(Helper Tools): Document gpgsm-gencert.sh.
[gnupg.git] / doc / tools.texi
1 @c Copyright (C) 2004 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file GnuPG.texi.
4
5 @node Helper Tools
6 @chapter Helper Tools
7
8 GnuPG comes with a couple of smaller tools:
9
10 @menu
11 * watchgnupg::            Read logs from a socket.
12 * addgnupghome::          Create .gnupg home directories.
13 * gpgconf::               Modify .gnupg home directories.
14 * gpgsm-gencert.sh::      Generate an X.509 certificate request.
15 @end menu
16
17 @c
18 @c  WATHCGNUPG
19 @c
20 @node watchgnupg
21 @section Read logs from a socket
22
23 Most of the main utilities are able to write there log files to a
24 Unix Domain socket if configured that way.  @command{watchgnupg} is a simple
25 listener for such a socket.  It ameliorates the output with a time
26 stamp and makes sure that long lines are not interspersed with log
27 output from other utilities.
28
29 @noindent
30 @command{watchgnupg} is commonly invoked as
31
32 @samp{watchgnupg --force ~/.gnupg/S.log}
33
34 @noindent
35 This starts it on the current terminal for listening on the socket
36 @file{~/.gnupg/S.log}.  
37
38 @noindent
39 @command{watchgnupg} understands these options:
40
41 @table @gnupgtabopt
42
43 @item --force 
44 @opindex force
45 Delete an already existing socket file.
46
47 @item --verbose
48 @opindex verbose
49 Enable extra informational output.
50
51 @item --version
52 @opindex version
53 print version of the program and exit
54
55 @item --help
56 @opindex help
57 Display a brief help page and exit
58
59 @end table
60
61
62 @c
63 @c    ADDGNUPGHOME
64 @c
65 @node addgnupghome
66 @section Create .gnupg home directories.
67
68 If GnuPG is installed on a system with existing user accounts, it is
69 sometimes required to populate the GnuPG home directory with existing
70 files.  Especially a @file{trustlist.txt} and a keybox with some
71 initial certificates are often desired.  This scripts help to do this
72 by copying all files from @file{/etc/skel/.gnupg} to the home
73 directories of the accounts given on the command line.  It takes care
74 not to overwrite existing GnuPG home directories.
75
76 @noindent
77 @command{addgnupghome} is invoked by root as:
78
79 @samp{addgnupghome account1 account2 ... accountn}
80
81
82 @c
83 @c   GPGCONF
84 @c
85 @node gpgconf
86 @section Modify .gnupg home directories.
87
88 The @command{gpgconf} is a utility to automatically and reasonable
89 safely query and modify configuration files in the @file{.gnupg} home
90 directory.  It is designed not to be invoked manually by the user, but
91 automatically by graphical user interfaces (GUI).@footnote{Please note
92 that currently no locking is done, so concurrent access should be
93 avoided.  There are some precautions to avoid corruption with
94 concurrent usage, but results may be inconsistent and some changes may
95 get lost.  The stateless design makes it difficult to provide more
96 guarantees.}
97
98 @command{gpgconf} provides access to the configuration of one or more
99 components of the GnuPG system.  These components correspond more or
100 less to the programs that exist in the GnuPG framework, like GnuPG,
101 GPGSM, DirMngr, etc.  But this is not a strict one-to-one
102 relationship.  Not all configuration options are available through
103 @command{gpgconf}.  @command{gpgconf} provides a generic and abstract
104 method to access the most important configuration options that can
105 feasibly be controlled via such a mechanism.
106
107 @command{gpgconf} can be used to gather and change the options
108 available in each component, and can also provide their default
109 values.  @command{gpgconf} will give detailed type information that
110 can be used to restrict the user's input without making an attempt to
111 commit the changes.
112
113 @command{gpgconf} provides the backend of a configuration editor.  The
114 configuration editor would usually be a graphical user interface
115 program, that allows to display the current options, their default
116 values, and allows the user to make changes to the options.  These
117 changes can then be made active with @command{gpgconf} again.  Such a
118 program that uses @command{gpgconf} in this way will be called GUI
119 throughout this section.
120
121 @menu
122 * Invoking gpgconf::      List of all commands and options.
123 * Format conventions::    Formatting conventions relevant for all commands.
124 * Listing components::    List all gpgconf components.
125 * Listing options::       List all options of a component.
126 * Changing options::      Changing options of a component.
127 @end menu
128
129
130 @node Invoking gpgconf
131 @subsection Invoking gpgconf
132
133 One of the following commands must be given:
134
135 @table @gnupgtabopt
136 @item --list-components
137 List all components.  This is the default command used if none is
138 specified.
139
140 @item --list-options @var{component}
141 List all options of the component @var{component}.
142
143 @item --change-options @var{component}
144 Change the options of the component @var{component}.
145 @end table
146
147 The following options may be used:
148
149 @table @gnupgtabopt
150 @c FIXME: Not yet supported.
151 @c @item -o @var{file}
152 @c @itemx --output @var{file}
153 @c Use @var{file} as output file.
154
155 @item -v
156 @itemx --verbose
157 Outputs additional information while running.  Specifically, this
158 extends numerical field values by human-readable descriptions.
159
160 @c FIXME: Not yet supported.
161 @c @item -n
162 @c @itemx --dry-run
163 @c Do not actually change anything.  Useful together with
164 @c @code{--change-options} for testing purposes.
165
166 @item -r
167 @itemx --runtime
168 Only used together with @code{--change-options}.  If one of the
169 modified options can be changed in a running daemon process, signal
170 the running daemon to ask it to reparse its configuration file after
171 changing.
172
173 This means that the changes will take effect at run-time, as far as
174 this is possible.  Otherwise, they will take effect at the next start
175 of the respective backend programs.
176 @end table
177
178
179 @node Format conventions
180 @subsection Format conventions
181
182 Some lines in the output of @command{gpgconf} contain a list of
183 colon-separated fields.  The following conventions apply:
184
185 @itemize @bullet
186 @item
187 The GUI program is required to strip off trailing newline and/or
188 carriage return characters from the output.
189
190 @item
191 @command{gpgconf} will never leave out fields.  If a certain version
192 provides a certain field, this field will always be present in all
193 @command{gpgconf} versions from that time on.
194
195 @item
196 Future versions of @command{gpgconf} might append fields to the list.
197 New fields will always be separated from the previously last field by
198 a colon separator.  The GUI should be prepared to parse the last field
199 it knows about up until a colon or end of line.
200
201 @item
202 Not all fields are defined under all conditions.  You are required to
203 ignore the content of undefined fields.
204 @end itemize
205
206 There are several standard types for the content of a field:
207
208 @table @asis
209 @item verbatim
210 Some fields contain strings that are not escaped in any way.  Such
211 fields are described to be used @emph{verbatim}.  These fields will
212 never contain a colon character (for obvious reasons).  No de-escaping
213 or other formatting is required to use the field content.  This is for
214 easy parsing of the output, when it is known that the content can
215 never contain any special characters.
216
217 @item percent-escaped
218 Some fields contain strings that are described to be
219 @emph{percent-escaped}.  Such strings need to be de-escaped before
220 their content can be presented to the user.  A percent-escaped string
221 is de-escaped by replacing all occurences of @code{%XY} by the byte
222 that has the hexadecimal value @code{XY}.  @code{X} and @code{Y} are
223 from the set @code{0-9a-f}.
224
225 @item localised
226 Some fields contain strings that are described to be @emph{localised}.
227 Such strings are translated to the active language and formatted in
228 the active character set.
229
230 @item @w{unsigned number}
231 Some fields contain an @emph{unsigned number}.  This number will
232 always fit into a 32-bit unsigned integer variable.  The number may be
233 followed by a space, followed by a human readable description of that
234 value (if the verbose option is used).  You should ignore everything
235 in the field that follows the number.
236
237 @item @w{signed number}
238 Some fields contain a @emph{signed number}.  This number will always
239 fit into a 32-bit signed integer variable.  The number may be followed
240 by a space, followed by a human readable description of that value (if
241 the verbose option is used).  You should ignore everything in the
242 field that follows the number.
243
244 @item option
245 Some fields contain an @emph{option} argument.  The format of an
246 option argument depends on the type of the option and on some flags:
247
248 @table @asis
249 @item no argument
250 The simplest case is that the option does not take an argument at all
251 (@var{type} @code{0}).  Then the option argument is an unsigned number
252 that specifies how often the option occurs.  If the @code{list} flag
253 is not set, then the only valid number is @code{1}.  Options that do
254 not take an argument never have the @code{default} or @code{optional
255 arg} flag set.
256
257 @item number
258 If the option takes a number argument (@var{alt-type} is @code{2} or
259 @code{3}), and it can only occur once (@code{list} flag is not set),
260 then the option argument is either empty (only allowed if the argument
261 is optional), or it is a number.  A number is a string that begins
262 with an optional minus character, followed by one or more digits.  The
263 number must fit into an integer variable (unsigned or signed,
264 depending on @var{alt-type}).
265
266 @item number list
267 If the option takes a number argument and it can occur more than once,
268 then the option argument is either empty, or it is a comma-separated
269 list of numbers as described above.
270
271 @item string
272 If the option takes a string argument (@var{alt-type} is 1), and it
273 can only occur once (@code{list} flag is not set) then the option
274 argument is either empty (only allowed if the argument is optional),
275 or it starts with a double quote character (@code{"}) followed by a
276 percent-escaped string that is the argument value.  Note that there is
277 only a leading double quote character, no trailing one.  The double
278 quote character is only needed to be able to differentiate between no
279 value and the empty string as value.
280
281 @item string list
282 If the option takes a number argument and it can occur more than once,
283 then the option argument is either empty, or it is a comma-separated
284 list of string arguments as described above.
285 @end table
286 @end table
287
288 The active language and character set are currently determined from
289 the locale environment of the @command{gpgconf} program.
290
291 @c FIXME: Document the active language and active character set.  Allow
292 @c to change it via the command line?
293
294
295 @node Listing components
296 @subsection Listing components
297
298 The command @code{--list-components} will list all components that can
299 be configured with @command{gpgconf}.  Usually, one component will
300 correspond to one GnuPG-related program and contain the options of
301 that programs configuration file that can be modified using
302 @command{gpgconf}.  However, this is not necessarily the case.  A
303 component might also be a group of selected options from several
304 programs, or contain entirely virtual options that have a special
305 effect rather than changing exactly one option in one configuration
306 file.
307
308 A component is a set of configuration options that semantically belong
309 together.  Furthermore, several changes to a component can be made in
310 an atomic way with a single operation.  The GUI could for example
311 provide a menu with one entry for each component, or a window with one
312 tabulator sheet per component.
313
314 The command argument @code{--list-components} lists all available
315 components, one per line.  The format of each line is:
316
317 @code{@var{name}:@var{description}}
318
319 @table @var
320 @item name
321 This field contains a name tag of the component.  The name tag is used
322 to specify the component in all communication with @command{gpgconf}.
323 The name tag is to be used @emph{verbatim}.  It is thus not in any
324 escaped format.
325
326 @item description
327 The @emph{string} in this field contains a human-readable description
328 of the component.  It can be displayed to the user of the GUI for
329 informational purposes.  It is @emph{percent-escaped} and
330 @emph{localized}.
331 @end table
332
333 Example:
334 @example
335 $ gpgconf --list-components
336 gpg:GPG for OpenPGP
337 gpg-agent:GPG Agent
338 scdaemon:Smartcard Daemon
339 gpgsm:GPG for S/MIME
340 dirmngr:Directory Manager
341 @end example
342
343
344 @node Listing options
345 @subsection Listing options
346
347 Every component contains one or more options.  Options may be gathered
348 into option groups to allow the GUI to give visual hints to the user
349 about which options are related.
350
351 The command argument @code{@w{--list-options @var{component}}} lists
352 all options (and the groups they belong to) in the component
353 @var{component}, one per line.  @var{component} must be the string in
354 the field @var{name} in the output of the @code{--list-components}
355 command.
356
357 There is one line for each option and each group.  First come all
358 options that are not in any group.  Then comes a line describing a
359 group.  Then come all options that belong into each group.  Then comes
360 the next group and so on.  There does not need to be any group (and in
361 this case the output will stop after the last non-grouped option).
362
363 The format of each line is:
364
365 @code{@var{name}:@var{flags}:@var{level}:@var{description}:@var{type}:@var{alt-type}:@var{argname}:@var{default}:@var{argdef}:@var{value}}
366
367 @table @var
368 @item name
369 This field contains a name tag for the group or option.  The name tag
370 is used to specify the group or option in all communication with
371 @command{gpgconf}.  The name tag is to be used @emph{verbatim}.  It is
372 thus not in any escaped format.
373
374 @item flags
375 The flags field contains an @emph{unsigned number}.  Its value is the
376 OR-wise combination of the following flag values:
377
378 @table @code
379 @item group (1)
380 If this flag is set, this is a line describing a group and not an
381 option.
382 @end table
383
384 The following flag values are only defined for options (that is, if
385 the @code{group} flag is not used).
386
387 @table @code
388 @item optional arg (2)
389 If this flag is set, the argument is optional.  This is never set for
390 @var{type} @code{0} (none) options.
391
392 @item list (4)
393 If this flag is set, the option can be given multiple times.
394
395 @item runtime (8)
396 If this flag is set, the option can be changed at runtime.
397
398 @item default (16)
399 If this flag is set, a default value is available.
400
401 @item default desc (32)
402 If this flag is set, a (runtime) default is available.  This and the
403 @code{default} flag are mutually exclusive.
404
405 @item no arg desc (64)
406 If this flag is set, and the @code{optional arg} flag is set, then the
407 option has a special meaning if no argument is given.
408 @end table
409
410 @item level
411 This field is defined for options and for groups.  It contains an
412 @emph{unsigned number} that specifies the expert level under which
413 this group or option should be displayed.  The following expert levels
414 are defined for options (they have analogous meaning for groups):
415
416 @table @code
417 @item basic (0)
418 This option should always be offered to the user.
419
420 @item advanced (1)
421 This option may be offered to advanced users.
422
423 @item expert (2)
424 This option should only be offered to expert users.
425
426 @item invisible (3)
427 This option should normally never be displayed, not even to expert
428 users.
429
430 @item internal (4)
431 This option is for internal use only.  Ignore it.
432 @end table
433
434 The level of a group will always be the lowest level of all options it
435 contains.
436
437 @item description
438 This field is defined for options and groups.  The @emph{string} in
439 this field contains a human-readable description of the option or
440 group.  It can be displayed to the user of the GUI for informational
441 purposes.  It is @emph{percent-escaped} and @emph{localized}.
442
443 @item type
444 This field is only defined for options.  It contains an @emph{unsigned
445 number} that specifies the type of the option's argument, if any.  The
446 following types are defined:
447
448 Basic types:
449
450 @table @code
451 @item none (0)
452 No argument allowed.
453
454 @item string (1)
455 An @emph{unformatted string}.
456
457 @item int32 (2)
458 A @emph{signed number}.
459
460 @item uint32 (3)
461 An @emph{unsigned number}.
462 @end table
463
464 Complex types:
465
466 @table @code
467 @item pathname (32)
468 A @emph{string} that describes the pathname of a file.  The file does
469 not necessarily need to exist.
470
471 @item ldap server (33)
472 A @emph{string} that describes an LDAP server in the format:
473
474 @code{@var{hostname}:@var{port}:@var{username}:@var{password}:@var{base_dn}}
475 @end table
476
477 More types will be added in the future.  Please see the @var{alt-type}
478 field for information on how to cope with unknown types.
479
480 @item alt-type
481 This field is identical to @var{type}, except that only the types
482 @code{0} to @code{31} are allowed.  The GUI is expected to present the
483 user the option in the format specified by @var{type}.  But if the
484 argument type @var{type} is not supported by the GUI, it can still
485 display the option in the more generic basic type @var{alt-type}.  The
486 GUI must support all the defined basic types to be able to display all
487 options.  More basic types may be added in future versions.  If the
488 GUI encounters a basic type it doesn't support, it should report an
489 error and abort the operation.
490
491 @item argname
492 This field is only defined for options with an argument type
493 @var{type} that is not @code{0}.  In this case it may contain a
494 @emph{percent-escaped} and @emph{localised string} that gives a short
495 name for the argument.  The field may also be empty, though, in which
496 case a short name is not known.
497
498 @item default
499 This field is defined only for options.  Its format is that of an
500 @emph{option argument} (@xref{Format conventions}, for details).  If
501 the default value is empty, then no default is known.  Otherwise, the
502 value specifies the default value for this option.  Note that this
503 field is also meaningful if the option itself does not take a real
504 argument.
505
506 @item argdef
507 This field is defined only for options for which the @code{optional
508 arg} flag is set.  If the @code{no arg desc} flag is not set, its
509 format is that of an @emph{option argument} (@xref{Format
510 conventions}, for details).  If the default value is empty, then no
511 default is known.  Otherwise, the value specifies the default value
512 for this option.  If the @code{no arg desc} flag is set, the field is
513 either empty or contains a description of the effect of this option if
514 no argument is given.  Note that this field is also meaningful if the
515 option itself does not take a real argument.
516
517 @item value
518 This field is defined only for options.  Its format is that of an
519 @emph{option argument}.  If it is empty, then the option is not
520 explicitely set in the current configuration, and the default applies
521 (if any).  Otherwise, it contains the current value of the option.
522 Note that this field is also meaningful if the option itself does not
523 take a real argument.
524 @end table
525
526
527 @node Changing options
528 @subsection Changing options
529
530 The command @w{@code{--change-options @var{component}}} will attempt
531 to change the options of the component @var{component} to the
532 specified values.  @var{component} must be the string in the field
533 @var{name} in the output of the @code{--list-components} command.  You
534 have to provide the options that shall be changed in the following
535 format on standard input:
536
537 @code{@var{name}:@var{flags}:@var{new-value}}
538
539 @table @var
540 @item name
541 This is the name of the option to change.  @var{name} must be the
542 string in the field @var{name} in the output of the
543 @code{--list-options} command.
544
545 @item flags
546 The flags field contains an @emph{unsigned number}.  Its value is the
547 OR-wise combination of the following flag values:
548
549 @table @code
550 @item default (16)
551 If this flag is set, the option is deleted and the default value is
552 used instead (if applicable).
553 @end table
554
555 @item new-value
556 The new value for the option.  This field is only defined if the
557 @code{default} flag is not set.  The format is that of an @emph{option
558 argument}.  If it is empty (or the field is omitted), the default
559 argument is used (only allowed if the argument is optional for this
560 option).  Otherwise, the option will be set to the specified value.
561 @end table
562
563 Examples:
564
565 To set the force option, which is of basic type @code{none (0)}:
566
567 @example
568 $ echo 'force:0:1' | gpgconf --change-options dirmngr
569 @end example
570
571 To delete the force option:
572
573 @example
574 $ echo 'force:16:' | gpgconf --change-options dirmngr
575 @end example
576
577 The @code{--runtime} option can influence when the changes take
578 effect.
579
580 @c
581 @c    GPGSM-GENCERT.SH
582 @c
583 @node gpgsm-gencert.sh
584 @section Generate an X.509 certificate request
585
586 This is a simple tool to interactivly generate a certificate request
587 whicl will be printed to stdout.
588
589 @noindent
590 @command{gpgsm-gencert.sh} is invoked as:
591
592 @samp{gpgsm-cencert.sh}
593
594
595