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>
 531 </dd>
 532 <dt>&lsquo;<samp>lock_timeout = integer</samp>&rsquo;</dt>
 533 <dd><p>The default timeout in tenths of a second before giving up waiting for a file
 534 lock and returning an error. The default is <code>50</code>.
 535 </p>
 536 </dd>
 537 <dt>&lsquo;<samp>send_state = boolean</samp>&rsquo;</dt>
 538 <dd><p>When <code>true</code> and the state of a client changes, send a status message to
 539 all connected clients about the client whose state changed (see <a href="#GETINFO">GETINFO</a>).
 540 The default is <code>true</code>.
 541 </p>
 542 </dd>
 543 </dl>
 544
 545 <a name="index-Data-file-configuration-options"></a>
 546 <p>The following options are defaults for new files when specified in the
 547 &lsquo;<samp>global</samp>&rsquo; section. When placed in a data file section they are options
 548 specific to that data file only.
 549 </p>
 550 <dl compact="compact">
 551 <dt>&lsquo;<samp>backup = boolean</samp>&rsquo;</dt>
 552 <dd><p>Whether to create a backup of the data file when saving. The backup filename
 553 has the <samp>.backup</samp> extension appended to the opened file. The default is
 554 <code>true</code>.
 555 </p>
 556 </dd>
 557 <dt>&lsquo;<samp>cache_timeout = seconds</samp>&rsquo;</dt>
 558 <dd><p>The number of seconds to keep the cache entry for this file. If <code>-1</code>, the
 559 cache entry is kept forever. If <code>0</code>, each time an encrypted file is
 560 <code>OPEN</code>ed (see <a href="#OPEN">OPEN</a>) a passphrase will be required. The default
 561 is <code>600</code> or 10 minutes.
 562 </p>
 563 </dd>
 564 <dt>&lsquo;<samp>xfer_progress = bytes</samp>&rsquo;</dt>
 565 <dd><p>Commands that send data lines to the client will also send the <code>XFER</code>
 566 status message (see <a href="#Status-Messages">Status Messages</a>) after the specified number of bytes
 567 have been sent. The number of bytes is rounded to <var>ASSUAN_LINELENGTH</var> or
 568 <code>1002</code> bytes. The default is <code>8196</code>.
 569 </p>
 570 </dd>
 571 <dt>&lsquo;<samp>passphrase = string</samp>&rsquo;</dt>
 572 <dd><p>The passphrase to use for this file. If specified in the &lsquo;<samp>global</samp>&rsquo; section
 573 then &lsquo;<samp>global</samp>&rsquo; is treated as a data filename and not a default for other
 574 files. Note that if a client changes the passphrase for this data file then
 575 this value is not modified and will need to be updated.
 576 </p>
 577 </dd>
 578 <dt>&lsquo;<samp>passphrase_file = /path/to/file</samp>&rsquo;</dt>
 579 <dd><p>Same as the <var>passphrase</var> parameter above but obtains the passphrase from
 580 the specified filename.
 581 </p>
 582 </dd>
 583 <dt>&lsquo;<samp>recursion_depth = integer</samp>&rsquo;</dt>
 584 <dd><p>The maximum number of times to resolve a <code>target</code> attribute for an
 585 element in an element path (see <a href="#Target-Attribute">Target Attribute</a>). An error is returned
 586 when this value is exceeded.  The default is <code>100</code> but can be disabled by
 587 setting to <code>0</code> (<em>not recommended</em>).
 588 </p>
 589 </dd>
 590 <dt>&lsquo;<samp>allowed = [-]user,[-]@group,...</samp>&rsquo;</dt>
 591 <dd><p>Same parameter value as the <code>allowed</code> parameter mentioned above in
 592 the &lsquo;<samp>global</samp>&rsquo; section but grants or denies a local user from opening
 593 a specific data file. The default is the same as the &lsquo;<samp>global</samp>&rsquo; section.
 594 </p>
 595 </dd>
 596 </dl>
 597 <table class="menu" border="0" cellspacing="0">
 598 <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.
 599 </td></tr>
 600 <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.
 601 </td></tr>
 602 </table>
 603
 604 <hr>
 605 <a name="TLS"></a>
 606 <div class="header">
 607 <p>
 608 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>
 609 </div>
 610 <a name="Configuring-remote-connections-over-TLS_002e"></a>
 611 <h2 class="chapter">5 Configuring remote connections over TLS.</h2>
 612 <p>Remote connections can also be made to <code>pwmd</code> over <abbr>TLS</abbr>.
 613 Authentication is done by using X509 client certificates that are signed with
 614 the same Certificate Authority (<abbr>CA</abbr>) as the server certificate.
 615 </p>
 616 <p>The <abbr>CA</abbr> certificate is expected to be found in
 617 <samp>~/.pwmd/ca-cert.pem</samp> while the <code>pwmd</code> server certificate and key
 618 file should be put in <samp>~/.pwmd/server-cert.pem</samp> and
 619 <samp>~/.pwmd/server-key.pem</samp>, respectively.
 620 </p>
 621 <p>See the documentation of <code>certtool</code> or <code>openssl</code> for details
 622 on creating self-signed certificates.
 623 </p>
 624 <p>The following TLS configuration options are available:
 625 </p>
 626 <dl compact="compact">
 627 <dt>&lsquo;<samp>enable_tcp = boolean</samp>&rsquo;</dt>
 628 <dd><p>Whether to enable TCP/TLS server support. If enabled, both TCP and the local
 629 unix domain socket will listen for connections. The default is
 630 <code>false</code>.
 631 </p>
 632 </dd>
 633 <dt>&lsquo;<samp>tcp_port = integer</samp>&rsquo;</dt>
 634 <dd><p>The TCP port to listen on when <var>enable_tcp</var> is <code>true</code>. The default is
 635 <code>6466</code>.
 636 </p>
 637 </dd>
 638 <dt>&lsquo;<samp>tcp_bind = string</samp>&rsquo;</dt>
 639 <dd><p>The internet protocol to listen with. Must be one of <code>ipv4</code>, <code>ipv6</code>
 640 or <code>any</code> to listen for both IPv4 and IPv6 connections.
 641 </p>
 642 </dd>
 643 <dt>&lsquo;<samp>tcp_interface = string</samp>&rsquo;</dt>
 644 <dd><p>Only useful if running as root.
 645 </p>
 646 </dd>
 647 <dt>&lsquo;<samp>tls_timeout = seconds</samp>&rsquo;</dt>
 648 <dd><p>The number of seconds to wait for a read() or write() call on a
 649 <abbr>TLS</abbr> client file descriptor to complete before returning an
 650 error. The default is <var>300</var>.
 651 </p>
 652 <p>Note that the <code>SAVE</code> command (see <a href="#SAVE">SAVE</a>) may take a longer time
 653 to complete than other commands since key generation may need to be done
 654 or do to a large <samp>--cipher-iterations</samp> setting.
 655 </p>
 656 </dd>
 657 <dt>&lsquo;<samp>keepalive_interval = seconds</samp>&rsquo;</dt>
 658 <dd><p>Send a keepalive status message to an idle remote client.  An idle
 659 client is one who is not in a command. The purpose of this status
 660 message is to disconnect a hung remote client and release any file mutex
 661 locks so another client may open the same data file. The default is <code>60</code>.
 662 </p>
 663 </dd>
 664 <dt>&lsquo;<samp>tcp_require_key = boolean</samp>&rsquo;</dt>
 665 <dd><p>When <code>true</code>, require the remote client to provide the key or passphrase
 666 to open a data file even if the file is cached. Note that the cache entry is
 667 cleared during the see <a href="#OPEN">OPEN</a> command and the passphrase will be retrieved
 668 from the client via a server <em>INQUIRE</em>. This option is a default
 669 for all files when specified in the &lsquo;<samp>global</samp>&rsquo; section. The default
 670 is <code>false</code>.
 671 </p>
 672 </dd>
 673 <dt>&lsquo;<samp>tcp_wait = integer</samp>&rsquo;</dt>
 674 <dd><p>The time in tenths of a second to wait between TCP connections.  Setting to 0
 675 will disable waiting. The default is <code>3</code>.
 676 </p>
 677 </dd>
 678 <dt>&lsquo;<samp>tls_cipher_suite = string</samp>&rsquo;</dt>
 679 <dd><p>The GnuTLS cipher suite and protocol to use. See the GnuTLS documentation for
 680 information about the format of this string. The default is <code>SECURE256</code>.
 681 </p></dd>
 682 </dl>
 683
 684 <hr>
 685 <a name="Pinentry"></a>
 686 <div class="header">
 687 <p>
 688 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>
 689 </div>
 690 <a name="Pinentry-configuration"></a>
 691 <h2 class="chapter">6 Pinentry configuration</h2>
 692
 693 <p>The <code>pinentry</code> program is used to prompt the user for passphrase
 694 input or as a confirmation dialog; it needs to know where to prompt for
 695 the input, beit from a terminal or an X11 display.
 696 </p>
 697 <p>It is the responsibility of the client to tell <code>pinentry</code> about
 698 the terminal or X11 display before requiring the input. This is done by
 699 using the <code>pwmd</code> <code>OPTION</code> (see <a href="#OPTION">OPTION</a>) protocol command. It
 700 need be done only once per client connection. To avoid the use of
 701 <code>pinentry</code> entirely, use the <code>OPTION</code> (see <a href="#OPTION">OPTION</a>)
 702 <samp>--disable-pinentry</samp> protocol command.
 703 </p>
 704 <hr>
 705 <a name="Commands"></a>
 706 <div class="header">
 707 <p>
 708 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>
 709 </div>
 710 <a name="Protocol-commands-and-their-syntax"></a>
 711 <h2 class="chapter">7 Protocol commands and their syntax</h2>
 712 <table class="menu" border="0" cellspacing="0">
 713 <tr><td align="left" valign="top">&bull; <a href="#AGENT" accesskey="1">AGENT</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 714 </td></tr>
 715 <tr><td align="left" valign="top">&bull; <a href="#ATTR" accesskey="2">ATTR</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 716 </td></tr>
 717 <tr><td align="left" valign="top">&bull; <a href="#CACHETIMEOUT" accesskey="3">CACHETIMEOUT</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 718 </td></tr>
 719 <tr><td align="left" valign="top">&bull; <a href="#CLEARCACHE" accesskey="4">CLEARCACHE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 720 </td></tr>
 721 <tr><td align="left" valign="top">&bull; <a href="#COPY" accesskey="5">COPY</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 722 </td></tr>
 723 <tr><td align="left" valign="top">&bull; <a href="#DELETE" accesskey="6">DELETE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 724 </td></tr>
 725 <tr><td align="left" valign="top">&bull; <a href="#DUMP" accesskey="7">DUMP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 726 </td></tr>
 727 <tr><td align="left" valign="top">&bull; <a href="#GET" accesskey="8">GET</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 728 </td></tr>
 729 <tr><td align="left" valign="top">&bull; <a href="#GETCONFIG" accesskey="9">GETCONFIG</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 730 </td></tr>
 731 <tr><td align="left" valign="top">&bull; <a href="#GETINFO">GETINFO</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 732 </td></tr>
 733 <tr><td align="left" valign="top">&bull; <a href="#HELP">HELP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 734 </td></tr>
 735 <tr><td align="left" valign="top">&bull; <a href="#IMPORT">IMPORT</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 736 </td></tr>
 737 <tr><td align="left" valign="top">&bull; <a href="#ISCACHED">ISCACHED</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 738 </td></tr>
 739 <tr><td align="left" valign="top">&bull; <a href="#KEYGRIP">KEYGRIP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 740 </td></tr>
 741 <tr><td align="left" valign="top">&bull; <a href="#KILL">KILL</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 742 </td></tr>
 743 <tr><td align="left" valign="top">&bull; <a href="#LIST">LIST</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 744 </td></tr>
 745 <tr><td align="left" valign="top">&bull; <a href="#LOCK">LOCK</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 746 </td></tr>
 747 <tr><td align="left" valign="top">&bull; <a href="#LS">LS</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 748 </td></tr>
 749 <tr><td align="left" valign="top">&bull; <a href="#MOVE">MOVE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 750 </td></tr>
 751 <tr><td align="left" valign="top">&bull; <a href="#NOP">NOP</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 752 </td></tr>
 753 <tr><td align="left" valign="top">&bull; <a href="#OPEN">OPEN</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 754 </td></tr>
 755 <tr><td align="left" valign="top">&bull; <a href="#OPTION">OPTION</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 756 </td></tr>
 757 <tr><td align="left" valign="top">&bull; <a href="#PASSWD">PASSWD</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 758 </td></tr>
 759 <tr><td align="left" valign="top">&bull; <a href="#REALPATH">REALPATH</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 760 </td></tr>
 761 <tr><td align="left" valign="top">&bull; <a href="#RENAME">RENAME</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 762 </td></tr>
 763 <tr><td align="left" valign="top">&bull; <a href="#RESET">RESET</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 764 </td></tr>
 765 <tr><td align="left" valign="top">&bull; <a href="#SAVE">SAVE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 766 </td></tr>
 767 <tr><td align="left" valign="top">&bull; <a href="#STORE">STORE</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 768 </td></tr>
 769 <tr><td align="left" valign="top">&bull; <a href="#UNLOCK">UNLOCK</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 770 </td></tr>
 771 <tr><td align="left" valign="top">&bull; <a href="#XPATH">XPATH</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 772 </td></tr>
 773 <tr><td align="left" valign="top">&bull; <a href="#XPATHATTR">XPATHATTR</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 774 </td></tr>
 775 </table>
 776 <hr>
 777 <a name="AGENT"></a>
 778 <div class="header">
 779 <p>
 780 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>
 781 </div>
 782 <a name="AGENT-command"></a>
 783 <h2 class="chapter">8 AGENT command</h2>
 784 <a name="index-AGENT-command"></a>
 785 <p>Syntax:
 786 </p><div class="example">
 787 <pre class="example">AGENT &lt;command&gt;
 788 </pre></div>
 789
 790 <p>Send a <code>gpg-agent</code> protocol <var>command</var> directly to the
 791 <code>gpg-agent</code>.
 792 </p>
 793
 794 <hr>
 795 <a name="ATTR"></a>
 796 <div class="header">
 797 <p>
 798 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>
 799 </div>
 800 <a name="ATTR-command"></a>
 801 <h2 class="chapter">9 ATTR command</h2>
 802 <a name="index-ATTR-command"></a>
 803 <p>Syntax:
 804 </p><div class="example">
 805 <pre class="example">ATTR [--inquire] SET|GET|DELETE|LIST [&lt;attribute&gt;] [!]element[&lt;TAB&gt;[!]child[..]] ..
 806 </pre></div>
 807
 808 <dl compact="compact">
 809 <dt>ATTR SET attribute [!]element[&lt;TAB&gt;[!]child[..]] [value]</dt>
 810 <dd>
 811 <p>Stores or updates an <var>attribute</var> name and optional <var>value</var> of an
 812 element. When no <var>value</var> is specified any existing value will be removed.
 813 </p>
 814 </dd>
 815 <dt>ATTR DELETE attribute [!]element[&lt;TAB&gt;[!]child[..]]</dt>
 816 <dd>
 817 <p>Removes an <var>attribute</var> from an element.
 818 </p>
 819 </dd>
 820 <dt>ATTR LIST [!]element[&lt;TAB&gt;[!]child[..]]</dt>
 821 <dd>
 822 <p>Retrieves a newline separated list of attributes names and values
 823 from the specified element. Each attribute name and value is space delimited.
 824 </p>
 825 </dd>
 826 <dt>ATTR GET attribute [!]element[&lt;TAB&gt;[!]child[..]]</dt>
 827 <dd>
 828 <p>Retrieves the value of an <var>attribute</var> from an element.
 829 </p></dd>
 830 </dl>
 831
 832 <p>The <code>_name</code> attribute (case sensitive) cannot be removed nor modified.
 833 Use the <code>DELETE</code> (see <a href="#DELETE">DELETE</a>) or <code>RENAME</code> (see <a href="#RENAME">RENAME</a>)
 834 commands instead.
 835 </p>
 836 <p>The <code>_mtime</code> attribute is updated each time an element is modified by
 837 either storing content, editing attributes or by deleting a child element.
 838 The <code>_ctime</code> attribute is created for each new element in an element
 839 path.
 840 </p>
 841 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
 842 arguments are retrieved via a server <em>INQUIRE</em>.
 843 </p>
 844 <p>See <a href="#Target-Attribute">Target Attribute</a>, for details about this special attribute.
 845 </p>
 846
 847 <hr>
 848 <a name="CACHETIMEOUT"></a>
 849 <div class="header">
 850 <p>
 851 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>
 852 </div>
 853 <a name="CACHETIMEOUT-command"></a>
 854 <h2 class="chapter">10 CACHETIMEOUT command</h2>
 855 <a name="index-CACHETIMEOUT-command"></a>
 856 <p>Syntax:
 857 </p><div class="example">
 858 <pre class="example">CACHETIMEOUT &lt;filename&gt; &lt;seconds&gt;
 859 </pre></div>
 860
 861 <p>The time in <var>seconds</var> until <var>filename</var> will be removed from the
 862 cache. <code>-1</code> will keep the cache entry forever, <code>0</code> will require
 863 the passphrase for each <code>OPEN</code> or <code>SAVE</code> command (see <a href="#OPEN">OPEN</a>,
 864 see <a href="#SAVE">SAVE</a>). See <a href="#Configuration">Configuration</a>, and the <code>cache_timeout</code>
 865 parameter.
 866 </p>
 867
 868 <hr>
 869 <a name="CLEARCACHE"></a>
 870 <div class="header">
 871 <p>
 872 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>
 873 </div>
 874 <a name="CLEARCACHE-command"></a>
 875 <h2 class="chapter">11 CLEARCACHE command</h2>
 876 <a name="index-CLEARCACHE-command"></a>
 877 <p>Syntax:
 878 </p><div class="example">
 879 <pre class="example">CLEARCACHE [&lt;filename&gt;]
 880 </pre></div>
 881
 882 <p>Clears a file cache entry for all or the specified <var>filename</var>.
 883 </p>
 884
 885 <hr>
 886 <a name="COPY"></a>
 887 <div class="header">
 888 <p>
 889 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>
 890 </div>
 891 <a name="COPY-command"></a>
 892 <h2 class="chapter">12 COPY command</h2>
 893 <a name="index-COPY-command"></a>
 894 <p>Syntax:
 895 </p><div class="example">
 896 <pre class="example">COPY [--inquire] [!]source[&lt;TAB&gt;[!]child[..]] [!]dest[&lt;TAB&gt;[!]child[..]]
 897 </pre></div>
 898
 899 <p>Copies the entire element tree starting from the child node of the source
 900 element, to the destination element path. If the destination element path
 901 does not exist then it will be created; otherwise it is overwritten.
 902 </p>
 903 <p>Note that attributes from the source element are merged into the
 904 destination element when the destination element path exists. When an
 905 attribute of the same name exists in both the source and destination
 906 elements then the destination attribute will be updated to the source
 907 attribute value.
 908 </p>
 909 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
 910 arguments are retrieved via a server <em>INQUIRE</em>.
 911 </p>
 912
 913 <hr>
 914 <a name="DELETE"></a>
 915 <div class="header">
 916 <p>
 917 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>
 918 </div>
 919 <a name="DELETE-command"></a>
 920 <h2 class="chapter">13 DELETE command</h2>
 921 <a name="index-DELETE-command"></a>
 922 <p>Syntax:
 923 </p><div class="example">
 924 <pre class="example">DELETE [--inquire] [!]element[&lt;TAB&gt;[!]child[..]]
 925 </pre></div>
 926
 927 <p>Removes the specified element path and all of its children. This may break
 928 an element with a <code>target</code> attribute (see <a href="#Target-Attribute">Target Attribute</a>) that
 929 refers to this element or any of its children.
 930 </p>
 931 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
 932 arguments are retrieved via a server <em>INQUIRE</em>.
 933 </p>
 934
 935 <hr>
 936 <a name="DUMP"></a>
 937 <div class="header">
 938 <p>
 939 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>
 940 </div>
 941 <a name="DUMP-command"></a>
 942 <h2 class="chapter">14 DUMP command</h2>
 943 <a name="index-DUMP-command"></a>
 944 <p>Syntax:
 945 </p><div class="example">
 946 <pre class="example">DUMP
 947 </pre></div>
 948
 949 <p>Shows the in memory <abbr>XML</abbr> document with indenting. See <a href="#XPATH">XPATH</a>, for
 950 dumping a specific node.
 951 </p>
 952
 953 <hr>
 954 <a name="GET"></a>
 955 <div class="header">
 956 <p>
 957 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>
 958 </div>
 959 <a name="GET-command"></a>
 960 <h2 class="chapter">15 GET command</h2>
 961 <a name="index-GET-command"></a>
 962 <p>Syntax:
 963 </p><div class="example">
 964 <pre class="example">GET [--inquire] [!]element[&lt;TAB&gt;[!]child[..]]
 965 </pre></div>
 966
 967 <p>Retrieves the content of the specified element. The content is returned
 968 with a data response.
 969 </p>
 970 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
 971 arguments are retrieved via a server <em>INQUIRE</em>.
 972 </p>
 973
 974 <hr>
 975 <a name="GETCONFIG"></a>
 976 <div class="header">
 977 <p>
 978 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>
 979 </div>
 980 <a name="GETCONFIG-command"></a>
 981 <h2 class="chapter">16 GETCONFIG command</h2>
 982 <a name="index-GETCONFIG-command"></a>
 983 <p>Syntax:
 984 </p><div class="example">
 985 <pre class="example">GETCONFIG [filename] &lt;parameter&gt;
 986 </pre></div>
 987
 988 <p>Returns the value of a <code>pwmd</code> configuration <var>parameter</var> with a
 989 data response. If no file has been opened then the value for <var>filename</var>
 990 or the default from the &lsquo;<samp>global</samp>&rsquo; section will be returned. If a file
 991 has been opened and no <var>filename</var> is specified, a value previously
 992 set with the <code>OPTION</code> command (see <a href="#OPTION">OPTION</a>) will be returned.
 993 </p>
 994
 995 <hr>
 996 <a name="GETINFO"></a>
 997 <div class="header">
 998 <p>
 999 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>
