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