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