Removed deprecated SIGEXPIRED status line.
[gnupg.git] / doc / DETAILS
1                                                               -*- text -*-
2 Format of colon listings
3 ========================
4 First an example:
5
6 $ gpg --fixed-list-mode --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
151 All dates are displayed in the format yyyy-mm-dd unless you use the
152 option --fixed-list-mode in which case they are displayed as seconds
153 since Epoch.  More fields may be added later, so parsers should be
154 prepared for this. When parsing a number the parser should stop at the
155 first non-number character so that additional information can later be
156 added.
157
158 If field 1 has the tag "pkd", a listing looks like this:
159 pkd:0:1024:B665B1435F4C2 .... FF26ABB:
160     !  !   !-- the value
161     !  !------ for information number of bits in the value
162     !--------- index (eg. DSA goes from 0 to 3: p,q,g,y)
163
164
165 Example for a "tru" trust base record:
166
167    tru:o:0:1166697654:1:3:1:5
168
169  The fields are:
170
171  2: Reason for staleness of trust.  If this field is empty, then the
172     trustdb is not stale.  This field may have multiple flags in it:
173
174     o: Trustdb is old
175     t: Trustdb was built with a different trust model than the one we
176        are using now.
177
178  3: Trust model:
179     0: Classic trust model, as used in PGP 2.x.
180     1: PGP trust model, as used in PGP 6 and later.  This is the same
181        as the classic trust model, except for the addition of trust
182        signatures.
183
184     GnuPG before version 1.4 used the classic trust model by default.
185     GnuPG 1.4 and later uses the PGP trust model by default.
186
187  4: Date trustdb was created in seconds since 1970-01-01.
188  5: Date trustdb will expire in seconds since 1970-01-01.
189  6: Number of marginally trusted users to introduce a new key signer
190     (gpg's option --marginals-needed)
191  7: Number of completely trusted users to introduce a new key signer.
192     (gpg's option --completes-needed)
193  8: Maximum depth of a certification chain.
194     *gpg's option --max-cert-depth)
195
196 The "spk" signature subpacket records have the fields:
197
198  2: Subpacket number as per RFC-4880 and later.
199  3: Flags in hex.  Currently the only two bits assigned are 1, to
200     indicate that the subpacket came from the hashed part of the
201     signature, and 2, to indicate the subpacket was marked critical.
202  4: Length of the subpacket.  Note that this is the length of the
203     subpacket, and not the length of field 5 below.  Due to the need
204     for %-encoding, the length of field 5 may be up to 3x this value.
205  5: The subpacket data.  Printable ASCII is shown as ASCII, but other
206     values are rendered as %XX where XX is the hex value for the byte.
207
208
209 Format of the "--status-fd" output
210 ==================================
211 Every line is prefixed with "[GNUPG:] ", followed by a keyword with
212 the type of the status line and a some arguments depending on the
213 type (maybe none); an application should always be prepared to see
214 more arguments in future versions.
215
216
217     NEWSIG
218         May be issued right before a signature verification starts.  This
219         is useful to define a context for parsing ERROR status
220         messages.  No arguments are currently defined.
221
222     GOODSIG  <long_keyid_or_fpr>  <username>
223         The signature with the keyid is good.  For each signature only
224         one of the codes GOODSIG, BADSIG, EXPSIG, EXPKEYSIG, REVKEYSIG
225         or ERRSIG will be emitted.  In the past they were used as a
226         marker for a new signature; new code should use the NEWSIG
227         status instead.  The username is the primary one encoded in
228         UTF-8 and %XX escaped. The fingerprint may be used instead of
229         the long keyid if it is available.  This is the case with CMS
230         and might eventually also be available for OpenPGP.
231
232     EXPSIG  <long_keyid_or_fpr>  <username>
233         The signature with the keyid is good, but the signature is
234         expired. The username is the primary one encoded in UTF-8 and
235         %XX escaped. The fingerprint may be used instead of the long
236         keyid if it is available.  This is the case with CMS and might
237         eventually also be available for OpenPGP.
238
239     EXPKEYSIG  <long_keyid_or_fpr> <username>
240         The signature with the keyid is good, but the signature was
241         made by an expired key. The username is the primary one
242         encoded in UTF-8 and %XX escaped.  The fingerprint may be used
243         instead of the long keyid if it is available.  This is the
244         case with CMS and might eventually also be available for
245         OpenPGP.
246
247     REVKEYSIG  <long_keyid_or_fpr>  <username>
248         The signature with the keyid is good, but the signature was
249         made by a revoked key. The username is the primary one encoded
250         in UTF-8 and %XX escaped. The fingerprint may be used instead
251         of the long keyid if it is available.  This is the case with
252         CMS and might eventually also be available for OpenPGP.
253
254     BADSIG  <long_keyid_or_fpr>  <username>
255         The signature with the keyid has not been verified okay.  The
256         username is the primary one encoded in UTF-8 and %XX
257         escaped. The fingerprint may be used instead of the long keyid
258         if it is available.  This is the case with CMS and might
259         eventually also be available for OpenPGP.
260
261     ERRSIG  <long_keyid_or_fpr>  <pubkey_algo> <hash_algo> \
262             <sig_class> <timestamp> <rc>
263         It was not possible to check the signature.  This may be
264         caused by a missing public key or an unsupported algorithm.  A
265         RC of 4 indicates unknown algorithm, a 9 indicates a missing
266         public key. The other fields give more information about this
267         signature.  sig_class is a 2 byte hex-value.  The fingerprint
268         may be used instead of the long keyid if it is available.
269         This is the case with CMS and might eventually also be
270         available for OpenPGP.
271
272         Note, that TIMESTAMP may either be a number with seconds since
273         epoch or an ISO 8601 string which can be detected by the
274         presence of the letter 'T' inside.
275
276     VALIDSIG    <fingerprint in hex> <sig_creation_date> <sig-timestamp>
277                 <expire-timestamp>  <sig-version> <reserved> <pubkey-algo>
278                 <hash-algo> <sig-class> [ <primary-key-fpr> ]
279
280         The signature with the keyid is good. This is the same as
281         GOODSIG but has the fingerprint as the argument. Both status
282         lines are emitted for a good signature.  All arguments here
283         are on one long line.  sig-timestamp is the signature creation
284         time in seconds after the epoch. expire-timestamp is the
285         signature expiration time in seconds after the epoch (zero
286         means "does not expire"). sig-version, pubkey-algo, hash-algo,
287         and sig-class (a 2-byte hex value) are all straight from the
288         signature packet.  PRIMARY-KEY-FPR is the fingerprint of the
289         primary key or identical to the first argument.  This is
290         useful to get back to the primary key without running gpg
291         again for this purpose.
292
293         The primary-key-fpr parameter is used for OpenPGP and not
294         available for CMS signatures.  The sig-version as well as the
295         sig class is not defined for CMS and currently set to 0 and 00.
296
297         Note, that *-TIMESTAMP may either be a number with seconds
298         since epoch or an ISO 8601 string which can be detected by the
299         presence of the letter 'T' inside.
300
301     SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
302         This is emitted only for signatures of class 0 or 1 which
303         have been verified okay.  The string is a signature id
304         and may be used in applications to detect replay attacks
305         of signed messages.  Note that only DLP algorithms give
306         unique ids - others may yield duplicated ones when they
307         have been created in the same second.
308
309         Note, that SIG-TIMESTAMP may either be a number with seconds
310         since epoch or an ISO 8601 string which can be detected by the
311         presence of the letter 'T' inside.
312
313     ENC_TO  <long_keyid>  <keytype>  <keylength>
314         The message is encrypted to this LONG_KEYID.  KEYTYPE is the
315         numerical value of the public key algorithm or 0 if it is not
316         known, KEYLENGTH is the length of the key or 0 if it is not
317         known (which is currently always the case).  Gpg prints this
318         line always; Gpgsm only if it knows the certificate.
319
320     NODATA  <what>
321         No data has been found. Codes for what are:
322             1 - No armored data.
323             2 - Expected a packet but did not found one.
324             3 - Invalid packet found, this may indicate a non OpenPGP
325                 message.
326             4 - signature expected but not found
327         You may see more than one of these status lines.
328
329     UNEXPECTED <what>
330         Unexpected data has been encountered
331             0 - not further specified
332
333
334     TRUST_UNDEFINED <error token>
335     TRUST_NEVER     <error token>
336     TRUST_MARGINAL  [0  [<validation_model>]]
337     TRUST_FULLY     [0  [<validation_model>]]
338     TRUST_ULTIMATE  [0  [<validation_model>]]
339         For good signatures one of these status lines are emitted to
340         indicate the validity of the key used to create the signature.
341         The error token values are currently only emitted by gpgsm.
342         VALIDATION_MODEL describes the algorithm used to check the
343         validity of the key.  The defaults are the standard Web of
344         Trust model for gpg and the the standard X.509 model for
345         gpgsm.  The defined values are
346
347            "pgp"   for the standard PGP WoT.
348            "shell" for the standard X.509 model.
349            "chain" for the chain model.
350
351         Note that we use the term "TRUST_" in the status names for
352         historic reasons; we now speak of validity.
353
354     PKA_TRUST_GOOD <mailbox>
355     PKA_TRUST_BAD  <mailbox>
356         Depending on the outcome of the PKA check one of the above
357         status codes is emitted in addition to a TRUST_* status.
358         Without PKA info available or
359
360     KEYEXPIRED <expire-timestamp>
361         The key has expired.  expire-timestamp is the expiration time
362         in seconds since Epoch.  This status line is not very useful
363         because it will also be emitted for expired subkeys even if
364         this subkey is not used.  To check whether a key used to sign
365         a message has expired, the EXPKEYSIG status line is to be
366         used.
367
368         Note, that TIMESTAMP may either be a number with seconds since
369         epoch or an ISO 8601 string which can be detected by the
370         presence of the letter 'T' inside.
371
372     KEYREVOKED
373         The used key has been revoked by its owner.  No arguments yet.
374
375     BADARMOR
376         The ASCII armor is corrupted.  No arguments yet.
377
378     RSA_OR_IDEA
379         The IDEA algorithms has been used in the data.  A
380         program might want to fallback to another program to handle
381         the data if GnuPG failed.  This status message used to be emitted
382         also for RSA but this has been dropped after the RSA patent expired.
383         However we can't change the name of the message.
384
385     SHM_INFO
386     SHM_GET
387     SHM_GET_BOOL
388     SHM_GET_HIDDEN
389
390     GET_BOOL
391     GET_LINE
392     GET_HIDDEN
393     GOT_IT
394
395     NEED_PASSPHRASE <long main keyid> <long keyid> <keytype> <keylength>
396         Issued whenever a passphrase is needed.
397         keytype is the numerical value of the public key algorithm
398         or 0 if this is not applicable, keylength is the length
399         of the key or 0 if it is not known (this is currently always the case).
400
401     NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
402         Issued whenever a passphrase for symmetric encryption is needed.
403
404     NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
405         Issued whenever a PIN is requested to unlock a card.
406
407     MISSING_PASSPHRASE
408         No passphrase was supplied.  An application which encounters this
409         message may want to stop parsing immediately because the next message
410         will probably be a BAD_PASSPHRASE.  However, if the application
411         is a wrapper around the key edit menu functionality it might not
412         make sense to stop parsing but simply ignoring the following
413         BAD_PASSPHRASE.
414
415     BAD_PASSPHRASE <long keyid>
416         The supplied passphrase was wrong or not given.  In the latter case
417         you may have seen a MISSING_PASSPHRASE.
418
419     GOOD_PASSPHRASE
420         The supplied passphrase was good and the secret key material
421         is therefore usable.
422
423     NO_PUBKEY  <long keyid>
424     NO_SECKEY  <long keyid>
425         The key is not available
426
427     IMPORT_CHECK <long keyid> <fingerprint> <user ID>
428         This status is emitted in interactive mode right before
429         the "import.okay" prompt.
430
431     IMPORTED   <long keyid>  <username>
432         The keyid and name of the signature just imported
433
434     IMPORT_OK  <reason> [<fingerprint>]
435         The key with the primary key's FINGERPRINT has been imported.
436         Reason flags:
437           0 := Not actually changed
438           1 := Entirely new key.
439           2 := New user IDs
440           4 := New signatures
441           8 := New subkeys
442          16 := Contains private key.
443         The flags may be ORed.
444
445     IMPORT_PROBLEM <reason> [<fingerprint>]
446         Issued for each import failure.  Reason codes are:
447           0 := "No specific reason given".
448           1 := "Invalid Certificate".
449           2 := "Issuer Certificate missing".
450           3 := "Certificate Chain too long".
451           4 := "Error storing certificate".
452
453     IMPORT_RES <count> <no_user_id> <imported> <imported_rsa> <unchanged>
454         <n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported>
455         <sec_dups> <skipped_new_keys> <not_imported>
456         Final statistics on import process (this is one long line)
457
458     FILE_START <what> <filename>
459         Start processing a file <filename>.  <what> indicates the performed
460         operation:
461             1 - verify
462             2 - encrypt
463             3 - decrypt
464
465     FILE_DONE
466         Marks the end of a file processing which has been started
467         by FILE_START.
468
469     BEGIN_DECRYPTION
470     END_DECRYPTION
471         Mark the start and end of the actual decryption process.  These
472         are also emitted when in --list-only mode.
473
474     DECRYPTION_INFO <mdc_method> <sym_algo>
475         Print information about the symmetric encryption algorithm and
476         the MDC method.  This will be emitted even if the decryption
477         fails.
478
479     DECRYPTION_FAILED
480         The symmetric decryption failed - one reason could be a wrong
481         passphrase for a symmetrical encrypted message.
482
483     DECRYPTION_OKAY
484         The decryption process succeeded.  This means, that either the
485         correct secret key has been used or the correct passphrase
486         for a conventional encrypted message was given.  The program
487         itself may return an errorcode because it may not be possible to
488         verify a signature for some reasons.
489
490     BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
491     END_ENCRYPTION
492         Mark the start and end of the actual encryption process.
493
494     BEGIN_SIGNING
495        Mark the start of the actual signing process. This may be used
496        as an indication that all requested secret keys are ready for
497        use.
498
499     DELETE_PROBLEM reason_code
500         Deleting a key failed.  Reason codes are:
501             1 - No such key
502             2 - Must delete secret key first
503             3 - Ambigious specification
504
505     PROGRESS what char cur total
506         Used by the primegen and Public key functions to indicate progress.
507         "char" is the character displayed with no --status-fd enabled, with
508         the linefeed replaced by an 'X'.  "cur" is the current amount
509         done and "total" is amount to be done; a "total" of 0 indicates that
510         the total amount is not known.  The condition
511            TOATL && CUR == TOTAL
512         may be used to detect the end of an operation.
513         Well known values for WHAT:
514              "pk_dsa"   - DSA key generation
515              "pk_elg"   - Elgamal key generation
516              "primegen" - Prime generation
517              "need_entropy" - Waiting for new entropy in the RNG
518              "file:XXX" - processing file XXX
519                           (note that current gpg versions leave out the
520                            "file:" prefix).
521              "tick"     - generic tick without any special meaning - useful
522                           for letting clients know that the server is
523                           still working.
524              "starting_agent" - A gpg-agent was started because it is not
525                           running as a daemon.
526              "learncard"  Send by the agent and gpgsm while learing
527                           the data of a smartcard.
528              "card_busy"  A smartcard is still working
529
530     SIG_CREATED <type> <pubkey algo> <hash algo> <class> <timestamp> <key fpr>
531         A signature has been created using these parameters.
532             type:  'D' = detached
533                    'C' = cleartext
534                    'S' = standard
535                    (only the first character should be checked)
536             class: 2 hex digits with the signature class
537
538         Note, that TIMESTAMP may either be a number with seconds since
539         epoch or an ISO 8601 string which can be detected by the
540         presence of the letter 'T' inside.
541
542     KEY_CREATED <type> <fingerprint> [<handle>]
543         A key has been created
544             type: 'B' = primary and subkey
545                   'P' = primary
546                   'S' = subkey
547         The fingerprint is one of the primary key for type B and P and
548         the one of the subkey for S.  Handle is an arbitrary
549         non-whitespace string used to match key parameters from batch
550         key creation run.
551
552     KEY_NOT_CREATED [<handle>]
553         The key from batch run has not been created due to errors.
554
555
556     SESSION_KEY  <algo>:<hexdigits>
557         The session key used to decrypt the message.  This message will
558         only be emitted when the special option --show-session-key
559         is used.  The format is suitable to be passed to the option
560         --override-session-key
561
562     NOTATION_NAME <name>
563     NOTATION_DATA <string>
564         name and string are %XX escaped; the data may be split
565         among several NOTATION_DATA lines.
566
567     USERID_HINT <long main keyid> <string>
568         Give a hint about the user ID for a certain keyID.
569
570     POLICY_URL <string>
571         string is %XX escaped
572
573     BEGIN_STREAM
574     END_STREAM
575         Issued by pipemode.
576
577     INV_RECP <reason> <requested_recipient>
578     INV_SGNR <reason> <requested_sender>
579         Issued for each unusable recipient/sender. The reasons codes
580         currently in use are:
581           0 := "No specific reason given".
582           1 := "Not Found"
583           2 := "Ambigious specification"
584           3 := "Wrong key usage"
585           4 := "Key revoked"
586           5 := "Key expired"
587           6 := "No CRL known"
588           7 := "CRL too old"
589           8 := "Policy mismatch"
590           9 := "Not a secret key"
591          10 := "Key not trusted"
592          11 := "Missing certificate"
593          12 := "Missing issuer certificate"
594
595         Note that for historical reasons the INV_RECP status is also
596         used for gpgsm's SIGNER command where it relates to signer's
597         of course.  Newer GnuPG versions are using INV_SGNR;
598         applications should ignore the INV_RECP during the sender's
599         command processing once they have seen an INV_SGNR.  We use
600         different code so that we can distinguish them while doing an
601         encrypt+sign.
602
603
604     NO_RECP <reserved>
605     NO_SGNR <reserved>
606         Issued when no recipients/senders are usable.
607
608     ALREADY_SIGNED <long-keyid>
609         Warning: This is experimental and might be removed at any time.
610
611     TRUNCATED <maxno>
612         The output was truncated to MAXNO items.  This status code is issued
613         for certain external requests
614
615     ERROR <error location> <error code> [<more>]
616
617         This is a generic error status message, it might be followed
618         by error location specific data. <error code> and
619         <error_location> should not contain spaces.  The error code is
620         a either a string commencing with a letter or such a string
621         prefixed with a numerical error code and an underscore; e.g.:
622         "151011327_EOF".
623
624     SUCCESS [<location>]
625         Postive confirimation that an operation succeeded.  <location>
626         is optional but if given should not contain spaces.
627         Used only with a few commands.
628
629
630     ATTRIBUTE <fpr> <octets> <type> <index> <count>
631               <timestamp> <expiredate> <flags>
632         This is one long line issued for each attribute subpacket when
633         an attribute packet is seen during key listing.  <fpr> is the
634         fingerprint of the key. <octets> is the length of the
635         attribute subpacket. <type> is the attribute type
636         (1==image). <index>/<count> indicates that this is the Nth
637         indexed subpacket of count total subpackets in this attribute
638         packet.  <timestamp> and <expiredate> are from the
639         self-signature on the attribute packet.  If the attribute
640         packet does not have a valid self-signature, then the
641         timestamp is 0.  <flags> are a bitwise OR of:
642                 0x01 = this attribute packet is a primary uid
643                 0x02 = this attribute packet is revoked
644                 0x04 = this attribute packet is expired
645
646     CARDCTRL <what> [<serialno>]
647         This is used to control smartcard operations.
648         Defined values for WHAT are:
649            1 = Request insertion of a card.  Serialnumber may be given
650                to request a specific card.  Used by gpg 1.4 w/o scdaemon.
651            2 = Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
652            3 = Card with serialnumber detected
653            4 = No card available.
654            5 = No card reader available
655            6 = No card support available
656
657     PLAINTEXT <format> <timestamp> <filename>
658         This indicates the format of the plaintext that is about to be
659         written.  The format is a 1 byte hex code that shows the
660         format of the plaintext: 62 ('b') is binary data, 74 ('t') is
661         text data with no character set specified, and 75 ('u') is
662         text data encoded in the UTF-8 character set.  The timestamp
663         is in seconds since the epoch.  If a filename is available it
664         gets printed as the third argument, percent-escaped as usual.
665
666     PLAINTEXT_LENGTH <length>
667         This indicates the length of the plaintext that is about to be
668         written.  Note that if the plaintext packet has partial length
669         encoding it is not possible to know the length ahead of time.
670         In that case, this status tag does not appear.
671
672     SIG_SUBPACKET <type> <flags> <len> <data>
673         This indicates that a signature subpacket was seen.  The
674         format is the same as the "spk" record above.
675
676     SC_OP_FAILURE [<code>]
677         An operation on a smartcard definitely failed.  Currently
678         there is no indication of the actual error code, but
679         application should be prepared to later accept more arguments.
680         Defined values for CODE are:
681            0 - unspecified error (identically to a missing CODE)
682            1 - canceled
683            2 - bad PIN
684
685     SC_OP_SUCCESS
686         A smart card operaion succeeded.  This status is only printed
687         for certain operation and is mostly useful to check whether a
688         PIN change really worked.
689
690     BACKUP_KEY_CREATED fingerprint fname
691         A backup key named FNAME has been created for the key with
692         KEYID.
693
694     MOUNTPOINT <name>
695         NAME is a percent-plus escaped filename describing the
696         mountpoint for the current operation (e.g. g13 --mount).  This
697         may either be the specified mountpoint or one randomly choosen
698         by g13.
699
700
701 Status lines which are not anymore used:
702
703     SIGEXPIRED removed on 2011-02-04.
704         This is deprecated in favor of KEYEXPIRED.
705
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.