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