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