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