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