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