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