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