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