doc/pwmd.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
   4 <head>
   5 <title>PWMD Manual</title>
   6
   7 <meta name="description" content="PWMD Manual">
   8 <meta name="keywords" content="PWMD Manual">
   9 <meta name="resource-type" content="document">
  10 <meta name="distribution" content="global">
  11 <meta name="Generator" content="makeinfo">
  12 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  13 <link href="#Top" rel="start" title="Top">
  14 <link href="#SEC_Contents" rel="contents" title="Table of Contents">
  15 <link href="dir.html#Top" rel="up" title="(dir)">
  16 <style type="text/css">
  17 <!--
  18 a.summary-letter {text-decoration: none}
  19 blockquote.indentedblock {margin-right: 0em}
  20 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  21 blockquote.smallquotation {font-size: smaller}
  22 div.display {margin-left: 3.2em}
  23 div.example {margin-left: 3.2em}
  24 div.lisp {margin-left: 3.2em}
  25 div.smalldisplay {margin-left: 3.2em}
  26 div.smallexample {margin-left: 3.2em}
  27 div.smalllisp {margin-left: 3.2em}
  28 kbd {font-style: oblique}
  29 pre.display {font-family: inherit}
  30 pre.format {font-family: inherit}
  31 pre.menu-comment {font-family: serif}
  32 pre.menu-preformatted {font-family: serif}
  33 pre.smalldisplay {font-family: inherit; font-size: smaller}
  34 pre.smallexample {font-size: smaller}
  35 pre.smallformat {font-family: inherit; font-size: smaller}
  36 pre.smalllisp {font-size: smaller}
  37 span.nolinebreak {white-space: nowrap}
  38 span.roman {font-family: initial; font-weight: normal}
  39 span.sansserif {font-family: sans-serif; font-weight: normal}
  40 ul.no-bullet {list-style: none}
  41 -->
  42 </style>
  43
  44
  45 </head>
  46
  47 <body lang="en">
  48 <h1 class="settitle" align="center">PWMD Manual</h1>
  49
  50
  51
  52
  53 <a name="Top"></a>
  54 <div class="header">
  55 <p>
  56 Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
  57 </div>
  58 <h1 class="node-heading">Top</h1>
  59
  60
  61 <table class="menu" border="0" cellspacing="0">
  62 <tr><td align="left" valign="top">&bull; <a href="#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Overview of pwmd.
  63 </td></tr>
  64 <tr><td align="left" valign="top">&bull; <a href="#Access-Control" accesskey="2">Access Control</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">ACL of a single XML element.
  65 </td></tr>
  66 <tr><td align="left" valign="top">&bull; <a href="#Invoking" accesskey="3">Invoking</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Command line options.
  67 </td></tr>
  68 <tr><td align="left" valign="top">&bull; <a href="#Configuration" accesskey="4">Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Configuration file options.
  69 </td></tr>
  70 <tr><td align="left" valign="top">&bull; <a href="#Commands" accesskey="5">Commands</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Protocol commands.
  71 </td></tr>
  72 <tr><td align="left" valign="top">&bull; <a href="#Status-Messages" accesskey="6">Status Messages</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Status lines and their meaning.
  73 </td></tr>
  74 <tr><td align="left" valign="top">&bull; <a href="#Target-Attribute" accesskey="7">Target Attribute</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">A kind of symbolic link.
  75 </td></tr>
  76 <tr><td align="left" valign="top">&bull; <a href="#Other-Attributes" accesskey="8">Other Attributes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Other attributes specially handled by pwmd.
  77 </td></tr>
  78 <tr><td align="left" valign="top">&bull; <a href="#Signals" accesskey="9">Signals</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Signals known to pwmd.
  79 </td></tr>
  80 <tr><td align="left" valign="top">&bull; <a href="#Concept-Index">Concept Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Index of concepts.
  81 </td></tr>
  82 </table>
  83
  84 <hr>
  85 <a name="Introduction"></a>
  86 <div class="header">
  87 <p>
  88 Next: <a href="#Access-Control" accesskey="n" rel="next">Access Control</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
  89 </div>
  90 <a name="Overview-of-pwmd"></a>
  91 <h2 class="chapter">1 Overview of <code>pwmd</code></h2>
  92
  93
  94
  95
  96
  97
  98 <p><em>Password Manager Daemon</em> (or <code>pwmd</code>) is a server that
  99 applications connect to and send commands to put and get data
 100 that is stored in an OpenPGP encrypted XML document. It mimics a
 101 filesystem in a lot of ways including per element ACL&rsquo;s, but also has
 102 the advantage of remote connections over TLS and a document cache. The
 103 document cache is needed for a data file encrypted with keys stored on a
 104 smartcard.
 105 </p>
 106 <p>The server uses the Assuan protocol (See <a href="http://www.gnupg.org/documentation/manuals/assuan/Implementation.html#Implementation">(assuan)Implementation</a>) which
 107 is the same used by <code>gpg-agent</code>, <code>pinentry</code> and
 108 <code>scdaemon</code>. It also uses <cite>libgpg-error</cite> for error reporting with
 109 <var>GPG_ERR_SOURCE_USER_1</var> being the error source.
 110 </p>
 111
 112 <p>The XML document uses the following DTD:
 113 </p>
 114 <div class="example">
 115 <pre class="example">    &lt;?xml version=&quot;1.0&quot;?&gt;
 116     &lt;!DOCTYPE pwmd [
 117     &lt;!ELEMENT pwmd (element*)&gt;
 118     &lt;!ATTLIST element _name CDATA #REQUIRED&gt;
 119     ]&gt;
 120 </pre></div>
 121
 122 <p>The <code>pwmd</code> element is the document root node while all other elements
 123 of the document have the name <code>element</code> with an attribute <code>_name</code>
 124 whose value uniquely identifies the element at the current element tree depth.
 125 It is done this way to avoid XML parsing errors for commonly used
 126 characters.  A URL for example would be an invalid XML element
 127 since the URI contains a &lsquo;<samp>:</samp>&rsquo; which is also the XML
 128 namespace separator.
 129 </p>
 130 <p>As mentioned, an element name must be unique for the current element tree
 131 depth. You cannot have two elements containing the same <code>_name</code> attribute
 132 value. <code>pwmd</code> will stop searching for an element of an <em>element
 133 path</em> at the first match then continue searching for the next element of the
 134 element path beginning at the child node of the matched element.
 135 </p>
 136 <p>An <em>element path</em> is a <code>TAB</code> delimited character string where each
 137 <code>TAB</code> separates each element in the path.  For example, the element path
 138 <code>a<code>TAB</code>b<code>TAB</code>c</code> has the following XML document structure:
 139 </p>
 140 <div class="example">
 141 <pre class="example">   &lt;pwmd&gt;
 142             &lt;element _name=&quot;a&quot;&gt;
 143                 &lt;element _name=&quot;b&quot;&gt;
 144                     &lt;element _name=&quot;c&quot;&gt;
 145                         [... element value or content ...]
 146                     &lt;/element&gt;
 147                 &lt;/element&gt;
 148             &lt;/element&gt;
 149         &lt;/pwmd&gt;
 150 </pre></div>
 151
 152 <p>The only restriction of an element name is that it contain no whitespace
 153 characters.
 154 </p>
 155 <hr>
 156 <a name="Access-Control"></a>
 157 <div class="header">
 158 <p>
 159 Next: <a href="#Invoking" accesskey="n" rel="next">Invoking</a>, Previous: <a href="#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 160 </div>
 161 <a name="Access-Control-1"></a>
 162 <h2 class="chapter">2 Access Control</h2>
 163
 164 <p>Like a filesystem has an ACL to grant or limit access to directories or
 165 files for a specific user or group, <code>pwmd</code> can limit a local user,
 166 group or a TLS connection to a specific element path. This is done by
 167 storing an ACL in the element attribute <var>_acl</var>. Its syntax is
 168 similar to the <var>allowed</var> configuration parameter (see <a href="#Configuration">Configuration</a>)
 169 with the exception that a TLS fingerprint hash is prefixed with a
 170 <code>#</code>.
 171 </p>
 172 <p>Access is denied for all users that are not in the ACL of an element
 173 with the exception of an invoking user (see the <var>invoking_user</var>). The
 174 connected client must be in the ACL for each element in an element path
 175 otherwise an error is returned.  As an example:
 176 </p>
 177 <div class="example">
 178 <pre class="example">&lt;element _name=&quot;test&quot; _acl=&quot;username,-@wheel,root,#ABCDEF&quot;&gt;
 179         &lt;element _name=&quot;child&quot;/&gt;
 180 &lt;/element&gt;
 181 </pre></div>
 182
 183 <p>The user <code>username</code> would be allowed access to the <code>test</code> element
 184 but not if it is a member of the <code>wheel</code> group although, the <code>root</code>
 185 user, who may be a member of the <code>wheel</code> group, is allowed. The SHA-256
 186 TLS fingerprint hash <code>#ABCDEF</code> is also allowed.  No users other than an
 187 <var>invoking_user</var> are allowed access to the <code>child</code> element.
 188 </p>
 189 <p>The first user listed in the ACL is considered the owner of the
 190 element. This determines which clients may modify an <var>_acl</var> attribute and
 191 store content for an element. An <var>invoking_user</var> may always modify an
 192 ACL.
 193 </p>
 194 <hr>
 195 <a name="Invoking"></a>
 196 <div class="header">
 197 <p>
 198 Next: <a href="#Configuration" accesskey="n" rel="next">Configuration</a>, Previous: <a href="#Access-Control" accesskey="p" rel="prev">Access Control</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 199 </div>
 200 <a name="Invoking-pwmd"></a>
 201 <h2 class="chapter">3 Invoking <code>pwmd</code></h2>
 202
 203
 204
 205 <p><code>pwmd</code> uses GpgME for encryption, decryption and signing of the
 206 OpenPGP data file. GpgME itself makes use of <code>gpg</code> for
 207 these operations so some configuration of <code>gpg</code> may also be needed.
 208 </p>
 209 <p>It is recommended to pass the <samp>--allow-preset-passphrase</samp>
 210 command line option to <code>gpg-agent</code>. Doing so allows <code>pwmd</code>
 211 cache pushing on startup. It is also recommended to pass the
 212 <samp>--allow-loopback-pinentry</samp> to <code>gpg-agent</code>. This option allows
 213 a passphrase to be inquired from <code>pwmd</code> when a <code>pinentry</code> is
 214 unavailable to the client (see <a href="#TLS">TLS</a>). See <a href="#Configuration">Configuration</a> for details
 215 about the <var>gpg_homedir</var> parameter.
 216 </p>
 217 <a name="index-Running-pwmd"></a>
 218 <p><code>pwmd</code> is executed as follows:
 219 </p>
 220 <div class="example">
 221 <pre class="example">pwmd <var>options</var> [ file1 ] [ &hellip; ]
 222 </pre></div>
 223
 224 <p>Non-option arguments are data files to cache upon startup. When the data file
 225 requires a passphrase for decryption a <code>pinentry</code> will prompt either
 226 on the current TTY or from an X11 window when the <code>DISPLAY</code>
 227 environment variable is set. See <a href="#Pinentry">Pinentry</a>.
 228 </p>
 229 <a name="index-Options"></a>
 230 <a name="index-Arguments"></a>
 231 <p>The following command line options are supported:
 232 </p>
 233 <a name="index-Getting-help"></a>
 234 <dl compact="compact">
 235 <dt>&lsquo;<samp>--debug protocol:level[,protocol:level]</samp>&rsquo;</dt>
 236 <dd><p>Enable debugging output. This option can output sensitive information such as
 237 passphrases and secret keys so care should be taken where the output gets
 238 written to. The <var>protocol</var> is a single character representing the protocol
 239 to log. Use <code>a</code> for <code>libassuan</code> with <var>level</var> being one or more
 240 character flags: <code>i</code> for init, <code>x</code> for context, <code>e</code> for engine,
 241 <code>d</code> for data, <code>s</code> for system IO or <code>c</code> for control.  To debug
 242 <code>gpgme</code> use <code>g</code> as the <var>protocol</var> with <var>level</var> being an
 243 integer from <code>1</code> to <code>9</code>. To enable <acronym>TLS</acronym> debugging output
 244 use <code>t</code> as the <var>protocol</var> with <var>level</var> being an integer from
 245 <code>1</code> to <code>9</code>. A value over <code>10</code> will enable all <acronym>TLS</acronym>
 246 debugging output with <code>1</code> being the default.
 247 </p>
 248 </dd>
 249 <dt>&lsquo;<samp>--homedir directory</samp>&rsquo;</dt>
 250 <dd><p>The root directory where pwmd will store its data and temporary files.  The
 251 default is <samp>~/.pwmd</samp>.
 252 </p>
 253 </dd>
 254 <dt>&lsquo;<samp>--rcfile, -f rcfile</samp>&rsquo;</dt>
 255 <dd><p>Specify an alternate configuration file. The default is
 256 <samp>~/.pwmd/config</samp>.
 257 </p>
 258 </dd>
 259 <dt>&lsquo;<samp>--kill</samp>&rsquo;</dt>
 260 <dd><p>Terminate an existing instance of pwmd. The process to terminate is determined
 261 from the <samp>--homedir</samp> and <samp>--rcfile</samp> options.
 262 </p>
 263 </dd>
 264 <dt>&lsquo;<samp>--import, -I filename|-</samp>&rsquo;</dt>
 265 <dd><p>Imports the XML <var>filename</var>. When <var>filename</var> is <code>-</code> the
 266 XML is read from stdin. The XML file should be in conformance to
 267 the <code>pwmd</code> DTD (see <a href="#Introduction">Introduction</a>). You will be prompted for
 268 a passphrase to encrypt with.  The output is written to the filename specified
 269 with <samp>--outfile</samp>. To make use of the imported data, place the output
 270 file in <samp>~/.pwmd/data</samp>.
 271 </p>
 272 </dd>
 273 <dt>&lsquo;<samp>--output, -o filename|-</samp>&rsquo;</dt>
 274 <dd><p>When importing, write the encrypted data file to <var>filename</var>. When
 275 <var>filename</var> is <code>-</code> output will be written to stdout.
 276 </p>
 277 </dd>
 278 <dt>&lsquo;<samp>--passphrase-file, -k filename&quot;</samp>&rsquo;</dt>
 279 <dd><p>Obtain the passphrase to use when importing from the specified <var>filename</var>.
 280 </p>
 281 </dd>
 282 <dt>&lsquo;<samp>--keyparam filename</samp>&rsquo;</dt>
 283 <dd><p>The key parameters to use when generating a new key pair while importing an
 284 XML file. The file contents must be in GnuPG XML format.
 285 </p>
 286 </dd>
 287 <dt>&lsquo;<samp>--keyid fingerprint[,&lt;fingerprint&gt;]</samp>&rsquo;</dt>
 288 <dd><p>Specifies the fingerprint of the encryption key to use as a recipient when
 289 importing. When not specified a new key-pair will be created.
 290 </p>
 291 </dd>
 292 <dt>&lsquo;<samp>--sign-keyid fingerprint[,&lt;fingerprint&gt;]</samp>&rsquo;</dt>
 293 <dd><p>Specifies the fingerprint of the signing key to use for signing of the data
 294 file when importing.  When not specified the signing key of the generated
 295 key-pair or the signing key of the <samp>--keyid</samp> option will be used.
 296 </p>
 297 </dd>
 298 <dt>&lsquo;<samp>--symmetric, -s</samp>&rsquo;</dt>
 299 <dd><p>Use symmetric or conventional encryption rather than pubic key encryption when
 300 importing.  Signing is still possible by using the <samp>--sign-keyid</samp>
 301 option. By default no signing is done when specifying this option.
 302 </p>
 303 </dd>
 304 <dt>&lsquo;<samp>--disable-dump</samp>&rsquo;</dt>
 305 <dd><p>Disable the <code>XPATH</code>, <code>XPATHATTR</code>, <code>LIST</code> and <code>DUMP</code>
 306 protocol commands (see <a href="#Commands">Commands</a>). This overrides any
 307 <var>disable_list_and_dump</var> configuration parameter (see <a href="#Configuration">Configuration</a>).
 308 </p>
 309 </dd>
 310 <dt>&lsquo;<samp>--no-fork, -n</samp>&rsquo;</dt>
 311 <dd><p>Run as a foreground process and do not fork into the background.
 312 </p>
 313 </dd>
 314 <dt>&lsquo;<samp>--ignore, --force</samp>&rsquo;</dt>
 315 <dd><p>Ignore cache pushing failures on startup. By default, <code>pwmd</code> will exit
 316 if an error occurred do to an invalid passphrase or other error.
 317 </p>
 318 </dd>
 319 <dt>&lsquo;<samp>--version</samp>&rsquo;</dt>
 320 <dd><p>Show the version, copyright and compile time features and exit.
 321 </p>
 322 </dd>
 323 <dt>&lsquo;<samp>--help</samp>&rsquo;</dt>
 324 <dd><p>Print a summary of options.
 325 </p></dd>
 326 </dl>
 327
 328
 329 <hr>
 330 <a name="Configuration"></a>
 331 <div class="header">
 332 <p>
 333 Next: <a href="#TLS" accesskey="n" rel="next">TLS</a>, Previous: <a href="#Invoking" accesskey="p" rel="prev">Invoking</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 334 </div>
 335 <a name="pwmd-configuration-file-options"></a>
 336 <h2 class="chapter">4 <code>pwmd</code> configuration file options</h2>
 337
 338
 339 <p>If no configuration file is specified with the <code>pwmd</code> <samp>-f</samp>
 340 command line option, <code>pwmd</code> will read <samp>~/.pwmd/config</samp> if it
 341 exists, and if not, will use defaults.  Blank lines and lines beginning with
 342 &lsquo;<samp>#</samp>&rsquo; are ignored. Some parameters may have data file specific settings by
 343 placing them in a file section. A file section is declared by surrounding the
 344 filename with braces (i.e., &lsquo;<samp>[filename]</samp>&rsquo;).  Global options may be
 345 specified in the <code>global</code> section &lsquo;<samp>e.g., [global]</samp>&rsquo; and are the
 346 default options for new or unspecified file sections.
 347 </p>
 348 <p>A tilde <code>~</code> will be expanded to the home directory of the user starting
 349 <code>pwmd</code> when contained in a parameter whose value is a filename.
 350 </p>
 351 <a name="index-Reloading-the-configuration-file"></a>
 352 <p>The configuration file can be reloaded by sending the <em>SIGHUP</em> signal to
 353 a <code>pwmd</code> process. Some security sensitive settings may not be used
 354 until <code>pwmd</code> is restarted.
 355 </p>
 356 <a name="index-Global-configuration-options"></a>
 357 <p>The following options are only for use in the <code>[global]</code> section:
 358 </p>
 359 <dl compact="compact">
 360 <dt>&lsquo;<samp>socket_path = /path/to/socket</samp>&rsquo;</dt>
 361 <dd><p>Listen on the specified socket. The default is <samp>~/.pwmd/socket</samp>.
 362 </p>
 363 </dd>
 364 <dt>&lsquo;<samp>socket_perms = octal_mode</samp>&rsquo;</dt>
 365 <dd><p>Permissions to set after creating the socket. This will override any
 366 <cite>umask(2)</cite> setting.
 367 </p>
 368 </dd>
 369 <dt>&lsquo;<samp>backlog = integer</samp>&rsquo;</dt>
 370 <dd><p>The number of connections to queue. When this limit is reached then new
 371 connections will be refused. The default is <code>128</code>.
 372 </p>
 373 </dd>
 374 <dt>&lsquo;<samp>invoking_user = [-!]user,[-!]@group,[-!]#SHA-256,...</samp>&rsquo;</dt>
 375 <dd><p>This parameter is not to be confused with setuid or setguid upon startup. It&rsquo;s
 376 syntax is the same as the <code>allowed</code> parameter except that it is a list of
 377 local usernames, group names and TLS fingerprint hashes that may use the
 378 <code>XPATH</code>, <code>XPATHATTR</code> and <code>DUMP</code> commands (except when
 379 disabled with the <code>disable_list_and_dump</code> option) and also who may modify
 380 elements that have no <code>_acl</code> attribute or is not listed in an
 381 <code>_acl</code>. It is similar to the system administrator root account but for a
 382 data file and element paths (see <a href="#Access-Control">Access Control</a>). The default is the user
 383 the executes <code>pwmd</code>.
 384 </p>
 385 </dd>
 386 <dt>&lsquo;<samp>invoking_file = filename</samp>&rsquo;</dt>
 387 <dd><p>A file containing one entry per line. An entry has the same syntax as the
 388 <code>invoking_user</code> parameter. When both this parameter and the
 389 <code>invoking_user</code> parameter are specified then the <code>invoking_user</code>
 390 parameter will behave as if the <code>invoking_file</code> entries have been
 391 appended to the <code>invoking_user</code> parameter value.
 392 </p>
 393 </dd>
 394 <dt>&lsquo;<samp>strict_kill = boolean</samp>&rsquo;</dt>
 395 <dd><p>When <code>false</code>, the <code>KILL</code> command (see <a href="#KILL">KILL</a>) will allow killing
 396 another client that is not of the same <code>UID</code> or TLS fingerprint of
 397 the current client and when not the <code>invoking_user</code>. The default us
 398 <code>false</code>.
 399 </p>
 400 </dd>
 401 <dt>&lsquo;<samp>allowed = [-!]user,[-!]@group,[+,][-!]#SHA-256,...</samp>&rsquo;</dt>
 402 <dd><p>A comma separated list of local user names, group names or TLS
 403 fingerprint SHA-256 hashes (in the case of a remote client) who are
 404 allowed to connect.  Groups should be prefixed with a &lsquo;<samp>@</samp>&rsquo;. When not
 405 specified only the user who started <code>pwmd</code> may connect. A username,
 406 group name or hash may also be prefixed with a <code>-</code> or <code>!</code> to prevent
 407 access to a specific user or group in the list. The order of the list is
 408 important since a user may be a member of multiple groups.
 409 </p>
 410 <p>This parameter may also be specified in a filename section to allow or deny a
 411 client to <code>OPEN</code> (see <a href="#OPEN">OPEN</a>) a data file. It also affects the cache
 412 commands <code>CLEARCACHE</code> (see <a href="#CLEARCACHE">CLEARCACHE</a>) and <code>CACHETIMEOUT</code>
 413 (see <a href="#CACHETIMEOUT">CACHETIMEOUT</a>). When not specified in a file section, any user that
 414 can connect may also open any filename (provided they can decrypt it).
 415 </p>
 416 <p>The following example would deny all users in group <code>primary</code> but
 417 allow <code>username</code> who may be a member of <code>primary</code>. It will also
 418 allow any TLS client except for the client with TLS fingerprint hash
 419 <code>#ABCDEF</code>:
 420 </p>
 421 <div class="example">
 422 <pre class="example">allowed=-@primary,username,+,!#ABCDEF
 423 </pre></div>
 424
 425 </dd>
 426 <dt>&lsquo;<samp>allowed_file = filename</samp>&rsquo;</dt>
 427 <dd><p>A file containing one entry per line. An entry has the same syntax as the
 428 <code>allowed</code> parameter. When both this parameter and the <code>allowed</code>
 429 parameter are specified then the <code>allowed_file</code> entries will be appended
 430 to the <code>allowed</code> parameter value.
 431 </p>
 432 </dd>
 433 <dt>&lsquo;<samp>encrypt_to = boolean</samp>&rsquo;</dt>
 434 <dd><p>When <code>true</code> and <code>SAVE</code>&rsquo;ing a data file, allow <code>gpg</code> to
 435 append it&rsquo;s configured key to the list of recipients. The default is
 436 <code>false</code> meaning that only keys specified with <code>SAVE</code>
 437 <samp>--keyid</samp> are recipients.
 438 </p>
 439 </dd>
 440 <dt>&lsquo;<samp>always_trust = boolean</samp>&rsquo;</dt>
 441 <dd><p>When <code>true</code>, allow encrypting to untrusted recipients or public
 442 encryption keys. The default is <code>false</code>.
 443 </p>
 444 </dd>
 445 <dt>&lsquo;<samp>gpg_homedir = path</samp>&rsquo;</dt>
 446 <dd><p>The location where <code>gpg</code> will store its public and private keys and
 447 configuration. The default is <samp>HOMEDIR/.gnupg</samp> where <var>HOMEDIR</var> is the
 448 default (<samp>~/.pwmd</samp>) or the value specified on the command line with the
 449 <samp>--homedir</samp> command line option (see <a href="#Invoking">Invoking</a>). If you want to use
 450 your standard <code>gpg</code> keyring then set this to <samp>~/.gnupg</samp>. Note
 451 that a new instance of <code>gpg-agent</code> will be started when <em>not</em>
 452 using the standard keyring and that any configuration options for
 453 <code>gpg-agent</code> will need to placed in
 454 <samp>HOMEDIR/.gnupg/gpg-agent.conf</samp>.
 455 </p>
 456 </dd>
 457 <dt>&lsquo;<samp>disable_mlockall = boolean</samp>&rsquo;</dt>
 458 <dd><p>When set to <code>false</code>, <cite>mlockall(2)</cite> will be called on startup.  This
 459 will use more physical memory but may also be more secure since no swapping to
 460 disk will occur. The default is <var>true</var>. If possible, use an encrypted swap
 461 file or partition and leave this set to <var>true</var>.
 462 </p>
 463 </dd>
 464 <dt>&lsquo;<samp>log_path = /path/to/logfile</samp>&rsquo;</dt>
 465 <dd><p>Logs informational messages to the specified file. The default is
 466 <samp>~/.pwmd/log</samp>.
 467 </p>
 468 </dd>
 469 <dt>&lsquo;<samp>enable_logging = boolean</samp>&rsquo;</dt>
 470 <dd><p>Enable or disable logging to <var>log_path</var>. The default is <code>false</code>.
 471 </p>
 472 </dd>
 473 <dt>&lsquo;<samp>log_keepopen = boolean</samp>&rsquo;</dt>
 474 <dd><p>When set to <code>false</code>, the log file specified with <var>log_path</var> will be
 475 closed after writing each line. The default is <code>true</code>.
 476 </p>
 477 </dd>
 478 <dt>&lsquo;<samp>syslog = boolean</samp>&rsquo;</dt>
 479 <dd><p>Enable logging to <cite>syslog(8)</cite> with facility <em>LOG_DAEMON</em> and priority
 480 <em>LOG_INFO</em>. The default is <code>false</code>.
 481 </p>
 482 </dd>
 483 <dt>&lsquo;<samp>log_level = level</samp>&rsquo;</dt>
 484 <dd><p>When <code>0</code>, only connections and errors are logged. When <code>1</code>, data
 485 file recipients and signers are logged during <code>OPEN</code> (see <a href="#OPEN">OPEN</a>) and
 486 <code>SAVE</code> (see <a href="#SAVE">SAVE</a>). When <code>2</code>, client commands are also logged.
 487 The default is <code>0</code>.
 488 </p>
 489 </dd>
 490 <dt>&lsquo;<samp>kill_scd = boolean</samp>&rsquo;</dt>
 491 <dd><p>Kill <code>scdaemon</code> after each <code>OPEN</code> (see <a href="#OPEN">OPEN</a>),
 492 <code>SAVE</code> (see <a href="#SAVE">SAVE</a>) or <code>PASSWD</code> (see <a href="#PASSWD">PASSWD</a>) command. The
 493 default is <code>false</code>.
 494 </p>
 495 </dd>
 496 <dt>&lsquo;<samp>disable_list_and_dump = boolean</samp>&rsquo;</dt>
 497 <dd><p>When <code>true</code>, the <code>XPATH</code>, <code>XPATHATTR</code>, <code>LIST</code> and
 498 <code>DUMP</code> protocol commands (see <a href="#Commands">Commands</a>) will be disabled.
 499 </p>
 500 </dd>
 501 <dt>&lsquo;<samp>cache_push = file1,file2</samp>&rsquo;</dt>
 502 <dd><p>A comma separated list of filenames that will be pushed into the file cache
 503 upon startup. <code>pwmd</code> will prompt for the passphrase for each file
 504 unless specified with <var>passphrase_file</var> parameter in a matching file
 505 section.
 506 </p>
 507 </dd>
 508 <dt>&lsquo;<samp>priority = integer</samp>&rsquo;</dt>
 509 <dd><p>The priority, or niceness, of the server. The default is inherited from the
 510 parent process.
 511 </p>
 512 </dd>
 513 <dt>&lsquo;<samp>lock_timeout = integer</samp>&rsquo;</dt>
 514 <dd><p>The default timeout in tenths of a second before giving up waiting for a file
 515 lock and returning an error. The default is <code>50</code>.
 516 </p>
 517 </dd>
 518 </dl>
 519
 520 <a name="index-Data-file-configuration-options"></a>
 521 <p>The following options are defaults for new files when specified in the
 522 &lsquo;<samp>global</samp>&rsquo; section. When placed in a data file section they are options
 523 specific to that data file only.
 524 </p>
 525 <dl compact="compact">
 526 <dt>&lsquo;<samp>require_save_key = boolean</samp>&rsquo;</dt>
 527 <dd><p>Require the passphrase needed for signing before writing changes of the
 528 document to disk reguardless of the key cache status. The default is
 529 <code>true</code>. This option compliments <code>gpg-agent</code> option
 530 <samp>--ignore-cache-for-signing</samp> and is used as a fail-safe.
 531 </p>
 532 </dd>
 533 <dt>&lsquo;<samp>backup = boolean</samp>&rsquo;</dt>
 534 <dd><p>Whether to create a backup of the data file when saving. The backup filename
 535 has the <samp>.backup</samp> extension appended to the opened file. The default is
 536 <code>true</code>.
 537 </p>
 538 </dd>
 539 <dt>&lsquo;<samp>cache_timeout = seconds</samp>&rsquo;</dt>
 540 <dd><p>The number of seconds to keep the cache entry for this file. If <code>-1</code>, the
 541 cache entry is kept forever. If <code>0</code>, each time an encrypted file is
 542 <code>OPEN</code>ed (see <a href="#OPEN">OPEN</a>) a passphrase will be required. The default
 543 is <code>600</code> or 10 minutes.
 544 </p>
 545 </dd>
 546 <dt>&lsquo;<samp>xfer_progress = bytes</samp>&rsquo;</dt>
 547 <dd><p>Commands that send data lines to the client will also send the <code>XFER</code>
 548 status message (see <a href="#Status-Messages">Status Messages</a>) after the specified number of bytes
 549 have been sent. The number of bytes is rounded to <var>ASSUAN_LINELENGTH</var> or
 550 <code>1002</code> bytes. The default is <code>8196</code>.
 551 </p>
 552 </dd>
 553 <dt>&lsquo;<samp>passphrase_file = /path/to/filename</samp>&rsquo;</dt>
 554 <dd><p>Obtain the passphrase to open the data file from <var>filename</var>. If specified
 555 in the &lsquo;<samp>global</samp>&rsquo; section then the <var>passphrase_file</var> is a default for
 556 all data files. Note that if a client changes the passphrase for this data
 557 file then the <var>passphrase_file</var> will need to be updated with the new
 558 passphrase.
 559 </p>
 560 </dd>
 561 <dt>&lsquo;<samp>recursion_depth = integer</samp>&rsquo;</dt>
 562 <dd><p>The maximum number of times to resolve a <code>target</code> attribute for an
 563 element in an element path (see <a href="#Target-Attribute">Target Attribute</a>). An error is returned
 564 when this value is exceeded.  The default is <code>100</code> but can be disabled by
 565 setting to <code>0</code> (<em>not recommended</em>).
 566 </p>
 567 </dd>
 568 <dt>&lsquo;<samp>allowed = [-]user,[-]@group,[!]#TLSFINGERPRINT,...</samp>&rsquo;</dt>
 569 <dd><p>Same parameter value as the <code>allowed</code> parameter mentioned above in
 570 the &lsquo;<samp>[global]</samp>&rsquo; section but grants or denies a client from opening a
 571 specific data file. The default is to allow any client that is allowed to
 572 connect.
 573 </p>
 574 </dd>
 575 </dl>
 576 <table class="menu" border="0" cellspacing="0">
 577 <tr><td align="left" valign="top">&bull; <a href="#TLS" accesskey="1">TLS</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Remote connections over TLS.
 578 </td></tr>
 579 <tr><td align="left" valign="top">&bull; <a href="#Pinentry" accesskey="2">Pinentry</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Configuration file and defaults.
 580 </td></tr>
 581 </table>
 582
 583 <hr>
 584 <a name="TLS"></a>
 585 <div class="header">
 586 <p>
 587 Next: <a href="#Pinentry" accesskey="n" rel="next">Pinentry</a>, Previous: <a href="#Configuration" accesskey="p" rel="prev">Configuration</a>, Up: <a href="#Configuration" accesskey="u" rel="up">Configuration</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 588 </div>
 589 <a name="Configuring-remote-connections-over-TLS_002e"></a>
 590 <h2 class="chapter">5 Configuring remote connections over TLS.</h2>
 591 <p>Remote connections can also be made to <code>pwmd</code> over TLS.
 592 Authentication is done by using X.509 client certificates that are signed with
 593 the same Certificate Authority (CA) as the server certificate.
 594 </p>
 595 <p>The CA certificate is expected to be found in
 596 <samp>~/.pwmd/ca-cert.pem</samp> while the <code>pwmd</code> server certificate and key
 597 file should be put in <samp>~/.pwmd/server-cert.pem</samp> and
 598 <samp>~/.pwmd/server-key.pem</samp>, respectively.
 599 </p>
 600 <p>See the documentation of <code>certtool</code> or <code>openssl</code> for details
 601 about creating self-signed certificates.
 602 </p>
 603 <p>The following TLS configuration options are available:
 604 </p>
 605 <dl compact="compact">
 606 <dt>&lsquo;<samp>enable_tcp = boolean</samp>&rsquo;</dt>
 607 <dd><p>Whether to enable TCP/TLS server support. If enabled, both TCP and the local
 608 unix domain socket will listen for connections. The default is
 609 <code>false</code>.
 610 </p>
 611 </dd>
 612 <dt>&lsquo;<samp>tcp_port = integer</samp>&rsquo;</dt>
 613 <dd><p>The TCP port to listen on when <var>enable_tcp</var> is <code>true</code>. The default is
 614 <code>6466</code>.
 615 </p>
 616 </dd>
 617 <dt>&lsquo;<samp>tcp_bind = string</samp>&rsquo;</dt>
 618 <dd><p>The internet protocol to listen with. Must be one of <code>ipv4</code>, <code>ipv6</code>
 619 or <code>any</code> to listen for both IPv4 and IPv6 connections. The default is
 620 <code>any</code>.
 621 </p>
 622 </dd>
 623 <dt>&lsquo;<samp>tcp_interface = string</samp>&rsquo;</dt>
 624 <dd><p>Only useful if running as root.
 625 </p>
 626 </dd>
 627 <dt>&lsquo;<samp>tls_timeout = seconds</samp>&rsquo;</dt>
 628 <dd><p>The number of seconds to wait for a read() or write() call on a
 629 TLS client file descriptor to complete before returning an
 630 error. The default is <var>300</var>.
 631 </p>
 632 </dd>
 633 <dt>&lsquo;<samp>keepalive_interval = seconds</samp>&rsquo;</dt>
 634 <dd><p>Send a keepalive status message to an idle remote client.  An idle
 635 client is one that is not in a command. The purpose of this status
 636 message is to disconnect a hung remote client and release any file mutex
 637 locks so another client may open the same data file. The default is <code>60</code>.
 638 </p>
 639 </dd>
 640 <dt>&lsquo;<samp>tcp_require_key = boolean</samp>&rsquo;</dt>
 641 <dd><p>When <code>true</code>, require the remote client to provide the passphrase to open
 642 a data file even if the file is cached.  This option is a default for all
 643 files when specified in the &lsquo;<samp>[global]</samp>&rsquo; section. The default is
 644 <code>false</code>.
 645 </p>
 646 </dd>
 647 <dt>&lsquo;<samp>tls_cipher_suite = string</samp>&rsquo;</dt>
 648 <dd><p>The GnuTLS cipher suite and protocol to use. See the GnuTLS documentation for
 649 information about the format of this string. The default is
 650 <code>SECURE256:SECURE192:SECURE128:-VERS-SSL3.0:-VERS-TLS1.0</code>.
 651 </p>
 652 </dd>
 653 <dt>&lsquo;<samp>tls_dh_params_file = filename</samp>&rsquo;</dt>
 654 <dd><p>The PEM encoded filename containing DH parameters. If not specified
 655 then DH algorithms will not be available to the client. See the
 656 <code>openssl dhparam</code> or <code>certtool</code> manual pages for details about
 657 generating this file.
 658 </p>
 659 <p>Note that SIGHUP will not reload this file once TLS support has been enabled.
 660 You will need to restart <code>pwmd</code> for changes to take effect.
 661 </p></dd>
 662 </dl>
 663
 664 <hr>
 665 <a name="Pinentry"></a>
 666 <div class="header">
 667 <p>
 668 Next: <a href="#Commands" accesskey="n" rel="next">Commands</a>, Previous: <a href="#TLS" accesskey="p" rel="prev">TLS</a>, Up: <a href="#Configuration" accesskey="u" rel="up">Configuration</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 669 </div>
 670 <a name="Pinentry-configuration"></a>
 671 <h2 class="chapter">6 Pinentry configuration</h2>
 672
 673 <p>The <code>pinentry</code> program is used to prompt the user for passphrase
 674 input or as a confirmation dialog; it needs to know where to prompt for
 675 the input, beit from a terminal or an X11 display.
 676 </p>
 677 <p>It is the responsibility of the client to tell <code>pinentry</code> about the
 678 terminal or X11 display before requiring the input. This is done with the
 679 <code>OPTION</code> command (see <a href="#OPTION">OPTION</a>) to either set or unset needed
 680 <code>pwmd</code> environment variables and by using the
 681 <code>gpg-connect-agent</code> program. Please read it&rsquo;s documentation about the
 682 <em>UPDATESTARTUPTTY</em> command.
 683 </p>
 684 <hr>
 685 <a name="Commands"></a>
 686 <div class="header">
 687 <p>
 688 Next: <a href="#Status-Messages" accesskey="n" rel="next">Status Messages</a>, Previous: <a href="#Pinentry" accesskey="p" rel="prev">Pinentry</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 689 </div>
 690 <a name="Protocol-commands-and-their-syntax"></a>
 691 <h2 class="chapter">7 Protocol commands and their syntax</h2>
 692 <table class="menu" border="0" cellspacing="0">
 693 <tr><td align="left" valign="top">&bull; <a href="#ATTR" accesskey="1">ATTR</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 694 </td></tr>
 695 <tr><td align="left" valign="top">&bull; <a href="#CACHETIMEOUT" accesskey="2">CACHETIMEOUT</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 696 </td></tr>
 697 <tr><td align="left" valign="top">&bull; <a href="#CLEARCACHE" accesskey="3">CLEARCACHE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 698 </td></tr>
 699 <tr><td align="left" valign="top">&bull; <a href="#COPY" accesskey="4">COPY</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 700 </td></tr>
 701 <tr><td align="left" valign="top">&bull; <a href="#DELETE" accesskey="5">DELETE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 702 </td></tr>
 703 <tr><td align="left" valign="top">&bull; <a href="#DUMP" accesskey="6">DUMP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 704 </td></tr>
 705 <tr><td align="left" valign="top">&bull; <a href="#GET" accesskey="7">GET</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 706 </td></tr>
 707 <tr><td align="left" valign="top">&bull; <a href="#GETCONFIG" accesskey="8">GETCONFIG</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 708 </td></tr>
 709 <tr><td align="left" valign="top">&bull; <a href="#GETINFO" accesskey="9">GETINFO</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 710 </td></tr>
 711 <tr><td align="left" valign="top">&bull; <a href="#HELP">HELP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 712 </td></tr>
 713 <tr><td align="left" valign="top">&bull; <a href="#IMPORT">IMPORT</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 714 </td></tr>
 715 <tr><td align="left" valign="top">&bull; <a href="#ISCACHED">ISCACHED</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 716 </td></tr>
 717 <tr><td align="left" valign="top">&bull; <a href="#KEYINFO">KEYINFO</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 718 </td></tr>
 719 <tr><td align="left" valign="top">&bull; <a href="#KILL">KILL</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 720 </td></tr>
 721 <tr><td align="left" valign="top">&bull; <a href="#LIST">LIST</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 722 </td></tr>
 723 <tr><td align="left" valign="top">&bull; <a href="#LISTKEYS">LISTKEYS</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 724 </td></tr>
 725 <tr><td align="left" valign="top">&bull; <a href="#LOCK">LOCK</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 726 </td></tr>
 727 <tr><td align="left" valign="top">&bull; <a href="#LS">LS</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 728 </td></tr>
 729 <tr><td align="left" valign="top">&bull; <a href="#MOVE">MOVE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 730 </td></tr>
 731 <tr><td align="left" valign="top">&bull; <a href="#NOP">NOP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 732 </td></tr>
 733 <tr><td align="left" valign="top">&bull; <a href="#OPEN">OPEN</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 734 </td></tr>
 735 <tr><td align="left" valign="top">&bull; <a href="#OPTION">OPTION</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 736 </td></tr>
 737 <tr><td align="left" valign="top">&bull; <a href="#PASSWD">PASSWD</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 738 </td></tr>
 739 <tr><td align="left" valign="top">&bull; <a href="#REALPATH">REALPATH</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 740 </td></tr>
 741 <tr><td align="left" valign="top">&bull; <a href="#RENAME">RENAME</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 742 </td></tr>
 743 <tr><td align="left" valign="top">&bull; <a href="#RESET">RESET</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 744 </td></tr>
 745 <tr><td align="left" valign="top">&bull; <a href="#SAVE">SAVE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 746 </td></tr>
 747 <tr><td align="left" valign="top">&bull; <a href="#STORE">STORE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 748 </td></tr>
 749 <tr><td align="left" valign="top">&bull; <a href="#UNLOCK">UNLOCK</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 750 </td></tr>
 751 <tr><td align="left" valign="top">&bull; <a href="#XPATH">XPATH</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 752 </td></tr>
 753 <tr><td align="left" valign="top">&bull; <a href="#XPATHATTR">XPATHATTR</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 754 </td></tr>
 755 </table>
 756 <hr>
 757 <a name="ATTR"></a>
 758 <div class="header">
 759 <p>
 760 Next: <a href="#CACHETIMEOUT" accesskey="n" rel="next">CACHETIMEOUT</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 761 </div>
 762 <a name="ATTR-command"></a>
 763 <h2 class="chapter">8 ATTR command</h2>
 764 <a name="index-ATTR-command"></a>
 765 <p>Syntax:
 766 </p><div class="example">
 767 <pre class="example">ATTR [--inquire] SET|GET|DELETE|LIST [&lt;attribute&gt;] element[&lt;TAB&gt;child[..]] ..
 768 </pre></div>
 769
 770 <dl compact="compact">
 771 <dt>ATTR SET attribute element[&lt;TAB&gt;child[..]] [value]</dt>
 772 <dd><p>Stores or updates an <var>attribute</var> name and optional <var>value</var> of an
 773 element. When no <var>value</var> is specified any existing value will be removed.
 774 <br><br>
 775 </p></dd>
 776 <dt>ATTR DELETE attribute element[&lt;TAB&gt;child[..]]</dt>
 777 <dd><p>Removes an attribute from an element. If <var>attribute</var> is <code>_name</code>
 778 or <code>target</code> an error is returned. Use the <code>DELETE</code> command
 779 (see <a href="#DELETE">DELETE</a>) instead.
 780 <br><br>
 781 </p></dd>
 782 <dt>ATTR LIST element[&lt;TAB&gt;child[..]]</dt>
 783 <dd><p>Retrieves a newline separated list of attributes names and values
 784 from the specified element. Each attribute name and value is space delimited.
 785 <br><br>
 786 </p></dd>
 787 <dt>ATTR GET attribute element[&lt;TAB&gt;child[..]]</dt>
 788 <dd><p>Retrieves the value of an <var>attribute</var> from an element.
 789 </p></dd>
 790 </dl>
 791 <br><br>
 792 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
 793 arguments are retrieved via a server <em>INQUIRE</em>.
 794 <br><br>
 795 See <a href="#Target-Attribute">Target Attribute</a>, for details about this special attribute and also
 796 see <a href="#Other-Attributes">Other Attributes</a> for other attributes that are handled specially
 797 by <code>pwmd</code>.
 798 </p>
 799
 800 <hr>
 801 <a name="CACHETIMEOUT"></a>
 802 <div class="header">
 803 <p>
 804 Next: <a href="#CLEARCACHE" accesskey="n" rel="next">CLEARCACHE</a>, Previous: <a href="#ATTR" accesskey="p" rel="prev">ATTR</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 805 </div>
 806 <a name="CACHETIMEOUT-command"></a>
 807 <h2 class="chapter">9 CACHETIMEOUT command</h2>
 808 <a name="index-CACHETIMEOUT-command"></a>
 809 <p>Syntax:
 810 </p><div class="example">
 811 <pre class="example">CACHETIMEOUT &lt;filename&gt; &lt;seconds&gt;
 812 </pre></div>
 813
 814 <p>The time in <var>seconds</var> until <var>filename</var> will be removed from the
 815 cache. <code>-1</code> will keep the cache entry forever, <code>0</code> will require
 816 the passphrase for each <code>OPEN</code> command (see <a href="#OPEN">OPEN</a>) or <code>SAVE</code>
 817 (see <a href="#SAVE">SAVE</a>) command. See <a href="#Configuration">Configuration</a>, and the <code>cache_timeout</code>
 818 parameter.
 819 </p>
 820
 821 <hr>
 822 <a name="CLEARCACHE"></a>
 823 <div class="header">
 824 <p>
 825 Next: <a href="#COPY" accesskey="n" rel="next">COPY</a>, Previous: <a href="#CACHETIMEOUT" accesskey="p" rel="prev">CACHETIMEOUT</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 826 </div>
 827 <a name="CLEARCACHE-command"></a>
 828 <h2 class="chapter">10 CLEARCACHE command</h2>
 829 <a name="index-CLEARCACHE-command"></a>
 830 <p>Syntax:
 831 </p><div class="example">
 832 <pre class="example">CLEARCACHE [&lt;filename&gt;]
 833 </pre></div>
 834
 835 <p>Clears a file cache entry for all or the specified <var>filename</var>. Note that
 836 this will also clear any <code>gpg-agent</code> cached keys which may cause
 837 problems if another data file shares the same keys as <var>filename</var>.
 838 <br><br>
 839 When clearing all cache entries a permissions test is done against the
 840 current client based on the <var>allowed</var> configuration parameter in a
 841 <var>filename</var> section. Both a cache entry may be cleared and an error
 842 returned depending on cached data files and client permissions.
 843 </p>
 844
 845 <hr>
 846 <a name="COPY"></a>
 847 <div class="header">
 848 <p>
 849 Next: <a href="#DELETE" accesskey="n" rel="next">DELETE</a>, Previous: <a href="#CLEARCACHE" accesskey="p" rel="prev">CLEARCACHE</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 850 </div>
 851 <a name="COPY-command"></a>
 852 <h2 class="chapter">11 COPY command</h2>
 853 <a name="index-COPY-command"></a>
 854 <p>Syntax:
 855 </p><div class="example">
 856 <pre class="example">COPY [--inquire] source[&lt;TAB&gt;child[..]] dest[&lt;TAB&gt;child[..]]
 857 </pre></div>
 858
 859 <p>Copies the entire element tree starting from the child node of the source
 860 element, to the destination element path. If the destination element path
 861 does not exist then it will be created; otherwise it is overwritten.
 862 <br><br>
 863 Note that attributes from the source element are merged into the
 864 destination element when the destination element path exists. When an
 865 attribute of the same name exists in both the source and destination
 866 elements then the destination attribute will be updated to the source
 867 attribute value.
 868 <br><br>
 869 When the <samp>--inquire</samp> option is passed then all remaining non-option
 870 arguments are retrieved via a server <em>INQUIRE</em>.
 871 </p>
 872
 873 <hr>
 874 <a name="DELETE"></a>
 875 <div class="header">
 876 <p>
 877 Next: <a href="#DUMP" accesskey="n" rel="next">DUMP</a>, Previous: <a href="#COPY" accesskey="p" rel="prev">COPY</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 878 </div>
 879 <a name="DELETE-command"></a>
 880 <h2 class="chapter">12 DELETE command</h2>
 881 <a name="index-DELETE-command"></a>
 882 <p>Syntax:
 883 </p><div class="example">
 884 <pre class="example">DELETE [--inquire] element[&lt;TAB&gt;child[..]]
 885 </pre></div>
 886
 887 <p>Removes the specified element path and all of its children. This may break
 888 an element with a <code>target</code> attribute (see <a href="#Target-Attribute">Target Attribute</a>) that
 889 refers to this element or any of its children.
 890 <br><br>
 891 When the <samp>--inquire</samp> option is passed then all remaining non-option
 892 arguments are retrieved via a server <em>INQUIRE</em>.
 893 </p>
 894
 895 <hr>
 896 <a name="DUMP"></a>
 897 <div class="header">
 898 <p>
 899 Next: <a href="#GET" accesskey="n" rel="next">GET</a>, Previous: <a href="#DELETE" accesskey="p" rel="prev">DELETE</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 900 </div>
 901 <a name="DUMP-command"></a>
 902 <h2 class="chapter">13 DUMP command</h2>
 903 <a name="index-DUMP-command"></a>
 904 <p>Syntax:
 905 </p><div class="example">
 906 <pre class="example">DUMP
 907 </pre></div>
 908
 909 <p>Shows the in memory <abbr>XML</abbr> document with indenting. See <a href="#XPATH">XPATH</a>, for
 910 dumping a specific node.
 911 </p>
 912
 913 <hr>
 914 <a name="GET"></a>
 915 <div class="header">
 916 <p>
 917 Next: <a href="#GETCONFIG" accesskey="n" rel="next">GETCONFIG</a>, Previous: <a href="#DUMP" accesskey="p" rel="prev">DUMP</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 918 </div>
 919 <a name="GET-command"></a>
 920 <h2 class="chapter">14 GET command</h2>
 921 <a name="index-GET-command"></a>
 922 <p>Syntax:
 923 </p><div class="example">
 924 <pre class="example">GET [--inquire] element[&lt;TAB&gt;child[..]]
 925 </pre></div>
 926
 927 <p>Retrieves the content of the specified element. The content is returned
 928 with a data response.
 929 <br><br>
 930 When the <samp>--inquire</samp> option is passed then all remaining non-option
 931 arguments are retrieved via a server <em>INQUIRE</em>.
 932 </p>
 933
 934 <hr>
 935 <a name="GETCONFIG"></a>
 936 <div class="header">
 937 <p>
 938 Next: <a href="#GETINFO" accesskey="n" rel="next">GETINFO</a>, Previous: <a href="#GET" accesskey="p" rel="prev">GET</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 939 </div>
 940 <a name="GETCONFIG-command"></a>
 941 <h2 class="chapter">15 GETCONFIG command</h2>
 942 <a name="index-GETCONFIG-command"></a>
 943 <p>Syntax:
 944 </p><div class="example">
 945 <pre class="example">GETCONFIG [filename] &lt;parameter&gt;
 946 </pre></div>
 947
 948 <p>Returns the value of a <code>pwmd</code> configuration <var>parameter</var> with a
 949 data response. If no file has been opened then the value for <var>filename</var>
 950 or the default from the <var>global</var> section will be returned. If a file
 951 has been opened and no <var>filename</var> is specified, the value previously
 952 set with the <code>OPTION</code> command (see <a href="#OPTION">OPTION</a>) will be returned.
 953 </p>
 954
 955 <hr>
 956 <a name="GETINFO"></a>
 957 <div class="header">
 958 <p>
 959 Next: <a href="#HELP" accesskey="n" rel="next">HELP</a>, Previous: <a href="#GETCONFIG" accesskey="p" rel="prev">GETCONFIG</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
 960 </div>
 961 <a name="GETINFO-command"></a>
 962 <h2 class="chapter">16 GETINFO command</h2>
 963 <a name="index-GETINFO-command"></a>
 964 <p>Syntax:
 965 </p><div class="example">
 966 <pre class="example">GETINFO [--data] [--verbose] CACHE | CLIENTS | PID | USER | LAST_ERROR | VERSION
 967 </pre></div>
 968
 969 <p>Get server and other information. The information is returned via a status
 970 message (see <a href="#Status-Messages">Status Messages</a>) unless otherwise noted or <samp>--data</samp>
 971 is specified.
 972 <br><br>
 973 <var>CACHE</var> returns the number of cached documents.
 974 <br><br>
 975 <var>CLIENTS</var> returns the number of
 976 connected clients via a status message or a list of connected clients when
 977 the <samp>--verbose</samp> parameter is used (implies <samp>--data</samp>). A
 978 verbose line of a client list contains
 979 space delimited
 980 fields: the thread ID, client name, opened file (<code>/</code> if none opened),
 981 IP address if remote, file lock status, whether the current client is self
 982 or not, client state (see below),
 983 user ID or TLS fingerprint of the connected client, username if the
 984 client is a local one else <code>-</code>, and finally the time stamp of when the
 985 client connected.
 986 <br><br>
 987 Client state <code>0</code> is an unknown client state, state <code>1</code> indicates
 988 the client has connected but hasn&rsquo;t completed initializing, state <code>2</code>
 989 indicates that the client is idle, state <code>3</code> means the
 990 client is in a command and state <code>4</code> means the client is disconnecting.
 991 <br><br>
 992 <var>PID</var> returns the process ID number of the server via a data response.
 993 <br><br>
 994 <var>VERSION</var> returns the server version number and compile-time features
 995 via a data response with each being space delimited.
 996 <br><br>
 997 <var>LAST_ERROR</var> returns a detailed description of the last failed command
 998 via a data response, when available.
 999 <br><br>
