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