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