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