* samplekeys.asc: Updated.
[gnupg.git] / doc / DETAILS
1
2 Format of colon listings
3 ========================
4 First an example:
5
6 $ gpg --fixed-list-mode --with-colons --list-keys \
7    --with-fingerprint --with-fingerprint wk@gnupg.org
8
9 pub:f:1024:17:6C7EE1B8621CC013:899817715:1055898235::m:::scESC:
10 fpr:::::::::ECAF7590EB3443B5C7CF3ACB6C7EE1B8621CC013:
11 uid:f::::::::Werner Koch <wk@g10code.com>:
12 uid:f::::::::Werner Koch <wk@gnupg.org>:
13 sub:f:1536:16:06AD222CADF6A6E1:919537416:1036177416:::::e:
14 fpr:::::::::CF8BCC4B18DE08FCD8A1615906AD222CADF6A6E1:
15 sub:r:1536:20:5CE086B5B5A18FF4:899817788:1025961788:::::esc:
16 fpr:::::::::AB059359A3B81F410FCFF97F5CE086B5B5A18FF4:
17
18 The double --with-fingerprint prints the fingerprint for the subkeys
19 too, --fixed-list-mode is themodern listing way printing dates in
20 seconds since Epoch and does not merge the first userID with the pub
21 record.
22
23
24  1. Field:  Type of record
25             pub = public key
26             crt = X.509 certificate
27             crs = X.509 certificate and private key available
28             sub = subkey (secondary key)
29             sec = secret key
30             ssb = secret subkey (secondary key)
31             uid = user id (only field 10 is used).
32             uat = user attribute (same as user id except for field 10).
33             sig = signature
34             rev = revocation signature
35             fpr = fingerprint: (fingerprint is in field 10)
36             pkd = public key data (special field format, see below)
37             grp = reserved for gpgsm
38             rvk = revocation key
39             tru = trust database information
40
41  2. Field:  A letter describing the calculated trust. This is a single
42             letter, but be prepared that additional information may follow
43             in some future versions. (not used for secret keys)
44                 o = Unknown (this key is new to the system)
45                 i = The key is invalid (e.g. due to a missing self-signature)
46                 d = The key has been disabled
47                     (deprecated - use the 'D' in field 12 instead)
48                 r = The key has been revoked
49                 e = The key has expired
50                 - = Unknown trust (i.e. no value assigned)
51                 q = Undefined trust
52                     '-' and 'q' may safely be treated as the same
53                     value for most purposes
54                 n = Don't trust this key at all
55                 m = There is marginal trust in this key
56                 f = The key is fully trusted
57                 u = The key is ultimately trusted.  This often means
58                     that the secret key is available, but any key may
59                     be marked as ultimately trusted.
60  3. Field:  length of key in bits.
61  4. Field:  Algorithm:  1 = RSA
62                        16 = ElGamal (encrypt only)
63                        17 = DSA (sometimes called DH, sign only)
64                        20 = ElGamal (sign and encrypt)
65             (for other id's see include/cipher.h)
66  5. Field:  KeyID
67  6. Field:  Creation Date (in UTC).  For UID and UAT records, this is the
68             self-signature date.
69  7. Field:  Key or user ID/user attribute expiration date or empty if none.
70  8. Field:  Used for serial number in crt records (used to be the Local-ID).
71             For UID and UAT records, this is a hash of the user ID contents
72             used to represent that exact user ID.  For trust signatures,
73             this is the trust depth seperated by the trust value by a
74             space.
75  9. Field:  Ownertrust (primary public keys only)
76             This is a single letter, but be prepared that additional
77             information may follow in some future versions.  For trust
78             signatures with a regular expression, this is the regular
79             expression value, quoted as in field 10.
80 10. Field:  User-ID.  The value is quoted like a C string to avoid
81             control characters (the colon is quoted "\x3a").
82             This is not used with --fixed-list-mode in gpg.
83             A UAT record puts the attribute subpacket count here, a
84             space, and then the total attribute subpacket size.
85             In gpgsm the issuer name comes here
86             An FPR record stores the fingerprint here.
87             The fingerprint of an revocation key is stored here.
88 11. Field:  Signature class.  This is a 2 digit hexnumber followed by
89             either the letter 'x' for an exportable signature or the
90             letter 'l' for a local-only signature.
91             The class byte of an revocation key is also given here,
92             'x' and 'l' ist used the same way.
93 12. Field:  Key capabilities:
94                 e = encrypt
95                 s = sign
96                 c = certify
97             A key may have any combination of them in any order.  In
98             addition to these letters, the primary key has uppercase
99             versions of the letters to denote the _usable_
100             capabilities of the entire key, and a potential letter 'D'
101             to indicate a disabled key.
102 13. Field:  Used in FPR records for S/MIME keys to store the fingerprint of
103             the issuer certificate.  This is useful to build the
104             certificate path based on certificates stored in the local
105             keyDB; it is only filled if the issue certificate is
106             available. The advantage of using this value is that it is
107             guaranteed to have been been build by the same lookup
108             algorithm as gpgsm uses.
109             For "uid" recods this lists the preferences n the sameway the 
110             -edit menu does.
111 14. Field   Flag field used in the --edit menu output:
112
113
114 All dates are displayed in the format yyyy-mm-dd unless you use the
115 option --fixed-list-mode in which case they are displayed as seconds
116 since Epoch.  More fields may be added later, so parsers should be
117 prepared for this. When parsing a number the parser should stop at the
118 first non-number character so that additional information can later be
119 added.
120
121 If field 1 has the tag "pkd", a listing looks like this:
122 pkd:0:1024:B665B1435F4C2 .... FF26ABB:
123     !  !   !-- the value
124     !  !------ for information number of bits in the value
125     !--------- index (eg. DSA goes from 0 to 3: p,q,g,y)
126
127
128 The "tru" trust database records have the fields:
129
130  1: Reason for staleness of trust.  If this field is empty, then the
131     trustdb is not stale.  This field may have multiple flags in it:
132
133     o: Trustdb is old
134     t: Trustdb was built with a different trust model than the one we
135        are using now.
136
137  2: Trust model.  This is always zero (i.e. "Classic") in this version
138     of GnuPG.
139  3: Date trustdb was created in seconds since 1/1/1970.
140  4: Date trustdb will expire in seconds since 1/1/1970.
141
142  
143
144 Format of the "--status-fd" output
145 ==================================
146 Every line is prefixed with "[GNUPG:] ", followed by a keyword with
147 the type of the status line and a some arguments depending on the
148 type (maybe none); an application should always be prepared to see
149 more arguments in future versions.
150
151
152     GOODSIG     <long keyid>  <username>
153         The signature with the keyid is good.  For each signature only
154         one of the three codes GOODSIG, BADSIG or ERRSIG will be
155         emitted and they may be used as a marker for a new signature.
156         The username is the primary one encoded in UTF-8 and %XX
157         escaped.
158
159     EXPSIG      <long keyid>  <username>
160         The signature with the keyid is good, but the signature is
161         expired. The username is the primary one encoded in UTF-8 and
162         %XX escaped.
163
164     EXPKEYSIG   <long keyid>  <username>
165         The signature with the keyid is good, but the signature was
166         made by an expired key. The username is the primary one
167         encoded in UTF-8 and %XX escaped.
168
169     REVKEYSIG   <long keyid>  <username>
170         The signature with the keyid is good, but the signature was
171         made by a revoked key. The username is the primary one
172         encoded in UTF-8 and %XX escaped.
173
174     BADSIG      <long keyid>  <username>
175         The signature with the keyid has not been verified okay.
176         The username is the primary one encoded in UTF-8 and %XX
177         escaped.
178
179     ERRSIG  <long keyid>  <pubkey_algo> <hash_algo> \
180             <sig_class> <timestamp> <rc>
181         It was not possible to check the signature.  This may be
182         caused by a missing public key or an unsupported algorithm.
183         A RC of 4 indicates unknown algorithm, a 9 indicates a missing
184         public key. The other fields give more information about
185         this signature.  sig_class is a 2 byte hex-value.
186
187     VALIDSIG    <fingerprint in hex> <sig_creation_date> <sig-timestamp>
188                 <expire-timestamp> <sig-version> <reserved> <pubkey-algo>
189                 <hash-algo> <sig-class> <primary-key-fpr>
190
191         The signature with the keyid is good. This is the same as
192         GOODSIG but has the fingerprint as the argument. Both status
193         lines are emitted for a good signature.  All arguments here
194         are on one long line.  sig-timestamp is the signature creation
195         time in seconds after the epoch. expire-timestamp is the
196         signature expiration time in seconds after the epoch (zero
197         means "does not expire"). sig-version, pubkey-algo, hash-algo,
198         and sig-class (a 2-byte hex value) are all straight from the
199         signature packet.  PRIMARY-KEY-FPR is the fingerprint of the
200         primary key or identical to the first argument.  This is
201         useful to get back to the primary key without running gpg
202         again for this purpose.
203
204     SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
205         This is emitted only for signatures of class 0 or 1 which
206         have been verified okay.  The string is a signature id
207         and may be used in applications to detect replay attacks
208         of signed messages.  Note that only DLP algorithms give
209         unique ids - others may yield duplicated ones when they
210         have been created in the same second.
211
212     ENC_TO  <long keyid>  <keytype>  <keylength>
213         The message is encrypted to this keyid.
214         keytype is the numerical value of the public key algorithm,
215         keylength is the length of the key or 0 if it is not known
216         (which is currently always the case).
217
218     NODATA  <what>
219         No data has been found. Codes for what are:
220             1 - No armored data.
221             2 - Expected a packet but did not found one.
222             3 - Invalid packet found, this may indicate a non OpenPGP message.
223         You may see more than one of these status lines.
224
225     UNEXPECTED <what>
226         Unexpected data has been encountered
227             0 - not further specified               1       
228   
229
230     TRUST_UNDEFINED <error token>
231     TRUST_NEVER  <error token>
232     TRUST_MARGINAL
233     TRUST_FULLY
234     TRUST_ULTIMATE
235         For good signatures one of these status lines are emitted
236         to indicate how trustworthy the signature is.  The error token
237         values are currently only emiited by gpgsm.
238
239     SIGEXPIRED
240         This is deprecated in favor of KEYEXPIRED.
241
242     KEYEXPIRED <expire-timestamp>
243         The key has expired.  expire-timestamp is the expiration time
244         in seconds after the epoch.
245
246     KEYREVOKED
247         The used key has been revoked by its owner.  No arguments yet.
248
249     BADARMOR
250         The ASCII armor is corrupted.  No arguments yet.
251
252     RSA_OR_IDEA
253         The IDEA algorithms has been used in the data.  A
254         program might want to fallback to another program to handle
255         the data if GnuPG failed.  This status message used to be emitted
256         also for RSA but this has been dropped after the RSA patent expired.
257         However we can't change the name of the message.
258
259     SHM_INFO
260     SHM_GET
261     SHM_GET_BOOL
262     SHM_GET_HIDDEN
263
264     GET_BOOL
265     GET_LINE
266     GET_HIDDEN
267     GOT_IT
268
269     NEED_PASSPHRASE <long main keyid> <long keyid> <keytype> <keylength>
270         Issued whenever a passphrase is needed.
271         keytype is the numerical value of the public key algorithm
272         or 0 if this is not applicable, keylength is the length
273         of the key or 0 if it is not known (this is currently always the case).
274
275     NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
276         Issued whenever a passphrase for symmetric encryption is needed.
277
278     MISSING_PASSPHRASE
279         No passphrase was supplied.  An application which encounters this
280         message may want to stop parsing immediately because the next message
281         will probably be a BAD_PASSPHRASE.  However, if the application
282         is a wrapper around the key edit menu functionality it might not
283         make sense to stop parsing but simply ignoring the following
284         BAD_PASSPHRASE.
285
286     BAD_PASSPHRASE <long keyid>
287         The supplied passphrase was wrong or not given.  In the latter case
288         you may have seen a MISSING_PASSPHRASE.
289
290     GOOD_PASSPHRASE
291         The supplied passphrase was good and the secret key material
292         is therefore usable.
293
294     DECRYPTION_FAILED
295         The symmetric decryption failed - one reason could be a wrong
296         passphrase for a symmetrical encrypted message.
297
298     DECRYPTION_OKAY
299         The decryption process succeeded.  This means, that either the
300         correct secret key has been used or the correct passphrase
301         for a conventional encrypted message was given.  The program
302         itself may return an errorcode because it may not be possible to
303         verify a signature for some reasons.
304
305     NO_PUBKEY  <long keyid>
306     NO_SECKEY  <long keyid>
307         The key is not available
308
309     IMPORTED   <long keyid>  <username>
310         The keyid and name of the signature just imported
311
312     IMPORT_OK  <reason> [<fingerprint>]
313         The key with the primary key's FINGERPRINT has been imported.
314         Reason flags:
315           0 := Not actually changed
316           1 := Entirely new key.
317           2 := New user IDs
318           4 := New signatures
319           8 := New subkeys 
320          16 := Contains private key.
321         The flags may be ORed.
322
323     IMPORT_PROBLEM <reason> [<fingerprint>]
324         Issued for each import failure.  Reason codes are:
325           0 := "No specific reason given".
326           1 := "Invalid Certificate".
327           2 := "Issuer Certificate missing".
328           3 := "Certificate Chain too long".
329           4 := "Error storing certificate".
330
331     IMPORT_RES <count> <no_user_id> <imported> <imported_rsa> <unchanged>
332         <n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported> <sec_dups> <not_imported>
333         Final statistics on import process (this is one long line)
334
335     FILE_START <what> <filename>
336         Start processing a file <filename>.  <what> indicates the performed
337         operation:
338             1 - verify
339             2 - encrypt
340             3 - decrypt        
341
342     FILE_DONE
343         Marks the end of a file processing which has been started
344         by FILE_START.
345
346     BEGIN_DECRYPTION
347     END_DECRYPTION
348         Mark the start and end of the actual decryption process.  These
349         are also emitted when in --list-only mode.
350
351     BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
352     END_ENCRYPTION
353         Mark the start and end of the actual encryption process.
354
355     DELETE_PROBLEM reason_code
356         Deleting a key failed.  Reason codes are:
357             1 - No such key
358             2 - Must delete secret key first
359             3 - Ambigious specification
360
361     PROGRESS what char cur total
362         Used by the primegen and Public key functions to indicate progress.
363         "char" is the character displayed with no --status-fd enabled, with
364         the linefeed replaced by an 'X'.  "cur" is the current amount
365         done and "total" is amount to be done; a "total" of 0 indicates that
366         the total amount is not known.  100/100 may be used to detect the
367         end of operation.
368
369     SIG_CREATED <type> <pubkey algo> <hash algo> <class> <timestamp> <key fpr>
370         A signature has been created using these parameters.
371             type:  'D' = detached
372                    'C' = cleartext
373                    'S' = standard
374                    (only the first character should be checked)
375             class: 2 hex digits with the signature class
376         
377     KEY_CREATED <type> <fingerprint>
378         A key has been created
379             type: 'B' = primary and subkey
380                   'P' = primary
381                   'S' = subkey
382         The fingerprint is one of the primary key for type B and P and
383         the one of the subkey for S.
384
385     SESSION_KEY  <algo>:<hexdigits>
386         The session key used to decrypt the message.  This message will
387         only be emmited when the special option --show-session-key
388         is used.  The format is suitable to be passed to the option
389         --override-session-key
390
391     NOTATION_NAME <name> 
392     NOTATION_DATA <string>
393         name and string are %XX escaped; the data may be splitted
394         among several notation_data lines.
395
396     USERID_HINT <long main keyid> <string>
397         Give a hint about the user ID for a certain keyID. 
398
399     POLICY_URL <string>
400         string is %XX escaped
401
402     BEGIN_STREAM
403     END_STREAM
404         Issued by pipemode.
405
406     INV_RECP <reason> <requested_recipient>
407         Issued for each unusable recipient. The reasons codes
408         currently in use are:
409           0 := "No specific reason given".
410           1 := "Not Found"
411           2 := "Ambigious specification"
412           3 := "Wrong key usage"
413           4 := "Key revoked"
414           5 := "Key expired"
415           6 := "No CRL known"
416           7 := "CRL too old"
417           8 := "Policy mismatch"
418           9 := "Not a secret key"
419          10 := "Key not trusted"
420
421         Note that this status is also used for gpgsm's SIGNER command
422         where it relates to signer's of course.
423
424     NO_RECP <reserved>
425         Issued when no recipients are usable.
426
427     ALREADY_SIGNED <long-keyid>
428         Warning: This is experimental and might be removed at any time.
429
430     TRUNCATED <maxno>
431         The output was truncated to MAXNO items.  This status code is issued
432         for certain external requests
433
434     ERROR <error location> <error code> 
435         This is a generic error status message, it might be followed
436         by error location specific data. <error token> and
437         <error_location> should not contain a space.
438
439     ATTRIBUTE <fpr> <octets> <type> <index> <count>
440               <timestamp> <expiredate> <flags>
441         This is one long line issued for each attribute subpacket when
442         an attribute packet is seen during key listing.  <fpr> is the
443         fingerprint of the key. <octets> is the length of the
444         attribute subpacket. <type> is the attribute type
445         (1==image). <index>/<count> indicates that this is the Nth
446         indexed subpacket of count total subpackets in this attribute
447         packet.  <timestamp> and <expiredate> are from the
448         self-signature on the attribute packet.  If the attribute
449         packet does not have a valid self-signature, then the
450         timestamp is 0.  <flags> are a bitwise OR of:
451                 0x01 = this attribute packet is a primary uid
452                 0x02 = this attribute packet is revoked
453                 0x04 = this attribute packet is expired
454
455
456 Format of the "--attribute-fd" output
457 =====================================
458
459 When --attribute-fd is set, during key listings (--list-keys,
460 --list-secret-keys) GnuPG dumps each attribute packet to the file
461 descriptor specified.  --attribute-fd is intended for use with
462 --status-fd as part of the required information is carried on the
463 ATTRIBUTE status tag (see above).
464
465 The contents of the attribute data is specified by 2440bis, but for
466 convenience, here is the Photo ID format, as it is currently the only
467 attribute defined:
468
469    Byte 0-1:  The length of the image header.  Due to a historical
470               accident (i.e. oops!) back in the NAI PGP days, this is
471               a little-endian number.  Currently 16 (0x10 0x00).
472
473    Byte 2:    The image header version.  Currently 0x01.
474
475    Byte 3:    Encoding format.  0x01 == JPEG.
476
477    Byte 4-15: Reserved, and currently unused.
478
479    All other data after this header is raw image (JPEG) data.
480
481
482 Key generation
483 ==============
484     Key generation shows progress by printing different characters to
485     stderr:
486              "."  Last 10 Miller-Rabin tests failed
487              "+"  Miller-Rabin test succeeded
488              "!"  Reloading the pool with fresh prime numbers
489              "^"  Checking a new value for the generator
490              "<"  Size of one factor decreased
491              ">"  Size of one factor increased
492
493     The prime number for ElGamal is generated this way:
494
495     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize)
496     2) Select the length of the other prime factors to be at least the size
497        of q and calculate the number of prime factors needed
498     3) Make a pool of prime numbers, each of the length determined in step 2
499     4) Get a new permutation out of the pool or continue with step 3
500        if we have tested all permutations.
501     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
502     6) Check that this prime has the correct length (this may change q if
503        it seems not to be possible to make a prime of the desired length)
504     7) Check whether this is a prime using trial divisions and the
505        Miller-Rabin test.
506     8) Continue with step 4 if we did not find a prime in step 7.
507     9) Find a generator for that prime.
508
509     This algorithm is based on Lim and Lee's suggestion from the
510     Crypto '97 proceedings p. 260.
511
512
513 Unattended key generation
514 =========================
515 This feature allows unattended generation of keys controlled by a
516 parameter file.  To use this feature, you use --gen-key together with
517 --batch and feed the parameters either from stdin or from a file given
518 on the commandline.
519
520 The format of this file is as follows:
521   o Text only, line length is limited to about 1000 chars.
522   o You must use UTF-8 encoding to specify non-ascii characters.
523   o Empty lines are ignored.
524   o Leading and trailing spaces are ignored.
525   o A hash sign as the first non white space character indicates a comment line.
526   o Control statements are indicated by a leading percent sign, the
527     arguments are separated by white space from the keyword.
528   o Parameters are specified by a keyword, followed by a colon.  Arguments
529     are separated by white space.
530   o The first parameter must be "Key-Type", control statements
531     may be placed anywhere.
532   o Key generation takes place when either the end of the parameter file
533     is reached, the next "Key-Type" parameter is encountered or at the
534     control statement "%commit"
535   o Control statements:
536     %echo <text>
537         Print <text>.
538     %dry-run
539         Suppress actual key generation (useful for syntax checking).
540     %commit
541         Perform the key generation.  An implicit commit is done
542         at the next "Key-Type" parameter.
543     %pubring <filename>
544     %secring <filename>
545         Do not write the key to the default or commandline given
546         keyring but to <filename>.  This must be given before the first
547         commit to take place, duplicate specification of the same filename
548         is ignored, the last filename before a commit is used.
549         The filename is used until a new filename is used (at commit points)
550         and all keys are written to that file.  If a new filename is given,
551         this file is created (and overwrites an existing one).
552         Both control statements must be given.
553    o The order of the parameters does not matter except for "Key-Type"
554      which must be the first parameter.  The parameters are only for the
555      generated keyblock and parameters from previous key generations are not
556      used. Some syntactically checks may be performed.
557      The currently defined parameters are:
558      Key-Type: <algo-number>|<algo-string>
559         Starts a new parameter block by giving the type of the
560         primary key. The algorithm must be capable of signing.
561         This is a required parameter.
562      Key-Length: <length-in-bits>
563         Length of the key in bits.  Default is 1024.
564      Key-Usage: <usage-list>
565         Space or comma delimited list of key usage, allowed values are
566         "encrypt" and "sign".  This is used to generate the key flags.
567         Please make sure that the algorithm is capable of this usage.
568      Subkey-Type: <algo-number>|<algo-string>
569         This generates a secondary key.  Currently only one subkey
570         can be handled.
571      Subkey-Length: <length-in-bits>
572         Length of the subkey in bits.  Default is 1024.
573      Subkey-Usage: <usage-list>
574         Similar to Key-Usage.
575      Passphrase: <string>
576         If you want to specify a passphrase for the secret key,
577         enter it here.  Default is not to use any passphrase.
578      Name-Real: <string>
579      Name-Comment: <string>
580      Name-Email: <string>
581         The 3 parts of a key. Remember to use UTF-8 here.
582         If you don't give any of them, no user ID is created.
583      Expire-Date: <iso-date>|(<number>[d|w|m|y])
584         Set the expiration date for the key (and the subkey).  It
585         may either be entered in ISO date format (2000-08-15) or as
586         number of days, weeks, month or years. Without a letter days
587         are assumed.
588      Preferences: <string>
589         Set the cipher, hash, and compression preference values for
590         this key.  This expects the same type of string as "setpref"
591         in the --edit menu.
592      Revoker: <algo>:<fpr> [sensitive]
593         Add a designated revoker to the generated key.  Algo is the
594         public key algorithm of the designated revoker (i.e. RSA=1,
595         DSA=17, etc.)  Fpr is the fingerprint of the designated
596         revoker.  The optional "sensitive" flag marks the designated
597         revoker as sensitive information.  Only v4 keys may be
598         designated revokers.
599
600 Here is an example:
601 $ cat >foo <<EOF
602      %echo Generating a standard key
603      Key-Type: DSA
604      Key-Length: 1024
605      Subkey-Type: ELG-E
606      Subkey-Length: 1024
607      Name-Real: Joe Tester
608      Name-Comment: with stupid passphrase
609      Name-Email: joe@foo.bar
610      Expire-Date: 0
611      Passphrase: abc
612      %pubring foo.pub
613      %secring foo.sec
614      # Do a commit here, so that we can later print "done" :-)
615      %commit
616      %echo done
617 EOF
618 $ gpg --batch --gen-key foo
619  [...]
620 $ gpg --no-default-keyring --secret-keyring ./foo.sec \
621                                   --keyring ./foo.pub --list-secret-keys
622 /home/wk/work/gnupg-stable/scratch/foo.sec
623 ------------------------------------------
624 sec  1024D/915A878D 2000-03-09 Joe Tester (with stupid passphrase) <joe@foo.bar>
625 ssb  1024g/8F70E2C0 2000-03-09
626
627
628
629 Layout of the TrustDB
630 =====================
631 The TrustDB is built from fixed length records, where the first byte
632 describes the record type.  All numeric values are stored in network
633 byte order. The length of each record is 40 bytes. The first record of
634 the DB is always of type 1 and this is the only record of this type.
635
636 FIXME:  The layout changed, document it here.
637
638   Record type 0:
639   --------------
640     Unused record, can be reused for any purpose.
641
642   Record type 1:
643   --------------
644     Version information for this TrustDB.  This is always the first
645     record of the DB and the only one with type 1.
646      1 byte value 1
647      3 bytes 'gpg'  magic value
648      1 byte Version of the TrustDB (2)
649      1 byte marginals needed
650      1 byte completes needed
651      1 byte max_cert_depth
652             The three items are used to check whether the cached
653             validity value from the dir record can be used.
654      1 u32  locked flags [not used]
655      1 u32  timestamp of trustdb creation
656      1 u32  timestamp of last modification which may affect the validity
657             of keys in the trustdb.  This value is checked against the
658             validity timestamp in the dir records.
659      1 u32  timestamp of last validation [currently not used]
660             (Used to keep track of the time, when this TrustDB was checked
661              against the pubring)
662      1 u32  record number of keyhashtable [currently not used]
663      1 u32  first free record
664      1 u32  record number of shadow directory hash table [currently not used]
665             It does not make sense to combine this table with the key table
666             because the keyid is not in every case a part of the fingerprint.
667      1 u32  record number of the trusthashtbale
668
669
670   Record type 2: (directory record)
671   --------------
672     Informations about a public key certificate.
673     These are static values which are never changed without user interaction.
674
675      1 byte value 2
676      1 byte  reserved
677      1 u32   LID     .  (This is simply the record number of this record.)
678      1 u32   List of key-records (the first one is the primary key)
679      1 u32   List of uid-records
680      1 u32   cache record
681      1 byte  ownertrust
682      1 byte  dirflag
683      1 byte  maximum validity of all the user ids
684      1 u32   time of last validity check.
685      1 u32   Must check when this time has been reached.
686              (0 = no check required)
687
688
689   Record type 3:  (key record)
690   --------------
691     Informations about a primary public key.
692     (This is mainly used to lookup a trust record)
693
694      1 byte value 3
695      1 byte  reserved
696      1 u32   LID
697      1 u32   next   - next key record
698      7 bytes reserved
699      1 byte  keyflags
700      1 byte  pubkey algorithm
701      1 byte  length of the fingerprint (in bytes)
702      20 bytes fingerprint of the public key
703               (This is the value we use to identify a key)
704
705   Record type 4: (uid record)
706   --------------
707     Informations about a userid
708     We do not store the userid but the hash value of the userid because that
709     is sufficient.
710
711      1 byte value 4
712      1 byte reserved
713      1 u32  LID  points to the directory record.
714      1 u32  next   next userid
715      1 u32  pointer to preference record
716      1 u32  siglist  list of valid signatures
717      1 byte uidflags
718      1 byte validity of the key calculated over this user id
719      20 bytes ripemd160 hash of the username.
720
721
722   Record type 5: (pref record)
723   --------------
724     This record type is not anymore used.
725
726      1 byte value 5
727      1 byte   reserved
728      1 u32  LID; points to the directory record (and not to the uid record!).
729             (or 0 for standard preference record)
730      1 u32  next
731      30 byte preference data
732
733   Record type 6  (sigrec)
734   -------------
735     Used to keep track of key signatures. Self-signatures are not
736     stored.  If a public key is not in the DB, the signature points to
737     a shadow dir record, which in turn has a list of records which
738     might be interested in this key (and the signature record here
739     is one).
740
741      1 byte   value 6
742      1 byte   reserved
743      1 u32    LID           points back to the dir record
744      1 u32    next   next sigrec of this uid or 0 to indicate the
745                      last sigrec.
746      6 times
747         1 u32  Local_id of signatures dir or shadow dir record
748         1 byte Flag: Bit 0 = checked: Bit 1 is valid (we have a real
749                              directory record for this)
750                          1 = valid is set (but may be revoked)
751
752
753
754   Record type 8: (shadow directory record)
755   --------------
756     This record is used to reserve a LID for a public key.  We
757     need this to create the sig records of other keys, even if we
758     do not yet have the public key of the signature.
759     This record (the record number to be more precise) will be reused
760     as the dir record when we import the real public key.
761
762      1 byte value 8
763      1 byte  reserved
764      1 u32   LID      (This is simply the record number of this record.)
765      2 u32   keyid
766      1 byte  pubkey algorithm
767      3 byte reserved
768      1 u32   hintlist   A list of records which have references to
769                         this key.  This is used for fast access to
770                         signature records which are not yet checked.
771                         Note, that this is only a hint and the actual records
772                         may not anymore hold signature records for that key
773                         but that the code cares about this.
774     18 byte reserved
775
776
777
778   Record Type 10 (hash table)
779   --------------
780     Due to the fact that we use fingerprints to lookup keys, we can
781     implement quick access by some simple hash methods, and avoid
782     the overhead of gdbm.  A property of fingerprints is that they can be
783     used directly as hash values.  (They can be considered as strong
784     random numbers.)
785       What we use is a dynamic multilevel architecture, which combines
786     hashtables, record lists, and linked lists.
787
788     This record is a hashtable of 256 entries; a special property
789     is that all these records are stored consecutively to make one
790     big table. The hash value is simple the 1st, 2nd, ... byte of
791     the fingerprint (depending on the indirection level).
792
793     When used to hash shadow directory records, a different table is used
794     and indexed by the keyid.
795
796      1 byte value 10
797      1 byte reserved
798      n u32  recnum; n depends on the record length:
799             n = (reclen-2)/4  which yields 9 for the current record length
800             of 40 bytes.
801
802     the total number of such record which makes up the table is:
803          m = (256+n-1) / n
804     which is 29 for a record length of 40.
805
806     To look up a key we use the first byte of the fingerprint to get
807     the recnum from this hashtable and look up the addressed record:
808        - If this record is another hashtable, we use 2nd byte
809          to index this hash table and so on.
810        - if this record is a hashlist, we walk all entries
811          until we found one a matching one.
812        - if this record is a key record, we compare the
813          fingerprint and to decide whether it is the requested key;
814
815
816   Record type 11 (hash list)
817   --------------
818     see hash table for an explanation.
819     This is also used for other purposes.
820
821     1 byte value 11
822     1 byte reserved
823     1 u32  next          next hash list record
824     n times              n = (reclen-5)/5
825         1 u32  recnum
826
827     For the current record length of 40, n is 7
828
829
830
831   Record type 254 (free record)
832   ---------------
833     All these records form a linked list of unused records.
834      1 byte  value 254
835      1 byte  reserved (0)
836      1 u32   next_free
837
838
839
840 Packet Headers
841 ===============
842
843 GNUPG uses PGP 2 packet headers and also understands OpenPGP packet header.
844 There is one enhancement used with the old style packet headers:
845
846    CTB bits 10, the "packet-length length bits", have values listed in
847    the following table:
848
849       00 - 1-byte packet-length field
850       01 - 2-byte packet-length field
851       10 - 4-byte packet-length field
852       11 - no packet length supplied, unknown packet length
853
854    As indicated in this table, depending on the packet-length length
855    bits, the remaining 1, 2, 4, or 0 bytes of the packet structure field
856    are a "packet-length field".  The packet-length field is a whole
857    number field.  The value of the packet-length field is defined to be
858    the value of the whole number field.
859
860    A value of 11 is currently used in one place: on compressed data.
861    That is, a compressed data block currently looks like <A3 01 . .  .>,
862    where <A3>, binary 10 1000 11, is an indefinite-length packet. The
863    proper interpretation is "until the end of the enclosing structure",
864    although it should never appear outermost (where the enclosing
865    structure is a file).
866
867 +  This will be changed with another version, where the new meaning of
868 +  the value 11 (see below) will also take place.
869 +
870 +  A value of 11 for other packets enables a special length encoding,
871 +  which is used in case, where the length of the following packet can
872 +  not be determined prior to writing the packet; especially this will
873 +  be used if large amounts of data are processed in filter mode.
874 +
875 +  It works like this: After the CTB (with a length field of 11) a
876 +  marker field is used, which gives the length of the following datablock.
877 +  This is a simple 2 byte field (MSB first) containing the amount of data
878 +  following this field, not including this length field. After this datablock
879 +  another length field follows, which gives the size of the next datablock.
880 +  A value of 0 indicates the end of the packet. The maximum size of a
881 +  data block is limited to 65534, thereby reserving a value of 0xffff for
882 +  future extensions. These length markers must be inserted into the data
883 +  stream just before writing the data out.
884 +
885 +  This 2 byte field is large enough, because the application must buffer
886 +  this amount of data to prepend the length marker before writing it out.
887 +  Data block sizes larger than about 32k doesn't make any sense. Note
888 +  that this may also be used for compressed data streams, but we must use
889 +  another packet version to tell the application that it can not assume,
890 +  that this is the last packet.
891
892
893 GNU extensions to the S2K algorithm
894 ===================================
895 S2K mode 101 is used to identify these extensions.
896 After the hash algorithm the 3 bytes "GNU" are used to make
897 clear that these are extensions for GNU, the next bytes gives the
898 GNU protection mode - 1000.  Defined modes are:
899   1001 - do not store the secret part at all
900   1002 - a stub to access smartcards (not used in 1.2.x)
901
902
903 Pipemode
904 ========
905 NOTE:  This is deprecated and will be removed in future versions.
906
907 This mode can be used to perform multiple operations with one call to
908 gpg. It comes handy in cases where you have to verify a lot of
909 signatures. Currently we support only detached signatures.  This mode
910 is a kludge to avoid running gpg n daemon mode and using Unix Domain
911 Sockets to pass the data to it.  There is no easy portable way to do
912 this under Windows, so we use plain old pipes which do work well under
913 Windows.  Because there is no way to signal multiple EOFs in a pipe we
914 have to embed control commands in the data stream: We distinguish
915 between a data state and a control state.  Initially the system is in
916 data state but it won't accept any data.  Instead it waits for
917 transition to control state which is done by sending a single '@'
918 character.  While in control state the control command os expected and
919 this command is just a single byte after which the system falls back
920 to data state (but does not necesary accept data now).  The simplest
921 control command is a '@' which just inserts this character into the
922 data stream.
923
924 Here is the format we use for detached signatures:
925 "@<"  - Begin of new stream
926 "@B"  - Detached signature follows.
927         This emits a control packet (1,'B')
928 <detached_signature>
929 "@t"  - Signed text follows. 
930         This emits the control packet (2, 'B')
931 <signed_text>
932 "@."  - End of operation. The final control packet forces signature
933         verification
934 "@>"  - End of stream   
935
936
937
938
939
940
941 Other Notes
942 ===========
943     * For packet version 3 we calculate the keyids this way:
944         RSA     := low 64 bits of n
945         ELGAMAL := build a v3 pubkey packet (with CTB 0x99) and calculate
946                    a rmd160 hash value from it. This is used as the
947                    fingerprint and the low 64 bits are the keyid.
948
949     * Revocation certificates consist only of the signature packet;
950       "import" knows how to handle this.  The rationale behind it is
951       to keep them small.
952
953
954
955
956
957
958
959 Keyserver Message Format
960 =========================
961
962 The keyserver may be contacted by a Unix Domain socket or via TCP.
963
964 The format of a request is:
965
966 ====
967 command-tag
968 "Content-length:" digits
969 CRLF
970 =======
971
972 Where command-tag is
973
974 NOOP
975 GET <user-name>
976 PUT
977 DELETE <user-name>
978
979
980 The format of a response is:
981
982 ======
983 "GNUPG/1.0" status-code status-text
984 "Content-length:" digits
985 CRLF
986 ============
987 followed by <digits> bytes of data
988
989
990 Status codes are:
991
992      o  1xx: Informational - Request received, continuing process
993
994      o  2xx: Success - The action was successfully received, understood,
995         and accepted
996
997      o  4xx: Client Error - The request contains bad syntax or cannot be
998         fulfilled
999
1000      o  5xx: Server Error - The server failed to fulfill an apparently
1001         valid request
1002
1003
1004
1005 Documentation on HKP (the http keyserver protocol):
1006
1007 A minimalistic HTTP server on port 11371 recognizes a GET for /pks/lookup.
1008 The standard http URL encoded query parameters are this (always key=value):
1009
1010 - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1011   pgp -kxa)
1012
1013 - search=<stringlist>. This is a list of words that must occur in the key.
1014   The words are delimited with space, points, @ and so on. The delimiters
1015   are not searched for and the order of the words doesn't matter (but see
1016   next option).
1017
1018 - exact=on. This switch tells the hkp server to only report exact matching
1019   keys back. In this case the order and the "delimiters" are important.
1020
1021 - fingerprint=on. Also reports the fingerprints when used with 'index' or
1022   'vindex'
1023
1024 The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1025 keys.
1026
1027
1028 A better way to do this would be a request like:
1029
1030    /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1031
1032 This can be implemented using Hurd's translator mechanism.
1033 However, I think the whole key server stuff has to be re-thought;
1034 I have some ideas and probably create a white paper.
1035