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