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