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