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