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