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