1000 <var>USER</var> returns the username or <abbr>TLS</abbr> hash of the connected client
1001 via a data response.
1002 </p>
1003
1004 <hr>
1005 <a name="HELP"></a>
1006 <div class="header">
1007 <p>
1008 Next: <a href="#IMPORT" accesskey="n" rel="next">IMPORT</a>, Previous: <a href="#GETINFO" accesskey="p" rel="prev">GETINFO</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1009 </div>
1010 <a name="HELP-command"></a>
1011 <h2 class="chapter">17 HELP command</h2>
1012 <a name="index-HELP-command"></a>
1013 <p>Syntax:
1014 </p><div class="example">
1015 <pre class="example">HELP [--html] [&lt;COMMAND&gt;]
1016 </pre></div>
1017
1018 <p>Show available commands or command specific help text.
1019 <br><br>
1020 The <samp>--html</samp> option will output the help text in HTML format.
1021 </p>
1022
1023 <hr>
1024 <a name="IMPORT"></a>
1025 <div class="header">
1026 <p>
1027 Next: <a href="#ISCACHED" accesskey="n" rel="next">ISCACHED</a>, Previous: <a href="#HELP" accesskey="p" rel="prev">HELP</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1028 </div>
1029 <a name="IMPORT-command"></a>
1030 <h2 class="chapter">18 IMPORT command</h2>
1031 <a name="index-IMPORT-command"></a>
1032 <p>Syntax:
1033 </p><div class="example">
1034 <pre class="example">IMPORT [--root=element[&lt;TAB&gt;child[..]]]
1035 </pre></div>
1036
1037 <p>This command uses a server <em>INQUIRE</em> to retrieve data from the client.
1038 <br><br>
1039 Like the <code>STORE</code> command (see <a href="#STORE">STORE</a>), but the <var>content</var>
1040 argument is raw <abbr>XML</abbr> data. The content is created as a child of
1041 the element path specified with the <samp>--root</samp> option or at the
1042 document root when not specified. Existing elements of the same name will
1043 be overwritten.
1044 <br><br>
1045 The content must begin with an <abbr>XML</abbr> element node. See <a href="#Introduction">Introduction</a>,
1046 for details.
1047 </p>
1048
1049 <hr>
1050 <a name="ISCACHED"></a>
1051 <div class="header">
1052 <p>
1053 Next: <a href="#KEYINFO" accesskey="n" rel="next">KEYINFO</a>, Previous: <a href="#IMPORT" accesskey="p" rel="prev">IMPORT</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1054 </div>
1055 <a name="ISCACHED-command"></a>
1056 <h2 class="chapter">19 ISCACHED command</h2>
1057 <a name="index-ISCACHED-command"></a>
1058 <p>Syntax:
1059 </p><div class="example">
1060 <pre class="example">ISCACHED [--lock] [--agent [--sign]] &lt;filename&gt;
1061 </pre></div>
1062
1063 <p>Determines the file cache status of the specified <var>filename</var>.
1064 The default is to test whether the filename is cached in memory. Passing
1065 option <samp>--agent</samp> will test the <code>gpg-agent</code> cache for at most
1066 one cached key used for opening the data file (see <a href="#OPEN">OPEN</a>). To test if
1067 a signing key is cached, pass <samp>--sign</samp> along with <samp>--agent</samp>.
1068 Both the <samp>--agent</samp> and <samp>--sign</samp> options require an opened data
1069 file.
1070 <br><br>
1071 An <em>OK</em> response is returned if the specified <var>filename</var> is found
1072 in the cache. If not found in the cache but exists on the filesystem
1073 then <code>GPG_ERR_NO_DATA</code> is returned. Otherwise a filesystem error is
1074 returned.
1075 <br><br>
1076 The <samp>--lock</samp> option will lock the file mutex of <var>filename</var> when
1077 the file exists; it does not need to be opened nor cached. The lock will be
1078 released when the client exits or sends the <code>UNLOCK</code> command
1079 (see <a href="#UNLOCK">UNLOCK</a>). When this option is passed the current data file is closed.
1080 </p>
1081
1082 <hr>
1083 <a name="KEYINFO"></a>
1084 <div class="header">
1085 <p>
1086 Next: <a href="#KILL" accesskey="n" rel="next">KILL</a>, Previous: <a href="#ISCACHED" accesskey="p" rel="prev">ISCACHED</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1087 </div>
1088 <a name="KEYINFO-command"></a>
1089 <h2 class="chapter">20 KEYINFO command</h2>
1090 <a name="index-KEYINFO-command"></a>
1091 <p>Syntax:
1092 </p><div class="example">
1093 <pre class="example">KEYINFO [--learn]
1094 </pre></div>
1095
1096 <p>Returns a new line separated list of key ID&rsquo;s that the currently opened
1097 data file has recipients and signers for. If the key is a signing key it
1098 will be prefixed with an <code>S</code>. If the file is a new one, or has no
1099 signers in the case of being symmetrically encrypted, the error code
1100 <code>GPG_ERR_NO_DATA</code> is returned.
1101 <br><br>
1102 When the <samp>--learn</samp> option is passed, keys on a smartcard will be
1103 imported.
1104 </p>
1105
1106 <hr>
1107 <a name="KILL"></a>
1108 <div class="header">
1109 <p>
1110 Next: <a href="#LIST" accesskey="n" rel="next">LIST</a>, Previous: <a href="#KEYINFO" accesskey="p" rel="prev">KEYINFO</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1111 </div>
1112 <a name="KILL-command"></a>
1113 <h2 class="chapter">21 KILL command</h2>
1114 <a name="index-KILL-command"></a>
1115 <p>Syntax:
1116 </p><div class="example">
1117 <pre class="example">KILL &lt;thread_id&gt;
1118 </pre></div>
1119
1120 <p>Terminates the client identified by <var>thread_id</var> and releases any file
1121 lock or other resources it has held. See <code>GETINFO</code> (see <a href="#GETINFO">GETINFO</a>)
1122 for details about listing connected clients. An <code>invoking_user</code>
1123 (see <a href="#Configuration">Configuration</a>) may kill any client while others may only kill
1124 clients of the same <code>UID</code> or <abbr>TLS</abbr> fingerprint.
1125 </p>
1126
1127 <hr>
1128 <a name="LIST"></a>
1129 <div class="header">
1130 <p>
1131 Next: <a href="#LISTKEYS" accesskey="n" rel="next">LISTKEYS</a>, Previous: <a href="#KILL" accesskey="p" rel="prev">KILL</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1132 </div>
1133 <a name="LIST-command"></a>
1134 <h2 class="chapter">22 LIST command</h2>
1135 <a name="index-LIST-command"></a>
1136 <p>Syntax:
1137 </p><div class="example">
1138 <pre class="example">LIST [--inquire] [--recurse] [element[&lt;TAB&gt;child[..]]]
1139 </pre></div>
1140
1141 <p>If no element path is given then a newline separated list of root elements
1142 is returned with a data response. If given, then children of the specified
1143 element path are returned.
1144 <br><br>
1145 Each element path
1146 returned will have zero or more flags appened to it. These flags are
1147 delimited from the element path by a single space character. A flag itself
1148 is a single character. Flag <code>P</code> indicates that access to the element
1149 is denied. Flag <code>+</code> indicates that there are child nodes of
1150 the current element path. Flag <code>E</code> indicates that an element of the
1151 element path contained in a <var>target</var> attribute could not be found. Flag
1152 <code>O</code> indicates that a <var>target</var> attribute recursion limit was reached
1153 (see <a href="#Configuration">Configuration</a>). Flag <code>T</code>, followed by a single space character,
1154 then an element path, is the element path of the <var>target</var> attribute
1155 contained in the current element.
1156 <br><br>
1157 When a specified element path contains an error, beit from the final
1158 element in the path or any previous element, the path is still shown but
1159 will contain the error flag for the element with the error. Determining
1160 the actual element which contains the error is up to the client. This can be
1161 done by traversing the final element up to parent elements that contain the
1162 same error flag.
1163 <br><br>
1164 The option <samp>--recurse</samp> may be used to list the entire element tree
1165 for a specified element path or the entire tree for all root elements.
1166 <br><br>
1167 When the <samp>--inquire</samp> option is passed then all remaining non-option
1168 arguments are retrieved via a server <em>INQUIRE</em>.
1169 </p>
1170
1171 <hr>
1172 <a name="LISTKEYS"></a>
1173 <div class="header">
1174 <p>
1175 Next: <a href="#LOCK" accesskey="n" rel="next">LOCK</a>, Previous: <a href="#LIST" accesskey="p" rel="prev">LIST</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1176 </div>
1177 <a name="LISTKEYS-command"></a>
1178 <h2 class="chapter">23 LISTKEYS command</h2>
1179 <a name="index-LISTKEYS-command"></a>
1180 <p>Syntax:
1181 </p><div class="example">
1182 <pre class="example">LISTKEYS [--secret-only] [pattern[,&lt;pattern&gt;]]
1183 </pre></div>
1184
1185 <p>Returns a new line separated list of key information matching a comma
1186 separated list of <var>pattern</var>&rsquo;s. When option <samp>--secret-only</samp> is
1187 specified, only keys matching <var>pattern</var> that also have a secret key
1188 available will be returned.
1189 </p>
1190
1191 <hr>
1192 <a name="LOCK"></a>
1193 <div class="header">
1194 <p>
1195 Next: <a href="#LS" accesskey="n" rel="next">LS</a>, Previous: <a href="#LISTKEYS" accesskey="p" rel="prev">LISTKEYS</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1196 </div>
1197 <a name="LOCK-command"></a>
1198 <h2 class="chapter">24 LOCK command</h2>
1199 <a name="index-LOCK-command"></a>
1200 <p>Syntax:
1201 </p><div class="example">
1202 <pre class="example">LOCK
1203 </pre></div>
1204
1205 <p>Locks the mutex associated with the opened file. This prevents other clients
1206 from sending commands to the same opened file until the client
1207 that sent this command either disconnects or sends the <code>UNLOCK</code>
1208 command. See <a href="#UNLOCK">UNLOCK</a>.
1209 </p>
1210
1211 <hr>
1212 <a name="LS"></a>
1213 <div class="header">
1214 <p>
1215 Next: <a href="#MOVE" accesskey="n" rel="next">MOVE</a>, Previous: <a href="#LOCK" accesskey="p" rel="prev">LOCK</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1216 </div>
1217 <a name="LS-command"></a>
1218 <h2 class="chapter">25 LS command</h2>
1219 <a name="index-LS-command"></a>
1220 <p>Syntax:
1221 </p><div class="example">
1222 <pre class="example">LS
1223 </pre></div>
1224
1225 <p>Returns a newline separated list of data files stored in the data directory
1226 <samp>HOMEDIR/data</samp> (see <a href="#Invoking">Invoking</a>) with a data response.
1227 </p>
1228
1229 <hr>
1230 <a name="MOVE"></a>
1231 <div class="header">
1232 <p>
1233 Next: <a href="#NOP" accesskey="n" rel="next">NOP</a>, Previous: <a href="#LS" accesskey="p" rel="prev">LS</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1234 </div>
1235 <a name="MOVE-command"></a>
1236 <h2 class="chapter">26 MOVE command</h2>
1237 <a name="index-MOVE-command"></a>
1238 <p>Syntax:
1239 </p><div class="example">
1240 <pre class="example">MOVE [--inquire] source[&lt;TAB&gt;child[..]] [dest[&lt;TAB&gt;child[..]]]
1241 </pre></div>
1242
1243 <p>Moves the source element path to the destination element path. If the
1244 destination is not specified then it will be moved to the root node of the
1245 document. If the destination is specified and exists then it will be
1246 overwritten; otherwise non-existing elements of the destination element
1247 path will be created.
1248 <br><br>
1249 When the <samp>--inquire</samp> option is passed then all remaining non-option
1250 arguments are retrieved via a server <em>INQUIRE</em>.
1251 </p>
1252
1253 <hr>
1254 <a name="NOP"></a>
1255 <div class="header">
1256 <p>
1257 Next: <a href="#OPEN" accesskey="n" rel="next">OPEN</a>, Previous: <a href="#MOVE" accesskey="p" rel="prev">MOVE</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1258 </div>
1259 <a name="NOP-command"></a>
1260 <h2 class="chapter">27 NOP command</h2>
1261 <a name="index-NOP-command"></a>
1262 <p>Syntax:
1263 </p><div class="example">
1264 <pre class="example">NOP
1265 </pre></div>
1266
1267 <p>Does nothing. Always returns successfully.
1268 </p>
1269
1270 <hr>
1271 <a name="OPEN"></a>
1272 <div class="header">
1273 <p>
1274 Next: <a href="#OPTION" accesskey="n" rel="next">OPTION</a>, Previous: <a href="#NOP" accesskey="p" rel="prev">NOP</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1275 </div>
1276 <a name="OPEN-command"></a>
1277 <h2 class="chapter">28 OPEN command</h2>
1278 <a name="index-OPEN-command"></a>
1279 <p>Syntax:
1280 </p><div class="example">
1281 <pre class="example">OPEN [--lock] &lt;filename&gt;
1282 </pre></div>
1283
1284 <p>Opens <var>filename</var>. When the <var>filename</var> is not found on the
1285 file-system then a new in-memory document will be created. If the file is
1286 found, it is looked for in the file cache and when found no passphrase will
1287 be required to open it. When not cached, <cite>pinentry(1)</cite> will be used to
1288 retrieve the passphrase for decryption unless <samp>disable-pinentry</samp>
1289 (see <a href="#OPTION">OPTION</a>) was specified in which case <code>pwmd</code> will
1290 <em>INQUIRE</em> the client for the passphrase.
1291 <br><br>
1292 When the <samp>--lock</samp> option is passed then the file mutex will be
1293 locked as if the <code>LOCK</code> command (see <a href="#LOCK">LOCK</a>) had been sent after the
1294 file had been opened.
1295 </p>
1296
1297 <hr>
1298 <a name="OPTION"></a>
1299 <div class="header">
1300 <p>
1301 Next: <a href="#PASSWD" accesskey="n" rel="next">PASSWD</a>, Previous: <a href="#OPEN" accesskey="p" rel="prev">OPEN</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1302 </div>
1303 <a name="OPTION-command"></a>
1304 <h2 class="chapter">29 OPTION command</h2>
1305 <a name="index-OPTION-command"></a>
1306 <p>Syntax:
1307 </p><div class="example">
1308 <pre class="example">OPTION &lt;NAME&gt;=[&lt;VALUE&gt;]
1309 </pre></div>
1310
1311 <p>Sets a client option <var>name</var> to <var>value</var>. The value for an option is
1312 kept for the duration of the connection with the exception of the
1313 <code>pinentry</code> options which are defaults for all future connections
1314 (see <a href="#Pinentry">Pinentry</a>). When <var>value</var> is empty the option is unset.
1315 <br><br>
1316 </p><dl compact="compact">
1317 <dt>DISABLE-PINENTRY</dt>
1318 <dd><p>Disable use of <code>pinentry</code> for passphrase retrieval. When <code>1</code>, a
1319 server inquire is sent to the client to obtain the passphrase. This option
1320 may be set as needed before the <code>OPEN</code> (see <a href="#OPEN">OPEN</a>), <code>PASSWD</code>
1321 (see <a href="#PASSWD">PASSWD</a>) and <code>SAVE</code> (see <a href="#SAVE">SAVE</a>) commands. Set to <code>0</code>
1322 to use a <code>pinentry</code>.
1323 <br><br>
1324 </p></dd>
1325 <dt>DISPLAY</dt>
1326 <dd><p>Set or unset the X11 display to use when prompting for a passphrase.
1327 <br><br>
1328 </p></dd>
1329 <dt>TTYNAME</dt>
1330 <dd><p>Set the terminal device path to use when prompting for a passphrase.
1331 <br><br>
1332 </p></dd>
1333 <dt>TTYTYPE</dt>
1334 <dd><p>Set the terminal type for use with <samp>TTYNAME</samp>.
1335 <br><br>
1336 </p></dd>
1337 <dt>NAME</dt>
1338 <dd><p>Associates the thread ID of the connection with the specified textual
1339 representation. Useful for debugging log messages. May not contain whitespace.
1340 <br><br>
1341 </p></dd>
1342 <dt>LOCK-TIMEOUT</dt>
1343 <dd><p>When not <code>0</code>, the duration in tenths of a second to wait for the file
1344 mutex which has been locked by another thread to be released before returning
1345 an error. When <code>-1</code> the error will be returned immediately.
1346 <br><br>
1347 </p></dd>
1348 <dt>CLIENT-STATE</dt>
1349 <dd><p>When set to <code>1</code> then client state status messages for other clients are
1350 sent to the current client. The default is <code>0</code>.
1351 </p></dd>
1352 </dl>
1353
1354
1355 <hr>
1356 <a name="PASSWD"></a>
1357 <div class="header">
1358 <p>
1359 Next: <a href="#REALPATH" accesskey="n" rel="next">REALPATH</a>, Previous: <a href="#OPTION" accesskey="p" rel="prev">OPTION</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1360 </div>
1361 <a name="PASSWD-command"></a>
1362 <h2 class="chapter">30 PASSWD command</h2>
1363 <a name="index-PASSWD-command"></a>
1364 <p>Syntax:
1365 </p><div class="example">
1366 <pre class="example">PASSWD
1367 </pre></div>
1368
1369 <p>Changes the passphrase of the secret key required to open the current
1370 data file. If the data file is symmetrically encrypted, the error
1371 <code>GPG_ERR_NOT_SUPPORTED</code> is returned. When symmetrically encrypted,
1372 the <code>SAVE</code> command (see <a href="#SAVE">SAVE</a>) should be used instead to prevent
1373 this command saving any unwanted changes to the <abbr>XML</abbr> document.
1374 <br><br>
1375 This command is not available to non-invoking clients
1376 (see <a href="#Access-Control">Access Control</a>).
1377 </p>
1378
1379 <hr>
1380 <a name="REALPATH"></a>
1381 <div class="header">
1382 <p>
1383 Next: <a href="#RENAME" accesskey="n" rel="next">RENAME</a>, Previous: <a href="#PASSWD" accesskey="p" rel="prev">PASSWD</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1384 </div>
1385 <a name="REALPATH-command"></a>
1386 <h2 class="chapter">31 REALPATH command</h2>
1387 <a name="index-REALPATH-command"></a>
1388 <p>Syntax:
1389 </p><div class="example">
1390 <pre class="example">REALPATH [--inquire] element[&lt;TAB&gt;child[..]]
1391 </pre></div>
1392
1393 <p>Resolves all <code>target</code> attributes of the specified element path and
1394 returns the result with a data response. See <a href="#Target-Attribute">Target Attribute</a>, for details.
1395 <br><br>
1396 When the <samp>--inquire</samp> option is passed then all remaining non-option
1397 arguments are retrieved via a server <em>INQUIRE</em>.
1398 </p>
1399
1400 <hr>
1401 <a name="RENAME"></a>
1402 <div class="header">
1403 <p>
1404 Next: <a href="#RESET" accesskey="n" rel="next">RESET</a>, Previous: <a href="#REALPATH" accesskey="p" rel="prev">REALPATH</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1405 </div>
1406 <a name="RENAME-command"></a>
1407 <h2 class="chapter">32 RENAME command</h2>
1408 <a name="index-RENAME-command"></a>
1409 <p>Syntax:
1410 </p><div class="example">
1411 <pre class="example">RENAME [--inquire] element[&lt;TAB&gt;child[..]] &lt;value&gt;
1412 </pre></div>
1413
1414 <p>Renames the specified <var>element</var> to the new <var>value</var>. If an element of
1415 the same name as the <var>value</var> already exists it will be overwritten.
1416 <br><br>
1417 When the <samp>--inquire</samp> option is passed then all remaining non-option
1418 arguments are retrieved via a server <em>INQUIRE</em>.
1419 </p>
1420
1421 <hr>
1422 <a name="RESET"></a>
1423 <div class="header">
1424 <p>
1425 Next: <a href="#SAVE" accesskey="n" rel="next">SAVE</a>, Previous: <a href="#RENAME" accesskey="p" rel="prev">RENAME</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1426 </div>
1427 <a name="RESET-command"></a>
1428 <h2 class="chapter">33 RESET command</h2>
1429 <a name="index-RESET-command"></a>
1430 <p>Syntax:
1431 </p><div class="example">
1432 <pre class="example">RESET
1433 </pre></div>
1434
1435 <p>Closes the currently opened file but keeps any previously set client options
1436 (see <a href="#OPTION">OPTION</a>).
1437 </p>
1438
1439 <hr>
1440 <a name="SAVE"></a>
1441 <div class="header">
1442 <p>
1443 Next: <a href="#STORE" accesskey="n" rel="next">STORE</a>, Previous: <a href="#RESET" accesskey="p" rel="prev">RESET</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1444 </div>
1445 <a name="SAVE-command"></a>
1446 <h2 class="chapter">34 SAVE command</h2>
1447 <a name="index-SAVE-command"></a>
1448 <p>Syntax:
1449 </p><div class="example">
1450 <pre class="example">SAVE [--symmetric] [--inquire-keyparam] [--keyid=&lt;fpr&gt;[,..] | [--inquire-keyid]] [--sign-keyid=&lt;fpr&gt;[,..] | [--inquire-sign-keyid]]
1451 </pre></div>
1452
1453 <p>Writes the in-memory <abbr>XML</abbr> document to disk. The file written to is the
1454 file that was opened using the <code>OPEN</code> command (see <a href="#OPEN">OPEN</a>). If the
1455 file is a new one or the option <samp>--inquire-keyparam</samp> was passed, a
1456 new keypair will be generated and <cite>pinentry(1)</cite> will be used to prompt
1457 for the passphrase of the secret key used for signing.
1458 <br><br>
1459 The <samp>--inquire-keyparam</samp> option will send an
1460 <em>INQUIRE</em> to the client to obtain the key parameters to use for
1461 generating the new keypair. The inquired data is expected to be in
1462 <cite>gnupg</cite> <abbr>XML</abbr> format. See the <cite>gnupg</cite> documentation for
1463 details. Note that when this option is specified a new keypair will be
1464 generated reguardless if the file is a new one and that the passphrase for
1465 the current file will be required before generating the new keypair. This
1466 option is available to non-invoking clients (see <a href="#Access-Control">Access Control</a>) only
1467 when the file is a new one.
1468 <br><br>
1469 You can encrypt the data file to a recipient other than the one that it
1470 was encrypted with by passing the <samp>--keyid</samp> or
1471 <samp>--inquire-keyid</samp> option with
1472 the fingerprint of a public encryption key as its argument. Use the
1473 <code>LISTKEYS</code> command (see <a href="#LISTKEYS">LISTKEYS</a>) to show key information by
1474 pattern. The <samp>--sign-keyid</samp> or <samp>--inquire-sign-keyid</samp> option
1475 may also be used to sign the data
1476 file with an alternate key by specifying the fingerprint of a secret key.
1477 A passphrase to decrypt the data file
1478 will be required when one or more of the original encryption or signing keys
1479 are not found in either of these two options&rsquo; arguments or when the data
1480 file is symmetrically encrypted, reguardless of the <code>require_save_key</code>
1481 configuration parameter. The original encryption or signing keys will be
1482 used when either of these options are not specified.
1483 <br><br>
1484 The <samp>--keyid</samp> and <samp>--sign-keyid</samp> options are not available
1485 for non-invoking clients
1486 (see <a href="#Access-Control">Access Control</a>) when the recipients or signers do not match those
1487 that were used when the file was <code>OPEN</code>&rsquo;ed.
1488 <br><br>
1489 The <samp>--symmetric</samp> option specifies that a new data file be
1490 conventionally encrypted. These types of data files do not use a recipient
1491 public key but may be signed by using the <samp>--sign-keyid</samp> or
1492 <samp>--inquire-sign-keyid</samp> options. To remove all signers from a
1493 symmtrically encrypted data file, leave the option value empty. Note that
1494 you cannot change encryption schemes once a data file has been saved.
1495 </p>
1496
1497 <hr>
1498 <a name="STORE"></a>
1499 <div class="header">
1500 <p>
1501 Next: <a href="#UNLOCK" accesskey="n" rel="next">UNLOCK</a>, Previous: <a href="#SAVE" accesskey="p" rel="prev">SAVE</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1502 </div>
1503 <a name="STORE-command"></a>
1504 <h2 class="chapter">35 STORE command</h2>
1505 <a name="index-STORE-command"></a>
1506 <p>Syntax:
1507 </p><div class="example">
1508 <pre class="example">STORE element[&lt;TAB&gt;child[..]]&lt;TAB&gt;[content]
1509 </pre></div>
1510
1511 <p>This command uses a server <em>INQUIRE</em> to retrieve data from the client.
1512 <br><br>
1513 Creates a new element path or modifies the <var>content</var> of an existing
1514 element. If only a single element is specified then a new root element is
1515 created. Otherwise, elements are <tt class="key">TAB</tt> delimited and the content will be
1516 set to the final <tt class="key">TAB</tt> delimited element. If no <var>content</var> is
1517 specified after the final <tt class="key">TAB</tt>, then the content of the existing
1518 element will be removed; or will be empty if creating a new element.
1519 <br><br>
1520 The only restriction of an element name is that it not contain whitespace
1521 characters. There is no other whitespace between the <tt class="key">TAB</tt> delimited
1522 elements. It is recommended that the content of an element be base64 encoded
1523 when it contains control or <tt class="key">TAB</tt> characters to prevent <abbr>XML</abbr>
1524 parsing and <code>pwmd</code> syntax errors.
1525 </p>
1526
1527 <hr>
1528 <a name="UNLOCK"></a>
1529 <div class="header">
1530 <p>
1531 Next: <a href="#XPATH" accesskey="n" rel="next">XPATH</a>, Previous: <a href="#STORE" accesskey="p" rel="prev">STORE</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1532 </div>
1533 <a name="UNLOCK-command"></a>
1534 <h2 class="chapter">36 UNLOCK command</h2>
1535 <a name="index-UNLOCK-command"></a>
1536 <p>Syntax:
1537 </p><div class="example">
1538 <pre class="example">UNLOCK
1539 </pre></div>
1540
1541 <p>Unlocks the file mutex which was locked with the <code>LOCK</code> command or
1542 a commands&rsquo; <samp>--lock</samp> option (see <a href="#LOCK">LOCK</a>, see <a href="#OPEN">OPEN</a>,
1543 see <a href="#ISCACHED">ISCACHED</a>).
1544 </p>
1545
1546 <hr>
1547 <a name="XPATH"></a>
1548 <div class="header">
1549 <p>
1550 Next: <a href="#XPATHATTR" accesskey="n" rel="next">XPATHATTR</a>, Previous: <a href="#UNLOCK" accesskey="p" rel="prev">UNLOCK</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1551 </div>
1552 <a name="XPATH-command"></a>
1553 <h2 class="chapter">37 XPATH command</h2>
1554 <a name="index-XPATH-command"></a>
1555 <p>Syntax:
1556 </p><div class="example">
1557 <pre class="example">XPATH [--inquire] &lt;expression&gt;[&lt;TAB&gt;[value]]
1558 </pre></div>
1559
1560 <p>Evaluates an XPath <var>expression</var>. If no <var>value</var> argument is
1561 specified it is assumed the expression is a request to return a result.
1562 Otherwise, the result is set to the <var>value</var> argument and the document is
1563 updated. If there is no <var>value</var> after the <tt class="key">TAB</tt> character, the value
1564 is assumed to be empty and the document is updated. For example:
1565 </p><br>
1566 <div class="example">
1567 <pre class="example">XPATH //element[@_name='password']<span class="key">TAB</span>
1568 </pre></div>
1569 <br>
1570 <p>would clear the content of all <var>password</var> elements in the data file
1571 while leaving off the trailing <tt class="key">TAB</tt> would return all <var>password</var>
1572 elements in <abbr>XML</abbr> format.
1573 <br><br>
1574 When the <samp>--inquire</samp> option is passed then all remaining non-option
1575 arguments are retrieved via a server <em>INQUIRE</em>.
1576 <br><br>
1577 See <a href="http://www.w3schools.com/xpath/xpath_syntax.asp">http://www.w3schools.com/xpath/xpath_syntax.asp</a> for <abbr>XPATH</abbr>
1578 expression syntax.
1579 </p>
1580
1581 <hr>
1582 <a name="XPATHATTR"></a>
1583 <div class="header">
1584 <p>
1585 Previous: <a href="#XPATH" accesskey="p" rel="prev">XPATH</a>, Up: <a href="#Commands" accesskey="u" rel="up">Commands</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1586 </div>
1587 <a name="XPATHATTR-command"></a>
1588 <h2 class="chapter">38 XPATHATTR command</h2>
1589 <a name="index-XPATHATTR-command"></a>
1590 <p>Syntax:
1591 </p><div class="example">
1592 <pre class="example">XPATHATTR [--inquire] SET|DELETE &lt;name&gt; &lt;expression&gt;[&lt;TAB&gt;[&lt;value&gt;]]
1593 </pre></div>
1594
1595 <p>Like the <code>XPATH</code> command (see <a href="#XPATH">XPATH</a>) but operates on element
1596 attributes and does not return a result. For the <var>SET</var> operation the
1597 <var>value</var> is optional but the field is required. If not specified then
1598 the attribute value will be empty. For example:
1599 </p><br>
1600 <div class="example">
1601 <pre class="example">XPATHATTR SET password //element[@_name='password']<span class="key">TAB</span>
1602 </pre></div>
1603 <br>
1604 <p>would create a <var>password</var> attribute for each <var>password</var> element
1605 found in the document. The attribute value will be empty but still exist.
1606 <br><br>
1607 When the <samp>--inquire</samp> option is passed then all remaining non-option
1608 arguments are retrieved via a server <em>INQUIRE</em>.
1609 <br><br>
1610 See <a href="http://www.w3schools.com/xpath/xpath_syntax.asp">http://www.w3schools.com/xpath/xpath_syntax.asp</a> for <abbr>XPATH</abbr>
1611 expression syntax.
1612 </p>
1613
1614
1615 <hr>
1616 <a name="Status-Messages"></a>
1617 <div class="header">
1618 <p>
1619 Next: <a href="#Target-Attribute" accesskey="n" rel="next">Target Attribute</a>, Previous: <a href="#Commands" accesskey="p" rel="prev">Commands</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1620 </div>
1621 <a name="Status-messages-and-their-meanings"></a>
1622 <h2 class="chapter">39 Status messages and their meanings</h2>
1623 <p>Some commands send status messages to inform the client about certain
1624 operations or as a progress indicator.  Status messages begin with a
1625 <code>KEYWORD</code> followed by a status description for status messages that
1626 require it. What status messages are sent, when, and how often may depend on
1627 configuration settings (see <a href="#Configuration">Configuration</a>).
1628 </p>
1629 <table>
1630 <thead><tr><th width="20%">Message</th><th width="25%">Parameters</th><th width="55%">Description</th></tr></thead>
1631 <tr><td width="20%">CACHE
1632 <a name="index-CACHE"></a></td><td width="25%"><code>&lt;integer&gt;</code></td><td width="55%">The number of cached documents. Sent to each client after connecting
1633 (see <a href="#GETINFO">GETINFO</a>) and after every cache modification.</td></tr>
1634 <tr><td width="20%">CLIENTS
1635 <a name="index-CLIENTS"></a></td><td width="25%"><code>&lt;integer&gt;</code></td><td width="55%">The number of connected clients (see <a href="#GETINFO">GETINFO</a>). Sent to each client
1636 when another client either connects or disconnects.</td></tr>
1637 <tr><td width="20%">DECRYPT
1638 <a name="index-DECRYPT"></a></td><td width="25%"></td><td width="55%">Sent to the current client during a decrypt operation. How often this
1639 status message is sent is determined by the <code>keepalive_interval</code>
1640 (see <a href="#Configuration">Configuration</a>) setting.</td></tr>
1641 <tr><td width="20%">ENCRYPT
1642 <a name="index-ENCRYPT"></a></td><td width="25%"></td><td width="55%">Sent to the current client during an encrypt operation. How often this
1643 status message is sent is determined by the <code>keepalive_interval</code>
1644 (see <a href="#Configuration">Configuration</a>) setting.</td></tr>
1645 <tr><td width="20%">GENKEY
1646 <a name="index-GENKEY"></a></td><td width="25%"><code>[&lt;sigkey_fpr&gt; &lt;pubkey_fpr&gt;]</code></td><td width="55%">Sent to the current client during key generation. How often this
1647 status message is sent is determined by the <code>keepalive_interval</code>
1648 (see <a href="#Configuration">Configuration</a>) setting. The <var>sigkey_fpr</var> and <var>pubkey_fpr</var>
1649 parameters are added when key generation has completed.</td></tr>
1650 <tr><td width="20%">INQUIRE_MAXLEN
1651 <a name="index-INQUIRE_005fMAXLEN"></a></td><td width="25%"><code>&lt;bytes&gt;</code></td><td width="55%">Sent to the client from <code>gpg-agent</code> when inquiring data. This
1652 specifies the maximum number of bytes allowed for the client to send and
1653 should not be exceeded.</td></tr>
1654 <tr><td width="20%">KEEPALIVE
1655 <a name="index-KEEPALIVE"></a></td><td width="25%"></td><td width="55%">Sent to each idle client every <var>keepalive_interval</var>
1656 (see <a href="#Configuration">Configuration</a>) seconds.</td></tr>
1657 <tr><td width="20%">LOCKED
1658 <a name="index-LOCKED"></a></td><td width="25%"></td><td width="55%">Sent to the current client when another client is holding the lock for
1659 the mutex associated with a file. How often this status message is sent is
1660 determined by the <code>keepalive_interval</code> (see <a href="#Configuration">Configuration</a>) setting.</td></tr>
1661 <tr><td width="20%">NEWFILE
1662 <a name="index-NEWFILE"></a></td><td width="25%"></td><td width="55%">Sent to the current client when the opened (see <a href="#OPEN">OPEN</a>) file does not
1663 exist on the file-system.</td></tr>
1664 <tr><td width="20%">XFER
1665 <a name="index-XFER"></a></td><td width="25%"><code>&lt;sent&gt; &lt;total&gt;</code></td><td width="55%">Sent to the current client when transferring data. It has two space
1666 delimited arguments. The first being the current amount of bytes transferred
1667 and the other being the total bytes to be transferred.</td></tr>
1668 <tr><td width="20%">STATE
1669 <a name="index-STATE"></a></td><td width="25%"><code>&lt;client_id&gt; &lt;state&gt;</code></td><td width="55%">Sent to each client to indicate that <var>client_id</var> has changed to
1670 <var>state</var> (see <a href="#GETINFO">GETINFO</a> for client states). For a client to receive
1671 another clients state the option <var>CLIENT-STATE</var> must be set.
1672 See <a href="#OPTION">OPTION</a> command.</td></tr>
1673 <tr><td width="20%">EXPIRE
1674 <a name="index-EXPIRE"></a></td><td width="25%"><code>&lt;epoch_seconds&gt; &lt;epoch_future&gt;|0</code></td><td width="55%">Sent to the current client when <code>GET</code> (see <a href="#GET">GET</a>) encounters an
1675 <code>expire</code> (see <a href="#Other-Attributes">Other Attributes</a>) attribute that is in the past or when
1676 <code>STORE</code> (see <a href="#STORE">STORE</a>) updates the <code>expire</code> attribute from the
1677 <code>expire_increment</code> attribute value. The second field will be <code>0</code>
1678 when <code>GET</code> sends this status message.  Otherwise the second field is the
1679 time the next expiry will be.</td></tr>
1680 <tr><td width="20%">PASSPHRASE_HINT
1681 <a name="index-PASSPHRASE_005fHINT"></a></td><td width="25%">&lt;keyid&gt; &lt;userid&gt;</td><td width="55%">Forwarded from <code>GpgME</code>. Contains information that is useful in a
1682 <code>pinentry</code>. Only sent when pinentry is disabled (see <a href="#OPTION">OPTION</a>).</td></tr>
1683 <tr><td width="20%">PASSPHRASE_INFO
1684 <a name="index-PASSPHRASE_005fINFO"></a></td><td width="25%">&lt;flags&gt; ...</td><td width="55%">Forwarded from <code>GpgME</code>. Contains information that is useful in a
1685 <code>pinentry</code>. Only sent when pinentry is disabled (see <a href="#OPTION">OPTION</a>).</td></tr>
1686 <tr><td width="20%">REHANDSHAKE
1687 <a name="index-REHANDSHAKE"></a></td><td width="25%"></td><td width="55%">Sent to each TLS client just before performing a cipher renegotiation
1688 after a SIGHUP signal was received.</td></tr>
1689 </table>
1690
1691 <hr>
1692 <a name="Target-Attribute"></a>
1693 <div class="header">
1694 <p>
1695 Next: <a href="#Other-Attributes" accesskey="n" rel="next">Other Attributes</a>, Previous: <a href="#Status-Messages" accesskey="p" rel="prev">Status Messages</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1696 </div>
1697 <a name="The-target-attribute"></a>
1698 <h2 class="chapter">40 The <code>target</code> attribute</h2>
1699 <a name="index-target-attribute"></a>
1700 <p>A <em>case sensitive</em> attribute named <code>target</code> is treated specially
1701 when found in each element of an element path. This attribute, like other
1702 element attributes, is created or modified with the <code>ATTR</code> command
1703 (see <a href="#ATTR">ATTR</a>). The value of this attribute is an existing element path
1704 somewhere in the document.  If you are familiar with XML entities or
1705 maybe the HTML <code>id</code> or <code>target</code> attributes or a symbolic link
1706 in a file-system, you may find this attribute behaves similar to any of those.
1707 </p>
1708 <p>To create a <code>target</code> attribute use the following syntax:
1709 </p>
1710 <div class="example">
1711 <pre class="example">ATTR SET target element[<code>TAB</code>child[..]] element[<code>TAB</code>child[..]]
1712 </pre></div>
1713
1714 <p>Note the single space between the two element paths. The first element path is
1715 where the <code>target</code> attribute will be created. If the element path does
1716 not exist then it will be created.  This is the only time the <code>ATTR</code>
1717 (see <a href="#ATTR">ATTR</a>) command will create elements. The attribute is created in the
1718 final element of the element path.
1719 </p>
1720 <p>The second element path is the destination of where you want the first element
1721 path to resolve to. When an element path is passed as an argument to a
1722 protocol command <code>pwmd</code> looks for a <code>target</code> attribute when
1723 resolving each element and, if found, &quot;jumps&quot; to the attribute value and
1724 continues resolving any remaining elements a commands element path.
1725 </p>
1726 <p>When an element of a element path is removed that a <code>target</code> attribute
1727 resolves to then an error will occur when trying to access that element. You
1728 may need to either update the <code>target</code> attribute value with a new element
1729 path or remove the attribute entirely.
1730 </p>
1731 <p>Clients should be careful of creating <code>target</code> loops, or targets that
1732 resolve to themselves. See the <var>recursion_depth</var> (see <a href="#Configuration">Configuration</a>)
1733 configuration parameter for details.
1734 </p>
1735 <p>The <code>REALPATH</code> command (see <a href="#REALPATH">REALPATH</a>) can be used to show the element
1736 path after resolving all <code>target</code> attributes.
1737 </p>
1738 <p><em>Note that when setting this attribute any children of the element will
1739 be removed.</em>
1740 </p>
1741
1742 <hr>
1743 <a name="Other-Attributes"></a>
1744 <div class="header">
1745 <p>
1746 Next: <a href="#Signals" accesskey="n" rel="next">Signals</a>, Previous: <a href="#Target-Attribute" accesskey="p" rel="prev">Target Attribute</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1747 </div>
1748 <a name="Other-special-attributes"></a>
1749 <h2 class="chapter">41 Other special attributes</h2>
1750 <a name="index-special-attributes"></a>
1751 <p>In addition to the <code>target</code> attribute (see <a href="#Target-Attribute">Target Attribute</a>), there
1752 are a few other attributes that are specially handled by <code>pwmd</code>. The
1753 first is the <code>_ctime</code> attribute which is set to the current time when an
1754 element is created. Next is the <code>_mtime</code> attribute which is created when
1755 an element is created and also updated when an element is modified. Both of
1756 these attributes may be removed but the <code>_mtime</code> attribute is
1757 automatically added again since removing an attribute is considered modifying
1758 an element. The <code>_acl</code> attribute controls access to the element, beit
1759 modifying or accessing element content, or descending into child elements.
1760 See <a href="#Access-Control">Access Control</a> for details. The <code>_name</code> attribute contains the
1761 name of an element.
1762 </p>
1763 <p>The above mentioned attributes are considered reserved attribute names.
1764 Reserved attributes are treated specially when a <code>target</code> attribute is
1765 found for the current element. The <code>ATTR LIST</code> command will show these
1766 attribute values for the current element and not the attribute values for the
1767 resolved <code>target</code> element. All other non-reserved attributes for the
1768 resolved <code>target</code> are appended to the <code>ATTR LIST</code> command output.
1769 Other <code>ATTR</code> commands (see <a href="#ATTR">ATTR</a>) behave as usual. You can, for example, <code>ATTR
1770 DELETE</code> a non-reserved attribute for an element that contains a <code>target</code>
1771 attribute. The resolved target elements&rsquo; attribute will be removed rather than
1772 the element containing the <code>target</code> attribute.
1773 </p>
1774 <p>Another specially handled attribute is the <code>expire</code> attribute. This
1775 attribute value, like the <code>_ctime</code> and <code>_mtime</code> attributes, is a
1776 timestamp. But this timestamp is usually in the future and for use with the
1777 <code>GET</code> (see <a href="#GET">GET</a>) and <code>STORE</code> (see <a href="#STORE">STORE</a>) commands. When the
1778 <code>GET</code> command is issued, it checks for an <code>expire</code> attribute an
1779 compares its&rsquo; value with the current time. If the <code>expire</code> timestamp is in
1780 the past then a status message is sent (see <a href="#Status-Messages">Status Messages</a>) to inform the
1781 client that the element content should be updated.  When the content for an
1782 element containing an <code>expire</code> attribute is set when using the
1783 <code>STORE</code> command, the value of the <code>expire_increment</code> attribute is
1784 added to the current time and the <code>expire</code> attribute value is updated.
1785 When no <code>expire_increment</code> attribute is found, no modification is done of
1786 the <code>expire</code> attribute.
1787 </p>
1788
1789 <hr>
1790 <a name="Signals"></a>
1791 <div class="header">
1792 <p>
1793 Next: <a href="#Concept-Index" accesskey="n" rel="next">Concept Index</a>, Previous: <a href="#Other-Attributes" accesskey="p" rel="prev">Other Attributes</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1794 </div>
1795 <a name="Recognized-signals"></a>
1796 <h2 class="chapter">42 Recognized signals</h2>
1797
1798 <p>Sending the <em>SIGHUP</em> signal to a <code>pwmd</code> process will reload the
1799 configuration file and sending <em>SIGUSR1</em> will clear the entire file
1800 cache.
1801 </p>
1802
1803
1804 <hr>
1805 <a name="Concept-Index"></a>
1806 <div class="header">
1807 <p>
1808 Previous: <a href="#Signals" accesskey="p" rel="prev">Signals</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
1809 </div>
1810 <a name="Concept-Index-1"></a>
1811 <h2 class="unnumbered">Concept Index</h2>
1812
1813
1814 <a name="SEC_Overview"></a>
1815 <h2 class="shortcontents-heading">Short Table of Contents</h2>
1816
1817 <div class="shortcontents">
1818 <ul class="no-bullet">
1819 <li><a name="stoc-Overview-of-pwmd" href="#toc-Overview-of-pwmd">1 Overview of <code>pwmd</code></a></li>
1820 <li><a name="stoc-Access-Control-1" href="#toc-Access-Control-1">2 Access Control</a></li>
1821 <li><a name="stoc-Invoking-pwmd" href="#toc-Invoking-pwmd">3 Invoking <code>pwmd</code></a></li>
1822 <li><a name="stoc-pwmd-configuration-file-options" href="#toc-pwmd-configuration-file-options">4 <code>pwmd</code> configuration file options</a></li>
1823 <li><a name="stoc-Configuring-remote-connections-over-TLS_002e" href="#toc-Configuring-remote-connections-over-TLS_002e">5 Configuring remote connections over TLS.</a></li>
1824 <li><a name="stoc-Pinentry-configuration" href="#toc-Pinentry-configuration">6 Pinentry configuration</a></li>
1825 <li><a name="stoc-Protocol-commands-and-their-syntax" href="#toc-Protocol-commands-and-their-syntax">7 Protocol commands and their syntax</a></li>
1826 <li><a name="stoc-ATTR-command" href="#toc-ATTR-command">8 ATTR command</a></li>
1827 <li><a name="stoc-CACHETIMEOUT-command" href="#toc-CACHETIMEOUT-command">9 CACHETIMEOUT command</a></li>
1828 <li><a name="stoc-CLEARCACHE-command" href="#toc-CLEARCACHE-command">10 CLEARCACHE command</a></li>
1829 <li><a name="stoc-COPY-command" href="#toc-COPY-command">11 COPY command</a></li>
1830 <li><a name="stoc-DELETE-command" href="#toc-DELETE-command">12 DELETE command</a></li>
1831 <li><a name="stoc-DUMP-command" href="#toc-DUMP-command">13 DUMP command</a></li>
1832 <li><a name="stoc-GET-command" href="#toc-GET-command">14 GET command</a></li>
1833 <li><a name="stoc-GETCONFIG-command" href="#toc-GETCONFIG-command">15 GETCONFIG command</a></li>
1834 <li><a name="stoc-GETINFO-command" href="#toc-GETINFO-command">16 GETINFO command</a></li>
1835 <li><a name="stoc-HELP-command" href="#toc-HELP-command">17 HELP command</a></li>
1836 <li><a name="stoc-IMPORT-command" href="#toc-IMPORT-command">18 IMPORT command</a></li>
1837 <li><a name="stoc-ISCACHED-command" href="#toc-ISCACHED-command">19 ISCACHED command</a></li>
1838 <li><a name="stoc-KEYINFO-command" href="#toc-KEYINFO-command">20 KEYINFO command</a></li>
1839 <li><a name="stoc-KILL-command" href="#toc-KILL-command">21 KILL command</a></li>
1840 <li><a name="stoc-LIST-command" href="#toc-LIST-command">22 LIST command</a></li>
1841 <li><a name="stoc-LISTKEYS-command" href="#toc-LISTKEYS-command">23 LISTKEYS command</a></li>
1842 <li><a name="stoc-LOCK-command" href="#toc-LOCK-command">24 LOCK command</a></li>
1843 <li><a name="stoc-LS-command" href="#toc-LS-command">25 LS command</a></li>
1844 <li><a name="stoc-MOVE-command" href="#toc-MOVE-command">26 MOVE command</a></li>
1845 <li><a name="stoc-NOP-command" href="#toc-NOP-command">27 NOP command</a></li>
1846 <li><a name="stoc-OPEN-command" href="#toc-OPEN-command">28 OPEN command</a></li>
1847 <li><a name="stoc-OPTION-command" href="#toc-OPTION-command">29 OPTION command</a></li>
1848 <li><a name="stoc-PASSWD-command" href="#toc-PASSWD-command">30 PASSWD command</a></li>
1849 <li><a name="stoc-REALPATH-command" href="#toc-REALPATH-command">31 REALPATH command</a></li>
1850 <li><a name="stoc-RENAME-command" href="#toc-RENAME-command">32 RENAME command</a></li>
1851 <li><a name="stoc-RESET-command" href="#toc-RESET-command">33 RESET command</a></li>
1852 <li><a name="stoc-SAVE-command" href="#toc-SAVE-command">34 SAVE command</a></li>
1853 <li><a name="stoc-STORE-command" href="#toc-STORE-command">35 STORE command</a></li>
1854 <li><a name="stoc-UNLOCK-command" href="#toc-UNLOCK-command">36 UNLOCK command</a></li>
1855 <li><a name="stoc-XPATH-command" href="#toc-XPATH-command">37 XPATH command</a></li>
1856 <li><a name="stoc-XPATHATTR-command" href="#toc-XPATHATTR-command">38 XPATHATTR command</a></li>
1857 <li><a name="stoc-Status-messages-and-their-meanings" href="#toc-Status-messages-and-their-meanings">39 Status messages and their meanings</a></li>
1858 <li><a name="stoc-The-target-attribute" href="#toc-The-target-attribute">40 The <code>target</code> attribute</a></li>
1859 <li><a name="stoc-Other-special-attributes" href="#toc-Other-special-attributes">41 Other special attributes</a></li>
1860 <li><a name="stoc-Recognized-signals" href="#toc-Recognized-signals">42 Recognized signals</a></li>
1861 <li><a name="stoc-Concept-Index-1" href="#toc-Concept-Index-1">Concept Index</a></li>
1862
1863 </ul>
1864 </div>
1865
1866 <a name="SEC_Contents"></a>
1867 <h2 class="contents-heading">Table of Contents</h2>
1868
1869 <div class="contents">
1870 <ul class="no-bullet">
1871 <li><a name="toc-Overview-of-pwmd" href="#Introduction">1 Overview of <code>pwmd</code></a></li>
1872 <li><a name="toc-Access-Control-1" href="#Access-Control">2 Access Control</a></li>
1873 <li><a name="toc-Invoking-pwmd" href="#Invoking">3 Invoking <code>pwmd</code></a></li>
1874 <li><a name="toc-pwmd-configuration-file-options" href="#Configuration">4 <code>pwmd</code> configuration file options</a></li>
1875 <li><a name="toc-Configuring-remote-connections-over-TLS_002e" href="#TLS">5 Configuring remote connections over TLS.</a></li>
1876 <li><a name="toc-Pinentry-configuration" href="#Pinentry">6 Pinentry configuration</a></li>
1877 <li><a name="toc-Protocol-commands-and-their-syntax" href="#Commands">7 Protocol commands and their syntax</a></li>
1878 <li><a name="toc-ATTR-command" href="#ATTR">8 ATTR command</a></li>
1879 <li><a name="toc-CACHETIMEOUT-command" href="#CACHETIMEOUT">9 CACHETIMEOUT command</a></li>
1880 <li><a name="toc-CLEARCACHE-command" href="#CLEARCACHE">10 CLEARCACHE command</a></li>
1881 <li><a name="toc-COPY-command" href="#COPY">11 COPY command</a></li>
1882 <li><a name="toc-DELETE-command" href="#DELETE">12 DELETE command</a></li>
1883 <li><a name="toc-DUMP-command" href="#DUMP">13 DUMP command</a></li>
1884 <li><a name="toc-GET-command" href="#GET">14 GET command</a></li>
1885 <li><a name="toc-GETCONFIG-command" href="#GETCONFIG">15 GETCONFIG command</a></li>
1886 <li><a name="toc-GETINFO-command" href="#GETINFO">16 GETINFO command</a></li>
1887 <li><a name="toc-HELP-command" href="#HELP">17 HELP command</a></li>
1888 <li><a name="toc-IMPORT-command" href="#IMPORT">18 IMPORT command</a></li>
1889 <li><a name="toc-ISCACHED-command" href="#ISCACHED">19 ISCACHED command</a></li>
1890 <li><a name="toc-KEYINFO-command" href="#KEYINFO">20 KEYINFO command</a></li>
1891 <li><a name="toc-KILL-command" href="#KILL">21 KILL command</a></li>
1892 <li><a name="toc-LIST-command" href="#LIST">22 LIST command</a></li>
1893 <li><a name="toc-LISTKEYS-command" href="#LISTKEYS">23 LISTKEYS command</a></li>
1894 <li><a name="toc-LOCK-command" href="#LOCK">24 LOCK command</a></li>
1895 <li><a name="toc-LS-command" href="#LS">25 LS command</a></li>
1896 <li><a name="toc-MOVE-command" href="#MOVE">26 MOVE command</a></li>
1897 <li><a name="toc-NOP-command" href="#NOP">27 NOP command</a></li>
1898 <li><a name="toc-OPEN-command" href="#OPEN">28 OPEN command</a></li>
1899 <li><a name="toc-OPTION-command" href="#OPTION">29 OPTION command</a></li>
1900 <li><a name="toc-PASSWD-command" href="#PASSWD">30 PASSWD command</a></li>
1901 <li><a name="toc-REALPATH-command" href="#REALPATH">31 REALPATH command</a></li>
1902 <li><a name="toc-RENAME-command" href="#RENAME">32 RENAME command</a></li>
1903 <li><a name="toc-RESET-command" href="#RESET">33 RESET command</a></li>
1904 <li><a name="toc-SAVE-command" href="#SAVE">34 SAVE command</a></li>
1905 <li><a name="toc-STORE-command" href="#STORE">35 STORE command</a></li>
1906 <li><a name="toc-UNLOCK-command" href="#UNLOCK">36 UNLOCK command</a></li>
1907 <li><a name="toc-XPATH-command" href="#XPATH">37 XPATH command</a></li>
1908 <li><a name="toc-XPATHATTR-command" href="#XPATHATTR">38 XPATHATTR command</a></li>
1909 <li><a name="toc-Status-messages-and-their-meanings" href="#Status-Messages">39 Status messages and their meanings</a></li>
1910 <li><a name="toc-The-target-attribute" href="#Target-Attribute">40 The <code>target</code> attribute</a></li>
1911 <li><a name="toc-Other-special-attributes" href="#Other-Attributes">41 Other special attributes</a></li>
1912 <li><a name="toc-Recognized-signals" href="#Signals">42 Recognized signals</a></li>
1913 <li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li>
1914
1915 </ul>
1916 </div>
1917
1918 <hr>
1919
1920
1921
1922 </body>
1923 </html>