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