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