Give hints on files to backup.
[gnupg.git] / doc / KEYSERVER
1 Format of keyserver colon listings
2 ==================================
3
4 David Shaw <dshaw@jabberwocky.com>
5
6 The machine readable response begins with an optional information
7 line:
8
9 info:<version>:<count>
10
11 <version> = this is the version of this protocol.  Currently, this is
12             the number 1.
13
14 <count> = the number of keys returned in this response.  Note this is
15           the number of keys, and not the number of lines returned.
16           It should match the number of "pub:" lines returned.
17
18 If this optional line is not included, or the version information is
19 not supplied, the version number is assumed to be 1.
20
21 The key listings are made up of several lines per key.  The first line
22 is for the primary key:
23
24 pub:<fingerprint>:<algo>:<keylen>:<creationdate>:<expirationdate>:<flags>
25
26 <fingerprint> = this is either the fingerprint or the keyid of the
27                 key.  Either the 16-digit or 8-digit keyids are
28                 acceptable, but obviously the fingerprint is best.
29                 Since it is not possible to calculate the keyid from a
30                 V3 key fingerprint, for V3 keys this should be either
31                 the 16-digit or 8-digit keyid only.
32
33 <algo> = the algorithm number from RFC-2440.  (i.e. 1==RSA, 17==DSA,
34          etc).
35
36 <keylen> = the key length (i.e. 1024, 2048, 4096, etc.)
37
38 <creationdate> = creation date of the key in standard RFC-2440 form
39                  (i.e. number of seconds since 1/1/1970 UTC time)
40
41 <expirationdate> = expiration date of the key in standard RFC-2440
42                  form (i.e. number of seconds since 1/1/1970 UTC time)
43
44 <flags> = letter codes to indicate details of the key, if any.  Flags
45           may be in any order.
46
47           r == revoked
48           d == disabled
49           e == expired
50
51 Following the "pub" line are one or more "uid" lines to indicate user
52 IDs on the key:
53
54 uid:<escaped uid string>:<creationdate>:<expirationdate>:<flags>
55
56 <escaped uid string> == the user ID string, with HTTP %-escaping for
57                         anything that isn't 7-bit safe as well as for
58                         the ":" character.  Any other characters may
59                         be escaped, as desired.
60
61 creationdate, expirationdate, and flags mean the same here as before.
62 The information is taken from the self-sig, if any, and applies to the
63 user ID in question, and not to the key as a whole.
64
65 Details:
66
67 * All characters except for the <escaped uid string> are
68   case-insensitive.
69
70 * Obviously, on a keyserver without integrated crypto, many of the
71   items given here are not fully trustworthy until the key is
72   downloaded and signatures checked.  For example, the information
73   that a key is flagged "r" for revoked should be treated as
74   untrustworthy information until the key is checked on the client
75   side.
76
77 * Empty fields are allowed.  For example, a key with no expiration
78   date would have the <expirationdate> field empty.  Also, a keyserver
79   that does not track a particular piece of information may leave that
80   field empty as well.  I expect that the creation and expiration
81   dates for user IDs will be left empty in current keyservers.  Colons
82   for empty fields on the end of each line may be left off, if
83   desired.