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