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