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