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