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