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