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