doc/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 the filename is not found on the
  13     file-system, then a new document will be created. If the file is found, it
  14     is looked for in the file cache for an existing key. When found and no key
  15     was specified, the cached key will be used for decryption (if encrypted).
  16     When not found, pinentry(1) will be used to retrieve the key (see OPTIONS
  17     below). You can also open a different file using the same connection. When
  18     using an empty or NULL key and you want to avoid the pinentry dialog, set
  19     ENABLE_PINENTRY to 0 (see OPTIONS below).
  20
  21
  22 SAVE [<key>]
  23     Writes the XML document to disk. The file written to is the file that was
  24     opened using the OPEN command. If <key> is not specified then the
  25     currently cached key will be used. If the file is a new file or the file
  26     isn't found in the file cache, <key> will be used. If <key> is not
  27     specified then pinentry(1) will be used to retrieve the key (see OPTIONS
  28     below). If you want to use and empty key and want to avoid the pinentry
  29     dialog, set ENABLE_PINENTRY to 0 (see OPTIONS below).
  30
  31
  32 ISCACHED <filename>
  33     An OK response is returned if the specified file is found in the file
  34     cache. If not found in the cache but exists on the filesystem,
  35     GPG_ERR_NOT_FOUND is returned. Otherwise a filesystem error is returned.
  36
  37
  38 CLEARCACHE [<filename>]
  39     Clears a file cache entry. This will forget the timeout and key for all or
  40     the specified file. Always returns an OK response.
  41
  42
  43 CACHETIMEOUT <filename> <seconds>
  44     Specify the number of seconds the specified file will be cached. -1 will
  45     keep the cache entry forever, 0 will require the key each time the OPEN or
  46     SAVE commands are used. Also see the "cache_timeout" configuration
  47     parameter. Returns ERR if the filename isn't cached or if the timeout is
  48     invalid. OK otherwise.
  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. 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 XML 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. The element path may extend
  82     multiple lines but each must be prefixed with the data "D " response. When
  83     finished, the client sends "END" on an empty line. This is needed so an
  84     element path and value can be more than 1000 bytes long, the Assuan
  85     protocol line limit.
  86
  87
  88 RENAME [!]element[<TAB>[!]element[...]] <value>
  89     Renames the specified element to the new value.
  90
  91
  92 COPY [!]element[<TAB>[!]element[...]] [!]element[<TAB>[!]element[...]]
  93     Copies the entire element tree starting from the child node of the source
  94     element path, to the destination element path. If the destination element
  95     path doesn't exist then it is created; otherwise it is overwritten.
  96
  97     Note that attributes from the source element path are merged into the
  98     destination element path.
  99
 100
 101 DELETE [!]element[<TAB>[!]element[...]]
 102     Removes an element tree from the specified element path.
 103
 104
 105 GET [!]element[<TAB>[!]element[...]]
 106     Retrieves the content or text node of the specified element path. The data
 107     is returned with a data response.
 108
 109
 110 ATTR SET|GET|DELETE|LIST [<attribute>] [!]<arg1> [!][arg2]
 111     ATTR SET attribute [!]element[<TAB>[!]element[...]] attribute_value
 112         Stores or updates an attribute value of an element path.
 113
 114     ATTR DELETE attribute [!]element[<TAB>[!]element[...]]
 115         Removes an attribute from an element path.
 116
 117     ATTR LIST [!]element[<TAB>[!]element[...]]
 118         Gets a list of attributes from an element path.
 119
 120     ATTR GET attribute [!]element[<TAB>[!]element[...]]
 121         Gets the value of an attribute from an element path.
 122
 123     The "name" attribute (case sensitive) cannot be removed with ATTR DELETE
 124     if the element path is the root element. Although it can be SET to change
 125     the root element name.
 126
 127     Also see THE TARGET ATTRIBUTE below.
 128
 129
 130 XPATH <expression>[<TAB>[value]]
 131     Evaluates an XPath expression. If no value argument is specified, it is
 132     assumed the expression is a request to return a result. Otherwise, the
 133     result is set to the value argument and the document is updated. If there
 134     is no value after the <TAB> character, the value is assumed to be empty
 135     and the document is updated.
 136
 137
 138 IMPORT <content>[<TAB>[!]element[<TAB>[!]element[...]]]
 139     Like the STORE command (an INQUIRE), but the content argument is raw XML
 140     data. The content is created as a child of the specified element path. If
 141     an element of the element path does not exist then it is created. If no
 142     element path is specified then the content must begin with an pwmd DTD
 143     root element.
 144
 145     Note that the new content must begin with an element node. Also note that
 146     an existing child node of the same element name as the root node of the
 147     imported content will be overwritten.
 148
 149
 150 DUMP
 151     Shows the in memory XML document with indenting. To dump a specific
 152     element tree, use the XPATH command.
 153
 154
 155 LOCK
 156     Locks the mutex associated with the opened file. This prevents other
 157     clients from sending commands to the same opened file until the client
 158     that sent this command either disconnects or sends the UNLOCK command.
 159
 160
 161 UNLOCK
 162     Unlocks the mutex which was locked with the LOCK command.
 163
 164
 165 GETPID
 166     Retrieves the process id of the server.
 167
 168
 169 GETCONFIG [filename] <parameter>
 170     Returns the value of a pwmd configuration variable with a data response.
 171     If no file has been opened then the value for the specified file or the
 172     default from the "global" section will be returned. If a file has been
 173     opened and no filename is specified, the value previously set with the SET
 174     command, if any, will be returned.
 175
 176     If there is no such parameter defined, GPG_ERR_NO_VALUE is returned.
 177
 178
 179 VERSION
 180     Returns the server version number with a data response.
 181
 182
 183 SET <NAME>=<VALUE>
 184     Sets an option NAME to VALUE. See OPTIONS below for available options.
 185
 186
 187 UNSET <NAME>
 188     Resets option NAME to the value specified in the server configuration
 189     file. Some options have no default and will be reset to NULL or 0
 190     depending on the type.
 191
 192
 193 BYE
 194     Closes the connection disconnecting the client. Unless the SAVE command
 195     had been sent, any changes to the document will be lost.
 196
 197
 198 OPTIONS
 199 -------
 200 Commands that require a key that is neither cached nor specified will use
 201 pinentry(1) to retrieve the key. Pinentry options can be set with the SET
 202 command followed by the option name and value. Below are the available pwmd
 203 options:
 204
 205     NAME             |VALUE     |Description
 206     -----------------|----------|----------------------------------------------
 207     ENABLE_PINENTRY   0|1        When 0, disable use of pinentry. The default
 208                                  is 1.
 209     PINENTRY_TIMEOUT  <integer>  The number of seconds before the pinentry
 210                                  process will terminate while waiting for a
 211                                  passphrase. The default is 20, 0 disables.
 212     PINENTRTY_PATH    <string>   Full path to the pinentry binary. The default
 213                                  is specified at compile time.
 214     TTYNAME           <string>   Same as the --ttyname option to pinentry(1).
 215     TTYTYPE           <string>   Same as the --ttytype option to pinentry(1).
 216     DISPLAY           <string>   Same as the --display option to pinentry(1).
 217     TITLE             <string>   Sets the title string of the pinentry dialog.
 218     PROMPT            <string>   Sets the prompt string of the pinentry dialog.
 219     DESC              <string>   Sets the error or description string of the
 220                                  pinentry dialog.
 221     LC_CTYPE          <string>   Same as the --lc-ctype option to pinentry(1).
 222     LC_MESSAGES       <string>   Same as the --lc-messages option to
 223                                  pinentry(1).
 224     ITERATIONS        <integer>  The number of encryption iterations to do
 225                                  when the SAVE command is sent. An opened file
 226                                  is needed when setting this option. The
 227                                  CONFIG status message is sent after receiving
 228                                  this command.
 229     NAME              <string>   Associates the thread ID of the connection
 230                                  with the specified textual representation.
 231                                  Useful for debugging log messages.
 232     CIPHER            <string>   The cipher to use for the next SAVE.
 233
 234 When pinentry is used with the SAVE command the passphrase will be asked for
 235 confirmation. If the confirmation fails, the process is started over again
 236 until either the passphrases match or until Cancel is selected. The OPEN
 237 command will only ask for the passphrase once without retrying on failure. It
 238 is up to the client to retry the OPEN command. Empty keys are allowed. To
 239 prevent pinentry asking for an (empty) passphrase, use SET ENABLE_PINENTRY=0.
 240
 241 To reset an option value string to its default, use the UNSET command.
 242
 243
 244 STATUS MESSAGES
 245 ---------------
 246 Some commands send a status message to the client when successful or as a
 247 progress indicator. Status messages begin with a KEYWORD (see below) followed
 248 by the status description. What messages are sent, when, and how often, depend
 249 on configuration settings:
 250
 251     COMMAND      | KEYWORD
 252     -------------|-------------
 253     <ALL>         LOCKED
 254
 255     OPEN          DECRYPT
 256                   DECOMPRESS
 257                   CACHE
 258
 259     SAVE          COMPRESS
 260                   ENCRYPT
 261                   CACHE
 262
 263     GET           XFER
 264
 265     LIST          XFER
 266
 267     DUMP          XFER
 268
 269     XPATH         XFER
 270
 271     CLEARCACHE    CACHE
 272
 273     CACHETIMEOUT  CACHE
 274
 275
 276     KEYWORD    |OUTPUT FORMAT
 277     -----------|--------------------
 278     CACHE       <slots used>
 279                 Sent to each client after the file cache changes.
 280     ENCRYPT     <iterations so far> <total iterations>
 281     DECRYPT     <iterations so far> <total iterations>
 282     COMPRESS    <bytes so far> <total bytes>
 283     DECOMPRESS  <bytes so far> <total bytes>
 284     XFER        <bytes so far> <total bytes>
 285     LOCKED      When another thread owns a mutex lock that the current thread
 286                 needs, this is status message is sent and the thread will
 287                 block until the lock can be obtained.
 288     KEEPALIVE   Sent to each client after every configured amount of
 289                 seconds. It is important that this status message be sent to
 290                 test for client connectivity.
 291     CONFIG      Sent to each client after the configuration file has
 292                 been reloaded or has had a value changed that may affect other
 293                 connected clients.
 294     CLIENTS     Sent to each client after a client connects or disconnects.
 295
 296
 297 THE TARGET ATTRIBUTE
 298 --------------------
 299 There is a special attribute "target" (case sensitive) that can be set with
 300 ATTR SET. The value of this attribute is an element path that is located
 301 somewhere else in the XML document and are alot like how XPath treats
 302 entities, but is needed do to how pwmd commands are implemented. The syntax
 303 is as follows:
 304
 305 ATTR SET target [!]element[<TAB>[!]element[..]] [!]element[<TAB>[!]element[..]]
 306                 arg1^^^^^^^^^^^^^^^^^^^^^^^^^^^ arg2^^^^^^^^^^^^^^^^^^^^^^^^^^^
 307
 308 If the element path of the "target" attribute (arg1) doesn't exist, it is
 309 created. This is the only time the ATTR command will create elements.
 310
 311 When a protocol command requests <arg1> as the element path, the remaining
 312 elements after the element with the "target" attribute will be appended to
 313 <arg2>. This is useful if you have elements that share the same data. If the
 314 target is modified, the other elements "pointing" to the target will have the
 315 same content. To get the real or literal element and ignore any "target"
 316 attributes, prefix the element with a '!' character. Here's an example:
 317
 318     C> STORE
 319     S> INQUIRE STORE
 320     C> D host1<TAB>username<TAB>original username
 321     C> END
 322     S> OK
 323     C> STORE
 324     S> INQUIRE STORE
 325     C> D host2<TAB>smtp<TAB>username<TAB>someuser
 326     C> END
 327     S> OK
 328     C> ATTR SET target host1<TAB>username host2<TAB>smtp<TAB>username
 329     S> OK
 330
 331 Now host1's "target" attribute will be used:
 332
 333     C> GET host1<TAB>username
 334     S> D someuser
 335     S> OK
 336
 337 If you want host1's username, prefix the element of the "target" attribute
 338 with a '!':
 339
 340     C> GET host1<TAB>!username
 341     S> D original username
 342     S> OK
 343
 344 The target value (arg2) element can also have a "target" attribute:
 345
 346     C> ATTR SET target new_account host1
 347     S> OK
 348     C> GET new_account<TAB>username
 349     S> D someuser
 350     S> OK
 351
 352 The value of the "target" attribute may also be prefixed with a '!' to set the
 353 target to the actual element path and not a target of the element path:
 354
 355     C> ATTR DELETE target !new_account
 356     S> OK
 357     C> ATTR SET target new_account<TAB>username host1<TAB>!username
 358     S> OK
 359     C> GET new_account<TAB>username
 360     S> D original username
 361     S> OK
 362
 363 The "target" attribute is considered for all commands that support an element
 364 path. If the target element has been renamed or deleted afterwards, the
 365 command will fail.
 366
 367 Clients should be careful of creating target loops. See the "recursion_depth"
 368 configuration parameter for details.
 369
 370
 371 XML DOCUMENT STRUCTURE
 372 ----------------------
 373 When importing an XML data file with the -I command line option, the document
 374 should have the following DTD:
 375
 376     <?xml version="1.0"?>
 377     <!DOCTYPE pwmd [
 378     <!ELEMENT pwmd (root*)>
 379     <!ATTLIST root name CDATA #REQUIRED>
 380     ]>
 381
 382 The "pwmd" element is the document root node while the first element of an
 383 element path specified in protocol commands use the "root" element. So if you
 384 specify the command "LIST isp", "isp" is really a "root" element that has a
 385 "name" attribute with the value "isp". Any following elements are children of
 386 the "root" element:
 387
 388     <pwmd>
 389         <root name="isp">
 390         [...]
 391         </root>
 392     </pwmd>
 393
 394 The remaining <TAB> delimited elements (e.g., "LIST isp<TAB>SMTP") are regular
 395 elements and are not treated specially in the XML document.
 396
 397 The DUMP command might be useful to show the document structure.
 398
 399 Ben Kibbey <bjk@luxsci.net>
 400 http://bjk.sourceforge.net/pwmd/