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