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