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