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