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