1000 </div>
1001 <a name="GETINFO-command"></a>
1002 <h2 class="chapter">17 GETINFO command</h2>
1003 <a name="index-GETINFO-command"></a>
1004 <p>Syntax:
1005 </p><div class="example">
1006 <pre class="example">GETINFO [--data] [--verbose] CACHE | CLIENTS | PID | USER | LAST_ERROR | VERSION
1007 </pre></div>
1008
1009 <p>Get server and other information: <var>CACHE</var> returns the number of cached
1010 documents via a status message. <var>CLIENTS</var> returns the number of
1011 connected clients via a status message or a list of connected clients when
1012 the <samp>--verbose</samp> parameter is used. The list contains space delimited
1013 fields: the thread ID, client name, opened file (<code>/</code> if none opened),
1014 file lock status, whether the current client is self, client state and
1015 user ID or TLS fingerprint of the connected client.
1016 Client state <code>1</code> indicates that the client is idle, <code>2</code> means the
1017 client is in a command and <code>3</code> means the client is disconnecting. This
1018 line is always returned with a data response. <var>PID</var> returns the process
1019 ID number of the server via a data response. <var>VERSION</var> returns the server
1020 version number and compile-time features with a data response with each
1021 being space delimited. <var>LAST_ERROR</var> returns a detailed description of
1022 the last failed command when available. <var>USER</var> returns the username or
1023 <abbr>TLS</abbr> hash of the connected client. See <a href="#Status-Messages">Status Messages</a>.
1024 </p>
1025 <p>When the <samp>--data</samp> option is specified then the result will be sent
1026 via a data response rather than a status message.
1027 </p>
1028
1029 <hr>
1030 <a name="HELP"></a>
1031 <div class="header">
1032 <p>
1033 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>
1034 </div>
1035 <a name="HELP-command"></a>
1036 <h2 class="chapter">18 HELP command</h2>
1037 <a name="index-HELP-command"></a>
1038 <p>Syntax:
1039 </p><div class="example">
1040 <pre class="example">HELP [&lt;COMMAND&gt;]
1041 </pre></div>
1042
1043 <p>Show available commands or command specific help text.
1044 </p>
1045
1046 <hr>
1047 <a name="IMPORT"></a>
1048 <div class="header">
1049 <p>
1050 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>
1051 </div>
1052 <a name="IMPORT-command"></a>
1053 <h2 class="chapter">19 IMPORT command</h2>
1054 <a name="index-IMPORT-command"></a>
1055 <p>Syntax:
1056 </p><div class="example">
1057 <pre class="example">IMPORT [--root [!]element[&lt;TAB&gt;[!]child[..]]] &lt;content&gt;
1058 </pre></div>
1059
1060 <p>This command uses a server <em>INQUIRE</em> to retrieve data from the client.
1061 </p>
1062 <p>Like the <code>STORE</code> command (see <a href="#STORE">STORE</a>), but the <var>content</var>
1063 argument is raw <abbr>XML</abbr> data. The content is created as a child of
1064 the element path specified with the <samp>--root</samp> option or at the
1065 document root when not specified. Existing elements of the same name will
1066 be overwritten.
1067 </p>
1068 <p>The content must begin with an <abbr>XML</abbr> element node. See <a href="#Introduction">Introduction</a>,
1069 for details.
1070 </p>
1071
1072 <hr>
1073 <a name="ISCACHED"></a>
1074 <div class="header">
1075 <p>
1076 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>
1077 </div>
1078 <a name="ISCACHED-command"></a>
1079 <h2 class="chapter">20 ISCACHED command</h2>
1080 <a name="index-ISCACHED-command"></a>
1081 <p>Syntax:
1082 </p><div class="example">
1083 <pre class="example">ISCACHED [--lock] &lt;filename&gt;
1084 </pre></div>
1085
1086 <p>An <em>OK</em> response is returned if the specified <var>filename</var> is found
1087 in the file cache. If not found in the cache but exists on the filesystem
1088 then <var>GPG_ERR_NO_DATA</var> is returned. Otherwise a filesystem error is
1089 returned.
1090 </p>
1091 <p>The <samp>lock</samp> option will lock the file mutex of <var>filename</var> when the
1092 file exists; it does not need to be opened nor cached. The lock will be
1093 released when the client exits or sends the <code>UNLOCK</code> (see <a href="#UNLOCK">UNLOCK</a>)
1094 command.
1095 </p>
1096
1097 <hr>
1098 <a name="KEYGRIP"></a>
1099 <div class="header">
1100 <p>
1101 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>
1102 </div>
1103 <a name="KEYGRIP-command"></a>
1104 <h2 class="chapter">21 KEYGRIP command</h2>
1105 <a name="index-KEYGRIP-command"></a>
1106 <p>Syntax:
1107 </p><div class="example">
1108 <pre class="example">KEYGRIP [--sign] &lt;filename&gt;
1109 </pre></div>
1110
1111 <p>Returns the hex encoded keygrip of the specified <var>filename</var> with a
1112 data response.
1113 </p>
1114 <p>When the <samp>--sign</samp> option is specified then the key used for signing
1115 of the specified <var>filename</var> will be returned.
1116 </p>
1117 <p>For symmetrically encrypted data files this command returns the error
1118 GPG_ERR_NOT_SUPPORTED.
1119 </p>
1120
1121 <hr>
1122 <a name="KILL"></a>
1123 <div class="header">
1124 <p>
1125 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>
1126 </div>
1127 <a name="KILL-command"></a>
1128 <h2 class="chapter">22 KILL command</h2>
1129 <a name="index-KILL-command"></a>
1130 <p>Syntax:
1131 </p><div class="example">
1132 <pre class="example">KILL &lt;thread_id&gt;
1133 </pre></div>
1134
1135 <p>Terminates the client identified by <var>thread_id</var> and releases any file
1136 lock or other resources it has held. See <a href="#GETINFO">GETINFO</a> for details about listing
1137 connected clients.
1138 </p>
1139
1140 <hr>
1141 <a name="LIST"></a>
1142 <div class="header">
1143 <p>
1144 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>
1145 </div>
1146 <a name="LIST-command"></a>
1147 <h2 class="chapter">23 LIST command</h2>
1148 <a name="index-LIST-command"></a>
1149 <p>Syntax:
1150 </p><div class="example">
1151 <pre class="example">LIST [--inquire] [--no-recurse] [--verbose] [--with-target] [--all] [[!]element[&lt;TAB&gt;[!]child[..]]]
1152 </pre></div>
1153
1154 <p>If no element path is given then a newline separated list of root elements
1155 is returned with a data response. If given, then all reachable elements
1156 of the specified element path are returned unless the <samp>--no-recurse</samp>
1157 option is specified. If specified, only the child elements of the element
1158 path are returned without recursing into grandchildren. Each resulting
1159 element is prefixed with the literal <code>!</code> character when the element
1160 contains no <code>target</code> attribute. See <a href="#Target-Attribute">Target Attribute</a>, for details.
1161 </p>
1162 <p>When the <samp>--verbose</samp> option is passed then each element path
1163 returned will have zero or more flags appened to it. These flags are
1164 delimited from the element path by a single space character. A flag itself
1165 is a single character. Flag <code>P</code> indicates that access to the element
1166 is denied. Flag <code>+</code> indicates that there are child nodes of
1167 the current element path. Flag <code>E</code> indicates that an element of an
1168 element path contained in a <var>target</var> attribute could not be found. Flag
1169 <code>O</code> indicates that a <var>target</var> attribute recursion limit was reached
1170 (see <a href="#Configuration">Configuration</a>). Flag <code>T</code> will append the resolved element path
1171 of the <var>target</var> attribute contained in the current element (see below).
1172 </p>
1173 <p>The <samp>--with-target</samp> option implies <samp>--verbose</samp> and will append
1174 an additional flag <code>T</code> followed by a single space then an element path.
1175 The appended element path is the resolved path (see <a href="#REALPATH">REALPATH</a>) of the
1176 current element when it contains a <var>target</var> attribute. When no
1177 <var>target</var> attribute is found then no flag will be appended.
1178 </p>
1179 <p>The <samp>--no-recurse</samp> option limits the amount of data returned to only
1180 the listing of children of the specified element path and not any
1181 grandchildren.
1182 </p>
1183 <p>The <samp>--all</samp> option lists the entire element tree for each root
1184 element. This option also implies option <samp>--verbose</samp>.
1185 </p>
1186 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
1187 arguments are retrieved via a server <em>INQUIRE</em>.
1188 </p>
1189
1190 <hr>
1191 <a name="LOCK"></a>
1192 <div class="header">
1193 <p>
1194 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>
1195 </div>
1196 <a name="LOCK-command"></a>
1197 <h2 class="chapter">24 LOCK command</h2>
1198 <a name="index-LOCK-command"></a>
1199 <p>Syntax:
1200 </p><div class="example">
1201 <pre class="example">LOCK
1202 </pre></div>
1203
1204 <p>Locks the mutex associated with the opened file. This prevents other clients
1205 from sending commands to the same opened file until the client
1206 that sent this command either disconnects or sends the <code>UNLOCK</code>
1207 command. See <a href="#UNLOCK">UNLOCK</a>.
1208 </p>
1209
1210 <hr>
1211 <a name="LS"></a>
1212 <div class="header">
1213 <p>
1214 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>
1215 </div>
1216 <a name="LS-command"></a>
1217 <h2 class="chapter">25 LS command</h2>
1218 <a name="index-LS-command"></a>
1219 <p>Syntax:
1220 </p><div class="example">
1221 <pre class="example">LS
1222 </pre></div>
1223
1224 <p>Lists the available data files stored in the data directory
1225 (<samp>~/.pwmd/data</samp>). The result is a newline separated list of filenames.
1226 </p>
1227
1228 <hr>
1229 <a name="MOVE"></a>
1230 <div class="header">
1231 <p>
1232 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>
1233 </div>
1234 <a name="MOVE-command"></a>
1235 <h2 class="chapter">26 MOVE command</h2>
1236 <a name="index-MOVE-command"></a>
1237 <p>Syntax:
1238 </p><div class="example">
1239 <pre class="example">MOVE [--inquire] [!]source[&lt;TAB&gt;[!]child[..]] [[!]dest[&lt;TAB&gt;[!]child[..]]]
1240 </pre></div>
1241
1242 <p>Moves the source element path to the destination element path. If the
1243 destination is not specified then it will be moved to the root node of the
1244 document. If the destination is specified and exists then it will be
1245 overwritten; otherwise non-existing elements of the destination element
1246 path will be created.
1247 </p>
1248 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
1249 arguments are retrieved via a server <em>INQUIRE</em>.
1250 </p>
1251
1252 <hr>
1253 <a name="NOP"></a>
1254 <div class="header">
1255 <p>
1256 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>
1257 </div>
1258 <a name="NOP-command"></a>
1259 <h2 class="chapter">27 NOP command</h2>
1260 <a name="index-NOP-command"></a>
1261 <p>Syntax:
1262 </p><div class="example">
1263 <pre class="example">NOP
1264 </pre></div>
1265
1266 <p>Does nothing. Always returns successfully.
1267 </p>
1268
1269 <hr>
1270 <a name="OPEN"></a>
1271 <div class="header">
1272 <p>
1273 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>
1274 </div>
1275 <a name="OPEN-command"></a>
1276 <h2 class="chapter">28 OPEN command</h2>
1277 <a name="index-OPEN-command"></a>
1278 <p>Syntax:
1279 </p><div class="example">
1280 <pre class="example">OPEN [--lock] &lt;filename&gt; [&lt;passphrase&gt;]
1281 </pre></div>
1282
1283 <p>Opens <var>filename</var> using <var>passphrase</var>. When the filename is not
1284 found on the file-system  then a new document will be created. If the file
1285 is found, it is looked for in the file cache. If cached and no
1286 <var>passphrase</var> was specified then the cached document is opened. When not
1287 cached, <cite>pinentry(1)</cite> will be used to retrieve the passphrase to use
1288 for decryption unless <samp>disable-pinentry</samp> (see <a href="#OPTION">OPTION</a>) was
1289 specified.
1290 </p>
1291 <p>When the <samp>--lock</samp> option is passed then the file mutex will be
1292 locked as if the <code>LOCK</code> command (see <a href="#LOCK">LOCK</a>) had been sent after the
1293 file has been opened.
1294 </p>
1295
1296 <hr>
1297 <a name="OPTION"></a>
1298 <div class="header">
1299 <p>
1300 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>
1301 </div>
1302 <a name="OPTION-command"></a>
1303 <h2 class="chapter">29 OPTION command</h2>
1304 <a name="index-OPTION-command"></a>
1305 <p>Syntax:
1306 </p><div class="example">
1307 <pre class="example">OPTION &lt;NAME&gt;=&lt;VALUE&gt;
1308 </pre></div>
1309
1310 <p>Sets a client option <var>name</var> to <var>value</var>. The value for an option is
1311 kept for the duration of the connection.
1312 </p>
1313 <dl compact="compact">
1314 <dt>DISABLE-PINENTRY</dt>
1315 <dd><p>Disable use of <code>pinentry</code> for passphrase retrieval. When set, a
1316 server inquire is sent to the client to obtain the passphrase. This option
1317 may be set as needed before the <code>OPEN</code> (see <a href="#OPEN">OPEN</a>), <code>PASSWD</code>
1318 (see <a href="#PASSWD">PASSWD</a>) and <code>SAVE</code> (see <a href="#SAVE">SAVE</a>) commands.
1319 </p>
1320 </dd>
1321 <dt>PINENTRY-TIMEOUT</dt>
1322 <dd><p>Sets the number of seconds before a pinentry prompt will return an error
1323 while waiting for user input.
1324 </p>
1325 </dd>
1326 <dt>TTYNAME</dt>
1327 <dd><p>Passed to the <code>gpg-agent</code> and used for the <code>pinentry</code> dialog.
1328 </p>
1329 </dd>
1330 <dt>TTYTYPE</dt>
1331 <dd><p>Passed to the <code>gpg-agent</code> and used for the <code>pinentry</code> dialog.
1332 </p>
1333 </dd>
1334 <dt>DISPLAY</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>PINENTRY-DESC</dt>
1339 <dd><p>Sets the description string of the <code>gpg-agent</code> and <code>pinentry</code> dialog.
1340 </p>
1341 </dd>
1342 <dt>PINENTRY-TITLE</dt>
1343 <dd><p>Sets the title string of the <code>gpg-agent</code> and <code>pinentry</code> dialog.
1344 </p>
1345 </dd>
1346 <dt>PINENTRY-PROMPT</dt>
1347 <dd><p>Sets the prompt string of the <code>gpg-agent</code> and <code>pinentry</code> dialog.
1348 </p>
1349 </dd>
1350 <dt>LC-CTYPE</dt>
1351 <dd><p>Passed to the <code>gpg-agent</code> and used for the <code>pinentry</code> dialog.
1352 </p>
1353 </dd>
1354 <dt>LC-MESSAGES</dt>
1355 <dd><p>Passed to the <code>gpg-agent</code> and used for the <code>pinentry</code> dialog.
1356 </p>
1357 </dd>
1358 <dt>NAME</dt>
1359 <dd><p>Associates the thread ID of the connection with the specified textual
1360 representation. Useful for debugging log messages. May not contain whitespace.
1361 </p>
1362 </dd>
1363 <dt>LOCK-TIMEOUT</dt>
1364 <dd><p>When not <code>0</code>, the duration in tenths of a second to wait for the file
1365 mutex which has been locked by another thread to be released before returning
1366 an error. When <code>-1</code>, then an error will be returned immediately.
1367 </p>
1368 </dd>
1369 <dt>LOG-LEVEL</dt>
1370 <dd><p>An integer specifiying the logging level.
1371 </p></dd>
1372 </dl>
1373
1374
1375 <hr>
1376 <a name="PASSWD"></a>
1377 <div class="header">
1378 <p>
1379 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>
1380 </div>
1381 <a name="PASSWD-command"></a>
1382 <h2 class="chapter">30 PASSWD command</h2>
1383 <a name="index-PASSWD-command"></a>
1384 <p>Syntax:
1385 </p><div class="example">
1386 <pre class="example">PASSWD [--reset] [--s2k-count=N] [--no-passphrase]
1387 </pre></div>
1388
1389 <p>Changes the passphrase of the secret key required to open the current
1390 file or the passphrase of a symmetrically encrypted data file. When the
1391 <samp>--reset</samp> option is passed then the cache entry for the current
1392 file will be reset and the passphrase, if any, will be required during the
1393 next <code>OPEN</code> (see <a href="#OPEN">OPEN</a>).
1394 </p>
1395 <p>The <samp>--s2k-count</samp> option sets or changes (see <a href="#SAVE">SAVE</a>) the number
1396 of hash iterations for a passphrase and must be either <code>0</code> to use
1397 the calibrated count of the machine (the default), or a value greater than
1398 or equal to <code>65536</code>. This option has no effect for symmetrically
1399 encrypted data files.
1400 </p>
1401 <p>The <samp>--no-passphrase</samp> option will prevent requiring a passphrase for
1402 the data file, although a passphrase may be required when changing it.
1403 </p>
1404 <p>This command is not available for non-invoking clients
1405 (see <a href="#Access-Control">Access Control</a>).
1406 </p>
1407
1408 <hr>
1409 <a name="REALPATH"></a>
1410 <div class="header">
1411 <p>
1412 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>
1413 </div>
1414 <a name="REALPATH-command"></a>
1415 <h2 class="chapter">31 REALPATH command</h2>
1416 <a name="index-REALPATH-command"></a>
1417 <p>Syntax:
1418 </p><div class="example">
1419 <pre class="example">REALPATH [--inquire] [!]element[&lt;TAB&gt;[!]child[..]]
1420 </pre></div>
1421
1422 <p>Resolves all <code>target</code> attributes of the specified element path and
1423 returns the result with a data response. See <a href="#Target-Attribute">Target Attribute</a>, for details.
1424 </p>
1425 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
1426 arguments are retrieved via a server <em>INQUIRE</em>.
1427 </p>
1428
1429 <hr>
1430 <a name="RENAME"></a>
1431 <div class="header">
1432 <p>
1433 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>
1434 </div>
1435 <a name="RENAME-command"></a>
1436 <h2 class="chapter">32 RENAME command</h2>
1437 <a name="index-RENAME-command"></a>
1438 <p>Syntax:
1439 </p><div class="example">
1440 <pre class="example">RENAME [--inquire] [!]element[&lt;TAB&gt;[!]child[..]] &lt;value&gt;
1441 </pre></div>
1442
1443 <p>Renames the specified <var>element</var> to the new <var>value</var>. If an element of
1444 the same name as the <var>value</var> already exists it will be overwritten.
1445 </p>
1446 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
1447 arguments are retrieved via a server <em>INQUIRE</em>.
1448 </p>
1449
1450 <hr>
1451 <a name="RESET"></a>
1452 <div class="header">
1453 <p>
1454 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>
1455 </div>
1456 <a name="RESET-command"></a>
1457 <h2 class="chapter">33 RESET command</h2>
1458 <a name="index-RESET-command"></a>
1459 <p>Syntax:
1460 </p><div class="example">
1461 <pre class="example">RESET
1462 </pre></div>
1463
1464 <p>Closes the currently opened file but keeps any previously set client options.
1465 </p>
1466
1467 <hr>
1468 <a name="SAVE"></a>
1469 <div class="header">
1470 <p>
1471 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>
1472 </div>
1473 <a name="SAVE-command"></a>
1474 <h2 class="chapter">34 SAVE command</h2>
1475 <a name="index-SAVE-command"></a>
1476 <p>Syntax:
1477 </p><div class="example">
1478 <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]
1479 </pre></div>
1480
1481 <p>Writes the <abbr>XML</abbr> document to disk. The file written to is the file that
1482 was opened using the <code>OPEN</code> command (see <a href="#OPEN">OPEN</a>). If the file is a
1483 new one or the option <samp>--inquire-keyparam</samp> was passed, then a new
1484 keypair will be generated and a pinentry will be used to prompt for the
1485 passphrase to encrypt with unless the <samp>--no-passphrase</samp> option was
1486 passed in which case the data file will not be passphrase protected.
1487 </p>
1488 <p>The <samp>--no-agent</samp> option disables use of <code>gpg-agent</code> for
1489 passphrase retrieval and caching of new files when <code>gpg-agent</code>
1490 use is enabled. The datafile will be symmetrically encrypted and will not
1491 use or generate any keypair.
1492 </p>
1493 <p>The <samp>--reset</samp> option will clear the cache entry for the current file
1494 and require a passphrase, if needed, before saving.
1495 </p>
1496 <p>The <samp>--cipher</samp> option can be used to encrypt the <abbr>XML</abbr> data to
1497 an alternate cipher. The default is <code>aes256</code>. See the Configuration
1498 (see <a href="#Configuration">Configuration</a>) for available ciphers.
1499 </p>
1500 <p>The <samp>--cipher-iterations</samp> option  specifies the number of times to
1501 encrypt the XML data. The default is 0 although 1 iteration is still done.
1502 </p>
1503 <p>The <samp>--inquire-keyparam</samp> option will send a server <em>INQUIRE</em> to
1504 the client to obtain the key paramaters to use when generating a new
1505 keypair. The inquired data is expected to be an S-expression. If not
1506 specified then an &lsquo;<samp>RSA</samp>&rsquo; key of &lsquo;<samp>2048</samp>&rsquo; bits will be generated
1507 unless otherwise set in the configuration file (see <a href="#Configuration">Configuration</a>). Note
1508 that when this option is specified a new keypair will be generated
1509 reguardless if the file is a new one and that if the data file is protected
1510 the passphrase to open it will be required before generating the new
1511 keypair. This option is not available for non-invoking clients
1512 (see <a href="#Access-Control">Access Control</a>).
1513 </p>
1514 <p>You can encrypt the data file to a public key other than the one that it
1515 was originally encrypted with by passing the <samp>--keygrip</samp> option with
1516 the hex encoded keygrip of the public key as its argument. The keygrip may
1517 be of any key that <code>gpg-agent</code> knows about. The
1518 <samp>--sign-keygrip</samp> option may also be used to sign with an alternate
1519 secret key. Use the <code>KEYGRIP</code> (see <a href="#KEYGRIP">KEYGRIP</a>) command to obtain the
1520 keygrip of an existing data file. This option may be needed when using a
1521 smartcard. This option has no effect with symmetrically encrypted data
1522 files. These options are not available for non-invoking clients
1523 (see <a href="#Access-Control">Access Control</a>).
1524 </p>
1525 <p>The <samp>--s2k-count</samp> option sets number of hash iterations for a
1526 passphrase. A value less-than <code>65536</code> will use the machine calibrated
1527 value and is the default. This setting only affects new files. To change
1528 the setting use the <code>PASSWD</code> command (see <a href="#PASSWD">PASSWD</a>). This option
1529 has no effect with symmetrically encrypted data files.
1530 </p>
1531
1532 <hr>
1533 <a name="STORE"></a>
1534 <div class="header">
1535 <p>
1536 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>
1537 </div>
1538 <a name="STORE-command"></a>
1539 <h2 class="chapter">35 STORE command</h2>
1540 <a name="index-STORE-command"></a>
1541 <p>Syntax:
1542 </p><div class="example">
1543 <pre class="example">STORE [!]element[&lt;TAB&gt;[!]child[..]]&lt;TAB&gt;[content]
1544 </pre></div>
1545
1546 <p>This command uses a server <em>INQUIRE</em> to retrieve data from the client.
1547 </p>
1548 <p>Creates a new element path or modifies the <var>content</var> of an existing
1549 element. If only a single element is specified then a new root element is
1550 created. Otherwise, elements are <tt class="key">TAB</tt> delimited and the content will be
1551 set to the final <tt class="key">TAB</tt> delimited element. If no <var>content</var> is
1552 specified after the final <tt class="key">TAB</tt>, then the content of an existing
1553 element will be removed; or empty when creating a new element.
1554 </p>
1555 <p>The only restriction of an element name is that it not contain whitespace
1556 or begin with the literal element character <code>!</code> unless specifying a
1557 literal element (see <a href="#Target-Attribute">Target Attribute</a>). There is no whitespace between
1558 the <tt class="key">TAB</tt> delimited elements. It is recommended that the content of an
1559 element be base64 encoded when it contains control or <tt class="key">TAB</tt> characters
1560 to prevent <abbr>XML</abbr> parsing and <code>pwmd</code> syntax errors.
1561 </p>
1562
1563 <hr>
1564 <a name="UNLOCK"></a>
1565 <div class="header">
1566 <p>
1567 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>
1568 </div>
1569 <a name="UNLOCK-command"></a>
1570 <h2 class="chapter">36 UNLOCK command</h2>
1571 <a name="index-UNLOCK-command"></a>
1572 <p>Syntax:
1573 </p><div class="example">
1574 <pre class="example">UNLOCK
1575 </pre></div>
1576
1577 <p>Unlocks the file mutex which was locked with the <code>LOCK</code> command or
1578 a commands&rsquo; <samp>--lock</samp> option (see <a href="#LOCK">LOCK</a>, see <a href="#OPEN">OPEN</a>,
1579 see <a href="#ISCACHED">ISCACHED</a>).
1580 </p>
1581
1582 <hr>
1583 <a name="XPATH"></a>
1584 <div class="header">
1585 <p>
1586 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>
1587 </div>
1588 <a name="XPATH-command"></a>
1589 <h2 class="chapter">37 XPATH command</h2>
1590 <a name="index-XPATH-command"></a>
1591 <p>Syntax:
1592 </p><div class="example">
1593 <pre class="example">XPATH [--inquire] &lt;expression&gt;[&lt;TAB&gt;[value]]
1594 </pre></div>
1595
1596 <p>Evaluates an XPath <var>expression</var>. If no <var>value</var> argument is
1597 specified it is assumed the expression is a request to return a result.
1598 Otherwise, the result is set to the <var>value</var> argument and the document is
1599 updated. If there is no <var>value</var> after the <tt class="key">TAB</tt> character, the value
1600 is assumed to be empty and the document is updated. For example:
1601 </p><br>
1602 <div class="example">
1603 <pre class="example">XPATH //element[@_name='password']<span class="key">TAB</span>
1604 </pre></div>
1605 <br>
1606 <p>would clear the content of all <code>password</code> elements in the data file
1607 while leaving off the trailing <tt class="key">TAB</tt> would return all <code>password</code>
1608 elements in <abbr>XML</abbr> format.
1609 </p>
1610 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
1611 arguments are retrieved via a server <em>INQUIRE</em>.
1612 </p>
1613 <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>
1614 expression syntax.
1615 </p>
1616
1617 <hr>
1618 <a name="XPATHATTR"></a>
1619 <div class="header">
1620 <p>
1621 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>
1622 </div>
1623 <a name="XPATHATTR-command"></a>
1624 <h2 class="chapter">38 XPATHATTR command</h2>
1625 <a name="index-XPATHATTR-command"></a>
1626 <p>Syntax:
1627 </p><div class="example">
1628 <pre class="example">XPATHATTR [--inquire] SET|DELETE &lt;name&gt; &lt;expression&gt;[&lt;TAB&gt;[&lt;value&gt;]]
1629 </pre></div>
1630
1631 <p>Like the <code>XPATH</code> command (see <a href="#XPATH">XPATH</a>) but operates on element
1632 attributes and does not return a result. For the <var>SET</var> operation the
1633 <var>value</var> is optional but the field is required. If not specified then
1634 the attribute value will be empty. For example:
1635 </p><br>
1636 <div class="example">
1637 <pre class="example">XPATHATTR SET password //element[@_name='password']<span class="key">TAB</span>
1638 </pre></div>
1639 <br>
1640 <p>would create an <code>password</code> attribute for each <code>password</code> element
1641 found in the document. The attribute value will be empty but still exist.
1642 </p>
1643 <p>When the <samp>--inquire</samp> option is passed then all remaining non-option
1644 arguments are retrieved via a server <em>INQUIRE</em>.
1645 </p>
1646 <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>
1647 expression syntax.
1648 </p>
1649
1650
1651 <hr>
1652 <a name="Status-Messages"></a>
1653 <div class="header">
1654 <p>
1655 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>
1656 </div>
1657 <a name="Status-messages-and-their-meanings"></a>
1658 <h2 class="chapter">39 Status messages and their meanings</h2>
1659 <p>Some commands send status messages to inform the client about certain
1660 operations or as a progress indicator.  Status messages begin with a
1661 <code>KEYWORD</code> followed by a status description for status messages that
1662 require it. What status messages are sent, when, and how often may depend on
1663 configuration settings (see <a href="#Configuration">Configuration</a>). A status message sent from
1664 <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
1665 the client.
1666 </p>
1667 <table>
1668 <thead><tr><th width="20%">Message</th><th width="25%">Parameters</th><th width="55%">Description</th></tr></thead>
1669 <tr><td width="20%">CACHE
1670 <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
1671 (see <a href="#GETINFO">GETINFO</a>) and after every cache modification.</td></tr>
1672 <tr><td width="20%">CLIENTS
1673 <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
1674 when another client either connects or disconnects.</td></tr>
1675 <tr><td width="20%">DECRYPT
1676 <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
1677 status message is sent is determined by the <code>cipher_progress</code>
1678 (see <a href="#Configuration">Configuration</a>) setting.</td></tr>
1679 <tr><td width="20%">ENCRYPT
1680 <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
1681 status message is sent is determined by the <code>cipher_progress</code>
1682 (see <a href="#Configuration">Configuration</a>) setting.</td></tr>
1683 <tr><td width="20%">GENKEY
1684 <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>
1685 <tr><td width="20%">INQUIRE_MAXLEN
1686 <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
1687 specifies the maximum number of bytes allowed for the client to send and
1688 should not be exceeded.</td></tr>
1689 <tr><td width="20%">KEEPALIVE
1690 <a name="index-KEEPALIVE"></a></td><td width="25%"></td><td width="55%">Sent to each idle client every <var>keepalive_interval</var>
1691 (see <a href="#Configuration">Configuration</a>) seconds.</td></tr>
1692 <tr><td width="20%">LOCKED
1693 <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
1694 the mutex associated with a file.</td></tr>
1695 <tr><td width="20%">NEWFILE
1696 <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
1697 exist on the file-system.</td></tr>
1698 <tr><td width="20%">XFER
1699 <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
1700 delimited arguments. The first being the current amount of bytes transferred
1701 and the other being the total bytes to be transferred.</td></tr>
1702 <tr><td width="20%">STATE
1703 <a name="index-STATE"></a></td><td width="25%"><code>&lt;client_id&gt; &lt;state&gt;</code></td><td width="55%">Sent to all connected clients to indicate that <var>client_id</var> has
1704 changed to <var>state</var> (see <a href="#GETINFO">GETINFO</a> to describe the available client
1705 states).</td></tr>
1706 </table>
1707
1708 <hr>
1709 <a name="Target-Attribute"></a>
1710 <div class="header">
1711 <p>
1712 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>
1713 </div>
1714 <a name="The-target-attribute"></a>
1715 <h2 class="chapter">40 The <code>target</code> attribute</h2>
1716 <a name="index-target-attribute"></a>
1717 <p>A <em>case sensitive</em> attribute named <code>target</code> is treated specially
1718 when found in each element of an element path. This attribute, like other
1719 element attributes, is created or modified with the <code>ATTR</code> command
1720 (see <a href="#ATTR">ATTR</a>). The value of this attribute is an existing element path
1721 somewhere in the document.  If you are familiar with <abbr>XML</abbr> entities or
1722 maybe the <abbr>HTML</abbr> <code>id</code> or <code>target</code> attributes or a symbolic link
1723 in a file-system, you may find this attribute behaves similar to any of those.
1724 </p>
1725 <p>To create a <code>target</code> attribute use the following syntax:
1726 </p>
1727 <div class="example">
1728 <pre class="example">ATTR SET target [!]element[<span class="key">TAB</span>[!]child[..]] [!]element[<span class="key">TAB</span>[!]child[..]]
1729 </pre></div>
1730
1731 <p>Note the single space between the two element paths. The first element path is
1732 where the <code>target</code> attribute will be created. If the element path does
1733 not exist then it will be created.  This is the only time the <code>ATTR</code>
1734 (see <a href="#ATTR">ATTR</a>) command will create elements. The attribute is created in the
1735 final element of the first element path.
1736 </p>
1737 <p>The second element path is the destination of where you want the first element
1738 path to resolve to. When an element path is passed as an argument to a
1739 protocol command <code>pwmd</code> looks for a <code>target</code> attribute when
1740 resolving each element and, if found, &quot;jumps&quot; to the attribute value and
1741 continues resolving any remaining elements.  When you want to avoid the
1742 <code>target</code> attribute for any element of an element path then prefix the
1743 element with the literal element character &lsquo;<samp>!</samp>&rsquo;.
1744 </p>
1745 <p>When an element of a element path is removed that a <code>target</code> attribute
1746 resolves to then an error will occur when trying to access that element. You
1747 may need to either update the <code>target</code> attribute value with a new element
1748 path or remove the attribute entirely. Remember that since the element
1749 contains the <code>target</code> attribute it will need to be prefixed with the
1750 literal element character &lsquo;<samp>!</samp>&rsquo; when specifying the element path to prevent
1751 <code>pwmd</code> from trying to resolve the <code>target</code> attribute. For
1752 example, to remove a <code>target</code> attribute for an element containing it:
1753 </p>
1754 <div class="example">
1755 <pre class="example">ATTR DELETE target path<span class="key">TAB</span>to<span class="key">TAB</span>!element
1756 </pre></div>
1757
1758 <p>Clients should be careful of creating <code>target</code> loops, or targets that
1759 resolve to themselves. See the <var>recursion_depth</var> (see <a href="#Configuration">Configuration</a>)
1760 configuration parameter for details.
1761 </p>
1762 <p>The <code>REALPATH</code> command (see <a href="#REALPATH">REALPATH</a>) can be used to show the element
1763 path after resolving all <code>target</code> attributes.
1764 </p>
1765
1766 <hr>
1767 <a name="Signals"></a>
1768 <div class="header">
1769 <p>
1770 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>
1771 </div>
1772 <a name="Recognized-signals"></a>
1773 <h2 class="chapter">41 Recognized signals</h2>
1774
1775 <p>Sending the <em>SIGHUP</em> signal to a <code>pwmd</code> process will reload the
1776 configuration file and sending <em>SIGUSR1</em> will clear the entire file
1777 cache.
1778 </p>
1779
1780
1781 <hr>
1782 <a name="Concept-Index"></a>
1783 <div class="header">
1784 <p>
1785 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>
1786 </div>
1787 <a name="Concept-Index-1"></a>
1788 <h2 class="unnumbered">Concept Index</h2>
1789
1790
1791 <a name="SEC_Overview"></a>
1792 <h2 class="shortcontents-heading">Short Table of Contents</h2>
1793
1794 <div class="shortcontents">
1795 <ul class="no-bullet">
1796 <li><a name="stoc-Overview-of-pwmd" href="#toc-Overview-of-pwmd">1 Overview of <code>pwmd</code></a></li>
1797 <li><a name="stoc-Access-Control-1" href="#toc-Access-Control-1">2 Access Control</a></li>
1798 <li><a name="stoc-Invoking-pwmd" href="#toc-Invoking-pwmd">3 Invoking <code>pwmd</code></a></li>
1799 <li><a name="stoc-pwmd-configuration-file-options" href="#toc-pwmd-configuration-file-options">4 <code>pwmd</code> configuration file options</a></li>
1800 <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>
1801 <li><a name="stoc-Pinentry-configuration" href="#toc-Pinentry-configuration">6 Pinentry configuration</a></li>
1802 <li><a name="stoc-Protocol-commands-and-their-syntax" href="#toc-Protocol-commands-and-their-syntax">7 Protocol commands and their syntax</a></li>
1803 <li><a name="stoc-AGENT-command" href="#toc-AGENT-command">8 AGENT command</a></li>
1804 <li><a name="stoc-ATTR-command" href="#toc-ATTR-command">9 ATTR command</a></li>
1805 <li><a name="stoc-CACHETIMEOUT-command" href="#toc-CACHETIMEOUT-command">10 CACHETIMEOUT command</a></li>
1806 <li><a name="stoc-CLEARCACHE-command" href="#toc-CLEARCACHE-command">11 CLEARCACHE command</a></li>
1807 <li><a name="stoc-COPY-command" href="#toc-COPY-command">12 COPY command</a></li>
1808 <li><a name="stoc-DELETE-command" href="#toc-DELETE-command">13 DELETE command</a></li>
1809 <li><a name="stoc-DUMP-command" href="#toc-DUMP-command">14 DUMP command</a></li>
1810 <li><a name="stoc-GET-command" href="#toc-GET-command">15 GET command</a></li>
1811 <li><a name="stoc-GETCONFIG-command" href="#toc-GETCONFIG-command">16 GETCONFIG command</a></li>
1812 <li><a name="stoc-GETINFO-command" href="#toc-GETINFO-command">17 GETINFO command</a></li>
1813 <li><a name="stoc-HELP-command" href="#toc-HELP-command">18 HELP command</a></li>
1814 <li><a name="stoc-IMPORT-command" href="#toc-IMPORT-command">19 IMPORT command</a></li>
1815 <li><a name="stoc-ISCACHED-command" href="#toc-ISCACHED-command">20 ISCACHED command</a></li>
1816 <li><a name="stoc-KEYGRIP-command" href="#toc-KEYGRIP-command">21 KEYGRIP command</a></li>
1817 <li><a name="stoc-KILL-command" href="#toc-KILL-command">22 KILL command</a></li>
1818 <li><a name="stoc-LIST-command" href="#toc-LIST-command">23 LIST command</a></li>
1819 <li><a name="stoc-LOCK-command" href="#toc-LOCK-command">24 LOCK command</a></li>
1820 <li><a name="stoc-LS-command" href="#toc-LS-command">25 LS command</a></li>
1821 <li><a name="stoc-MOVE-command" href="#toc-MOVE-command">26 MOVE command</a></li>
1822 <li><a name="stoc-NOP-command" href="#toc-NOP-command">27 NOP command</a></li>
1823 <li><a name="stoc-OPEN-command" href="#toc-OPEN-command">28 OPEN command</a></li>
1824 <li><a name="stoc-OPTION-command" href="#toc-OPTION-command">29 OPTION command</a></li>
1825 <li><a name="stoc-PASSWD-command" href="#toc-PASSWD-command">30 PASSWD command</a></li>
1826 <li><a name="stoc-REALPATH-command" href="#toc-REALPATH-command">31 REALPATH command</a></li>
1827 <li><a name="stoc-RENAME-command" href="#toc-RENAME-command">32 RENAME command</a></li>
1828 <li><a name="stoc-RESET-command" href="#toc-RESET-command">33 RESET command</a></li>
1829 <li><a name="stoc-SAVE-command" href="#toc-SAVE-command">34 SAVE command</a></li>
1830 <li><a name="stoc-STORE-command" href="#toc-STORE-command">35 STORE command</a></li>
1831 <li><a name="stoc-UNLOCK-command" href="#toc-UNLOCK-command">36 UNLOCK command</a></li>
1832 <li><a name="stoc-XPATH-command" href="#toc-XPATH-command">37 XPATH command</a></li>
1833 <li><a name="stoc-XPATHATTR-command" href="#toc-XPATHATTR-command">38 XPATHATTR command</a></li>
1834 <li><a name="stoc-Status-messages-and-their-meanings" href="#toc-Status-messages-and-their-meanings">39 Status messages and their meanings</a></li>
1835 <li><a name="stoc-The-target-attribute" href="#toc-The-target-attribute">40 The <code>target</code> attribute</a></li>
1836 <li><a name="stoc-Recognized-signals" href="#toc-Recognized-signals">41 Recognized signals</a></li>
1837 <li><a name="stoc-Concept-Index-1" href="#toc-Concept-Index-1">Concept Index</a></li>
1838
1839 </ul>
1840 </div>
1841
1842 <a name="SEC_Contents"></a>
1843 <h2 class="contents-heading">Table of Contents</h2>
1844
1845 <div class="contents">
1846 <ul class="no-bullet">
1847 <li><a name="toc-Overview-of-pwmd" href="#Introduction">1 Overview of <code>pwmd</code></a></li>
1848 <li><a name="toc-Access-Control-1" href="#Access-Control">2 Access Control</a></li>
1849 <li><a name="toc-Invoking-pwmd" href="#Invoking">3 Invoking <code>pwmd</code></a></li>
1850 <li><a name="toc-pwmd-configuration-file-options" href="#Configuration">4 <code>pwmd</code> configuration file options</a></li>
1851 <li><a name="toc-Configuring-remote-connections-over-TLS_002e" href="#TLS">5 Configuring remote connections over TLS.</a></li>
1852 <li><a name="toc-Pinentry-configuration" href="#Pinentry">6 Pinentry configuration</a></li>
1853 <li><a name="toc-Protocol-commands-and-their-syntax" href="#Commands">7 Protocol commands and their syntax</a></li>
1854 <li><a name="toc-AGENT-command" href="#AGENT">8 AGENT command</a></li>
1855 <li><a name="toc-ATTR-command" href="#ATTR">9 ATTR command</a></li>
1856 <li><a name="toc-CACHETIMEOUT-command" href="#CACHETIMEOUT">10 CACHETIMEOUT command</a></li>
1857 <li><a name="toc-CLEARCACHE-command" href="#CLEARCACHE">11 CLEARCACHE command</a></li>
1858 <li><a name="toc-COPY-command" href="#COPY">12 COPY command</a></li>
1859 <li><a name="toc-DELETE-command" href="#DELETE">13 DELETE command</a></li>
1860 <li><a name="toc-DUMP-command" href="#DUMP">14 DUMP command</a></li>
1861 <li><a name="toc-GET-command" href="#GET">15 GET command</a></li>
1862 <li><a name="toc-GETCONFIG-command" href="#GETCONFIG">16 GETCONFIG command</a></li>
1863 <li><a name="toc-GETINFO-command" href="#GETINFO">17 GETINFO command</a></li>
1864 <li><a name="toc-HELP-command" href="#HELP">18 HELP command</a></li>
1865 <li><a name="toc-IMPORT-command" href="#IMPORT">19 IMPORT command</a></li>
1866 <li><a name="toc-ISCACHED-command" href="#ISCACHED">20 ISCACHED command</a></li>
1867 <li><a name="toc-KEYGRIP-command" href="#KEYGRIP">21 KEYGRIP command</a></li>
1868 <li><a name="toc-KILL-command" href="#KILL">22 KILL command</a></li>
1869 <li><a name="toc-LIST-command" href="#LIST">23 LIST command</a></li>
1870 <li><a name="toc-LOCK-command" href="#LOCK">24 LOCK command</a></li>
1871 <li><a name="toc-LS-command" href="#LS">25 LS command</a></li>
1872 <li><a name="toc-MOVE-command" href="#MOVE">26 MOVE command</a></li>
1873 <li><a name="toc-NOP-command" href="#NOP">27 NOP command</a></li>
1874 <li><a name="toc-OPEN-command" href="#OPEN">28 OPEN command</a></li>
1875 <li><a name="toc-OPTION-command" href="#OPTION">29 OPTION command</a></li>
1876 <li><a name="toc-PASSWD-command" href="#PASSWD">30 PASSWD command</a></li>
1877 <li><a name="toc-REALPATH-command" href="#REALPATH">31 REALPATH command</a></li>
1878 <li><a name="toc-RENAME-command" href="#RENAME">32 RENAME command</a></li>
1879 <li><a name="toc-RESET-command" href="#RESET">33 RESET command</a></li>
1880 <li><a name="toc-SAVE-command" href="#SAVE">34 SAVE command</a></li>
1881 <li><a name="toc-STORE-command" href="#STORE">35 STORE command</a></li>
1882 <li><a name="toc-UNLOCK-command" href="#UNLOCK">36 UNLOCK command</a></li>
1883 <li><a name="toc-XPATH-command" href="#XPATH">37 XPATH command</a></li>
1884 <li><a name="toc-XPATHATTR-command" href="#XPATHATTR">38 XPATHATTR command</a></li>
1885 <li><a name="toc-Status-messages-and-their-meanings" href="#Status-Messages">39 Status messages and their meanings</a></li>
1886 <li><a name="toc-The-target-attribute" href="#Target-Attribute">40 The <code>target</code> attribute</a></li>
1887 <li><a name="toc-Recognized-signals" href="#Signals">41 Recognized signals</a></li>
1888 <li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li>
1889
1890 </ul>
1891 </div>
1892
1893 <hr>
1894
1895
1896
1897 </body>
1898 </html>