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