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