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