Actually show translators comments in PO files
[gnupg.git] / agent / keyformat.txt
1 keyformat.txt (wk 2001-12-18)
2 -----------------------------
3
4
5 Some notes on the format of the secret keys used with gpg-agent.
6
7 Location of keys
8 ================
9 The secret keys[1] are stored on a per file basis in a directory below
10 the ~/.gnupg home directory.  This directory is named
11
12    private-keys-v1.d
13
14 and should have permissions 700.
15
16 The secret keys are stored in files with a name matching the
17 hexadecimal representation of the keygrip[2] and suffixed with ".key".
18
19
20 Unprotected Private Key Format
21 ==============================
22 The content of the file is an S-Expression like the ones used with
23 Libgcrypt.  Here is an example of an unprotected file:
24
25 (private-key
26  (rsa
27   (n #00e0ce9..[some bytes not shown]..51#)
28   (e #010001#)
29   (d #046129F..[some bytes not shown]..81#)
30   (p #00e861b..[some bytes not shown]..f1#)
31   (q #00f7a7c..[some bytes not shown]..61#)
32   (u #304559a..[some bytes not shown]..9b#)
33  )
34  (created-at timestamp)
35  (uri http://foo.bar x-foo:whatever_you_want)
36  (comment whatever)
37 )
38
39 "comment", "created-at" and "uri" are optional.  "comment" is
40 currently used to keep track of ssh key comments. "created-at" is used
41 to keep track of the creation time stamp used with OpenPGP keys; it is
42 optional but required for some operations to calculate the fingerprint
43 of the key.  This timestamp should be a string with the number of
44 seconds since Epoch or an ISO time string (yyyymmddThhmmss).
45
46 Actually this form should not be used for regular purposes and only
47 accepted by gpg-agent with the configuration option:
48 --allow-non-canonical-key-format.  The regular way to represent the
49 keys is in canonical representation[3]:
50
51 (private-key
52    (rsa
53     (n #00e0ce9..[some bytes not shown]..51#)
54     (e #010001#)
55     (d #046129F..[some bytes not shown]..81#)
56     (p #00e861b..[some bytes not shown]..f1#)
57     (q #00f7a7c..[some bytes not shown]..61#)
58     (u #304559a..[some bytes not shown]..9b#)
59    )
60    (uri http://foo.bar x-foo:whatever_you_want)
61 )
62
63
64 Protected Private Key Format
65 ==============================
66 A protected key is like this:
67
68 (protected-private-key
69    (rsa
70     (n #00e0ce9..[some bytes not shown]..51#)
71     (e #010001#)
72     (protected mode (parms) encrypted_octet_string)
73     (protected-at <isotimestamp>)
74    )
75    (uri http://foo.bar x-foo:whatever_you_want)
76    (comment whatever)
77 )
78
79
80 In this scheme the encrypted_octet_string is encrypted according to
81 the algorithm described after the keyword protected; most protection
82 algorithms need some parameters, which are given in a list before the
83 encrypted_octet_string.  The result of the decryption process is a
84 list of the secret key parameters.  The protected-at expression is
85 optional; the isotimestamp is 15 bytes long (e.g. "19610711T172000").
86
87 The only available protection mode for now is
88
89   openpgp-s2k3-sha1-aes-cbc
90
91 which describes an algorithm using using AES in CBC mode for
92 encryption, SHA-1 for integrity protection and the String to Key
93 algorithm 3 from OpenPGP (rfc2440).
94
95 Example:
96
97 (protected openpgp-s2k3-sha1-aes-cbc
98   ((sha1 16byte_salt no_of_iterations) 16byte_iv)
99   encrypted_octet_string
100 )
101
102 The encrypted_octet string should yield this S-Exp (in canonical
103 representation) after decryption:
104
105 (
106  (
107   (d #046129F..[some bytes not shown]..81#)
108   (p #00e861b..[some bytes not shown]..f1#)
109   (q #00f7a7c..[some bytes not shown]..61#)
110   (u #304559a..[some bytes not shown]..9b#)
111  )
112  (hash sha1 #...[hashvalue]...#)
113 )
114
115 For padding reasons, random bytes are appended to this list - they can
116 easily be stripped by looking for the end of the list.
117
118 The hash is calculated on the concatenation of the public key and
119 secret key parameter lists: i.e it is required to hash the
120 concatenation of these 6 canonical encoded lists for RSA, including
121 the parenthesis, the algorithm keyword and (if used) the protected-at
122 list.
123
124 (rsa
125  (n #00e0ce9..[some bytes not shown]..51#)
126  (e #010001#)
127  (d #046129F..[some bytes not shown]..81#)
128  (p #00e861b..[some bytes not shown]..f1#)
129  (q #00f7a7c..[some bytes not shown]..61#)
130  (u #304559a..[some bytes not shown]..9b#)
131  (protected-at "18950523T000000")
132 )
133
134 After decryption the hash must be recalculated and compared against
135 the stored one - If they don't match the integrity of the key is not
136 given.
137
138
139 Shadowed Private Key Format
140 ============================
141 To keep track of keys stored on IC cards we use a third format for
142 private kyes which are called shadow keys as they are only a reference
143 to keys stored on a token:
144
145 (shadowed-private-key
146    (rsa
147     (n #00e0ce9..[some bytes not shown]..51#)
148     (e #010001#)
149     (shadowed protocol (info))
150    )
151    (uri http://foo.bar x-foo:whatever_you_want)
152    (comment whatever)
153 )
154
155 The currently used protocol is "ti-v1" (token info version 1).  The
156 second list with the information has this layout:
157
158 (card_serial_number id_string_of_key fixed_pin_length)
159
160 FIXED_PIN_LENGTH is optional.  It can be used to store the length of
161 the PIN; a value of 0 indicates that this information is not
162 available.  The rationale for this field is that some pinpad equipped
163 readers don't allow passing a variable length PIN.
164
165 More items may be added to the list.
166
167
168 OpenPGP Private Key Transfer Format
169 ===================================
170
171 This format is used to transfer keys between gpg and gpg-agent.
172
173 (openpgp-private-key
174   (version V)
175   (algo PUBKEYALGO)
176   (skey _ P1 _ P2 _ P3 ... e PN)
177   (csum n)
178   (protection PROTTYPE PROTALGO IV S2KMODE S2KHASH S2KSALT S2KCOUNT))
179
180
181 * V is the packet version number (3 or 4).
182 * PUBKEYALGO is a Libgcrypt algo name
183 * P1 .. PN are the parameters; the public parameters are never encrypted
184   the secrect key parameters are encrypted if the "protection" list is
185   given.  To make this more explicit each parameter is preceded by a
186   flag "_" for cleartext or "e" for encrypted text.
187 * CSUM is the depreciated 16 bit checksum as defined by OpenPGP.  This
188   is an optional element.
189 * If PROTTYPE is "sha1" the new style SHA1 checksum is used if it is "sum"
190   the old 16 bit checksum (above) is used and if it is "none" no
191   protection at all is used.
192 * PROTALGO is a Libgcrypt style cipher algorithm name
193 * IV is the initialization verctor.
194 * S2KMODE is the value from RFC-4880.
195 * S2KHASH is a a libgcrypt style hash algorithm identifier.
196 * S2KSALT is the 8 byte salt
197 * S2KCOUNT is the count value from RFC-4880.
198
199
200 Persistent Passphrase Format
201 ============================
202
203 To allow persistent storage of cached passphrases we use a scheme
204 similar to the private-key storage format.  This is a master
205 passphrase format where each file may protect several secrets under
206 one master passphrase.  It is possible to have several of those files
207 each protected by a dedicated master passphrase.  Clear text keywords
208 allow to list the available protected passphrases.
209
210 The name of the files with these protected secrets have this form:
211 pw-<string>.dat.  STRING may be an arbitrary string, as a default name
212 for the passphrase storage the name "pw-default.dat" is suggested.
213
214
215 (protected-shared-secret
216    ((desc descriptive_text)
217     (key [key_1] (keyword_1 keyword_2 keyword_n))
218     (key [key_2] (keyword_21 keyword_22 keyword_2n))
219     (key [key_n] (keyword_n1 keyword_n2 keyword_nn))
220     (protected mode (parms) encrypted_octet_string)
221     (protected-at <isotimestamp>)
222    )
223 )
224
225 After decryption the encrypted_octet_string yields this S-expression:
226
227 (
228  (
229   (value key_1 value_1)
230   (value key_2 value_2)
231   (value key_n value_n)
232  )
233  (hash sha1 #...[hashvalue]...#)
234 )
235
236 The "descriptive_text" is displayed with the prompt to enter the
237 unprotection passphrase.
238
239 KEY_1 to KEY_N are unique identifiers for the shared secret, for
240 example an URI.  In case this information should be kept confidential
241 as well, they may not appear in the unprotected part; however they are
242 mandatory in the encrypted_octet_string.  The list of keywords is
243 optional.  The oder of the "key" lists and the order of the "value"
244 lists mut match, that is the first "key"-list is associated with the
245 first "value" list in the encrypted_octet_string.
246
247 The protection mode etc. is indentical to the protection mode as
248 decribed for the private key format.
249
250 list of the secret key parameters.  The protected-at expression is
251 optional; the isotimestamp is 15 bytes long (e.g. "19610711T172000").
252
253 The "hash" in the encrypted_octet_string is calculated on the
254 concatenation of the key list and value lists: i.e it is required to
255 hash the concatenation of all these lists, including the
256 parenthesis and (if used) the protected-at list.
257
258 Example:
259
260 (protected-shared-secret
261    ((desc "List of system passphrases")
262     (key "uid-1002" ("Knuth" "Donald Ervin Knuth"))
263     (key "uid-1001" ("Dijkstra" "Edsgar Wybe Dijkstra"))
264     (key)
265     (protected mode (parms) encrypted_octet_string)
266     (protected-at "20100915T111722")
267    )
268 )
269
270 with "encrypted_octet_string" decoding to:
271
272 (
273  (
274   (value 4:1002 "signal flags at the lock")
275   (value 4:1001 "taocp")
276   (value 1:0    "premature optimization is the root of all evil")
277  )
278  (hash sha1 #0102030405060708091011121314151617181920#)
279 )
280
281 To compute the hash this S-expression (in canoncical format) was
282 hashed:
283
284    ((desc "List of system passphrases")
285     (key "uid-1002" ("Knuth" "Donald Ervin Knuth"))
286     (key "uid-1001" ("Dijkstra" "Edsgar Wybe Dijkstra"))
287     (key)
288     (value 4:1002 "signal flags at the lock")
289     (value 4:1001 "taocp")
290     (value 1:0    "premature optimization is the root of all evil")
291     (protected-at "20100915T111722")
292    )
293
294
295
296
297
298
299
300 Notes:
301 ======
302 [1] I usually use the terms private and secret key exchangeable but prefer the
303 term secret key because it can be visually be better distinguished
304 from the term public key.
305
306 [2] The keygrip is a unique identifier for a key pair, it is
307 independent of any protocol, so that the same key can be used with
308 different protocols.  PKCS-15 calls this a subjectKeyHash; it can be
309 calculated using Libgcrypt's gcry_pk_get_keygrip ().
310
311 [3] Even when canonical representation are required we will show the
312 S-expression here in a more readable representation.