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