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