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