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