d306eb361290589c4bd2b193b86ef08eaa31eb60
[gnupg.git] / doc / DETAILS
1
2
3     * For packet version 3 we calculate the keyids this way:
4         RSA     := low 64 bits of n
5         ELGAMAL := build a v3 pubkey packet (with CTB 0x99) and calculate
6                    a rmd160 hash value from it. This is used as the
7                    fingerprint and the low 64 bits are the keyid.
8
9     * Revocation certificates consist only of the signature packet;
10       "import" knows how to handle this.  The rationale behind it is
11       to keep them small.
12
13
14     Key generation shows progress by printing different characters to
15     stderr:
16              "."  Last 10 Miller-Rabin tests failed
17              "+"  Miller-Rabin test succeeded
18              "!"  Reloading the pool with fresh prime numbers
19              "^"  Checking a new value for the generator
20              "<"  Size of one factor decreased
21              ">"  Size of one factor increased
22
23     The prime number for ElGamal is generated this way:
24
25     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize)
26     2) Select the length of the other prime factors to be at least the size
27        of q and calculate the number of prime factors needed
28     3) Make a pool of prime numbers, each of the length determined in step 2
29     4) Get a new permutation out of the pool or continue with step 3
30        if we have tested all permutations.
31     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
32     6) Check that this prime has the correct length (this may change q if
33        it seems not to be possible to make a prime of the desired length)
34     7) Check whether this is a prime using trial divisions and the
35        Miller-Rabin test.
36     8) Continue with step 4 if we did not find a prime in step 7.
37     9) Find a generator for that prime.
38
39
40
41
42 Layout of the TrustDB
43 =====================
44 FIXME: use a directory record as top node instead of the pubkey record
45
46 The TrustDB is built from fixed length records, where the first byte
47 describes the record type.  All numeric values are stored in network
48 byte order. The length of each record is 40 bytes. The first record of
49 the DB is always of type 1 and this is the only record of this type.
50
51 Record type 0:
52 --------------
53     Unused record, can be reused for any purpose.
54
55 Record type 1:
56 --------------
57     Version information for this TrustDB.  This is always the first
58     record of the DB and the only one with type 1.
59      1 byte value 1
60      3 bytes 'gpg'  magic value
61      1 byte Version of the TrustDB
62      3 byte reserved
63      1 u32  locked by (pid) 0 = not locked.
64      1 u32  timestamp of trustdb creation
65      1 u32  timestamp of last modification
66      1 u32  timestamp of last validation
67             (Used to keep track of the time, when this TrustDB was checked
68              against the pubring)
69      1 u32  reserved
70      1 byte marginals needed
71      1 byte completes needed
72      1 byte max. cert depth
73             If any of this 3 values are changed, all cache records
74             muts be invalidated.
75      9 bytes reserved
76
77
78 Record type 2: (directory record)
79 --------------
80     Informations about a public key certificate.
81     These are static values which are never changed without user interaction.
82
83      1 byte value 2
84      1 byte   reserved
85      8 bytes keyid (We keep it here to speed up searching by keyid)
86      1 u32   Local-Id.  This is simply the record number of this record.
87      1 u32   pubkey (record number of it)
88      1 u32   cache record
89      1 u32   sigrecord
90      1 byte  No signatures flag  (used to avoid duplicate building).
91      13 byte reserved
92
93
94 Record type 3:
95 --------------
96     Informations about a public key certificate.
97     These are static values which are never changed without user interaction.
98
99      1 byte value 3
100      1 byte   reserved
101      1 u32   owner  This is used to bind all records for
102              a given certificate together. It is valid only in this TrustDB
103              and useful if we have duplicate keyids
104              It points back to the directory node.
105      1 byte pubkey algorithm
106      1 byte reserved
107      20 bytes fingerprint of the public key
108      1 byte ownertrust:
109      3 byte reserved
110
111
112 Record type 4:  (cache record)
113 --------------
114     Used to bind the trustDB to the concrete instance of keyblock in
115     a pubring. This is used to cache information.
116
117      1 byte   value 4
118      1 byte   reserved
119      1 u32    Local-Id.
120      8 bytes  keyid of the primary key (needed?)
121      1 byte   cache-is-valid the following stuff is only
122               valid if this is set.
123      1 byte   reserved
124      20 bytes rmd160 hash value over the complete keyblock
125               This is used to detect any changes of the keyblock with all
126               CTBs and lengths headers. Calculation is easy if the keyblock
127               is optained from a keyserved: simply create the hash from all
128               received data bytes.
129
130      1 byte   number of untrusted signatures.
131      1 byte   number of marginal trusted signatures.
132      1 byte   number of fully trusted signatures.
133               (255 is stored for all values greater than 254)
134      1 byte   Trustlevel
135                 0 = undefined (not calculated)
136                 1 = unknown
137                 2 = not trusted
138                 3 = marginally trusted
139                 4 = fully trusted
140                 5 = ultimately trusted (have secret key too).
141
142 Record type 5  (sigrec)
143 -------------
144     Used to keep track of valid key signatures. Self-signatures are not
145     stored.
146
147      1 byte   value 5
148      1 byte   reserved
149      1 u32    For Local-Id (points back to the directory record)
150      1 u32    chain: next sigrec of this owner or 0 to indicate the
151               last sigrec.
152      6 times
153         1 u32  Local_id of signators pubkey record
154         1 byte reserved
155
156
157 Record Type 6 (hash table)
158 -------------
159     Due to the fact that we use the keyid to lookup keys, we can
160     implement quick access by some simple hash methods, and avoid
161     the overhead of gdbm.  A property of keyids is that they can be
162     used directly as hash values.  (They can be considered as strong
163     random numbers.)
164       What we use is a dynamic multilevel architecture, which combines
165     Hashtables, record lists, and linked lists.
166
167     This record is a hashtable of 256 entries; a special property
168     is that all these records are stored consecutively to make one
169     big table. The hash value is simple the 1st, 2nd, ... byte of
170     the keyid (depending on the indirection level).
171
172      1 byte value 5
173      1 byte reserved
174      n u32  recnum; n depends on th record length:
175             n = (reclen-2)/4  which yields 9 for the current record length
176             of 40 bytes.
177
178     the total number of surch record which makes up the table is:
179          m = (256+n-1) / n
180     which is 29 for a record length of 40.
181
182     To look up a key we use its lsb to get the recnum from this
183     hashtable and look up the addressed record:
184        - If this record is another hashtable, we use 2nd lsb
185          to index this hast table and so on.
186        - if this record is a hashlist, we walk thru the
187          reclist records until we found one whose hash field
188          matches the MSB of our keyid, and lookup this record
189        - if this record is a dir record, we compare the
190          keyid and if this is correct, we get the keyrecod and compare
191          the fingerprint to decide whether it is the requested key;
192          if this is not the correct dir record, we look at the next
193          dir record which is linked by the link field.
194
195 Record type 7  (hash list)
196 -------------
197     see hash table for an explanation.
198
199     1 byte value 6
200     1 byte reserved
201     1 u32  chain         next hash list record
202     n times              n = (reclen-6)/5
203         1 byte hash
204         1 u32  recnum
205
206     For the current record length of 40, n is 6
207
208
209
210
211 Packet Headers
212 ===============
213
214 GNUPG uses PGP 2 packet headers and also understands OpenPGP packet header.
215 There is one enhancement used with the old style packet headers:
216
217    CTB bits 10, the "packet-length length bits", have values listed in
218    the following table:
219
220       00 - 1-byte packet-length field
221       01 - 2-byte packet-length field
222       10 - 4-byte packet-length field
223       11 - no packet length supplied, unknown packet length
224
225    As indicated in this table, depending on the packet-length length
226    bits, the remaining 1, 2, 4, or 0 bytes of the packet structure field
227    are a "packet-length field".  The packet-length field is a whole
228    number field.  The value of the packet-length field is defined to be
229    the value of the whole number field.
230
231    A value of 11 is currently used in one place: on compressed data.
232    That is, a compressed data block currently looks like <A3 01 . .  .>,
233    where <A3>, binary 10 1000 11, is an indefinite-length packet. The
234    proper interpretation is "until the end of the enclosing structure",
235    although it should never appear outermost (where the enclosing
236    structure is a file).
237
238 +  This will be changed with another version, where the new meaning of
239 +  the value 11 (see below) will also take place.
240 +
241 +  A value of 11 for other packets enables a special length encoding,
242 +  which is used in case, where the length of the following packet can
243 +  not be determined prior to writing the packet; especially this will
244 +  be used if large amounts of data are processed in filter mode.
245 +
246 +  It works like this: After the CTB (with a length field of 11) a
247 +  marker field is used, which gives the length of the following datablock.
248 +  This is a simple 2 byte field (MSB first) containig the amount of data
249 +  following this field, not including this length field. After this datablock
250 +  another length field follows, which gives the size of the next datablock.
251 +  A value of 0 indicates the end of the packet. The maximum size of a
252 +  data block is limited to 65534, thereby reserving a value of 0xffff for
253 +  future extensions. These length markers must be insereted into the data
254 +  stream just before writing the data out.
255 +
256 +  This 2 byte filed is large enough, because the application must buffer
257 +  this amount of data to prepend the length marker before writing it out.
258 +  Data block sizes larger than about 32k doesn't make any sense. Note
259 +  that this may also be used for compressed data streams, but we must use
260 +  another packet version to tell the application that it can not assume,
261 +  that this is the last packet.
262
263
264
265
266
267 Keyserver Message Format
268 -------------------------
269
270 The keyserver may be contacted by a Unix Domain socket or via TCP.
271
272 The format of a request is:
273
274 ----
275 command-tag
276 "Content-length:" digits
277 CRLF
278 ------
279
280 Where command-tag is
281
282 NOOP
283 GET <user-name>
284 PUT
285 DELETE <user-name>
286
287
288 The format of a response is:
289
290 ------
291 "GNUPG/1.0" status-code status-text
292 "Content-length:" digits
293 CRLF
294 ------------
295 followed by <digits> bytes of data
296
297
298 Status codes are:
299
300      o  1xx: Informational - Request received, continuing process
301
302      o  2xx: Success - The action was successfully received, understood,
303         and accepted
304
305      o  4xx: Client Error - The request contains bad syntax or cannot be
306         fulfilled
307
308      o  5xx: Server Error - The server failed to fulfill an apparently
309         valid request
310
311
312
313 Ich werde jetzt doch das HKP Protokoll implementieren:
314
315 Naja, die Doku ist so gut wie nichtexistent, da gebe ich Dir recht.
316 In kurzen Worten:
317
318 (Minimal-)HTTP-Server auf Port 11371, versteht ein GET auf /pks/lookup,
319 wobei die Query-Parameter (Key-Value-Paare mit = zwischen Key und
320 Value; die Paare sind hinter ? und durch & getrennt). Gültige
321 Operationen sind:
322
323 - - op (Operation) mit den Möglichkeiten index (gleich wie -kv bei
324   PGP), vindex (-kvv) und get (-kxa)
325 - - search: Liste der Worte, die im Key vorkommen müssen. Worte sind
326   mit Worttrennzeichen wie Space, Punkt, @, ... getrennt, Worttrennzeichen
327   werden nicht betrachtet, die Reihenfolge der Worte ist egal.
328 - - exact: (on=aktiv, alles andere inaktiv) Nur die Schlüssel
329   zurückgeben, die auch den "search"-String beinhalten (d.h.
330   Wortreihenfolge und Sonderzeichen sind wichtig)
331 - - fingerprint (Bei [v]index auch den Fingerprint ausgeben), "on"
332   für aktiv, alles andere inaktiv
333
334 Neu (wird von GNUPG benutzt):
335    /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
336
337 Zusätzlich versteht der Keyserver auch ein POST auf /pks/add, womit
338 man Keys hochladen kann.
339