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