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