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