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 HELP [<COMMAND>]
  12     Show available commands or command specific help text.
  13
  14
  15 OPEN [--lock] [--inquire | --pinentry=[0|1]] [--base64] <filename> [<key>]
  16     Opens <filename> using <key>. When the filename is not found on the
  17     file-system a new document will be created. If the file is found, it is
  18     looked for in the file cache for an existing key. When found and no key
  19     was specified, the cached key will be used for decryption (if encrypted).
  20     When not found, pinentry(1) will be used to retrieve the key (see the
  21     OPTIONS documentation).
  22
  23     When the --lock option is passed then the file mutex will be locked as if
  24     the LOCK command had been sent after the file had been opened.
  25
  26     The --inquire option disables pinentry usage and uses a server inquire to
  27     retrieve the filename and key arguments.
  28
  29     Using pinentry for passphrase retrieval can be enabled or disabled by
  30     specifying the --pinentry option with the value 1 or 0 respectively. When
  31     no value is specified then the configuration file value will be used. If
  32     the passphrase is invalid then it is up to the client whether to retry or
  33     not.  To decrypt an encrypted file with an empty passphrase and avoid the
  34     pinentry dialog, use --pinentry=0.
  35
  36     When a "key_file" configuration parameter has been set for the current
  37     file and there is no cache entry, then an --inquire must be used to
  38     retrieve the key.
  39
  40     The --base64 option specifies that the key is Base64 encoded. It will be
  41     decoded before doing decryption. This allows for binary keys and may also
  42     be used with --inquire. This option is ignored when a pinentry is used.
  43
  44
  45 SAVE [--reset] [--inquire | --pinentry=[0|1]] [--cipher=[<string>]]
  46      [--iterations=[N]] [--base64] [<key>]
  47     Writes the XML document to disk. The file written to is the file that was
  48     opened using the OPEN command. If <key> is not specified then the
  49     currently cached key will be used. If the file is a new file or the file
  50     is not found in the file cache then <key> will be used. If both <key> is
  51     not specified and the file is not cached then pinentry(1) will be used to
  52     retrieve the key (see below) unless the configured number of iterations is
  53     0 in which case the file will be saved unencrypted.
  54
  55     Note that when both <key> is specified and the configured number of
  56     iterations is 0 the iterations for the current filename will be reset to
  57     1. This is to be on the safe side and prevent misuse.
  58
  59     The --iterations option can be used to change the number of encryption
  60     iterations for the opened file. When 0 no encryption will be performed.
  61     When this option is either not passed or is specified without a value then
  62     the previous setting obtained from the file header will be used.
  63
  64     You can specify an alternate cipher to encrypt with by specifying a cipher
  65     string with the --cipher option. Omitting the string uses the current
  66     cipher of the opened file or the default if the file is a new one. The
  67     default is specified in the configuration file. See pwmd(1) for available
  68     ciphers.
  69
  70     Using pinentry for passphrase retrieval can be enabled or disabled by
  71     specifying the --pinentry option with the value 1 or 0, respectively. When
  72     no value is specified then the configuration file value will be used.
  73     When enabled and the passphrase confirmation fails, the pinentry process
  74     is started over again until either the passphrases match or until the
  75     input is canceled by the user.  To save with encryption and with an empty
  76     passphrase, use --pinentry=0.
  77
  78     When --reset is specified then the cached passphrase for the opened file
  79     will be cleared before doing the actual SAVE as if the CLEARCACHE command
  80     had been sent.
  81
  82     The --inquire option disables pinentry usage and uses a server inquire to
  83     retrieve the key.
  84
  85     When a "key_file" configuration parameter has been set for the current
  86     file and there is no cache entry, then an --inquire must be used to
  87     retrieve the key.
  88
  89     The --base64 option specifies that the key is Base64 encoded. It will be
  90     decoded before doing encryption. This allows for binary keys and may also
  91     be used with --inquire. This option is ignored when a pinentry is used.
  92
  93
  94 ISCACHED <filename>
  95     An OK response is returned if the specified file is found in the file
  96     cache. If not found in the cache but exists on the filesystem,
  97     GPG_ERR_NOT_FOUND is returned. Otherwise a filesystem error is returned.
  98
  99
 100 CLEARCACHE [<filename>]
 101     Clears a file cache entry. This will forget the timeout and key for all or
 102     the specified file. Always returns an OK response.
 103
 104
 105 CACHETIMEOUT <filename> <seconds>
 106     Specify the number of seconds the specified file will be cached. -1 will
 107     keep the cache entry forever, 0 will require the key each time the OPEN or
 108     SAVE commands are used. Also see the "cache_timeout" configuration
 109     parameter. Returns ERR if the filename is not cached or if the timeout is
 110     invalid. OK otherwise.
 111
 112
 113 LIST [--no-recurse] [--verbose] [[!]element[<TAB>[!]element[...]]]
 114     If no element path is given then a newline separated list of root elements
 115     is returned with the data response. If given, then all reachable elements
 116     for the specified element path are returned unless the --no-recurse option
 117     is specified. If specified, only the child elements of the element path
 118     are returned without recursing into grandchildren. Each element in the
 119     path is prefixed with the literal '!' character when the element contains
 120     no "target" attribute. Refer to THE TARGET ATTRIBUTE for more information.
 121
 122     When the --verbose option is passed then each element path returned in the
 123     list will have a single space character followed by either a 0 or 1
 124     appended to it.  When 0, the element path has no children, otherwise it
 125     does have children.  When used with the --no-recurse option this may be
 126     useful to limit the amount of data transferred to the client.
 127
 128
 129 REALPATH [!]element[<TAB>[!]element[...]]
 130     Resolves all "target" attributes of the specified element path and returns
 131     the result with a data response.
 132
 133
 134 STORE [!]element[[<TAB>[!]element[...]]<TAB>[content]]
 135     Creates a new element path or modifies the content of an existing element
 136     path. If only a single element is specified, a new root element is
 137     created. Otherwise, elements are TAB delimited and the content will be set
 138     to the last TAB delimited argument. If no content is specified after the
 139     last TAB then the content for the last specified element will be removed,
 140     or empty when creating a new element.
 141
 142     The only restriction of an element name is that it not contain whitespace
 143     or begin with the literal element character '!' unless specifying a
 144     literal element. There is no whitespace between the TAB delimited
 145     elements. It is recommended that the value or content be base 64 encoded
 146     when it contains control or TAB characters to prevent XML and pwmd parsing
 147     errors.
 148
 149     This command uses a server INQUIRE to retrieve the data from the client.
 150
 151
 152 RENAME [!]element[<TAB>[!]element[...]] <value>
 153     Renames the specified element to the new value. If an element of the same
 154     name as the value exists then it will be overwritten.
 155
 156
 157 COPY [!]element[<TAB>[!]element[...]] [!]element[<TAB>[!]element[...]]
 158     Copies the entire element tree starting from the child node of the source
 159     element path, to the destination element path. If the destination element
 160     path does not exist then it will be created; otherwise it is overwritten.
 161
 162     Note that attributes from the source element path are merged into the
 163     destination element path when the destination element path exists. When an
 164     attribute of the same name exists in both the source and destination
 165     element paths then the destination attribute will be updated to the source
 166     attribute value.
 167
 168
 169 MOVE [!]element[<TAB>[!]element[...]] [[!]element[<TAB>[!]element[...]]]
 170     Moves the source element path to the destination element path. If the
 171     destination is not specified then it will be moved to the root of the
 172     document. If the destination is specified and exists then it will be
 173     overwritten; otherwise it will be created.
 174
 175
 176 DELETE [!]element[<TAB>[!]element[...]]
 177     Removes the specified element path and any children from the XML document.
 178
 179
 180 GET [!]element[<TAB>[!]element[...]]
 181     Retrieves the content or XML text node of the specified element path. The
 182     content is returned with a data response.
 183
 184
 185 ATTR SET|GET|DELETE|LIST [<attribute>] [!]<arg1> [!][arg2]
 186     ATTR SET attribute [!]element[<TAB>[!]element[...]] [attribute_value]
 187         Stores or updates an attribute name and optional value of an element
 188         path.
 189
 190     ATTR DELETE attribute [!]element[<TAB>[!]element[...]]
 191         Removes an attribute from an element path.
 192
 193     ATTR LIST [!]element[<TAB>[!]element[...]]
 194         Retrieves a newline separated list of attributes names and values from
 195         the specified element path. The attribute names and values are space
 196         delimited.
 197
 198     ATTR GET attribute [!]element[<TAB>[!]element[...]]
 199         Retrieves the value of an attribute from an element path.
 200
 201     The "_name" attribute (case sensitive) cannot be removed with ATTR DELETE
 202     if the element path is the root element. Although it can be SET to change
 203     the element name but only if the destination element name doesn't exist.
 204     Use the RENAME command for that instead.
 205
 206     The "_mtime" attribute is updated each time an element is modified by
 207     either storing content, editing attributes or by deleting a child element.
 208
 209     Also see THE TARGET ATTRIBUTE.
 210
 211
 212 XPATH <expression>[<TAB>[value]]
 213     Evaluates an XPath expression. If no value argument is specified, it is
 214     assumed the expression is a request to return a result. Otherwise, the
 215     result is set to the value argument and the document is updated. If there
 216     is no value after the <TAB> character, the value is assumed to be empty
 217     and the document is updated.
 218
 219
 220 XPATHATTR SET|DELETE <name> <expression>[<TAB>[<value>]]
 221     Like the XPATH command but operates on element attributes and won't return
 222     a result. For the SET operation the <value> is optional but the field is
 223     required in which case the value will be empty.
 224
 225
 226 IMPORT <content>[<TAB>[!]element[<TAB>[!]element[...]]]
 227     Like the STORE command (an INQUIRE), but the content argument is raw XML
 228     data. The content is created as a child of the specified element path. If
 229     an element of the element path does not exist then it is created. If no
 230     element path is specified then the content must begin with an pwmd DTD
 231     root element.
 232
 233     Note that the new content must begin with an XML element node. Also note
 234     that an existing child node of the same element name as the root node of
 235     the imported content will be overwritten.
 236
 237
 238 DUMP
 239     Shows the in memory XML document with indenting. To dump a specific
 240     element tree, use the XPATH command.
 241
 242
 243 LOCK
 244     Locks the mutex associated with the opened file. This prevents other
 245     clients from sending commands to the same opened file until the client
 246     that sent this command either disconnects or sends the UNLOCK command.
 247
 248
 249 UNLOCK
 250     Unlocks the file mutex which was locked with the LOCK command.
 251
 252
 253 GETPID
 254     Retrieves the process id of the server.
 255
 256
 257 GETCONFIG [filename] <parameter>
 258     Returns the value of a pwmd configuration variable with a data response.
 259     If no file has been opened then the value for the specified file or the
 260     default from the "global" section will be returned. If a file has been
 261     opened and no filename is specified, the value previously set with the SET
 262     command, if any, will be returned.
 263
 264     If there is no such configuration parameter defined, GPG_ERR_UNKNOWN_OPTION
 265     is returned.
 266
 267
 268 VERSION
 269     Returns the server version number and compile-time features with a data
 270     response with each being space delimited.
 271
 272
 273 SET <NAME>=<VALUE>
 274     Sets a client option NAME to VALUE. Use the UNSET command to reset an
 275     option to its default value.
 276
 277     NAME             |VALUE     |Description
 278     -----------------|----------|----------------------------------------------
 279     ENABLE_PINENTRY   0|1        When 0, disable use of pinentry. The default
 280                                  is 1.
 281
 282                                  * Deprecated. Pass --pinentry to the OPEN and
 283                                  SAVE commands instead.
 284
 285     PINENTRY_TIMEOUT  <integer>  The number of seconds before the pinentry
 286                                  process will terminate while waiting for a
 287                                  passphrase. The default is 20, 0 disables.
 288
 289     PINENTRTY_PATH    <string>   Full path to the pinentry binary. The default
 290                                  is specified at compile time.
 291
 292     TTYNAME           <string>   Same as the --ttyname option to pinentry(1).
 293
 294     TTYTYPE           <string>   Same as the --ttytype option to pinentry(1).
 295
 296     DISPLAY           <string>   Same as the --display option to pinentry(1).
 297
 298     TITLE             <string>   Sets the title string of the pinentry dialog.
 299
 300     PROMPT            <string>   Sets the prompt string of the pinentry dialog.
 301
 302     DESC              <string>   Sets the error or description string of the
 303                                  pinentry dialog.
 304
 305     LC_CTYPE          <string>   Same as the --lc-ctype option to pinentry(1).
 306
 307     LC_MESSAGES       <string>   Same as the --lc-messages option to
 308                                  pinentry(1).
 309
 310     NAME              <string>   Associates the thread ID of the connection
 311                                  with the specified textual representation.
 312                                  Useful for debugging log messages.
 313
 314     CIPHER            <string>   The cipher to use for the next SAVE.
 315
 316                                  * Deprecated. Use --cipher instead.
 317
 318     ITERATIONS        <integer>  The number of encryption iterations to do
 319                                  when the SAVE command is sent. An opened file
 320                                  is needed when setting this option. The
 321                                  CONFIG status message is sent after receiving
 322                                  this command.
 323
 324                                  * Deprecated. Use --iterations instead.
 325
 326     LOCK_ON_OPEN      0|1        If enabled then the file mutex will be locked
 327                                  after a successful OPEN as if the LOCK
 328                                  command had been sent.
 329
 330                                  * Deprecated. Use --lock instead.
 331
 332     RC_ON_LOCKED      0|1        If enabled then return an error code instead
 333                                  of a status message when the file mutex is
 334                                  locked by another client.
 335
 336
 337 UNSET <NAME>
 338     Resets option NAME to the value specified in the server configuration
 339     file. Some options have no default and will be reset to NULL or 0
 340     depending on the value type. See the SET command for available options.
 341
 342
 343 LS
 344     Lists the contents of the configured data_directory. The result is a
 345     newline separated list of filenames.
 346
 347
 348 RESET
 349     Closes the currently opened file but keeps any previously set client
 350     options.
 351
 352
 353 BYE
 354     Closes the connection discarding any unsaved changes.
 355
 356
 357 NOP
 358     Does nothing. Always returns successfully.
 359
 360
 361 STATUS MESSAGES
 362 ---------------
 363 Some commands send a status message to the client when successful or as a
 364 progress indicator. Status messages begin with a KEYWORD followed by the
 365 status description. What messages are sent, when, and how often, depend on
 366 configuration settings:
 367
 368     COMMAND      | KEYWORD
 369     -------------|-------------
 370     <ALL>         LOCKED
 371
 372     OPEN          DECRYPT
 373                   DECOMPRESS
 374                   CACHE
 375
 376     SAVE          COMPRESS
 377                   ENCRYPT
 378                   CACHE
 379
 380     GET           XFER
 381
 382     LIST          XFER
 383
 384     DUMP          XFER
 385
 386     XPATH         XFER
 387
 388     CLEARCACHE    CACHE
 389
 390     CACHETIMEOUT  CACHE
 391
 392     OPEN          NEWFILE
 393
 394
 395     KEYWORD    |OUTPUT FORMAT
 396     -----------|--------------------
 397     CACHE       <slots used>
 398                 Sent to each client after the file cache changes.
 399
 400     ENCRYPT     <iterations so far> <total iterations>
 401
 402     DECRYPT     <iterations so far> <total iterations>
 403
 404     COMPRESS    <bytes so far> <total bytes>
 405
 406     DECOMPRESS  <bytes so far> <total bytes>
 407
 408     XFER        <bytes so far> <total bytes>
 409
 410     LOCKED      When another thread owns a mutex lock that the current thread
 411                 needs, this is status message is sent and the thread will
 412                 block until the lock can be obtained.
 413
 414     CONFIG      Sent to each client after the configuration file has
 415                 been reloaded or has had a value changed that may affect other
 416                 connected clients.
 417
 418     CLIENTS     <count>
 419                 Sent to each client after a client connects or disconnects.
 420
 421     NEWFILE     Sent to the current client after opening a non-existant file.
 422
 423
 424 THE TARGET ATTRIBUTE
 425 --------------------
 426 There is a special attribute "target" (case sensitive) that can be set with
 427 ATTR SET. The value of this attribute is an element path that is located
 428 somewhere else in the XML document and are alot like how XPath treats
 429 entities, but is needed do to how pwmd commands are implemented. The syntax
 430 is as follows:
 431
 432 ATTR SET target [!]element[<TAB>[!]element[..]] [!]element[<TAB>[!]element[..]]
 433                 arg1^^^^^^^^^^^^^^^^^^^^^^^^^^^ arg2^^^^^^^^^^^^^^^^^^^^^^^^^^^
 434
 435 If the element path of where the "target" attribute (arg1) is to be stored
 436 doesn't exist then it will be created. This is the only time the ATTR command
 437 will create elements.
 438
 439 When a protocol command requests <arg1> as the element path then the path will
 440 be modified to use <arg2>. This is useful if you need elements to share the
 441 same data. If the target is modified, the other elements "pointing" to the
 442 target will have the same content. To get the real or literal element and
 443 ignore any "target" attributes, prefix the element with a '!' character.
 444 Another way to think of this attribute is that it's like a symbolic link in a
 445 filesystem. Here's an example XML document:
 446
 447     <pwmd>
 448         <element _name="a">
 449             <element _name="child">value a</element>
 450         </element>
 451         <element _name="b" target="a">
 452             <element _name="element_b">value b</element>
 453         </element>
 454         <element _name="c" target="b"/>
 455         <element name="d" target="!b"/>
 456     </pwmd>
 457
 458 Example:
 459     C> LIST b
 460     S> b
 461     S> b !child
 462
 463 Notice that there is not an <element_b> listed. This is because of the
 464 "target" attribute. The target attribute is recursive too, meaning that it can
 465 point to other elements with a "target" attibute:
 466
 467     C> LIST c
 468     S> c
 469     S> c !child
 470
 471 To get the value of an element with a "target" attribute without resolving the
 472 target, prefix the element with the literal element character '!':
 473
 474     C> LIST !b
 475     S> !b
 476     S> !b !element_b
 477
 478 A "target" attribute value may also contain the literal element character:
 479
 480     C> LIST d
 481     S> d
 482     S> d !element_b
 483
 484 The value of the "target" attribute isn't limited to only one element. It can
 485 be a full element path with literal element characters placed where needed.
 486 Use the REALPATH command to resolve all "target" attributes.
 487
 488 The "target" attribute is considered for all commands that support an element
 489 path. If the target element has been renamed or deleted afterwards, the
 490 command will fail.
 491
 492 Clients should be careful of creating target loops or targets which resolve to
 493 themselves. See the "recursion_depth" configuration parameter for details.
 494
 495
 496 XML DOCUMENT STRUCTURE
 497 ----------------------
 498 When importing an XML data file with the -I command line option, the document
 499 should have the following DTD:
 500
 501     <?xml version="1.0"?>
 502     <!DOCTYPE pwmd [
 503     <!ELEMENT pwmd (element*)>
 504     <!ATTLIST element _name CDATA #REQUIRED>
 505     ]>
 506
 507 The "pwmd" element is the document root node while all other elements of the
 508 document have the name "element" with an attribute "_name" which is used as
 509 the reference to the current "element". It's done this way so commonly used
 510 characters that would normally cause the XML parser to throw an error while
 511 parsing an XML element won't because the element name is stored as an XML
 512 attribute which has more loose restrictions in their values. See THE TARGET
 513 ATTRIBUTE for an example document.
 514
 515
 516 Ben Kibbey <bjk@luxsci.net>
 517 http://pwmd.sourceforge.net/