gpg: Fix the TOFU_STATS_LONG status.
[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
345     Is issued right before a signature verification starts.  This is
346     useful to define a context for parsing ERROR status messages.  No
347     arguments are currently defined.
348
349 *** GOODSIG  <long_keyid_or_fpr>  <username>
350     The signature with the keyid is good.  For each signature only one
351     of the codes GOODSIG, BADSIG, EXPSIG, EXPKEYSIG, REVKEYSIG or
352     ERRSIG will be emitted.  In the past they were used as a marker
353     for a new signature; new code should use the NEWSIG status
354     instead.  The username is the primary one encoded in UTF-8 and %XX
355     escaped. The fingerprint may be used instead of the long keyid if
356     it is available.  This is the case with CMS and might eventually
357     also be available for OpenPGP.
358
359 *** EXPSIG  <long_keyid_or_fpr>  <username>
360     The signature with the keyid is good, but the signature is
361     expired. The username is the primary one encoded in UTF-8 and %XX
362     escaped. The fingerprint may be used instead of the long keyid if
363     it is available.  This is the case with CMS and might eventually
364     also be available for OpenPGP.
365
366 *** EXPKEYSIG  <long_keyid_or_fpr> <username>
367     The signature with the keyid is good, but the signature was made
368     by an expired key. The username is the primary one encoded in
369     UTF-8 and %XX escaped.  The fingerprint may be used instead of the
370     long keyid if it is available.  This is the case with CMS and
371     might eventually also be available for OpenPGP.
372
373 *** REVKEYSIG  <long_keyid_or_fpr>  <username>
374     The signature with the keyid is good, but the signature was made
375     by a revoked key. The username is the primary one encoded in UTF-8
376     and %XX escaped. The fingerprint may be used instead of the long
377     keyid if it is available.  This is the case with CMS and might
378     eventually also beƱ available for OpenPGP.
379
380 *** BADSIG  <long_keyid_or_fpr>  <username>
381     The signature with the keyid has not been verified okay.  The
382     username is the primary one encoded in UTF-8 and %XX escaped. The
383     fingerprint may be used instead of the long keyid if it is
384     available.  This is the case with CMS and might eventually also be
385     available for OpenPGP.
386
387 *** ERRSIG  <keyid>  <pkalgo> <hashalgo> <sig_class> <time> <rc>
388     It was not possible to check the signature.  This may be caused by
389     a missing public key or an unsupported algorithm.  A RC of 4
390     indicates unknown algorithm, a 9 indicates a missing public
391     key. The other fields give more information about this signature.
392     sig_class is a 2 byte hex-value.  The fingerprint may be used
393     instead of the keyid if it is available.  This is the case with
394     gpgsm and might eventually also be available for OpenPGP.
395
396     Note, that TIME may either be the number of seconds since Epoch or
397     an ISO 8601 string.  The latter can be detected by the presence of
398     the letter 'T'.
399
400 *** VALIDSIG <args>
401
402     The args are:
403
404     - <fingerprint_in_hex>
405     - <sig_creation_date>
406     - <sig-timestamp>
407     - <expire-timestamp>
408     - <sig-version>
409     - <reserved>
410     - <pubkey-algo>
411     - <hash-algo>
412     - <sig-class>
413     - [ <primary-key-fpr> ]
414
415     This status indicates that the signature is cryptographically
416     valid. This is similar to GOODSIG, EXPSIG, EXPKEYSIG, or REVKEYSIG
417     (depending on the date and the state of the signature and signing
418     key) but has the fingerprint as the argument. Multiple status
419     lines (VALIDSIG and the other appropriate *SIG status) are emitted
420     for a valid signature.  All arguments here are on one long line.
421     sig-timestamp is the signature creation time in seconds after the
422     epoch. expire-timestamp is the signature expiration time in
423     seconds after the epoch (zero means "does not
424     expire"). sig-version, pubkey-algo, hash-algo, and sig-class (a
425     2-byte hex value) are all straight from the signature packet.
426     PRIMARY-KEY-FPR is the fingerprint of the primary key or identical
427     to the first argument.  This is useful to get back to the primary
428     key without running gpg again for this purpose.
429
430     The primary-key-fpr parameter is used for OpenPGP and not
431     available for CMS signatures.  The sig-version as well as the sig
432     class is not defined for CMS and currently set to 0 and 00.
433
434     Note, that *-TIMESTAMP may either be a number of seconds since
435     Epoch or an ISO 8601 string which can be detected by the presence
436     of the letter 'T'.
437
438 *** SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
439     This is emitted only for signatures of class 0 or 1 which have
440     been verified okay.  The string is a signature id and may be used
441     in applications to detect replay attacks of signed messages.  Note
442     that only DLP algorithms give unique ids - others may yield
443     duplicated ones when they have been created in the same second.
444
445     Note, that SIG-TIMESTAMP may either be a number of seconds since
446     Epoch or an ISO 8601 string which can be detected by the presence
447     of the letter 'T'.
448
449 *** ENC_TO  <long_keyid>  <keytype>  <keylength>
450     The message is encrypted to this LONG_KEYID.  KEYTYPE is the
451     numerical value of the public key algorithm or 0 if it is not
452     known, KEYLENGTH is the length of the key or 0 if it is not known
453     (which is currently always the case).  Gpg prints this line
454     always; Gpgsm only if it knows the certificate.
455
456 *** BEGIN_DECRYPTION
457     Mark the start of the actual decryption process.  This is also
458     emitted when in --list-only mode.
459 *** END_DECRYPTION
460     Mark the end of the actual decryption process.  This are also
461     emitted when in --list-only mode.
462 *** DECRYPTION_INFO <mdc_method> <sym_algo>
463     Print information about the symmetric encryption algorithm and the
464     MDC method.  This will be emitted even if the decryption fails.
465
466 *** DECRYPTION_FAILED
467     The symmetric decryption failed - one reason could be a wrong
468     passphrase for a symmetrical encrypted message.
469
470 *** DECRYPTION_OKAY
471     The decryption process succeeded.  This means, that either the
472     correct secret key has been used or the correct passphrase for a
473     symmetric encrypted message was given.  The program itself may
474     return an errorcode because it may not be possible to verify a
475     signature for some reasons.
476
477 *** SESSION_KEY <algo>:<hexdigits>
478     The session key used to decrypt the message.  This message will
479     only be emitted if the option --show-session-key is used.  The
480     format is suitable to be passed as value for the option
481     --override-session-key.  It is not an indication that the
482     decryption will or has succeeded.
483
484 *** BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
485     Mark the start of the actual encryption process.
486
487 *** END_ENCRYPTION
488     Mark the end of the actual encryption process.
489
490 *** FILE_START <what> <filename>
491     Start processing a file <filename>.  <what> indicates the performed
492     operation:
493     - 1 :: verify
494     - 2 :: encrypt
495     - 3 :: decrypt
496
497 *** FILE_DONE
498     Marks the end of a file processing which has been started
499     by FILE_START.
500
501 *** BEGIN_SIGNING
502     Mark the start of the actual signing process. This may be used as
503     an indication that all requested secret keys are ready for use.
504
505 *** ALREADY_SIGNED <long-keyid>
506     Warning: This is experimental and might be removed at any time.
507
508 *** SIG_CREATED <type> <pk_algo> <hash_algo> <class> <timestamp> <keyfpr>
509     A signature has been created using these parameters.
510     Values for type <type> are:
511       - D :: detached
512       - C :: cleartext
513       - S :: standard
514     (only the first character should be checked)
515
516     <class> are 2 hex digits with the OpenPGP signature class.
517
518     Note, that TIMESTAMP may either be a number of seconds since Epoch
519     or an ISO 8601 string which can be detected by the presence of the
520     letter 'T'.
521
522 *** NOTATION_
523     There are actually two related status codes to convey notation
524     data:
525
526     - NOTATION_NAME <name>
527     - NOTATION_DATA <string>
528
529     <name> and <string> are %XX escaped; the data may be split among
530     several NOTATION_DATA lines.
531
532 *** POLICY_URL <string>
533     Note that URL in <string> is %XX escaped.
534
535 *** PLAINTEXT <format> <timestamp> <filename>
536     This indicates the format of the plaintext that is about to be
537     written.  The format is a 1 byte hex code that shows the format of
538     the plaintext: 62 ('b') is binary data, 74 ('t') is text data with
539     no character set specified, and 75 ('u') is text data encoded in
540     the UTF-8 character set.  The timestamp is in seconds since the
541     epoch.  If a filename is available it gets printed as the third
542     argument, percent-escaped as usual.
543
544 *** PLAINTEXT_LENGTH <length>
545     This indicates the length of the plaintext that is about to be
546     written.  Note that if the plaintext packet has partial length
547     encoding it is not possible to know the length ahead of time.  In
548     that case, this status tag does not appear.
549
550 *** ATTRIBUTE <arguments>
551     The list or arguments are:
552     - <fpr>
553     - <octets>
554     - <type>
555     - <index>
556     - <count>
557     - <timestamp>
558     - <expiredate>
559     - <flags>
560
561     This is one long line issued for each attribute subpacket when an
562     attribute packet is seen during key listing.  <fpr> is the
563     fingerprint of the key.  <octets> is the length of the attribute
564     subpacket.  <type> is the attribute type (e.g. 1 for an image).
565     <index> and <count> indicate that this is the N-th indexed
566     subpacket of count total subpackets in this attribute packet.
567     <timestamp> and <expiredate> are from the self-signature on the
568     attribute packet.  If the attribute packet does not have a valid
569     self-signature, then the timestamp is 0.  <flags> are a bitwise OR
570     of:
571     - 0x01 :: this attribute packet is a primary uid
572     - 0x02 :: this attribute packet is revoked
573     - 0x04 :: this attribute packet is expired
574
575 *** SIG_SUBPACKET <type> <flags> <len> <data>
576     This indicates that a signature subpacket was seen.  The format is
577     the same as the "spk" record above.
578
579 ** Key related
580 *** INV_RECP, INV_SGNR
581     The two similar status codes:
582
583     - INV_RECP <reason> <requested_recipient>
584     - INV_SGNR <reason> <requested_sender>
585
586     are issued for each unusable recipient/sender. The reasons codes
587     currently in use are:
588
589        -  0 :: No specific reason given
590        -  1 :: Not Found
591        -  2 :: Ambigious specification
592        -  3 :: Wrong key usage
593        -  4 :: Key revoked
594        -  5 :: Key expired
595        -  6 :: No CRL known
596        -  7 :: CRL too old
597        -  8 :: Policy mismatch
598        -  9 :: Not a secret key
599        - 10 :: Key not trusted
600        - 11 :: Missing certificate
601        - 12 :: Missing issuer certificate
602        - 13 :: Key disabled
603        - 14 :: Syntax error in specification
604
605     If no specific reason was given a previously emitted status code
606     KEY_CONSIDERED may be used to analyzed the problem.
607
608     Note that for historical reasons the INV_RECP status is also used
609     for gpgsm's SIGNER command where it relates to signer's of course.
610     Newer GnuPG versions are using INV_SGNR; applications should
611     ignore the INV_RECP during the sender's command processing once
612     they have seen an INV_SGNR.  Different codes are used so that they
613     can be distinguish while doing an encrypt+sign operation.
614
615 *** NO_RECP <reserved>
616     Issued if no recipients are usable.
617
618 *** NO_SGNR <reserved>
619     Issued if no senders are usable.
620
621 *** KEY_CONSIDERED <fpr> <flags>
622     Issued to explian the lookup of a key.  FPR is the hexified
623     fingerprint of the primary key.  The bit values for FLAGS are:
624
625     - 1 :: The key has not been selected.
626     - 2 :: All subkeys of the key are expired or have been revoked.
627
628 *** KEYEXPIRED <expire-timestamp>
629     The key has expired.  expire-timestamp is the expiration time in
630     seconds since Epoch.  This status line is not very useful because
631     it will also be emitted for expired subkeys even if this subkey is
632     not used.  To check whether a key used to sign a message has
633     expired, the EXPKEYSIG status line is to be used.
634
635     Note, that the TIMESTAMP may either be a number of seconds since
636     Epoch or an ISO 8601 string which can be detected by the presence
637     of the letter 'T'.
638
639 *** KEYREVOKED
640     The used key has been revoked by its owner.  No arguments yet.
641
642 *** NO_PUBKEY  <long keyid>
643     The public key is not available
644
645 *** NO_SECKEY  <long keyid>
646     The secret key is not available
647
648 *** KEY_CREATED <type> <fingerprint> [<handle>]
649     A key has been created.  Values for <type> are:
650       - B :: primary and subkey
651       - P :: primary
652       - S :: subkey
653     The fingerprint is one of the primary key for type B and P and the
654     one of the subkey for S.  Handle is an arbitrary non-whitespace
655     string used to match key parameters from batch key creation run.
656
657 *** KEY_NOT_CREATED [<handle>]
658     The key from batch run has not been created due to errors.
659
660 *** TRUST_
661     These are several similar status codes:
662
663     - TRUST_UNDEFINED <error_token>
664     - TRUST_NEVER     <error_token>
665     - TRUST_MARGINAL  [0  [<validation_model>]]
666     - TRUST_FULLY     [0  [<validation_model>]]
667     - TRUST_ULTIMATE  [0  [<validation_model>]]
668
669     For good signatures one of these status lines are emitted to
670     indicate the validity of the key used to create the signature.
671     The error token values are currently only emitted by gpgsm.
672
673     VALIDATION_MODEL describes the algorithm used to check the
674     validity of the key.  The defaults are the standard Web of Trust
675     model for gpg and the the standard X.509 model for gpgsm.  The
676     defined values are
677
678        - pgp   :: The standard PGP WoT.
679        - shell :: The standard X.509 model.
680        - chain :: The chain model.
681        - steed :: The STEED model.
682        - tofu  :: The TOFU model
683
684     Note that the term =TRUST_= in the status names is used for
685     historic reasons; we now speak of validity.
686
687 *** TOFU_USER <fingerprint_in_hex> <mbox>
688
689     This status identifies the key and the userid for all following
690     Tofu information.  The fingerprint is the fingerprint of the
691     primary key and the mbox is in general the addr-spec part of the
692     userid encoded in UTF-8 and percent escaped.
693
694 *** TOFU_STATS <validity> <sign-count> 0 [<policy> [<tm1> <tm2>]]
695
696     Statistics for the current user id.
697
698     Values for VALIDITY are:
699     - 0 :: conflict
700     - 1 :: key without history
701     - 2 :: key with too little history
702     - 3 :: key with enough history for basic trust
703     - 4 :: key with a lot of history
704
705     Values for POLICY are:
706     - none    :: No Policy set
707     - auto    :: Policy is "auto"
708     - good    :: Policy is "good"
709     - bad     :: Policy is "bad"
710     - ask     :: Policy is "ask"
711     - unknown :: Policy is not known.
712
713     TM1 gives the number of seconds since the the first messages was
714     verified.  TM2 gives the number of seconds since the most recent
715     message was verified.
716
717 *** TOFU_STATS_SHORT <long_string>
718
719     Information about the TOFU binding for the signature.
720     Example: "15 signatures verified. 10 messages encrypted"
721
722 *** TOFU_STATS_LONG <long_string>
723
724     Information about the TOFU binding for the signature in verbose
725     format.  The LONG_STRING is percent escaped.
726     Example: 'Verified 9 messages signed by "Werner Koch
727     (dist sig)" in the past 3 minutes, 40 seconds.  The most
728     recent message was verified 4 seconds ago.'
729
730 *** PKA_TRUST_
731     This is is one:
732
733     - PKA_TRUST_GOOD <addr-spec>
734     - PKA_TRUST_BAD  <addr-spec>
735
736     Depending on the outcome of the PKA check one of the above status
737     codes is emitted in addition to a =TRUST_*= status.
738
739 ** Remote control
740 *** GET_BOOL, GET_LINE, GET_HIDDEN, GOT_IT
741
742     These status line are used with --command-fd for interactive
743     control of the process.
744
745 *** USERID_HINT <long main keyid> <string>
746     Give a hint about the user ID for a certain keyID.
747
748 *** NEED_PASSPHRASE <long keyid> <long main keyid> <keytype> <keylength>
749     Issued whenever a passphrase is needed.  KEYTYPE is the numerical
750     value of the public key algorithm or 0 if this is not applicable,
751     KEYLENGTH is the length of the key or 0 if it is not known (this
752     is currently always the case).
753
754 *** NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
755     Issued whenever a passphrase for symmetric encryption is needed.
756
757 *** NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
758     Issued whenever a PIN is requested to unlock a card.
759
760 *** MISSING_PASSPHRASE
761     No passphrase was supplied.  An application which encounters this
762     message may want to stop parsing immediately because the next
763     message will probably be a BAD_PASSPHRASE.  However, if the
764     application is a wrapper around the key edit menu functionality it
765     might not make sense to stop parsing but simply ignoring the
766     following BAD_PASSPHRASE.
767
768 *** BAD_PASSPHRASE <long keyid>
769     The supplied passphrase was wrong or not given.  In the latter
770     case you may have seen a MISSING_PASSPHRASE.
771
772 *** GOOD_PASSPHRASE
773     The supplied passphrase was good and the secret key material
774     is therefore usable.
775
776 ** Import/Export
777 *** IMPORT_CHECK <long keyid> <fingerprint> <user ID>
778     This status is emitted in interactive mode right before
779     the "import.okay" prompt.
780
781 *** IMPORTED   <long keyid>  <username>
782     The keyid and name of the signature just imported
783
784 *** IMPORT_OK  <reason> [<fingerprint>]
785     The key with the primary key's FINGERPRINT has been imported.
786     REASON flags are:
787
788     - 0 :: Not actually changed
789     - 1 :: Entirely new key.
790     - 2 :: New user IDs
791     - 4 :: New signatures
792     - 8 :: New subkeys
793     - 16 :: Contains private key.
794
795     The flags may be ORed.
796
797 *** IMPORT_PROBLEM <reason> [<fingerprint>]
798     Issued for each import failure.  Reason codes are:
799
800     - 0 :: No specific reason given.
801     - 1 :: Invalid Certificate.
802     - 2 :: Issuer Certificate missing.
803     - 3 :: Certificate Chain too long.
804     - 4 :: Error storing certificate.
805
806 *** IMPORT_RES <args>
807     Final statistics on import process (this is one long line). The
808     args are a list of unsigned numbers separated by white space:
809
810     - <count>
811     - <no_user_id>
812     - <imported>
813     - always 0 (formerly used for the number of RSA keys)
814     - <unchanged>
815     - <n_uids>
816     - <n_subk>
817     - <n_sigs>
818     - <n_revoc>
819     - <sec_read>
820     - <sec_imported>
821     - <sec_dups>
822     - <skipped_new_keys>
823     - <not_imported>
824     - <skipped_v3_keys>
825
826 *** EXPORTED  <fingerprint>
827     The key with <fingerprint> has been exported.  The fingerprint is
828     the fingerprint of the primary key even if the primary key has
829     been replaced by a stub key during secret key export.
830
831 *** EXPORT_RES <args>
832
833     Final statistics on export process (this is one long line). The
834     args are a list of unsigned numbers separated by white space:
835
836     - <count>
837     - <secret_count>
838     - <exported>
839
840
841 ** Smartcard related
842 *** CARDCTRL <what> [<serialno>]
843     This is used to control smartcard operations.  Defined values for
844     WHAT are:
845
846       - 1 :: Request insertion of a card.  Serialnumber may be given
847              to request a specific card.  Used by gpg 1.4 w/o
848              scdaemon
849       - 2 :: Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
850       - 3 :: Card with serialnumber detected
851       - 4 :: No card available
852       - 5 :: No card reader available
853       - 6 :: No card support available
854       - 7 :: Card is in termination state
855
856 *** SC_OP_FAILURE [<code>]
857     An operation on a smartcard definitely failed.  Currently there is
858     no indication of the actual error code, but application should be
859     prepared to later accept more arguments.  Defined values for
860     <code> are:
861
862       - 0 :: unspecified error (identically to a missing CODE)
863       - 1 :: canceled
864       - 2 :: bad PIN
865
866 *** SC_OP_SUCCESS
867     A smart card operaion succeeded.  This status is only printed for
868     certain operation and is mostly useful to check whether a PIN
869     change really worked.
870
871 ** Miscellaneous status codes
872 *** NODATA  <what>
873     No data has been found.  Codes for WHAT are:
874
875     - 1 :: No armored data.
876     - 2 :: Expected a packet but did not found one.
877     - 3 :: Invalid packet found, this may indicate a non OpenPGP
878            message.
879     - 4 :: Signature expected but not found
880
881     You may see more than one of these status lines.
882
883 *** UNEXPECTED <what>
884     Unexpected data has been encountered.  Codes for WHAT are:
885     - 0 :: Not further specified
886     - 1 :: Corrupted message structure
887
888 *** TRUNCATED <maxno>
889     The output was truncated to MAXNO items.  This status code is
890     issued for certain external requests.
891
892 *** ERROR <error location> <error code> [<more>]
893     This is a generic error status message, it might be followed by
894     error location specific data. <error code> and <error_location>
895     should not contain spaces.  The error code is a either a string
896     commencing with a letter or such a string prefixed with a
897     numerical error code and an underscore; e.g.: "151011327_EOF".
898 *** WARNING <location> <error code> [<text>]
899     This is a generic warning status message, it might be followed by
900     error location specific data. <error code> and <location>
901     should not contain spaces.  The error code is a either a string
902     commencing with a letter or such a string prefixed with a
903     numerical error code and an underscore; e.g.: "151011327_EOF".
904 *** SUCCESS [<location>]
905     Postive confirmation that an operation succeeded.  It is used
906     similar to ISO-C's EXIT_SUCCESS.  <location> is optional but if
907     given should not contain spaces.  Used only with a few commands.
908
909 *** FAILURE <location> <error_code>
910     This is the counterpart to SUCCESS and used to indicate a program
911     failure.  It is used similar to ISO-C's EXIT_FAILURE but allows to
912     convey more information, in particular an gpg-error error code.
913     That numerical error code may optionally have a suffix made of an
914     underscore and a string with an error symbol like "151011327_EOF".
915     A dash may be used instead of <location>.
916
917 *** BADARMOR
918     The ASCII armor is corrupted.  No arguments yet.
919
920 *** DELETE_PROBLEM <reason_code>
921     Deleting a key failed.  Reason codes are:
922     - 1 :: No such key
923     - 2 :: Must delete secret key first
924     - 3 :: Ambigious specification
925     - 4 :: Key is stored on a smartcard.
926
927 *** PROGRESS <what> <char> <cur> <total>
928     Used by the primegen and Public key functions to indicate
929     progress.  <char> is the character displayed with no --status-fd
930     enabled, with the linefeed replaced by an 'X'.  <cur> is the
931     current amount done and <total> is amount to be done; a <total> of
932     0 indicates that the total amount is not known. The condition
933       :       TOTAL && CUR == TOTAL
934     may be used to detect the end of an operation.
935
936     Well known values for WHAT are:
937
938            - pk_dsa   :: DSA key generation
939            - pk_elg   :: Elgamal key generation
940            - primegen :: Prime generation
941            - need_entropy :: Waiting for new entropy in the RNG
942            - tick :: Generic tick without any special meaning - useful
943                      for letting clients know that the server is still
944                      working.
945            - starting_agent :: A gpg-agent was started because it is not
946                                 running as a daemon.
947            - learncard :: Send by the agent and gpgsm while learing
948                           the data of a smartcard.
949            - card_busy :: A smartcard is still working
950
951 *** BACKUP_KEY_CREATED <fingerprint> <fname>
952     A backup of a key identified by <fingerprint> has been writte to
953     the file <fname>; <fname> is percent-escaped.
954
955 *** MOUNTPOINT <name>
956     <name> is a percent-plus escaped filename describing the
957     mountpoint for the current operation (e.g. used by "g13 --mount").
958     This may either be the specified mountpoint or one randomly
959     choosen by g13.
960
961 *** PINENTRY_LAUNCHED <pid>
962     This status line is emitted by gpg to notify a client that a
963     Pinentry has been launched.  <pid> is the PID of the Pinentry.  It
964     may be used to display a hint to the user but can't be used to
965     synchronize with Pinentry.  Note that there is also an Assuan
966     inquiry line with the same name used internally or, if enabled,
967     send to the client instead of this status line.  Such an inquiry
968     may be used to sync with Pinentry
969
970 ** Obsolete status codes
971 *** SIGEXPIRED
972     Removed on 2011-02-04.  This is deprecated in favor of KEYEXPIRED.
973 *** RSA_OR_IDEA
974     Obsolete.  This status message used to be emitted for requests to
975     use the IDEA or RSA algorithms.  It has been dropped from GnuPG
976     2.1 after the respective patents expired.
977 *** SHM_INFO, SHM_GET, SHM_GET_BOOL, SHM_GET_HIDDEN
978     These were used for the ancient shared memory based co-processing.
979 *** BEGIN_STREAM, END_STREAM
980     Used to issued by the experimental pipemode.
981
982
983 * Format of the --attribute-fd output
984
985   When --attribute-fd is set, during key listings (--list-keys,
986   --list-secret-keys) GnuPG dumps each attribute packet to the file
987   descriptor specified.  --attribute-fd is intended for use with
988   --status-fd as part of the required information is carried on the
989   ATTRIBUTE status tag (see above).
990
991   The contents of the attribute data is specified by RFC 4880.  For
992   convenience, here is the Photo ID format, as it is currently the
993   only attribute defined:
994
995   - Byte 0-1 :: The length of the image header.  Due to a historical
996                 accident (i.e. oops!) back in the NAI PGP days, this
997                 is a little-endian number.  Currently 16 (0x10 0x00).
998
999   - Byte 2 :: The image header version.  Currently 0x01.
1000
1001   - Byte 3 :: Encoding format.  0x01 == JPEG.
1002
1003   - Byte 4-15 :: Reserved, and currently unused.
1004
1005   All other data after this header is raw image (JPEG) data.
1006
1007
1008 * Layout of the TrustDB
1009
1010   The TrustDB is built from fixed length records, where the first byte
1011   describes the record type.  All numeric values are stored in network
1012   byte order.  The length of each record is 40 bytes.  The first
1013   record of the DB is always of type 1 and this is the only record of
1014   this type.
1015
1016   The record types: directory(2), key(3), uid(4), pref(5), sigrec(6),
1017   and shadow directory(8) are not anymore used by version 2 of the
1018   TrustDB.
1019
1020 ** Record type 0
1021
1022    Unused record or deleted, can be reused for any purpose.  Such
1023    records should in general not exist because deleted records are of
1024    type 254 and kept in a linked list.
1025
1026 ** Version info (RECTYPE_VER, 1)
1027
1028    Version information for this TrustDB.  This is always the first
1029    record of the DB and the only one of this type.
1030
1031    - 1 u8 :: Record type (value: 1).
1032    - 3 byte :: Magic value ("gpg")
1033    - 1 u8 :: TrustDB version (value: 2).
1034    - 1 u8 :: =marginals=. How many marginal trusted keys are required.
1035    - 1 u8 :: =completes=. How many completely trusted keys are
1036              required.
1037    - 1 u8 :: =max_cert_depth=.  How deep is the WoT evaluated.  Along
1038              with =marginals= and =completes=, this value is used to
1039              check whether the cached validity value from a [FIXME
1040              dir] record can be used.
1041    - 1 u8 :: =trust_model=
1042    - 1 u8 :: =min_cert_level=
1043    - 2 byte :: Not used
1044    - 1 u32 :: =created=. Timestamp of trustdb creation.
1045    - 1 u32 :: =nextcheck=. Timestamp of last modification which may
1046               affect the validity of keys in the trustdb.  This value
1047               is checked against the validity timestamp in the dir
1048               records.
1049    - 1 u32 :: =reserved=.  Not used.
1050    - 1 u32 :: =reserved2=. Not used.
1051    - 1 u32 :: =firstfree=. Number of the record with the head record
1052               of the RECTYPE_FREE linked list.
1053    - 1 u32 :: =reserved3=. Not used.
1054    - 1 u32 :: =trusthashtbl=. Record number of the trusthashtable.
1055
1056
1057 ** Hash table (RECTYPE_HTBL, 10)
1058
1059    Due to the fact that we use fingerprints to lookup keys, we can
1060    implement quick access by some simple hash methods, and avoid the
1061    overhead of gdbm.  A property of fingerprints is that they can be
1062    used directly as hash values.  What we use is a dynamic multilevel
1063    architecture, which combines hash tables, record lists, and linked
1064    lists.
1065
1066    This record is a hash table of 256 entries with the property that
1067    all these records are stored consecutively to make one big
1068    table. The hash value is simple the 1st, 2nd, ... byte of the
1069    fingerprint (depending on the indirection level).
1070
1071    - 1 u8 :: Record type (value: 10).
1072    - 1 u8 :: Reserved
1073    - n u32 :: =recnum=.  A table with the hash table items fitting into
1074               this record.  =n= depends on the record length:
1075               $n=(reclen-2)/4$ which yields 9 for oure current record
1076               length of 40 bytes.
1077
1078    The total number of hash table records to form the table is:
1079    $m=(256+n-1)/n$.  This is 29 for our record length of 40.
1080
1081    To look up a key we use the first byte of the fingerprint to get
1082    the recnum from this hash table and then look up the addressed
1083    record:
1084
1085    - If that record is another hash table, we use 2nd byte to index
1086      that hash table and so on;
1087    - if that record is a hash list, we walk all entries until we find
1088      a matching one; or
1089    - if that record is a key record, we compare the fingerprint to
1090      decide whether it is the requested key;
1091
1092
1093 ** Hash list (RECTYPE_HLST, 11)
1094
1095    See hash table above on how it is used.  It may also be used for
1096    other purposes.
1097
1098    - 1 u8 :: Record type (value: 11).
1099    - 1 u8 :: Reserved.
1100    - 1 u32 :: =next=.  Record number of the next hash list record or 0
1101               if none.
1102    - n u32 :: =rnum=.  Array with record numbers to values.  With
1103               $n=(reclen-5)/5$ and our record length of 40, n is 7.
1104
1105 ** Trust record (RECTYPE_TRUST, 12)
1106
1107    - 1 u8 :: Record type (value: 12).
1108    - 1 u8 :: Reserved.
1109    - 20 byte :: =fingerprint=.
1110    - 1 u8 :: =ownertrust=.
1111    - 1 u8 :: =depth=.
1112    - 1 u8 :: =min_ownertrust=.
1113    - 1 byte :: Not used.
1114    - 1 u32 :: =validlist=.
1115    - 10 byte :: Not used.
1116
1117 ** Validity record (RECTYPE_VALID, 13)
1118
1119    - 1 u8 :: Record type (value: 13).
1120    - 1 u8 :: Reserved.
1121    - 20 byte :: =namehash=.
1122    - 1 u8 :: =validity=
1123    - 1 u32 :: =next=.
1124    - 1 u8 :: =full_count=.
1125    - 1 u8 :: =marginal_count=.
1126    - 11 byte :: Not used.
1127
1128 ** Free record (RECTYPE_FREE, 254)
1129
1130    All these records form a linked list of unused records in the TrustDB.
1131
1132    - 1 u8 :: Record type (value: 254)
1133    - 1 u8 :: Reserved.
1134    - 1 u32 :: =next=.  Record number of the next rcord of this type.
1135               The record number to the head of this linked list is
1136               stored in the version info record.
1137
1138
1139 * GNU extensions to the S2K algorithm
1140
1141   1 octet  - S2K Usage: either 254 or 255.
1142   1 octet  - S2K Cipher Algo: 0
1143   1 octet  - S2K Specifier: 101
1144   3 octets - "GNU"
1145   1 octet  - GNU S2K Extension Number.
1146
1147   If such a GNU extension is used neither an IV nor any kind of
1148   checksum is used.  The defined GNU S2K Extension Numbers are:
1149
1150   - 1 :: Do not store the secret part at all.  No specific data
1151          follows.
1152
1153   - 2 :: A stub to access smartcards.  This data follows:
1154          - One octet with the length of the following serial number.
1155          - The serial number. Regardless of what the length octet
1156            indicates no more than 16 octets are stored.
1157
1158   Note that gpg stores the GNU S2K Extension Number internally as an
1159   S2K Specifier with an offset of 1000.
1160
1161
1162 * Keyserver helper message format
1163
1164   The keyserver may be contacted by a Unix Domain socket or via TCP.
1165
1166   The format of a request is:
1167 #+begin_example
1168   command-tag
1169   "Content-length:" digits
1170   CRLF
1171 #+end_example
1172
1173   Where command-tag is
1174
1175 #+begin_example
1176   NOOP
1177   GET <user-name>
1178   PUT
1179   DELETE <user-name>
1180 #+end_example
1181
1182 The format of a response is:
1183
1184 #+begin_example
1185   "GNUPG/1.0" status-code status-text
1186   "Content-length:" digits
1187   CRLF
1188 #+end_example
1189 followed by <digits> bytes of data
1190
1191 Status codes are:
1192
1193   - 1xx :: Informational - Request received, continuing process
1194
1195   - 2xx :: Success - The action was successfully received, understood,
1196            and accepted
1197
1198   - 4xx :: Client Error - The request contains bad syntax or cannot be
1199            fulfilled
1200
1201   - 5xx :: Server Error - The server failed to fulfill an apparently
1202            valid request
1203
1204
1205 * Object identifiers
1206
1207   OIDs below the GnuPG arc:
1208
1209 #+begin_example
1210   1.3.6.1.4.1.11591.2          GnuPG
1211   1.3.6.1.4.1.11591.2.1          notation
1212   1.3.6.1.4.1.11591.2.1.1          pkaAddress
1213   1.3.6.1.4.1.11591.2.2          X.509 extensions
1214   1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
1215   1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
1216   1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
1217 #+end_example
1218
1219
1220
1221 * Miscellaneous notes
1222
1223 ** v3 fingerprints
1224    For packet version 3 we calculate the keyids this way:
1225     - RSA :: Low 64 bits of n
1226     - ELGAMAL :: Build a v3 pubkey packet (with CTB 0x99) and
1227                  calculate a RMD160 hash value from it. This is used
1228                  as the fingerprint and the low 64 bits are the keyid.
1229
1230 ** Simplified revocation certificates
1231   Revocation certificates consist only of the signature packet;
1232   "--import" knows how to handle this.  The rationale behind it is to
1233   keep them small.
1234
1235 ** Documentation on HKP (the http keyserver protocol):
1236
1237    A minimalistic HTTP server on port 11371 recognizes a GET for
1238    /pks/lookup.  The standard http URL encoded query parameters are
1239    this (always key=value):
1240
1241    - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1242      pgp -kxa)
1243
1244    - search=<stringlist>. This is a list of words that must occur in the key.
1245      The words are delimited with space, points, @ and so on. The delimiters
1246      are not searched for and the order of the words doesn't matter (but see
1247      next option).
1248
1249    - exact=on. This switch tells the hkp server to only report exact matching
1250      keys back. In this case the order and the "delimiters" are important.
1251
1252    - fingerprint=on. Also reports the fingerprints when used with 'index' or
1253      'vindex'
1254
1255    The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1256    keys.
1257
1258
1259    A better way to do this would be a request like:
1260
1261       /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1262
1263    This can be implemented using Hurd's translator mechanism.
1264    However, I think the whole key server stuff has to be re-thought;
1265    I have some ideas and probably create a white paper.
1266 ** Algorithm names for the "keygen.algo" prompt
1267
1268   When using a --command-fd controlled key generation or "addkey"
1269   there is way to know the number to enter on the "keygen.algo"
1270   prompt.  The displayed numbers are for human reception and may
1271   change with releases.  To provide a stable way to enter a desired
1272   algorithm choice the prompt also accepts predefined names for the
1273   algorithms, which will not change.
1274
1275    | Name    | No | Description                     |
1276    |---------+----+---------------------------------|
1277    | rsa+rsa |  1 | RSA and RSA (default)           |
1278    | dsa+elg |  2 | DSA and Elgamal                 |
1279    | dsa     |  3 | DSA (sign only)                 |
1280    | rsa/s   |  4 | RSA (sign only)                 |
1281    | elg     |  5 | Elgamal (encrypt only)          |
1282    | rsa/e   |  6 | RSA (encrypt only)              |
1283    | dsa/*   |  7 | DSA (set your own capabilities) |
1284    | rsa/*   |  8 | RSA (set your own capabilities) |
1285    | ecc+ecc |  9 | ECC and ECC                     |
1286    | ecc/s   | 10 | ECC (sign only)                 |
1287    | ecc/*   | 11 | ECC (set your own capabilities) |
1288    | ecc/e   | 12 | ECC (encrypt only)              |
1289    | keygrip | 13 | Existing key                    |
1290
1291    If one of the "foo/*" names are used a "keygen.flags" prompt needs
1292    to be answered as well.  Instead of toggling the predefined flags,
1293    it is also possible to set them direct: Use a "=" character
1294    directly followed by a comination of "a" (for authentication), "s"
1295    (for signing), or "c" (for certification).