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