gpg: Add status line PINENTRY_LAUNCHED.
[gnupg.git] / doc / DETAILS
1                                                               -*- text -*-
2 Format of colon listings
3 ========================
4 First an example:
5
6 $ gpg --with-colons --list-keys \
7       --with-fingerprint --with-fingerprint wk@gnupg.org
8
9 pub:f:1024:17:6C7EE1B8621CC013:899817715:1055898235::m:::scESC:
10 fpr:::::::::ECAF7590EB3443B5C7CF3ACB6C7EE1B8621CC013:
11 uid:f::::::::Werner Koch <wk@g10code.com>:
12 uid:f::::::::Werner Koch <wk@gnupg.org>:
13 sub:f:1536:16:06AD222CADF6A6E1:919537416:1036177416:::::e:
14 fpr:::::::::CF8BCC4B18DE08FCD8A1615906AD222CADF6A6E1:
15 sub:r:1536:20:5CE086B5B5A18FF4:899817788:1025961788:::::esc:
16 fpr:::::::::AB059359A3B81F410FCFF97F5CE086B5B5A18FF4:
17
18 The double --with-fingerprint prints the fingerprint for the subkeys
19 too. --fixed-list-mode is the modern listing way printing dates in
20 seconds since Epoch and does not merge the first userID with the pub
21 record; gpg2 does this by default and the option is a dummy.
22
23
24  1. Field:  Type of record
25             pub = public key
26             crt = X.509 certificate
27             crs = X.509 certificate and private key available
28             sub = subkey (secondary key)
29             sec = secret key
30             ssb = secret subkey (secondary key)
31             uid = user id (only field 10 is used).
32             uat = user attribute (same as user id except for field 10).
33             sig = signature
34             rev = revocation signature
35             fpr = fingerprint: (fingerprint is in field 10)
36             pkd = public key data (special field format, see below)
37             grp = keygrip
38             rvk = revocation key
39             tru = trust database information
40             spk = signature subpacket
41
42  2. Field:  A letter describing the calculated validity. This is a single
43             letter, but be prepared that additional information may follow
44             in some future versions. (not used for secret keys)
45                 o = Unknown (this key is new to the system)
46                 i = The key is invalid (e.g. due to a missing self-signature)
47                 d = The key has been disabled
48                     (deprecated - use the 'D' in field 12 instead)
49                 r = The key has been revoked
50                 e = The key has expired
51                 - = Unknown validity (i.e. no value assigned)
52                 q = Undefined validity
53                     '-' and 'q' may safely be treated as the same
54                     value for most purposes
55                 n = The key is not valid
56                 m = The key is marginal valid.
57                 f = The key is fully valid
58                 u = The key is ultimately valid.  This often means
59                     that the secret key is available, but any key may
60                     be marked as ultimately valid.
61                 w = The key has a well known private part.
62                 s = The key has special validity.  This means that it
63                     might be self-signed and expected to be used in
64                     the STEED sytem.
65
66             If the validity information is given for a UID or UAT
67             record, it describes the validity calculated based on this
68             user ID.  If given for a key record it describes the best
69             validity taken from the best rated user ID.
70
71             For X.509 certificates a 'u' is used for a trusted root
72             certificate (i.e. for the trust anchor) and an 'f' for all
73             other valid certificates.
74
75  3. Field:  length of key in bits.
76
77  4. Field:  Algorithm:  1 = RSA
78                        16 = Elgamal (encrypt only)
79                        17 = DSA (sometimes called DH, sign only)
80                        20 = Elgamal (sign and encrypt - don't use them!)
81             (for other id's see include/cipher.h)
82
83  5. Field:  KeyID
84
85  6. Field:  Creation Date (in UTC).  For UID and UAT records, this is
86             the self-signature date.  Note that the date is usally
87             printed in seconds since epoch, however, we are migrating
88             to an ISO 8601 format (e.g. "19660205T091500").  This is
89             currently only relevant for X.509.  A simple way to detect
90             the new format is to scan for the 'T'.
91
92  7. Field:  Key or user ID/user attribute expiration date or empty if none.
93
94  8. Field:  Used for serial number in crt records (used to be the Local-ID).
95             For UID and UAT records, this is a hash of the user ID contents
96             used to represent that exact user ID.  For trust signatures,
97             this is the trust depth seperated by the trust value by a
98             space.
99
100  9. Field:  Ownertrust (primary public keys only)
101             This is a single letter, but be prepared that additional
102             information may follow in some future versions.  For trust
103             signatures with a regular expression, this is the regular
104             expression value, quoted as in field 10.
105
106 10. Field:  User-ID.  The value is quoted like a C string to avoid
107             control characters (the colon is quoted "\x3a").
108             For a "pub" record this field is not used on --fixed-list-mode.
109             A UAT record puts the attribute subpacket count here, a
110             space, and then the total attribute subpacket size.
111             In gpgsm the issuer name comes here
112             An FPR record stores the fingerprint here.
113             The fingerprint of an revocation key is stored here.
114
115 11. Field:  Signature class as per RFC-4880.  This is a 2 digit
116             hexnumber followed by either the letter 'x' for an
117             exportable signature or the letter 'l' for a local-only
118             signature.  The class byte of an revocation key is also
119             given here, 'x' and 'l' is used the same way.  IT is not
120             used for X.509.
121
122 12. Field:  Key capabilities:
123                 e = encrypt
124                 s = sign
125                 c = certify
126                 a = authentication
127             A key may have any combination of them in any order.  In
128             addition to these letters, the primary key has uppercase
129             versions of the letters to denote the _usable_
130             capabilities of the entire key, and a potential letter 'D'
131             to indicate a disabled key.
132
133 13. Field:  Used in FPR records for S/MIME keys to store the
134             fingerprint of the issuer certificate.  This is useful to
135             build the certificate path based on certificates stored in
136             the local keyDB; it is only filled if the issuer
137             certificate is available. The root has been reached if
138             this is the same string as the fingerprint. The advantage
139             of using this value is that it is guaranteed to have been
140             been build by the same lookup algorithm as gpgsm uses.
141             For "uid" records this lists the preferences in the same
142             way the gpg's --edit-key menu does.
143             For "sig" records, this is the fingerprint of the key that
144             issued the signature.  Note that this is only filled in if
145             the signature verified correctly.  Note also that for
146             various technical reasons, this fingerprint is only
147             available if --no-sig-cache is used.
148
149 14. Field   Flag field used in the --edit menu output:
150
151 15. Field   Used in sec/sbb to print the serial number of a token
152             (internal protect mode 1002) or a '#' if that key is a
153             simple stub (internal protect mode 1001)
154 16. Field:  For sig records, this is the used hash algorithm:
155                 2 = SHA-1
156                 8 = SHA-256
157             (for other id's see include/cipher.h)
158
159 All dates are displayed in the format yyyy-mm-dd unless you use the
160 option --fixed-list-mode in which case they are displayed as seconds
161 since Epoch.  More fields may be added later, so parsers should be
162 prepared for this. When parsing a number the parser should stop at the
163 first non-number character so that additional information can later be
164 added.
165
166 If field 1 has the tag "pkd", a listing looks like this:
167 pkd:0:1024:B665B1435F4C2 .... FF26ABB:
168     !  !   !-- the value
169     !  !------ for information number of bits in the value
170     !--------- index (eg. DSA goes from 0 to 3: p,q,g,y)
171
172
173 Example for a "tru" trust base record:
174
175    tru:o:0:1166697654:1:3:1:5
176
177  The fields are:
178
179  2: Reason for staleness of trust.  If this field is empty, then the
180     trustdb is not stale.  This field may have multiple flags in it:
181
182     o: Trustdb is old
183     t: Trustdb was built with a different trust model than the one we
184        are using now.
185
186  3: Trust model:
187     0: Classic trust model, as used in PGP 2.x.
188     1: PGP trust model, as used in PGP 6 and later.  This is the same
189        as the classic trust model, except for the addition of trust
190        signatures.
191
192     GnuPG before version 1.4 used the classic trust model by default.
193     GnuPG 1.4 and later uses the PGP trust model by default.
194
195  4: Date trustdb was created in seconds since 1970-01-01.
196  5: Date trustdb will expire in seconds since 1970-01-01.
197  6: Number of marginally trusted users to introduce a new key signer
198     (gpg's option --marginals-needed)
199  7: Number of completely trusted users to introduce a new key signer.
200     (gpg's option --completes-needed)
201  8: Maximum depth of a certification chain.
202     *gpg's option --max-cert-depth)
203
204 The "spk" signature subpacket records have the fields:
205
206  2: Subpacket number as per RFC-4880 and later.
207  3: Flags in hex.  Currently the only two bits assigned are 1, to
208     indicate that the subpacket came from the hashed part of the
209     signature, and 2, to indicate the subpacket was marked critical.
210  4: Length of the subpacket.  Note that this is the length of the
211     subpacket, and not the length of field 5 below.  Due to the need
212     for %-encoding, the length of field 5 may be up to 3x this value.
213  5: The subpacket data.  Printable ASCII is shown as ASCII, but other
214     values are rendered as %XX where XX is the hex value for the byte.
215
216
217 Format of the "--status-fd" output
218 ==================================
219 Every line is prefixed with "[GNUPG:] ", followed by a keyword with
220 the type of the status line and a some arguments depending on the
221 type (maybe none); an application should always be prepared to see
222 more arguments in future versions.
223
224
225     NEWSIG
226         May be issued right before a signature verification starts.  This
227         is useful to define a context for parsing ERROR status
228         messages.  No arguments are currently defined.
229
230     GOODSIG  <long_keyid_or_fpr>  <username>
231         The signature with the keyid is good.  For each signature only
232         one of the codes GOODSIG, BADSIG, EXPSIG, EXPKEYSIG, REVKEYSIG
233         or ERRSIG will be emitted.  In the past they were used as a
234         marker for a new signature; new code should use the NEWSIG
235         status instead.  The username is the primary one encoded in
236         UTF-8 and %XX escaped. The fingerprint may be used instead of
237         the long keyid if it is available.  This is the case with CMS
238         and might eventually also be available for OpenPGP.
239
240     EXPSIG  <long_keyid_or_fpr>  <username>
241         The signature with the keyid is good, but the signature is
242         expired. The username is the primary one encoded in UTF-8 and
243         %XX escaped. The fingerprint may be used instead of the long
244         keyid if it is available.  This is the case with CMS and might
245         eventually also be available for OpenPGP.
246
247     EXPKEYSIG  <long_keyid_or_fpr> <username>
248         The signature with the keyid is good, but the signature was
249         made by an expired key. The username is the primary one
250         encoded in UTF-8 and %XX escaped.  The fingerprint may be used
251         instead of the long keyid if it is available.  This is the
252         case with CMS and might eventually also be available for
253         OpenPGP.
254
255     REVKEYSIG  <long_keyid_or_fpr>  <username>
256         The signature with the keyid is good, but the signature was
257         made by a revoked key. The username is the primary one encoded
258         in UTF-8 and %XX escaped. The fingerprint may be used instead
259         of the long keyid if it is available.  This is the case with
260         CMS and might eventually also be available for OpenPGP.
261
262     BADSIG  <long_keyid_or_fpr>  <username>
263         The signature with the keyid has not been verified okay.  The
264         username is the primary one encoded in UTF-8 and %XX
265         escaped. The fingerprint may be used instead of the long keyid
266         if it is available.  This is the case with CMS and might
267         eventually also be available for OpenPGP.
268
269     ERRSIG  <long_keyid_or_fpr>  <pubkey_algo> <hash_algo> \
270             <sig_class> <timestamp> <rc>
271         It was not possible to check the signature.  This may be
272         caused by a missing public key or an unsupported algorithm.  A
273         RC of 4 indicates unknown algorithm, a 9 indicates a missing
274         public key. The other fields give more information about this
275         signature.  sig_class is a 2 byte hex-value.  The fingerprint
276         may be used instead of the long keyid if it is available.
277         This is the case with CMS and might eventually also be
278         available for OpenPGP.
279
280         Note, that TIMESTAMP may either be a number with seconds since
281         epoch or an ISO 8601 string which can be detected by the
282         presence of the letter 'T' inside.
283
284     VALIDSIG    <fingerprint in hex> <sig_creation_date> <sig-timestamp>
285                 <expire-timestamp>  <sig-version> <reserved> <pubkey-algo>
286                 <hash-algo> <sig-class> [ <primary-key-fpr> ]
287
288         The signature with the keyid is good. This is the same as
289         GOODSIG but has the fingerprint as the argument. Both status
290         lines are emitted for a good signature.  All arguments here
291         are on one long line.  sig-timestamp is the signature creation
292         time in seconds after the epoch. expire-timestamp is the
293         signature expiration time in seconds after the epoch (zero
294         means "does not expire"). sig-version, pubkey-algo, hash-algo,
295         and sig-class (a 2-byte hex value) are all straight from the
296         signature packet.  PRIMARY-KEY-FPR is the fingerprint of the
297         primary key or identical to the first argument.  This is
298         useful to get back to the primary key without running gpg
299         again for this purpose.
300
301         The primary-key-fpr parameter is used for OpenPGP and not
302         available for CMS signatures.  The sig-version as well as the
303         sig class is not defined for CMS and currently set to 0 and 00.
304
305         Note, that *-TIMESTAMP may either be a number with seconds
306         since epoch or an ISO 8601 string which can be detected by the
307         presence of the letter 'T' inside.
308
309     SIG_ID  <radix64_string>  <sig_creation_date>  <sig-timestamp>
310         This is emitted only for signatures of class 0 or 1 which
311         have been verified okay.  The string is a signature id
312         and may be used in applications to detect replay attacks
313         of signed messages.  Note that only DLP algorithms give
314         unique ids - others may yield duplicated ones when they
315         have been created in the same second.
316
317         Note, that SIG-TIMESTAMP may either be a number with seconds
318         since epoch or an ISO 8601 string which can be detected by the
319         presence of the letter 'T' inside.
320
321     ENC_TO  <long_keyid>  <keytype>  <keylength>
322         The message is encrypted to this LONG_KEYID.  KEYTYPE is the
323         numerical value of the public key algorithm or 0 if it is not
324         known, KEYLENGTH is the length of the key or 0 if it is not
325         known (which is currently always the case).  Gpg prints this
326         line always; Gpgsm only if it knows the certificate.
327
328     NODATA  <what>
329         No data has been found. Codes for what are:
330             1 - No armored data.
331             2 - Expected a packet but did not found one.
332             3 - Invalid packet found, this may indicate a non OpenPGP
333                 message.
334             4 - signature expected but not found
335         You may see more than one of these status lines.
336
337     UNEXPECTED <what>
338         Unexpected data has been encountered
339             0 - not further specified
340
341
342     TRUST_UNDEFINED <error token>
343     TRUST_NEVER     <error token>
344     TRUST_MARGINAL  [0  [<validation_model>]]
345     TRUST_FULLY     [0  [<validation_model>]]
346     TRUST_ULTIMATE  [0  [<validation_model>]]
347         For good signatures one of these status lines are emitted to
348         indicate the validity of the key used to create the signature.
349         The error token values are currently only emitted by gpgsm.
350         VALIDATION_MODEL describes the algorithm used to check the
351         validity of the key.  The defaults are the standard Web of
352         Trust model for gpg and the the standard X.509 model for
353         gpgsm.  The defined values are
354
355            "pgp"   for the standard PGP WoT.
356            "shell" for the standard X.509 model.
357            "chain" for the chain model.
358            "steed" for the STEED model.
359
360         Note that we use the term "TRUST_" in the status names for
361         historic reasons; we now speak of validity.
362
363     PKA_TRUST_GOOD <mailbox>
364     PKA_TRUST_BAD  <mailbox>
365         Depending on the outcome of the PKA check one of the above
366         status codes is emitted in addition to a TRUST_* status.
367         Without PKA info available or
368
369     KEYEXPIRED <expire-timestamp>
370         The key has expired.  expire-timestamp is the expiration time
371         in seconds since Epoch.  This status line is not very useful
372         because it will also be emitted for expired subkeys even if
373         this subkey is not used.  To check whether a key used to sign
374         a message has expired, the EXPKEYSIG status line is to be
375         used.
376
377         Note, that TIMESTAMP may either be a number with seconds since
378         epoch or an ISO 8601 string which can be detected by the
379         presence of the letter 'T' inside.
380
381     KEYREVOKED
382         The used key has been revoked by its owner.  No arguments yet.
383
384     BADARMOR
385         The ASCII armor is corrupted.  No arguments yet.
386
387     RSA_OR_IDEA
388         Obsolete.  This status message used to be emitted for requests
389         to use the IDEA or RSA algorithms.  It has been dropped from
390         GnuPG 2.1 after the respective patents expired.
391
392     SHM_INFO
393     SHM_GET
394     SHM_GET_BOOL
395     SHM_GET_HIDDEN
396
397     GET_BOOL
398     GET_LINE
399     GET_HIDDEN
400     GOT_IT
401
402     NEED_PASSPHRASE <long main keyid> <long keyid> <keytype> <keylength>
403         Issued whenever a passphrase is needed.
404         keytype is the numerical value of the public key algorithm
405         or 0 if this is not applicable, keylength is the length
406         of the key or 0 if it is not known (this is currently always the case).
407
408     NEED_PASSPHRASE_SYM <cipher_algo> <s2k_mode> <s2k_hash>
409         Issued whenever a passphrase for symmetric encryption is needed.
410
411     NEED_PASSPHRASE_PIN <card_type> <chvno> [<serialno>]
412         Issued whenever a PIN is requested to unlock a card.
413
414     MISSING_PASSPHRASE
415         No passphrase was supplied.  An application which encounters this
416         message may want to stop parsing immediately because the next message
417         will probably be a BAD_PASSPHRASE.  However, if the application
418         is a wrapper around the key edit menu functionality it might not
419         make sense to stop parsing but simply ignoring the following
420         BAD_PASSPHRASE.
421
422     BAD_PASSPHRASE <long keyid>
423         The supplied passphrase was wrong or not given.  In the latter case
424         you may have seen a MISSING_PASSPHRASE.
425
426     GOOD_PASSPHRASE
427         The supplied passphrase was good and the secret key material
428         is therefore usable.
429
430     NO_PUBKEY  <long keyid>
431     NO_SECKEY  <long keyid>
432         The key is not available
433
434     IMPORT_CHECK <long keyid> <fingerprint> <user ID>
435         This status is emitted in interactive mode right before
436         the "import.okay" prompt.
437
438     IMPORTED   <long keyid>  <username>
439         The keyid and name of the signature just imported
440
441     IMPORT_OK  <reason> [<fingerprint>]
442         The key with the primary key's FINGERPRINT has been imported.
443         Reason flags:
444           0 := Not actually changed
445           1 := Entirely new key.
446           2 := New user IDs
447           4 := New signatures
448           8 := New subkeys
449          16 := Contains private key.
450         The flags may be ORed.
451
452     IMPORT_PROBLEM <reason> [<fingerprint>]
453         Issued for each import failure.  Reason codes are:
454           0 := "No specific reason given".
455           1 := "Invalid Certificate".
456           2 := "Issuer Certificate missing".
457           3 := "Certificate Chain too long".
458           4 := "Error storing certificate".
459
460     IMPORT_RES <count> <no_user_id> <imported> <imported_rsa> <unchanged>
461         <n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported>
462         <sec_dups> <skipped_new_keys> <not_imported>
463         Final statistics on import process (this is one long line)
464
465     FILE_START <what> <filename>
466         Start processing a file <filename>.  <what> indicates the performed
467         operation:
468             1 - verify
469             2 - encrypt
470             3 - decrypt
471
472     FILE_DONE
473         Marks the end of a file processing which has been started
474         by FILE_START.
475
476     BEGIN_DECRYPTION
477     END_DECRYPTION
478         Mark the start and end of the actual decryption process.  These
479         are also emitted when in --list-only mode.
480
481     DECRYPTION_INFO <mdc_method> <sym_algo>
482         Print information about the symmetric encryption algorithm and
483         the MDC method.  This will be emitted even if the decryption
484         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
493         for a conventional encrypted message was given.  The program
494         itself may return an errorcode because it may not be possible to
495         verify a signature for some reasons.
496
497     BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
498     END_ENCRYPTION
499         Mark the start and end of the actual encryption process.
500
501     BEGIN_SIGNING
502        Mark the start of the actual signing process. This may be used
503        as an indication that all requested secret keys are ready for
504        use.
505
506     DELETE_PROBLEM reason_code
507         Deleting a key failed.  Reason codes are:
508             1 - No such key
509             2 - Must delete secret key first
510             3 - Ambigious specification
511
512     PROGRESS what char cur total
513         Used by the primegen and Public key functions to indicate progress.
514         "char" is the character displayed with no --status-fd enabled, with
515         the linefeed replaced by an 'X'.  "cur" is the current amount
516         done and "total" is amount to be done; a "total" of 0 indicates that
517         the total amount is not known.  The condition
518            TOATL && CUR == TOTAL
519         may be used to detect the end of an operation.
520         Well known values for WHAT:
521              "pk_dsa"   - DSA key generation
522              "pk_elg"   - Elgamal key generation
523              "primegen" - Prime generation
524              "need_entropy" - Waiting for new entropy in the RNG
525              "file:XXX" - processing file XXX
526                           (note that current gpg versions leave out the
527                            "file:" prefix).
528              "tick"     - generic tick without any special meaning - useful
529                           for letting clients know that the server is
530                           still working.
531              "starting_agent" - A gpg-agent was started because it is not
532                           running as a daemon.
533              "learncard"  Send by the agent and gpgsm while learing
534                           the data of a smartcard.
535              "card_busy"  A smartcard is still working
536
537     SIG_CREATED <type> <pubkey algo> <hash algo> <class> <timestamp> <key fpr>
538         A signature has been created using these parameters.
539             type:  'D' = detached
540                    'C' = cleartext
541                    'S' = standard
542                    (only the first character should be checked)
543             class: 2 hex digits with the signature class
544
545         Note, that TIMESTAMP may either be a number with seconds since
546         epoch or an ISO 8601 string which can be detected by the
547         presence of the letter 'T' inside.
548
549     KEY_CREATED <type> <fingerprint> [<handle>]
550         A key has been created
551             type: 'B' = primary and subkey
552                   'P' = primary
553                   'S' = subkey
554         The fingerprint is one of the primary key for type B and P and
555         the one of the subkey for S.  Handle is an arbitrary
556         non-whitespace string used to match key parameters from batch
557         key creation run.
558
559     KEY_NOT_CREATED [<handle>]
560         The key from batch run has not been created due to errors.
561
562
563     SESSION_KEY  <algo>:<hexdigits>
564         The session key used to decrypt the message.  This message will
565         only be emitted when the special option --show-session-key
566         is used.  The format is suitable to be passed to the option
567         --override-session-key
568
569     NOTATION_NAME <name>
570     NOTATION_DATA <string>
571         name and string are %XX escaped; the data may be split
572         among several NOTATION_DATA lines.
573
574     USERID_HINT <long main keyid> <string>
575         Give a hint about the user ID for a certain keyID.
576
577     POLICY_URL <string>
578         string is %XX escaped
579
580     BEGIN_STREAM
581     END_STREAM
582         Issued by pipemode.
583
584     INV_RECP <reason> <requested_recipient>
585     INV_SGNR <reason> <requested_sender>
586         Issued for each unusable recipient/sender. The reasons codes
587         currently in use are:
588           0 := "No specific reason given".
589           1 := "Not Found"
590           2 := "Ambigious specification"
591           3 := "Wrong key usage"
592           4 := "Key revoked"
593           5 := "Key expired"
594           6 := "No CRL known"
595           7 := "CRL too old"
596           8 := "Policy mismatch"
597           9 := "Not a secret key"
598          10 := "Key not trusted"
599          11 := "Missing certificate"
600          12 := "Missing issuer certificate"
601
602         Note that for historical reasons the INV_RECP status is also
603         used for gpgsm's SIGNER command where it relates to signer's
604         of course.  Newer GnuPG versions are using INV_SGNR;
605         applications should ignore the INV_RECP during the sender's
606         command processing once they have seen an INV_SGNR.  We use
607         different code so that we can distinguish them while doing an
608         encrypt+sign.
609
610
611     NO_RECP <reserved>
612     NO_SGNR <reserved>
613         Issued when no recipients/senders are usable.
614
615     ALREADY_SIGNED <long-keyid>
616         Warning: This is experimental and might be removed at any time.
617
618     TRUNCATED <maxno>
619         The output was truncated to MAXNO items.  This status code is issued
620         for certain external requests
621
622     ERROR <error location> <error code> [<more>]
623
624         This is a generic error status message, it might be followed
625         by error location specific data. <error code> and
626         <error_location> should not contain spaces.  The error code is
627         a either a string commencing with a letter or such a string
628         prefixed with a numerical error code and an underscore; e.g.:
629         "151011327_EOF".
630
631     SUCCESS [<location>]
632         Postive confirimation that an operation succeeded.  <location>
633         is optional but if given should not contain spaces.
634         Used only with a few commands.
635
636
637     ATTRIBUTE <fpr> <octets> <type> <index> <count>
638               <timestamp> <expiredate> <flags>
639         This is one long line issued for each attribute subpacket when
640         an attribute packet is seen during key listing.  <fpr> is the
641         fingerprint of the key. <octets> is the length of the
642         attribute subpacket. <type> is the attribute type
643         (1==image). <index>/<count> indicates that this is the Nth
644         indexed subpacket of count total subpackets in this attribute
645         packet.  <timestamp> and <expiredate> are from the
646         self-signature on the attribute packet.  If the attribute
647         packet does not have a valid self-signature, then the
648         timestamp is 0.  <flags> are a bitwise OR of:
649                 0x01 = this attribute packet is a primary uid
650                 0x02 = this attribute packet is revoked
651                 0x04 = this attribute packet is expired
652
653     CARDCTRL <what> [<serialno>]
654         This is used to control smartcard operations.
655         Defined values for WHAT are:
656            1 = Request insertion of a card.  Serialnumber may be given
657                to request a specific card.  Used by gpg 1.4 w/o scdaemon.
658            2 = Request removal of a card.  Used by gpg 1.4 w/o scdaemon.
659            3 = Card with serialnumber detected
660            4 = No card available.
661            5 = No card reader available
662            6 = No card support available
663
664     PLAINTEXT <format> <timestamp> <filename>
665         This indicates the format of the plaintext that is about to be
666         written.  The format is a 1 byte hex code that shows the
667         format of the plaintext: 62 ('b') is binary data, 74 ('t') is
668         text data with no character set specified, and 75 ('u') is
669         text data encoded in the UTF-8 character set.  The timestamp
670         is in seconds since the epoch.  If a filename is available it
671         gets printed as the third argument, percent-escaped as usual.
672
673     PLAINTEXT_LENGTH <length>
674         This indicates the length of the plaintext that is about to be
675         written.  Note that if the plaintext packet has partial length
676         encoding it is not possible to know the length ahead of time.
677         In that case, this status tag does not appear.
678
679     SIG_SUBPACKET <type> <flags> <len> <data>
680         This indicates that a signature subpacket was seen.  The
681         format is the same as the "spk" record above.
682
683     SC_OP_FAILURE [<code>]
684         An operation on a smartcard definitely failed.  Currently
685         there is no indication of the actual error code, but
686         application should be prepared to later accept more arguments.
687         Defined values for CODE are:
688            0 - unspecified error (identically to a missing CODE)
689            1 - canceled
690            2 - bad PIN
691
692     SC_OP_SUCCESS
693         A smart card operaion succeeded.  This status is only printed
694         for certain operation and is mostly useful to check whether a
695         PIN change really worked.
696
697     BACKUP_KEY_CREATED fingerprint fname
698         A backup key named FNAME has been created for the key with
699         KEYID.
700
701     MOUNTPOINT <name>
702         NAME is a percent-plus escaped filename describing the
703         mountpoint for the current operation (e.g. g13 --mount).  This
704         may either be the specified mountpoint or one randomly choosen
705         by g13.
706
707     PINENTRY_LAUNCHED <pid>
708
709         This status line is emitted by gpg to notify a client that a
710         Pinentry has been launched.  <pid> is the PID of the Pinentry.
711         It may be used to display a hint to the user but can't be used
712         to synchronize with Pinentry.  Note that there is also an
713         Assuan inquiry line with the same name used internally or, if
714         enabled, send to the client instead of this status line.  Such
715         an inquiry may be used to sync with Pinentry
716
717 Status lines which are not anymore used:
718
719     SIGEXPIRED removed on 2011-02-04.
720         This is deprecated in favor of KEYEXPIRED.
721
722
723
724
725 Format of the "--attribute-fd" output
726 =====================================
727
728 When --attribute-fd is set, during key listings (--list-keys,
729 --list-secret-keys) GnuPG dumps each attribute packet to the file
730 descriptor specified.  --attribute-fd is intended for use with
731 --status-fd as part of the required information is carried on the
732 ATTRIBUTE status tag (see above).
733
734 The contents of the attribute data is specified by RFC 4880.  For
735 convenience, here is the Photo ID format, as it is currently the only
736 attribute defined:
737
738    Byte 0-1:  The length of the image header.  Due to a historical
739               accident (i.e. oops!) back in the NAI PGP days, this is
740               a little-endian number.  Currently 16 (0x10 0x00).
741
742    Byte 2:    The image header version.  Currently 0x01.
743
744    Byte 3:    Encoding format.  0x01 == JPEG.
745
746    Byte 4-15: Reserved, and currently unused.
747
748    All other data after this header is raw image (JPEG) data.
749
750
751 Format of the "--list-config" output
752 ====================================
753
754 --list-config outputs information about the GnuPG configuration for
755 the benefit of frontends or other programs that call GnuPG.  There are
756 several list-config items, all colon delimited like the rest of the
757 --with-colons output.  The first field is always "cfg" to indicate
758 configuration information.  The second field is one of (with
759 examples):
760
761 version: the third field contains the version of GnuPG.
762
763    cfg:version:1.3.5
764
765 pubkey: the third field contains the public key algorithmdcaiphers
766         this version of GnuPG supports, separated by semicolons.  The
767         algorithm numbers are as specified in RFC-4880.  Note that in
768         contrast to the --status-fd interface these are _not_ the
769         Libgcrypt identifiers.
770
771    cfg:pubkey:1;2;3;16;17
772
773 cipher: the third field contains the symmetric ciphers this version of
774         GnuPG supports, separated by semicolons.  The cipher numbers
775         are as specified in RFC-4880.
776
777    cfg:cipher:2;3;4;7;8;9;10
778
779 digest: the third field contains the digest (hash) algorithms this
780         version of GnuPG supports, separated by semicolons.  The
781         digest numbers are as specified in RFC-4880.
782
783    cfg:digest:1;2;3;8;9;10
784
785 compress: the third field contains the compression algorithms this
786           version of GnuPG supports, separated by semicolons.  The
787           algorithm numbers are as specified in RFC-4880.
788
789    cfg:compress:0;1;2;3
790
791 group: the third field contains the name of the group, and the fourth
792        field contains the values that the group expands to, separated
793        by semicolons.
794
795 For example, a group of:
796    group mynames = paige 0x12345678 joe patti
797
798 would result in:
799    cfg:group:mynames:patti;joe;0x12345678;paige
800
801
802 Key generation
803 ==============
804 See the Libcrypt manual.
805
806
807 Unattended key generation
808 =========================
809 The the manual for a description.
810
811
812 Layout of the TrustDB
813 =====================
814 The TrustDB is built from fixed length records, where the first byte
815 describes the record type.  All numeric values are stored in network
816 byte order. The length of each record is 40 bytes. The first record of
817 the DB is always of type 1 and this is the only record of this type.
818
819 FIXME:  The layout changed, document it here.
820
821   Record type 0:
822   --------------
823     Unused record, can be reused for any purpose.
824
825   Record type 1:
826   --------------
827     Version information for this TrustDB.  This is always the first
828     record of the DB and the only one with type 1.
829      1 byte value 1
830      3 bytes 'gpg'  magic value
831      1 byte Version of the TrustDB (2)
832      1 byte marginals needed
833      1 byte completes needed
834      1 byte max_cert_depth
835             The three items are used to check whether the cached
836             validity value from the dir record can be used.
837      1 u32  locked flags [not used]
838      1 u32  timestamp of trustdb creation
839      1 u32  timestamp of last modification which may affect the validity
840             of keys in the trustdb.  This value is checked against the
841             validity timestamp in the dir records.
842      1 u32  timestamp of last validation [currently not used]
843             (Used to keep track of the time, when this TrustDB was checked
844              against the pubring)
845      1 u32  record number of keyhashtable [currently not used]
846      1 u32  first free record
847      1 u32  record number of shadow directory hash table [currently not used]
848             It does not make sense to combine this table with the key table
849             because the keyid is not in every case a part of the fingerprint.
850      1 u32  record number of the trusthashtbale
851
852
853   Record type 2: (directory record)
854   --------------
855     Informations about a public key certificate.
856     These are static values which are never changed without user interaction.
857
858      1 byte value 2
859      1 byte  reserved
860      1 u32   LID     .  (This is simply the record number of this record.)
861      1 u32   List of key-records (the first one is the primary key)
862      1 u32   List of uid-records
863      1 u32   cache record
864      1 byte  ownertrust
865      1 byte  dirflag
866      1 byte  maximum validity of all the user ids
867      1 u32   time of last validity check.
868      1 u32   Must check when this time has been reached.
869              (0 = no check required)
870
871
872   Record type 3:  (key record)
873   --------------
874     Informations about a primary public key.
875     (This is mainly used to lookup a trust record)
876
877      1 byte value 3
878      1 byte  reserved
879      1 u32   LID
880      1 u32   next   - next key record
881      7 bytes reserved
882      1 byte  keyflags
883      1 byte  pubkey algorithm
884      1 byte  length of the fingerprint (in bytes)
885      20 bytes fingerprint of the public key
886               (This is the value we use to identify a key)
887
888   Record type 4: (uid record)
889   --------------
890     Informations about a userid
891     We do not store the userid but the hash value of the userid because that
892     is sufficient.
893
894      1 byte value 4
895      1 byte reserved
896      1 u32  LID  points to the directory record.
897      1 u32  next   next userid
898      1 u32  pointer to preference record
899      1 u32  siglist  list of valid signatures
900      1 byte uidflags
901      1 byte validity of the key calculated over this user id
902      20 bytes ripemd160 hash of the username.
903
904
905   Record type 5: (pref record)
906   --------------
907     This record type is not anymore used.
908
909      1 byte value 5
910      1 byte   reserved
911      1 u32  LID; points to the directory record (and not to the uid record!).
912             (or 0 for standard preference record)
913      1 u32  next
914      30 byte preference data
915
916   Record type 6  (sigrec)
917   -------------
918     Used to keep track of key signatures. Self-signatures are not
919     stored.  If a public key is not in the DB, the signature points to
920     a shadow dir record, which in turn has a list of records which
921     might be interested in this key (and the signature record here
922     is one).
923
924      1 byte   value 6
925      1 byte   reserved
926      1 u32    LID           points back to the dir record
927      1 u32    next   next sigrec of this uid or 0 to indicate the
928                      last sigrec.
929      6 times
930         1 u32  Local_id of signatures dir or shadow dir record
931         1 byte Flag: Bit 0 = checked: Bit 1 is valid (we have a real
932                              directory record for this)
933                          1 = valid is set (but may be revoked)
934
935
936
937   Record type 8: (shadow directory record)
938   --------------
939     This record is used to reserve a LID for a public key.  We
940     need this to create the sig records of other keys, even if we
941     do not yet have the public key of the signature.
942     This record (the record number to be more precise) will be reused
943     as the dir record when we import the real public key.
944
945      1 byte value 8
946      1 byte  reserved
947      1 u32   LID      (This is simply the record number of this record.)
948      2 u32   keyid
949      1 byte  pubkey algorithm
950      3 byte reserved
951      1 u32   hintlist   A list of records which have references to
952                         this key.  This is used for fast access to
953                         signature records which are not yet checked.
954                         Note, that this is only a hint and the actual records
955                         may not anymore hold signature records for that key
956                         but that the code cares about this.
957     18 byte reserved
958
959
960
961   Record Type 10 (hash table)
962   --------------
963     Due to the fact that we use fingerprints to lookup keys, we can
964     implement quick access by some simple hash methods, and avoid
965     the overhead of gdbm.  A property of fingerprints is that they can be
966     used directly as hash values.  (They can be considered as strong
967     random numbers.)
968       What we use is a dynamic multilevel architecture, which combines
969     hashtables, record lists, and linked lists.
970
971     This record is a hashtable of 256 entries; a special property
972     is that all these records are stored consecutively to make one
973     big table. The hash value is simple the 1st, 2nd, ... byte of
974     the fingerprint (depending on the indirection level).
975
976     When used to hash shadow directory records, a different table is used
977     and indexed by the keyid.
978
979      1 byte value 10
980      1 byte reserved
981      n u32  recnum; n depends on the record length:
982             n = (reclen-2)/4  which yields 9 for the current record length
983             of 40 bytes.
984
985     the total number of such record which makes up the table is:
986          m = (256+n-1) / n
987     which is 29 for a record length of 40.
988
989     To look up a key we use the first byte of the fingerprint to get
990     the recnum from this hashtable and look up the addressed record:
991        - If this record is another hashtable, we use 2nd byte
992          to index this hash table and so on.
993        - if this record is a hashlist, we walk all entries
994          until we found one a matching one.
995        - if this record is a key record, we compare the
996          fingerprint and to decide whether it is the requested key;
997
998
999   Record type 11 (hash list)
1000   --------------
1001     see hash table for an explanation.
1002     This is also used for other purposes.
1003
1004     1 byte value 11
1005     1 byte reserved
1006     1 u32  next          next hash list record
1007     n times              n = (reclen-5)/5
1008         1 u32  recnum
1009
1010     For the current record length of 40, n is 7
1011
1012
1013
1014   Record type 254 (free record)
1015   ---------------
1016     All these records form a linked list of unused records.
1017      1 byte  value 254
1018      1 byte  reserved (0)
1019      1 u32   next_free
1020
1021
1022
1023 GNU extensions to the S2K algorithm
1024 ===================================
1025 S2K mode 101 is used to identify these extensions.
1026 After the hash algorithm the 3 bytes "GNU" are used to make
1027 clear that these are extensions for GNU, the next bytes gives the
1028 GNU protection mode - 1000.  Defined modes are:
1029   1001 - do not store the secret part at all
1030   1002 - a stub to access smartcards (not used in 1.2.x)
1031
1032
1033
1034 Other Notes
1035 ===========
1036     * For packet version 3 we calculate the keyids this way:
1037         RSA     := low 64 bits of n
1038         ELGAMAL := build a v3 pubkey packet (with CTB 0x99) and calculate
1039                    a rmd160 hash value from it. This is used as the
1040                    fingerprint and the low 64 bits are the keyid.
1041
1042     * Revocation certificates consist only of the signature packet;
1043       "import" knows how to handle this.  The rationale behind it is
1044       to keep them small.
1045
1046
1047 OIDs below the GnuPG arc:
1048 =========================
1049
1050  1.3.6.1.4.1.11591.2          GnuPG
1051  1.3.6.1.4.1.11591.2.1          notation
1052  1.3.6.1.4.1.11591.2.1.1          pkaAddress
1053  1.3.6.1.4.1.11591.2.2          X.509 extensions
1054  1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
1055  1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
1056  1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
1057
1058
1059
1060 Keyserver Message Format
1061 =========================
1062
1063 The keyserver may be contacted by a Unix Domain socket or via TCP.
1064
1065 The format of a request is:
1066
1067 ====
1068 command-tag
1069 "Content-length:" digits
1070 CRLF
1071 =======
1072
1073 Where command-tag is
1074
1075 NOOP
1076 GET <user-name>
1077 PUT
1078 DELETE <user-name>
1079
1080
1081 The format of a response is:
1082
1083 ======
1084 "GNUPG/1.0" status-code status-text
1085 "Content-length:" digits
1086 CRLF
1087 ============
1088 followed by <digits> bytes of data
1089
1090
1091 Status codes are:
1092
1093      o  1xx: Informational - Request received, continuing process
1094
1095      o  2xx: Success - The action was successfully received, understood,
1096         and accepted
1097
1098      o  4xx: Client Error - The request contains bad syntax or cannot be
1099         fulfilled
1100
1101      o  5xx: Server Error - The server failed to fulfill an apparently
1102         valid request
1103
1104
1105
1106 Documentation on HKP (the http keyserver protocol):
1107
1108 A minimalistic HTTP server on port 11371 recognizes a GET for /pks/lookup.
1109 The standard http URL encoded query parameters are this (always key=value):
1110
1111 - op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
1112   pgp -kxa)
1113
1114 - search=<stringlist>. This is a list of words that must occur in the key.
1115   The words are delimited with space, points, @ and so on. The delimiters
1116   are not searched for and the order of the words doesn't matter (but see
1117   next option).
1118
1119 - exact=on. This switch tells the hkp server to only report exact matching
1120   keys back. In this case the order and the "delimiters" are important.
1121
1122 - fingerprint=on. Also reports the fingerprints when used with 'index' or
1123   'vindex'
1124
1125 The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
1126 keys.
1127
1128
1129 A better way to do this would be a request like:
1130
1131    /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
1132
1133 This can be implemented using Hurd's translator mechanism.
1134 However, I think the whole key server stuff has to be re-thought;
1135 I have some ideas and probably create a white paper.