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