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