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