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