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