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