2004-02-26 Marcus Brinkmann <marcus@g10code.de>
[gnupg.git] / tools / README.gpgconf
1 ============
2   GPG Conf
3 ============
4
5 CONCEPT
6 =======
7
8 gpgconf provides access to the configuration of one or more components
9 of the GnuPG system.  These components correspond more or less to the
10 programs that exist in the GnuPG framework, like GnuPG, GPGSM,
11 DirMngr, etc.  But this is not a strict one-to-one relationship.  Not
12 all configuration options are available through GPGConf.  GPGConf
13 provides a generic and abstract method to access the most important
14 configuration options that can feasibly be controlled via such a
15 mechanism.
16
17 GPGConf can be used to gather and change the options available in each
18 component, and can also provide their default values.  GPGConf will
19 give detailed type information that can be used to restrict the user's
20 input without making an attempt to commit the changes.
21
22 GPGConf provides the backend of a configuration editor.  The
23 configuration editor would usually be a graphical user interface
24 program, that allows to display the current options, their default
25 values, and allows the user to make changes to the options.  These
26 changes can then be made active with GPGConf again.  Such a program
27 that uses GPGConf in this way will be called 'GUI' throughout this
28 document.
29
30
31 Format Conventions
32 ==================
33
34 Some lines in the output of GPGConf contain a list of colon-separated
35 fields.  The following conventions apply:
36
37 The GUI program is required to strip off trailing newline and/or carriage
38 return characters from the output.
39
40 GPGConf will never leave out fields.  If a certain version documents a
41 certain field, this field will always be present in all GPGConf
42 versions from that time on.
43
44 Future versions of GPGConf might append fields to the list.  New
45 fields will always be separated from the previously last field by a
46 colon separator.  The GUI should be prepared to parse the last field
47 it knows about up until a colon or end of line.
48
49 Not all fields are defined under all conditions.  You are required to
50 ignore the content of undefined fields.
51
52 Some fields contain strings that are not escaped in any way.  Such
53 fields are described to be used "verbatim".  These fields will never
54 contain a colon character (for obvious reasons).  No de-escaping or
55 other formatting is required to use the field content.  This is for
56 easy parsing of the output, when it is known that the content can
57 never contain any special characters.
58
59 Some fields contain strings that are described to be
60 "percent-escaped".  Such strings need to be de-escaped before their
61 content can be presented to the user.  A percent-escaped string is
62 de-escaped by replacing all occurences of %XY by the byte that has the
63 hexadecimal value XY.  X and Y are from the set { '0'..'9', 'a'..'f' }.
64
65 Some fields contain strings that are described to be "localised".  Such
66 strings are translated to the active language and formatted in the
67 active character set.
68
69 Some fields contain an unsigned number.  This number will always fit
70 into a 32-bit unsigned integer variable.  The number may be followed
71 by a space, followed by a human readable description of that value.
72 You should ignore everything in the field that follows the number.
73
74 Some fields contain a signed number.  This number will always fit into
75 a 32-bit signed integer variable.  The number may be followed by a
76 space, followed by a human readable description of that value.  You
77 should ignore everything in the field that follows the number.
78
79 Some fields contain an option argument.  The format of an option
80 argument depends on the type of the option and on some flags:
81
82 The simplest case is that the option does not take an argument at all
83 (TYPE is 0).  Then the option argument is an unsigned number that
84 specifies how often the option occurs.  If the LIST flag is not set,
85 then the only valid number is 1.  Options that don't take an argument
86 never have the "default" or "optional arg" flag set.
87
88 If the option takes a number argument (ALT-TYPE is 2 or 3), and it can
89 only occur once (LIST flag is not set), then the option argument is
90 either empty (only allowed if the argument is optional), or it is a
91 number.  A number is a string that begins with an optional minus
92 character, followed by one or more digits.  The number must fit into
93 an integer variable (unsigned or signed, depending on ALT-TYPE).
94
95 If the option takes a number argument and it can occur more than once,
96 then the option argument is either empty, or it is a comma-separated
97 list of numbers as described above.
98
99 If the option takes a string argument (ALT-TYPE is 1), and it can only
100 occur once (LIST flag is not set) then the option argument is either
101 empty (only allowed if the argument is optional), or it starts with a
102 double quote character (") followed by a percent-escaped string that
103 is the argument value.  Note that there is only a leading double quote
104 character, no trailing one.  The double quote character is only needed
105 to be able to differentiate between no value and the empty string as
106 value.
107
108 If the option takes a number argument and it can occur more than once,
109 then the option argument is either empty, or it is a comma-separated
110 list of string arguments as described above.
111
112 FIXME: Document the active language and active character set.  Allow
113 to change it via the command line?
114
115
116 Components
117 ==========
118
119 A component is a set of configuration options that semantically belong
120 together.  Furthermore, several changes to a component can be made in
121 an atomic way with a single operation.  The GUI could for example
122 provide a menu with one entry for each component, or a window with one
123 tabulator sheet per component.
124
125 The following interface is provided to list the available components:
126
127 Command --list-components
128 -------------------------
129
130 Outputs a list of all components available, one per line.  The format
131 of each line is:
132
133 NAME:DESCRIPTION
134
135 NAME
136
137 This field contains a name tag of the component.  The name tag is used
138 to specify the component in all communication with GPGConf.  The name
139 tag is to be used verbatim.  It is not in any escaped format.
140
141 DESCRIPTION
142
143 The string in this field contains a human-readable description of the
144 component.  It can be displayed to the user of the GUI for
145 informational purposes.  It is percent-escaped and localized.
146
147 Example:
148 $ gpgconf --list-components
149 gpg-agent:GPG Agent
150 dirmngr:CRL Manager
151
152
153 OPTIONS
154 =======
155
156 Every component contains one or more options.  Options may belong to a
157 group.  The following command lists all options and the groups they
158 belong to:
159
160 Command --list-options COMPONENT
161 --------------------------------
162
163 Lists all options (and the groups they belong to) in the component
164 COMPONENT.  COMPONENT is the string in the field NAME in the
165 output of the --list-components command.
166
167 There is one line for each option and each group.  First come all
168 options that are not in any group.  Then comes a line describing a
169 group.  Then come all options that belong into each group.  Then comes
170 the next group and so on.
171
172 The format of each line is:
173
174 NAME:FLAGS:LEVEL:DESCRIPTION:TYPE:ALT-TYPE:ARGNAME:DEFAULT:ARGDEF:VALUE
175
176 NAME
177
178 This field contains a name tag for the group or option.  The name tag
179 is used to specify the group or option in all communication with
180 GPGConf.  The name tag is to be used verbatim.  It is not in any
181 escaped format.
182
183 FLAGS
184
185 The flags field contains an unsigned number.  Its value is the
186 OR-wise combination of the following flag values:
187
188          1 group        If this flag is set, this is a line describing
189                         a group and not an option.
190   O      2 optional arg If this flag is set, the argument is optional.
191                         This is never set for arg type 0 (none) options.
192   O      4 list         If this flag is set, the option can be given
193                         multiple times.
194   O      8 runtime      If this flag is set, the option can be changed
195                         at runtime.
196   O     16 default      If this flag is set, a default value is available.
197   O     32 default desc If this flag is set, a (runtime) default is available.
198                         This and the 'default' flag are mutually exclusive.
199   O     64 no arg desc  If this flag is set, and the 'optional arg' flag
200                         is set, then the option has a special meaning if no
201                         argument is given.
202
203 Flags marked with a 'O' are only defined for options (ie, if the GROUP
204 flag is not set).
205
206 LEVEL
207
208 This field is defined for options and for groups.  It contains an
209 unsigned number that specifies the expert level under which this group
210 or option should be displayed.  The following expert levels are
211 defined for options (they have analogous meaning for groups):
212
213         0 basic         This option should always be offered to the user.
214         1 advanced      This option may be offered to advanced users.
215         2 expert        This option should only be offered to expert users.
216         3 invisible     This option should normally never be displayed,
217                         not even to expert users.
218         4 internal      This option is for internal use only.  Ignore it.
219
220 The level of a group will always be the lowest level of all options it
221 contains.
222
223 DESCRIPTION
224
225 This field is defined for options and groups.  The string in this
226 field contains a human-readable description of the option or group.
227 It can be displayed to the user of the GUI for informational purposes.
228 It is percent-escaped and localized.
229
230 TYPE
231
232 This field is only defined for options.  It contains an unsigned
233 number that specifies the type of the option's argument, if any.
234 The following types are defined:
235
236         Basic types
237          0 none         No argument allowed.
238          1 string       An unformatted string.
239          2 int32        A signed integer number.
240          3 uint32       An unsigned integer number.
241
242         Complex types
243         32 pathname     A string that describes the pathname of a file.
244                         The file does not necessarily need to exist.
245         33 ldap server  A string that describes an LDAP server in the format
246                         HOSTNAME:PORT:USERNAME:PASSWORD:BASE_DN.
247
248 More types will be added in the future.  Please see the ALT-TYPE field
249 for information on how to cope with unknown types.
250
251 ALT-TYPE
252
253 This field is identical to TYPE, except that only the types 0 to 31
254 are allowed.  The GUI is expected to present the user the option in
255 the format specified by TYPE.  But if the argument type TYPE is not
256 supported by the GUI, it can still display the option in the more
257 generic basic type ALT-TYPE.  The GUI must support all the defined
258 basic types to be able to display all options.  More basic types may
259 be added in future versions.  If the GUI encounters a basic type it
260 doesn't support, it should report an error and abort the operation.
261
262 ARGNAME
263
264 This field is only defined for options with an argument type TYPE that
265 is not 0.  In this case it may contain a percent-escaped and localised
266 string that gives a short name for the argument.  The field may also
267 be empty, though, in which case a short name is not known.
268
269 DEFAULT
270
271 This field is defined only for options.  Its format is that of an
272 option argument (see section Format Conventions for details).  If the
273 default value is empty, then no default is known.  Otherwise, the
274 value specifies the default value for this option.  Note that this
275 field is also meaningful if the option itself does not take a real
276 argument.
277
278 ARGDEF
279
280 This field is defined only for options for which the "optional arg"
281 flag is set.  If the "no arg desc" flag is not set, its format is that
282 of an option argument (see section Format Conventions for details).
283 If the default value is empty, then no default is known.  Otherwise,
284 the value specifies the default value for this option.  If the "no arg
285 desc" flag is set, the field is either empty or contains a description
286 of the effect of this option if no argument is given.  Note that this
287 field is also meaningful if the option itself does not take a real
288 argument.
289
290 VALUE
291
292 This field is defined only for options.  Its format is that of an
293 option argument.  If it is empty, then the option is not explicitely
294 set in the current configuration, and the default applies (if any).
295 Otherwise, it contains the current value of the option.  Note that
296 this field is also meaningful if the option itself does not take a
297 real argument.
298
299
300 CHANGING OPTIONS
301 ================
302
303 To change the options for a component, you must provide them in the
304 following format:
305
306 NAME:FLAGS:NEW-VALUE
307
308 NAME
309
310 This is the name of the option to change.
311
312 FLAGS
313
314 The flags field contains an unsigned number.  Its value is the
315 OR-wise combination of the following flag values:
316
317         16 default      If this flag is set, the option is deleted and the
318                         default value is used instead (if applicable).
319
320 NEW-VALUE
321
322 The new value for the option.  This field is only defined if the
323 "default" flag is not set.  The format is that of an option argument.
324 If it is empty (or the field is omitted), the default argument is used
325 (only allowed if the argument is optional for this option).
326 Otherwise, the option will be set to the specified value.
327
328
329 Example:
330 To set the option force, which is of basic type 0 (none).
331 $ echo 'force:0:1' | gpgconf --change-options dirmngr
332 To delete the option force:
333 $ echo 'force:16:0' | gpgconf --change-options dirmngr
334
335
336 Option --runtime
337 ----------------
338
339 If this option is set, the changes will take effect at run-time, as
340 far as this is possible.  Otherwise, they will take effect at the next
341 start of the respective backend programs.
342
343
344 BACKENDS
345 ========
346
347 Backends should support the following commands:
348
349 Command --gpgconf-list
350 ----------------------
351
352 List the location of the configuration file, and all default values of
353 all options.  The location of the configuration file must be an
354 absolute pathname.
355
356 The format of each line is:
357
358 NAME:FLAGS:DEFAULT:ARGDEF
359
360 NAME
361
362 This field contains a name tag for the group or option.  The name tag
363 is used to specify the group or option in all communication with
364 GPGConf.  The name tag is to be used verbatim.  It is not in any
365 escaped format.
366
367 FLAGS
368
369 The flags field contains an unsigned number.  Its value is the
370 OR-wise combination of the following flag values:
371
372         16 default      If this flag is set, a default value is available.
373         32 default desc If this flag is set, a (runtime) default is available.
374                         This and the "default" flag are mutually exclusive.
375         64 no arg desc  If this flag is set, and the "optional arg" flag
376                         is set, then the option has a special meaning if no
377                         argument is given.
378
379 DEFAULT
380
381 This field is defined only for options.  Its format is that of an
382 option argument (see section Format Conventions for details).  If the
383 default value is empty, then no default is known.  Otherwise, the
384 value specifies the default value for this option.  Note that this
385 field is also meaningful if the option itself does not take a real
386 argument.
387
388 ARGDEF
389
390 This field is defined only for options for which the "optional arg"
391 flag is set.  If the "no arg desc" flag is not set, its format is that
392 of an option argument (see section Format Conventions for details).
393 If the default value is empty, then no default is known.  Otherwise,
394 the value specifies the default value for this option.  If the "no arg
395 desc" flag is set, the field is either empty or contains a description
396 of the effect of this option if no argument is given.  Note that this
397 field is also meaningful if the option itself does not take a real
398 argument.
399
400
401 Example:
402 $ dirmngr --gpgconf-list
403 gpgconf-config-file:/mnt/marcus/.gnupg/dirmngr.conf
404 ldapservers-file:/mnt/marcus/.gnupg/dirmngr_ldapservers.conf
405 add-servers:0
406 max-replies:10
407
408
409 TODO
410 ----
411
412 * Extend the backend interface to include gettext domain and
413 description, if available, to avoid repeating this information in
414 gpgconf.