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