gpgscm: Add types for special objects.
[gnupg.git] / doc / DETAILS
1 # doc/DETAILS                                                -*- org -*-
2 #+TITLE: GnuPG Details
3 # Globally disable superscripts and subscripts:
4 #+OPTIONS: ^:{}
5 #
6
7 # Note: This file uses org-mode; it should be easy to read as plain
8 # text but be aware of some markup peculiarities: Verbatim code is
9 # enclosed in #+begin-example, #+end-example blocks or marked by a
10 # colon as the first non-white-space character, words bracketed with
11 # equal signs indicate a monospace font, and the usual /italics/,
12 # *bold*, and _underline_ conventions are recognized.
13
14 This is the DETAILS file for GnuPG which specifies some internals and
15 parts of the external API for GPG and GPGSM.
16
17 * Format of the colon listings
18   The format is a based on colon separated record, each recods starts
19   with a tag string and extends to the end of the line.  Here is an
20   example:
21 #+begin_example
22 $ gpg --with-colons --list-keys \
23       --with-fingerprint --with-fingerprint wk@gnupg.org
24 pub:f:1024:17:6C7EE1B8621CC013:899817715:1055898235::m:::scESC:
25 fpr:::::::::ECAF7590EB3443B5C7CF3ACB6C7EE1B8621CC013:
26 uid:f::::::::Werner Koch <wk@g10code.com>:
27 uid:f::::::::Werner Koch <wk@gnupg.org>:
28 sub:f:1536:16:06AD222CADF6A6E1:919537416:1036177416:::::e:
29 fpr:::::::::CF8BCC4B18DE08FCD8A1615906AD222CADF6A6E1:
30 sub:r:1536:20:5CE086B5B5A18FF4:899817788:1025961788:::::esc:
31 fpr:::::::::AB059359A3B81F410FCFF97F5CE086B5B5A18FF4:
32 #+end_example
33
34 The double =--with-fingerprint= prints the fingerprint for the subkeys
35 too.  Old versions of gpg used a slightly different format and required
36 the use of the option =--fixed-list-mode= to conform to the format
37 described here.
38
39 ** Description of the fields
40 *** Field 1 - Type of record
41
42     - pub :: Public key
43     - crt :: X.509 certificate
44     - crs :: X.509 certificate and private key available
45     - sub :: Subkey (secondary key)
46     - sec :: Secret key
47     - ssb :: Secret subkey (secondary key)
48     - uid :: User id (only field 10 is used).
49     - uat :: User attribute (same as user id except for field 10).
50     - sig :: Signature
51     - rev :: Revocation signature
52     - fpr :: Fingerprint (fingerprint is in field 10)
53     - pkd :: Public key data [*]
54     - grp :: Keygrip
55     - rvk :: Revocation key
56     - tru :: Trust database information [*]
57     - spk :: Signature subpacket [*]
58     - cfg :: Configuration data [*]
59
60     Records marked with an asterisk are described at [[*Special%20field%20formats][*Special fields]].
61
62 *** Field 2 - Validity
63
64     This is a letter describing the computed validity of a key.
65     Currently this is a single letter, but be prepared that additional
66     information may follow in some future versions. Note that GnuPG <
67     2.1 does not set this field for secret key listings.
68
69     - o :: Unknown (this key is new to the system)
70     - i :: The key is invalid (e.g. due to a missing self-signature)
71     - d :: The key has been disabled
72            (deprecated - use the 'D' in field 12 instead)
73     - r :: The key has been revoked
74     - e :: The key has expired
75     - - :: Unknown validity (i.e. no value assigned)
76     - q :: Undefined validity.  '-' and 'q' may safely be treated as
77            the same value for most purposes
78     - n :: The key is not valid
79     - m :: The key is marginal valid.
80     - f :: The key is fully valid
81     - u :: The key is ultimately valid.  This often means that the
82            secret key is available, but any key may be marked as
83            ultimately valid.
84     - w :: The key has a well known private part.
85     - s :: The key has special validity.  This means that it might be
86            self-signed and expected to be used in the STEED sytem.
87
88     If the validity information is given for a UID or UAT record, it
89     describes the validity calculated based on this user ID.  If given
90     for a key record it describes the validity taken from the best
91     rated user ID.
92
93     For X.509 certificates a 'u' is used for a trusted root
94     certificate (i.e. for the trust anchor) and an 'f' for all other
95     valid certificates.
96
97 *** Field 3 - Key length
98
99     The length of key in bits.
100
101 *** Field 4 - Public key algorithm
102
103     The values here are those from the OpenPGP specs or if they are
104     greather than 255 the algorithm ids as used by Libgcrypt.
105
106 *** Field 5 - KeyID
107
108     This is the 64 bit keyid as specified by OpenPGP and the last 64
109     bit of the SHA-1 fingerprint of an X.509 certifciate.
110
111 *** Field 6 - Creation date
112
113     The creation date of the key is given in UTC.  For UID and UAT
114     records, this is used for the self-signature date.  Note that the
115     date is usally printed in seconds since epoch, however, we are
116     migrating to an ISO 8601 format (e.g. "19660205T091500").  This is
117     currently only relevant for X.509.  A simple way to detect the new
118     format is to scan for the 'T'.  Note that old versions of gpg
119     without using the =--fixed-list-mode= option used a "yyyy-mm-tt"
120     format.
121
122 *** Field 7 - Expiration date
123
124     Key or UID/UAT expiration date or empty if it does not expire.
125
126 *** Field 8 - Certificate S/N, UID hash, trust signature info
127
128     Used for serial number in crt records.  For UID and UAT records,
129     this is a hash of the user ID contents used to represent that
130     exact user ID.  For trust signatures, this is the trust depth
131     seperated by the trust value by a space.
132
133 *** Field 9 -  Ownertrust
134
135     This is only used on primary keys.  This is a single letter, but
136     be prepared that additional information may follow in future
137     versions.  For trust signatures with a regular expression, this is
138     the regular expression value, quoted as in field 10.
139
140 *** Field 10 - User-ID
141     The value is quoted like a C string to avoid control characters
142     (the colon is quoted =\x3a=).  For a "pub" record this field is
143     not used on --fixed-list-mode.  A UAT record puts the attribute
144     subpacket count here, a space, and then the total attribute
145     subpacket size.  In gpgsm the issuer name comes here.  A FPR
146     record stores the fingerprint here.  The fingerprint of a
147     revocation key is stored here.
148 *** Field 11 - Signature class
149
150     Signature class as per RFC-4880.  This is a 2 digit hexnumber
151     followed by either the letter 'x' for an exportable signature or
152     the letter 'l' for a local-only signature.  The class byte of an
153     revocation key is also given here, 'x' and 'l' is used the same
154     way.  This field if not used for X.509.
155
156 *** Field 12 - Key capabilities
157
158     The defined capabilities are:
159
160     - e :: Encrypt
161     - s :: Sign
162     - c :: Certify
163     - a :: Authentication
164     - ? :: Unknown capability
165
166     A key may have any combination of them in any order.  In addition
167     to these letters, the primary key has uppercase versions of the
168     letters to denote the _usable_ capabilities of the entire key, and
169     a potential letter 'D' to indicate a disabled key.
170
171 *** Field 13 - Issuer certificate fingerprint or other info
172
173     Used in FPR records for S/MIME keys to store the fingerprint of
174     the issuer certificate.  This is useful to build the certificate
175     path based on certificates stored in the local key database it is
176     only filled if the issuer certificate is available. The root has
177     been reached if this is the same string as the fingerprint. The
178     advantage of using this value is that it is guaranteed to have
179     been been build by the same lookup algorithm as gpgsm uses.
180
181     For "uid" records this field lists the preferences in the same way
182     gpg's --edit-key menu does.
183
184     For "sig" records, this is the fingerprint of the key that issued
185     the signature.  Note that this is only filled in if the signature
186     verified correctly.  Note also that for various technical reasons,
187     this fingerprint is only available if --no-sig-cache is used.
188
189 *** Field 14 - Flag field
190
191     Flag field used in the --edit menu output
192
193 *** Field 15 - S/N of a token
194
195     Used in sec/ssb to print the serial number of a token (internal
196     protect mode 1002) or a '#' if that key is a simple stub (internal
197     protect mode 1001).  If the option --with-secret is used and a
198     secret key is available for the public key, a '+' indicates this.
199
200 *** Field 16 - Hash algorithm
201
202     For sig records, this is the used hash algorithm.  For example:
203     2 = SHA-1, 8 = SHA-256.
204
205 *** Field 17 - Curve name
206
207     For pub, sub, sec, and ssb records this field is used for the ECC
208     curve name.
209 *** Field 18 - TOFU Policy
210
211     This is the TOFU policy.  It is either good, bad, unknown, ask or
212     auto.  This is only shows for uid records.
213
214 ** Special fields
215
216 *** PKD - Public key data
217
218     If field 1 has the tag "pkd", a listing looks like this:
219 #+begin_example
220 pkd:0:1024:B665B1435F4C2 .... FF26ABB:
221     !  !   !-- the value
222     !  !------ for information number of bits in the value
223     !--------- index (eg. DSA goes from 0 to 3: p,q,g,y)
224 #+end_example
225
226 *** TRU - Trust database information
227     Example for a "tru" trust base record:
228 #+begin_example
229     tru:o:0:1166697654:1:3:1:5
230 #+end_example
231
232     - Field 2 :: Reason for staleness of trust.  If this field is
233                  empty, then the trustdb is not stale.  This field may
234                  have multiple flags in it:
235
236                  - o :: Trustdb is old
237                  - t :: Trustdb was built with a different trust model
238                         than the one we are using now.
239
240     - Field 3 :: Trust model
241
242                  - 0 :: Classic trust model, as used in PGP 2.x.
243                  - 1 :: PGP trust model, as used in PGP 6 and later.
244                         This is the same as the classic trust model,
245                         except for the addition of trust signatures.
246
247                  GnuPG before version 1.4 used the classic trust model
248                  by default. GnuPG 1.4 and later uses the PGP trust
249                  model by default.
250
251     - Field 4 :: Date trustdb was created in seconds since Epoch.
252     - Field 5 :: Date trustdb will expire in seconds since Epoch.
253     - Field 6 :: Number of marginally trusted users to introduce a new
254                  key signer (gpg's option --marginals-needed).
255     - Field 7 :: Number of completely trusted users to introduce a new
256                  key signer.  (gpg's option --completes-needed)
257
258     - Field 8 :: Maximum depth of a certification chain. (gpg's option
259                  --max-cert-depth)
260
261 *** SPK - Signature subpacket records
262
263     - Field 2 :: Subpacket number as per RFC-4880 and later.
264     - Field 3 :: Flags in hex.  Currently the only two bits assigned
265                  are 1, to indicate that the subpacket came from the
266                  hashed part of the signature, and 2, to indicate the
267                  subpacket was marked critical.
268     - Field 4 :: Length of the subpacket.  Note that this is the
269                  length of the subpacket, and not the length of field
270                  5 below.  Due to the need for %-encoding, the length
271                  of field 5 may be up to 3x this value.
272     - Field 5 :: The subpacket data.  Printable ASCII is shown as
273                  ASCII, but other values are rendered as %XX where XX
274                  is the hex value for the byte.
275
276 *** CFG - Configuration data
277
278     --list-config outputs information about the GnuPG configuration
279     for the benefit of frontends or other programs that call GnuPG.
280     There are several list-config items, all colon delimited like the
281     rest of the --with-colons output.  The first field is always "cfg"
282     to indicate configuration information.  The second field is one of
283     (with examples):
284
285     - version :: The third field contains the version of GnuPG.
286
287                  : cfg:version:1.3.5
288
289     - pubkey :: The third field contains the public key algorithms
290                 this version of GnuPG supports, separated by
291                 semicolons.  The algorithm numbers are as specified in
292                 RFC-4880.  Note that in contrast to the --status-fd
293                 interface these are _not_ the Libgcrypt identifiers.
294                 Using =pubkeyname= prints names instead of numbers.
295
296                  : cfg:pubkey:1;2;3;16;17
297
298     - cipher :: The third field contains the symmetric ciphers this
299                 version of GnuPG supports, separated by semicolons.
300                 The cipher numbers are as specified in RFC-4880.
301                 Using =ciphername= prints names instead of numbers.
302
303                  : cfg:cipher:2;3;4;7;8;9;10
304
305     - digest :: The third field contains the digest (hash) algorithms
306                 this version of GnuPG supports, separated by
307                 semicolons.  The digest numbers are as specified in
308                 RFC-4880.  Using =digestname= prints names instead of
309                 numbers.
310
311                  : cfg:digest:1;2;3;8;9;10
312
313     - compress :: The third field contains the compression algorithms
314                   this version of GnuPG supports, separated by
315                   semicolons.  The algorithm numbers are as specified
316                   in RFC-4880.
317
318                  : cfg:compress:0;1;2;3
319
320     - group :: The third field contains the name of the group, and the
321                fourth field contains the values that the group expands
322                to, separated by semicolons.
323
324                For example, a group of:
325                  : group mynames = paige 0x12345678 joe patti
326                would result in:
327                  : cfg:group:mynames:patti;joe;0x12345678;paige
328
329     - curve :: The third field contains the curve names this version
330                of GnuPG supports, separated by semicolons. Using
331                =curveoid= prints OIDs instead of numbers.
332
333                  : cfg:curve:ed25519;nistp256;nistp384;nistp521
334
335
336 * Format of the --status-fd output
337
338   Every line is prefixed with "[GNUPG:] ", followed by a keyword with
339   the type of the status line and some arguments depending on the type
340   (maybe none); an application should always be prepared to see more
341   arguments in future versions.
342
343 ** General status codes
344 *** NEWSIG [<signers_uid>]
345     Is issued right before a signature verification starts.  This is
346     useful to define a context for parsing ERROR status messages.
347     arguments are currently defined.  If SIGNERS_UID is given and is
348     not "-" this is the percent escape value of the OpenPGP Signer's
349     User ID signature sub-packet.
350
351 *** GOODSIG  <long_keyid_or_fpr>  <username>
352     The signature with the keyid is good.  For each signature only one
353     of the codes GOODSIG, BADSIG, EXPSIG, EXPKEYSIG, REVKEYSIG or
354     ERRSIG will be emitted.  In the past they were used as a marker
355     for a new signature; new code should use the NEWSIG status
356     instead.  The username is the primary one encoded in UTF-8 and %XX
357     escaped. The fingerprint may be used instead of the long keyid if
358     it is available.  This is the case with CMS and might eventually
359     also be available for OpenPGP.
360
361 *** EXPSIG  <long_keyid_or_fpr>  <username>
362     The signature with the keyid is good, but the signature is
363     expired. The username is the primary one encoded in UTF-8 and %XX
364     escaped. The fingerprint may be used instead of the long keyid if
365     it is available.  This is the case with CMS and might eventually
366     also be available for OpenPGP.
367
368 *** EXPKEYSIG  <long_keyid_or_fpr> <username>
369     The signature with the keyid is good, but the signature was made
370     by an expired key. The username is the primary one encoded in
371     UTF-8 and %XX escaped.  The fingerprint may be used instead of the
372     long keyid if it is available.  This is the case with CMS and
373     might eventually also be available for OpenPGP.
374
375 *** REVKEYSIG  <long_keyid_or_fpr>  <username>
376     The signature with the keyid is good, but the signature was made
377     by a revoked key. The username is the primary one encoded in UTF-8
378     and %XX escaped. The fingerprint may be used instead of the long
379     keyid if it is available.  This is the case with CMS and might
380     eventually also beƱ available for OpenPGP.
381
382 *** BADSIG  <long_keyid_or_fpr>  <username>
383     The signature with the keyid has not been verified okay.  The
384     username is the primary one encoded in UTF-8 and %XX escaped. The
385     fingerprint may be used instead of the long keyid if it is
386     available.  This is the case with CMS and might eventually also be
387     available for OpenPGP.
388
389 *** ERRSIG  <keyid>  <pkalgo> <hashalgo> <sig_class> <time> <rc>
390     It was not possible to check the signature.  This may be caused by
391     a missing public key or an unsupported algorithm.  A RC of 4
392     indicates unknown algorithm, a 9 indicates a missing public
393     key. The other fields give more information about this signature.
394     sig_class is a 2 byte hex-value.  The fingerprint may be used
395     instead of the keyid if it is available.  This is the case with
396     gpgsm and might eventually also be available for OpenPGP.
397
398     Note, that TIME may either be the number of seconds since Epoch or
399     an ISO 8601 string.  The latter can be detected by the presence of
400     the letter 'T'.
401
402 *** VALIDSIG <args>
403
404     The args are:
405
406     - <fingerprint_in_hex>
407     - <sig_creation_date>
408     - <sig-timestamp>
409     - <expire-timestamp>
410     - <sig-version>
411     - <reserved>
412     - <pubkey-algo>
413     - <hash-algo>
414     - <sig-class>
415     - [ <primary-key-fpr> ]
416
417     This status indicates that the signature is cryptographically
418     valid. This is similar to GOODSIG, EXPSIG, EXPKEYSIG, or REVKEYSIG
419     (depending on the date and the state of the signature and signing
420     key) but has the fingerprint as the argument. Multiple status
421     lines (VALIDSIG and the other appropriate *SIG status) are emitted
422     for a valid signature.  All arguments here are on one long line.
423     sig-timestamp is the signature creation time in seconds after the
424     epoch. expire-timestamp is the signature expiration time in
425     seconds after the epoch (zero means "does not
426     expire"). sig-version, pubkey-algo, hash-algo, and sig-class (a
427     2-byte hex value) are all straight from the signature packet.
428     PRIMARY-KEY-FPR is the fingerprint of the primary key or identical
429     to the first argument.  This is useful to get back to the primary
430     key without running gpg again for this purpose.
431
432     The primary-key-fpr parameter is used for OpenPGP and not
433     available for CMS signatures.  The sig-version as well as the sig
434     class is not defined for CMS and currently set to 0 and 00.
435
436     Note, that *-TIMESTAMP may either be a number of seconds since
437     Epoch or an ISO 8601 string which can be detected by the presence
438     of the letter 'T'.
439
440 *** SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
441     This is emitted only for signatures of class 0 or 1 which have
442     been verified okay.  The string is a signature id and may be used
443     in applications to detect replay attacks of signed messages.  Note
444     that only DLP algorithms give unique ids - others may yield
445     duplicated ones when they have been created in the same second.
446
447     Note, that SIG-TIMESTAMP may either be a number of seconds since
448     Epoch or an ISO 8601 string which can be detected by the presence
449     of the letter 'T'.
450
451 *** ENC_TO  <long_keyid>  <keytype>  <keylength>
452     The message is encrypted to this LONG_KEYID.  KEYTYPE is the
453     numerical value of the public key algorithm or 0 if it is not
454     known, KEYLENGTH is the length of the key or 0 if it is not known
455     (which is currently always the case).  Gpg prints this line
456     always; Gpgsm only if it knows the certificate.
457
458 *** BEGIN_DECRYPTION
459     Mark the start of the actual decryption process.  This is also
460     emitted when in --list-only mode.
461 *** END_DECRYPTION
462     Mark the end of the actual decryption process.  This are also
463     emitted when in --list-only mode.
464 *** DECRYPTION_INFO <mdc_method> <sym_algo>
465     Print information about the symmetric encryption algorithm and the
466     MDC method.  This will be emitted even if the decryption fails.
467
468 *** DECRYPTION_FAILED
469     The symmetric decryption failed - one reason could be a wrong
470     passphrase for a symmetrical encrypted message.
471
472 *** DECRYPTION_OKAY
473     The decryption process succeeded.  This means, that either the
474     correct secret key has been used or the correct passphrase for a
475     symmetric encrypted message was given.  The program itself may
476     return an errorcode because it may not be possible to verify a
477     signature for some reasons.
478
479 *** SESSION_KEY <algo>:<hexdigits>
480     The session key used to decrypt the message.  This message will
481     only be emitted if the option --show-session-key is used.  The
482     format is suitable to be passed as value for the option
483     --override-session-key.  It is not an indication that the
484     decryption will or has succeeded.
485
486 *** BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
487     Mark the start of the actual encryption process.
488
489 *** END_ENCRYPTION
490     Mark the end of the actual encryption process.
491
492 *** FILE_START <what> <filename>
493     Start processing a file <filename>.  <what> indicates the performed
494     operation:
495     - 1 :: verify
496     - 2 :: encrypt
497     - 3 :: decrypt
498
499 *** FILE_DONE
500     Marks the end of a file processing which has been started
501     by FILE_START.
502
503 *** BEGIN_SIGNING
504     Mark the start of the actual signing process. This may be used as
505     an indication that all requested secret keys are ready for use.
506
507 *** ALREADY_SIGNED <long-keyid>
508     Warning: This is experimental and might be removed at any time.
509
510 *** SIG_CREATED <type> <pk_algo> <hash_algo> <class> <timestamp> <keyfpr>
511     A signature has been created using these parameters.
512     Values for type <type> are:
513       - D :: detached
514       - C :: cleartext
515       - S :: standard
516     (only the first character should be checked)
517
518     <class> are 2 hex digits with the OpenPGP signature class.
519
520     Note, that TIMESTAMP may either be a number of seconds since Epoch
521     or an ISO 8601 string which can be detected by the presence of the
522     letter 'T'.
523
524 *** NOTATION_
525     There are actually three related status codes to convey notation
526     data:
527
528     - NOTATION_NAME <name>
529     - NOTATION_FLAGS <critical> <human_readable>
530     - NOTATION_DATA <string>
531
532     <name> and <string> are %XX escaped.  The data may be split among
533     several NOTATION_DATA lines.  NOTATION_FLAGS is emitted after
534     NOTATION_NAME and gives the critical and human readable flags;
535     the flag values are either 0 or 1.
536
537 *** POLICY_URL <string>
538     Note that URL in <string> is %XX escaped.
539
540 *** PLAINTEXT <format> <timestamp> <filename>
541     This indicates the format of the plaintext that is about to be
542     written.  The format is a 1 byte hex code that shows the format of
543     the plaintext: 62 ('b') is binary data, 74 ('t') is text data with
544     no character set specified, and 75 ('u') is text data encoded in
545     the UTF-8 character set.  The timestamp is in seconds since the
546     epoch.  If a filename is available it gets printed as the third
547     argument, percent-escaped as usual.
548
549 *** PLAINTEXT_LENGTH <length>
550     This indicates the length of the plaintext that is about to be
551     written.  Note that if the plaintext packet has partial length
552     encoding it is not possible to know the length ahead of time.  In
553     that case, this status tag does not appear.
554
555 *** ATTRIBUTE <arguments>
556     The list or arguments are:
557     - <fpr>
558     - <octets>
559     - <type>
560     - <index>
561     - <count>
562     - <timestamp>
563     - <expiredate>
564     - <flags>
565
566     This is one long line issued for each attribute subpacket when an
567     attribute packet is seen during key listing.  <fpr> is the
568     fingerprint of the key.  <octets> is the length of the attribute
569     subpacket.  <type> is the attribute type (e.g. 1 for an image).
570     <index> and <count> indicate that this is the N-th indexed
571     subpacket of count total subpackets in this attribute packet.
572     <timestamp> and <expiredate> are from the self-signature on the
573     attribute packet.  If the attribute packet does not have a valid
574     self-signature, then the timestamp is 0.  <flags> are a bitwise OR
575     of:
576     - 0x01 :: this attribute packet is a primary uid
577     - 0x02 :: this attribute packet is revoked
578     - 0x04 :: this attribute packet is expired
579
580 *** SIG_SUBPACKET <type> <flags> <len> <data>
581     This indicates that a signature subpacket was seen.  The format is
582     the same as the "spk" record above.
583
584 ** Key related
585 *** INV_RECP, INV_SGNR
586     The two similar status codes:
587
588     - INV_RECP <reason> <requested_recipient>
589     - INV_SGNR <reason> <requested_sender>
590
591     are issued for each unusable recipient/sender. The reasons codes
592     currently in use are:
593
594        -  0 :: No specific reason given
595        -  1 :: Not Found
596        -  2 :: Ambigious specification
597        -  3 :: Wrong key usage
598        -  4 :: Key revoked
599        -  5 :: Key expired
600        -  6 :: No CRL known
601        -  7 :: CRL too old
602        -  8 :: Policy mismatch
603        -  9 :: Not a secret key
604        - 10 :: Key not trusted
605        - 11 :: Missing certificate
606        - 12 :: Missing issuer certificate
607        - 13 :: Key disabled
608        - 14 :: Syntax error in specification
609
610     If no specific reason was given a previously emitted status code
611     KEY_CONSIDERED may be used to analyzed the problem.
612
613     Note that for historical reasons the INV_RECP status is also used
614     for gpgsm's SIGNER command where it relates to signer's of course.
615     Newer GnuPG versions are using INV_SGNR; applications should
616     ignore the INV_RECP during the sender's command processing once
617     they have seen an INV_SGNR.  Different codes are used so that they
618     can be distinguish while doing an encrypt+sign operation.
619
620 *** NO_RECP <reserved>
621     Issued if no recipients are usable.
622
623 *** NO_SGNR <reserved>
624     Issued if no senders are usable.
625
626 *** KEY_CONSIDERED <fpr> <flags>
627     Issued to explian the lookup of a key.  FPR is the hexified
628     fingerprint of the primary key.  The bit values for FLAGS are:
629
630     - 1 :: The key has not been selected.
631     - 2 :: All subkeys of the key are expired or have been revoked.
632
633 *** KEYEXPIRED <expire-timestamp>
634     The key has expired.  expire-timestamp is the expiration time in
635     seconds since Epoch.  This status line is not very useful because
636     it will also be emitted for expired subkeys even if this subkey is
637     not used.  To check whether a key used to sign a message has
638     expired, the EXPKEYSIG status line is to be used.
639
640     Note, that the TIMESTAMP may either be a number of seconds since
641     Epoch or an ISO 8601 string which can be detected by the presence
642     of the letter 'T'.
643
644 *** KEYREVOKED
645     The used key has been revoked by its owner.  No arguments yet.
646
647 *** NO_PUBKEY  <long keyid>
648     The public key is not available
649
650 *** NO_SECKEY  <long keyid>
651     The secret key is not available
652
653 *** KEY_CREATED <type> <fingerprint> [<handle>]
654     A key has been created.  Values for <type> are:
655       - B :: primary and subkey
656       - P :: primary
657       - S :: subkey
658     The fingerprint is one of the primary key for type B and P and the
659     one of the subkey for S.  Handle is an arbitrary non-whitespace
660     string used to match key parameters from batch key creation run.
661
662 *** KEY_NOT_CREATED [<handle>]
663     The key from batch run has not been created due to errors.
664
665 *** TRUST_
666     These are several similar status codes:
667
668     - TRUST_UNDEFINED <error_token>
669     - TRUST_NEVER     <error_token>
670     - TRUST_MARGINAL  [0  [<validation_model>]]
671     - TRUST_FULLY     [0  [<validation_model>]]
672     - TRUST_ULTIMATE  [0  [<validation_model>]]
673
674     For good signatures one of these status lines are emitted to
675     indicate the validity of the key used to create the signature.
676     The error token values are currently only emitted by gpgsm.
677
678     VALIDATION_MODEL describes the algorithm used to check the
679     validity of the key.  The defaults are the standard Web of Trust
680     model for gpg and the the standard X.509 model for gpgsm.  The
681     defined values are
682
683        - pgp   :: The standard PGP WoT.
684        - shell :: The standard X.509 model.
685        - chain :: The chain model.
686        - steed :: The STEED model.
687        - tofu  :: The TOFU model
688
689     Note that the term =TRUST_= in the status names is used for
690     historic reasons; we now speak of validity.
691
692 *** TOFU_USER <fingerprint_in_hex> <mbox>
693
694     This status identifies the key and the userid for all following
695     Tofu information.  The fingerprint is the fingerprint of the
696     primary key and the mbox is in general the addr-spec part of the
697     userid encoded in UTF-8 and percent escaped.
698
699 *** TOFU_STATS <validity> <sign-count> 0 [<policy> [<tm1> <tm2>]]
700
701     Statistics for the current user id.
702
703     Values for VALIDITY are:
704     - 0 :: conflict
705     - 1 :: key without history
706     - 2 :: key with too little history
707     - 3 :: key with enough history for basic trust
708     - 4 :: key with a lot of history
709
710     Values for POLICY are:
711     - none    :: No Policy set
712     - auto    :: Policy is "auto"
713     - good    :: Policy is "good"
714     - bad     :: Policy is "bad"
715     - ask     :: Policy is "ask"
716     - unknown :: Policy is not known.
717
718     TM1 gives the number of seconds since the the first messages was
719     verified.  TM2 gives the number of seconds since the most recent
720     message was verified.
721
722 *** TOFU_STATS_SHORT <long_string>
723
724     Information about the TOFU binding for the signature.
725     Example: "15 signatures verified. 10 messages encrypted"
726
727 *** TOFU_STATS_LONG <long_string>
728
729     Information about the TOFU binding for the signature in verbose
730     format.  The LONG_STRING is percent escaped.
731     Example: 'Verified 9 messages signed by "Werner Koch
732     (dist sig)" in the past 3 minutes, 40 seconds.  The most
733     recent message was verified 4 seconds ago.'
734
735 *** PKA_TRUST_
736     This is is one:
737
738     - PKA_TRUST_GOOD <addr-spec>
739     - PKA_TRUST_BAD  <addr-spec>
740
741     Depending on the outcome of the PKA check one of the above status
742     codes is emitted in addition to a =TRUST_*= status.
743
744 ** Remote control
745 *** GET_BOOL, GET_LINE, GET_HIDDEN, GOT_IT
746
747     These status line are used with --command-fd for interactive
748     control of the process.
749
750 *** USERID_HINT <long main keyid> <string>
751     Give a hint about the user ID for a certain keyID.
752
753 *** NEED_PASSPHRASE <long keyid> <long main keyid> <keytype> <keylength>
754     Issued whenever a passphrase is needed.  KEYTYPE is the numerical
755     value of the public key algorithm or 0 if this is not applicable,
756     KEYLENGTH is the length of the key or 0 if it is not known (this
757     is currently always the case).
758
759 *** NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
760     Issued whenever a passphrase for symmetric encryption is needed.
761
762 *** NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
763     Issued whenever a PIN is requested to unlock a card.
764
765 *** MISSING_PASSPHRASE
766     No passphrase was supplied.  An application which encounters this
767     message may want to stop parsing immediately because the next
768     message will probably be a BAD_PASSPHRASE.  However, if the
769     application is a wrapper around the key edit menu functionality it
770     might not make sense to stop parsing but simply ignoring the
771     following BAD_PASSPHRASE.
772
773 *** BAD_PASSPHRASE <long keyid>
774     The supplied passphrase was wrong or not given.  In the latter
775     case you may have seen a MISSING_PASSPHRASE.
776
777 *** GOOD_PASSPHRASE
778     The supplied passphrase was good and the secret key material
779     is therefore usable.
780
781 ** Import/Export
782 *** IMPORT_CHECK <long keyid> <fingerprint> <user ID>
783     This status is emitted in interactive mode right before
784     the "import.okay" prompt.
785
786 *** IMPORTED   <long keyid>  <username>
787     The keyid and name of the signature just imported
788
789 *** IMPORT_OK  <reason> [<fingerprint>]
790     The key with the primary key's FINGERPRINT has been imported.
791     REASON flags are:
792
793     - 0 :: Not actually changed
794     - 1 :: Entirely new key.
795     - 2 :: New user IDs
796     - 4 :: New signatures
797     - 8 :: New subkeys
798     - 16 :: Contains private key.
799
800     The flags may be ORed.
801
802 *** IMPORT_PROBLEM <reason> [<fingerprint>]
803     Issued for each import failure.  Reason codes are:
804
805     - 0 :: No specific reason given.
806     - 1 :: Invalid Certificate.
807     - 2 :: Issuer Certificate missing.
808     - 3 :: Certificate Chain too long.
809     - 4 :: Error storing certificate.
810
811 *** IMPORT_RES <args>
812     Final statistics on import process (this is one long line). The
813     args are a list of unsigned numbers separated by white space:
814
815     - <count>
816     - <no_user_id>
817     - <imported>
818     - always 0 (formerly used for the number of RSA keys)
819     - <unchanged>
820     - <n_uids>
821     - <n_subk>
822     - <n_sigs>
823     - <n_revoc>
824     - <sec_read>
825     - <sec_imported>
826     - <sec_dups>
827     - <skipped_new_keys>
828     - <not_imported>
829     - <skipped_v3_keys>
830
831 *** EXPORTED  <fingerprint>
832     The key with <fingerprint> has been exported.  The fingerprint is
833     the fingerprint of the primary key even if the primary key has
834     been replaced by a stub key during secret key export.
835
836 *** EXPORT_RES <args>
837
838     Final statistics on export process (this is one long line). The
839     args are a list of unsigned numbers separated by white space:
840
841     - <count>
842     - <secret_count>
843     - <exported>
844
845
846 ** Smartcard related
847 *** CARDCTRL <what> [<serialno>]
848     This is used to control smartcard operations.  Defined values for
849     WHAT are:
850
851       - 1 :: Request insertion of a card.  Serialnumber may be given
852              to request a specific card.  Used by gpg 1.4 w/o
853              scdaemon
854       - 2 :: Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
855       - 3 :: Card with serialnumber detected
856       - 4 :: No card available
857       - 5 :: No card reader available
858       - 6 :: No card support available
859       - 7 :: Card is in termination state
860
861 *** SC_OP_FAILURE [<code>]
862     An operation on a smartcard definitely failed.  Currently there is
863     no indication of the actual error code, but application should be
864     prepared to later accept more arguments.  Defined values for
865     <code> are:
866
867       - 0 :: unspecified error (identically to a missing CODE)
868       - 1 :: canceled
869       - 2 :: bad PIN
870
871 *** SC_OP_SUCCESS
872     A smart card operaion succeeded.  This status is only printed for
873     certain operation and is mostly useful to check whether a PIN
874     change really worked.
875
876 ** Miscellaneous status codes
877 *** NODATA  <what>
878     No data has been found.  Codes for WHAT are:
879
880     - 1 :: No armored data.
881     - 2 :: Expected a packet but did not found one.
882     - 3 :: Invalid packet found, this may indicate a non OpenPGP
883            message.
884     - 4 :: Signature expected but not found
885
886     You may see more than one of these status lines.
887
888 *** UNEXPECTED <what>
889     Unexpected data has been encountered.  Codes for WHAT are:
890     - 0 :: Not further specified
891     - 1 :: Corrupted message structure
892
893 *** TRUNCATED <maxno>
894     The output was truncated to MAXNO items.  This status code is
895     issued for certain external requests.
896
897 *** ERROR <error location> <error code> [<more>]
898     This is a generic error status message, it might be followed by
899     error location specific data. <error code> and <error_location>
900     should not contain spaces.  The error code is a either a string
901     commencing with a letter or such a string prefixed with a
902     numerical error code and an underscore; e.g.: "151011327_EOF".
903 *** WARNING <location> <error code> [<text>]
904     This is a generic warning status message, it might be followed by
905     error location specific data. <error code> and <location>
906     should not contain spaces.  The error code is a either a string
907     commencing with a letter or such a string prefixed with a
908     numerical error code and an underscore; e.g.: "151011327_EOF".
909 *** SUCCESS [<location>]
910     Postive confirmation that an operation succeeded.  It is used
911     similar to ISO-C's EXIT_SUCCESS.  <location> is optional but if
912     given should not contain spaces.  Used only with a few commands.
913
914 *** FAILURE <location> <error_code>
915     This is the counterpart to SUCCESS and used to indicate a program
916     failure.  It is used similar to ISO-C's EXIT_FAILURE but allows to
917     convey more information, in particular an gpg-error error code.
918     That numerical error code may optionally have a suffix made of an
919     underscore and a string with an error symbol like "151011327_EOF".
920     A dash may be used instead of <location>.
921
922 *** BADARMOR
923     The ASCII armor is corrupted.  No arguments yet.
924
925 *** DELETE_PROBLEM <reason_code>
926     Deleting a key failed.  Reason codes are:
927     - 1 :: No such key
928     - 2 :: Must delete secret key first
929     - 3 :: Ambigious specification
930     - 4 :: Key is stored on a smartcard.
931
932 *** PROGRESS <what> <char> <cur> <total>
933     Used by the primegen and Public key functions to indicate
934     progress.  <char> is the character displayed with no --status-fd
935     enabled, with the linefeed replaced by an 'X'.  <cur> is the
936     current amount done and <total> is amount to be done; a <total> of
937     0 indicates that the total amount is not known. The condition
938       :       TOTAL && CUR == TOTAL
939     may be used to detect the end of an operation.
940
941     Well known values for WHAT are:
942
943            - pk_dsa   :: DSA key generation
944            - pk_elg   :: Elgamal key generation
945            - primegen :: Prime generation
946            - need_entropy :: Waiting for new entropy in the RNG
947            - tick :: Generic tick without any special meaning - useful
948                      for letting clients know that the server is still
949                      working.
950            - starting_agent :: A gpg-agent was started because it is not
951                                 running as a daemon.
952            - learncard :: Send by the agent and gpgsm while learing
953                           the data of a smartcard.
954            - card_busy :: A smartcard is still working
955
956 *** BACKUP_KEY_CREATED <fingerprint> <fname>
957     A backup of a key identified by <fingerprint> has been writte to
958     the file <fname>; <fname> is percent-escaped.
959
960 *** MOUNTPOINT <name>
961     <name> is a percent-plus escaped filename describing the
962     mountpoint for the current operation (e.g. used by "g13 --mount").
963     This may either be the specified mountpoint or one randomly
964     choosen by g13.
965
966 *** PINENTRY_LAUNCHED <pid>
967     This status line is emitted by gpg to notify a client that a
968     Pinentry has been launched.  <pid> is the PID of the Pinentry.  It
969     may be used to display a hint to the user but can't be used to
970     synchronize with Pinentry.  Note that there is also an Assuan
971     inquiry line with the same name used internally or, if enabled,
972     send to the client instead of this status line.  Such an inquiry
973     may be used to sync with Pinentry
974
975 ** Obsolete status codes
976 *** SIGEXPIRED
977     Removed on 2011-02-04.  This is deprecated in favor of KEYEXPIRED.
978 *** RSA_OR_IDEA
979     Obsolete.  This status message used to be emitted for requests to
980     use the IDEA or RSA algorithms.  It has been dropped from GnuPG
981     2.1 after the respective patents expired.
982 *** SHM_INFO, SHM_GET, SHM_GET_BOOL, SHM_GET_HIDDEN
983     These were used for the ancient shared memory based co-processing.
984 *** BEGIN_STREAM, END_STREAM
985     Used to issued by the experimental pipemode.
986
987
988 * Format of the --attribute-fd output
989
990   When --attribute-fd is set, during key listings (--list-keys,
991   --list-secret-keys) GnuPG dumps each attribute packet to the file
992   descriptor specified.  --attribute-fd is intended for use with
993   --status-fd as part of the required information is carried on the
994   ATTRIBUTE status tag (see above).
995
996   The contents of the attribute data is specified by RFC 4880.  For
997   convenience, here is the Photo ID format, as it is currently the
998   only attribute defined:
999
1000   - Byte 0-1 :: The length of the image header.  Due to a historical
1001                 accident (i.e. oops!) back in the NAI PGP days, this
1002                 is a little-endian number.  Currently 16 (0x10 0x00).
1003
1004   - Byte 2 :: The image header version.  Currently 0x01.
1005
1006   - Byte 3 :: Encoding format.  0x01 == JPEG.
1007
1008   - Byte 4-15 :: Reserved, and currently unused.
1009
1010   All other data after this header is raw image (JPEG) data.
1011
1012
1013 * Layout of the TrustDB
1014
1015   The TrustDB is built from fixed length records, where the first byte
1016   describes the record type.  All numeric values are stored in network
1017   byte order.  The length of each record is 40 bytes.  The first
1018   record of the DB is always of type 1 and this is the only record of
1019   this type.
1020
1021   The record types: directory(2), key(3), uid(4), pref(5), sigrec(6),
1022   and shadow directory(8) are not anymore used by version 2 of the
1023   TrustDB.
1024
1025 ** Record type 0
1026
1027    Unused record or deleted, can be reused for any purpose.  Such
1028    records should in general not exist because deleted records are of
1029    type 254 and kept in a linked list.
1030
1031 ** Version info (RECTYPE_VER, 1)
1032
1033    Version information for this TrustDB.  This is always the first
1034    record of the DB and the only one of this type.
1035
1036    - 1 u8 :: Record type (value: 1).
1037    - 3 byte :: Magic value ("gpg")
1038    - 1 u8 :: TrustDB version (value: 2).
1039    - 1 u8 :: =marginals=. How many marginal trusted keys are required.
1040    - 1 u8 :: =completes=. How many completely trusted keys are
1041              required.
1042    - 1 u8 :: =max_cert_depth=.  How deep is the WoT evaluated.  Along
1043              with =marginals= and =completes=, this value is used to
1044              check whether the cached validity value from a [FIXME
1045              dir] record can be used.
1046    - 1 u8 :: =trust_model=
1047    - 1 u8 :: =min_cert_level=
1048    - 2 byte :: Not used
1049    - 1 u32 :: =created=. Timestamp of trustdb creation.
1050    - 1 u32 :: =nextcheck=. Timestamp of last modification which may
1051               affect the validity of keys in the trustdb.  This value
1052               is checked against the validity timestamp in the dir
1053               records.
1054    - 1 u32 :: =reserved=.  Not used.
1055    - 1 u32 :: =reserved2=. Not used.
1056    - 1 u32 :: =firstfree=. Number of the record with the head record
1057               of the RECTYPE_FREE linked list.
1058    - 1 u32 :: =reserved3=. Not used.
1059    - 1 u32 :: =trusthashtbl=. Record number of the trusthashtable.
1060
1061
1062 ** Hash table (RECTYPE_HTBL, 10)
1063
1064    Due to the fact that we use fingerprints to lookup keys, we can
1065    implement quick access by some simple hash methods, and avoid the
1066    overhead of gdbm.  A property of fingerprints is that they can be
1067    used directly as hash values.  What we use is a dynamic multilevel
1068    architecture, which combines hash tables, record lists, and linked
1069    lists.
1070
1071    This record is a hash table of 256 entries with the property that
1072    all these records are stored consecutively to make one big
1073    table. The hash value is simple the 1st, 2nd, ... byte of the
1074    fingerprint (depending on the indirection level).
1075
1076    - 1 u8 :: Record type (value: 10).
1077    - 1 u8 :: Reserved
1078    - n u32 :: =recnum=.  A table with the hash table items fitting into
1079               this record.  =n= depends on the record length:
1080               $n=(reclen-2)/4$ which yields 9 for oure current record
1081               length of 40 bytes.
1082
1083    The total number of hash table records to form the table is:
1084    $m=(256+n-1)/n$.  This is 29 for our record length of 40.
1085
1086    To look up a key we use the first byte of the fingerprint to get
1087    the recnum from this hash table and then look up the addressed
1088    record:
1089
1090    - If that record is another hash table, we use 2nd byte to index
1091      that hash table and so on;
1092    - if that record is a hash list, we walk all entries until we find
1093      a matching one; or
1094    - if that record is a key record, we compare the fingerprint to
1095      decide whether it is the requested key;
1096
1097
1098 ** Hash list (RECTYPE_HLST, 11)
1099
1100    See hash table above on how it is used.  It may also be used for
1101    other purposes.
1102
1103    - 1 u8 :: Record type (value: 11).
1104    - 1 u8 :: Reserved.
1105    - 1 u32 :: =next=.  Record number of the next hash list record or 0
1106               if none.
1107    - n u32 :: =rnum=.  Array with record numbers to values.  With
1108               $n=(reclen-5)/5$ and our record length of 40, n is 7.
1109
1110 ** Trust record (RECTYPE_TRUST, 12)
1111
1112    - 1 u8 :: Record type (value: 12).
1113    - 1 u8 :: Reserved.
1114    - 20 byte :: =fingerprint=.
1115    - 1 u8 :: =ownertrust=.
1116    - 1 u8 :: =depth=.
1117    - 1 u8 :: =min_ownertrust=.
1118    - 1 byte :: Not used.
1119    - 1 u32 :: =validlist=.
1120    - 10 byte :: Not used.
1121
1122 ** Validity record (RECTYPE_VALID, 13)
1123
1124    - 1 u8 :: Record type (value: 13).
1125    - 1 u8 :: Reserved.
1126    - 20 byte :: =namehash=.
1127    - 1 u8 :: =validity=
1128    - 1 u32 :: =next=.
1129    - 1 u8 :: =full_count=.
1130    - 1 u8 :: =marginal_count=.
1131    - 11 byte :: Not used.
1132
1133 ** Free record (RECTYPE_FREE, 254)
1134
1135    All these records form a linked list of unused records in the TrustDB.
1136
1137    - 1 u8 :: Record type (value: 254)
1138    - 1 u8 :: Reserved.
1139    - 1 u32 :: =next=.  Record number of the next rcord of this type.
1140               The record number to the head of this linked list is
1141               stored in the version info record.
1142
1143
1144 * GNU extensions to the S2K algorithm
1145
1146   1 octet  - S2K Usage: either 254 or 255.
1147   1 octet  - S2K Cipher Algo: 0
1148   1 octet  - S2K Specifier: 101
1149   3 octets - "GNU"
1150   1 octet  - GNU S2K Extension Number.
1151
1152   If such a GNU extension is used neither an IV nor any kind of
1153   checksum is used.  The defined GNU S2K Extension Numbers are:
1154
1155   - 1 :: Do not store the secret part at all.  No specific data
1156          follows.
1157
1158   - 2 :: A stub to access smartcards.  This data follows:
1159          - One octet with the length of the following serial number.
1160          - The serial number. Regardless of what the length octet
1161            indicates no more than 16 octets are stored.
1162
1163   Note that gpg stores the GNU S2K Extension Number internally as an
1164   S2K Specifier with an offset of 1000.
1165
1166
1167 * Keyserver helper message format
1168
1169   The keyserver may be contacted by a Unix Domain socket or via TCP.
1170
1171   The format of a request is:
1172 #+begin_example
1173   command-tag
1174   "Content-length:" digits
1175   CRLF
1176 #+end_example
1177
1178   Where command-tag is
1179
1180 #+begin_example
1181   NOOP
1182   GET <user-name>
1183   PUT
1184   DELETE <user-name>
1185 #+end_example
1186
1187 The format of a response is:
1188
1189 #+begin_example
1190   "GNUPG/1.0" status-code status-text
1191   "Content-length:" digits
1192   CRLF
1193 #+end_example
1194 followed by <digits> bytes of data
1195
1196 Status codes are:
1197
1198   - 1xx :: Informational - Request received, continuing process
1199
1200   - 2xx :: Success - The action was successfully received, understood,
1201            and accepted
1202
1203   - 4xx :: Client Error - The request contains bad syntax or cannot be
1204            fulfilled
1205
1206   - 5xx :: Server Error - The server failed to fulfill an apparently
1207            valid request
1208
1209
1210 * Object identifiers
1211
1212   OIDs below the GnuPG arc:
1213
1214 #+begin_example
1215   1.3.6.1.4.1.11591.2          GnuPG
1216   1.3.6.1.4.1.11591.2.1          notation
1217   1.3.6.1.4.1.11591.2.1.1          pkaAddress
1218   1.3.6.1.4.1.11591.2.2          X.509 extensions
1219   1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
1220   1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
1221   1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
1222 #+end_example
1223
1224
1225
1226 * Miscellaneous notes
1227
1228 ** v3 fingerprints
1229    For packet version 3 we calculate the keyids this way:
1230     - RSA :: Low 64 bits of n
1231     - ELGAMAL :: Build a v3 pubkey packet (with CTB 0x99) and
1232                  calculate a RMD160 hash value from it. This is used
1233                  as the fingerprint and the low 64 bits are the keyid.
1234
1235 ** Simplified revocation certificates
1236   Revocation certificates consist only of the signature packet;
1237   "--import" knows how to handle this.  The rationale behind it is to
1238   keep them small.
1239
1240 ** Documentation on HKP (the http keyserver protocol):
1241
1242    A minimalistic HTTP server on port 11371 recognizes a GET for
1243    /pks/lookup.  The standard http URL encoded query parameters are
1244    this (always key=value):
1245
1246    - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1247      pgp -kxa)
1248
1249    - search=<stringlist>. This is a list of words that must occur in the key.
1250      The words are delimited with space, points, @ and so on. The delimiters
1251      are not searched for and the order of the words doesn't matter (but see
1252      next option).
1253
1254    - exact=on. This switch tells the hkp server to only report exact matching
1255      keys back. In this case the order and the "delimiters" are important.
1256
1257    - fingerprint=on. Also reports the fingerprints when used with 'index' or
1258      'vindex'
1259
1260    The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1261    keys.
1262
1263
1264    A better way to do this would be a request like:
1265
1266       /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1267
1268    This can be implemented using Hurd's translator mechanism.
1269    However, I think the whole keyserver stuff has to be re-thought;
1270    I have some ideas and probably create a white paper.
1271 ** Algorithm names for the "keygen.algo" prompt
1272
1273   When using a --command-fd controlled key generation or "addkey"
1274   there is way to know the number to enter on the "keygen.algo"
1275   prompt.  The displayed numbers are for human reception and may
1276   change with releases.  To provide a stable way to enter a desired
1277   algorithm choice the prompt also accepts predefined names for the
1278   algorithms, which will not change.
1279
1280    | Name    | No | Description                     |
1281    |---------+----+---------------------------------|
1282    | rsa+rsa |  1 | RSA and RSA (default)           |
1283    | dsa+elg |  2 | DSA and Elgamal                 |
1284    | dsa     |  3 | DSA (sign only)                 |
1285    | rsa/s   |  4 | RSA (sign only)                 |
1286    | elg     |  5 | Elgamal (encrypt only)          |
1287    | rsa/e   |  6 | RSA (encrypt only)              |
1288    | dsa/*   |  7 | DSA (set your own capabilities) |
1289    | rsa/*   |  8 | RSA (set your own capabilities) |
1290    | ecc+ecc |  9 | ECC and ECC                     |
1291    | ecc/s   | 10 | ECC (sign only)                 |
1292    | ecc/*   | 11 | ECC (set your own capabilities) |
1293    | ecc/e   | 12 | ECC (encrypt only)              |
1294    | keygrip | 13 | Existing key                    |
1295
1296    If one of the "foo/*" names are used a "keygen.flags" prompt needs
1297    to be answered as well.  Instead of toggling the predefined flags,
1298    it is also possible to set them direct: Use a "=" character
1299    directly followed by a comination of "a" (for authentication), "s"
1300    (for signing), or "c" (for certification).