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