See ChangeLog: Fri Feb 26 17:55:41 CET 1999 Werner Koch
[gnupg.git] / doc / DETAILS
1
2 Format of "---with-colons" listings
3 ===================================
4
5 sec::1024:17:6C7EE1B8621CC013:1998-07-07:0:::Werner Koch <werner.koch@guug.de>:
6 ssb::1536:20:5CE086B5B5A18FF4:1998-07-07:0:::
7
8  1. Field:  Type of record
9             pub = public key
10             sub = subkey (secondary key)
11             sec = secret key
12             ssb = secret subkey (secondary key)
13             uid = user id (only field 10 is used).
14             fpr = fingerprint: (fingerprint is in field 10)
15
16  2. Field:  A letter describing the calculated trust, see doc/FAQ
17             This is a single letter, but be prepared that additional
18             information may follow in some future versions.
19             (not used for secret keys)
20  3. Field:  length of key in bits.
21  4. Field:  Algorithm:  1 = RSA
22                        16 = ElGamal (encrypt only)
23                        17 = DSA (sometimes called DH, sign only)
24                        20 = ElGamal (sign and encrypt)
25  5. Field:  KeyID
26  6. Field:  Creation Date (in UTC)
27  7. Field:  Key expiration date or empty if none.
28  8. Field:  Local ID: record number of the dir record in the trustdb
29             this value is only valid as long as the trustdb is not
30             deleted.  May be later used to lookup the key: You will be
31             able to use "#<local-id> as the user id.  This is needed
32             because keyids may not be unique - a program may use this
33             number to access keys later.
34  9. Field:  Ownertrust (primary public keys only)
35             This is a single letter, but be prepared that additional
36             information may follow in some future versions.
37 10. Field:  User-ID.  The value is quoted like a C string to avoid
38             control characters (the colon is quoted "\x3a").
39
40 More fields may be added later.
41
42
43 Format of the "--status-fd" output
44 ==================================
45 Every line is prefixed with "[GNUPG:] ", followed by a keyword with
46 the type of the status line and a some arguments depending on the
47 type (maybe none); an application should always be prepared to see
48 more arguments in future versions.
49
50
51     GOODSIG     <long keyid>  <username>
52         The signature with the keyid is good.
53
54     BADSIG      <long keyid>  <username>
55         The signature with the keyid has not been verified okay.
56
57     ERRSIG
58         It was not possible to check the signature.  This may be
59         caused by a missing public key or an unsupported algorithm.
60         No argument yet.
61
62     VALIDSIG    <fingerprint in hex>
63         The signature with the keyid is good. This is the same
64         as GOODSIG but has the fingerprint as the argument. Both
65         status lines ere emitted for a good signature.
66
67     SIG_ID  <radix64_string>
68         This is emitted only for DSA or ElGamal signatures which
69         have been verified okay.  The strings is a signature id
70         and maybe used in applications to detect replay attacks
71         of signed messages.
72
73     TRUST_UNDEFINED
74     TRUST_NEVER
75     TRUST_MARGINAL
76     TRUST_FULLY
77     TRUST_ULTIMATE
78         For good signatures one of these status lines are emitted
79         to indicate how trustworthy the signature is.  No arguments yet.
80
81     SIGEXPIRED
82         The signature key has expired.  No arguments yet.
83
84     KEYREVOKED
85         The used key has been revoked by his owner.  No arguments yet.
86
87     BADARMOR
88         The ASCII armor is corrupted.  No arguments yet.
89
90     RSA_OR_IDEA
91         The RSA or IDEA algorithms has been used in the data.  A
92         program might want to fallback to another program to handle
93         the data if GnuPG failed.
94
95     SHM_INFO
96     SHM_GET
97     SHM_GET_BOOL
98     SHM_GET_HIDDEN
99     NEED_PASSPHRASE
100         [Needs documentation]
101
102
103
104
105 Key generation
106 ==============
107     Key generation shows progress by printing different characters to
108     stderr:
109              "."  Last 10 Miller-Rabin tests failed
110              "+"  Miller-Rabin test succeeded
111              "!"  Reloading the pool with fresh prime numbers
112              "^"  Checking a new value for the generator
113              "<"  Size of one factor decreased
114              ">"  Size of one factor increased
115
116     The prime number for ElGamal is generated this way:
117
118     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize)
119     2) Select the length of the other prime factors to be at least the size
120        of q and calculate the number of prime factors needed
121     3) Make a pool of prime numbers, each of the length determined in step 2
122     4) Get a new permutation out of the pool or continue with step 3
123        if we have tested all permutations.
124     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
125     6) Check that this prime has the correct length (this may change q if
126        it seems not to be possible to make a prime of the desired length)
127     7) Check whether this is a prime using trial divisions and the
128        Miller-Rabin test.
129     8) Continue with step 4 if we did not find a prime in step 7.
130     9) Find a generator for that prime.
131
132
133
134 Layout of the TrustDB
135 =====================
136 The TrustDB is built from fixed length records, where the first byte
137 describes the record type.  All numeric values are stored in network
138 byte order. The length of each record is 40 bytes. The first record of
139 the DB is always of type 2 and this is the only record of this type.
140
141 Record type 0:
142 --------------
143     Unused record, can be reused for any purpose.
144
145 Record type 1:
146 --------------
147     Version information for this TrustDB.  This is always the first
148     record of the DB and the only one with type 1.
149      1 byte value 1
150      3 bytes 'gpg'  magic value
151      1 byte Version of the TrustDB (2)
152      1 byte marginals needed
153      1 byte completes needed
154      1 byte max_cert_depth
155             The three items are used to check whether the cached
156             validity value from the dir record can be used.
157      1 u32  locked flags
158      1 u32  timestamp of trustdb creation
159      1 u32  timestamp of last modification
160      1 u32  timestamp of last validation
161             (Used to keep track of the time, when this TrustDB was checked
162              against the pubring)
163      1 u32  record number of keyhashtable
164      1 u32  first free record
165      1 u32  record number of shadow directory hash table
166             It does not make sense to combine this table with the key table
167             because the keyid is not in every case a part of the fingerprint.
168      4 bytes reserved for version extension record
169
170
171 Record type 2: (directory record)
172 --------------
173     Informations about a public key certificate.
174     These are static values which are never changed without user interaction.
175
176      1 byte value 2
177      1 byte  reserved
178      1 u32   LID     .  (This is simply the record number of this record.)
179      1 u32   List of key-records (the first one is the primary key)
180      1 u32   List of uid-records
181      1 u32   cache record
182      1 byte  ownertrust
183      1 byte  dirflag
184      1 byte  validity of the key calucalted over all user ids
185     19 byte reserved
186
187
188 Record type 3:  (key record)
189 --------------
190     Informations about a primary public key.
191     (This is mainly used to lookup a trust record)
192
193      1 byte value 3
194      1 byte  reserved
195      1 u32   LID
196      1 u32   next   - next key record
197      7 bytes reserved
198      1 byte  keyflags
199      1 byte  pubkey algorithm
200      1 byte  length of the fingerprint (in bytes)
201      20 bytes fingerprint of the public key
202               (This is the value we use to identify a key)
203
204 Record type 4: (uid record)
205 --------------
206     Informations about a userid
207     We do not store the userid but the hash value of the userid because that
208     is sufficient.
209
210      1 byte value 4
211      1 byte reserved
212      1 u32  LID  points to the directory record.
213      1 u32  next   next userid
214      1 u32  pointer to preference record
215      1 u32  siglist  list of valid signatures
216      1 byte uidflags
217      1 byte validity of the key calculated over this user id
218      20 bytes ripemd160 hash of the username.
219
220
221 Record type 5: (pref record)
222 --------------
223     Informations about preferences
224
225      1 byte value 5
226      1 byte   reserved
227      1 u32  LID; points to the directory record (and not to the uid record!).
228             (or 0 for standard preference record)
229      1 u32  next
230      30 byte preference data
231
232 Record type 6  (sigrec)
233 -------------
234     Used to keep track of key signatures. Self-signatures are not
235     stored.  If a public key is not in the DB, the signature points to
236     a shadow dir record, which in turn has a list of records which
237     might be interested in this key (and the signature record here
238     is one).
239
240      1 byte   value 6
241      1 byte   reserved
242      1 u32    LID           points back to the dir record
243      1 u32    next   next sigrec of this uid or 0 to indicate the
244                      last sigrec.
245      6 times
246         1 u32  Local_id of signators dir or shadow dir record
247         1 byte Flag: Bit 0 = checked: Bit 1 is valid (we have a real
248                               directory record for this)
249                          1 = valid is set (but my be revoked)
250
251
252
253 Record type 8: (shadow directory record)
254 --------------
255     This record is used to reserved a LID for a public key.  We
256     need this to create the sig records of other keys, even if we
257     do not yet have the public key of the signature.
258     This record (the record number to be more precise) will be reused
259     as the dir record when we import the real public key.
260
261      1 byte value 8
262      1 byte  reserved
263      1 u32   LID      (This is simply the record number of this record.)
264      2 u32   keyid
265      1 byte  pubkey algorithm
266      3 byte reserved
267      1 u32   hintlist   A list of records which have references to
268                         this key.  This is used for fast access to
269                         signature records which are not yet checked.
270                         Note, that this is only a hint and the actual records
271                         may not anymore hold signature records for that key
272                         but that the code cares about this.
273     18 byte reserved
274
275
276
277 Record type 9:  (cache record)
278 --------------
279     Used to bind the trustDB to the concrete instance of keyblock in
280     a pubring. This is used to cache information.
281
282      1 byte   value 9
283      1 byte   reserved
284      1 u32    Local-Id.
285      8 bytes  keyid of the primary key (needed?)
286      1 byte   cache-is-valid the following stuff is only
287               valid if this is set.
288      1 byte   reserved
289      20 bytes rmd160 hash value over the complete keyblock
290               This is used to detect any changes of the keyblock with all
291               CTBs and lengths headers. Calculation is easy if the keyblock
292               is obtained from a keyserver: simply create the hash from all
293               received data bytes.
294
295      1 byte   number of untrusted signatures.
296      1 byte   number of marginal trusted signatures.
297      1 byte   number of fully trusted signatures.
298               (255 is stored for all values greater than 254)
299      1 byte   Trustlevel
300                 0 = undefined (not calculated)
301                 1 = unknown
302                 2 = not trusted
303                 3 = marginally trusted
304                 4 = fully trusted
305                 5 = ultimately trusted (have secret key too).
306
307
308 Record Type 10 (hash table)
309 --------------
310     Due to the fact that we use fingerprints to lookup keys, we can
311     implement quick access by some simple hash methods, and avoid
312     the overhead of gdbm.  A property of fingerprints is that they can be
313     used directly as hash values.  (They can be considered as strong
314     random numbers.)
315       What we use is a dynamic multilevel architecture, which combines
316     hashtables, record lists, and linked lists.
317
318     This record is a hashtable of 256 entries; a special property
319     is that all these records are stored consecutively to make one
320     big table. The hash value is simple the 1st, 2nd, ... byte of
321     the fingerprint (depending on the indirection level).
322
323     When used to hash shadow directory records, a different table is used
324     and indexed by the keyid.
325
326      1 byte value 10
327      1 byte reserved
328      n u32  recnum; n depends on the record length:
329             n = (reclen-2)/4  which yields 9 for the current record length
330             of 40 bytes.
331
332     the total number of such record which makes up the table is:
333          m = (256+n-1) / n
334     which is 29 for a record length of 40.
335
336     To look up a key we use the first byte of the fingerprint to get
337     the recnum from this hashtable and look up the addressed record:
338        - If this record is another hashtable, we use 2nd byte
339          to index this hash table and so on.
340        - if this record is a hashlist, we walk all entries
341          until we found one a matching one.
342        - if this record is a key record, we compare the
343          fingerprint and to decide whether it is the requested key;
344
345
346 Record type 11 (hash list)
347 --------------
348     see hash table for an explanation.
349     This is also used for other purposes.
350
351     1 byte value 11
352     1 byte reserved
353     1 u32  next          next hash list record
354     n times              n = (reclen-5)/5
355         1 u32  recnum
356
357     For the current record length of 40, n is 7
358
359
360
361 Record type 254 (free record)
362 ---------------
363     All these records form a linked list of unused records.
364      1 byte  value 254
365      1 byte  reserved (0)
366      1 u32   next_free
367
368
369
370 Packet Headers
371 ===============
372
373 GNUPG uses PGP 2 packet headers and also understands OpenPGP packet header.
374 There is one enhancement used with the old style packet headers:
375
376    CTB bits 10, the "packet-length length bits", have values listed in
377    the following table:
378
379       00 - 1-byte packet-length field
380       01 - 2-byte packet-length field
381       10 - 4-byte packet-length field
382       11 - no packet length supplied, unknown packet length
383
384    As indicated in this table, depending on the packet-length length
385    bits, the remaining 1, 2, 4, or 0 bytes of the packet structure field
386    are a "packet-length field".  The packet-length field is a whole
387    number field.  The value of the packet-length field is defined to be
388    the value of the whole number field.
389
390    A value of 11 is currently used in one place: on compressed data.
391    That is, a compressed data block currently looks like <A3 01 . .  .>,
392    where <A3>, binary 10 1000 11, is an indefinite-length packet. The
393    proper interpretation is "until the end of the enclosing structure",
394    although it should never appear outermost (where the enclosing
395    structure is a file).
396
397 +  This will be changed with another version, where the new meaning of
398 +  the value 11 (see below) will also take place.
399 +
400 +  A value of 11 for other packets enables a special length encoding,
401 +  which is used in case, where the length of the following packet can
402 +  not be determined prior to writing the packet; especially this will
403 +  be used if large amounts of data are processed in filter mode.
404 +
405 +  It works like this: After the CTB (with a length field of 11) a
406 +  marker field is used, which gives the length of the following datablock.
407 +  This is a simple 2 byte field (MSB first) containing the amount of data
408 +  following this field, not including this length field. After this datablock
409 +  another length field follows, which gives the size of the next datablock.
410 +  A value of 0 indicates the end of the packet. The maximum size of a
411 +  data block is limited to 65534, thereby reserving a value of 0xffff for
412 +  future extensions. These length markers must be inserted into the data
413 +  stream just before writing the data out.
414 +
415 +  This 2 byte filed is large enough, because the application must buffer
416 +  this amount of data to prepend the length marker before writing it out.
417 +  Data block sizes larger than about 32k doesn't make any sense. Note
418 +  that this may also be used for compressed data streams, but we must use
419 +  another packet version to tell the application that it can not assume,
420 +  that this is the last packet.
421
422
423 Usage of gdbm files for keyrings
424 ================================
425     The key to store the keyblock is it's fingerprint, other records
426     are used for secondary keys.  fingerprints are always 20 bytes
427     where 16 bit fingerprints are appended with zero.
428     The first byte of the key gives some information on the type of the
429     key.
430       1 = key is a 20 bit fingerprint (16 bytes fpr are padded with zeroes)
431           data is the keyblock
432       2 = key is the complete 8 byte keyid
433           data is a list of 20 byte fingerprints
434       3 = key is the short 4 byte keyid
435           data is a list of 20 byte fingerprints
436       4 = key is the email address
437           data is a list of 20 byte fingerprints
438
439     Data is prepended with a type byte:
440       1 = keyblock
441       2 = list of 20 byte padded fingerprints
442       3 = list of list fingerprints (but how to we key them?)
443
444
445
446
447 Other Notes
448 ===========
449     * For packet version 3 we calculate the keyids this way:
450         RSA     := low 64 bits of n
451         ELGAMAL := build a v3 pubkey packet (with CTB 0x99) and calculate
452                    a rmd160 hash value from it. This is used as the
453                    fingerprint and the low 64 bits are the keyid.
454
455     * Revocation certificates consist only of the signature packet;
456       "import" knows how to handle this.  The rationale behind it is
457       to keep them small.
458
459
460 Supported targets:
461 ------------------
462       powerpc-unknown-linux-gnu  (linuxppc)
463       hppa1.1-hp-hpux10.20
464
465
466
467
468
469
470
471
472 Keyserver Message Format
473 -------------------------
474
475 The keyserver may be contacted by a Unix Domain socket or via TCP.
476
477 The format of a request is:
478
479 ----
480 command-tag
481 "Content-length:" digits
482 CRLF
483 ------
484
485 Where command-tag is
486
487 NOOP
488 GET <user-name>
489 PUT
490 DELETE <user-name>
491
492
493 The format of a response is:
494
495 ------
496 "GNUPG/1.0" status-code status-text
497 "Content-length:" digits
498 CRLF
499 ------------
500 followed by <digits> bytes of data
501
502
503 Status codes are:
504
505      o  1xx: Informational - Request received, continuing process
506
507      o  2xx: Success - The action was successfully received, understood,
508         and accepted
509
510      o  4xx: Client Error - The request contains bad syntax or cannot be
511         fulfilled
512
513      o  5xx: Server Error - The server failed to fulfill an apparently
514         valid request
515
516
517
518 Ich werde jetzt doch das HKP Protokoll implementieren:
519
520 Naja, die Doku ist so gut wie nichtexistent, da gebe ich Dir recht.
521 In kurzen Worten:
522
523 (Minimal-)HTTP-Server auf Port 11371, versteht ein GET auf /pks/lookup,
524 wobei die Query-Parameter (Key-Value-Paare mit = zwischen Key und
525 Value; die Paare sind hinter ? und durch & getrennt). Gültige
526 Operationen sind:
527
528 - - op (Operation) mit den Möglichkeiten index (gleich wie -kv bei
529   PGP), vindex (-kvv) und get (-kxa)
530 - - search: Liste der Worte, die im Key vorkommen müssen. Worte sind
531   mit Worttrennzeichen wie Space, Punkt, @, ... getrennt, Worttrennzeichen
532   werden nicht betrachtet, die Reihenfolge der Worte ist egal.
533 - - exact: (on=aktiv, alles andere inaktiv) Nur die Schlüssel
534   zurückgeben, die auch den "search"-String beinhalten (d.h.
535   Wortreihenfolge und Sonderzeichen sind wichtig)
536 - - fingerprint (Bei [v]index auch den Fingerprint ausgeben), "on"
537   für aktiv, alles andere inaktiv
538
539 Neu (wird von GNUPG benutzt):
540    /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
541
542 Zusätzlich versteht der Keyserver auch ein POST auf /pks/add, womit
543 man Keys hochladen kann.
544