g10: Record and show statistics for encrypted messages when using TOFU
[gnupg.git] / doc / DETAILS
1 # doc/DETAILS                                                -*- org -*-
2 #+TITLE: GnuPG Details
3 # Globally disable superscripts and subscripts:
4 #+OPTIONS: ^:{}
5 #
6
7 # Note: This file uses org-mode; it should be easy to read as plain
8 # text but be aware of some markup peculiarities: Verbatim code is
9 # enclosed in #+begin-example, #+end-example blocks or marked by a
10 # colon as the first non-white-space character, words bracketed with
11 # equal signs indicate a monospace font, and the usual /italics/,
12 # *bold*, and _underline_ conventions are recognized.
13
14 This is the DETAILS file for GnuPG which specifies some internals and
15 parts of the external API for GPG and GPGSM.
16
17 * Format of the colon listings
18   The format is a based on colon separated record, each recods starts
19   with a tag string and extends to the end of the line.  Here is an
20   example:
21 #+begin_example
22 $ gpg --with-colons --list-keys \
23       --with-fingerprint --with-fingerprint wk@gnupg.org
24 pub:f:1024:17:6C7EE1B8621CC013:899817715:1055898235::m:::scESC:
25 fpr:::::::::ECAF7590EB3443B5C7CF3ACB6C7EE1B8621CC013:
26 uid:f::::::::Werner Koch <wk@g10code.com>:
27 uid:f::::::::Werner Koch <wk@gnupg.org>:
28 sub:f:1536:16:06AD222CADF6A6E1:919537416:1036177416:::::e:
29 fpr:::::::::CF8BCC4B18DE08FCD8A1615906AD222CADF6A6E1:
30 sub:r:1536:20:5CE086B5B5A18FF4:899817788:1025961788:::::esc:
31 fpr:::::::::AB059359A3B81F410FCFF97F5CE086B5B5A18FF4:
32 #+end_example
33
34 Note that new version of GnuPG or the use of certain options may add
35 new fields to the output.  Parsers should not assume a limit on the
36 number of fields per line.  Some fields are not yet used or only used
37 with certain record types; parsers should ignore fields they are not
38 aware of.
39
40 The double =--with-fingerprint= prints the fingerprint for the subkeys
41 too.  Old versions of gpg used a slightly different format and required
42 the use of the option =--fixed-list-mode= to conform to the format
43 described here.
44
45
46 ** Description of the fields
47 *** Field 1 - Type of record
48
49     - pub :: Public key
50     - crt :: X.509 certificate
51     - crs :: X.509 certificate and private key available
52     - sub :: Subkey (secondary key)
53     - sec :: Secret key
54     - ssb :: Secret subkey (secondary key)
55     - uid :: User id
56     - uat :: User attribute (same as user id except for field 10).
57     - sig :: Signature
58     - rev :: Revocation signature
59     - fpr :: Fingerprint (fingerprint is in field 10)
60     - pkd :: Public key data [*]
61     - grp :: Keygrip
62     - rvk :: Revocation key
63     - tfs :: TOFU statistics [*]
64     - tru :: Trust database information [*]
65     - spk :: Signature subpacket [*]
66     - cfg :: Configuration data [*]
67
68     Records marked with an asterisk are described at [[*Special%20field%20formats][*Special fields]].
69
70 *** Field 2 - Validity
71
72     This is a letter describing the computed validity of a key.
73     Currently this is a single letter, but be prepared that additional
74     information may follow in some future versions. Note that GnuPG <
75     2.1 does not set this field for secret key listings.
76
77     - o :: Unknown (this key is new to the system)
78     - i :: The key is invalid (e.g. due to a missing self-signature)
79     - d :: The key has been disabled
80            (deprecated - use the 'D' in field 12 instead)
81     - r :: The key has been revoked
82     - e :: The key has expired
83     - - :: Unknown validity (i.e. no value assigned)
84     - q :: Undefined validity.  '-' and 'q' may safely be treated as
85            the same value for most purposes
86     - n :: The key is not valid
87     - m :: The key is marginal valid.
88     - f :: The key is fully valid
89     - u :: The key is ultimately valid.  This often means that the
90            secret key is available, but any key may be marked as
91            ultimately valid.
92     - w :: The key has a well known private part.
93     - s :: The key has special validity.  This means that it might be
94            self-signed and expected to be used in the STEED sytem.
95
96     If the validity information is given for a UID or UAT record, it
97     describes the validity calculated based on this user ID.  If given
98     for a key record it describes the validity taken from the best
99     rated user ID.
100
101     For X.509 certificates a 'u' is used for a trusted root
102     certificate (i.e. for the trust anchor) and an 'f' for all other
103     valid certificates.
104
105 *** Field 3 - Key length
106
107     The length of key in bits.
108
109 *** Field 4 - Public key algorithm
110
111     The values here are those from the OpenPGP specs or if they are
112     greather than 255 the algorithm ids as used by Libgcrypt.
113
114 *** Field 5 - KeyID
115
116     This is the 64 bit keyid as specified by OpenPGP and the last 64
117     bit of the SHA-1 fingerprint of an X.509 certifciate.
118
119 *** Field 6 - Creation date
120
121     The creation date of the key is given in UTC.  For UID and UAT
122     records, this is used for the self-signature date.  Note that the
123     date is usally printed in seconds since epoch, however, we are
124     migrating to an ISO 8601 format (e.g. "19660205T091500").  This is
125     currently only relevant for X.509.  A simple way to detect the new
126     format is to scan for the 'T'.  Note that old versions of gpg
127     without using the =--fixed-list-mode= option used a "yyyy-mm-tt"
128     format.
129
130 *** Field 7 - Expiration date
131
132     Key or UID/UAT expiration date or empty if it does not expire.
133
134 *** Field 8 - Certificate S/N, UID hash, trust signature info
135
136     Used for serial number in crt records.  For UID and UAT records,
137     this is a hash of the user ID contents used to represent that
138     exact user ID.  For trust signatures, this is the trust depth
139     seperated by the trust value by a space.
140
141 *** Field 9 -  Ownertrust
142
143     This is only used on primary keys.  This is a single letter, but
144     be prepared that additional information may follow in future
145     versions.  For trust signatures with a regular expression, this is
146     the regular expression value, quoted as in field 10.
147
148 *** Field 10 - User-ID
149     The value is quoted like a C string to avoid control characters
150     (the colon is quoted =\x3a=).  For a "pub" record this field is
151     not used on --fixed-list-mode.  A UAT record puts the attribute
152     subpacket count here, a space, and then the total attribute
153     subpacket size.  In gpgsm the issuer name comes here.  A FPR
154     record stores the fingerprint here.  The fingerprint of a
155     revocation key is stored here.
156 *** Field 11 - Signature class
157
158     Signature class as per RFC-4880.  This is a 2 digit hexnumber
159     followed by either the letter 'x' for an exportable signature or
160     the letter 'l' for a local-only signature.  The class byte of an
161     revocation key is also given here, 'x' and 'l' is used the same
162     way.  This field if not used for X.509.
163
164 *** Field 12 - Key capabilities
165
166     The defined capabilities are:
167
168     - e :: Encrypt
169     - s :: Sign
170     - c :: Certify
171     - a :: Authentication
172     - ? :: Unknown capability
173
174     A key may have any combination of them in any order.  In addition
175     to these letters, the primary key has uppercase versions of the
176     letters to denote the _usable_ capabilities of the entire key, and
177     a potential letter 'D' to indicate a disabled key.
178
179 *** Field 13 - Issuer certificate fingerprint or other info
180
181     Used in FPR records for S/MIME keys to store the fingerprint of
182     the issuer certificate.  This is useful to build the certificate
183     path based on certificates stored in the local key database it is
184     only filled if the issuer certificate is available. The root has
185     been reached if this is the same string as the fingerprint. The
186     advantage of using this value is that it is guaranteed to have
187     been been build by the same lookup algorithm as gpgsm uses.
188
189     For "uid" records this field lists the preferences in the same way
190     gpg's --edit-key menu does.
191
192     For "sig" records, this is the fingerprint of the key that issued
193     the signature.  Note that this is only filled in if the signature
194     verified correctly.  Note also that for various technical reasons,
195     this fingerprint is only available if --no-sig-cache is used.
196
197 *** Field 14 - Flag field
198
199     Flag field used in the --edit menu output
200
201 *** Field 15 - S/N of a token
202
203     Used in sec/ssb to print the serial number of a token (internal
204     protect mode 1002) or a '#' if that key is a simple stub (internal
205     protect mode 1001).  If the option --with-secret is used and a
206     secret key is available for the public key, a '+' indicates this.
207
208 *** Field 16 - Hash algorithm
209
210     For sig records, this is the used hash algorithm.  For example:
211     2 = SHA-1, 8 = SHA-256.
212
213 *** Field 17 - Curve name
214
215     For pub, sub, sec, and ssb records this field is used for the ECC
216     curve name.
217
218 ** Special fields
219
220 *** PKD - Public key data
221
222     If field 1 has the tag "pkd", a listing looks like this:
223 #+begin_example
224 pkd:0:1024:B665B1435F4C2 .... FF26ABB:
225     !  !   !-- the value
226     !  !------ for information number of bits in the value
227     !--------- index (eg. DSA goes from 0 to 3: p,q,g,y)
228 #+end_example
229
230 *** TFS - TOFU statistics
231
232     This field may follows a UID record to convey information about
233     the TOFU database.  The information is similar to a TOFU_STATS
234     status line.
235
236     - Field 2 :: tfs record version (must be 1)
237     - Field 3 :: validity -  A number with validity code.
238     - Field 4 :: signcount - The number of signatures seen.
239     - Field 5 :: encrcount - The number of encryptions done.
240     - Field 6 :: policy - A string with the policy
241     - Field 7 :: signture-first-seen - a timestamp or 0 if not known.
242     - Field 8 :: signature-most-recent-seen - a timestamp or 0 if not known.
243     - Field 9 :: encryption-first-done - a timestamp or 0 if not known.
244     - Field 10 :: encryption-most-recent-done - a timestamp or 0 if not known.
245
246 *** TRU - Trust database information
247     Example for a "tru" trust base record:
248 #+begin_example
249     tru:o:0:1166697654:1:3:1:5
250 #+end_example
251
252     - Field 2 :: Reason for staleness of trust.  If this field is
253                  empty, then the trustdb is not stale.  This field may
254                  have multiple flags in it:
255
256                  - o :: Trustdb is old
257                  - t :: Trustdb was built with a different trust model
258                         than the one we are using now.
259
260     - Field 3 :: Trust model
261
262                  - 0 :: Classic trust model, as used in PGP 2.x.
263                  - 1 :: PGP trust model, as used in PGP 6 and later.
264                         This is the same as the classic trust model,
265                         except for the addition of trust signatures.
266
267                  GnuPG before version 1.4 used the classic trust model
268                  by default. GnuPG 1.4 and later uses the PGP trust
269                  model by default.
270
271     - Field 4 :: Date trustdb was created in seconds since Epoch.
272     - Field 5 :: Date trustdb will expire in seconds since Epoch.
273     - Field 6 :: Number of marginally trusted users to introduce a new
274                  key signer (gpg's option --marginals-needed).
275     - Field 7 :: Number of completely trusted users to introduce a new
276                  key signer.  (gpg's option --completes-needed)
277
278     - Field 8 :: Maximum depth of a certification chain. (gpg's option
279                  --max-cert-depth)
280
281 *** SPK - Signature subpacket records
282
283     - Field 2 :: Subpacket number as per RFC-4880 and later.
284     - Field 3 :: Flags in hex.  Currently the only two bits assigned
285                  are 1, to indicate that the subpacket came from the
286                  hashed part of the signature, and 2, to indicate the
287                  subpacket was marked critical.
288     - Field 4 :: Length of the subpacket.  Note that this is the
289                  length of the subpacket, and not the length of field
290                  5 below.  Due to the need for %-encoding, the length
291                  of field 5 may be up to 3x this value.
292     - Field 5 :: The subpacket data.  Printable ASCII is shown as
293                  ASCII, but other values are rendered as %XX where XX
294                  is the hex value for the byte.
295
296 *** CFG - Configuration data
297
298     --list-config outputs information about the GnuPG configuration
299     for the benefit of frontends or other programs that call GnuPG.
300     There are several list-config items, all colon delimited like the
301     rest of the --with-colons output.  The first field is always "cfg"
302     to indicate configuration information.  The second field is one of
303     (with examples):
304
305     - version :: The third field contains the version of GnuPG.
306
307                  : cfg:version:1.3.5
308
309     - pubkey :: The third field contains the public key algorithms
310                 this version of GnuPG supports, separated by
311                 semicolons.  The algorithm numbers are as specified in
312                 RFC-4880.  Note that in contrast to the --status-fd
313                 interface these are _not_ the Libgcrypt identifiers.
314                 Using =pubkeyname= prints names instead of numbers.
315
316                  : cfg:pubkey:1;2;3;16;17
317
318     - cipher :: The third field contains the symmetric ciphers this
319                 version of GnuPG supports, separated by semicolons.
320                 The cipher numbers are as specified in RFC-4880.
321                 Using =ciphername= prints names instead of numbers.
322
323                  : cfg:cipher:2;3;4;7;8;9;10
324
325     - digest :: The third field contains the digest (hash) algorithms
326                 this version of GnuPG supports, separated by
327                 semicolons.  The digest numbers are as specified in
328                 RFC-4880.  Using =digestname= prints names instead of
329                 numbers.
330
331                  : cfg:digest:1;2;3;8;9;10
332
333     - compress :: The third field contains the compression algorithms
334                   this version of GnuPG supports, separated by
335                   semicolons.  The algorithm numbers are as specified
336                   in RFC-4880.
337
338                  : cfg:compress:0;1;2;3
339
340     - group :: The third field contains the name of the group, and the
341                fourth field contains the values that the group expands
342                to, separated by semicolons.
343
344                For example, a group of:
345                  : group mynames = paige 0x12345678 joe patti
346                would result in:
347                  : cfg:group:mynames:patti;joe;0x12345678;paige
348
349     - curve :: The third field contains the curve names this version
350                of GnuPG supports, separated by semicolons. Using
351                =curveoid= prints OIDs instead of numbers.
352
353                  : cfg:curve:ed25519;nistp256;nistp384;nistp521
354
355
356 * Format of the --status-fd output
357
358   Every line is prefixed with "[GNUPG:] ", followed by a keyword with
359   the type of the status line and some arguments depending on the type
360   (maybe none); an application should always be prepared to see new
361   keyworkds or more arguments in future versions.
362
363 ** General status codes
364 *** NEWSIG [<signers_uid>]
365     Is issued right before a signature verification starts.  This is
366     useful to define a context for parsing ERROR status messages.
367     arguments are currently defined.  If SIGNERS_UID is given and is
368     not "-" this is the percent escape value of the OpenPGP Signer's
369     User ID signature sub-packet.
370
371 *** GOODSIG  <long_keyid_or_fpr>  <username>
372     The signature with the keyid is good.  For each signature only one
373     of the codes GOODSIG, BADSIG, EXPSIG, EXPKEYSIG, REVKEYSIG or
374     ERRSIG will be emitted.  In the past they were used as a marker
375     for a new signature; new code should use the NEWSIG status
376     instead.  The username is the primary one encoded in UTF-8 and %XX
377     escaped. The fingerprint may be used instead of the long keyid if
378     it is available.  This is the case with CMS and might eventually
379     also be available for OpenPGP.
380
381 *** EXPSIG  <long_keyid_or_fpr>  <username>
382     The signature with the keyid is good, but the signature is
383     expired. The username is the primary one encoded in UTF-8 and %XX
384     escaped. The fingerprint may be used instead of the long keyid if
385     it is available.  This is the case with CMS and might eventually
386     also be available for OpenPGP.
387
388 *** EXPKEYSIG  <long_keyid_or_fpr> <username>
389     The signature with the keyid is good, but the signature was made
390     by an expired key. The username is the primary one encoded in
391     UTF-8 and %XX escaped.  The fingerprint may be used instead of the
392     long keyid if it is available.  This is the case with CMS and
393     might eventually also be available for OpenPGP.
394
395 *** REVKEYSIG  <long_keyid_or_fpr>  <username>
396     The signature with the keyid is good, but the signature was made
397     by a revoked key. The username is the primary one encoded in UTF-8
398     and %XX escaped. The fingerprint may be used instead of the long
399     keyid if it is available.  This is the case with CMS and might
400     eventually also beƱ available for OpenPGP.
401
402 *** BADSIG  <long_keyid_or_fpr>  <username>
403     The signature with the keyid has not been verified okay.  The
404     username is the primary one encoded in UTF-8 and %XX escaped. The
405     fingerprint may be used instead of the long keyid if it is
406     available.  This is the case with CMS and might eventually also be
407     available for OpenPGP.
408
409 *** ERRSIG  <keyid>  <pkalgo> <hashalgo> <sig_class> <time> <rc>
410     It was not possible to check the signature.  This may be caused by
411     a missing public key or an unsupported algorithm.  A RC of 4
412     indicates unknown algorithm, a 9 indicates a missing public
413     key. The other fields give more information about this signature.
414     sig_class is a 2 byte hex-value.  The fingerprint may be used
415     instead of the keyid if it is available.  This is the case with
416     gpgsm and might eventually also be available for OpenPGP.
417
418     Note, that TIME may either be the number of seconds since Epoch or
419     an ISO 8601 string.  The latter can be detected by the presence of
420     the letter 'T'.
421
422 *** VALIDSIG <args>
423
424     The args are:
425
426     - <fingerprint_in_hex>
427     - <sig_creation_date>
428     - <sig-timestamp>
429     - <expire-timestamp>
430     - <sig-version>
431     - <reserved>
432     - <pubkey-algo>
433     - <hash-algo>
434     - <sig-class>
435     - [ <primary-key-fpr> ]
436
437     This status indicates that the signature is cryptographically
438     valid. This is similar to GOODSIG, EXPSIG, EXPKEYSIG, or REVKEYSIG
439     (depending on the date and the state of the signature and signing
440     key) but has the fingerprint as the argument. Multiple status
441     lines (VALIDSIG and the other appropriate *SIG status) are emitted
442     for a valid signature.  All arguments here are on one long line.
443     sig-timestamp is the signature creation time in seconds after the
444     epoch. expire-timestamp is the signature expiration time in
445     seconds after the epoch (zero means "does not
446     expire"). sig-version, pubkey-algo, hash-algo, and sig-class (a
447     2-byte hex value) are all straight from the signature packet.
448     PRIMARY-KEY-FPR is the fingerprint of the primary key or identical
449     to the first argument.  This is useful to get back to the primary
450     key without running gpg again for this purpose.
451
452     The primary-key-fpr parameter is used for OpenPGP and not
453     available for CMS signatures.  The sig-version as well as the sig
454     class is not defined for CMS and currently set to 0 and 00.
455
456     Note, that *-TIMESTAMP may either be a number of seconds since
457     Epoch or an ISO 8601 string which can be detected by the presence
458     of the letter 'T'.
459
460 *** SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
461     This is emitted only for signatures of class 0 or 1 which have
462     been verified okay.  The string is a signature id and may be used
463     in applications to detect replay attacks of signed messages.  Note
464     that only DLP algorithms give unique ids - others may yield
465     duplicated ones when they have been created in the same second.
466
467     Note, that SIG-TIMESTAMP may either be a number of seconds since
468     Epoch or an ISO 8601 string which can be detected by the presence
469     of the letter 'T'.
470
471 *** ENC_TO  <long_keyid>  <keytype>  <keylength>
472     The message is encrypted to this LONG_KEYID.  KEYTYPE is the
473     numerical value of the public key algorithm or 0 if it is not
474     known, KEYLENGTH is the length of the key or 0 if it is not known
475     (which is currently always the case).  Gpg prints this line
476     always; Gpgsm only if it knows the certificate.
477
478 *** BEGIN_DECRYPTION
479     Mark the start of the actual decryption process.  This is also
480     emitted when in --list-only mode.
481 *** END_DECRYPTION
482     Mark the end of the actual decryption process.  This are also
483     emitted when in --list-only mode.
484 *** DECRYPTION_INFO <mdc_method> <sym_algo>
485     Print information about the symmetric encryption algorithm and the
486     MDC method.  This will be emitted even if the decryption fails.
487
488 *** DECRYPTION_FAILED
489     The symmetric decryption failed - one reason could be a wrong
490     passphrase for a symmetrical encrypted message.
491
492 *** DECRYPTION_OKAY
493     The decryption process succeeded.  This means, that either the
494     correct secret key has been used or the correct passphrase for a
495     symmetric encrypted message was given.  The program itself may
496     return an errorcode because it may not be possible to verify a
497     signature for some reasons.
498
499 *** SESSION_KEY <algo>:<hexdigits>
500     The session key used to decrypt the message.  This message will
501     only be emitted if the option --show-session-key is used.  The
502     format is suitable to be passed as value for the option
503     --override-session-key.  It is not an indication that the
504     decryption will or has succeeded.
505
506 *** BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
507     Mark the start of the actual encryption process.
508
509 *** END_ENCRYPTION
510     Mark the end of the actual encryption process.
511
512 *** FILE_START <what> <filename>
513     Start processing a file <filename>.  <what> indicates the performed
514     operation:
515     - 1 :: verify
516     - 2 :: encrypt
517     - 3 :: decrypt
518
519 *** FILE_DONE
520     Marks the end of a file processing which has been started
521     by FILE_START.
522
523 *** BEGIN_SIGNING
524     Mark the start of the actual signing process. This may be used as
525     an indication that all requested secret keys are ready for use.
526
527 *** ALREADY_SIGNED <long-keyid>
528     Warning: This is experimental and might be removed at any time.
529
530 *** SIG_CREATED <type> <pk_algo> <hash_algo> <class> <timestamp> <keyfpr>
531     A signature has been created using these parameters.
532     Values for type <type> are:
533       - D :: detached
534       - C :: cleartext
535       - S :: standard
536     (only the first character should be checked)
537
538     <class> are 2 hex digits with the OpenPGP signature class.
539
540     Note, that TIMESTAMP may either be a number of seconds since Epoch
541     or an ISO 8601 string which can be detected by the presence of the
542     letter 'T'.
543
544 *** NOTATION_
545     There are actually three related status codes to convey notation
546     data:
547
548     - NOTATION_NAME <name>
549     - NOTATION_FLAGS <critical> <human_readable>
550     - NOTATION_DATA <string>
551
552     <name> and <string> are %XX escaped.  The data may be split among
553     several NOTATION_DATA lines.  NOTATION_FLAGS is emitted after
554     NOTATION_NAME and gives the critical and human readable flags;
555     the flag values are either 0 or 1.
556
557 *** POLICY_URL <string>
558     Note that URL in <string> is %XX escaped.
559
560 *** PLAINTEXT <format> <timestamp> <filename>
561     This indicates the format of the plaintext that is about to be
562     written.  The format is a 1 byte hex code that shows the format of
563     the plaintext: 62 ('b') is binary data, 74 ('t') is text data with
564     no character set specified, and 75 ('u') is text data encoded in
565     the UTF-8 character set.  The timestamp is in seconds since the
566     epoch.  If a filename is available it gets printed as the third
567     argument, percent-escaped as usual.
568
569 *** PLAINTEXT_LENGTH <length>
570     This indicates the length of the plaintext that is about to be
571     written.  Note that if the plaintext packet has partial length
572     encoding it is not possible to know the length ahead of time.  In
573     that case, this status tag does not appear.
574
575 *** ATTRIBUTE <arguments>
576     The list or arguments are:
577     - <fpr>
578     - <octets>
579     - <type>
580     - <index>
581     - <count>
582     - <timestamp>
583     - <expiredate>
584     - <flags>
585
586     This is one long line issued for each attribute subpacket when an
587     attribute packet is seen during key listing.  <fpr> is the
588     fingerprint of the key.  <octets> is the length of the attribute
589     subpacket.  <type> is the attribute type (e.g. 1 for an image).
590     <index> and <count> indicate that this is the N-th indexed
591     subpacket of count total subpackets in this attribute packet.
592     <timestamp> and <expiredate> are from the self-signature on the
593     attribute packet.  If the attribute packet does not have a valid
594     self-signature, then the timestamp is 0.  <flags> are a bitwise OR
595     of:
596     - 0x01 :: this attribute packet is a primary uid
597     - 0x02 :: this attribute packet is revoked
598     - 0x04 :: this attribute packet is expired
599
600 *** SIG_SUBPACKET <type> <flags> <len> <data>
601     This indicates that a signature subpacket was seen.  The format is
602     the same as the "spk" record above.
603
604 ** Key related
605 *** INV_RECP, INV_SGNR
606     The two similar status codes:
607
608     - INV_RECP <reason> <requested_recipient>
609     - INV_SGNR <reason> <requested_sender>
610
611     are issued for each unusable recipient/sender. The reasons codes
612     currently in use are:
613
614        -  0 :: No specific reason given
615        -  1 :: Not Found
616        -  2 :: Ambigious specification
617        -  3 :: Wrong key usage
618        -  4 :: Key revoked
619        -  5 :: Key expired
620        -  6 :: No CRL known
621        -  7 :: CRL too old
622        -  8 :: Policy mismatch
623        -  9 :: Not a secret key
624        - 10 :: Key not trusted
625        - 11 :: Missing certificate
626        - 12 :: Missing issuer certificate
627        - 13 :: Key disabled
628        - 14 :: Syntax error in specification
629
630     If no specific reason was given a previously emitted status code
631     KEY_CONSIDERED may be used to analyzed the problem.
632
633     Note that for historical reasons the INV_RECP status is also used
634     for gpgsm's SIGNER command where it relates to signer's of course.
635     Newer GnuPG versions are using INV_SGNR; applications should
636     ignore the INV_RECP during the sender's command processing once
637     they have seen an INV_SGNR.  Different codes are used so that they
638     can be distinguish while doing an encrypt+sign operation.
639
640 *** NO_RECP <reserved>
641     Issued if no recipients are usable.
642
643 *** NO_SGNR <reserved>
644     Issued if no senders are usable.
645
646 *** KEY_CONSIDERED <fpr> <flags>
647     Issued to explian the lookup of a key.  FPR is the hexified
648     fingerprint of the primary key.  The bit values for FLAGS are:
649
650     - 1 :: The key has not been selected.
651     - 2 :: All subkeys of the key are expired or have been revoked.
652
653 *** KEYEXPIRED <expire-timestamp>
654     The key has expired.  expire-timestamp is the expiration time in
655     seconds since Epoch.  This status line is not very useful because
656     it will also be emitted for expired subkeys even if this subkey is
657     not used.  To check whether a key used to sign a message has
658     expired, the EXPKEYSIG status line is to be used.
659
660     Note, that the TIMESTAMP may either be a number of seconds since
661     Epoch or an ISO 8601 string which can be detected by the presence
662     of the letter 'T'.
663
664 *** KEYREVOKED
665     The used key has been revoked by its owner.  No arguments yet.
666
667 *** NO_PUBKEY  <long keyid>
668     The public key is not available
669
670 *** NO_SECKEY  <long keyid>
671     The secret key is not available
672
673 *** KEY_CREATED <type> <fingerprint> [<handle>]
674     A key has been created.  Values for <type> are:
675       - B :: primary and subkey
676       - P :: primary
677       - S :: subkey
678     The fingerprint is one of the primary key for type B and P and the
679     one of the subkey for S.  Handle is an arbitrary non-whitespace
680     string used to match key parameters from batch key creation run.
681
682 *** KEY_NOT_CREATED [<handle>]
683     The key from batch run has not been created due to errors.
684
685 *** TRUST_
686     These are several similar status codes:
687
688     - TRUST_UNDEFINED <error_token>
689     - TRUST_NEVER     <error_token>
690     - TRUST_MARGINAL  [0  [<validation_model>]]
691     - TRUST_FULLY     [0  [<validation_model>]]
692     - TRUST_ULTIMATE  [0  [<validation_model>]]
693
694     For good signatures one of these status lines are emitted to
695     indicate the validity of the key used to create the signature.
696     The error token values are currently only emitted by gpgsm.
697
698     VALIDATION_MODEL describes the algorithm used to check the
699     validity of the key.  The defaults are the standard Web of Trust
700     model for gpg and the the standard X.509 model for gpgsm.  The
701     defined values are
702
703        - pgp   :: The standard PGP WoT.
704        - shell :: The standard X.509 model.
705        - chain :: The chain model.
706        - steed :: The STEED model.
707        - tofu  :: The TOFU model
708
709     Note that the term =TRUST_= in the status names is used for
710     historic reasons; we now speak of validity.
711
712 *** TOFU_USER <fingerprint_in_hex> <mbox>
713
714     This status identifies the key and the userid for all following
715     Tofu information.  The fingerprint is the fingerprint of the
716     primary key and the mbox is in general the addr-spec part of the
717     userid encoded in UTF-8 and percent escaped.  The fingerprint is
718     indentical for all TOFU_USER lines up to a NEWSIG line.
719
720 *** TOFU_STATS <validity> <sign-count> 0 [<policy> [<tm1> <tm2> <tm3> <tm4>]]
721
722     Statistics for the current user id.
723
724     Values for VALIDITY are:
725     - 0 :: conflict
726     - 1 :: key without history
727     - 2 :: key with too little history
728     - 3 :: key with enough history for basic trust
729     - 4 :: key with a lot of history
730
731     Values for POLICY are:
732     - none    :: No Policy set
733     - auto    :: Policy is "auto"
734     - good    :: Policy is "good"
735     - bad     :: Policy is "bad"
736     - ask     :: Policy is "ask"
737     - unknown :: Policy is not known.
738
739     TM1 ist the time the first message was verified.  TM2 is the time
740     the most recent message was verified.  TM3 is the time the first
741     message was encrypted.  TM4 is the most recent encryption. All may
742     either be seconds since Epoch or an ISO time string
743     (yyyymmddThhmmss).
744
745 *** TOFU_STATS_SHORT <long_string>
746
747     Information about the TOFU binding for the signature.
748     Example: "15 signatures verified. 10 messages encrypted"
749
750 *** TOFU_STATS_LONG <long_string>
751
752     Information about the TOFU binding for the signature in verbose
753     format.  The LONG_STRING is percent escaped.
754     Example: 'Verified 9 messages signed by "Werner Koch
755     (dist sig)" in the past 3 minutes, 40 seconds.  The most
756     recent message was verified 4 seconds ago.'
757
758 *** PKA_TRUST_
759     This is is one:
760
761     - PKA_TRUST_GOOD <addr-spec>
762     - PKA_TRUST_BAD  <addr-spec>
763
764     Depending on the outcome of the PKA check one of the above status
765     codes is emitted in addition to a =TRUST_*= status.
766
767 ** Remote control
768 *** GET_BOOL, GET_LINE, GET_HIDDEN, GOT_IT
769
770     These status line are used with --command-fd for interactive
771     control of the process.
772
773 *** USERID_HINT <long main keyid> <string>
774     Give a hint about the user ID for a certain keyID.
775
776 *** NEED_PASSPHRASE <long keyid> <long main keyid> <keytype> <keylength>
777     Issued whenever a passphrase is needed.  KEYTYPE is the numerical
778     value of the public key algorithm or 0 if this is not applicable,
779     KEYLENGTH is the length of the key or 0 if it is not known (this
780     is currently always the case).
781
782 *** NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
783     Issued whenever a passphrase for symmetric encryption is needed.
784
785 *** NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
786     Issued whenever a PIN is requested to unlock a card.
787
788 *** MISSING_PASSPHRASE
789     No passphrase was supplied.  An application which encounters this
790     message may want to stop parsing immediately because the next
791     message will probably be a BAD_PASSPHRASE.  However, if the
792     application is a wrapper around the key edit menu functionality it
793     might not make sense to stop parsing but simply ignoring the
794     following BAD_PASSPHRASE.
795
796 *** BAD_PASSPHRASE <long keyid>
797     The supplied passphrase was wrong or not given.  In the latter
798     case you may have seen a MISSING_PASSPHRASE.
799
800 *** GOOD_PASSPHRASE
801     The supplied passphrase was good and the secret key material
802     is therefore usable.
803
804 ** Import/Export
805 *** IMPORT_CHECK <long keyid> <fingerprint> <user ID>
806     This status is emitted in interactive mode right before
807     the "import.okay" prompt.
808
809 *** IMPORTED   <long keyid>  <username>
810     The keyid and name of the signature just imported
811
812 *** IMPORT_OK  <reason> [<fingerprint>]
813     The key with the primary key's FINGERPRINT has been imported.
814     REASON flags are:
815
816     - 0 :: Not actually changed
817     - 1 :: Entirely new key.
818     - 2 :: New user IDs
819     - 4 :: New signatures
820     - 8 :: New subkeys
821     - 16 :: Contains private key.
822
823     The flags may be ORed.
824
825 *** IMPORT_PROBLEM <reason> [<fingerprint>]
826     Issued for each import failure.  Reason codes are:
827
828     - 0 :: No specific reason given.
829     - 1 :: Invalid Certificate.
830     - 2 :: Issuer Certificate missing.
831     - 3 :: Certificate Chain too long.
832     - 4 :: Error storing certificate.
833
834 *** IMPORT_RES <args>
835     Final statistics on import process (this is one long line). The
836     args are a list of unsigned numbers separated by white space:
837
838     - <count>
839     - <no_user_id>
840     - <imported>
841     - always 0 (formerly used for the number of RSA keys)
842     - <unchanged>
843     - <n_uids>
844     - <n_subk>
845     - <n_sigs>
846     - <n_revoc>
847     - <sec_read>
848     - <sec_imported>
849     - <sec_dups>
850     - <skipped_new_keys>
851     - <not_imported>
852     - <skipped_v3_keys>
853
854 *** EXPORTED  <fingerprint>
855     The key with <fingerprint> has been exported.  The fingerprint is
856     the fingerprint of the primary key even if the primary key has
857     been replaced by a stub key during secret key export.
858
859 *** EXPORT_RES <args>
860
861     Final statistics on export process (this is one long line). The
862     args are a list of unsigned numbers separated by white space:
863
864     - <count>
865     - <secret_count>
866     - <exported>
867
868
869 ** Smartcard related
870 *** CARDCTRL <what> [<serialno>]
871     This is used to control smartcard operations.  Defined values for
872     WHAT are:
873
874       - 1 :: Request insertion of a card.  Serialnumber may be given
875              to request a specific card.  Used by gpg 1.4 w/o
876              scdaemon
877       - 2 :: Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
878       - 3 :: Card with serialnumber detected
879       - 4 :: No card available
880       - 5 :: No card reader available
881       - 6 :: No card support available
882       - 7 :: Card is in termination state
883
884 *** SC_OP_FAILURE [<code>]
885     An operation on a smartcard definitely failed.  Currently there is
886     no indication of the actual error code, but application should be
887     prepared to later accept more arguments.  Defined values for
888     <code> are:
889
890       - 0 :: unspecified error (identically to a missing CODE)
891       - 1 :: canceled
892       - 2 :: bad PIN
893
894 *** SC_OP_SUCCESS
895     A smart card operaion succeeded.  This status is only printed for
896     certain operation and is mostly useful to check whether a PIN
897     change really worked.
898
899 ** Miscellaneous status codes
900 *** NODATA  <what>
901     No data has been found.  Codes for WHAT are:
902
903     - 1 :: No armored data.
904     - 2 :: Expected a packet but did not found one.
905     - 3 :: Invalid packet found, this may indicate a non OpenPGP
906            message.
907     - 4 :: Signature expected but not found
908
909     You may see more than one of these status lines.
910
911 *** UNEXPECTED <what>
912     Unexpected data has been encountered.  Codes for WHAT are:
913     - 0 :: Not further specified
914     - 1 :: Corrupted message structure
915
916 *** TRUNCATED <maxno>
917     The output was truncated to MAXNO items.  This status code is
918     issued for certain external requests.
919
920 *** ERROR <error location> <error code> [<more>]
921     This is a generic error status message, it might be followed by
922     error location specific data. <error code> and <error_location>
923     should not contain spaces.  The error code is a either a string
924     commencing with a letter or such a string prefixed with a
925     numerical error code and an underscore; e.g.: "151011327_EOF".
926 *** WARNING <location> <error code> [<text>]
927     This is a generic warning status message, it might be followed by
928     error location specific data. <error code> and <location>
929     should not contain spaces.  The error code is a either a string
930     commencing with a letter or such a string prefixed with a
931     numerical error code and an underscore; e.g.: "151011327_EOF".
932 *** SUCCESS [<location>]
933     Postive confirmation that an operation succeeded.  It is used
934     similar to ISO-C's EXIT_SUCCESS.  <location> is optional but if
935     given should not contain spaces.  Used only with a few commands.
936
937 *** FAILURE <location> <error_code>
938     This is the counterpart to SUCCESS and used to indicate a program
939     failure.  It is used similar to ISO-C's EXIT_FAILURE but allows
940     conveying more information, in particular a gpg-error error code.
941     That numerical error code may optionally have a suffix made of an
942     underscore and a string with an error symbol like "151011327_EOF".
943     A dash may be used instead of <location>.
944
945 *** BADARMOR
946     The ASCII armor is corrupted.  No arguments yet.
947
948 *** DELETE_PROBLEM <reason_code>
949     Deleting a key failed.  Reason codes are:
950     - 1 :: No such key
951     - 2 :: Must delete secret key first
952     - 3 :: Ambigious specification
953     - 4 :: Key is stored on a smartcard.
954
955 *** PROGRESS <what> <char> <cur> <total> [<units>]
956     Used by the primegen and Public key functions to indicate
957     progress.  <char> is the character displayed with no --status-fd
958     enabled, with the linefeed replaced by an 'X'.  <cur> is the
959     current amount done and <total> is amount to be done; a <total> of
960     0 indicates that the total amount is not known. The condition
961       :       TOTAL && CUR == TOTAL
962     may be used to detect the end of an operation.
963
964     Well known values for WHAT are:
965
966            - pk_dsa   :: DSA key generation
967            - pk_elg   :: Elgamal key generation
968            - primegen :: Prime generation
969            - need_entropy :: Waiting for new entropy in the RNG
970            - tick :: Generic tick without any special meaning - useful
971                      for letting clients know that the server is still
972                      working.
973            - starting_agent :: A gpg-agent was started because it is not
974                                 running as a daemon.
975            - learncard :: Send by the agent and gpgsm while learing
976                           the data of a smartcard.
977            - card_busy :: A smartcard is still working
978
979     <units> is sometines used to describe the units for <current> and
980     <total>.  For example "B", "KiB", or "MiB".
981
982 *** BACKUP_KEY_CREATED <fingerprint> <fname>
983     A backup of a key identified by <fingerprint> has been writte to
984     the file <fname>; <fname> is percent-escaped.
985
986 *** MOUNTPOINT <name>
987     <name> is a percent-plus escaped filename describing the
988     mountpoint for the current operation (e.g. used by "g13 --mount").
989     This may either be the specified mountpoint or one randomly
990     choosen by g13.
991
992 *** PINENTRY_LAUNCHED <pid>
993     This status line is emitted by gpg to notify a client that a
994     Pinentry has been launched.  <pid> is the PID of the Pinentry.  It
995     may be used to display a hint to the user but can't be used to
996     synchronize with Pinentry.  Note that there is also an Assuan
997     inquiry line with the same name used internally or, if enabled,
998     send to the client instead of this status line.  Such an inquiry
999     may be used to sync with Pinentry
1000
1001 ** Obsolete status codes
1002 *** SIGEXPIRED
1003     Removed on 2011-02-04.  This is deprecated in favor of KEYEXPIRED.
1004 *** RSA_OR_IDEA
1005     Obsolete.  This status message used to be emitted for requests to
1006     use the IDEA or RSA algorithms.  It has been dropped from GnuPG
1007     2.1 after the respective patents expired.
1008 *** SHM_INFO, SHM_GET, SHM_GET_BOOL, SHM_GET_HIDDEN
1009     These were used for the ancient shared memory based co-processing.
1010 *** BEGIN_STREAM, END_STREAM
1011     Used to issued by the experimental pipemode.
1012
1013
1014 * Format of the --attribute-fd output
1015
1016   When --attribute-fd is set, during key listings (--list-keys,
1017   --list-secret-keys) GnuPG dumps each attribute packet to the file
1018   descriptor specified.  --attribute-fd is intended for use with
1019   --status-fd as part of the required information is carried on the
1020   ATTRIBUTE status tag (see above).
1021
1022   The contents of the attribute data is specified by RFC 4880.  For
1023   convenience, here is the Photo ID format, as it is currently the
1024   only attribute defined:
1025
1026   - Byte 0-1 :: The length of the image header.  Due to a historical
1027                 accident (i.e. oops!) back in the NAI PGP days, this
1028                 is a little-endian number.  Currently 16 (0x10 0x00).
1029
1030   - Byte 2 :: The image header version.  Currently 0x01.
1031
1032   - Byte 3 :: Encoding format.  0x01 == JPEG.
1033
1034   - Byte 4-15 :: Reserved, and currently unused.
1035
1036   All other data after this header is raw image (JPEG) data.
1037
1038
1039 * Layout of the TrustDB
1040
1041   The TrustDB is built from fixed length records, where the first byte
1042   describes the record type.  All numeric values are stored in network
1043   byte order.  The length of each record is 40 bytes.  The first
1044   record of the DB is always of type 1 and this is the only record of
1045   this type.
1046
1047   The record types: directory(2), key(3), uid(4), pref(5), sigrec(6),
1048   and shadow directory(8) are not anymore used by version 2 of the
1049   TrustDB.
1050
1051 ** Record type 0
1052
1053    Unused record or deleted, can be reused for any purpose.  Such
1054    records should in general not exist because deleted records are of
1055    type 254 and kept in a linked list.
1056
1057 ** Version info (RECTYPE_VER, 1)
1058
1059    Version information for this TrustDB.  This is always the first
1060    record of the DB and the only one of this type.
1061
1062    - 1 u8 :: Record type (value: 1).
1063    - 3 byte :: Magic value ("gpg")
1064    - 1 u8 :: TrustDB version (value: 2).
1065    - 1 u8 :: =marginals=. How many marginal trusted keys are required.
1066    - 1 u8 :: =completes=. How many completely trusted keys are
1067              required.
1068    - 1 u8 :: =max_cert_depth=.  How deep is the WoT evaluated.  Along
1069              with =marginals= and =completes=, this value is used to
1070              check whether the cached validity value from a [FIXME
1071              dir] record can be used.
1072    - 1 u8 :: =trust_model=
1073    - 1 u8 :: =min_cert_level=
1074    - 2 byte :: Not used
1075    - 1 u32 :: =created=. Timestamp of trustdb creation.
1076    - 1 u32 :: =nextcheck=. Timestamp of last modification which may
1077               affect the validity of keys in the trustdb.  This value
1078               is checked against the validity timestamp in the dir
1079               records.
1080    - 1 u32 :: =reserved=.  Not used.
1081    - 1 u32 :: =reserved2=. Not used.
1082    - 1 u32 :: =firstfree=. Number of the record with the head record
1083               of the RECTYPE_FREE linked list.
1084    - 1 u32 :: =reserved3=. Not used.
1085    - 1 u32 :: =trusthashtbl=. Record number of the trusthashtable.
1086
1087
1088 ** Hash table (RECTYPE_HTBL, 10)
1089
1090    Due to the fact that we use fingerprints to lookup keys, we can
1091    implement quick access by some simple hash methods, and avoid the
1092    overhead of gdbm.  A property of fingerprints is that they can be
1093    used directly as hash values.  What we use is a dynamic multilevel
1094    architecture, which combines hash tables, record lists, and linked
1095    lists.
1096
1097    This record is a hash table of 256 entries with the property that
1098    all these records are stored consecutively to make one big
1099    table. The hash value is simple the 1st, 2nd, ... byte of the
1100    fingerprint (depending on the indirection level).
1101
1102    - 1 u8 :: Record type (value: 10).
1103    - 1 u8 :: Reserved
1104    - n u32 :: =recnum=.  A table with the hash table items fitting into
1105               this record.  =n= depends on the record length:
1106               $n=(reclen-2)/4$ which yields 9 for oure current record
1107               length of 40 bytes.
1108
1109    The total number of hash table records to form the table is:
1110    $m=(256+n-1)/n$.  This is 29 for our record length of 40.
1111
1112    To look up a key we use the first byte of the fingerprint to get
1113    the recnum from this hash table and then look up the addressed
1114    record:
1115
1116    - If that record is another hash table, we use 2nd byte to index
1117      that hash table and so on;
1118    - if that record is a hash list, we walk all entries until we find
1119      a matching one; or
1120    - if that record is a key record, we compare the fingerprint to
1121      decide whether it is the requested key;
1122
1123
1124 ** Hash list (RECTYPE_HLST, 11)
1125
1126    See hash table above on how it is used.  It may also be used for
1127    other purposes.
1128
1129    - 1 u8 :: Record type (value: 11).
1130    - 1 u8 :: Reserved.
1131    - 1 u32 :: =next=.  Record number of the next hash list record or 0
1132               if none.
1133    - n u32 :: =rnum=.  Array with record numbers to values.  With
1134               $n=(reclen-5)/5$ and our record length of 40, n is 7.
1135
1136 ** Trust record (RECTYPE_TRUST, 12)
1137
1138    - 1 u8 :: Record type (value: 12).
1139    - 1 u8 :: Reserved.
1140    - 20 byte :: =fingerprint=.
1141    - 1 u8 :: =ownertrust=.
1142    - 1 u8 :: =depth=.
1143    - 1 u8 :: =min_ownertrust=.
1144    - 1 byte :: Not used.
1145    - 1 u32 :: =validlist=.
1146    - 10 byte :: Not used.
1147
1148 ** Validity record (RECTYPE_VALID, 13)
1149
1150    - 1 u8 :: Record type (value: 13).
1151    - 1 u8 :: Reserved.
1152    - 20 byte :: =namehash=.
1153    - 1 u8 :: =validity=
1154    - 1 u32 :: =next=.
1155    - 1 u8 :: =full_count=.
1156    - 1 u8 :: =marginal_count=.
1157    - 11 byte :: Not used.
1158
1159 ** Free record (RECTYPE_FREE, 254)
1160
1161    All these records form a linked list of unused records in the TrustDB.
1162
1163    - 1 u8 :: Record type (value: 254)
1164    - 1 u8 :: Reserved.
1165    - 1 u32 :: =next=.  Record number of the next rcord of this type.
1166               The record number to the head of this linked list is
1167               stored in the version info record.
1168
1169
1170 * Database scheme for the TOFU info
1171
1172 #+begin_src sql
1173 --
1174 -- The VERSION table holds the version of our TOFU data structures.
1175 --
1176 CREATE TABLE version (
1177   version integer -- As of now this is always 1
1178 );
1179
1180 --
1181 -- The BINDINGS table associates mail addresses with keys.
1182 --
1183 CREATE TABLE bindings (
1184   oid integer primary key autoincrement,
1185   fingerprint text, -- The key's fingerprint in hex
1186   email text,       -- The normalized mail address destilled from user_id
1187   user_id text,     -- The unmodified user id
1188   time integer,     -- The time this binding was first observed.
1189   policy boolean check
1190        (policy in (1, 2, 3, 4, 5)), -- The trust policy with the values:
1191                                     --   1 := Auto
1192                                     --   2 := Good
1193                                     --   3 := Unknown
1194                                     --   4 := Bad
1195                                     --   5 := Ask
1196   conflict string,  -- NULL or a hex formatted fingerprint.
1197   unique (fingerprint, email)
1198 );
1199
1200 CREATE INDEX bindings_fingerprint_email on bindings (fingerprint, email);
1201 CREATE INDEX bindings_email on bindings (email);
1202
1203 --
1204 -- The SIGNATURES table records all data signatures we verified
1205 --
1206 CREATE TABLE signatures (
1207   binding integer not null, -- Link to bindings table,
1208                             -- references bindings.oid.
1209   sig_digest text,          -- The digest of the signed message.
1210   origin text,              -- String describing who initially fed
1211                             -- the signature to gpg (e.g. "email:claws").
1212   sig_time integer,         -- Timestamp from the signature.
1213   time integer,             -- Time this record was created.
1214   primary key (binding, sig_digest, origin)
1215 );
1216 #+end_src
1217
1218
1219 * GNU extensions to the S2K algorithm
1220
1221   1 octet  - S2K Usage: either 254 or 255.
1222   1 octet  - S2K Cipher Algo: 0
1223   1 octet  - S2K Specifier: 101
1224   3 octets - "GNU"
1225   1 octet  - GNU S2K Extension Number.
1226
1227   If such a GNU extension is used neither an IV nor any kind of
1228   checksum is used.  The defined GNU S2K Extension Numbers are:
1229
1230   - 1 :: Do not store the secret part at all.  No specific data
1231          follows.
1232
1233   - 2 :: A stub to access smartcards.  This data follows:
1234          - One octet with the length of the following serial number.
1235          - The serial number. Regardless of what the length octet
1236            indicates no more than 16 octets are stored.
1237
1238   Note that gpg stores the GNU S2K Extension Number internally as an
1239   S2K Specifier with an offset of 1000.
1240
1241
1242 * Keyserver helper message format
1243
1244   *This information is obsolete*
1245   (Keyserver helpers have been replaced by dirmngr)
1246
1247   The keyserver may be contacted by a Unix Domain socket or via TCP.
1248
1249   The format of a request is:
1250 #+begin_example
1251   command-tag
1252   "Content-length:" digits
1253   CRLF
1254 #+end_example
1255
1256   Where command-tag is
1257
1258 #+begin_example
1259   NOOP
1260   GET <user-name>
1261   PUT
1262   DELETE <user-name>
1263 #+end_example
1264
1265 The format of a response is:
1266
1267 #+begin_example
1268   "GNUPG/1.0" status-code status-text
1269   "Content-length:" digits
1270   CRLF
1271 #+end_example
1272 followed by <digits> bytes of data
1273
1274 Status codes are:
1275
1276   - 1xx :: Informational - Request received, continuing process
1277
1278   - 2xx :: Success - The action was successfully received, understood,
1279            and accepted
1280
1281   - 4xx :: Client Error - The request contains bad syntax or cannot be
1282            fulfilled
1283
1284   - 5xx :: Server Error - The server failed to fulfill an apparently
1285            valid request
1286
1287
1288 * Object identifiers
1289
1290   OIDs below the GnuPG arc:
1291
1292 #+begin_example
1293   1.3.6.1.4.1.11591.2          GnuPG
1294   1.3.6.1.4.1.11591.2.1          notation
1295   1.3.6.1.4.1.11591.2.1.1          pkaAddress
1296   1.3.6.1.4.1.11591.2.2          X.509 extensions
1297   1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
1298   1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
1299   1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
1300 #+end_example
1301
1302
1303
1304 * Miscellaneous notes
1305
1306 ** v3 fingerprints
1307    For packet version 3 we calculate the keyids this way:
1308     - RSA :: Low 64 bits of n
1309     - ELGAMAL :: Build a v3 pubkey packet (with CTB 0x99) and
1310                  calculate a RMD160 hash value from it. This is used
1311                  as the fingerprint and the low 64 bits are the keyid.
1312
1313 ** Simplified revocation certificates
1314   Revocation certificates consist only of the signature packet;
1315   "--import" knows how to handle this.  The rationale behind it is to
1316   keep them small.
1317
1318 ** Documentation on HKP (the http keyserver protocol):
1319
1320    A minimalistic HTTP server on port 11371 recognizes a GET for
1321    /pks/lookup.  The standard http URL encoded query parameters are
1322    this (always key=value):
1323
1324    - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1325      pgp -kxa)
1326
1327    - search=<stringlist>. This is a list of words that must occur in the key.
1328      The words are delimited with space, points, @ and so on. The delimiters
1329      are not searched for and the order of the words doesn't matter (but see
1330      next option).
1331
1332    - exact=on. This switch tells the hkp server to only report exact matching
1333      keys back. In this case the order and the "delimiters" are important.
1334
1335    - fingerprint=on. Also reports the fingerprints when used with 'index' or
1336      'vindex'
1337
1338    The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1339    keys.
1340
1341
1342    A better way to do this would be a request like:
1343
1344       /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1345
1346    This can be implemented using Hurd's translator mechanism.
1347    However, I think the whole keyserver stuff has to be re-thought;
1348    I have some ideas and probably create a white paper.
1349 ** Algorithm names for the "keygen.algo" prompt
1350
1351   When using a --command-fd controlled key generation or "addkey"
1352   there is way to know the number to enter on the "keygen.algo"
1353   prompt.  The displayed numbers are for human reception and may
1354   change with releases.  To provide a stable way to enter a desired
1355   algorithm choice the prompt also accepts predefined names for the
1356   algorithms, which will not change.
1357
1358    | Name    | No | Description                     |
1359    |---------+----+---------------------------------|
1360    | rsa+rsa |  1 | RSA and RSA (default)           |
1361    | dsa+elg |  2 | DSA and Elgamal                 |
1362    | dsa     |  3 | DSA (sign only)                 |
1363    | rsa/s   |  4 | RSA (sign only)                 |
1364    | elg     |  5 | Elgamal (encrypt only)          |
1365    | rsa/e   |  6 | RSA (encrypt only)              |
1366    | dsa/*   |  7 | DSA (set your own capabilities) |
1367    | rsa/*   |  8 | RSA (set your own capabilities) |
1368    | ecc+ecc |  9 | ECC and ECC                     |
1369    | ecc/s   | 10 | ECC (sign only)                 |
1370    | ecc/*   | 11 | ECC (set your own capabilities) |
1371    | ecc/e   | 12 | ECC (encrypt only)              |
1372    | keygrip | 13 | Existing key                    |
1373
1374    If one of the "foo/*" names are used a "keygen.flags" prompt needs
1375    to be answered as well.  Instead of toggling the predefined flags,
1376    it is also possible to set them direct: Use a "=" character
1377    directly followed by a comination of "a" (for authentication), "s"
1378    (for signing), or "c" (for certification).