COMMANDS

   1 The server uses a protocol provided by libassuan to communicate with the
   2 client. An OK response is returned when a command succeeds or ERR along with
   3 an error code and description, if not. When a command requests data for
   4 retrieval (e.g., GET) the output is prefixed with D then a single SPACE then
   5 the actual data followed by a response. Read the libassuan docs for more info
   6 about the protocol.
   7
   8
   9 PROTOCOL COMMANDS
  10 -----------------
  11 OPEN <filename> [<key>]
  12     Opens <filename> using <key>. If file is not found on the file-system, then
  13     a new document will be created. If the file is found, it is looked for in
  14     the file cache for an existing key. When found, the existing key will be
  15     used for decryption. When not found, pinentry(1) will be used to retrieve
  16     the key (see OPTIONS below). You can also open a different file using the
  17     same connection. When using an empty key and you want to avoid the
  18     pinentry dialog, set PINENTRY to 0 (see OPTIONS below).
  19
  20
  21 SAVE [<key>]
  22     Writes the XML document to disk. The file written to is the file that was
  23     opened using the OPEN command. If <key> is not specified then the
  24     currently cached key will be used. If the file is a new file or the file
  25     isn't found in the file cache, <key> may be used. If <key> is not
  26     specified then pinentry(1) will be used to retrieve the key (see OPTIONS
  27     below). When using an empty key and you want to avoid the pinentry dialog,
  28     set PINENTRY to 0 (see OPTIONS below).
  29
  30     When the SAVE command is sent and a key is found in the file cache, the
  31     cached key will be used. To reset the key to a new value, send the
  32     CLEARCACHE command followed by the filename, then send the SAVE command to
  33     enter a new key.
  34
  35
  36 ISCACHED <filename>
  37     An OK response is returned if the specified file is in the file cache.
  38
  39
  40 CLEARCACHE [<filename>]
  41     Clears a file cache entry. This will forget the timeout and key for all or
  42     the specified file.
  43
  44
  45 CACHETIMEOUT <seconds> <filename>
  46     Specify the number of seconds the specified file will be cached. -1 will
  47     keep the cache entry forever, 0 will require the key each time the OPEN or
  48     SAVE commands are used. Also see the "cache_timeout" configuration option.
  49
  50
  51 LIST [[!]element[<TAB>[!]element[...]]]
  52     If no element path is given then a list of root elements is returned with
  53     the data response code. If given, then all reachable elements for the
  54     specified element path are returned. Each element in the path is prefixed
  55     with the literal '!' character when the element contains no "target"
  56     attribute (See THE TARGET ATTRIBUTE below).
  57
  58
  59 REALPATH [!]element[<TAB>[!]element[...]]
  60     Resolves all "target" attributes of the specified element path and returns
  61     the result with a data response.
  62
  63
  64 STORE [!]element[[<TAB>[!]element[...]]<TAB>[content]]
  65     Creates a new element tree or modifies the content of an existing element
  66     path. If only a single element is specified, a new root element is
  67     created. Otherwise, elements are TAB delimited and the content will be set
  68     to the last TAB delimited argument. If no content is specified after the
  69     last TAB then the content for the last specified element will be removed
  70     or empty if creating a new element.
  71
  72     The only restriction of element names is that they not begin with a
  73     punctuation character (the literal '!' character is an exception) or digit
  74     and not contain any whitespace. There is no whitespace between the TAB
  75     delimited elements. It is recommended that the value be base 64 encoded to
  76     prevent libXML and pwmd parsing errors.
  77
  78     PWMD reads the element path from the client via the Assuan INQUIRE
  79     protocol response. The STORE command is sent by itself without arguments,
  80     then the server responds with INQUIRE. The client then sends the element
  81     path prefixed with a "D " data response. When finished, the client sends
  82     "END" on an empty line. This is needed so an element path and value can be
  83     more than 1000 bytes long, the Assuan protocol line limit.
  84
  85
  86 DELETE [!]element[<TAB>[!]element[...]]
  87     Removes an element tree from the specified element path.
  88
  89
  90 GET [!]element[<TAB>[!]element[...]]
  91     Retrieves the text content of the specified element path. The data is
  92     returned with a data response.
  93
  94
  95 ATTR SET|GET|DELETE|LIST [<attribute>] [!]<arg1> [!][arg2]
  96     ATTR SET attribute [!]element[<TAB>[!]element[...]] attribute_value
  97         Stores or updates an attribute value of an element path.
  98
  99     ATTR DELETE attribute [!]element[<TAB>[!]element[...]]
 100         Removes an attribute from an element path.
 101
 102     ATTR LIST [!]element[<TAB>[!]element[...]]
 103         Gets a list of attributes from an element path.
 104
 105     ATTR GET attribute [!]element[<TAB>[!]element[...]]
 106         Gets the value of an attribute from an element path.
 107
 108     The "name" attribute (case sensitive) cannot be removed with ATTR DELETE
 109     if the element path is only a root element. Although it can be SET to
 110     change the root element name.
 111
 112     Also see THE TARGET ATTRIBUTE below.
 113
 114
 115 XPATH <expression>[<TAB>[value]]
 116     Evaluates an XPath expression. If no value argument is specified, it is
 117     assumed the expression is a request to return a result. Otherwise, the
 118     result is set to the value argument and the document is updated. If there
 119     is no value after the <TAB> character, the value is assumed to be empty
 120     and the document is updated.
 121
 122
 123 IMPORT [!]element[<TAB>[!]element[...]] <content>
 124     Like the STORE command (an INQUIRE), but the content argument is raw XML
 125     data. The content is created as a child of the specified element path. If
 126     an element of the element path does not exist, it is created.
 127
 128     Note that the new content must begin with an element and not text. Also
 129     note that an existing child node of the same element name as the root node
 130     of the imported content will be overwritten.
 131
 132
 133 DUMP
 134     Shows the in memory XML document with indenting. To dump a specific
 135     element tree, use the XPATH command.
 136
 137
 138 LOCK
 139     Locks the mutex associated with the opened file. This prevents other
 140     clients from sending commands to the same opened file until the client
 141     that sent this command sends the UNLOCK command.
 142
 143
 144 UNLOCK
 145     Unlocks the mutex which was locked with the LOCK command.
 146
 147
 148 GETPID
 149     Retrieves the process id of the server.
 150
 151
 152 GETCONFIG [filename] <parameter>
 153     Returns the value of a pwmd configuration variable with a data response.
 154     If no file is open then the specified files value or the default will be
 155     returned. The "key" and "key_file" variables are ignored.
 156
 157
 158 OPTION <NAME>=<VALUE>
 159     Sets an option NAME to VALUE. See OPTIONS below.
 160
 161
 162 BYE
 163     Closes the connection. Use the SAVE command before this command as any
 164     changes will be lost.
 165
 166
 167 If a command fails then the ERR response is returned followed by a protocol
 168 error code and description. See src/pwmd_error.h or libpwmd/libpwmd.h for
 169 error codes.
 170
 171
 172 OPTIONS
 173 -------
 174 Commands that require a key that is neither cached nor specified will use
 175 pinentry(1) to retrieve the key. Pinentry options can be set with the OPTION
 176 command followed by the option name and value. Below are the available
 177 pinentry options:
 178
 179     NAME       VALUE      Description
 180     ---------|----------|----------------------------------------------------
 181     PINENTRY   0|1        When 0, disable use of pinentry. The default is 1.
 182     PATH       <string>   Full path to the pinentry binary. The default is
 183                           specified at compile time (/usr/bin/pinentry).
 184     TTYNAME    <string>   Same as the --ttyname option to pinentry(1).
 185     TTYTYPE    <string>   Same as the --ttytype option to pinentry(1).
 186     DISPLAY    <string>   Same as the --display option to pinentry(1).
 187     TITLE      <string>   Sets the title string of the dialog.
 188     PROMPT     <string>   Sets the prompt string of the dialog.
 189     DESC       <string>   Sets the error or description string of the dialog.
 190     ITERATIONS <integer>  The number of encrypting iterations for the opened
 191                           file or default.
 192
 193 When pinentry is used with the SAVE command the key will be asked for
 194 confirmation. If the confirmation fails, the process is started over again
 195 until either the keys match or until Cancel is selected. The OPEN command will
 196 only ask for the key once without retrying on failure. It is up to the client
 197 to retry the OPEN command. Empty keys are allowed.
 198
 199 There is also a CLIENT option that contains other sub-options. The format is
 200 OPTION CLIENT NAME=VALUE, where NAME is one of:
 201
 202     NAME       VALUE      Description
 203     ---------|----------|----------------------------------------------------
 204     NAME      <string>   Associates the thread ID of the connection with the
 205                          specified textual representation. Useful for
 206                          debugging log messages.
 207
 208
 209 STATUS MESSAGES
 210 ---------------
 211 Some commands send a status message to the client when successful or as a
 212 progress indicator. Status messages begin with a KEYWORD (see below) followed
 213 by the status description. What messages are sent, and how often, depend on
 214 configuration settings:
 215
 216     COMMAND             KEYWORD
 217     --------------------------------
 218     Non-cache commands  LOCKED
 219
 220     OPEN                DECRYPT
 221                         DECOMPRESS
 222                         CACHE
 223                         LOCKED
 224
 225     SAVE                COMPRESS
 226                         ENCRYPT
 227                         CACHE
 228                         LOCKED
 229
 230     CLEARCACHE          CACHE
 231                         LOCKED
 232
 233     CACHETIMEOUT        CACHE
 234                         LOCKED
 235
 236     ISCACHED            LOCKED
 237
 238
 239     KEYWORD             OUTPUT FORMAT
 240     ---------------------------------
 241     CACHE               <slots used> <slots available>
 242                         Sent to each client after a change.
 243     ENCRYPT             <iterations so far>
 244     DECRYPT             <iterations so far>
 245     COMPRESS            <bytes so far> <total bytes>
 246     DECOMPRESS          <bytes so far> <total bytes>
 247     LOCKED              When another thread owns the file/key cache mutex
 248                         lock, this is sent once and the thread will block
 249                         until the lock can be obtained.
 250     KEEPALIVE           Sent to each client after every configured amount of
 251                         seconds. This lets the client know that the connection
 252                         is still active for commands that take a while to
 253                         complete.
 254     CONFIG              Sent to each client after the configuration file has
 255                         been reloaded.
 256     CLIENTS             Sent to each client after a client connects or
 257                         disconnects.
 258
 259
 260 THE TARGET ATTRIBUTE
 261 --------------------
 262 There is a special attribute "target" (case sensitive) that can be set with
 263 ATTR SET. The value of this attribute is an element path that is located
 264 somewhere else in the XML document and are alot like how XPath treats
 265 entities, but are needed do to how pwmd commands are implemented. The syntax
 266 is as follows:
 267
 268 ATTR SET target [!]element[<TAB>[!]element[..]] [!]element[<TAB>[!]element[..]]
 269                    arg1^^^^^^^^^^^^^^^^^^^^^^^^    arg2^^^^^^^^^^^^^^^^^^^^^^^^
 270
 271 If the element path of the "target" attribute (arg1) doesn't exist, it is
 272 created. This is the only time the ATTR command will create elements.
 273
 274 When a protocol command requests <arg1> as the element path, the remaining
 275 elements after the element with the "target" attribute will be appended to
 276 <arg2>. This is useful if you have elements that share the same data. If the
 277 target is modified, the other elements "pointing" to the target will have the
 278 same content. To get the real or literal element and ignore any "target"
 279 attributes, prefix an element with a '!' character. Here's an example:
 280
 281     C> STORE
 282     S> INQUIRE STORE
 283     C> D host1<TAB>username<TAB>original username
 284     C> END
 285     S> OK
 286     C> STORE
 287     S> INQUIRE STORE
 288     C> D host2<TAB>smtp<TAB>username<TAB>someuser
 289     C> END
 290     S> OK
 291     C> ATTR SET target host1<TAB>username host2<TAB>smtp<TAB>username
 292     S> OK
 293
 294 Now host1's "target" attribute will be used:
 295
 296     C> GET host1<TAB>username
 297     S> D someuser
 298     S> OK
 299
 300 If you want host1's username, prefix the element of the "target" attribute
 301 with a '!':
 302
 303     C> GET host1<TAB>!username
 304     S> D original username
 305     S> OK
 306
 307 The target value (arg2) element can also have a "target" attribute:
 308
 309     C> ATTR SET target new_account host1
 310     S> OK
 311     C> GET new_account<TAB>username
 312     S> D someuser
 313     S> OK
 314
 315 The value of the "target" attribute may also be prefixed with a '!' to set the
 316 target to the actual element path and not a target of the element path:
 317
 318     C> ATTR DELETE target !new_account
 319     S> OK
 320     C> ATTR SET target new_account<TAB>username host1<TAB>!username
 321     S> OK
 322     C> GET new_account<TAB>username
 323     S> D original username
 324     S> OK
 325
 326 The "target" attribute is considered for all commands that support an element
 327 path. If the target element has been renamed or deleted afterwards, the
 328 command will fail.
 329
 330 Clients should be careful of creating target loops. See the "recursion_depth"
 331 configuration parameter for details.
 332
 333
 334 XML DOCUMENT STRUCTURE
 335 ----------------------
 336 When importing an XML data file with the -I command line option, the document
 337 should have the following DTD:
 338
 339     <?xml version="1.0"?>
 340     <!DOCTYPE accounts [
 341     <!ELEMENT accounts (account*)>
 342     <!ATTLIST account name CDATA #REQUIRED>
 343     ]>
 344
 345 "accounts" is the document root element while each root element mentioned in
 346 the protocol commands use the "account" element. So if you have a root element
 347 "isp" to be shown with the LIST command ("LIST isp"), the document structure
 348 looks like this:
 349
 350     <accounts>
 351         <account name="isp">
 352         [...]
 353         </account>
 354     </accounts>
 355
 356 The DUMP command can be useful to show the current document structure.
 357
 358
 359 DESIGN
 360 ------
 361 The key cache is protected with a mutex and is locked with each access. Each
 362 cache entry also contains a mutex for the opened file and a reference count
 363 which is adjusted each time a client connects or disconnects. This allows
 364 client A to issue commands that aren't related to the file opened by client B.
 365 The refcount is needed to prevent the mutex being overwritten when the entry
 366 needs to be reset (CACHETIMEOUT for example) and there are any clients
 367 connected.
 368
 369 The client_thread() uses an event to wait for the client FD to become ready
 370 for reading. When ready, it uses the libassuan external IO loop functions to
 371 prevent blocking letting other threads do their work.
 372
 373 When a key is required for the OPEN or SAVE commands, and OPTION PINENTRY=1,
 374 pinentry(1) is used to retrieve the key. This is done by creating a pipe()
 375 with the client_thread(), then pth_fork()'s the pinentry process which will
 376 write the key or error to the pipe that client_thread() will read from. After
 377 the read, the pinentry will have exited and client_thread() calls the
 378 finalization function for the original command.
 379
 380 The KEEPALIVE status message is a PTH_EVENT_TIME event from server_loop(). It
 381 uses a pth_msgport_t to write to other client threads. This is the same for
 382 the CACHE and CONFIG status messages, except that pth_msgport_put() is called
 383 from a client thread and sent to all other clients too. Each client thread
 384 uses an PTH_EVENT_MSG event to wait for these messages.
 385
 386            -------------       ---------------
 387            [server_loop]-_-_-_-[accept_thread]
 388            -------------       ---------------
 389        not joinable :                |
 390     ---------------------     ---------------
 391     [adjust_timer_thread]     [client_thread]<----------=====
 392     ---------------------     --------------- |   |    |    =
 393                                | |     ---------  |    |    =
 394                    ------------------  [command]  |    |    =
 395                    [command finalize]  ---------  |    |    = pipe()
 396                    ------------------    |   |    |    |    =
 397                                          |  ---------  |    =
 398                                          |  [INQUIRE]  |    =
 399                                          |  ---------  |    =
 400                                          |    -----------   =
 401                                          |----[OPEN/SAVE]   =
 402                                               -----------   =
 403                                                    : fork() =
 404                                                ----------   =
 405                                                [pinentry]====
 406                                                ----------
 407
 408 There is also a library libpwmd which makes it easy for applications to use
 409 the server. It supports it's own key retrieval and asynchronous interaction
 410 with pwmd.
 411
 412 The latest version of both pwmd and libpwmd can be obtained from
 413 http://bjk.sourceforge.net/pwmd/. Feel free to send me any questions, bug
 414 reports, patches or feature requests.
 415
 416 Ben Kibbey <bjk@luxsci.net>