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