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