gpg: Fix bug with deeply nested compressed packets.
[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   The format is a based on colon separated record, each recods starts
19   with a tag string and extends to the end of the line.  Here is an
20   example:
21 #+begin_example
22 $ gpg --with-colons --list-keys \
23       --with-fingerprint --with-fingerprint wk@gnupg.org
24 pub:f:1024:17:6C7EE1B8621CC013:899817715:1055898235::m:::scESC:
25 fpr:::::::::ECAF7590EB3443B5C7CF3ACB6C7EE1B8621CC013:
26 uid:f::::::::Werner Koch <wk@g10code.com>:
27 uid:f::::::::Werner Koch <wk@gnupg.org>:
28 sub:f:1536:16:06AD222CADF6A6E1:919537416:1036177416:::::e:
29 fpr:::::::::CF8BCC4B18DE08FCD8A1615906AD222CADF6A6E1:
30 sub:r:1536:20:5CE086B5B5A18FF4:899817788:1025961788:::::esc:
31 fpr:::::::::AB059359A3B81F410FCFF97F5CE086B5B5A18FF4:
32 #+end_example
33
34 The double =--with-fingerprint= prints the fingerprint for the subkeys
35 too.  Old versions of gpg used a lighly different format and required
36 the use of the option =--fixed-list-mode= to conform to format
37 described here.
38
39 ** Description of the fields
40 *** Field 1 - Type of record
41
42     - pub :: Public key
43     - crt :: X.509 certificate
44     - crs :: X.509 certificate and private key available
45     - sub :: Subkey (secondary key)
46     - sec :: Secret key
47     - ssb :: Secret subkey (secondary key)
48     - uid :: User id (only field 10 is used).
49     - uat :: User attribute (same as user id except for field 10).
50     - sig :: Signature
51     - rev :: Revocation signature
52     - fpr :: Fingerprint (fingerprint is in field 10)
53     - pkd :: Public key data [*]
54     - grp :: Keygrip
55     - rvk :: Revocation key
56     - tru :: Trust database information [*]
57     - spk :: Signature subpacket [*]
58     - cfg :: Configuration data [*]
59
60     Records marked with an asterisk are described at [[*Special%20field%20formats][*Special fields]].
61
62 *** Field 2 - Validity
63
64     This is a letter describing the computed validity of a key.
65     Currently this is a single letter, but be prepared that additional
66     information may follow in some future versions. Note that GnuPG <
67     2.1 does not set this field for secret key listings.
68
69     - o :: Unknown (this key is new to the system)
70     - i :: The key is invalid (e.g. due to a missing self-signature)
71     - d :: The key has been disabled
72            (deprecated - use the 'D' in field 12 instead)
73     - r :: The key has been revoked
74     - e :: The key has expired
75     - - :: Unknown validity (i.e. no value assigned)
76     - q :: Undefined validity.  '-' and 'q' may safely be treated as
77            the same value for most purposes
78     - n :: The key is not valid
79     - m :: The key is marginal valid.
80     - f :: The key is fully valid
81     - u :: The key is ultimately valid.  This often means that the
82            secret key is available, but any key may be marked as
83            ultimately valid.
84     - w :: The key has a well known private part.
85     - s :: The key has special validity.  This means that it might be
86            self-signed and expected to be used in the STEED sytem.
87
88     If the validity information is given for a UID or UAT record, it
89     describes the validity calculated based on this user ID.  If given
90     for a key record it describes the validity taken from the best
91     rated user ID.
92
93     For X.509 certificates a 'u' is used for a trusted root
94     certificate (i.e. for the trust anchor) and an 'f' for all other
95     valid certificates.
96
97 *** Field 3 - Key length
98
99     The length of key in bits.
100
101 *** Field 4 - Public key algorithm
102
103     The values here are those from the OpenPGP specs or if they are
104     greather than 255 the algorithm ids as used by Libgcrypt.
105
106 *** Field 5 - KeyID
107
108     This is the 64 bit keyid as specified by OpenPGP and the last 64
109     bit of the SHA-1 fingerprint of an X.509 certifciate.
110
111 *** Field 6 - Creation date
112
113     The creation date of the key is given in UTC.  For UID and UAT
114     records, this is used for the self-signature date.  Note that the
115     date is usally printed in seconds since epoch, however, we are
116     migrating to an ISO 8601 format (e.g. "19660205T091500").  This is
117     currently only relevant for X.509.  A simple way to detect the new
118     format is to scan for the 'T'.  Note that old versions of gpg
119     without using the =--fixed-list-mode= option used a "yyyy-mm-tt"
120     format.
121
122 *** Field 7 - Expiration date
123
124     Key or UID/UAT expiration date or empty if it does not expire.
125
126 *** Field 8 - Certificate S/N, UID hash, trust signature info
127
128     Used for serial number in crt records.  For UID and UAT records,
129     this is a hash of the user ID contents used to represent that
130     exact user ID.  For trust signatures, this is the trust depth
131     seperated by the trust value by a space.
132
133 *** Field 9 -  Ownertrust
134
135     This is only used on primary keys.  This is a single letter, but
136     be prepared that additional information may follow in future
137     versions.  For trust signatures with a regular expression, this is
138     the regular expression value, quoted as in field 10.
139
140 *** Field 10 - User-ID
141     The value is quoted like a C string to avoid control characters
142     (the colon is quoted =\x3a=).  For a "pub" record this field is
143     not used on --fixed-list-mode.  A UAT record puts the attribute
144     subpacket count here, a space, and then the total attribute
145     subpacket size.  In gpgsm the issuer name comes here.  A FPR
146     record stores the fingerprint here.  The fingerprint of a
147     revocation key is stored here.
148 *** Field 11 - Signature class
149
150     Signature class as per RFC-4880.  This is a 2 digit hexnumber
151     followed by either the letter 'x' for an exportable signature or
152     the letter 'l' for a local-only signature.  The class byte of an
153     revocation key is also given here, 'x' and 'l' is used the same
154     way.  This field if not used for X.509.
155
156 *** Field 12 - Key capabilities
157
158     The defined capabilities are:
159
160     - e :: Encrypt
161     - s :: Sign
162     - c :: Certify
163     - a :: Authentication
164     - ? :: Unknown capability
165
166     A key may have any combination of them in any order.  In addition
167     to these letters, the primary key has uppercase versions of the
168     letters to denote the _usable_ capabilities of the entire key, and
169     a potential letter 'D' to indicate a disabled key.
170
171 *** Field 13 - Issuer certificate fingerprint or other info
172
173     Used in FPR records for S/MIME keys to store the fingerprint of
174     the issuer certificate.  This is useful to build the certificate
175     path based on certificates stored in the local key database it is
176     only filled if the issuer certificate is available. The root has
177     been reached if this is the same string as the fingerprint. The
178     advantage of using this value is that it is guaranteed to have
179     been been build by the same lookup algorithm as gpgsm uses.
180
181     For "uid" records this field lists the preferences in the same way
182     gpg's --edit-key menu does.
183
184     For "sig" records, this is the fingerprint of the key that issued
185     the signature.  Note that this is only filled in if the signature
186     verified correctly.  Note also that for various technical reasons,
187     this fingerprint is only available if --no-sig-cache is used.
188
189 *** Field 14 - Flag field
190
191     Flag field used in the --edit menu output
192
193 *** Field 15 - S/N of a token
194
195     Used in sec/sbb to print the serial number of a token (internal
196     protect mode 1002) or a '#' if that key is a simple stub (internal
197     protect mode 1001)
198
199 *** Field 16 - Hash algorithm
200
201     For sig records, this is the used hash algorithm.  For example:
202     2 = SHA-1, 8 = SHA-256.
203
204 ** Special fields
205
206 *** PKD - Public key data
207
208     If field 1 has the tag "pkd", a listing looks like this:
209 #+begin_example
210 pkd:0:1024:B665B1435F4C2 .... FF26ABB:
211     !  !   !-- the value
212     !  !------ for information number of bits in the value
213     !--------- index (eg. DSA goes from 0 to 3: p,q,g,y)
214 #+end_example
215
216 *** TRU - Trust database information
217     Example for a "tru" trust base record:
218 #+begin_example
219     tru:o:0:1166697654:1:3:1:5
220 #+end_example
221
222     - Field 2 :: Reason for staleness of trust.  If this field is
223                  empty, then the trustdb is not stale.  This field may
224                  have multiple flags in it:
225
226                  - o :: Trustdb is old
227                  - t :: Trustdb was built with a different trust model
228                         than the one we are using now.
229
230     - Field 3 :: Trust model
231
232                  - 0 :: Classic trust model, as used in PGP 2.x.
233                  - 1 :: PGP trust model, as used in PGP 6 and later.
234                         This is the same as the classic trust model,
235                         except for the addition of trust signatures.
236
237                  GnuPG before version 1.4 used the classic trust model
238                  by default. GnuPG 1.4 and later uses the PGP trust
239                  model by default.
240
241     - Field 4 :: Date trustdb was created in seconds since Epoch.
242     - Field 5 :: Date trustdb will expire in seconds since Epoch.
243     - Field 6 :: Number of marginally trusted users to introduce a new
244                  key signer (gpg's option --marginals-needed).
245     - Field 7 :: Number of completely trusted users to introduce a new
246                  key signer.  (gpg's option --completes-needed)
247
248     - Field 8 :: Maximum depth of a certification chain. (gpg's option
249                  --max-cert-depth)
250
251 *** SPK - Signature subpacket records
252
253     - Field 2 :: Subpacket number as per RFC-4880 and later.
254     - Field 3 :: Flags in hex.  Currently the only two bits assigned
255                  are 1, to indicate that the subpacket came from the
256                  hashed part of the signature, and 2, to indicate the
257                  subpacket was marked critical.
258     - Field 4 :: Length of the subpacket.  Note that this is the
259                  length of the subpacket, and not the length of field
260                  5 below.  Due to the need for %-encoding, the length
261                  of field 5 may be up to 3x this value.
262     - Field 5 :: The subpacket data.  Printable ASCII is shown as
263                  ASCII, but other values are rendered as %XX where XX
264                  is the hex value for the byte.
265
266 *** CFG - Configuration data
267
268     --list-config outputs information about the GnuPG configuration
269     for the benefit of frontends or other programs that call GnuPG.
270     There are several list-config items, all colon delimited like the
271     rest of the --with-colons output.  The first field is always "cfg"
272     to indicate configuration information.  The second field is one of
273     (with examples):
274
275     - version :: The third field contains the version of GnuPG.
276
277                  : cfg:version:1.3.5
278
279     - pubkey :: The third field contains the public key algorithms
280                 this version of GnuPG supports, separated by
281                 semicolons.  The algorithm numbers are as specified in
282                 RFC-4880.  Note that in contrast to the --status-fd
283                 interface these are _not_ the Libgcrypt identifiers.
284
285                  : cfg:pubkey:1;2;3;16;17
286
287     - cipher :: The third field contains the symmetric ciphers this
288                 version of GnuPG supports, separated by semicolons.
289                 The cipher numbers are as specified in RFC-4880.
290
291                  : cfg:cipher:2;3;4;7;8;9;10
292
293     - digest :: The third field contains the digest (hash) algorithms
294                 this version of GnuPG supports, separated by
295                 semicolons.  The digest numbers are as specified in
296                 RFC-4880.
297
298                  : cfg:digest:1;2;3;8;9;10
299
300     - compress :: The third field contains the compression algorithms
301                   this version of GnuPG supports, separated by
302                   semicolons.  The algorithm numbers are as specified
303                   in RFC-4880.
304
305                  : cfg:compress:0;1;2;3
306
307     - group :: The third field contains the name of the group, and the
308                fourth field contains the values that the group expands
309                to, separated by semicolons.
310
311                For example, a group of:
312                  : group mynames = paige 0x12345678 joe patti
313                would result in:
314                  : cfg:group:mynames:patti;joe;0x12345678;paige
315
316
317 * Format of the --status-fd output
318
319   Every line is prefixed with "[GNUPG:] ", followed by a keyword with
320   the type of the status line and some arguments depending on the type
321   (maybe none); an application should always be prepared to see more
322   arguments in future versions.
323
324 ** General status codes
325 *** NEWSIG
326     May be issued right before a signature verification starts.  This
327     is useful to define a context for parsing ERROR status messages.
328     No arguments are currently defined.
329
330 *** GOODSIG  <long_keyid_or_fpr>  <username>
331     The signature with the keyid is good.  For each signature only one
332     of the codes GOODSIG, BADSIG, EXPSIG, EXPKEYSIG, REVKEYSIG or
333     ERRSIG will be emitted.  In the past they were used as a marker
334     for a new signature; new code should use the NEWSIG status
335     instead.  The username is the primary one encoded in UTF-8 and %XX
336     escaped. The fingerprint may be used instead of the long keyid if
337     it is available.  This is the case with CMS and might eventually
338     also be available for OpenPGP.
339
340 *** EXPSIG  <long_keyid_or_fpr>  <username>
341     The signature with the keyid is good, but the signature is
342     expired. The username is the primary one encoded in UTF-8 and %XX
343     escaped. The fingerprint may be used instead of the long keyid if
344     it is available.  This is the case with CMS and might eventually
345     also be available for OpenPGP.
346
347 *** EXPKEYSIG  <long_keyid_or_fpr> <username>
348     The signature with the keyid is good, but the signature was made
349     by an expired key. The username is the primary one encoded in
350     UTF-8 and %XX escaped.  The fingerprint may be used instead of the
351     long keyid if it is available.  This is the case with CMS and
352     might eventually also be available for OpenPGP.
353
354 *** REVKEYSIG  <long_keyid_or_fpr>  <username>
355     The signature with the keyid is good, but the signature was made
356     by a revoked key. The username is the primary one encoded in UTF-8
357     and %XX escaped. The fingerprint may be used instead of the long
358     keyid if it is available.  This is the case with CMS and might
359     eventually also beƱ available for OpenPGP.
360
361 *** BADSIG  <long_keyid_or_fpr>  <username>
362     The signature with the keyid has not been verified okay.  The
363     username is the primary one encoded in UTF-8 and %XX escaped. The
364     fingerprint may be used instead of the long keyid if it is
365     available.  This is the case with CMS and might eventually also be
366     available for OpenPGP.
367
368 *** ERRSIG  <keyid>  <pkalgo> <hashalgo> <sig_class> <time> <rc>
369     It was not possible to check the signature.  This may be caused by
370     a missing public key or an unsupported algorithm.  A RC of 4
371     indicates unknown algorithm, a 9 indicates a missing public
372     key. The other fields give more information about this signature.
373     sig_class is a 2 byte hex-value.  The fingerprint may be used
374     instead of the keyid if it is available.  This is the case with
375     gpgsm and might eventually also be available for OpenPGP.
376
377     Note, that TIME may either be the number of seconds since Epoch or
378     the letter 'T'.
379     an ISO 8601 string.  The latter can be detected by the presence of
380
381 *** VALIDSIG <args>
382
383     The args are:
384
385     - <fingerprint_in_hex>
386     - <sig_creation_date>
387     - <sig-timestamp>
388     - <expire-timestamp>
389     - <sig-version>
390     - <reserved>
391     - <pubkey-algo>
392     - <hash-algo>
393     - <sig-class>
394     - [ <primary-key-fpr> ]
395
396     This status indicates that the signature is good. This is the same
397     as GOODSIG but has the fingerprint as the argument. Both status
398     lines are emitted for a good signature.  All arguments here are on
399     one long line.  sig-timestamp is the signature creation time in
400     seconds after the epoch. expire-timestamp is the signature
401     expiration time in seconds after the epoch (zero means "does not
402     expire"). sig-version, pubkey-algo, hash-algo, and sig-class (a
403     2-byte hex value) are all straight from the signature packet.
404     PRIMARY-KEY-FPR is the fingerprint of the primary key or identical
405     to the first argument.  This is useful to get back to the primary
406     key without running gpg again for this purpose.
407
408     The primary-key-fpr parameter is used for OpenPGP and not
409     class is not defined for CMS and currently set to 0 and 00.
410     available for CMS signatures.  The sig-version as well as the sig
411
412     Note, that *-TIMESTAMP may either be a number of seconds since
413     Epoch or an ISO 8601 string which can be detected by the presence
414     of the letter 'T'.
415
416 *** SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
417     This is emitted only for signatures of class 0 or 1 which have
418     been verified okay.  The string is a signature id and may be used
419     in applications to detect replay attacks of signed messages.  Note
420     that only DLP algorithms give unique ids - others may yield
421     duplicated ones when they have been created in the same second.
422
423     Note, that SIG-TIMESTAMP may either be a number of seconds since
424     Epoch or an ISO 8601 string which can be detected by the presence
425     of the letter 'T'.
426
427 *** ENC_TO  <long_keyid>  <keytype>  <keylength>
428     The message is encrypted to this LONG_KEYID.  KEYTYPE is the
429     numerical value of the public key algorithm or 0 if it is not
430     known, KEYLENGTH is the length of the key or 0 if it is not known
431     (which is currently always the case).  Gpg prints this line
432     always; Gpgsm only if it knows the certificate.
433
434 *** BEGIN_DECRYPTION
435     Mark the start of the actual decryption process.  This is also
436     emitted when in --list-only mode.
437 *** END_DECRYPTION
438     Mark the end of the actual decryption process.  This are also
439     emitted when in --list-only mode.
440 *** DECRYPTION_INFO <mdc_method> <sym_algo>
441     Print information about the symmetric encryption algorithm and the
442     MDC method.  This will be emitted even if the decryption fails.
443
444 *** DECRYPTION_FAILED
445     The symmetric decryption failed - one reason could be a wrong
446     passphrase for a symmetrical encrypted message.
447
448 *** DECRYPTION_OKAY
449     The decryption process succeeded.  This means, that either the
450     correct secret key has been used or the correct passphrase for a
451     conventional encrypted message was given.  The program itself may
452     return an errorcode because it may not be possible to verify a
453     signature for some reasons.
454
455 *** SESSION_KEY <algo>:<hexdigits>
456     The session key used to decrypt the message.  This message will
457     only be emitted when the special option --show-session-key is
458     used.  The format is suitable to be passed to the option
459     --override-session-key
460
461 *** BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
462     Mark the start of the actual encryption process.
463
464 *** END_ENCRYPTION
465     Mark the end of the actual encryption process.
466
467 *** FILE_START <what> <filename>
468     Start processing a file <filename>.  <what> indicates the performed
469     operation:
470     - 1 :: verify
471     - 2 :: encrypt
472     - 3 :: decrypt
473
474 *** FILE_DONE
475     Marks the end of a file processing which has been started
476     by FILE_START.
477
478 *** BEGIN_SIGNING
479     Mark the start of the actual signing process. This may be used as
480     an indication that all requested secret keys are ready for use.
481
482 *** ALREADY_SIGNED <long-keyid>
483     Warning: This is experimental and might be removed at any time.
484
485 *** SIG_CREATED <type> <pk_algo> <hash_algo> <class> <timestamp> <keyfpr>
486     A signature has been created using these parameters.
487     Values for type <type> are:
488       - D :: detached
489       - C :: cleartext
490       - S :: standard
491     (only the first character should be checked)
492
493     <class> are 2 hex digits with the OpenPGP signature class.
494
495     Note, that TIMESTAMP may either be a number of seconds since Epoch
496     or an ISO 8601 string which can be detected by the presence of the
497     letter 'T'.
498
499 *** NOTATION_
500     There are actually two related status codes to convey notation
501     data:
502
503     - NOTATION_NAME <name>
504     - NOTATION_DATA <string>
505
506     <name> and <string> are %XX escaped; the data may be split among
507     several NOTATION_DATA lines.
508
509 *** POLICY_URL <string>
510     Note that URL in <string> is %XX escaped.
511
512 *** PLAINTEXT <format> <timestamp> <filename>
513     This indicates the format of the plaintext that is about to be
514     written.  The format is a 1 byte hex code that shows the format of
515     the plaintext: 62 ('b') is binary data, 74 ('t') is text data with
516     no character set specified, and 75 ('u') is text data encoded in
517     the UTF-8 character set.  The timestamp is in seconds since the
518     epoch.  If a filename is available it gets printed as the third
519     argument, percent-escaped as usual.
520
521 *** PLAINTEXT_LENGTH <length>
522     This indicates the length of the plaintext that is about to be
523     written.  Note that if the plaintext packet has partial length
524     encoding it is not possible to know the length ahead of time.  In
525     that case, this status tag does not appear.
526
527 *** ATTRIBUTE <arguments>
528     The list or argemnts are:
529     - <fpr>
530     - <octets>
531     - <type>
532     - <index>
533     - <count>
534     - <timestamp>
535     - <expiredate>
536     - <flags>
537
538     This is one long line issued for each attribute subpacket when an
539     attribute packet is seen during key listing.  <fpr> is the
540     fingerprint of the key.  <octets> is the length of the attribute
541     subpacket.  <type> is the attribute type (e.g. 1 for an image).
542     <index> and <count> indicate that this is the N-th indexed
543     subpacket of count total subpackets in this attribute packet.
544     <timestamp> and <expiredate> are from the self-signature on the
545     attribute packet.  If the attribute packet does not have a valid
546     self-signature, then the timestamp is 0.  <flags> are a bitwise OR
547     of:
548     - 0x01 :: this attribute packet is a primary uid
549     - 0x02 :: this attribute packet is revoked
550     - 0x04 :: this attribute packet is expired
551
552 *** SIG_SUBPACKET <type> <flags> <len> <data>
553     This indicates that a signature subpacket was seen.  The format is
554     the same as the "spk" record above.
555
556 ** Key related
557 *** INV_RECP, INV_SGNR
558     The two similar status codes:
559
560     - INV_RECP <reason> <requested_recipient>
561     - INV_SGNR <reason> <requested_sender>
562
563     are issued for each unusable recipient/sender. The reasons codes
564     currently in use are:
565
566        -  0 :: No specific reason given
567        -  1 :: Not Found
568        -  2 :: Ambigious specification
569        -  3 :: Wrong key usage
570        -  4 :: Key revoked
571        -  5 :: Key expired
572        -  6 :: No CRL known
573        -  7 :: CRL too old
574        -  8 :: Policy mismatch
575        -  9 :: Not a secret key
576        - 10 :: Key not trusted
577        - 11 :: Missing certificate
578        - 12 :: Missing issuer certificate
579
580     Note that for historical reasons the INV_RECP status is also used
581     for gpgsm's SIGNER command where it relates to signer's of course.
582     Newer GnuPG versions are using INV_SGNR; applications should
583     ignore the INV_RECP during the sender's command processing once
584     they have seen an INV_SGNR.  Different codes are used so that they
585     can be distinguish while doing an encrypt+sign operation.
586 *** NO_RECP <reserved>
587     Issued if no recipients are usable.
588
589 *** NO_SGNR <reserved>
590     Issued if no senders are usable.
591
592 *** KEYEXPIRED <expire-timestamp>
593     The key has expired.  expire-timestamp is the expiration time in
594     seconds since Epoch.  This status line is not very useful because
595     it will also be emitted for expired subkeys even if this subkey is
596     not used.  To check whether a key used to sign a message has
597     expired, the EXPKEYSIG status line is to be used.
598
599     Note, that the TIMESTAMP may either be a number of seconds since
600     Epoch or an ISO 8601 string which can be detected by the presence
601     of the letter 'T'.
602
603 *** KEYREVOKED
604     The used key has been revoked by its owner.  No arguments yet.
605
606 *** NO_PUBKEY  <long keyid>
607     The public key is not available
608
609 *** NO_SECKEY  <long keyid>
610     The secret key is not available
611
612 *** KEY_CREATED <type> <fingerprint> [<handle>]
613     A key has been created.  Values for <type> are:
614       - B :: primary and subkey
615       - P :: primary
616       - S :: subkey
617     The fingerprint is one of the primary key for type B and P and the
618     one of the subkey for S.  Handle is an arbitrary non-whitespace
619     string used to match key parameters from batch key creation run.
620
621 *** KEY_NOT_CREATED [<handle>]
622     The key from batch run has not been created due to errors.
623
624 *** TRUST_
625     These are several similar status codes:
626
627     - TRUST_UNDEFINED <error_token>
628     - TRUST_NEVER     <error_token>
629     - TRUST_MARGINAL  [0  [<validation_model>]]
630     - TRUST_FULLY     [0  [<validation_model>]]
631     - TRUST_ULTIMATE  [0  [<validation_model>]]
632
633     For good signatures one of these status lines are emitted to
634     indicate the validity of the key used to create the signature.
635     The error token values are currently only emitted by gpgsm.
636
637     VALIDATION_MODEL describes the algorithm used to check the
638     validity of the key.  The defaults are the standard Web of Trust
639     model for gpg and the the standard X.509 model for gpgsm.  The
640     defined values are
641
642        - pgp   :: The standard PGP WoT.
643        - shell :: The standard X.509 model.
644        - chain :: The chain model.
645        - steed :: The STEED model.
646
647     Note that the term =TRUST_= in the status names is used for
648     historic reasons; we now speak of validity.
649
650 *** PKA_TRUST_
651     This is is one:
652
653     - PKA_TRUST_GOOD <mailbox>
654     - PKA_TRUST_BAD  <mailbox>
655
656     Depending on the outcome of the PKA check one of the above status
657     codes is emitted in addition to a =TRUST_*= status.
658
659 ** Remote control
660 *** GET_BOOL, GET_LINE, GET_HIDDEN, GOT_IT
661
662     These status line are used with --command-fd for interactive
663     control of the process.
664
665 *** USERID_HINT <long main keyid> <string>
666     Give a hint about the user ID for a certain keyID.
667
668 *** NEED_PASSPHRASE <long keyid> <long main keyid> <keytype> <keylength>
669     Issued whenever a passphrase is needed.  KEYTYPE is the numerical
670     value of the public key algorithm or 0 if this is not applicable,
671     KEYLENGTH is the length of the key or 0 if it is not known (this
672     is currently always the case).
673
674 *** NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
675     Issued whenever a passphrase for symmetric encryption is needed.
676
677 *** NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
678     Issued whenever a PIN is requested to unlock a card.
679
680 *** MISSING_PASSPHRASE
681     No passphrase was supplied.  An application which encounters this
682     message may want to stop parsing immediately because the next
683     message will probably be a BAD_PASSPHRASE.  However, if the
684     application is a wrapper around the key edit menu functionality it
685     might not make sense to stop parsing but simply ignoring the
686     following BAD_PASSPHRASE.
687
688 *** BAD_PASSPHRASE <long keyid>
689     The supplied passphrase was wrong or not given.  In the latter
690     case you may have seen a MISSING_PASSPHRASE.
691
692 *** GOOD_PASSPHRASE
693     The supplied passphrase was good and the secret key material
694     is therefore usable.
695
696 ** Import/Export
697 *** IMPORT_CHECK <long keyid> <fingerprint> <user ID>
698     This status is emitted in interactive mode right before
699     the "import.okay" prompt.
700
701 *** IMPORTED   <long keyid>  <username>
702     The keyid and name of the signature just imported
703
704 *** IMPORT_OK  <reason> [<fingerprint>]
705     The key with the primary key's FINGERPRINT has been imported.
706     REASON flags are:
707
708     - 0 :: Not actually changed
709     - 1 :: Entirely new key.
710     - 2 :: New user IDs
711     - 4 :: New signatures
712     - 8 :: New subkeys
713     - 16 :: Contains private key.
714
715     The flags may be ORed.
716
717 *** IMPORT_PROBLEM <reason> [<fingerprint>]
718     Issued for each import failure.  Reason codes are:
719
720     - 0 :: No specific reason given.
721     - 1 :: Invalid Certificate.
722     - 2 :: Issuer Certificate missing.
723     - 3 :: Certificate Chain too long.
724     - 4 :: Error storing certificate.
725
726 *** IMPORT_RES <args>
727     Final statistics on import process (this is one long line). The
728     args are a list of unsigned numbers separated by white space:
729
730     - <count>
731     - <no_user_id>
732     - <imported>
733     - <imported_rsa>
734     - <unchanged>
735     - <n_uids>
736     - <n_subk>
737     - <n_sigs>
738     - <n_revoc>
739     - <sec_read>
740     - <sec_imported>
741     - <sec_dups>
742     - <skipped_new_keys>
743     - <not_imported>
744
745 ** Smartcard related
746 *** CARDCTRL <what> [<serialno>]
747     This is used to control smartcard operations.  Defined values for
748     WHAT are:
749
750       - 1 :: Request insertion of a card.  Serialnumber may be given
751              to request a specific card.  Used by gpg 1.4 w/o
752              scdaemon
753       - 2 :: Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
754       - 3 :: Card with serialnumber detected
755       - 4 :: No card available
756       - 5 :: No card reader available
757       - 6 :: No card support available
758
759 *** SC_OP_FAILURE [<code>]
760     An operation on a smartcard definitely failed.  Currently there is
761     no indication of the actual error code, but application should be
762     prepared to later accept more arguments.  Defined values for
763     <code> are:
764
765       - 0 :: unspecified error (identically to a missing CODE)
766       - 1 :: canceled
767       - 2 :: bad PIN
768
769 *** SC_OP_SUCCESS
770     A smart card operaion succeeded.  This status is only printed for
771     certain operation and is mostly useful to check whether a PIN
772     change really worked.
773
774 ** Miscellaneous status codes
775 *** NODATA  <what>
776     No data has been found.  Codes for WHAT are:
777
778     - 1 :: No armored data.
779     - 2 :: Expected a packet but did not found one.
780     - 3 :: Invalid packet found, this may indicate a non OpenPGP
781            message.
782     - 4 :: Signature expected but not found
783
784     You may see more than one of these status lines.
785
786 *** UNEXPECTED <what>
787     Unexpected data has been encountered.  Codes for WHAT are:
788     - 0 :: Not further specified
789     - 1 :: Corrupted message structure
790
791 *** TRUNCATED <maxno>
792     The output was truncated to MAXNO items.  This status code is
793     issued for certain external requests.
794
795 *** ERROR <error location> <error code> [<more>]
796     This is a generic error status message, it might be followed by
797     error location specific data. <error code> and <error_location>
798     should not contain spaces.  The error code is a either a string
799     commencing with a letter or such a string prefixed with a
800     numerical error code and an underscore; e.g.: "151011327_EOF".
801
802 *** SUCCESS [<location>]
803     Postive confirimation that an operation succeeded.  <location> is
804     optional but if given should not contain spaces.  Used only with a
805     few commands.
806
807 *** BADARMOR
808     The ASCII armor is corrupted.  No arguments yet.
809
810 *** DELETE_PROBLEM <reason_code>
811     Deleting a key failed.  Reason codes are:
812     - 1 :: No such key
813     - 2 :: Must delete secret key first
814     - 3 :: Ambigious specification
815
816 *** PROGRESS <what> <char> <cur> <total>
817     Used by the primegen and Public key functions to indicate
818     progress.  <char> is the character displayed with no --status-fd
819     enabled, with the linefeed replaced by an 'X'.  <cur> is the
820     current amount done and <total> is amount to be done; a <total> of
821     0 indicates that the total amount is not known. The condition
822       :       TOTAL && CUR == TOTAL
823     may be used to detect the end of an operation.
824
825     Well known values for WHAT are:
826
827            - pk_dsa   :: DSA key generation
828            - pk_elg   :: Elgamal key generation
829            - primegen :: Prime generation
830            - need_entropy :: Waiting for new entropy in the RNG
831            - tick :: Generic tick without any special meaning - useful
832                      for letting clients know that the server is still
833                      working.
834            - starting_agent :: A gpg-agent was started because it is not
835                                 running as a daemon.
836            - learncard :: Send by the agent and gpgsm while learing
837                           the data of a smartcard.
838            - card_busy :: A smartcard is still working
839
840 *** BACKUP_KEY_CREATED <fingerprint> <fname>
841     A backup of a key identified by <fingerprint> has been writte to
842     the file <fname>; <fname> is percent-escaped.
843
844 *** MOUNTPOINT <name>
845     <name> is a percent-plus escaped filename describing the
846     mountpoint for the current operation (e.g. used by "g13 --mount").
847     This may either be the specified mountpoint or one randomly
848     choosen by g13.
849
850 *** PINENTRY_LAUNCHED <pid>
851     This status line is emitted by gpg to notify a client that a
852     Pinentry has been launched.  <pid> is the PID of the Pinentry.  It
853     may be used to display a hint to the user but can't be used to
854     synchronize with Pinentry.  Note that there is also an Assuan
855     inquiry line with the same name used internally or, if enabled,
856     send to the client instead of this status line.  Such an inquiry
857     may be used to sync with Pinentry
858
859 ** Obsolete status codes
860 *** SIGEXPIRED
861     Removed on 2011-02-04.  This is deprecated in favor of KEYEXPIRED.
862 *** RSA_OR_IDEA
863     Obsolete.  This status message used to be emitted for requests to
864     use the IDEA or RSA algorithms.  It has been dropped from GnuPG
865     2.1 after the respective patents expired.
866 *** SHM_INFO, SHM_GET, SHM_GET_BOOL, SHM_GET_HIDDEN
867     These were used for the ancient shared memory based co-processing.
868 *** BEGIN_STREAM, END_STREAM
869     Used to issued by the experimental pipemode.
870
871
872 * Format of the --attribute-fd output
873
874   When --attribute-fd is set, during key listings (--list-keys,
875   --list-secret-keys) GnuPG dumps each attribute packet to the file
876   descriptor specified.  --attribute-fd is intended for use with
877   --status-fd as part of the required information is carried on the
878   ATTRIBUTE status tag (see above).
879
880   The contents of the attribute data is specified by RFC 4880.  For
881   convenience, here is the Photo ID format, as it is currently the
882   only attribute defined:
883
884   - Byte 0-1 :: The length of the image header.  Due to a historical
885                 accident (i.e. oops!) back in the NAI PGP days, this
886                 is a little-endian number.  Currently 16 (0x10 0x00).
887
888   - Byte 2 :: The image header version.  Currently 0x01.
889
890   - Byte 3 :: Encoding format.  0x01 == JPEG.
891
892   - Byte 4-15 :: Reserved, and currently unused.
893
894   All other data after this header is raw image (JPEG) data.
895
896
897 * Unattended key generation
898
899    Please see the GnuPG manual for a description.
900
901
902 * Layout of the TrustDB
903
904   The TrustDB is built from fixed length records, where the first byte
905   describes the record type.  All numeric values are stored in network
906   byte order. The length of each record is 40 bytes. The first record
907   of the DB is always of type 1 and this is the only record of this
908   type.
909
910   FIXME:  The layout changed, document it here.
911 #+begin_example
912   Record type 0:
913   --------------
914     Unused record, can be reused for any purpose.
915
916   Record type 1:
917   --------------
918     Version information for this TrustDB.  This is always the first
919     record of the DB and the only one with type 1.
920      1 byte value 1
921      3 bytes 'gpg'  magic value
922      1 byte Version of the TrustDB (2)
923      1 byte marginals needed
924      1 byte completes needed
925      1 byte max_cert_depth
926             The three items are used to check whether the cached
927             validity value from the dir record can be used.
928      1 u32  locked flags [not used]
929      1 u32  timestamp of trustdb creation
930      1 u32  timestamp of last modification which may affect the validity
931             of keys in the trustdb.  This value is checked against the
932             validity timestamp in the dir records.
933      1 u32  timestamp of last validation [currently not used]
934             (Used to keep track of the time, when this TrustDB was checked
935              against the pubring)
936      1 u32  record number of keyhashtable [currently not used]
937      1 u32  first free record
938      1 u32  record number of shadow directory hash table [currently not used]
939             It does not make sense to combine this table with the key table
940             because the keyid is not in every case a part of the fingerprint.
941      1 u32  record number of the trusthashtbale
942
943
944   Record type 2: (directory record)
945   --------------
946     Informations about a public key certificate.
947     These are static values which are never changed without user interaction.
948
949      1 byte value 2
950      1 byte  reserved
951      1 u32   LID     .  (This is simply the record number of this record.)
952      1 u32   List of key-records (the first one is the primary key)
953      1 u32   List of uid-records
954      1 u32   cache record
955      1 byte  ownertrust
956      1 byte  dirflag
957      1 byte  maximum validity of all the user ids
958      1 u32   time of last validity check.
959      1 u32   Must check when this time has been reached.
960              (0 = no check required)
961
962
963   Record type 3:  (key record)
964   --------------
965     Informations about a primary public key.
966     (This is mainly used to lookup a trust record)
967
968      1 byte value 3
969      1 byte  reserved
970      1 u32   LID
971      1 u32   next   - next key record
972      7 bytes reserved
973      1 byte  keyflags
974      1 byte  pubkey algorithm
975      1 byte  length of the fingerprint (in bytes)
976      20 bytes fingerprint of the public key
977               (This is the value we use to identify a key)
978
979   Record type 4: (uid record)
980   --------------
981     Informations about a userid
982     We do not store the userid but the hash value of the userid because that
983     is sufficient.
984
985      1 byte value 4
986      1 byte reserved
987      1 u32  LID  points to the directory record.
988      1 u32  next   next userid
989      1 u32  pointer to preference record
990      1 u32  siglist  list of valid signatures
991      1 byte uidflags
992      1 byte validity of the key calculated over this user id
993      20 bytes ripemd160 hash of the username.
994
995
996   Record type 5: (pref record)
997   --------------
998     This record type is not anymore used.
999
1000      1 byte value 5
1001      1 byte   reserved
1002      1 u32  LID; points to the directory record (and not to the uid record!).
1003             (or 0 for standard preference record)
1004      1 u32  next
1005      30 byte preference data
1006
1007   Record type 6  (sigrec)
1008   -------------
1009     Used to keep track of key signatures. Self-signatures are not
1010     stored.  If a public key is not in the DB, the signature points to
1011     a shadow dir record, which in turn has a list of records which
1012     might be interested in this key (and the signature record here
1013     is one).
1014
1015      1 byte   value 6
1016      1 byte   reserved
1017      1 u32    LID           points back to the dir record
1018      1 u32    next   next sigrec of this uid or 0 to indicate the
1019                      last sigrec.
1020      6 times
1021         1 u32  Local_id of signatures dir or shadow dir record
1022         1 byte Flag: Bit 0 = checked: Bit 1 is valid (we have a real
1023                              directory record for this)
1024                          1 = valid is set (but may be revoked)
1025
1026
1027
1028   Record type 8: (shadow directory record)
1029   --------------
1030     This record is used to reserve a LID for a public key.  We
1031     need this to create the sig records of other keys, even if we
1032     do not yet have the public key of the signature.
1033     This record (the record number to be more precise) will be reused
1034     as the dir record when we import the real public key.
1035
1036      1 byte value 8
1037      1 byte  reserved
1038      1 u32   LID      (This is simply the record number of this record.)
1039      2 u32   keyid
1040      1 byte  pubkey algorithm
1041      3 byte reserved
1042      1 u32   hintlist   A list of records which have references to
1043                         this key.  This is used for fast access to
1044                         signature records which are not yet checked.
1045                         Note, that this is only a hint and the actual records
1046                         may not anymore hold signature records for that key
1047                         but that the code cares about this.
1048     18 byte reserved
1049
1050
1051
1052   Record Type 10 (hash table)
1053   --------------
1054     Due to the fact that we use fingerprints to lookup keys, we can
1055     implement quick access by some simple hash methods, and avoid
1056     the overhead of gdbm.  A property of fingerprints is that they can be
1057     used directly as hash values.  (They can be considered as strong
1058     random numbers.)
1059       What we use is a dynamic multilevel architecture, which combines
1060     hashtables, record lists, and linked lists.
1061
1062     This record is a hashtable of 256 entries; a special property
1063     is that all these records are stored consecutively to make one
1064     big table. The hash value is simple the 1st, 2nd, ... byte of
1065     the fingerprint (depending on the indirection level).
1066
1067     When used to hash shadow directory records, a different table is used
1068     and indexed by the keyid.
1069
1070      1 byte value 10
1071      1 byte reserved
1072      n u32  recnum; n depends on the record length:
1073             n = (reclen-2)/4  which yields 9 for the current record length
1074             of 40 bytes.
1075
1076     the total number of such record which makes up the table is:
1077          m = (256+n-1) / n
1078     which is 29 for a record length of 40.
1079
1080     To look up a key we use the first byte of the fingerprint to get
1081     the recnum from this hashtable and look up the addressed record:
1082        - If this record is another hashtable, we use 2nd byte
1083          to index this hash table and so on.
1084        - if this record is a hashlist, we walk all entries
1085          until we found one a matching one.
1086        - if this record is a key record, we compare the
1087          fingerprint and to decide whether it is the requested key;
1088
1089
1090   Record type 11 (hash list)
1091   --------------
1092     see hash table for an explanation.
1093     This is also used for other purposes.
1094
1095     1 byte value 11
1096     1 byte reserved
1097     1 u32  next          next hash list record
1098     n times              n = (reclen-5)/5
1099         1 u32  recnum
1100
1101     For the current record length of 40, n is 7
1102
1103
1104
1105   Record type 254 (free record)
1106   ---------------
1107     All these records form a linked list of unused records.
1108      1 byte  value 254
1109      1 byte  reserved (0)
1110      1 u32   next_free
1111 #+end_example
1112
1113
1114 * GNU extensions to the S2K algorithm
1115
1116   S2K mode 101 is used to identify these extensions.
1117   After the hash algorithm the 3 bytes "GNU" are used to make
1118   clear that these are extensions for GNU, the next bytes gives the
1119   GNU protection mode - 1000.  Defined modes are:
1120   - 1001 :: Do not store the secret part at all.
1121   - 1002 :: A stub to access smartcards (not used in 1.2.x)
1122
1123 * Keyserver helper message format
1124
1125   The keyserver may be contacted by a Unix Domain socket or via TCP.
1126
1127   The format of a request is:
1128 #+begin_example
1129   command-tag
1130   "Content-length:" digits
1131   CRLF
1132 #+end_example
1133
1134   Where command-tag is
1135
1136 #+begin_example
1137   NOOP
1138   GET <user-name>
1139   PUT
1140   DELETE <user-name>
1141 #+end_example
1142
1143 The format of a response is:
1144
1145 #+begin_example
1146   "GNUPG/1.0" status-code status-text
1147   "Content-length:" digits
1148   CRLF
1149 #+end_example
1150 followed by <digits> bytes of data
1151
1152 Status codes are:
1153
1154   - 1xx :: Informational - Request received, continuing process
1155
1156   - 2xx :: Success - The action was successfully received, understood,
1157            and accepted
1158
1159   - 4xx :: Client Error - The request contains bad syntax or cannot be
1160            fulfilled
1161
1162   - 5xx :: Server Error - The server failed to fulfill an apparently
1163            valid request
1164
1165
1166 * Object identifiers
1167
1168   OIDs below the GnuPG arc:
1169
1170 #+begin_example
1171   1.3.6.1.4.1.11591.2          GnuPG
1172   1.3.6.1.4.1.11591.2.1          notation
1173   1.3.6.1.4.1.11591.2.1.1          pkaAddress
1174   1.3.6.1.4.1.11591.2.2          X.509 extensions
1175   1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
1176   1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
1177   1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
1178 #+end_example
1179
1180
1181
1182 * Miscellaneous notes
1183
1184 ** v3 fingerprints
1185    For packet version 3 we calculate the keyids this way:
1186     - RSA :: Low 64 bits of n
1187     - ELGAMAL :: Build a v3 pubkey packet (with CTB 0x99) and
1188                  calculate a RMD160 hash value from it. This is used
1189                  as the fingerprint and the low 64 bits are the keyid.
1190
1191 ** Simplified revocation certificates
1192   Revocation certificates consist only of the signature packet;
1193   "--import" knows how to handle this.  The rationale behind it is to
1194   keep them small.
1195
1196 ** Documentation on HKP (the http keyserver protocol):
1197
1198    A minimalistic HTTP server on port 11371 recognizes a GET for
1199    /pks/lookup.  The standard http URL encoded query parameters are
1200    this (always key=value):
1201
1202    - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1203      pgp -kxa)
1204
1205    - search=<stringlist>. This is a list of words that must occur in the key.
1206      The words are delimited with space, points, @ and so on. The delimiters
1207      are not searched for and the order of the words doesn't matter (but see
1208      next option).
1209
1210    - exact=on. This switch tells the hkp server to only report exact matching
1211      keys back. In this case the order and the "delimiters" are important.
1212
1213    - fingerprint=on. Also reports the fingerprints when used with 'index' or
1214      'vindex'
1215
1216    The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1217    keys.
1218
1219
1220    A better way to do this would be a request like:
1221
1222       /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1223
1224    This can be implemented using Hurd's translator mechanism.
1225    However, I think the whole key server stuff has to be re-thought;
1226    I have some ideas and probably create a white paper.