Fix detection of card removal and insertion.
[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                 w = The key has a well known private part.
62                 s = The key has special validity.  This means that it
63                     might be self-signed and expected to be used in
64                     the STEED sytem.
65
66             If the validity information is given for a UID or UAT
67             record, it describes the validity calculated based on this
68             user ID.  If given for a key record it describes the best
69             validity taken from the best rated user ID.
70
71             For X.509 certificates a 'u' is used for a trusted root
72             certificate (i.e. for the trust anchor) and an 'f' for all
73             other valid certificates.
74
75  3. Field:  length of key in bits.
76
77  4. Field:  Algorithm:  1 = RSA
78                        16 = Elgamal (encrypt only)
79                        17 = DSA (sometimes called DH, sign only)
80                        20 = Elgamal (sign and encrypt - don't use them!)
81             (for other id's see include/cipher.h)
82
83  5. Field:  KeyID
84
85  6. Field:  Creation Date (in UTC).  For UID and UAT records, this is
86             the self-signature date.  Note that the date is usally
87             printed in seconds since epoch, however, we are migrating
88             to an ISO 8601 format (e.g. "19660205T091500").  This is
89             currently only relevant for X.509.  A simple way to detect
90             the new format is to scan for the 'T'.
91
92  7. Field:  Key or user ID/user attribute expiration date or empty if none.
93
94  8. Field:  Used for serial number in crt records (used to be the Local-ID).
95             For UID and UAT records, this is a hash of the user ID contents
96             used to represent that exact user ID.  For trust signatures,
97             this is the trust depth seperated by the trust value by a
98             space.
99
100  9. Field:  Ownertrust (primary public keys only)
101             This is a single letter, but be prepared that additional
102             information may follow in some future versions.  For trust
103             signatures with a regular expression, this is the regular
104             expression value, quoted as in field 10.
105
106 10. Field:  User-ID.  The value is quoted like a C string to avoid
107             control characters (the colon is quoted "\x3a").
108             For a "pub" record this field is not used on --fixed-list-mode.
109             A UAT record puts the attribute subpacket count here, a
110             space, and then the total attribute subpacket size.
111             In gpgsm the issuer name comes here
112             An FPR record stores the fingerprint here.
113             The fingerprint of an revocation key is stored here.
114
115 11. Field:  Signature class as per RFC-4880.  This is a 2 digit
116             hexnumber followed by either the letter 'x' for an
117             exportable signature or the letter 'l' for a local-only
118             signature.  The class byte of an revocation key is also
119             given here, 'x' and 'l' is used the same way.  IT is not
120             used for X.509.
121
122 12. Field:  Key capabilities:
123                 e = encrypt
124                 s = sign
125                 c = certify
126                 a = authentication
127             A key may have any combination of them in any order.  In
128             addition to these letters, the primary key has uppercase
129             versions of the letters to denote the _usable_
130             capabilities of the entire key, and a potential letter 'D'
131             to indicate a disabled key.
132
133 13. Field:  Used in FPR records for S/MIME keys to store the
134             fingerprint of the issuer certificate.  This is useful to
135             build the certificate path based on certificates stored in
136             the local keyDB; it is only filled if the issuer
137             certificate is available. The root has been reached if
138             this is the same string as the fingerprint. The advantage
139             of using this value is that it is guaranteed to have been
140             been build by the same lookup algorithm as gpgsm uses.
141             For "uid" records this lists the preferences in the same
142             way the gpg's --edit-key menu does.
143             For "sig" records, this is the fingerprint of the key that
144             issued the signature.  Note that this is only filled in if
145             the signature verified correctly.  Note also that for
146             various technical reasons, this fingerprint is only
147             available if --no-sig-cache is used.
148
149 14. Field   Flag field used in the --edit menu output:
150
151 15. Field   Used in sec/sbb to print the serial number of a token
152             (internal protect mode 1002) or a '#' if that key is a
153             simple stub (internal protect mode 1001)
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
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            "steed" for the STEED model.
355
356         Note that we use the term "TRUST_" in the status names for
357         historic reasons; we now speak of validity.
358
359     PKA_TRUST_GOOD <mailbox>
360     PKA_TRUST_BAD  <mailbox>
361         Depending on the outcome of the PKA check one of the above
362         status codes is emitted in addition to a TRUST_* status.
363         Without PKA info available or
364
365     KEYEXPIRED <expire-timestamp>
366         The key has expired.  expire-timestamp is the expiration time
367         in seconds since Epoch.  This status line is not very useful
368         because it will also be emitted for expired subkeys even if
369         this subkey is not used.  To check whether a key used to sign
370         a message has expired, the EXPKEYSIG status line is to be
371         used.
372
373         Note, that TIMESTAMP may either be a number with seconds since
374         epoch or an ISO 8601 string which can be detected by the
375         presence of the letter 'T' inside.
376
377     KEYREVOKED
378         The used key has been revoked by its owner.  No arguments yet.
379
380     BADARMOR
381         The ASCII armor is corrupted.  No arguments yet.
382
383     RSA_OR_IDEA
384         The IDEA algorithms has been used in the data.  A
385         program might want to fallback to another program to handle
386         the data if GnuPG failed.  This status message used to be emitted
387         also for RSA but this has been dropped after the RSA patent expired.
388         However we can't change the name of the message.
389
390     SHM_INFO
391     SHM_GET
392     SHM_GET_BOOL
393     SHM_GET_HIDDEN
394
395     GET_BOOL
396     GET_LINE
397     GET_HIDDEN
398     GOT_IT
399
400     NEED_PASSPHRASE <long main keyid> <long keyid> <keytype> <keylength>
401         Issued whenever a passphrase is needed.
402         keytype is the numerical value of the public key algorithm
403         or 0 if this is not applicable, keylength is the length
404         of the key or 0 if it is not known (this is currently always the case).
405
406     NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
407         Issued whenever a passphrase for symmetric encryption is needed.
408
409     NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
410         Issued whenever a PIN is requested to unlock a card.
411
412     MISSING_PASSPHRASE
413         No passphrase was supplied.  An application which encounters this
414         message may want to stop parsing immediately because the next message
415         will probably be a BAD_PASSPHRASE.  However, if the application
416         is a wrapper around the key edit menu functionality it might not
417         make sense to stop parsing but simply ignoring the following
418         BAD_PASSPHRASE.
419
420     BAD_PASSPHRASE <long keyid>
421         The supplied passphrase was wrong or not given.  In the latter case
422         you may have seen a MISSING_PASSPHRASE.
423
424     GOOD_PASSPHRASE
425         The supplied passphrase was good and the secret key material
426         is therefore usable.
427
428     NO_PUBKEY  <long keyid>
429     NO_SECKEY  <long keyid>
430         The key is not available
431
432     IMPORT_CHECK <long keyid> <fingerprint> <user ID>
433         This status is emitted in interactive mode right before
434         the "import.okay" prompt.
435
436     IMPORTED   <long keyid>  <username>
437         The keyid and name of the signature just imported
438
439     IMPORT_OK  <reason> [<fingerprint>]
440         The key with the primary key's FINGERPRINT has been imported.
441         Reason flags:
442           0 := Not actually changed
443           1 := Entirely new key.
444           2 := New user IDs
445           4 := New signatures
446           8 := New subkeys
447          16 := Contains private key.
448         The flags may be ORed.
449
450     IMPORT_PROBLEM <reason> [<fingerprint>]
451         Issued for each import failure.  Reason codes are:
452           0 := "No specific reason given".
453           1 := "Invalid Certificate".
454           2 := "Issuer Certificate missing".
455           3 := "Certificate Chain too long".
456           4 := "Error storing certificate".
457
458     IMPORT_RES <count> <no_user_id> <imported> <imported_rsa> <unchanged>
459         <n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported>
460         <sec_dups> <skipped_new_keys> <not_imported>
461         Final statistics on import process (this is one long line)
462
463     FILE_START <what> <filename>
464         Start processing a file <filename>.  <what> indicates the performed
465         operation:
466             1 - verify
467             2 - encrypt
468             3 - decrypt
469
470     FILE_DONE
471         Marks the end of a file processing which has been started
472         by FILE_START.
473
474     BEGIN_DECRYPTION
475     END_DECRYPTION
476         Mark the start and end of the actual decryption process.  These
477         are also emitted when in --list-only mode.
478
479     DECRYPTION_INFO <mdc_method> <sym_algo>
480         Print information about the symmetric encryption algorithm and
481         the MDC method.  This will be emitted even if the decryption
482         fails.
483
484     DECRYPTION_FAILED
485         The symmetric decryption failed - one reason could be a wrong
486         passphrase for a symmetrical encrypted message.
487
488     DECRYPTION_OKAY
489         The decryption process succeeded.  This means, that either the
490         correct secret key has been used or the correct passphrase
491         for a conventional encrypted message was given.  The program
492         itself may return an errorcode because it may not be possible to
493         verify a signature for some reasons.
494
495     BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
496     END_ENCRYPTION
497         Mark the start and end of the actual encryption process.
498
499     BEGIN_SIGNING
500        Mark the start of the actual signing process. This may be used
501        as an indication that all requested secret keys are ready for
502        use.
503
504     DELETE_PROBLEM reason_code
505         Deleting a key failed.  Reason codes are:
506             1 - No such key
507             2 - Must delete secret key first
508             3 - Ambigious specification
509
510     PROGRESS what char cur total
511         Used by the primegen and Public key functions to indicate progress.
512         "char" is the character displayed with no --status-fd enabled, with
513         the linefeed replaced by an 'X'.  "cur" is the current amount
514         done and "total" is amount to be done; a "total" of 0 indicates that
515         the total amount is not known.  The condition
516            TOATL && CUR == TOTAL
517         may be used to detect the end of an operation.
518         Well known values for WHAT:
519              "pk_dsa"   - DSA key generation
520              "pk_elg"   - Elgamal key generation
521              "primegen" - Prime generation
522              "need_entropy" - Waiting for new entropy in the RNG
523              "file:XXX" - processing file XXX
524                           (note that current gpg versions leave out the
525                            "file:" prefix).
526              "tick"     - generic tick without any special meaning - useful
527                           for letting clients know that the server is
528                           still working.
529              "starting_agent" - A gpg-agent was started because it is not
530                           running as a daemon.
531              "learncard"  Send by the agent and gpgsm while learing
532                           the data of a smartcard.
533              "card_busy"  A smartcard is still working
534
535     SIG_CREATED <type> <pubkey algo> <hash algo> <class> <timestamp> <key fpr>
536         A signature has been created using these parameters.
537             type:  'D' = detached
538                    'C' = cleartext
539                    'S' = standard
540                    (only the first character should be checked)
541             class: 2 hex digits with the signature class
542
543         Note, that TIMESTAMP may either be a number with seconds since
544         epoch or an ISO 8601 string which can be detected by the
545         presence of the letter 'T' inside.
546
547     KEY_CREATED <type> <fingerprint> [<handle>]
548         A key has been created
549             type: 'B' = primary and subkey
550                   'P' = primary
551                   'S' = subkey
552         The fingerprint is one of the primary key for type B and P and
553         the one of the subkey for S.  Handle is an arbitrary
554         non-whitespace string used to match key parameters from batch
555         key creation run.
556
557     KEY_NOT_CREATED [<handle>]
558         The key from batch run has not been created due to errors.
559
560
561     SESSION_KEY  <algo>:<hexdigits>
562         The session key used to decrypt the message.  This message will
563         only be emitted when the special option --show-session-key
564         is used.  The format is suitable to be passed to the option
565         --override-session-key
566
567     NOTATION_NAME <name>
568     NOTATION_DATA <string>
569         name and string are %XX escaped; the data may be split
570         among several NOTATION_DATA lines.
571
572     USERID_HINT <long main keyid> <string>
573         Give a hint about the user ID for a certain keyID.
574
575     POLICY_URL <string>
576         string is %XX escaped
577
578     BEGIN_STREAM
579     END_STREAM
580         Issued by pipemode.
581
582     INV_RECP <reason> <requested_recipient>
583     INV_SGNR <reason> <requested_sender>
584         Issued for each unusable recipient/sender. The reasons codes
585         currently in use are:
586           0 := "No specific reason given".
587           1 := "Not Found"
588           2 := "Ambigious specification"
589           3 := "Wrong key usage"
590           4 := "Key revoked"
591           5 := "Key expired"
592           6 := "No CRL known"
593           7 := "CRL too old"
594           8 := "Policy mismatch"
595           9 := "Not a secret key"
596          10 := "Key not trusted"
597          11 := "Missing certificate"
598          12 := "Missing issuer certificate"
599
600         Note that for historical reasons the INV_RECP status is also
601         used for gpgsm's SIGNER command where it relates to signer's
602         of course.  Newer GnuPG versions are using INV_SGNR;
603         applications should ignore the INV_RECP during the sender's
604         command processing once they have seen an INV_SGNR.  We use
605         different code so that we can distinguish them while doing an
606         encrypt+sign.
607
608
609     NO_RECP <reserved>
610     NO_SGNR <reserved>
611         Issued when no recipients/senders are usable.
612
613     ALREADY_SIGNED <long-keyid>
614         Warning: This is experimental and might be removed at any time.
615
616     TRUNCATED <maxno>
617         The output was truncated to MAXNO items.  This status code is issued
618         for certain external requests
619
620     ERROR <error location> <error code> [<more>]
621
622         This is a generic error status message, it might be followed
623         by error location specific data. <error code> and
624         <error_location> should not contain spaces.  The error code is
625         a either a string commencing with a letter or such a string
626         prefixed with a numerical error code and an underscore; e.g.:
627         "151011327_EOF".
628
629     SUCCESS [<location>]
630         Postive confirimation that an operation succeeded.  <location>
631         is optional but if given should not contain spaces.
632         Used only with a few commands.
633
634
635     ATTRIBUTE <fpr> <octets> <type> <index> <count>
636               <timestamp> <expiredate> <flags>
637         This is one long line issued for each attribute subpacket when
638         an attribute packet is seen during key listing.  <fpr> is the
639         fingerprint of the key. <octets> is the length of the
640         attribute subpacket. <type> is the attribute type
641         (1==image). <index>/<count> indicates that this is the Nth
642         indexed subpacket of count total subpackets in this attribute
643         packet.  <timestamp> and <expiredate> are from the
644         self-signature on the attribute packet.  If the attribute
645         packet does not have a valid self-signature, then the
646         timestamp is 0.  <flags> are a bitwise OR of:
647                 0x01 = this attribute packet is a primary uid
648                 0x02 = this attribute packet is revoked
649                 0x04 = this attribute packet is expired
650
651     CARDCTRL <what> [<serialno>]
652         This is used to control smartcard operations.
653         Defined values for WHAT are:
654            1 = Request insertion of a card.  Serialnumber may be given
655                to request a specific card.  Used by gpg 1.4 w/o scdaemon.
656            2 = Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
657            3 = Card with serialnumber detected
658            4 = No card available.
659            5 = No card reader available
660            6 = No card support available
661
662     PLAINTEXT <format> <timestamp> <filename>
663         This indicates the format of the plaintext that is about to be
664         written.  The format is a 1 byte hex code that shows the
665         format of the plaintext: 62 ('b') is binary data, 74 ('t') is
666         text data with no character set specified, and 75 ('u') is
667         text data encoded in the UTF-8 character set.  The timestamp
668         is in seconds since the epoch.  If a filename is available it
669         gets printed as the third argument, percent-escaped as usual.
670
671     PLAINTEXT_LENGTH <length>
672         This indicates the length of the plaintext that is about to be
673         written.  Note that if the plaintext packet has partial length
674         encoding it is not possible to know the length ahead of time.
675         In that case, this status tag does not appear.
676
677     SIG_SUBPACKET <type> <flags> <len> <data>
678         This indicates that a signature subpacket was seen.  The
679         format is the same as the "spk" record above.
680
681     SC_OP_FAILURE [<code>]
682         An operation on a smartcard definitely failed.  Currently
683         there is no indication of the actual error code, but
684         application should be prepared to later accept more arguments.
685         Defined values for CODE are:
686            0 - unspecified error (identically to a missing CODE)
687            1 - canceled
688            2 - bad PIN
689
690     SC_OP_SUCCESS
691         A smart card operaion succeeded.  This status is only printed
692         for certain operation and is mostly useful to check whether a
693         PIN change really worked.
694
695     BACKUP_KEY_CREATED fingerprint fname
696         A backup key named FNAME has been created for the key with
697         KEYID.
698
699     MOUNTPOINT <name>
700         NAME is a percent-plus escaped filename describing the
701         mountpoint for the current operation (e.g. g13 --mount).  This
702         may either be the specified mountpoint or one randomly choosen
703         by g13.
704
705
706 Status lines which are not anymore used:
707
708     SIGEXPIRED removed on 2011-02-04.
709         This is deprecated in favor of KEYEXPIRED.
710
711
712
713
714 Format of the "--attribute-fd" output
715 =====================================
716
717 When --attribute-fd is set, during key listings (--list-keys,
718 --list-secret-keys) GnuPG dumps each attribute packet to the file
719 descriptor specified.  --attribute-fd is intended for use with
720 --status-fd as part of the required information is carried on the
721 ATTRIBUTE status tag (see above).
722
723 The contents of the attribute data is specified by RFC 4880.  For
724 convenience, here is the Photo ID format, as it is currently the only
725 attribute defined:
726
727    Byte 0-1:  The length of the image header.  Due to a historical
728               accident (i.e. oops!) back in the NAI PGP days, this is
729               a little-endian number.  Currently 16 (0x10 0x00).
730
731    Byte 2:    The image header version.  Currently 0x01.
732
733    Byte 3:    Encoding format.  0x01 == JPEG.
734
735    Byte 4-15: Reserved, and currently unused.
736
737    All other data after this header is raw image (JPEG) data.
738
739
740 Format of the "--list-config" output
741 ====================================
742
743 --list-config outputs information about the GnuPG configuration for
744 the benefit of frontends or other programs that call GnuPG.  There are
745 several list-config items, all colon delimited like the rest of the
746 --with-colons output.  The first field is always "cfg" to indicate
747 configuration information.  The second field is one of (with
748 examples):
749
750 version: the third field contains the version of GnuPG.
751
752    cfg:version:1.3.5
753
754 pubkey: the third field contains the public key algorithmdcaiphers
755         this version of GnuPG supports, separated by semicolons.  The
756         algorithm numbers are as specified in RFC-4880.  Note that in
757         contrast to the --status-fd interface these are _not_ the
758         Libgcrypt identifiers.
759
760    cfg:pubkey:1;2;3;16;17
761
762 cipher: the third field contains the symmetric ciphers this version of
763         GnuPG supports, separated by semicolons.  The cipher numbers
764         are as specified in RFC-4880.
765
766    cfg:cipher:2;3;4;7;8;9;10
767
768 digest: the third field contains the digest (hash) algorithms this
769         version of GnuPG supports, separated by semicolons.  The
770         digest numbers are as specified in RFC-4880.
771
772    cfg:digest:1;2;3;8;9;10
773
774 compress: the third field contains the compression algorithms this
775           version of GnuPG supports, separated by semicolons.  The
776           algorithm numbers are as specified in RFC-4880.
777
778    cfg:compress:0;1;2;3
779
780 group: the third field contains the name of the group, and the fourth
781        field contains the values that the group expands to, separated
782        by semicolons.
783
784 For example, a group of:
785    group mynames = paige 0x12345678 joe patti
786
787 would result in:
788    cfg:group:mynames:patti;joe;0x12345678;paige
789
790
791 Key generation
792 ==============
793 See the Libcrypt manual.
794
795
796 Unattended key generation
797 =========================
798 The the manual for a description.
799
800
801 Layout of the TrustDB
802 =====================
803 The TrustDB is built from fixed length records, where the first byte
804 describes the record type.  All numeric values are stored in network
805 byte order. The length of each record is 40 bytes. The first record of
806 the DB is always of type 1 and this is the only record of this type.
807
808 FIXME:  The layout changed, document it here.
809
810   Record type 0:
811   --------------
812     Unused record, can be reused for any purpose.
813
814   Record type 1:
815   --------------
816     Version information for this TrustDB.  This is always the first
817     record of the DB and the only one with type 1.
818      1 byte value 1
819      3 bytes 'gpg'  magic value
820      1 byte Version of the TrustDB (2)
821      1 byte marginals needed
822      1 byte completes needed
823      1 byte max_cert_depth
824             The three items are used to check whether the cached
825             validity value from the dir record can be used.
826      1 u32  locked flags [not used]
827      1 u32  timestamp of trustdb creation
828      1 u32  timestamp of last modification which may affect the validity
829             of keys in the trustdb.  This value is checked against the
830             validity timestamp in the dir records.
831      1 u32  timestamp of last validation [currently not used]
832             (Used to keep track of the time, when this TrustDB was checked
833              against the pubring)
834      1 u32  record number of keyhashtable [currently not used]
835      1 u32  first free record
836      1 u32  record number of shadow directory hash table [currently not used]
837             It does not make sense to combine this table with the key table
838             because the keyid is not in every case a part of the fingerprint.
839      1 u32  record number of the trusthashtbale
840
841
842   Record type 2: (directory record)
843   --------------
844     Informations about a public key certificate.
845     These are static values which are never changed without user interaction.
846
847      1 byte value 2
848      1 byte  reserved
849      1 u32   LID     .  (This is simply the record number of this record.)
850      1 u32   List of key-records (the first one is the primary key)
851      1 u32   List of uid-records
852      1 u32   cache record
853      1 byte  ownertrust
854      1 byte  dirflag
855      1 byte  maximum validity of all the user ids
856      1 u32   time of last validity check.
857      1 u32   Must check when this time has been reached.
858              (0 = no check required)
859
860
861   Record type 3:  (key record)
862   --------------
863     Informations about a primary public key.
864     (This is mainly used to lookup a trust record)
865
866      1 byte value 3
867      1 byte  reserved
868      1 u32   LID
869      1 u32   next   - next key record
870      7 bytes reserved
871      1 byte  keyflags
872      1 byte  pubkey algorithm
873      1 byte  length of the fingerprint (in bytes)
874      20 bytes fingerprint of the public key
875               (This is the value we use to identify a key)
876
877   Record type 4: (uid record)
878   --------------
879     Informations about a userid
880     We do not store the userid but the hash value of the userid because that
881     is sufficient.
882
883      1 byte value 4
884      1 byte reserved
885      1 u32  LID  points to the directory record.
886      1 u32  next   next userid
887      1 u32  pointer to preference record
888      1 u32  siglist  list of valid signatures
889      1 byte uidflags
890      1 byte validity of the key calculated over this user id
891      20 bytes ripemd160 hash of the username.
892
893
894   Record type 5: (pref record)
895   --------------
896     This record type is not anymore used.
897
898      1 byte value 5
899      1 byte   reserved
900      1 u32  LID; points to the directory record (and not to the uid record!).
901             (or 0 for standard preference record)
902      1 u32  next
903      30 byte preference data
904
905   Record type 6  (sigrec)
906   -------------
907     Used to keep track of key signatures. Self-signatures are not
908     stored.  If a public key is not in the DB, the signature points to
909     a shadow dir record, which in turn has a list of records which
910     might be interested in this key (and the signature record here
911     is one).
912
913      1 byte   value 6
914      1 byte   reserved
915      1 u32    LID           points back to the dir record
916      1 u32    next   next sigrec of this uid or 0 to indicate the
917                      last sigrec.
918      6 times
919         1 u32  Local_id of signatures dir or shadow dir record
920         1 byte Flag: Bit 0 = checked: Bit 1 is valid (we have a real
921                              directory record for this)
922                          1 = valid is set (but may be revoked)
923
924
925
926   Record type 8: (shadow directory record)
927   --------------
928     This record is used to reserve a LID for a public key.  We
929     need this to create the sig records of other keys, even if we
930     do not yet have the public key of the signature.
931     This record (the record number to be more precise) will be reused
932     as the dir record when we import the real public key.
933
934      1 byte value 8
935      1 byte  reserved
936      1 u32   LID      (This is simply the record number of this record.)
937      2 u32   keyid
938      1 byte  pubkey algorithm
939      3 byte reserved
940      1 u32   hintlist   A list of records which have references to
941                         this key.  This is used for fast access to
942                         signature records which are not yet checked.
943                         Note, that this is only a hint and the actual records
944                         may not anymore hold signature records for that key
945                         but that the code cares about this.
946     18 byte reserved
947
948
949
950   Record Type 10 (hash table)
951   --------------
952     Due to the fact that we use fingerprints to lookup keys, we can
953     implement quick access by some simple hash methods, and avoid
954     the overhead of gdbm.  A property of fingerprints is that they can be
955     used directly as hash values.  (They can be considered as strong
956     random numbers.)
957       What we use is a dynamic multilevel architecture, which combines
958     hashtables, record lists, and linked lists.
959
960     This record is a hashtable of 256 entries; a special property
961     is that all these records are stored consecutively to make one
962     big table. The hash value is simple the 1st, 2nd, ... byte of
963     the fingerprint (depending on the indirection level).
964
965     When used to hash shadow directory records, a different table is used
966     and indexed by the keyid.
967
968      1 byte value 10
969      1 byte reserved
970      n u32  recnum; n depends on the record length:
971             n = (reclen-2)/4  which yields 9 for the current record length
972             of 40 bytes.
973
974     the total number of such record which makes up the table is:
975          m = (256+n-1) / n
976     which is 29 for a record length of 40.
977
978     To look up a key we use the first byte of the fingerprint to get
979     the recnum from this hashtable and look up the addressed record:
980        - If this record is another hashtable, we use 2nd byte
981          to index this hash table and so on.
982        - if this record is a hashlist, we walk all entries
983          until we found one a matching one.
984        - if this record is a key record, we compare the
985          fingerprint and to decide whether it is the requested key;
986
987
988   Record type 11 (hash list)
989   --------------
990     see hash table for an explanation.
991     This is also used for other purposes.
992
993     1 byte value 11
994     1 byte reserved
995     1 u32  next          next hash list record
996     n times              n = (reclen-5)/5
997         1 u32  recnum
998
999     For the current record length of 40, n is 7
1000
1001
1002
1003   Record type 254 (free record)
1004   ---------------
1005     All these records form a linked list of unused records.
1006      1 byte  value 254
1007      1 byte  reserved (0)
1008      1 u32   next_free
1009
1010
1011
1012 GNU extensions to the S2K algorithm
1013 ===================================
1014 S2K mode 101 is used to identify these extensions.
1015 After the hash algorithm the 3 bytes "GNU" are used to make
1016 clear that these are extensions for GNU, the next bytes gives the
1017 GNU protection mode - 1000.  Defined modes are:
1018   1001 - do not store the secret part at all
1019   1002 - a stub to access smartcards (not used in 1.2.x)
1020
1021
1022
1023 Other Notes
1024 ===========
1025     * For packet version 3 we calculate the keyids this way:
1026         RSA     := low 64 bits of n
1027         ELGAMAL := build a v3 pubkey packet (with CTB 0x99) and calculate
1028                    a rmd160 hash value from it. This is used as the
1029                    fingerprint and the low 64 bits are the keyid.
1030
1031     * Revocation certificates consist only of the signature packet;
1032       "import" knows how to handle this.  The rationale behind it is
1033       to keep them small.
1034
1035
1036 OIDs below the GnuPG arc:
1037 =========================
1038
1039  1.3.6.1.4.1.11591.2          GnuPG
1040  1.3.6.1.4.1.11591.2.1          notation
1041  1.3.6.1.4.1.11591.2.1.1          pkaAddress
1042  1.3.6.1.4.1.11591.2.2          X.509 extensions
1043  1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
1044  1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
1045  1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
1046
1047
1048
1049 Keyserver Message Format
1050 =========================
1051
1052 The keyserver may be contacted by a Unix Domain socket or via TCP.
1053
1054 The format of a request is:
1055
1056 ====
1057 command-tag
1058 "Content-length:" digits
1059 CRLF
1060 =======
1061
1062 Where command-tag is
1063
1064 NOOP
1065 GET <user-name>
1066 PUT
1067 DELETE <user-name>
1068
1069
1070 The format of a response is:
1071
1072 ======
1073 "GNUPG/1.0" status-code status-text
1074 "Content-length:" digits
1075 CRLF
1076 ============
1077 followed by <digits> bytes of data
1078
1079
1080 Status codes are:
1081
1082      o  1xx: Informational - Request received, continuing process
1083
1084      o  2xx: Success - The action was successfully received, understood,
1085         and accepted
1086
1087      o  4xx: Client Error - The request contains bad syntax or cannot be
1088         fulfilled
1089
1090      o  5xx: Server Error - The server failed to fulfill an apparently
1091         valid request
1092
1093
1094
1095 Documentation on HKP (the http keyserver protocol):
1096
1097 A minimalistic HTTP server on port 11371 recognizes a GET for /pks/lookup.
1098 The standard http URL encoded query parameters are this (always key=value):
1099
1100 - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1101   pgp -kxa)
1102
1103 - search=<stringlist>. This is a list of words that must occur in the key.
1104   The words are delimited with space, points, @ and so on. The delimiters
1105   are not searched for and the order of the words doesn't matter (but see
1106   next option).
1107
1108 - exact=on. This switch tells the hkp server to only report exact matching
1109   keys back. In this case the order and the "delimiters" are important.
1110
1111 - fingerprint=on. Also reports the fingerprints when used with 'index' or
1112   'vindex'
1113
1114 The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1115 keys.
1116
1117
1118 A better way to do this would be a request like:
1119
1120    /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1121
1122 This can be implemented using Hurd's translator mechanism.
1123 However, I think the whole key server stuff has to be re-thought;
1124 I have some ideas and probably create a white paper.