]>
Commit | Line | Data |
---|---|---|
b5256303 TC |
1 | /* |
2 | * CDDL HEADER START | |
3 | * | |
4 | * This file and its contents are supplied under the terms of the | |
5 | * Common Development and Distribution License ("CDDL"), version 1.0. | |
6 | * You may only use this file in accordance with the terms of version | |
7 | * 1.0 of the CDDL. | |
8 | * | |
9 | * A full copy of the text of the CDDL should have accompanied this | |
10 | * source. A copy of the CDDL is also available via the Internet at | |
11 | * http://www.illumos.org/license/CDDL. | |
12 | * | |
13 | * CDDL HEADER END | |
14 | */ | |
15 | ||
16 | /* | |
17 | * Copyright (c) 2017, Datto, Inc. All rights reserved. | |
d52d80b7 | 18 | * Copyright (c) 2018 by Delphix. All rights reserved. |
b5256303 TC |
19 | */ |
20 | ||
21 | #include <sys/dsl_crypt.h> | |
22 | #include <sys/dsl_pool.h> | |
23 | #include <sys/zap.h> | |
24 | #include <sys/zil.h> | |
25 | #include <sys/dsl_dir.h> | |
26 | #include <sys/dsl_prop.h> | |
27 | #include <sys/spa_impl.h> | |
28 | #include <sys/dmu_objset.h> | |
29 | #include <sys/zvol.h> | |
30 | ||
31 | /* | |
32 | * This file's primary purpose is for managing master encryption keys in | |
33 | * memory and on disk. For more info on how these keys are used, see the | |
34 | * block comment in zio_crypt.c. | |
35 | * | |
36 | * All master keys are stored encrypted on disk in the form of the DSL | |
37 | * Crypto Key ZAP object. The binary key data in this object is always | |
38 | * randomly generated and is encrypted with the user's wrapping key. This | |
39 | * layer of indirection allows the user to change their key without | |
40 | * needing to re-encrypt the entire dataset. The ZAP also holds on to the | |
41 | * (non-encrypted) encryption algorithm identifier, IV, and MAC needed to | |
42 | * safely decrypt the master key. For more info on the user's key see the | |
43 | * block comment in libzfs_crypto.c | |
44 | * | |
45 | * In-memory encryption keys are managed through the spa_keystore. The | |
46 | * keystore consists of 3 AVL trees, which are as follows: | |
47 | * | |
48 | * The Wrapping Key Tree: | |
49 | * The wrapping key (wkey) tree stores the user's keys that are fed into the | |
50 | * kernel through 'zfs load-key' and related commands. Datasets inherit their | |
51 | * parent's wkey by default, so these structures are refcounted. The wrapping | |
52 | * keys remain in memory until they are explicitly unloaded (with | |
53 | * "zfs unload-key"). Unloading is only possible when no datasets are using | |
54 | * them (refcount=0). | |
55 | * | |
56 | * The DSL Crypto Key Tree: | |
57 | * The DSL Crypto Keys (DCK) are the in-memory representation of decrypted | |
58 | * master keys. They are used by the functions in zio_crypt.c to perform | |
59 | * encryption, decryption, and authentication. Snapshots and clones of a given | |
60 | * dataset will share a DSL Crypto Key, so they are also refcounted. Once the | |
61 | * refcount on a key hits zero, it is immediately zeroed out and freed. | |
62 | * | |
63 | * The Crypto Key Mapping Tree: | |
64 | * The zio layer needs to lookup master keys by their dataset object id. Since | |
65 | * the DSL Crypto Keys can belong to multiple datasets, we maintain a tree of | |
66 | * dsl_key_mapping_t's which essentially just map the dataset object id to its | |
67 | * appropriate DSL Crypto Key. The management for creating and destroying these | |
68 | * mappings hooks into the code for owning and disowning datasets. Usually, | |
69 | * there will only be one active dataset owner, but there are times | |
70 | * (particularly during dataset creation and destruction) when this may not be | |
71 | * true or the dataset may not be initialized enough to own. As a result, this | |
72 | * object is also refcounted. | |
73 | */ | |
74 | ||
f00ab3f2 TC |
75 | /* |
76 | * This tunable allows datasets to be raw received even if the stream does | |
77 | * not include IVset guids or if the guids don't match. This is used as part | |
78 | * of the resolution for ZPOOL_ERRATA_ZOL_8308_ENCRYPTION. | |
79 | */ | |
80 | int zfs_disable_ivset_guid_check = 0; | |
81 | ||
b5256303 TC |
82 | static void |
83 | dsl_wrapping_key_hold(dsl_wrapping_key_t *wkey, void *tag) | |
84 | { | |
c13060e4 | 85 | (void) zfs_refcount_add(&wkey->wk_refcnt, tag); |
b5256303 TC |
86 | } |
87 | ||
88 | static void | |
89 | dsl_wrapping_key_rele(dsl_wrapping_key_t *wkey, void *tag) | |
90 | { | |
424fd7c3 | 91 | (void) zfs_refcount_remove(&wkey->wk_refcnt, tag); |
b5256303 TC |
92 | } |
93 | ||
94 | static void | |
95 | dsl_wrapping_key_free(dsl_wrapping_key_t *wkey) | |
96 | { | |
424fd7c3 | 97 | ASSERT0(zfs_refcount_count(&wkey->wk_refcnt)); |
b5256303 TC |
98 | |
99 | if (wkey->wk_key.ck_data) { | |
100 | bzero(wkey->wk_key.ck_data, | |
4807c0ba | 101 | CRYPTO_BITS2BYTES(wkey->wk_key.ck_length)); |
b5256303 | 102 | kmem_free(wkey->wk_key.ck_data, |
4807c0ba | 103 | CRYPTO_BITS2BYTES(wkey->wk_key.ck_length)); |
b5256303 TC |
104 | } |
105 | ||
424fd7c3 | 106 | zfs_refcount_destroy(&wkey->wk_refcnt); |
b5256303 TC |
107 | kmem_free(wkey, sizeof (dsl_wrapping_key_t)); |
108 | } | |
109 | ||
110 | static int | |
111 | dsl_wrapping_key_create(uint8_t *wkeydata, zfs_keyformat_t keyformat, | |
112 | uint64_t salt, uint64_t iters, dsl_wrapping_key_t **wkey_out) | |
113 | { | |
114 | int ret; | |
115 | dsl_wrapping_key_t *wkey; | |
116 | ||
117 | /* allocate the wrapping key */ | |
118 | wkey = kmem_alloc(sizeof (dsl_wrapping_key_t), KM_SLEEP); | |
119 | if (!wkey) | |
120 | return (SET_ERROR(ENOMEM)); | |
121 | ||
122 | /* allocate and initialize the underlying crypto key */ | |
123 | wkey->wk_key.ck_data = kmem_alloc(WRAPPING_KEY_LEN, KM_SLEEP); | |
124 | if (!wkey->wk_key.ck_data) { | |
125 | ret = ENOMEM; | |
126 | goto error; | |
127 | } | |
128 | ||
129 | wkey->wk_key.ck_format = CRYPTO_KEY_RAW; | |
4807c0ba | 130 | wkey->wk_key.ck_length = CRYPTO_BYTES2BITS(WRAPPING_KEY_LEN); |
b5256303 TC |
131 | bcopy(wkeydata, wkey->wk_key.ck_data, WRAPPING_KEY_LEN); |
132 | ||
133 | /* initialize the rest of the struct */ | |
424fd7c3 | 134 | zfs_refcount_create(&wkey->wk_refcnt); |
b5256303 TC |
135 | wkey->wk_keyformat = keyformat; |
136 | wkey->wk_salt = salt; | |
137 | wkey->wk_iters = iters; | |
138 | ||
139 | *wkey_out = wkey; | |
140 | return (0); | |
141 | ||
142 | error: | |
143 | dsl_wrapping_key_free(wkey); | |
144 | ||
145 | *wkey_out = NULL; | |
146 | return (ret); | |
147 | } | |
148 | ||
149 | int | |
150 | dsl_crypto_params_create_nvlist(dcp_cmd_t cmd, nvlist_t *props, | |
151 | nvlist_t *crypto_args, dsl_crypto_params_t **dcp_out) | |
152 | { | |
153 | int ret; | |
154 | uint64_t crypt = ZIO_CRYPT_INHERIT; | |
155 | uint64_t keyformat = ZFS_KEYFORMAT_NONE; | |
156 | uint64_t salt = 0, iters = 0; | |
157 | dsl_crypto_params_t *dcp = NULL; | |
158 | dsl_wrapping_key_t *wkey = NULL; | |
159 | uint8_t *wkeydata = NULL; | |
160 | uint_t wkeydata_len = 0; | |
161 | char *keylocation = NULL; | |
162 | ||
163 | dcp = kmem_zalloc(sizeof (dsl_crypto_params_t), KM_SLEEP); | |
164 | if (!dcp) { | |
165 | ret = SET_ERROR(ENOMEM); | |
166 | goto error; | |
167 | } | |
168 | ||
169 | dcp->cp_cmd = cmd; | |
170 | ||
171 | /* get relevant arguments from the nvlists */ | |
172 | if (props != NULL) { | |
173 | (void) nvlist_lookup_uint64(props, | |
174 | zfs_prop_to_name(ZFS_PROP_ENCRYPTION), &crypt); | |
175 | (void) nvlist_lookup_uint64(props, | |
176 | zfs_prop_to_name(ZFS_PROP_KEYFORMAT), &keyformat); | |
177 | (void) nvlist_lookup_string(props, | |
178 | zfs_prop_to_name(ZFS_PROP_KEYLOCATION), &keylocation); | |
179 | (void) nvlist_lookup_uint64(props, | |
180 | zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), &salt); | |
181 | (void) nvlist_lookup_uint64(props, | |
182 | zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), &iters); | |
183 | ||
184 | dcp->cp_crypt = crypt; | |
185 | } | |
186 | ||
187 | if (crypto_args != NULL) { | |
188 | (void) nvlist_lookup_uint8_array(crypto_args, "wkeydata", | |
189 | &wkeydata, &wkeydata_len); | |
190 | } | |
191 | ||
192 | /* check for valid command */ | |
193 | if (dcp->cp_cmd >= DCP_CMD_MAX) { | |
194 | ret = SET_ERROR(EINVAL); | |
195 | goto error; | |
196 | } else { | |
197 | dcp->cp_cmd = cmd; | |
198 | } | |
199 | ||
200 | /* check for valid crypt */ | |
201 | if (dcp->cp_crypt >= ZIO_CRYPT_FUNCTIONS) { | |
202 | ret = SET_ERROR(EINVAL); | |
203 | goto error; | |
204 | } else { | |
205 | dcp->cp_crypt = crypt; | |
206 | } | |
207 | ||
208 | /* check for valid keyformat */ | |
209 | if (keyformat >= ZFS_KEYFORMAT_FORMATS) { | |
210 | ret = SET_ERROR(EINVAL); | |
211 | goto error; | |
212 | } | |
213 | ||
214 | /* check for a valid keylocation (of any kind) and copy it in */ | |
215 | if (keylocation != NULL) { | |
216 | if (!zfs_prop_valid_keylocation(keylocation, B_FALSE)) { | |
217 | ret = SET_ERROR(EINVAL); | |
218 | goto error; | |
219 | } | |
220 | ||
221 | dcp->cp_keylocation = spa_strdup(keylocation); | |
222 | } | |
223 | ||
224 | /* check wrapping key length, if given */ | |
225 | if (wkeydata != NULL && wkeydata_len != WRAPPING_KEY_LEN) { | |
226 | ret = SET_ERROR(EINVAL); | |
227 | goto error; | |
228 | } | |
229 | ||
e1cfd73f | 230 | /* if the user asked for the default crypt, determine that now */ |
b5256303 TC |
231 | if (dcp->cp_crypt == ZIO_CRYPT_ON) |
232 | dcp->cp_crypt = ZIO_CRYPT_ON_VALUE; | |
233 | ||
234 | /* create the wrapping key from the raw data */ | |
235 | if (wkeydata != NULL) { | |
236 | /* create the wrapping key with the verified parameters */ | |
237 | ret = dsl_wrapping_key_create(wkeydata, keyformat, salt, | |
238 | iters, &wkey); | |
239 | if (ret != 0) | |
240 | goto error; | |
241 | ||
242 | dcp->cp_wkey = wkey; | |
243 | } | |
244 | ||
245 | /* | |
246 | * Remove the encryption properties from the nvlist since they are not | |
247 | * maintained through the DSL. | |
248 | */ | |
249 | (void) nvlist_remove_all(props, zfs_prop_to_name(ZFS_PROP_ENCRYPTION)); | |
250 | (void) nvlist_remove_all(props, zfs_prop_to_name(ZFS_PROP_KEYFORMAT)); | |
251 | (void) nvlist_remove_all(props, zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT)); | |
252 | (void) nvlist_remove_all(props, | |
253 | zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS)); | |
254 | ||
255 | *dcp_out = dcp; | |
256 | ||
257 | return (0); | |
258 | ||
259 | error: | |
260 | if (wkey != NULL) | |
261 | dsl_wrapping_key_free(wkey); | |
262 | if (dcp != NULL) | |
263 | kmem_free(dcp, sizeof (dsl_crypto_params_t)); | |
264 | ||
265 | *dcp_out = NULL; | |
266 | return (ret); | |
267 | } | |
268 | ||
269 | void | |
270 | dsl_crypto_params_free(dsl_crypto_params_t *dcp, boolean_t unload) | |
271 | { | |
272 | if (dcp == NULL) | |
273 | return; | |
274 | ||
275 | if (dcp->cp_keylocation != NULL) | |
276 | spa_strfree(dcp->cp_keylocation); | |
277 | if (unload && dcp->cp_wkey != NULL) | |
278 | dsl_wrapping_key_free(dcp->cp_wkey); | |
279 | ||
280 | kmem_free(dcp, sizeof (dsl_crypto_params_t)); | |
281 | } | |
282 | ||
283 | static int | |
284 | spa_crypto_key_compare(const void *a, const void *b) | |
285 | { | |
286 | const dsl_crypto_key_t *dcka = a; | |
287 | const dsl_crypto_key_t *dckb = b; | |
288 | ||
289 | if (dcka->dck_obj < dckb->dck_obj) | |
290 | return (-1); | |
291 | if (dcka->dck_obj > dckb->dck_obj) | |
292 | return (1); | |
293 | return (0); | |
294 | } | |
295 | ||
296 | static int | |
297 | spa_key_mapping_compare(const void *a, const void *b) | |
298 | { | |
299 | const dsl_key_mapping_t *kma = a; | |
300 | const dsl_key_mapping_t *kmb = b; | |
301 | ||
302 | if (kma->km_dsobj < kmb->km_dsobj) | |
303 | return (-1); | |
304 | if (kma->km_dsobj > kmb->km_dsobj) | |
305 | return (1); | |
306 | return (0); | |
307 | } | |
308 | ||
309 | static int | |
310 | spa_wkey_compare(const void *a, const void *b) | |
311 | { | |
312 | const dsl_wrapping_key_t *wka = a; | |
313 | const dsl_wrapping_key_t *wkb = b; | |
314 | ||
315 | if (wka->wk_ddobj < wkb->wk_ddobj) | |
316 | return (-1); | |
317 | if (wka->wk_ddobj > wkb->wk_ddobj) | |
318 | return (1); | |
319 | return (0); | |
320 | } | |
321 | ||
322 | void | |
323 | spa_keystore_init(spa_keystore_t *sk) | |
324 | { | |
325 | rw_init(&sk->sk_dk_lock, NULL, RW_DEFAULT, NULL); | |
326 | rw_init(&sk->sk_km_lock, NULL, RW_DEFAULT, NULL); | |
327 | rw_init(&sk->sk_wkeys_lock, NULL, RW_DEFAULT, NULL); | |
328 | avl_create(&sk->sk_dsl_keys, spa_crypto_key_compare, | |
329 | sizeof (dsl_crypto_key_t), | |
330 | offsetof(dsl_crypto_key_t, dck_avl_link)); | |
331 | avl_create(&sk->sk_key_mappings, spa_key_mapping_compare, | |
332 | sizeof (dsl_key_mapping_t), | |
333 | offsetof(dsl_key_mapping_t, km_avl_link)); | |
334 | avl_create(&sk->sk_wkeys, spa_wkey_compare, sizeof (dsl_wrapping_key_t), | |
335 | offsetof(dsl_wrapping_key_t, wk_avl_link)); | |
336 | } | |
337 | ||
338 | void | |
339 | spa_keystore_fini(spa_keystore_t *sk) | |
340 | { | |
341 | dsl_wrapping_key_t *wkey; | |
342 | void *cookie = NULL; | |
343 | ||
344 | ASSERT(avl_is_empty(&sk->sk_dsl_keys)); | |
345 | ASSERT(avl_is_empty(&sk->sk_key_mappings)); | |
346 | ||
347 | while ((wkey = avl_destroy_nodes(&sk->sk_wkeys, &cookie)) != NULL) | |
348 | dsl_wrapping_key_free(wkey); | |
349 | ||
350 | avl_destroy(&sk->sk_wkeys); | |
351 | avl_destroy(&sk->sk_key_mappings); | |
352 | avl_destroy(&sk->sk_dsl_keys); | |
353 | rw_destroy(&sk->sk_wkeys_lock); | |
354 | rw_destroy(&sk->sk_km_lock); | |
355 | rw_destroy(&sk->sk_dk_lock); | |
356 | } | |
357 | ||
ae76f45c | 358 | static int |
b5256303 TC |
359 | dsl_dir_get_encryption_root_ddobj(dsl_dir_t *dd, uint64_t *rddobj) |
360 | { | |
361 | if (dd->dd_crypto_obj == 0) | |
362 | return (SET_ERROR(ENOENT)); | |
363 | ||
364 | return (zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
365 | DSL_CRYPTO_KEY_ROOT_DDOBJ, 8, 1, rddobj)); | |
366 | } | |
367 | ||
ae76f45c TC |
368 | int |
369 | dsl_dir_get_encryption_version(dsl_dir_t *dd, uint64_t *version) | |
370 | { | |
371 | *version = 0; | |
372 | ||
373 | if (dd->dd_crypto_obj == 0) | |
374 | return (SET_ERROR(ENOENT)); | |
375 | ||
376 | /* version 0 is implied by ENOENT */ | |
377 | (void) zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
378 | DSL_CRYPTO_KEY_VERSION, 8, 1, version); | |
379 | ||
380 | return (0); | |
381 | } | |
382 | ||
383 | boolean_t | |
384 | dsl_dir_incompatible_encryption_version(dsl_dir_t *dd) | |
385 | { | |
386 | int ret; | |
387 | uint64_t version = 0; | |
388 | ||
389 | ret = dsl_dir_get_encryption_version(dd, &version); | |
390 | if (ret != 0) | |
391 | return (B_FALSE); | |
392 | ||
393 | return (version != ZIO_CRYPT_KEY_CURRENT_VERSION); | |
394 | } | |
395 | ||
b5256303 TC |
396 | static int |
397 | spa_keystore_wkey_hold_ddobj_impl(spa_t *spa, uint64_t ddobj, | |
398 | void *tag, dsl_wrapping_key_t **wkey_out) | |
399 | { | |
400 | int ret; | |
401 | dsl_wrapping_key_t search_wkey; | |
402 | dsl_wrapping_key_t *found_wkey; | |
403 | ||
404 | ASSERT(RW_LOCK_HELD(&spa->spa_keystore.sk_wkeys_lock)); | |
405 | ||
406 | /* init the search wrapping key */ | |
407 | search_wkey.wk_ddobj = ddobj; | |
408 | ||
409 | /* lookup the wrapping key */ | |
410 | found_wkey = avl_find(&spa->spa_keystore.sk_wkeys, &search_wkey, NULL); | |
411 | if (!found_wkey) { | |
412 | ret = SET_ERROR(ENOENT); | |
413 | goto error; | |
414 | } | |
415 | ||
416 | /* increment the refcount */ | |
417 | dsl_wrapping_key_hold(found_wkey, tag); | |
418 | ||
419 | *wkey_out = found_wkey; | |
420 | return (0); | |
421 | ||
422 | error: | |
423 | *wkey_out = NULL; | |
424 | return (ret); | |
425 | } | |
426 | ||
427 | static int | |
428 | spa_keystore_wkey_hold_dd(spa_t *spa, dsl_dir_t *dd, void *tag, | |
429 | dsl_wrapping_key_t **wkey_out) | |
430 | { | |
431 | int ret; | |
432 | dsl_wrapping_key_t *wkey; | |
433 | uint64_t rddobj; | |
434 | boolean_t locked = B_FALSE; | |
435 | ||
436 | if (!RW_WRITE_HELD(&spa->spa_keystore.sk_wkeys_lock)) { | |
437 | rw_enter(&spa->spa_keystore.sk_wkeys_lock, RW_READER); | |
438 | locked = B_TRUE; | |
439 | } | |
440 | ||
441 | /* get the ddobj that the keylocation property was inherited from */ | |
442 | ret = dsl_dir_get_encryption_root_ddobj(dd, &rddobj); | |
443 | if (ret != 0) | |
444 | goto error; | |
445 | ||
446 | /* lookup the wkey in the avl tree */ | |
447 | ret = spa_keystore_wkey_hold_ddobj_impl(spa, rddobj, tag, &wkey); | |
448 | if (ret != 0) | |
449 | goto error; | |
450 | ||
451 | /* unlock the wkey tree if we locked it */ | |
452 | if (locked) | |
453 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
454 | ||
455 | *wkey_out = wkey; | |
456 | return (0); | |
457 | ||
458 | error: | |
459 | if (locked) | |
460 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
461 | ||
462 | *wkey_out = NULL; | |
463 | return (ret); | |
464 | } | |
465 | ||
466 | int | |
467 | dsl_crypto_can_set_keylocation(const char *dsname, const char *keylocation) | |
468 | { | |
469 | int ret = 0; | |
470 | dsl_dir_t *dd = NULL; | |
471 | dsl_pool_t *dp = NULL; | |
b5256303 TC |
472 | uint64_t rddobj; |
473 | ||
474 | /* hold the dsl dir */ | |
475 | ret = dsl_pool_hold(dsname, FTAG, &dp); | |
476 | if (ret != 0) | |
477 | goto out; | |
478 | ||
479 | ret = dsl_dir_hold(dp, dsname, FTAG, &dd, NULL); | |
fc1ecd16 DB |
480 | if (ret != 0) { |
481 | dd = NULL; | |
b5256303 | 482 | goto out; |
fc1ecd16 | 483 | } |
b5256303 TC |
484 | |
485 | /* if dd is not encrypted, the value may only be "none" */ | |
486 | if (dd->dd_crypto_obj == 0) { | |
487 | if (strcmp(keylocation, "none") != 0) { | |
488 | ret = SET_ERROR(EACCES); | |
489 | goto out; | |
490 | } | |
491 | ||
492 | ret = 0; | |
493 | goto out; | |
494 | } | |
495 | ||
496 | /* check for a valid keylocation for encrypted datasets */ | |
497 | if (!zfs_prop_valid_keylocation(keylocation, B_TRUE)) { | |
498 | ret = SET_ERROR(EINVAL); | |
499 | goto out; | |
500 | } | |
501 | ||
502 | /* check that this is an encryption root */ | |
503 | ret = dsl_dir_get_encryption_root_ddobj(dd, &rddobj); | |
504 | if (ret != 0) | |
505 | goto out; | |
506 | ||
507 | if (rddobj != dd->dd_object) { | |
508 | ret = SET_ERROR(EACCES); | |
509 | goto out; | |
510 | } | |
511 | ||
b5256303 TC |
512 | dsl_dir_rele(dd, FTAG); |
513 | dsl_pool_rele(dp, FTAG); | |
514 | ||
515 | return (0); | |
516 | ||
517 | out: | |
b5256303 TC |
518 | if (dd != NULL) |
519 | dsl_dir_rele(dd, FTAG); | |
520 | if (dp != NULL) | |
521 | dsl_pool_rele(dp, FTAG); | |
522 | ||
523 | return (ret); | |
524 | } | |
525 | ||
526 | static void | |
527 | dsl_crypto_key_free(dsl_crypto_key_t *dck) | |
528 | { | |
424fd7c3 | 529 | ASSERT(zfs_refcount_count(&dck->dck_holds) == 0); |
b5256303 TC |
530 | |
531 | /* destroy the zio_crypt_key_t */ | |
532 | zio_crypt_key_destroy(&dck->dck_key); | |
533 | ||
534 | /* free the refcount, wrapping key, and lock */ | |
424fd7c3 | 535 | zfs_refcount_destroy(&dck->dck_holds); |
b5256303 TC |
536 | if (dck->dck_wkey) |
537 | dsl_wrapping_key_rele(dck->dck_wkey, dck); | |
538 | ||
539 | /* free the key */ | |
540 | kmem_free(dck, sizeof (dsl_crypto_key_t)); | |
541 | } | |
542 | ||
543 | static void | |
544 | dsl_crypto_key_rele(dsl_crypto_key_t *dck, void *tag) | |
545 | { | |
424fd7c3 | 546 | if (zfs_refcount_remove(&dck->dck_holds, tag) == 0) |
b5256303 TC |
547 | dsl_crypto_key_free(dck); |
548 | } | |
549 | ||
550 | static int | |
551 | dsl_crypto_key_open(objset_t *mos, dsl_wrapping_key_t *wkey, | |
552 | uint64_t dckobj, void *tag, dsl_crypto_key_t **dck_out) | |
553 | { | |
554 | int ret; | |
ae76f45c | 555 | uint64_t crypt = 0, guid = 0, version = 0; |
b5256303 TC |
556 | uint8_t raw_keydata[MASTER_KEY_MAX_LEN]; |
557 | uint8_t raw_hmac_keydata[SHA512_HMAC_KEYLEN]; | |
558 | uint8_t iv[WRAPPING_IV_LEN]; | |
559 | uint8_t mac[WRAPPING_MAC_LEN]; | |
560 | dsl_crypto_key_t *dck; | |
561 | ||
562 | /* allocate and initialize the key */ | |
563 | dck = kmem_zalloc(sizeof (dsl_crypto_key_t), KM_SLEEP); | |
564 | if (!dck) | |
565 | return (SET_ERROR(ENOMEM)); | |
566 | ||
567 | /* fetch all of the values we need from the ZAP */ | |
568 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_CRYPTO_SUITE, 8, 1, | |
569 | &crypt); | |
570 | if (ret != 0) | |
571 | goto error; | |
572 | ||
573 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_GUID, 8, 1, &guid); | |
574 | if (ret != 0) | |
575 | goto error; | |
576 | ||
577 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_MASTER_KEY, 1, | |
578 | MASTER_KEY_MAX_LEN, raw_keydata); | |
579 | if (ret != 0) | |
580 | goto error; | |
581 | ||
582 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_HMAC_KEY, 1, | |
583 | SHA512_HMAC_KEYLEN, raw_hmac_keydata); | |
584 | if (ret != 0) | |
585 | goto error; | |
586 | ||
587 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_IV, 1, WRAPPING_IV_LEN, | |
588 | iv); | |
589 | if (ret != 0) | |
590 | goto error; | |
591 | ||
592 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_MAC, 1, WRAPPING_MAC_LEN, | |
593 | mac); | |
594 | if (ret != 0) | |
595 | goto error; | |
596 | ||
ae76f45c TC |
597 | /* the initial on-disk format for encryption did not have a version */ |
598 | (void) zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_VERSION, 8, 1, &version); | |
599 | ||
b5256303 TC |
600 | /* |
601 | * Unwrap the keys. If there is an error return EACCES to indicate | |
602 | * an authentication failure. | |
603 | */ | |
10fa2545 BB |
604 | ret = zio_crypt_key_unwrap(&wkey->wk_key, crypt, version, guid, |
605 | raw_keydata, raw_hmac_keydata, iv, mac, &dck->dck_key); | |
b5256303 TC |
606 | if (ret != 0) { |
607 | ret = SET_ERROR(EACCES); | |
608 | goto error; | |
609 | } | |
610 | ||
611 | /* finish initializing the dsl_crypto_key_t */ | |
424fd7c3 | 612 | zfs_refcount_create(&dck->dck_holds); |
b5256303 TC |
613 | dsl_wrapping_key_hold(wkey, dck); |
614 | dck->dck_wkey = wkey; | |
615 | dck->dck_obj = dckobj; | |
c13060e4 | 616 | zfs_refcount_add(&dck->dck_holds, tag); |
b5256303 TC |
617 | |
618 | *dck_out = dck; | |
619 | return (0); | |
620 | ||
621 | error: | |
622 | if (dck != NULL) { | |
623 | bzero(dck, sizeof (dsl_crypto_key_t)); | |
624 | kmem_free(dck, sizeof (dsl_crypto_key_t)); | |
625 | } | |
626 | ||
627 | *dck_out = NULL; | |
628 | return (ret); | |
629 | } | |
630 | ||
631 | static int | |
632 | spa_keystore_dsl_key_hold_impl(spa_t *spa, uint64_t dckobj, void *tag, | |
633 | dsl_crypto_key_t **dck_out) | |
634 | { | |
635 | int ret; | |
636 | dsl_crypto_key_t search_dck; | |
637 | dsl_crypto_key_t *found_dck; | |
638 | ||
639 | ASSERT(RW_LOCK_HELD(&spa->spa_keystore.sk_dk_lock)); | |
640 | ||
641 | /* init the search key */ | |
642 | search_dck.dck_obj = dckobj; | |
643 | ||
644 | /* find the matching key in the keystore */ | |
645 | found_dck = avl_find(&spa->spa_keystore.sk_dsl_keys, &search_dck, NULL); | |
646 | if (!found_dck) { | |
647 | ret = SET_ERROR(ENOENT); | |
648 | goto error; | |
649 | } | |
650 | ||
651 | /* increment the refcount */ | |
c13060e4 | 652 | zfs_refcount_add(&found_dck->dck_holds, tag); |
b5256303 TC |
653 | |
654 | *dck_out = found_dck; | |
655 | return (0); | |
656 | ||
657 | error: | |
658 | *dck_out = NULL; | |
659 | return (ret); | |
660 | } | |
661 | ||
662 | static int | |
663 | spa_keystore_dsl_key_hold_dd(spa_t *spa, dsl_dir_t *dd, void *tag, | |
664 | dsl_crypto_key_t **dck_out) | |
665 | { | |
666 | int ret; | |
667 | avl_index_t where; | |
0d23f5e2 | 668 | dsl_crypto_key_t *dck_io = NULL, *dck_ks = NULL; |
b5256303 TC |
669 | dsl_wrapping_key_t *wkey = NULL; |
670 | uint64_t dckobj = dd->dd_crypto_obj; | |
671 | ||
0d23f5e2 BB |
672 | /* Lookup the key in the tree of currently loaded keys */ |
673 | rw_enter(&spa->spa_keystore.sk_dk_lock, RW_READER); | |
674 | ret = spa_keystore_dsl_key_hold_impl(spa, dckobj, tag, &dck_ks); | |
675 | rw_exit(&spa->spa_keystore.sk_dk_lock); | |
676 | if (ret == 0) { | |
677 | *dck_out = dck_ks; | |
b5256303 TC |
678 | return (0); |
679 | } | |
680 | ||
0d23f5e2 | 681 | /* Lookup the wrapping key from the keystore */ |
b5256303 TC |
682 | ret = spa_keystore_wkey_hold_dd(spa, dd, FTAG, &wkey); |
683 | if (ret != 0) { | |
0d23f5e2 BB |
684 | *dck_out = NULL; |
685 | return (SET_ERROR(EACCES)); | |
b5256303 TC |
686 | } |
687 | ||
0d23f5e2 | 688 | /* Read the key from disk */ |
b5256303 | 689 | ret = dsl_crypto_key_open(spa->spa_meta_objset, wkey, dckobj, |
0d23f5e2 BB |
690 | tag, &dck_io); |
691 | if (ret != 0) { | |
692 | dsl_wrapping_key_rele(wkey, FTAG); | |
693 | *dck_out = NULL; | |
694 | return (ret); | |
695 | } | |
b5256303 TC |
696 | |
697 | /* | |
0d23f5e2 BB |
698 | * Add the key to the keystore. It may already exist if it was |
699 | * added while performing the read from disk. In this case discard | |
700 | * it and return the key from the keystore. | |
b5256303 | 701 | */ |
0d23f5e2 BB |
702 | rw_enter(&spa->spa_keystore.sk_dk_lock, RW_WRITER); |
703 | ret = spa_keystore_dsl_key_hold_impl(spa, dckobj, tag, &dck_ks); | |
704 | if (ret != 0) { | |
705 | avl_find(&spa->spa_keystore.sk_dsl_keys, dck_io, &where); | |
706 | avl_insert(&spa->spa_keystore.sk_dsl_keys, dck_io, where); | |
707 | *dck_out = dck_io; | |
708 | } else { | |
709 | dsl_crypto_key_free(dck_io); | |
710 | *dck_out = dck_ks; | |
711 | } | |
b5256303 | 712 | |
0d23f5e2 | 713 | /* Release the wrapping key (the dsl key now has a reference to it) */ |
b5256303 | 714 | dsl_wrapping_key_rele(wkey, FTAG); |
b5256303 TC |
715 | rw_exit(&spa->spa_keystore.sk_dk_lock); |
716 | ||
b5256303 | 717 | return (0); |
b5256303 TC |
718 | } |
719 | ||
720 | void | |
721 | spa_keystore_dsl_key_rele(spa_t *spa, dsl_crypto_key_t *dck, void *tag) | |
722 | { | |
723 | rw_enter(&spa->spa_keystore.sk_dk_lock, RW_WRITER); | |
724 | ||
424fd7c3 | 725 | if (zfs_refcount_remove(&dck->dck_holds, tag) == 0) { |
b5256303 TC |
726 | avl_remove(&spa->spa_keystore.sk_dsl_keys, dck); |
727 | dsl_crypto_key_free(dck); | |
728 | } | |
729 | ||
730 | rw_exit(&spa->spa_keystore.sk_dk_lock); | |
731 | } | |
732 | ||
733 | int | |
734 | spa_keystore_load_wkey_impl(spa_t *spa, dsl_wrapping_key_t *wkey) | |
735 | { | |
736 | int ret; | |
737 | avl_index_t where; | |
738 | dsl_wrapping_key_t *found_wkey; | |
739 | ||
740 | rw_enter(&spa->spa_keystore.sk_wkeys_lock, RW_WRITER); | |
741 | ||
742 | /* insert the wrapping key into the keystore */ | |
743 | found_wkey = avl_find(&spa->spa_keystore.sk_wkeys, wkey, &where); | |
744 | if (found_wkey != NULL) { | |
745 | ret = SET_ERROR(EEXIST); | |
746 | goto error_unlock; | |
747 | } | |
748 | avl_insert(&spa->spa_keystore.sk_wkeys, wkey, where); | |
749 | ||
750 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
751 | ||
752 | return (0); | |
753 | ||
754 | error_unlock: | |
755 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
756 | return (ret); | |
757 | } | |
758 | ||
759 | int | |
760 | spa_keystore_load_wkey(const char *dsname, dsl_crypto_params_t *dcp, | |
761 | boolean_t noop) | |
762 | { | |
763 | int ret; | |
764 | dsl_dir_t *dd = NULL; | |
765 | dsl_crypto_key_t *dck = NULL; | |
766 | dsl_wrapping_key_t *wkey = dcp->cp_wkey; | |
767 | dsl_pool_t *dp = NULL; | |
f44ad929 | 768 | uint64_t rddobj, keyformat, salt, iters; |
b5256303 TC |
769 | |
770 | /* | |
771 | * We don't validate the wrapping key's keyformat, salt, or iters | |
772 | * since they will never be needed after the DCK has been wrapped. | |
773 | */ | |
774 | if (dcp->cp_wkey == NULL || | |
775 | dcp->cp_cmd != DCP_CMD_NONE || | |
776 | dcp->cp_crypt != ZIO_CRYPT_INHERIT || | |
777 | dcp->cp_keylocation != NULL) | |
778 | return (SET_ERROR(EINVAL)); | |
779 | ||
780 | ret = dsl_pool_hold(dsname, FTAG, &dp); | |
781 | if (ret != 0) | |
782 | goto error; | |
783 | ||
784 | if (!spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_ENCRYPTION)) { | |
f44ad929 | 785 | ret = SET_ERROR(ENOTSUP); |
b5256303 TC |
786 | goto error; |
787 | } | |
788 | ||
789 | /* hold the dsl dir */ | |
790 | ret = dsl_dir_hold(dp, dsname, FTAG, &dd, NULL); | |
fc1ecd16 DB |
791 | if (ret != 0) { |
792 | dd = NULL; | |
b5256303 | 793 | goto error; |
fc1ecd16 | 794 | } |
b5256303 | 795 | |
f44ad929 TC |
796 | /* confirm that dd is the encryption root */ |
797 | ret = dsl_dir_get_encryption_root_ddobj(dd, &rddobj); | |
798 | if (ret != 0 || rddobj != dd->dd_object) { | |
799 | ret = SET_ERROR(EINVAL); | |
800 | goto error; | |
801 | } | |
802 | ||
b5256303 TC |
803 | /* initialize the wkey's ddobj */ |
804 | wkey->wk_ddobj = dd->dd_object; | |
805 | ||
806 | /* verify that the wkey is correct by opening its dsl key */ | |
807 | ret = dsl_crypto_key_open(dp->dp_meta_objset, wkey, | |
808 | dd->dd_crypto_obj, FTAG, &dck); | |
809 | if (ret != 0) | |
810 | goto error; | |
811 | ||
2637dda8 TC |
812 | /* initialize the wkey encryption parameters from the DSL Crypto Key */ |
813 | ret = zap_lookup(dp->dp_meta_objset, dd->dd_crypto_obj, | |
814 | zfs_prop_to_name(ZFS_PROP_KEYFORMAT), 8, 1, &keyformat); | |
815 | if (ret != 0) | |
816 | goto error; | |
817 | ||
818 | ret = zap_lookup(dp->dp_meta_objset, dd->dd_crypto_obj, | |
819 | zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), 8, 1, &salt); | |
820 | if (ret != 0) | |
821 | goto error; | |
822 | ||
823 | ret = zap_lookup(dp->dp_meta_objset, dd->dd_crypto_obj, | |
824 | zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), 8, 1, &iters); | |
825 | if (ret != 0) | |
826 | goto error; | |
827 | ||
828 | ASSERT3U(keyformat, <, ZFS_KEYFORMAT_FORMATS); | |
829 | ASSERT3U(keyformat, !=, ZFS_KEYFORMAT_NONE); | |
830 | IMPLY(keyformat == ZFS_KEYFORMAT_PASSPHRASE, iters != 0); | |
831 | IMPLY(keyformat == ZFS_KEYFORMAT_PASSPHRASE, salt != 0); | |
832 | IMPLY(keyformat != ZFS_KEYFORMAT_PASSPHRASE, iters == 0); | |
833 | IMPLY(keyformat != ZFS_KEYFORMAT_PASSPHRASE, salt == 0); | |
834 | ||
835 | wkey->wk_keyformat = keyformat; | |
836 | wkey->wk_salt = salt; | |
837 | wkey->wk_iters = iters; | |
838 | ||
b5256303 | 839 | /* |
2637dda8 TC |
840 | * At this point we have verified the wkey and confirmed that it can |
841 | * be used to decrypt a DSL Crypto Key. We can simply cleanup and | |
b5256303 TC |
842 | * return if this is all the user wanted to do. |
843 | */ | |
844 | if (noop) | |
845 | goto error; | |
846 | ||
847 | /* insert the wrapping key into the keystore */ | |
848 | ret = spa_keystore_load_wkey_impl(dp->dp_spa, wkey); | |
849 | if (ret != 0) | |
850 | goto error; | |
851 | ||
852 | dsl_crypto_key_rele(dck, FTAG); | |
853 | dsl_dir_rele(dd, FTAG); | |
854 | dsl_pool_rele(dp, FTAG); | |
855 | ||
856 | /* create any zvols under this ds */ | |
ec213971 | 857 | zvol_create_minors_recursive(dsname); |
b5256303 TC |
858 | |
859 | return (0); | |
860 | ||
861 | error: | |
862 | if (dck != NULL) | |
863 | dsl_crypto_key_rele(dck, FTAG); | |
864 | if (dd != NULL) | |
865 | dsl_dir_rele(dd, FTAG); | |
866 | if (dp != NULL) | |
867 | dsl_pool_rele(dp, FTAG); | |
868 | ||
869 | return (ret); | |
870 | } | |
871 | ||
872 | int | |
873 | spa_keystore_unload_wkey_impl(spa_t *spa, uint64_t ddobj) | |
874 | { | |
875 | int ret; | |
876 | dsl_wrapping_key_t search_wkey; | |
877 | dsl_wrapping_key_t *found_wkey; | |
878 | ||
879 | /* init the search wrapping key */ | |
880 | search_wkey.wk_ddobj = ddobj; | |
881 | ||
882 | rw_enter(&spa->spa_keystore.sk_wkeys_lock, RW_WRITER); | |
883 | ||
884 | /* remove the wrapping key from the keystore */ | |
885 | found_wkey = avl_find(&spa->spa_keystore.sk_wkeys, | |
886 | &search_wkey, NULL); | |
887 | if (!found_wkey) { | |
85ce3f4f | 888 | ret = SET_ERROR(EACCES); |
b5256303 | 889 | goto error_unlock; |
424fd7c3 | 890 | } else if (zfs_refcount_count(&found_wkey->wk_refcnt) != 0) { |
b5256303 TC |
891 | ret = SET_ERROR(EBUSY); |
892 | goto error_unlock; | |
893 | } | |
894 | avl_remove(&spa->spa_keystore.sk_wkeys, found_wkey); | |
895 | ||
896 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
897 | ||
898 | /* free the wrapping key */ | |
899 | dsl_wrapping_key_free(found_wkey); | |
900 | ||
901 | return (0); | |
902 | ||
903 | error_unlock: | |
904 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
905 | return (ret); | |
906 | } | |
907 | ||
908 | int | |
909 | spa_keystore_unload_wkey(const char *dsname) | |
910 | { | |
911 | int ret = 0; | |
912 | dsl_dir_t *dd = NULL; | |
913 | dsl_pool_t *dp = NULL; | |
52ce99dd TC |
914 | spa_t *spa = NULL; |
915 | ||
916 | ret = spa_open(dsname, &spa, FTAG); | |
917 | if (ret != 0) | |
918 | return (ret); | |
919 | ||
920 | /* | |
921 | * Wait for any outstanding txg IO to complete, releasing any | |
922 | * remaining references on the wkey. | |
923 | */ | |
da92d5cb | 924 | if (spa_mode(spa) != SPA_MODE_READ) |
52ce99dd TC |
925 | txg_wait_synced(spa->spa_dsl_pool, 0); |
926 | ||
927 | spa_close(spa, FTAG); | |
b5256303 TC |
928 | |
929 | /* hold the dsl dir */ | |
930 | ret = dsl_pool_hold(dsname, FTAG, &dp); | |
931 | if (ret != 0) | |
932 | goto error; | |
933 | ||
934 | if (!spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_ENCRYPTION)) { | |
935 | ret = (SET_ERROR(ENOTSUP)); | |
936 | goto error; | |
937 | } | |
938 | ||
939 | ret = dsl_dir_hold(dp, dsname, FTAG, &dd, NULL); | |
fc1ecd16 DB |
940 | if (ret != 0) { |
941 | dd = NULL; | |
b5256303 | 942 | goto error; |
fc1ecd16 | 943 | } |
b5256303 TC |
944 | |
945 | /* unload the wkey */ | |
946 | ret = spa_keystore_unload_wkey_impl(dp->dp_spa, dd->dd_object); | |
947 | if (ret != 0) | |
948 | goto error; | |
949 | ||
950 | dsl_dir_rele(dd, FTAG); | |
951 | dsl_pool_rele(dp, FTAG); | |
952 | ||
953 | /* remove any zvols under this ds */ | |
954 | zvol_remove_minors(dp->dp_spa, dsname, B_TRUE); | |
955 | ||
956 | return (0); | |
957 | ||
958 | error: | |
959 | if (dd != NULL) | |
960 | dsl_dir_rele(dd, FTAG); | |
961 | if (dp != NULL) | |
962 | dsl_pool_rele(dp, FTAG); | |
963 | ||
964 | return (ret); | |
965 | } | |
966 | ||
52ce99dd TC |
967 | void |
968 | key_mapping_add_ref(dsl_key_mapping_t *km, void *tag) | |
969 | { | |
970 | ASSERT3U(zfs_refcount_count(&km->km_refcnt), >=, 1); | |
971 | zfs_refcount_add(&km->km_refcnt, tag); | |
972 | } | |
973 | ||
974 | /* | |
975 | * The locking here is a little tricky to ensure we don't cause unnecessary | |
976 | * performance problems. We want to release a key mapping whenever someone | |
977 | * decrements the refcount to 0, but freeing the mapping requires removing | |
978 | * it from the spa_keystore, which requires holding sk_km_lock as a writer. | |
979 | * Most of the time we don't want to hold this lock as a writer, since the | |
980 | * same lock is held as a reader for each IO that needs to encrypt / decrypt | |
981 | * data for any dataset and in practice we will only actually free the | |
982 | * mapping after unmounting a dataset. | |
983 | */ | |
984 | void | |
985 | key_mapping_rele(spa_t *spa, dsl_key_mapping_t *km, void *tag) | |
986 | { | |
987 | ASSERT3U(zfs_refcount_count(&km->km_refcnt), >=, 1); | |
988 | ||
989 | if (zfs_refcount_remove(&km->km_refcnt, tag) != 0) | |
990 | return; | |
991 | ||
992 | /* | |
993 | * We think we are going to need to free the mapping. Add a | |
994 | * reference to prevent most other releasers from thinking | |
995 | * this might be their responsibility. This is inherently | |
996 | * racy, so we will confirm that we are legitimately the | |
997 | * last holder once we have the sk_km_lock as a writer. | |
998 | */ | |
999 | zfs_refcount_add(&km->km_refcnt, FTAG); | |
1000 | ||
1001 | rw_enter(&spa->spa_keystore.sk_km_lock, RW_WRITER); | |
1002 | if (zfs_refcount_remove(&km->km_refcnt, FTAG) != 0) { | |
1003 | rw_exit(&spa->spa_keystore.sk_km_lock); | |
1004 | return; | |
1005 | } | |
1006 | ||
1007 | avl_remove(&spa->spa_keystore.sk_key_mappings, km); | |
1008 | rw_exit(&spa->spa_keystore.sk_km_lock); | |
1009 | ||
1010 | spa_keystore_dsl_key_rele(spa, km->km_key, km); | |
1011 | kmem_free(km, sizeof (dsl_key_mapping_t)); | |
1012 | } | |
1013 | ||
b5256303 | 1014 | int |
52ce99dd TC |
1015 | spa_keystore_create_mapping(spa_t *spa, dsl_dataset_t *ds, void *tag, |
1016 | dsl_key_mapping_t **km_out) | |
b5256303 TC |
1017 | { |
1018 | int ret; | |
1019 | avl_index_t where; | |
0d23f5e2 | 1020 | dsl_key_mapping_t *km, *found_km; |
b5256303 TC |
1021 | boolean_t should_free = B_FALSE; |
1022 | ||
0d23f5e2 BB |
1023 | /* Allocate and initialize the mapping */ |
1024 | km = kmem_zalloc(sizeof (dsl_key_mapping_t), KM_SLEEP); | |
424fd7c3 | 1025 | zfs_refcount_create(&km->km_refcnt); |
b5256303 | 1026 | |
52ce99dd | 1027 | ret = spa_keystore_dsl_key_hold_dd(spa, ds->ds_dir, km, &km->km_key); |
0d23f5e2 | 1028 | if (ret != 0) { |
424fd7c3 | 1029 | zfs_refcount_destroy(&km->km_refcnt); |
0d23f5e2 | 1030 | kmem_free(km, sizeof (dsl_key_mapping_t)); |
52ce99dd TC |
1031 | |
1032 | if (km_out != NULL) | |
1033 | *km_out = NULL; | |
0d23f5e2 BB |
1034 | return (ret); |
1035 | } | |
b5256303 | 1036 | |
52ce99dd | 1037 | km->km_dsobj = ds->ds_object; |
b5256303 TC |
1038 | |
1039 | rw_enter(&spa->spa_keystore.sk_km_lock, RW_WRITER); | |
1040 | ||
1041 | /* | |
1042 | * If a mapping already exists, simply increment its refcount and | |
1043 | * cleanup the one we made. We want to allocate / free outside of | |
1044 | * the lock because this lock is also used by the zio layer to lookup | |
1045 | * key mappings. Otherwise, use the one we created. Normally, there will | |
1046 | * only be one active reference at a time (the objset owner), but there | |
1047 | * are times when there could be multiple async users. | |
1048 | */ | |
1049 | found_km = avl_find(&spa->spa_keystore.sk_key_mappings, km, &where); | |
1050 | if (found_km != NULL) { | |
1051 | should_free = B_TRUE; | |
c13060e4 | 1052 | zfs_refcount_add(&found_km->km_refcnt, tag); |
52ce99dd TC |
1053 | if (km_out != NULL) |
1054 | *km_out = found_km; | |
b5256303 | 1055 | } else { |
c13060e4 | 1056 | zfs_refcount_add(&km->km_refcnt, tag); |
b5256303 | 1057 | avl_insert(&spa->spa_keystore.sk_key_mappings, km, where); |
52ce99dd TC |
1058 | if (km_out != NULL) |
1059 | *km_out = km; | |
b5256303 TC |
1060 | } |
1061 | ||
1062 | rw_exit(&spa->spa_keystore.sk_km_lock); | |
1063 | ||
1064 | if (should_free) { | |
1065 | spa_keystore_dsl_key_rele(spa, km->km_key, km); | |
424fd7c3 | 1066 | zfs_refcount_destroy(&km->km_refcnt); |
b5256303 TC |
1067 | kmem_free(km, sizeof (dsl_key_mapping_t)); |
1068 | } | |
1069 | ||
1070 | return (0); | |
b5256303 TC |
1071 | } |
1072 | ||
b5256303 TC |
1073 | int |
1074 | spa_keystore_remove_mapping(spa_t *spa, uint64_t dsobj, void *tag) | |
1075 | { | |
1076 | int ret; | |
1077 | dsl_key_mapping_t search_km; | |
1078 | dsl_key_mapping_t *found_km; | |
b5256303 TC |
1079 | |
1080 | /* init the search key mapping */ | |
1081 | search_km.km_dsobj = dsobj; | |
1082 | ||
52ce99dd | 1083 | rw_enter(&spa->spa_keystore.sk_km_lock, RW_READER); |
b5256303 TC |
1084 | |
1085 | /* find the matching mapping */ | |
1086 | found_km = avl_find(&spa->spa_keystore.sk_key_mappings, | |
1087 | &search_km, NULL); | |
1088 | if (found_km == NULL) { | |
1089 | ret = SET_ERROR(ENOENT); | |
1090 | goto error_unlock; | |
1091 | } | |
1092 | ||
b5256303 TC |
1093 | rw_exit(&spa->spa_keystore.sk_km_lock); |
1094 | ||
52ce99dd | 1095 | key_mapping_rele(spa, found_km, tag); |
b5256303 TC |
1096 | |
1097 | return (0); | |
1098 | ||
1099 | error_unlock: | |
1100 | rw_exit(&spa->spa_keystore.sk_km_lock); | |
1101 | return (ret); | |
1102 | } | |
1103 | ||
1104 | /* | |
1105 | * This function is primarily used by the zio and arc layer to lookup | |
1106 | * DSL Crypto Keys for encryption. Callers must release the key with | |
1107 | * spa_keystore_dsl_key_rele(). The function may also be called with | |
1108 | * dck_out == NULL and tag == NULL to simply check that a key exists | |
1109 | * without getting a reference to it. | |
1110 | */ | |
1111 | int | |
1112 | spa_keystore_lookup_key(spa_t *spa, uint64_t dsobj, void *tag, | |
1113 | dsl_crypto_key_t **dck_out) | |
1114 | { | |
1115 | int ret; | |
1116 | dsl_key_mapping_t search_km; | |
1117 | dsl_key_mapping_t *found_km; | |
1118 | ||
1119 | ASSERT((tag != NULL && dck_out != NULL) || | |
1120 | (tag == NULL && dck_out == NULL)); | |
1121 | ||
1122 | /* init the search key mapping */ | |
1123 | search_km.km_dsobj = dsobj; | |
1124 | ||
1125 | rw_enter(&spa->spa_keystore.sk_km_lock, RW_READER); | |
1126 | ||
1127 | /* remove the mapping from the tree */ | |
1128 | found_km = avl_find(&spa->spa_keystore.sk_key_mappings, &search_km, | |
1129 | NULL); | |
1130 | if (found_km == NULL) { | |
1131 | ret = SET_ERROR(ENOENT); | |
1132 | goto error_unlock; | |
1133 | } | |
1134 | ||
1135 | if (found_km && tag) | |
c13060e4 | 1136 | zfs_refcount_add(&found_km->km_key->dck_holds, tag); |
b5256303 TC |
1137 | |
1138 | rw_exit(&spa->spa_keystore.sk_km_lock); | |
1139 | ||
1140 | if (dck_out != NULL) | |
1141 | *dck_out = found_km->km_key; | |
1142 | return (0); | |
1143 | ||
1144 | error_unlock: | |
1145 | rw_exit(&spa->spa_keystore.sk_km_lock); | |
1146 | ||
1147 | if (dck_out != NULL) | |
1148 | *dck_out = NULL; | |
1149 | return (ret); | |
1150 | } | |
1151 | ||
1152 | static int | |
1153 | dmu_objset_check_wkey_loaded(dsl_dir_t *dd) | |
1154 | { | |
1155 | int ret; | |
1156 | dsl_wrapping_key_t *wkey = NULL; | |
1157 | ||
1158 | ret = spa_keystore_wkey_hold_dd(dd->dd_pool->dp_spa, dd, FTAG, | |
1159 | &wkey); | |
1160 | if (ret != 0) | |
1161 | return (SET_ERROR(EACCES)); | |
1162 | ||
1163 | dsl_wrapping_key_rele(wkey, FTAG); | |
1164 | ||
1165 | return (0); | |
1166 | } | |
1167 | ||
1168 | static zfs_keystatus_t | |
1169 | dsl_dataset_get_keystatus(dsl_dir_t *dd) | |
1170 | { | |
1171 | /* check if this dd has a has a dsl key */ | |
1172 | if (dd->dd_crypto_obj == 0) | |
1173 | return (ZFS_KEYSTATUS_NONE); | |
1174 | ||
1175 | return (dmu_objset_check_wkey_loaded(dd) == 0 ? | |
1176 | ZFS_KEYSTATUS_AVAILABLE : ZFS_KEYSTATUS_UNAVAILABLE); | |
1177 | } | |
1178 | ||
1179 | static int | |
1180 | dsl_dir_get_crypt(dsl_dir_t *dd, uint64_t *crypt) | |
1181 | { | |
1182 | if (dd->dd_crypto_obj == 0) { | |
1183 | *crypt = ZIO_CRYPT_OFF; | |
1184 | return (0); | |
1185 | } | |
1186 | ||
1187 | return (zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
1188 | DSL_CRYPTO_KEY_CRYPTO_SUITE, 8, 1, crypt)); | |
1189 | } | |
1190 | ||
1191 | static void | |
1192 | dsl_crypto_key_sync_impl(objset_t *mos, uint64_t dckobj, uint64_t crypt, | |
1193 | uint64_t root_ddobj, uint64_t guid, uint8_t *iv, uint8_t *mac, | |
1194 | uint8_t *keydata, uint8_t *hmac_keydata, uint64_t keyformat, | |
1195 | uint64_t salt, uint64_t iters, dmu_tx_t *tx) | |
1196 | { | |
1197 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_CRYPTO_SUITE, 8, 1, | |
1198 | &crypt, tx)); | |
1199 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_ROOT_DDOBJ, 8, 1, | |
1200 | &root_ddobj, tx)); | |
1201 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_GUID, 8, 1, | |
1202 | &guid, tx)); | |
1203 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_IV, 1, WRAPPING_IV_LEN, | |
1204 | iv, tx)); | |
1205 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_MAC, 1, WRAPPING_MAC_LEN, | |
1206 | mac, tx)); | |
1207 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_MASTER_KEY, 1, | |
1208 | MASTER_KEY_MAX_LEN, keydata, tx)); | |
1209 | VERIFY0(zap_update(mos, dckobj, DSL_CRYPTO_KEY_HMAC_KEY, 1, | |
1210 | SHA512_HMAC_KEYLEN, hmac_keydata, tx)); | |
1211 | VERIFY0(zap_update(mos, dckobj, zfs_prop_to_name(ZFS_PROP_KEYFORMAT), | |
1212 | 8, 1, &keyformat, tx)); | |
1213 | VERIFY0(zap_update(mos, dckobj, zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), | |
1214 | 8, 1, &salt, tx)); | |
1215 | VERIFY0(zap_update(mos, dckobj, zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), | |
1216 | 8, 1, &iters, tx)); | |
1217 | } | |
1218 | ||
1219 | static void | |
1220 | dsl_crypto_key_sync(dsl_crypto_key_t *dck, dmu_tx_t *tx) | |
1221 | { | |
1222 | zio_crypt_key_t *key = &dck->dck_key; | |
1223 | dsl_wrapping_key_t *wkey = dck->dck_wkey; | |
1224 | uint8_t keydata[MASTER_KEY_MAX_LEN]; | |
1225 | uint8_t hmac_keydata[SHA512_HMAC_KEYLEN]; | |
1226 | uint8_t iv[WRAPPING_IV_LEN]; | |
1227 | uint8_t mac[WRAPPING_MAC_LEN]; | |
1228 | ||
1229 | ASSERT(dmu_tx_is_syncing(tx)); | |
1230 | ASSERT3U(key->zk_crypt, <, ZIO_CRYPT_FUNCTIONS); | |
1231 | ||
1232 | /* encrypt and store the keys along with the IV and MAC */ | |
10fa2545 BB |
1233 | VERIFY0(zio_crypt_key_wrap(&dck->dck_wkey->wk_key, key, iv, mac, |
1234 | keydata, hmac_keydata)); | |
b5256303 TC |
1235 | |
1236 | /* update the ZAP with the obtained values */ | |
10fa2545 BB |
1237 | dsl_crypto_key_sync_impl(tx->tx_pool->dp_meta_objset, dck->dck_obj, |
1238 | key->zk_crypt, wkey->wk_ddobj, key->zk_guid, iv, mac, keydata, | |
1239 | hmac_keydata, wkey->wk_keyformat, wkey->wk_salt, wkey->wk_iters, | |
1240 | tx); | |
b5256303 TC |
1241 | } |
1242 | ||
1243 | typedef struct spa_keystore_change_key_args { | |
1244 | const char *skcka_dsname; | |
1245 | dsl_crypto_params_t *skcka_cp; | |
1246 | } spa_keystore_change_key_args_t; | |
1247 | ||
1248 | static int | |
1249 | spa_keystore_change_key_check(void *arg, dmu_tx_t *tx) | |
1250 | { | |
1251 | int ret; | |
1252 | dsl_dir_t *dd = NULL; | |
1253 | dsl_pool_t *dp = dmu_tx_pool(tx); | |
1254 | spa_keystore_change_key_args_t *skcka = arg; | |
1255 | dsl_crypto_params_t *dcp = skcka->skcka_cp; | |
1256 | uint64_t rddobj; | |
1257 | ||
1258 | /* check for the encryption feature */ | |
1259 | if (!spa_feature_is_enabled(dp->dp_spa, SPA_FEATURE_ENCRYPTION)) { | |
1260 | ret = SET_ERROR(ENOTSUP); | |
1261 | goto error; | |
1262 | } | |
1263 | ||
1264 | /* check for valid key change command */ | |
1265 | if (dcp->cp_cmd != DCP_CMD_NEW_KEY && | |
1266 | dcp->cp_cmd != DCP_CMD_INHERIT && | |
1267 | dcp->cp_cmd != DCP_CMD_FORCE_NEW_KEY && | |
1268 | dcp->cp_cmd != DCP_CMD_FORCE_INHERIT) { | |
1269 | ret = SET_ERROR(EINVAL); | |
1270 | goto error; | |
1271 | } | |
1272 | ||
1273 | /* hold the dd */ | |
1274 | ret = dsl_dir_hold(dp, skcka->skcka_dsname, FTAG, &dd, NULL); | |
fc1ecd16 DB |
1275 | if (ret != 0) { |
1276 | dd = NULL; | |
b5256303 | 1277 | goto error; |
fc1ecd16 | 1278 | } |
b5256303 TC |
1279 | |
1280 | /* verify that the dataset is encrypted */ | |
1281 | if (dd->dd_crypto_obj == 0) { | |
1282 | ret = SET_ERROR(EINVAL); | |
1283 | goto error; | |
1284 | } | |
1285 | ||
1286 | /* clones must always use their origin's key */ | |
1287 | if (dsl_dir_is_clone(dd)) { | |
1288 | ret = SET_ERROR(EINVAL); | |
1289 | goto error; | |
1290 | } | |
1291 | ||
1292 | /* lookup the ddobj we are inheriting the keylocation from */ | |
1293 | ret = dsl_dir_get_encryption_root_ddobj(dd, &rddobj); | |
1294 | if (ret != 0) | |
1295 | goto error; | |
1296 | ||
85ce3f4f | 1297 | /* Handle inheritance */ |
b5256303 TC |
1298 | if (dcp->cp_cmd == DCP_CMD_INHERIT || |
1299 | dcp->cp_cmd == DCP_CMD_FORCE_INHERIT) { | |
1300 | /* no other encryption params should be given */ | |
1301 | if (dcp->cp_crypt != ZIO_CRYPT_INHERIT || | |
1302 | dcp->cp_keylocation != NULL || | |
1303 | dcp->cp_wkey != NULL) { | |
1304 | ret = SET_ERROR(EINVAL); | |
1305 | goto error; | |
1306 | } | |
1307 | ||
1308 | /* check that this is an encryption root */ | |
1309 | if (dd->dd_object != rddobj) { | |
1310 | ret = SET_ERROR(EINVAL); | |
1311 | goto error; | |
1312 | } | |
1313 | ||
1314 | /* check that the parent is encrypted */ | |
1315 | if (dd->dd_parent->dd_crypto_obj == 0) { | |
1316 | ret = SET_ERROR(EINVAL); | |
1317 | goto error; | |
1318 | } | |
1319 | ||
1320 | /* if we are rewrapping check that both keys are loaded */ | |
1321 | if (dcp->cp_cmd == DCP_CMD_INHERIT) { | |
1322 | ret = dmu_objset_check_wkey_loaded(dd); | |
1323 | if (ret != 0) | |
1324 | goto error; | |
1325 | ||
1326 | ret = dmu_objset_check_wkey_loaded(dd->dd_parent); | |
1327 | if (ret != 0) | |
1328 | goto error; | |
1329 | } | |
1330 | ||
1331 | dsl_dir_rele(dd, FTAG); | |
1332 | return (0); | |
1333 | } | |
1334 | ||
1335 | /* handle forcing an encryption root without rewrapping */ | |
1336 | if (dcp->cp_cmd == DCP_CMD_FORCE_NEW_KEY) { | |
1337 | /* no other encryption params should be given */ | |
1338 | if (dcp->cp_crypt != ZIO_CRYPT_INHERIT || | |
1339 | dcp->cp_keylocation != NULL || | |
1340 | dcp->cp_wkey != NULL) { | |
1341 | ret = SET_ERROR(EINVAL); | |
1342 | goto error; | |
1343 | } | |
1344 | ||
1345 | /* check that this is not an encryption root */ | |
1346 | if (dd->dd_object == rddobj) { | |
1347 | ret = SET_ERROR(EINVAL); | |
1348 | goto error; | |
1349 | } | |
1350 | ||
1351 | dsl_dir_rele(dd, FTAG); | |
1352 | return (0); | |
1353 | } | |
1354 | ||
1355 | /* crypt cannot be changed after creation */ | |
1356 | if (dcp->cp_crypt != ZIO_CRYPT_INHERIT) { | |
1357 | ret = SET_ERROR(EINVAL); | |
1358 | goto error; | |
1359 | } | |
1360 | ||
1361 | /* we are not inheritting our parent's wkey so we need one ourselves */ | |
1362 | if (dcp->cp_wkey == NULL) { | |
1363 | ret = SET_ERROR(EINVAL); | |
1364 | goto error; | |
1365 | } | |
1366 | ||
1367 | /* check for a valid keyformat for the new wrapping key */ | |
1368 | if (dcp->cp_wkey->wk_keyformat >= ZFS_KEYFORMAT_FORMATS || | |
1369 | dcp->cp_wkey->wk_keyformat == ZFS_KEYFORMAT_NONE) { | |
1370 | ret = SET_ERROR(EINVAL); | |
1371 | goto error; | |
1372 | } | |
1373 | ||
1374 | /* | |
1375 | * If this dataset is not currently an encryption root we need a new | |
1376 | * keylocation for this dataset's new wrapping key. Otherwise we can | |
1377 | * just keep the one we already had. | |
1378 | */ | |
1379 | if (dd->dd_object != rddobj && dcp->cp_keylocation == NULL) { | |
1380 | ret = SET_ERROR(EINVAL); | |
1381 | goto error; | |
1382 | } | |
1383 | ||
1384 | /* check that the keylocation is valid if it is not NULL */ | |
1385 | if (dcp->cp_keylocation != NULL && | |
1386 | !zfs_prop_valid_keylocation(dcp->cp_keylocation, B_TRUE)) { | |
1387 | ret = SET_ERROR(EINVAL); | |
1388 | goto error; | |
1389 | } | |
1390 | ||
1391 | /* passphrases require pbkdf2 salt and iters */ | |
1392 | if (dcp->cp_wkey->wk_keyformat == ZFS_KEYFORMAT_PASSPHRASE) { | |
1393 | if (dcp->cp_wkey->wk_salt == 0 || | |
1394 | dcp->cp_wkey->wk_iters < MIN_PBKDF2_ITERATIONS) { | |
1395 | ret = SET_ERROR(EINVAL); | |
1396 | goto error; | |
1397 | } | |
1398 | } else { | |
1399 | if (dcp->cp_wkey->wk_salt != 0 || dcp->cp_wkey->wk_iters != 0) { | |
1400 | ret = SET_ERROR(EINVAL); | |
1401 | goto error; | |
1402 | } | |
1403 | } | |
1404 | ||
1405 | /* make sure the dd's wkey is loaded */ | |
1406 | ret = dmu_objset_check_wkey_loaded(dd); | |
1407 | if (ret != 0) | |
1408 | goto error; | |
1409 | ||
1410 | dsl_dir_rele(dd, FTAG); | |
1411 | ||
1412 | return (0); | |
1413 | ||
1414 | error: | |
1415 | if (dd != NULL) | |
1416 | dsl_dir_rele(dd, FTAG); | |
1417 | ||
1418 | return (ret); | |
1419 | } | |
1420 | ||
637f0c60 TC |
1421 | /* |
1422 | * This function deals with the intricacies of updating wrapping | |
1423 | * key references and encryption roots recursively in the event | |
1424 | * of a call to 'zfs change-key' or 'zfs promote'. The 'skip' | |
1425 | * parameter should always be set to B_FALSE when called | |
1426 | * externally. | |
1427 | */ | |
b5256303 TC |
1428 | static void |
1429 | spa_keystore_change_key_sync_impl(uint64_t rddobj, uint64_t ddobj, | |
637f0c60 TC |
1430 | uint64_t new_rddobj, dsl_wrapping_key_t *wkey, boolean_t skip, |
1431 | dmu_tx_t *tx) | |
b5256303 | 1432 | { |
bae11ba8 | 1433 | int ret; |
b5256303 TC |
1434 | zap_cursor_t *zc; |
1435 | zap_attribute_t *za; | |
1436 | dsl_pool_t *dp = dmu_tx_pool(tx); | |
1437 | dsl_dir_t *dd = NULL; | |
1438 | dsl_crypto_key_t *dck = NULL; | |
1439 | uint64_t curr_rddobj; | |
1440 | ||
1441 | ASSERT(RW_WRITE_HELD(&dp->dp_spa->spa_keystore.sk_wkeys_lock)); | |
1442 | ||
1443 | /* hold the dd */ | |
1444 | VERIFY0(dsl_dir_hold_obj(dp, ddobj, NULL, FTAG, &dd)); | |
1445 | ||
637f0c60 | 1446 | /* ignore special dsl dirs */ |
b5256303 TC |
1447 | if (dd->dd_myname[0] == '$' || dd->dd_myname[0] == '%') { |
1448 | dsl_dir_rele(dd, FTAG); | |
1449 | return; | |
1450 | } | |
1451 | ||
bae11ba8 TC |
1452 | ret = dsl_dir_get_encryption_root_ddobj(dd, &curr_rddobj); |
1453 | VERIFY(ret == 0 || ret == ENOENT); | |
1454 | ||
b135b9f1 TC |
1455 | /* |
1456 | * Stop recursing if this dsl dir didn't inherit from the root | |
1457 | * or if this dd is a clone. | |
1458 | */ | |
bae11ba8 TC |
1459 | if (ret == ENOENT || |
1460 | (!skip && (curr_rddobj != rddobj || dsl_dir_is_clone(dd)))) { | |
b5256303 TC |
1461 | dsl_dir_rele(dd, FTAG); |
1462 | return; | |
1463 | } | |
1464 | ||
1465 | /* | |
1466 | * If we don't have a wrapping key just update the dck to reflect the | |
1467 | * new encryption root. Otherwise rewrap the entire dck and re-sync it | |
637f0c60 | 1468 | * to disk. If skip is set, we don't do any of this work. |
b5256303 | 1469 | */ |
637f0c60 TC |
1470 | if (!skip) { |
1471 | if (wkey == NULL) { | |
1472 | VERIFY0(zap_update(dp->dp_meta_objset, | |
1473 | dd->dd_crypto_obj, | |
1474 | DSL_CRYPTO_KEY_ROOT_DDOBJ, 8, 1, | |
1475 | &new_rddobj, tx)); | |
1476 | } else { | |
1477 | VERIFY0(spa_keystore_dsl_key_hold_dd(dp->dp_spa, dd, | |
1478 | FTAG, &dck)); | |
1479 | dsl_wrapping_key_hold(wkey, dck); | |
1480 | dsl_wrapping_key_rele(dck->dck_wkey, dck); | |
1481 | dck->dck_wkey = wkey; | |
1482 | dsl_crypto_key_sync(dck, tx); | |
1483 | spa_keystore_dsl_key_rele(dp->dp_spa, dck, FTAG); | |
1484 | } | |
b5256303 TC |
1485 | } |
1486 | ||
1487 | zc = kmem_alloc(sizeof (zap_cursor_t), KM_SLEEP); | |
1488 | za = kmem_alloc(sizeof (zap_attribute_t), KM_SLEEP); | |
1489 | ||
b135b9f1 | 1490 | /* Recurse into all child dsl dirs. */ |
b5256303 TC |
1491 | for (zap_cursor_init(zc, dp->dp_meta_objset, |
1492 | dsl_dir_phys(dd)->dd_child_dir_zapobj); | |
1493 | zap_cursor_retrieve(zc, za) == 0; | |
1494 | zap_cursor_advance(zc)) { | |
1495 | spa_keystore_change_key_sync_impl(rddobj, | |
637f0c60 TC |
1496 | za->za_first_integer, new_rddobj, wkey, B_FALSE, tx); |
1497 | } | |
1498 | zap_cursor_fini(zc); | |
1499 | ||
1500 | /* | |
1501 | * Recurse into all dsl dirs of clones. We utilize the skip parameter | |
1502 | * here so that we don't attempt to process the clones directly. This | |
1503 | * is because the clone and its origin share the same dck, which has | |
1504 | * already been updated. | |
1505 | */ | |
1506 | for (zap_cursor_init(zc, dp->dp_meta_objset, | |
1507 | dsl_dir_phys(dd)->dd_clones); | |
1508 | zap_cursor_retrieve(zc, za) == 0; | |
1509 | zap_cursor_advance(zc)) { | |
1510 | dsl_dataset_t *clone; | |
1511 | ||
1512 | VERIFY0(dsl_dataset_hold_obj(dp, za->za_first_integer, | |
1513 | FTAG, &clone)); | |
1514 | spa_keystore_change_key_sync_impl(rddobj, | |
1515 | clone->ds_dir->dd_object, new_rddobj, wkey, B_TRUE, tx); | |
1516 | dsl_dataset_rele(clone, FTAG); | |
b5256303 TC |
1517 | } |
1518 | zap_cursor_fini(zc); | |
1519 | ||
b5256303 TC |
1520 | kmem_free(za, sizeof (zap_attribute_t)); |
1521 | kmem_free(zc, sizeof (zap_cursor_t)); | |
1522 | ||
1523 | dsl_dir_rele(dd, FTAG); | |
1524 | } | |
1525 | ||
1526 | static void | |
1527 | spa_keystore_change_key_sync(void *arg, dmu_tx_t *tx) | |
1528 | { | |
1529 | dsl_dataset_t *ds; | |
1530 | avl_index_t where; | |
1531 | dsl_pool_t *dp = dmu_tx_pool(tx); | |
1532 | spa_t *spa = dp->dp_spa; | |
1533 | spa_keystore_change_key_args_t *skcka = arg; | |
1534 | dsl_crypto_params_t *dcp = skcka->skcka_cp; | |
1535 | dsl_wrapping_key_t *wkey = NULL, *found_wkey; | |
1536 | dsl_wrapping_key_t wkey_search; | |
1537 | char *keylocation = dcp->cp_keylocation; | |
1538 | uint64_t rddobj, new_rddobj; | |
1539 | ||
1540 | /* create and initialize the wrapping key */ | |
1541 | VERIFY0(dsl_dataset_hold(dp, skcka->skcka_dsname, FTAG, &ds)); | |
1542 | ASSERT(!ds->ds_is_snapshot); | |
1543 | ||
1544 | if (dcp->cp_cmd == DCP_CMD_NEW_KEY || | |
1545 | dcp->cp_cmd == DCP_CMD_FORCE_NEW_KEY) { | |
1546 | /* | |
1547 | * We are changing to a new wkey. Set additional properties | |
1548 | * which can be sent along with this ioctl. Note that this | |
1549 | * command can set keylocation even if it can't normally be | |
1550 | * set via 'zfs set' due to a non-local keylocation. | |
1551 | */ | |
1552 | if (dcp->cp_cmd == DCP_CMD_NEW_KEY) { | |
1553 | wkey = dcp->cp_wkey; | |
1554 | wkey->wk_ddobj = ds->ds_dir->dd_object; | |
1555 | } else { | |
1556 | keylocation = "prompt"; | |
1557 | } | |
1558 | ||
1559 | if (keylocation != NULL) { | |
1560 | dsl_prop_set_sync_impl(ds, | |
1561 | zfs_prop_to_name(ZFS_PROP_KEYLOCATION), | |
1562 | ZPROP_SRC_LOCAL, 1, strlen(keylocation) + 1, | |
1563 | keylocation, tx); | |
1564 | } | |
1565 | ||
1566 | VERIFY0(dsl_dir_get_encryption_root_ddobj(ds->ds_dir, &rddobj)); | |
1567 | new_rddobj = ds->ds_dir->dd_object; | |
1568 | } else { | |
1569 | /* | |
1570 | * We are inheritting the parent's wkey. Unset any local | |
1571 | * keylocation and grab a reference to the wkey. | |
1572 | */ | |
1573 | if (dcp->cp_cmd == DCP_CMD_INHERIT) { | |
1574 | VERIFY0(spa_keystore_wkey_hold_dd(spa, | |
1575 | ds->ds_dir->dd_parent, FTAG, &wkey)); | |
1576 | } | |
1577 | ||
1578 | dsl_prop_set_sync_impl(ds, | |
1579 | zfs_prop_to_name(ZFS_PROP_KEYLOCATION), ZPROP_SRC_NONE, | |
1580 | 0, 0, NULL, tx); | |
1581 | ||
1582 | rddobj = ds->ds_dir->dd_object; | |
62df1bc8 TC |
1583 | VERIFY0(dsl_dir_get_encryption_root_ddobj(ds->ds_dir->dd_parent, |
1584 | &new_rddobj)); | |
b5256303 TC |
1585 | } |
1586 | ||
1587 | if (wkey == NULL) { | |
1588 | ASSERT(dcp->cp_cmd == DCP_CMD_FORCE_INHERIT || | |
1589 | dcp->cp_cmd == DCP_CMD_FORCE_NEW_KEY); | |
1590 | } | |
1591 | ||
1592 | rw_enter(&spa->spa_keystore.sk_wkeys_lock, RW_WRITER); | |
1593 | ||
1594 | /* recurse through all children and rewrap their keys */ | |
1595 | spa_keystore_change_key_sync_impl(rddobj, ds->ds_dir->dd_object, | |
637f0c60 | 1596 | new_rddobj, wkey, B_FALSE, tx); |
b5256303 TC |
1597 | |
1598 | /* | |
1599 | * All references to the old wkey should be released now (if it | |
1600 | * existed). Replace the wrapping key. | |
1601 | */ | |
1602 | wkey_search.wk_ddobj = ds->ds_dir->dd_object; | |
1603 | found_wkey = avl_find(&spa->spa_keystore.sk_wkeys, &wkey_search, NULL); | |
1604 | if (found_wkey != NULL) { | |
424fd7c3 | 1605 | ASSERT0(zfs_refcount_count(&found_wkey->wk_refcnt)); |
b5256303 TC |
1606 | avl_remove(&spa->spa_keystore.sk_wkeys, found_wkey); |
1607 | dsl_wrapping_key_free(found_wkey); | |
1608 | } | |
1609 | ||
1610 | if (dcp->cp_cmd == DCP_CMD_NEW_KEY) { | |
1611 | avl_find(&spa->spa_keystore.sk_wkeys, wkey, &where); | |
1612 | avl_insert(&spa->spa_keystore.sk_wkeys, wkey, where); | |
1613 | } else if (wkey != NULL) { | |
1614 | dsl_wrapping_key_rele(wkey, FTAG); | |
1615 | } | |
1616 | ||
1617 | rw_exit(&spa->spa_keystore.sk_wkeys_lock); | |
1618 | ||
1619 | dsl_dataset_rele(ds, FTAG); | |
1620 | } | |
1621 | ||
1622 | int | |
1623 | spa_keystore_change_key(const char *dsname, dsl_crypto_params_t *dcp) | |
1624 | { | |
1625 | spa_keystore_change_key_args_t skcka; | |
1626 | ||
1627 | /* initialize the args struct */ | |
1628 | skcka.skcka_dsname = dsname; | |
1629 | skcka.skcka_cp = dcp; | |
1630 | ||
1631 | /* | |
1632 | * Perform the actual work in syncing context. The blocks modified | |
1633 | * here could be calculated but it would require holding the pool | |
e1cfd73f | 1634 | * lock and traversing all of the datasets that will have their keys |
b5256303 TC |
1635 | * changed. |
1636 | */ | |
1637 | return (dsl_sync_task(dsname, spa_keystore_change_key_check, | |
1638 | spa_keystore_change_key_sync, &skcka, 15, | |
1639 | ZFS_SPACE_CHECK_RESERVED)); | |
1640 | } | |
1641 | ||
1642 | int | |
1643 | dsl_dir_rename_crypt_check(dsl_dir_t *dd, dsl_dir_t *newparent) | |
1644 | { | |
1645 | int ret; | |
1646 | uint64_t curr_rddobj, parent_rddobj; | |
1647 | ||
da689887 | 1648 | if (dd->dd_crypto_obj == 0) |
b5256303 | 1649 | return (0); |
b5256303 TC |
1650 | |
1651 | ret = dsl_dir_get_encryption_root_ddobj(dd, &curr_rddobj); | |
1652 | if (ret != 0) | |
1653 | goto error; | |
1654 | ||
1655 | /* | |
1656 | * if this is not an encryption root, we must make sure we are not | |
1657 | * moving dd to a new encryption root | |
1658 | */ | |
1659 | if (dd->dd_object != curr_rddobj) { | |
1660 | ret = dsl_dir_get_encryption_root_ddobj(newparent, | |
1661 | &parent_rddobj); | |
1662 | if (ret != 0) | |
1663 | goto error; | |
1664 | ||
1665 | if (parent_rddobj != curr_rddobj) { | |
1666 | ret = SET_ERROR(EACCES); | |
1667 | goto error; | |
1668 | } | |
1669 | } | |
1670 | ||
1671 | return (0); | |
1672 | ||
1673 | error: | |
1674 | return (ret); | |
1675 | } | |
1676 | ||
1677 | /* | |
1678 | * Check to make sure that a promote from targetdd to origindd will not require | |
1679 | * any key rewraps. | |
1680 | */ | |
1681 | int | |
1682 | dsl_dataset_promote_crypt_check(dsl_dir_t *target, dsl_dir_t *origin) | |
1683 | { | |
1684 | int ret; | |
1685 | uint64_t rddobj, op_rddobj, tp_rddobj; | |
1686 | ||
1687 | /* If the dataset is not encrypted we don't need to check anything */ | |
1688 | if (origin->dd_crypto_obj == 0) | |
1689 | return (0); | |
1690 | ||
1691 | /* | |
1692 | * If we are not changing the first origin snapshot in a chain | |
1693 | * the encryption root won't change either. | |
1694 | */ | |
1695 | if (dsl_dir_is_clone(origin)) | |
1696 | return (0); | |
1697 | ||
1698 | /* | |
1699 | * If the origin is the encryption root we will update | |
1700 | * the DSL Crypto Key to point to the target instead. | |
1701 | */ | |
1702 | ret = dsl_dir_get_encryption_root_ddobj(origin, &rddobj); | |
1703 | if (ret != 0) | |
1704 | return (ret); | |
1705 | ||
1706 | if (rddobj == origin->dd_object) | |
1707 | return (0); | |
1708 | ||
1709 | /* | |
1710 | * The origin is inheriting its encryption root from its parent. | |
1711 | * Check that the parent of the target has the same encryption root. | |
1712 | */ | |
1713 | ret = dsl_dir_get_encryption_root_ddobj(origin->dd_parent, &op_rddobj); | |
53864800 TC |
1714 | if (ret == ENOENT) |
1715 | return (SET_ERROR(EACCES)); | |
1716 | else if (ret != 0) | |
b5256303 TC |
1717 | return (ret); |
1718 | ||
1719 | ret = dsl_dir_get_encryption_root_ddobj(target->dd_parent, &tp_rddobj); | |
53864800 TC |
1720 | if (ret == ENOENT) |
1721 | return (SET_ERROR(EACCES)); | |
1722 | else if (ret != 0) | |
b5256303 TC |
1723 | return (ret); |
1724 | ||
1725 | if (op_rddobj != tp_rddobj) | |
1726 | return (SET_ERROR(EACCES)); | |
1727 | ||
1728 | return (0); | |
1729 | } | |
1730 | ||
1731 | void | |
1732 | dsl_dataset_promote_crypt_sync(dsl_dir_t *target, dsl_dir_t *origin, | |
1733 | dmu_tx_t *tx) | |
1734 | { | |
1735 | uint64_t rddobj; | |
1736 | dsl_pool_t *dp = target->dd_pool; | |
1737 | dsl_dataset_t *targetds; | |
1738 | dsl_dataset_t *originds; | |
1739 | char *keylocation; | |
1740 | ||
1741 | if (origin->dd_crypto_obj == 0) | |
1742 | return; | |
1743 | if (dsl_dir_is_clone(origin)) | |
1744 | return; | |
1745 | ||
1746 | VERIFY0(dsl_dir_get_encryption_root_ddobj(origin, &rddobj)); | |
1747 | ||
1748 | if (rddobj != origin->dd_object) | |
1749 | return; | |
1750 | ||
1751 | /* | |
e1cfd73f | 1752 | * If the target is being promoted to the encryption root update the |
b5256303 TC |
1753 | * DSL Crypto Key and keylocation to reflect that. We also need to |
1754 | * update the DSL Crypto Keys of all children inheritting their | |
1755 | * encryption root to point to the new target. Otherwise, the check | |
1756 | * function ensured that the encryption root will not change. | |
1757 | */ | |
1758 | keylocation = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP); | |
1759 | ||
1760 | VERIFY0(dsl_dataset_hold_obj(dp, | |
1761 | dsl_dir_phys(target)->dd_head_dataset_obj, FTAG, &targetds)); | |
1762 | VERIFY0(dsl_dataset_hold_obj(dp, | |
1763 | dsl_dir_phys(origin)->dd_head_dataset_obj, FTAG, &originds)); | |
1764 | ||
1765 | VERIFY0(dsl_prop_get_dd(origin, zfs_prop_to_name(ZFS_PROP_KEYLOCATION), | |
1766 | 1, ZAP_MAXVALUELEN, keylocation, NULL, B_FALSE)); | |
1767 | dsl_prop_set_sync_impl(targetds, zfs_prop_to_name(ZFS_PROP_KEYLOCATION), | |
1768 | ZPROP_SRC_LOCAL, 1, strlen(keylocation) + 1, keylocation, tx); | |
1769 | dsl_prop_set_sync_impl(originds, zfs_prop_to_name(ZFS_PROP_KEYLOCATION), | |
1770 | ZPROP_SRC_NONE, 0, 0, NULL, tx); | |
1771 | ||
1772 | rw_enter(&dp->dp_spa->spa_keystore.sk_wkeys_lock, RW_WRITER); | |
1773 | spa_keystore_change_key_sync_impl(rddobj, origin->dd_object, | |
637f0c60 | 1774 | target->dd_object, NULL, B_FALSE, tx); |
b5256303 TC |
1775 | rw_exit(&dp->dp_spa->spa_keystore.sk_wkeys_lock); |
1776 | ||
1777 | dsl_dataset_rele(targetds, FTAG); | |
1778 | dsl_dataset_rele(originds, FTAG); | |
1779 | kmem_free(keylocation, ZAP_MAXVALUELEN); | |
1780 | } | |
1781 | ||
b5256303 | 1782 | int |
1fff937a TC |
1783 | dmu_objset_create_crypt_check(dsl_dir_t *parentdd, dsl_crypto_params_t *dcp, |
1784 | boolean_t *will_encrypt) | |
b5256303 TC |
1785 | { |
1786 | int ret; | |
1787 | uint64_t pcrypt, crypt; | |
d9c460a0 TC |
1788 | dsl_crypto_params_t dummy_dcp = { 0 }; |
1789 | ||
1fff937a TC |
1790 | if (will_encrypt != NULL) |
1791 | *will_encrypt = B_FALSE; | |
1792 | ||
d9c460a0 TC |
1793 | if (dcp == NULL) |
1794 | dcp = &dummy_dcp; | |
b5256303 TC |
1795 | |
1796 | if (dcp->cp_cmd != DCP_CMD_NONE) | |
1797 | return (SET_ERROR(EINVAL)); | |
1798 | ||
1799 | if (parentdd != NULL) { | |
1800 | ret = dsl_dir_get_crypt(parentdd, &pcrypt); | |
1801 | if (ret != 0) | |
1802 | return (ret); | |
1803 | } else { | |
1804 | pcrypt = ZIO_CRYPT_OFF; | |
1805 | } | |
1806 | ||
1807 | crypt = (dcp->cp_crypt == ZIO_CRYPT_INHERIT) ? pcrypt : dcp->cp_crypt; | |
1808 | ||
1809 | ASSERT3U(pcrypt, !=, ZIO_CRYPT_INHERIT); | |
1810 | ASSERT3U(crypt, !=, ZIO_CRYPT_INHERIT); | |
1811 | ||
b5256303 TC |
1812 | /* check for valid dcp with no encryption (inherited or local) */ |
1813 | if (crypt == ZIO_CRYPT_OFF) { | |
1814 | /* Must not specify encryption params */ | |
1815 | if (dcp->cp_wkey != NULL || | |
1816 | (dcp->cp_keylocation != NULL && | |
1817 | strcmp(dcp->cp_keylocation, "none") != 0)) | |
1818 | return (SET_ERROR(EINVAL)); | |
1819 | ||
1820 | return (0); | |
1821 | } | |
1822 | ||
1fff937a TC |
1823 | if (will_encrypt != NULL) |
1824 | *will_encrypt = B_TRUE; | |
1825 | ||
b5256303 TC |
1826 | /* |
1827 | * We will now definitely be encrypting. Check the feature flag. When | |
1828 | * creating the pool the caller will check this for us since we won't | |
1fff937a | 1829 | * technically have the feature activated yet. |
b5256303 TC |
1830 | */ |
1831 | if (parentdd != NULL && | |
1832 | !spa_feature_is_enabled(parentdd->dd_pool->dp_spa, | |
1833 | SPA_FEATURE_ENCRYPTION)) { | |
1834 | return (SET_ERROR(EOPNOTSUPP)); | |
1835 | } | |
1836 | ||
eaed8405 TC |
1837 | /* Check for errata #4 (encryption enabled, bookmark_v2 disabled) */ |
1838 | if (parentdd != NULL && | |
1839 | !spa_feature_is_enabled(parentdd->dd_pool->dp_spa, | |
1840 | SPA_FEATURE_BOOKMARK_V2)) { | |
1841 | return (SET_ERROR(EOPNOTSUPP)); | |
1842 | } | |
1843 | ||
85ce3f4f | 1844 | /* handle inheritance */ |
b5256303 TC |
1845 | if (dcp->cp_wkey == NULL) { |
1846 | ASSERT3P(parentdd, !=, NULL); | |
1847 | ||
1848 | /* key must be fully unspecified */ | |
1849 | if (dcp->cp_keylocation != NULL) | |
1850 | return (SET_ERROR(EINVAL)); | |
1851 | ||
1852 | /* parent must have a key to inherit */ | |
1853 | if (pcrypt == ZIO_CRYPT_OFF) | |
1854 | return (SET_ERROR(EINVAL)); | |
1855 | ||
1856 | /* check for parent key */ | |
1857 | ret = dmu_objset_check_wkey_loaded(parentdd); | |
1858 | if (ret != 0) | |
1859 | return (ret); | |
1860 | ||
1861 | return (0); | |
1862 | } | |
1863 | ||
1864 | /* At this point we should have a fully specified key. Check location */ | |
1865 | if (dcp->cp_keylocation == NULL || | |
1866 | !zfs_prop_valid_keylocation(dcp->cp_keylocation, B_TRUE)) | |
1867 | return (SET_ERROR(EINVAL)); | |
1868 | ||
1869 | /* Must have fully specified keyformat */ | |
1870 | switch (dcp->cp_wkey->wk_keyformat) { | |
1871 | case ZFS_KEYFORMAT_HEX: | |
1872 | case ZFS_KEYFORMAT_RAW: | |
1873 | /* requires no pbkdf2 iters and salt */ | |
1874 | if (dcp->cp_wkey->wk_salt != 0 || dcp->cp_wkey->wk_iters != 0) | |
1875 | return (SET_ERROR(EINVAL)); | |
1876 | break; | |
1877 | case ZFS_KEYFORMAT_PASSPHRASE: | |
1878 | /* requires pbkdf2 iters and salt */ | |
1879 | if (dcp->cp_wkey->wk_salt == 0 || | |
1880 | dcp->cp_wkey->wk_iters < MIN_PBKDF2_ITERATIONS) | |
1881 | return (SET_ERROR(EINVAL)); | |
1882 | break; | |
1883 | case ZFS_KEYFORMAT_NONE: | |
1884 | default: | |
1885 | /* keyformat must be specified and valid */ | |
1886 | return (SET_ERROR(EINVAL)); | |
1887 | } | |
1888 | ||
1889 | return (0); | |
1890 | } | |
1891 | ||
1892 | void | |
1893 | dsl_dataset_create_crypt_sync(uint64_t dsobj, dsl_dir_t *dd, | |
1894 | dsl_dataset_t *origin, dsl_crypto_params_t *dcp, dmu_tx_t *tx) | |
1895 | { | |
1896 | dsl_pool_t *dp = dd->dd_pool; | |
1897 | uint64_t crypt; | |
1898 | dsl_wrapping_key_t *wkey; | |
1899 | ||
1900 | /* clones always use their origin's wrapping key */ | |
1901 | if (dsl_dir_is_clone(dd)) { | |
1902 | ASSERT3P(dcp, ==, NULL); | |
1903 | ||
1904 | /* | |
1905 | * If this is an encrypted clone we just need to clone the | |
1906 | * dck into dd. Zapify the dd so we can do that. | |
1907 | */ | |
1908 | if (origin->ds_dir->dd_crypto_obj != 0) { | |
1909 | dmu_buf_will_dirty(dd->dd_dbuf, tx); | |
1910 | dsl_dir_zapify(dd, tx); | |
1911 | ||
1912 | dd->dd_crypto_obj = | |
1913 | dsl_crypto_key_clone_sync(origin->ds_dir, tx); | |
1914 | VERIFY0(zap_add(dp->dp_meta_objset, dd->dd_object, | |
1915 | DD_FIELD_CRYPTO_KEY_OBJ, sizeof (uint64_t), 1, | |
1916 | &dd->dd_crypto_obj, tx)); | |
1917 | } | |
1918 | ||
1919 | return; | |
1920 | } | |
1921 | ||
1922 | /* | |
1923 | * A NULL dcp at this point indicates this is the origin dataset | |
1924 | * which does not have an objset to encrypt. Raw receives will handle | |
b0918402 | 1925 | * encryption separately later. In both cases we can simply return. |
b5256303 TC |
1926 | */ |
1927 | if (dcp == NULL || dcp->cp_cmd == DCP_CMD_RAW_RECV) | |
1928 | return; | |
1929 | ||
1930 | crypt = dcp->cp_crypt; | |
1931 | wkey = dcp->cp_wkey; | |
1932 | ||
1933 | /* figure out the effective crypt */ | |
1934 | if (crypt == ZIO_CRYPT_INHERIT && dd->dd_parent != NULL) | |
1935 | VERIFY0(dsl_dir_get_crypt(dd->dd_parent, &crypt)); | |
1936 | ||
1937 | /* if we aren't doing encryption just return */ | |
1938 | if (crypt == ZIO_CRYPT_OFF || crypt == ZIO_CRYPT_INHERIT) | |
1939 | return; | |
1940 | ||
1941 | /* zapify the dd so that we can add the crypto key obj to it */ | |
1942 | dmu_buf_will_dirty(dd->dd_dbuf, tx); | |
1943 | dsl_dir_zapify(dd, tx); | |
1944 | ||
1945 | /* use the new key if given or inherit from the parent */ | |
1946 | if (wkey == NULL) { | |
1947 | VERIFY0(spa_keystore_wkey_hold_dd(dp->dp_spa, | |
1948 | dd->dd_parent, FTAG, &wkey)); | |
1949 | } else { | |
1950 | wkey->wk_ddobj = dd->dd_object; | |
1951 | } | |
1952 | ||
4807c0ba TC |
1953 | ASSERT3P(wkey, !=, NULL); |
1954 | ||
b5256303 TC |
1955 | /* Create or clone the DSL crypto key and activate the feature */ |
1956 | dd->dd_crypto_obj = dsl_crypto_key_create_sync(crypt, wkey, tx); | |
1957 | VERIFY0(zap_add(dp->dp_meta_objset, dd->dd_object, | |
1958 | DD_FIELD_CRYPTO_KEY_OBJ, sizeof (uint64_t), 1, &dd->dd_crypto_obj, | |
1959 | tx)); | |
d52d80b7 PD |
1960 | dsl_dataset_activate_feature(dsobj, SPA_FEATURE_ENCRYPTION, |
1961 | (void *)B_TRUE, tx); | |
b5256303 TC |
1962 | |
1963 | /* | |
1964 | * If we inherited the wrapping key we release our reference now. | |
1965 | * Otherwise, this is a new key and we need to load it into the | |
1966 | * keystore. | |
1967 | */ | |
1968 | if (dcp->cp_wkey == NULL) { | |
1969 | dsl_wrapping_key_rele(wkey, FTAG); | |
1970 | } else { | |
1971 | VERIFY0(spa_keystore_load_wkey_impl(dp->dp_spa, wkey)); | |
1972 | } | |
1973 | } | |
1974 | ||
1975 | typedef struct dsl_crypto_recv_key_arg { | |
1976 | uint64_t dcrka_dsobj; | |
f00ab3f2 | 1977 | uint64_t dcrka_fromobj; |
b5256303 | 1978 | dmu_objset_type_t dcrka_ostype; |
b0918402 TC |
1979 | nvlist_t *dcrka_nvl; |
1980 | boolean_t dcrka_do_key; | |
b5256303 TC |
1981 | } dsl_crypto_recv_key_arg_t; |
1982 | ||
b0918402 | 1983 | static int |
f00ab3f2 TC |
1984 | dsl_crypto_recv_raw_objset_check(dsl_dataset_t *ds, dsl_dataset_t *fromds, |
1985 | dmu_objset_type_t ostype, nvlist_t *nvl, dmu_tx_t *tx) | |
b5256303 TC |
1986 | { |
1987 | int ret; | |
b5256303 TC |
1988 | objset_t *os; |
1989 | dnode_t *mdn; | |
b5256303 TC |
1990 | uint8_t *buf = NULL; |
1991 | uint_t len; | |
f00ab3f2 TC |
1992 | uint64_t intval, nlevels, blksz, ibs; |
1993 | uint64_t nblkptr, maxblkid; | |
b5256303 | 1994 | |
b0918402 TC |
1995 | if (ostype != DMU_OST_ZFS && ostype != DMU_OST_ZVOL) |
1996 | return (SET_ERROR(EINVAL)); | |
b5256303 TC |
1997 | |
1998 | /* raw receives also need info about the structure of the metadnode */ | |
b5256303 | 1999 | ret = nvlist_lookup_uint64(nvl, "mdn_compress", &intval); |
b0918402 TC |
2000 | if (ret != 0 || intval >= ZIO_COMPRESS_LEGACY_FUNCTIONS) |
2001 | return (SET_ERROR(EINVAL)); | |
2002 | ||
2003 | ret = nvlist_lookup_uint64(nvl, "mdn_checksum", &intval); | |
2004 | if (ret != 0 || intval >= ZIO_CHECKSUM_LEGACY_FUNCTIONS) | |
2005 | return (SET_ERROR(EINVAL)); | |
b5256303 TC |
2006 | |
2007 | ret = nvlist_lookup_uint64(nvl, "mdn_nlevels", &nlevels); | |
b0918402 TC |
2008 | if (ret != 0 || nlevels > DN_MAX_LEVELS) |
2009 | return (SET_ERROR(EINVAL)); | |
b5256303 TC |
2010 | |
2011 | ret = nvlist_lookup_uint64(nvl, "mdn_blksz", &blksz); | |
b0918402 TC |
2012 | if (ret != 0 || blksz < SPA_MINBLOCKSIZE) |
2013 | return (SET_ERROR(EINVAL)); | |
2014 | else if (blksz > spa_maxblocksize(tx->tx_pool->dp_spa)) | |
2015 | return (SET_ERROR(ENOTSUP)); | |
b5256303 TC |
2016 | |
2017 | ret = nvlist_lookup_uint64(nvl, "mdn_indblkshift", &ibs); | |
b0918402 TC |
2018 | if (ret != 0 || ibs < DN_MIN_INDBLKSHIFT || ibs > DN_MAX_INDBLKSHIFT) |
2019 | return (SET_ERROR(ENOTSUP)); | |
b5256303 TC |
2020 | |
2021 | ret = nvlist_lookup_uint64(nvl, "mdn_nblkptr", &nblkptr); | |
b0918402 TC |
2022 | if (ret != 0 || nblkptr != DN_MAX_NBLKPTR) |
2023 | return (SET_ERROR(ENOTSUP)); | |
b5256303 | 2024 | |
ae76f45c | 2025 | ret = nvlist_lookup_uint64(nvl, "mdn_maxblkid", &maxblkid); |
b0918402 TC |
2026 | if (ret != 0) |
2027 | return (SET_ERROR(EINVAL)); | |
2028 | ||
2029 | ret = nvlist_lookup_uint8_array(nvl, "portable_mac", &buf, &len); | |
2030 | if (ret != 0 || len != ZIO_OBJSET_MAC_LEN) | |
2031 | return (SET_ERROR(EINVAL)); | |
ae76f45c | 2032 | |
b5256303 TC |
2033 | ret = dmu_objset_from_ds(ds, &os); |
2034 | if (ret != 0) | |
b0918402 | 2035 | return (ret); |
b5256303 TC |
2036 | |
2037 | /* | |
2038 | * Useraccounting is not portable and must be done with the keys loaded. | |
2039 | * Therefore, whenever we do any kind of receive the useraccounting | |
2040 | * must not be present. | |
2041 | */ | |
2042 | ASSERT0(os->os_flags & OBJSET_FLAG_USERACCOUNTING_COMPLETE); | |
2043 | ASSERT0(os->os_flags & OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE); | |
2044 | ||
2045 | mdn = DMU_META_DNODE(os); | |
2046 | ||
2047 | /* | |
b0918402 | 2048 | * If we already created the objset, make sure its unchangeable |
b5256303 TC |
2049 | * properties match the ones received in the nvlist. |
2050 | */ | |
2051 | rrw_enter(&ds->ds_bp_rwlock, RW_READER, FTAG); | |
2052 | if (!BP_IS_HOLE(dsl_dataset_get_blkptr(ds)) && | |
2053 | (mdn->dn_nlevels != nlevels || mdn->dn_datablksz != blksz || | |
2054 | mdn->dn_indblkshift != ibs || mdn->dn_nblkptr != nblkptr)) { | |
b0918402 TC |
2055 | rrw_exit(&ds->ds_bp_rwlock, FTAG); |
2056 | return (SET_ERROR(EINVAL)); | |
b5256303 TC |
2057 | } |
2058 | rrw_exit(&ds->ds_bp_rwlock, FTAG); | |
2059 | ||
f00ab3f2 TC |
2060 | /* |
2061 | * Check that the ivset guid of the fromds matches the one from the | |
2062 | * send stream. Older versions of the encryption code did not have | |
2063 | * an ivset guid on the from dataset and did not send one in the | |
2064 | * stream. For these streams we provide the | |
2065 | * zfs_disable_ivset_guid_check tunable to allow these datasets to | |
2066 | * be received with a generated ivset guid. | |
2067 | */ | |
2068 | if (fromds != NULL && !zfs_disable_ivset_guid_check) { | |
2069 | uint64_t from_ivset_guid = 0; | |
2070 | intval = 0; | |
2071 | ||
2072 | (void) nvlist_lookup_uint64(nvl, "from_ivset_guid", &intval); | |
2073 | (void) zap_lookup(tx->tx_pool->dp_meta_objset, | |
2074 | fromds->ds_object, DS_FIELD_IVSET_GUID, | |
2075 | sizeof (from_ivset_guid), 1, &from_ivset_guid); | |
2076 | ||
2077 | if (intval == 0 || from_ivset_guid == 0) | |
2078 | return (SET_ERROR(ZFS_ERR_FROM_IVSET_GUID_MISSING)); | |
2079 | ||
2080 | if (intval != from_ivset_guid) | |
2081 | return (SET_ERROR(ZFS_ERR_FROM_IVSET_GUID_MISMATCH)); | |
2082 | } | |
2083 | ||
b5256303 | 2084 | return (0); |
b5256303 TC |
2085 | } |
2086 | ||
2087 | static void | |
b0918402 TC |
2088 | dsl_crypto_recv_raw_objset_sync(dsl_dataset_t *ds, dmu_objset_type_t ostype, |
2089 | nvlist_t *nvl, dmu_tx_t *tx) | |
b5256303 | 2090 | { |
b5256303 | 2091 | dsl_pool_t *dp = tx->tx_pool; |
b5256303 TC |
2092 | objset_t *os; |
2093 | dnode_t *mdn; | |
b0918402 TC |
2094 | zio_t *zio; |
2095 | uint8_t *portable_mac; | |
b5256303 | 2096 | uint_t len; |
ae76f45c | 2097 | uint64_t compress, checksum, nlevels, blksz, ibs, maxblkid; |
b0918402 | 2098 | boolean_t newds = B_FALSE; |
b5256303 | 2099 | |
b5256303 TC |
2100 | VERIFY0(dmu_objset_from_ds(ds, &os)); |
2101 | mdn = DMU_META_DNODE(os); | |
2102 | ||
f00ab3f2 TC |
2103 | /* |
2104 | * Fetch the values we need from the nvlist. "to_ivset_guid" must | |
2105 | * be set on the snapshot, which doesn't exist yet. The receive | |
2106 | * code will take care of this for us later. | |
2107 | */ | |
b5256303 TC |
2108 | compress = fnvlist_lookup_uint64(nvl, "mdn_compress"); |
2109 | checksum = fnvlist_lookup_uint64(nvl, "mdn_checksum"); | |
2110 | nlevels = fnvlist_lookup_uint64(nvl, "mdn_nlevels"); | |
2111 | blksz = fnvlist_lookup_uint64(nvl, "mdn_blksz"); | |
2112 | ibs = fnvlist_lookup_uint64(nvl, "mdn_indblkshift"); | |
ae76f45c | 2113 | maxblkid = fnvlist_lookup_uint64(nvl, "mdn_maxblkid"); |
b0918402 TC |
2114 | VERIFY0(nvlist_lookup_uint8_array(nvl, "portable_mac", &portable_mac, |
2115 | &len)); | |
b5256303 TC |
2116 | |
2117 | /* if we haven't created an objset for the ds yet, do that now */ | |
2118 | rrw_enter(&ds->ds_bp_rwlock, RW_READER, FTAG); | |
2119 | if (BP_IS_HOLE(dsl_dataset_get_blkptr(ds))) { | |
2120 | (void) dmu_objset_create_impl_dnstats(dp->dp_spa, ds, | |
b0918402 TC |
2121 | dsl_dataset_get_blkptr(ds), ostype, nlevels, blksz, |
2122 | ibs, tx); | |
2123 | newds = B_TRUE; | |
b5256303 TC |
2124 | } |
2125 | rrw_exit(&ds->ds_bp_rwlock, FTAG); | |
2126 | ||
2127 | /* | |
2128 | * Set the portable MAC. The local MAC will always be zero since the | |
2129 | * incoming data will all be portable and user accounting will be | |
2130 | * deferred until the next mount. Afterwards, flag the os to be | |
2131 | * written out raw next time. | |
2132 | */ | |
2133 | arc_release(os->os_phys_buf, &os->os_phys_buf); | |
2134 | bcopy(portable_mac, os->os_phys->os_portable_mac, ZIO_OBJSET_MAC_LEN); | |
2135 | bzero(os->os_phys->os_local_mac, ZIO_OBJSET_MAC_LEN); | |
1b66810b | 2136 | os->os_next_write_raw[tx->tx_txg & TXG_MASK] = B_TRUE; |
b5256303 TC |
2137 | |
2138 | /* set metadnode compression and checksum */ | |
2139 | mdn->dn_compress = compress; | |
2140 | mdn->dn_checksum = checksum; | |
ae76f45c TC |
2141 | |
2142 | rw_enter(&mdn->dn_struct_rwlock, RW_WRITER); | |
369aa501 | 2143 | dnode_new_blkid(mdn, maxblkid, tx, B_FALSE, B_TRUE); |
ae76f45c TC |
2144 | rw_exit(&mdn->dn_struct_rwlock); |
2145 | ||
b0918402 TC |
2146 | /* |
2147 | * We can't normally dirty the dataset in syncing context unless | |
2148 | * we are creating a new dataset. In this case, we perform a | |
2149 | * pseudo txg sync here instead. | |
2150 | */ | |
2151 | if (newds) { | |
2152 | dsl_dataset_dirty(ds, tx); | |
2153 | } else { | |
2154 | zio = zio_root(dp->dp_spa, NULL, NULL, ZIO_FLAG_MUSTSUCCEED); | |
2155 | dsl_dataset_sync(ds, zio, tx); | |
2156 | VERIFY0(zio_wait(zio)); | |
2157 | ||
2158 | /* dsl_dataset_sync_done will drop this reference. */ | |
2159 | dmu_buf_add_ref(ds->ds_dbuf, ds); | |
2160 | dsl_dataset_sync_done(ds, tx); | |
2161 | } | |
2162 | } | |
2163 | ||
2164 | int | |
2165 | dsl_crypto_recv_raw_key_check(dsl_dataset_t *ds, nvlist_t *nvl, dmu_tx_t *tx) | |
2166 | { | |
2167 | int ret; | |
2168 | objset_t *mos = tx->tx_pool->dp_meta_objset; | |
2169 | uint8_t *buf = NULL; | |
2170 | uint_t len; | |
f00ab3f2 | 2171 | uint64_t intval, key_guid, version; |
b0918402 TC |
2172 | boolean_t is_passphrase = B_FALSE; |
2173 | ||
2174 | ASSERT(dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT); | |
2175 | ||
2176 | /* | |
2177 | * Read and check all the encryption values from the nvlist. We need | |
2178 | * all of the fields of a DSL Crypto Key, as well as a fully specified | |
2179 | * wrapping key. | |
2180 | */ | |
2181 | ret = nvlist_lookup_uint64(nvl, DSL_CRYPTO_KEY_CRYPTO_SUITE, &intval); | |
2182 | if (ret != 0 || intval >= ZIO_CRYPT_FUNCTIONS || | |
2183 | intval <= ZIO_CRYPT_OFF) | |
2184 | return (SET_ERROR(EINVAL)); | |
2185 | ||
2186 | ret = nvlist_lookup_uint64(nvl, DSL_CRYPTO_KEY_GUID, &intval); | |
2187 | if (ret != 0) | |
2188 | return (SET_ERROR(EINVAL)); | |
2189 | ||
2190 | /* | |
2191 | * If this is an incremental receive make sure the given key guid | |
2192 | * matches the one we already have. | |
2193 | */ | |
2194 | if (ds->ds_dir->dd_crypto_obj != 0) { | |
2195 | ret = zap_lookup(mos, ds->ds_dir->dd_crypto_obj, | |
f00ab3f2 | 2196 | DSL_CRYPTO_KEY_GUID, 8, 1, &key_guid); |
b0918402 TC |
2197 | if (ret != 0) |
2198 | return (ret); | |
f00ab3f2 | 2199 | if (intval != key_guid) |
b0918402 TC |
2200 | return (SET_ERROR(EACCES)); |
2201 | } | |
2202 | ||
2203 | ret = nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_MASTER_KEY, | |
2204 | &buf, &len); | |
2205 | if (ret != 0 || len != MASTER_KEY_MAX_LEN) | |
2206 | return (SET_ERROR(EINVAL)); | |
2207 | ||
2208 | ret = nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_HMAC_KEY, | |
2209 | &buf, &len); | |
2210 | if (ret != 0 || len != SHA512_HMAC_KEYLEN) | |
2211 | return (SET_ERROR(EINVAL)); | |
2212 | ||
2213 | ret = nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_IV, &buf, &len); | |
2214 | if (ret != 0 || len != WRAPPING_IV_LEN) | |
2215 | return (SET_ERROR(EINVAL)); | |
2216 | ||
2217 | ret = nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_MAC, &buf, &len); | |
2218 | if (ret != 0 || len != WRAPPING_MAC_LEN) | |
2219 | return (SET_ERROR(EINVAL)); | |
2220 | ||
2221 | /* | |
2222 | * We don't support receiving old on-disk formats. The version 0 | |
2223 | * implementation protected several fields in an objset that were | |
2224 | * not always portable during a raw receive. As a result, we call | |
2225 | * the old version an on-disk errata #3. | |
2226 | */ | |
2227 | ret = nvlist_lookup_uint64(nvl, DSL_CRYPTO_KEY_VERSION, &version); | |
2228 | if (ret != 0 || version != ZIO_CRYPT_KEY_CURRENT_VERSION) | |
2229 | return (SET_ERROR(ENOTSUP)); | |
2230 | ||
2231 | ret = nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_KEYFORMAT), | |
2232 | &intval); | |
2233 | if (ret != 0 || intval >= ZFS_KEYFORMAT_FORMATS || | |
2234 | intval == ZFS_KEYFORMAT_NONE) | |
2235 | return (SET_ERROR(EINVAL)); | |
2236 | ||
2237 | is_passphrase = (intval == ZFS_KEYFORMAT_PASSPHRASE); | |
2238 | ||
2239 | /* | |
2240 | * for raw receives we allow any number of pbkdf2iters since there | |
2241 | * won't be a chance for the user to change it. | |
2242 | */ | |
2243 | ret = nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), | |
2244 | &intval); | |
2245 | if (ret != 0 || (is_passphrase == (intval == 0))) | |
2246 | return (SET_ERROR(EINVAL)); | |
2247 | ||
2248 | ret = nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), | |
2249 | &intval); | |
2250 | if (ret != 0 || (is_passphrase == (intval == 0))) | |
2251 | return (SET_ERROR(EINVAL)); | |
2252 | ||
2253 | return (0); | |
2254 | } | |
2255 | ||
2256 | void | |
2257 | dsl_crypto_recv_raw_key_sync(dsl_dataset_t *ds, nvlist_t *nvl, dmu_tx_t *tx) | |
2258 | { | |
2259 | dsl_pool_t *dp = tx->tx_pool; | |
2260 | objset_t *mos = dp->dp_meta_objset; | |
2261 | dsl_dir_t *dd = ds->ds_dir; | |
2262 | uint_t len; | |
2263 | uint64_t rddobj, one = 1; | |
2264 | uint8_t *keydata, *hmac_keydata, *iv, *mac; | |
f00ab3f2 | 2265 | uint64_t crypt, key_guid, keyformat, iters, salt; |
b0918402 TC |
2266 | uint64_t version = ZIO_CRYPT_KEY_CURRENT_VERSION; |
2267 | char *keylocation = "prompt"; | |
2268 | ||
2269 | /* lookup the values we need to create the DSL Crypto Key */ | |
2270 | crypt = fnvlist_lookup_uint64(nvl, DSL_CRYPTO_KEY_CRYPTO_SUITE); | |
f00ab3f2 | 2271 | key_guid = fnvlist_lookup_uint64(nvl, DSL_CRYPTO_KEY_GUID); |
b0918402 TC |
2272 | keyformat = fnvlist_lookup_uint64(nvl, |
2273 | zfs_prop_to_name(ZFS_PROP_KEYFORMAT)); | |
2274 | iters = fnvlist_lookup_uint64(nvl, | |
2275 | zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS)); | |
2276 | salt = fnvlist_lookup_uint64(nvl, | |
2277 | zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT)); | |
2278 | VERIFY0(nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_MASTER_KEY, | |
2279 | &keydata, &len)); | |
2280 | VERIFY0(nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_HMAC_KEY, | |
2281 | &hmac_keydata, &len)); | |
2282 | VERIFY0(nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_IV, &iv, &len)); | |
2283 | VERIFY0(nvlist_lookup_uint8_array(nvl, DSL_CRYPTO_KEY_MAC, &mac, &len)); | |
b5256303 TC |
2284 | |
2285 | /* if this is a new dataset setup the DSL Crypto Key. */ | |
b0918402 | 2286 | if (dd->dd_crypto_obj == 0) { |
b5256303 | 2287 | /* zapify the dsl dir so we can add the key object to it */ |
b0918402 TC |
2288 | dmu_buf_will_dirty(dd->dd_dbuf, tx); |
2289 | dsl_dir_zapify(dd, tx); | |
b5256303 TC |
2290 | |
2291 | /* create the DSL Crypto Key on disk and activate the feature */ | |
b0918402 | 2292 | dd->dd_crypto_obj = zap_create(mos, |
b5256303 TC |
2293 | DMU_OTN_ZAP_METADATA, DMU_OT_NONE, 0, tx); |
2294 | VERIFY0(zap_update(tx->tx_pool->dp_meta_objset, | |
b0918402 | 2295 | dd->dd_crypto_obj, DSL_CRYPTO_KEY_REFCOUNT, |
b5256303 | 2296 | sizeof (uint64_t), 1, &one, tx)); |
ae76f45c | 2297 | VERIFY0(zap_update(tx->tx_pool->dp_meta_objset, |
b0918402 | 2298 | dd->dd_crypto_obj, DSL_CRYPTO_KEY_VERSION, |
ae76f45c | 2299 | sizeof (uint64_t), 1, &version, tx)); |
b5256303 | 2300 | |
b0918402 | 2301 | dsl_dataset_activate_feature(ds->ds_object, |
d52d80b7 PD |
2302 | SPA_FEATURE_ENCRYPTION, (void *)B_TRUE, tx); |
2303 | ds->ds_feature[SPA_FEATURE_ENCRYPTION] = (void *)B_TRUE; | |
b5256303 TC |
2304 | |
2305 | /* save the dd_crypto_obj on disk */ | |
b0918402 TC |
2306 | VERIFY0(zap_add(mos, dd->dd_object, DD_FIELD_CRYPTO_KEY_OBJ, |
2307 | sizeof (uint64_t), 1, &dd->dd_crypto_obj, tx)); | |
b5256303 TC |
2308 | |
2309 | /* | |
2310 | * Set the keylocation to prompt by default. If keylocation | |
b0918402 | 2311 | * has been provided via the properties, this will be overridden |
b5256303 TC |
2312 | * later. |
2313 | */ | |
2314 | dsl_prop_set_sync_impl(ds, | |
2315 | zfs_prop_to_name(ZFS_PROP_KEYLOCATION), | |
2316 | ZPROP_SRC_LOCAL, 1, strlen(keylocation) + 1, | |
2317 | keylocation, tx); | |
2318 | ||
b0918402 | 2319 | rddobj = dd->dd_object; |
b5256303 | 2320 | } else { |
b0918402 | 2321 | VERIFY0(dsl_dir_get_encryption_root_ddobj(dd, &rddobj)); |
b5256303 TC |
2322 | } |
2323 | ||
2324 | /* sync the key data to the ZAP object on disk */ | |
b0918402 | 2325 | dsl_crypto_key_sync_impl(mos, dd->dd_crypto_obj, crypt, |
f00ab3f2 | 2326 | rddobj, key_guid, iv, mac, keydata, hmac_keydata, keyformat, salt, |
b5256303 | 2327 | iters, tx); |
b0918402 | 2328 | } |
b5256303 | 2329 | |
b0918402 TC |
2330 | int |
2331 | dsl_crypto_recv_key_check(void *arg, dmu_tx_t *tx) | |
2332 | { | |
2333 | int ret; | |
2334 | dsl_crypto_recv_key_arg_t *dcrka = arg; | |
f00ab3f2 | 2335 | dsl_dataset_t *ds = NULL, *fromds = NULL; |
b0918402 TC |
2336 | |
2337 | ret = dsl_dataset_hold_obj(tx->tx_pool, dcrka->dcrka_dsobj, | |
2338 | FTAG, &ds); | |
2339 | if (ret != 0) | |
f00ab3f2 | 2340 | goto out; |
b0918402 | 2341 | |
f00ab3f2 TC |
2342 | if (dcrka->dcrka_fromobj != 0) { |
2343 | ret = dsl_dataset_hold_obj(tx->tx_pool, dcrka->dcrka_fromobj, | |
2344 | FTAG, &fromds); | |
2345 | if (ret != 0) | |
2346 | goto out; | |
2347 | } | |
2348 | ||
2349 | ret = dsl_crypto_recv_raw_objset_check(ds, fromds, | |
b0918402 TC |
2350 | dcrka->dcrka_ostype, dcrka->dcrka_nvl, tx); |
2351 | if (ret != 0) | |
f00ab3f2 | 2352 | goto out; |
b0918402 TC |
2353 | |
2354 | /* | |
2355 | * We run this check even if we won't be doing this part of | |
2356 | * the receive now so that we don't make the user wait until | |
2357 | * the receive finishes to fail. | |
2358 | */ | |
2359 | ret = dsl_crypto_recv_raw_key_check(ds, dcrka->dcrka_nvl, tx); | |
2360 | if (ret != 0) | |
f00ab3f2 | 2361 | goto out; |
b0918402 | 2362 | |
f00ab3f2 | 2363 | out: |
b0918402 TC |
2364 | if (ds != NULL) |
2365 | dsl_dataset_rele(ds, FTAG); | |
f00ab3f2 TC |
2366 | if (fromds != NULL) |
2367 | dsl_dataset_rele(fromds, FTAG); | |
b0918402 TC |
2368 | return (ret); |
2369 | } | |
2370 | ||
2371 | void | |
2372 | dsl_crypto_recv_key_sync(void *arg, dmu_tx_t *tx) | |
2373 | { | |
2374 | dsl_crypto_recv_key_arg_t *dcrka = arg; | |
2375 | dsl_dataset_t *ds; | |
2376 | ||
2377 | VERIFY0(dsl_dataset_hold_obj(tx->tx_pool, dcrka->dcrka_dsobj, | |
2378 | FTAG, &ds)); | |
2379 | dsl_crypto_recv_raw_objset_sync(ds, dcrka->dcrka_ostype, | |
2380 | dcrka->dcrka_nvl, tx); | |
2381 | if (dcrka->dcrka_do_key) | |
2382 | dsl_crypto_recv_raw_key_sync(ds, dcrka->dcrka_nvl, tx); | |
b5256303 TC |
2383 | dsl_dataset_rele(ds, FTAG); |
2384 | } | |
2385 | ||
2386 | /* | |
2387 | * This function is used to sync an nvlist representing a DSL Crypto Key and | |
2388 | * the associated encryption parameters. The key will be written exactly as is | |
2389 | * without wrapping it. | |
2390 | */ | |
2391 | int | |
f00ab3f2 | 2392 | dsl_crypto_recv_raw(const char *poolname, uint64_t dsobj, uint64_t fromobj, |
b0918402 | 2393 | dmu_objset_type_t ostype, nvlist_t *nvl, boolean_t do_key) |
b5256303 TC |
2394 | { |
2395 | dsl_crypto_recv_key_arg_t dcrka; | |
2396 | ||
2397 | dcrka.dcrka_dsobj = dsobj; | |
f00ab3f2 | 2398 | dcrka.dcrka_fromobj = fromobj; |
b5256303 | 2399 | dcrka.dcrka_ostype = ostype; |
b0918402 TC |
2400 | dcrka.dcrka_nvl = nvl; |
2401 | dcrka.dcrka_do_key = do_key; | |
b5256303 TC |
2402 | |
2403 | return (dsl_sync_task(poolname, dsl_crypto_recv_key_check, | |
2404 | dsl_crypto_recv_key_sync, &dcrka, 1, ZFS_SPACE_CHECK_NORMAL)); | |
2405 | } | |
2406 | ||
2407 | int | |
f00ab3f2 TC |
2408 | dsl_crypto_populate_key_nvlist(dsl_dataset_t *ds, uint64_t from_ivset_guid, |
2409 | nvlist_t **nvl_out) | |
b5256303 TC |
2410 | { |
2411 | int ret; | |
2412 | objset_t *os; | |
2413 | dnode_t *mdn; | |
2414 | uint64_t rddobj; | |
2415 | nvlist_t *nvl = NULL; | |
2416 | uint64_t dckobj = ds->ds_dir->dd_crypto_obj; | |
2637dda8 | 2417 | dsl_dir_t *rdd = NULL; |
b5256303 TC |
2418 | dsl_pool_t *dp = ds->ds_dir->dd_pool; |
2419 | objset_t *mos = dp->dp_meta_objset; | |
f00ab3f2 | 2420 | uint64_t crypt = 0, key_guid = 0, format = 0; |
ae76f45c | 2421 | uint64_t iters = 0, salt = 0, version = 0; |
f00ab3f2 | 2422 | uint64_t to_ivset_guid = 0; |
b5256303 TC |
2423 | uint8_t raw_keydata[MASTER_KEY_MAX_LEN]; |
2424 | uint8_t raw_hmac_keydata[SHA512_HMAC_KEYLEN]; | |
2425 | uint8_t iv[WRAPPING_IV_LEN]; | |
2426 | uint8_t mac[WRAPPING_MAC_LEN]; | |
2427 | ||
2428 | ASSERT(dckobj != 0); | |
2429 | ||
2430 | VERIFY0(dmu_objset_from_ds(ds, &os)); | |
2431 | mdn = DMU_META_DNODE(os); | |
2432 | ||
2433 | ret = nvlist_alloc(&nvl, NV_UNIQUE_NAME, KM_SLEEP); | |
2434 | if (ret != 0) | |
2435 | goto error; | |
2436 | ||
2437 | /* lookup values from the DSL Crypto Key */ | |
b5256303 TC |
2438 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_CRYPTO_SUITE, 8, 1, |
2439 | &crypt); | |
2440 | if (ret != 0) | |
2441 | goto error; | |
2442 | ||
f00ab3f2 | 2443 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_GUID, 8, 1, &key_guid); |
b5256303 TC |
2444 | if (ret != 0) |
2445 | goto error; | |
2446 | ||
2447 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_MASTER_KEY, 1, | |
2448 | MASTER_KEY_MAX_LEN, raw_keydata); | |
2449 | if (ret != 0) | |
2450 | goto error; | |
2451 | ||
2452 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_HMAC_KEY, 1, | |
2453 | SHA512_HMAC_KEYLEN, raw_hmac_keydata); | |
2454 | if (ret != 0) | |
2455 | goto error; | |
2456 | ||
2457 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_IV, 1, WRAPPING_IV_LEN, | |
2458 | iv); | |
2459 | if (ret != 0) | |
2460 | goto error; | |
2461 | ||
2462 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_MAC, 1, WRAPPING_MAC_LEN, | |
2463 | mac); | |
2464 | if (ret != 0) | |
2465 | goto error; | |
2466 | ||
f00ab3f2 TC |
2467 | /* see zfs_disable_ivset_guid_check tunable for errata info */ |
2468 | ret = zap_lookup(mos, ds->ds_object, DS_FIELD_IVSET_GUID, 8, 1, | |
2469 | &to_ivset_guid); | |
2470 | if (ret != 0) | |
2471 | ASSERT3U(dp->dp_spa->spa_errata, !=, 0); | |
2472 | ||
ae76f45c TC |
2473 | /* |
2474 | * We don't support raw sends of legacy on-disk formats. See the | |
2475 | * comment in dsl_crypto_recv_key_check() for details. | |
2476 | */ | |
2477 | ret = zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_VERSION, 8, 1, &version); | |
2478 | if (ret != 0 || version != ZIO_CRYPT_KEY_CURRENT_VERSION) { | |
2479 | dp->dp_spa->spa_errata = ZPOOL_ERRATA_ZOL_6845_ENCRYPTION; | |
2480 | ret = SET_ERROR(ENOTSUP); | |
2481 | goto error; | |
2482 | } | |
2483 | ||
2637dda8 TC |
2484 | /* |
2485 | * Lookup wrapping key properties. An early version of the code did | |
2486 | * not correctly add these values to the wrapping key or the DSL | |
2487 | * Crypto Key on disk for non encryption roots, so to be safe we | |
2488 | * always take the slightly circuitous route of looking it up from | |
2489 | * the encryption root's key. | |
2490 | */ | |
2491 | ret = dsl_dir_get_encryption_root_ddobj(ds->ds_dir, &rddobj); | |
b5256303 TC |
2492 | if (ret != 0) |
2493 | goto error; | |
2494 | ||
2637dda8 TC |
2495 | dsl_pool_config_enter(dp, FTAG); |
2496 | ||
2497 | ret = dsl_dir_hold_obj(dp, rddobj, NULL, FTAG, &rdd); | |
2498 | if (ret != 0) | |
2499 | goto error_unlock; | |
2500 | ||
2501 | ret = zap_lookup(dp->dp_meta_objset, rdd->dd_crypto_obj, | |
2502 | zfs_prop_to_name(ZFS_PROP_KEYFORMAT), 8, 1, &format); | |
2503 | if (ret != 0) | |
2504 | goto error_unlock; | |
2505 | ||
b5256303 | 2506 | if (format == ZFS_KEYFORMAT_PASSPHRASE) { |
2637dda8 | 2507 | ret = zap_lookup(dp->dp_meta_objset, rdd->dd_crypto_obj, |
b5256303 TC |
2508 | zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), 8, 1, &iters); |
2509 | if (ret != 0) | |
2637dda8 | 2510 | goto error_unlock; |
b5256303 | 2511 | |
2637dda8 | 2512 | ret = zap_lookup(dp->dp_meta_objset, rdd->dd_crypto_obj, |
b5256303 TC |
2513 | zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), 8, 1, &salt); |
2514 | if (ret != 0) | |
2637dda8 | 2515 | goto error_unlock; |
b5256303 TC |
2516 | } |
2517 | ||
2637dda8 TC |
2518 | dsl_dir_rele(rdd, FTAG); |
2519 | dsl_pool_config_exit(dp, FTAG); | |
2520 | ||
b5256303 | 2521 | fnvlist_add_uint64(nvl, DSL_CRYPTO_KEY_CRYPTO_SUITE, crypt); |
f00ab3f2 | 2522 | fnvlist_add_uint64(nvl, DSL_CRYPTO_KEY_GUID, key_guid); |
ae76f45c | 2523 | fnvlist_add_uint64(nvl, DSL_CRYPTO_KEY_VERSION, version); |
b5256303 TC |
2524 | VERIFY0(nvlist_add_uint8_array(nvl, DSL_CRYPTO_KEY_MASTER_KEY, |
2525 | raw_keydata, MASTER_KEY_MAX_LEN)); | |
2526 | VERIFY0(nvlist_add_uint8_array(nvl, DSL_CRYPTO_KEY_HMAC_KEY, | |
2527 | raw_hmac_keydata, SHA512_HMAC_KEYLEN)); | |
2528 | VERIFY0(nvlist_add_uint8_array(nvl, DSL_CRYPTO_KEY_IV, iv, | |
2529 | WRAPPING_IV_LEN)); | |
2530 | VERIFY0(nvlist_add_uint8_array(nvl, DSL_CRYPTO_KEY_MAC, mac, | |
2531 | WRAPPING_MAC_LEN)); | |
2532 | VERIFY0(nvlist_add_uint8_array(nvl, "portable_mac", | |
2533 | os->os_phys->os_portable_mac, ZIO_OBJSET_MAC_LEN)); | |
2534 | fnvlist_add_uint64(nvl, zfs_prop_to_name(ZFS_PROP_KEYFORMAT), format); | |
2535 | fnvlist_add_uint64(nvl, zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), iters); | |
2536 | fnvlist_add_uint64(nvl, zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), salt); | |
2537 | fnvlist_add_uint64(nvl, "mdn_checksum", mdn->dn_checksum); | |
2538 | fnvlist_add_uint64(nvl, "mdn_compress", mdn->dn_compress); | |
2539 | fnvlist_add_uint64(nvl, "mdn_nlevels", mdn->dn_nlevels); | |
2540 | fnvlist_add_uint64(nvl, "mdn_blksz", mdn->dn_datablksz); | |
2541 | fnvlist_add_uint64(nvl, "mdn_indblkshift", mdn->dn_indblkshift); | |
2542 | fnvlist_add_uint64(nvl, "mdn_nblkptr", mdn->dn_nblkptr); | |
ae76f45c | 2543 | fnvlist_add_uint64(nvl, "mdn_maxblkid", mdn->dn_maxblkid); |
f00ab3f2 TC |
2544 | fnvlist_add_uint64(nvl, "to_ivset_guid", to_ivset_guid); |
2545 | fnvlist_add_uint64(nvl, "from_ivset_guid", from_ivset_guid); | |
b5256303 TC |
2546 | |
2547 | *nvl_out = nvl; | |
2548 | return (0); | |
2549 | ||
2637dda8 TC |
2550 | error_unlock: |
2551 | dsl_pool_config_exit(dp, FTAG); | |
b5256303 | 2552 | error: |
2637dda8 TC |
2553 | if (rdd != NULL) |
2554 | dsl_dir_rele(rdd, FTAG); | |
b5256303 TC |
2555 | nvlist_free(nvl); |
2556 | ||
2557 | *nvl_out = NULL; | |
2558 | return (ret); | |
2559 | } | |
2560 | ||
2561 | uint64_t | |
2562 | dsl_crypto_key_create_sync(uint64_t crypt, dsl_wrapping_key_t *wkey, | |
2563 | dmu_tx_t *tx) | |
2564 | { | |
2565 | dsl_crypto_key_t dck; | |
ae76f45c TC |
2566 | uint64_t version = ZIO_CRYPT_KEY_CURRENT_VERSION; |
2567 | uint64_t one = 1ULL; | |
b5256303 TC |
2568 | |
2569 | ASSERT(dmu_tx_is_syncing(tx)); | |
2570 | ASSERT3U(crypt, <, ZIO_CRYPT_FUNCTIONS); | |
2571 | ASSERT3U(crypt, >, ZIO_CRYPT_OFF); | |
2572 | ||
2573 | /* create the DSL Crypto Key ZAP object */ | |
2574 | dck.dck_obj = zap_create(tx->tx_pool->dp_meta_objset, | |
2575 | DMU_OTN_ZAP_METADATA, DMU_OT_NONE, 0, tx); | |
2576 | ||
2577 | /* fill in the key (on the stack) and sync it to disk */ | |
2578 | dck.dck_wkey = wkey; | |
2579 | VERIFY0(zio_crypt_key_init(crypt, &dck.dck_key)); | |
2580 | ||
2581 | dsl_crypto_key_sync(&dck, tx); | |
2582 | VERIFY0(zap_update(tx->tx_pool->dp_meta_objset, dck.dck_obj, | |
2583 | DSL_CRYPTO_KEY_REFCOUNT, sizeof (uint64_t), 1, &one, tx)); | |
ae76f45c TC |
2584 | VERIFY0(zap_update(tx->tx_pool->dp_meta_objset, dck.dck_obj, |
2585 | DSL_CRYPTO_KEY_VERSION, sizeof (uint64_t), 1, &version, tx)); | |
b5256303 TC |
2586 | |
2587 | zio_crypt_key_destroy(&dck.dck_key); | |
2588 | bzero(&dck.dck_key, sizeof (zio_crypt_key_t)); | |
2589 | ||
2590 | return (dck.dck_obj); | |
2591 | } | |
2592 | ||
2593 | uint64_t | |
2594 | dsl_crypto_key_clone_sync(dsl_dir_t *origindd, dmu_tx_t *tx) | |
2595 | { | |
2596 | objset_t *mos = tx->tx_pool->dp_meta_objset; | |
2597 | ||
2598 | ASSERT(dmu_tx_is_syncing(tx)); | |
2599 | ||
2600 | VERIFY0(zap_increment(mos, origindd->dd_crypto_obj, | |
2601 | DSL_CRYPTO_KEY_REFCOUNT, 1, tx)); | |
2602 | ||
2603 | return (origindd->dd_crypto_obj); | |
2604 | } | |
2605 | ||
2606 | void | |
2607 | dsl_crypto_key_destroy_sync(uint64_t dckobj, dmu_tx_t *tx) | |
2608 | { | |
2609 | objset_t *mos = tx->tx_pool->dp_meta_objset; | |
2610 | uint64_t refcnt; | |
2611 | ||
2612 | /* Decrement the refcount, destroy if this is the last reference */ | |
2613 | VERIFY0(zap_lookup(mos, dckobj, DSL_CRYPTO_KEY_REFCOUNT, | |
2614 | sizeof (uint64_t), 1, &refcnt)); | |
2615 | ||
2616 | if (refcnt != 1) { | |
2617 | VERIFY0(zap_increment(mos, dckobj, DSL_CRYPTO_KEY_REFCOUNT, | |
2618 | -1, tx)); | |
2619 | } else { | |
2620 | VERIFY0(zap_destroy(mos, dckobj, tx)); | |
2621 | } | |
2622 | } | |
2623 | ||
2624 | void | |
2625 | dsl_dataset_crypt_stats(dsl_dataset_t *ds, nvlist_t *nv) | |
2626 | { | |
2627 | uint64_t intval; | |
2628 | dsl_dir_t *dd = ds->ds_dir; | |
2629 | dsl_dir_t *enc_root; | |
2630 | char buf[ZFS_MAX_DATASET_NAME_LEN]; | |
2631 | ||
2632 | if (dd->dd_crypto_obj == 0) | |
2633 | return; | |
2634 | ||
2635 | intval = dsl_dataset_get_keystatus(dd); | |
2636 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_KEYSTATUS, intval); | |
2637 | ||
2638 | if (dsl_dir_get_crypt(dd, &intval) == 0) | |
2639 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_ENCRYPTION, intval); | |
2640 | if (zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
2641 | DSL_CRYPTO_KEY_GUID, 8, 1, &intval) == 0) { | |
2642 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_KEY_GUID, intval); | |
2643 | } | |
2644 | if (zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
2645 | zfs_prop_to_name(ZFS_PROP_KEYFORMAT), 8, 1, &intval) == 0) { | |
2646 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_KEYFORMAT, intval); | |
2647 | } | |
2648 | if (zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
2649 | zfs_prop_to_name(ZFS_PROP_PBKDF2_SALT), 8, 1, &intval) == 0) { | |
2650 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_PBKDF2_SALT, intval); | |
2651 | } | |
2652 | if (zap_lookup(dd->dd_pool->dp_meta_objset, dd->dd_crypto_obj, | |
2653 | zfs_prop_to_name(ZFS_PROP_PBKDF2_ITERS), 8, 1, &intval) == 0) { | |
2654 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_PBKDF2_ITERS, intval); | |
2655 | } | |
f00ab3f2 TC |
2656 | if (zap_lookup(dd->dd_pool->dp_meta_objset, ds->ds_object, |
2657 | DS_FIELD_IVSET_GUID, 8, 1, &intval) == 0) { | |
2658 | dsl_prop_nvlist_add_uint64(nv, ZFS_PROP_IVSET_GUID, intval); | |
2659 | } | |
b5256303 TC |
2660 | |
2661 | if (dsl_dir_get_encryption_root_ddobj(dd, &intval) == 0) { | |
52a83dc6 TC |
2662 | if (dsl_dir_hold_obj(dd->dd_pool, intval, NULL, FTAG, |
2663 | &enc_root) == 0) { | |
2664 | dsl_dir_name(enc_root, buf); | |
2665 | dsl_dir_rele(enc_root, FTAG); | |
2666 | dsl_prop_nvlist_add_string(nv, | |
2667 | ZFS_PROP_ENCRYPTION_ROOT, buf); | |
2668 | } | |
b5256303 TC |
2669 | } |
2670 | } | |
2671 | ||
2672 | int | |
2673 | spa_crypt_get_salt(spa_t *spa, uint64_t dsobj, uint8_t *salt) | |
2674 | { | |
2675 | int ret; | |
2676 | dsl_crypto_key_t *dck = NULL; | |
2677 | ||
2678 | /* look up the key from the spa's keystore */ | |
2679 | ret = spa_keystore_lookup_key(spa, dsobj, FTAG, &dck); | |
2680 | if (ret != 0) | |
2681 | goto error; | |
2682 | ||
2683 | ret = zio_crypt_key_get_salt(&dck->dck_key, salt); | |
2684 | if (ret != 0) | |
2685 | goto error; | |
2686 | ||
2687 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2688 | return (0); | |
2689 | ||
2690 | error: | |
2691 | if (dck != NULL) | |
2692 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2693 | return (ret); | |
2694 | } | |
2695 | ||
2696 | /* | |
2697 | * Objset blocks are a special case for MAC generation. These blocks have 2 | |
2698 | * 256-bit MACs which are embedded within the block itself, rather than a | |
2699 | * single 128 bit MAC. As a result, this function handles encoding and decoding | |
2700 | * the MACs on its own, unlike other functions in this file. | |
2701 | */ | |
2702 | int | |
2703 | spa_do_crypt_objset_mac_abd(boolean_t generate, spa_t *spa, uint64_t dsobj, | |
2704 | abd_t *abd, uint_t datalen, boolean_t byteswap) | |
2705 | { | |
2706 | int ret; | |
2707 | dsl_crypto_key_t *dck = NULL; | |
2708 | void *buf = abd_borrow_buf_copy(abd, datalen); | |
2709 | objset_phys_t *osp = buf; | |
2710 | uint8_t portable_mac[ZIO_OBJSET_MAC_LEN]; | |
2711 | uint8_t local_mac[ZIO_OBJSET_MAC_LEN]; | |
2712 | ||
2713 | /* look up the key from the spa's keystore */ | |
2714 | ret = spa_keystore_lookup_key(spa, dsobj, FTAG, &dck); | |
2715 | if (ret != 0) | |
2716 | goto error; | |
2717 | ||
2718 | /* calculate both HMACs */ | |
2719 | ret = zio_crypt_do_objset_hmacs(&dck->dck_key, buf, datalen, | |
2720 | byteswap, portable_mac, local_mac); | |
2721 | if (ret != 0) | |
2722 | goto error; | |
2723 | ||
2724 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2725 | ||
2726 | /* if we are generating encode the HMACs in the objset_phys_t */ | |
2727 | if (generate) { | |
2728 | bcopy(portable_mac, osp->os_portable_mac, ZIO_OBJSET_MAC_LEN); | |
2729 | bcopy(local_mac, osp->os_local_mac, ZIO_OBJSET_MAC_LEN); | |
2730 | abd_return_buf_copy(abd, buf, datalen); | |
2731 | return (0); | |
2732 | } | |
2733 | ||
2734 | if (bcmp(portable_mac, osp->os_portable_mac, ZIO_OBJSET_MAC_LEN) != 0 || | |
2735 | bcmp(local_mac, osp->os_local_mac, ZIO_OBJSET_MAC_LEN) != 0) { | |
2736 | abd_return_buf(abd, buf, datalen); | |
2737 | return (SET_ERROR(ECKSUM)); | |
2738 | } | |
2739 | ||
2740 | abd_return_buf(abd, buf, datalen); | |
2741 | ||
2742 | return (0); | |
2743 | ||
2744 | error: | |
2745 | if (dck != NULL) | |
2746 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2747 | abd_return_buf(abd, buf, datalen); | |
2748 | return (ret); | |
2749 | } | |
2750 | ||
2751 | int | |
2752 | spa_do_crypt_mac_abd(boolean_t generate, spa_t *spa, uint64_t dsobj, abd_t *abd, | |
2753 | uint_t datalen, uint8_t *mac) | |
2754 | { | |
2755 | int ret; | |
2756 | dsl_crypto_key_t *dck = NULL; | |
2757 | uint8_t *buf = abd_borrow_buf_copy(abd, datalen); | |
2758 | uint8_t digestbuf[ZIO_DATA_MAC_LEN]; | |
2759 | ||
2760 | /* look up the key from the spa's keystore */ | |
2761 | ret = spa_keystore_lookup_key(spa, dsobj, FTAG, &dck); | |
2762 | if (ret != 0) | |
2763 | goto error; | |
2764 | ||
2765 | /* perform the hmac */ | |
4807c0ba TC |
2766 | ret = zio_crypt_do_hmac(&dck->dck_key, buf, datalen, |
2767 | digestbuf, ZIO_DATA_MAC_LEN); | |
b5256303 TC |
2768 | if (ret != 0) |
2769 | goto error; | |
2770 | ||
2771 | abd_return_buf(abd, buf, datalen); | |
2772 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2773 | ||
2774 | /* | |
2775 | * Truncate and fill in mac buffer if we were asked to generate a MAC. | |
2776 | * Otherwise verify that the MAC matched what we expected. | |
2777 | */ | |
2778 | if (generate) { | |
2779 | bcopy(digestbuf, mac, ZIO_DATA_MAC_LEN); | |
2780 | return (0); | |
2781 | } | |
2782 | ||
2783 | if (bcmp(digestbuf, mac, ZIO_DATA_MAC_LEN) != 0) | |
2784 | return (SET_ERROR(ECKSUM)); | |
2785 | ||
2786 | return (0); | |
2787 | ||
2788 | error: | |
2789 | if (dck != NULL) | |
2790 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2791 | abd_return_buf(abd, buf, datalen); | |
2792 | return (ret); | |
2793 | } | |
2794 | ||
2795 | /* | |
2796 | * This function serves as a multiplexer for encryption and decryption of | |
2797 | * all blocks (except the L2ARC). For encryption, it will populate the IV, | |
2798 | * salt, MAC, and cabd (the ciphertext). On decryption it will simply use | |
2799 | * these fields to populate pabd (the plaintext). | |
2800 | */ | |
2801 | int | |
be9a5c35 TC |
2802 | spa_do_crypt_abd(boolean_t encrypt, spa_t *spa, const zbookmark_phys_t *zb, |
2803 | dmu_object_type_t ot, boolean_t dedup, boolean_t bswap, uint8_t *salt, | |
2804 | uint8_t *iv, uint8_t *mac, uint_t datalen, abd_t *pabd, abd_t *cabd, | |
2805 | boolean_t *no_crypt) | |
b5256303 TC |
2806 | { |
2807 | int ret; | |
b5256303 TC |
2808 | dsl_crypto_key_t *dck = NULL; |
2809 | uint8_t *plainbuf = NULL, *cipherbuf = NULL; | |
2810 | ||
2811 | ASSERT(spa_feature_is_active(spa, SPA_FEATURE_ENCRYPTION)); | |
b5256303 TC |
2812 | |
2813 | /* look up the key from the spa's keystore */ | |
be9a5c35 TC |
2814 | ret = spa_keystore_lookup_key(spa, zb->zb_objset, FTAG, &dck); |
2815 | if (ret != 0) { | |
2816 | ret = SET_ERROR(EACCES); | |
b5256303 | 2817 | return (ret); |
be9a5c35 | 2818 | } |
b5256303 TC |
2819 | |
2820 | if (encrypt) { | |
2821 | plainbuf = abd_borrow_buf_copy(pabd, datalen); | |
2822 | cipherbuf = abd_borrow_buf(cabd, datalen); | |
2823 | } else { | |
2824 | plainbuf = abd_borrow_buf(pabd, datalen); | |
2825 | cipherbuf = abd_borrow_buf_copy(cabd, datalen); | |
2826 | } | |
2827 | ||
2828 | /* | |
2829 | * Both encryption and decryption functions need a salt for key | |
2830 | * generation and an IV. When encrypting a non-dedup block, we | |
2831 | * generate the salt and IV randomly to be stored by the caller. Dedup | |
2832 | * blocks perform a (more expensive) HMAC of the plaintext to obtain | |
2833 | * the salt and the IV. ZIL blocks have their salt and IV generated | |
2834 | * at allocation time in zio_alloc_zil(). On decryption, we simply use | |
2835 | * the provided values. | |
2836 | */ | |
be9a5c35 | 2837 | if (encrypt && ot != DMU_OT_INTENT_LOG && !dedup) { |
b5256303 TC |
2838 | ret = zio_crypt_key_get_salt(&dck->dck_key, salt); |
2839 | if (ret != 0) | |
2840 | goto error; | |
2841 | ||
2842 | ret = zio_crypt_generate_iv(iv); | |
2843 | if (ret != 0) | |
2844 | goto error; | |
be9a5c35 | 2845 | } else if (encrypt && dedup) { |
b5256303 TC |
2846 | ret = zio_crypt_generate_iv_salt_dedup(&dck->dck_key, |
2847 | plainbuf, datalen, iv, salt); | |
2848 | if (ret != 0) | |
2849 | goto error; | |
2850 | } | |
2851 | ||
2852 | /* call lower level function to perform encryption / decryption */ | |
10fa2545 BB |
2853 | ret = zio_do_crypt_data(encrypt, &dck->dck_key, ot, bswap, salt, iv, |
2854 | mac, datalen, plainbuf, cipherbuf, no_crypt); | |
be9a5c35 TC |
2855 | |
2856 | /* | |
2857 | * Handle injected decryption faults. Unfortunately, we cannot inject | |
2858 | * faults for dnode blocks because we might trigger the panic in | |
2859 | * dbuf_prepare_encrypted_dnode_leaf(), which exists because syncing | |
2860 | * context is not prepared to handle malicious decryption failures. | |
2861 | */ | |
2862 | if (zio_injection_enabled && !encrypt && ot != DMU_OT_DNODE && ret == 0) | |
2863 | ret = zio_handle_decrypt_injection(spa, zb, ot, ECKSUM); | |
b5256303 TC |
2864 | if (ret != 0) |
2865 | goto error; | |
2866 | ||
2867 | if (encrypt) { | |
2868 | abd_return_buf(pabd, plainbuf, datalen); | |
2869 | abd_return_buf_copy(cabd, cipherbuf, datalen); | |
2870 | } else { | |
2871 | abd_return_buf_copy(pabd, plainbuf, datalen); | |
2872 | abd_return_buf(cabd, cipherbuf, datalen); | |
2873 | } | |
2874 | ||
2875 | spa_keystore_dsl_key_rele(spa, dck, FTAG); | |
2876 | ||
2877 | return (0); | |
2878 | ||
2879 | error: | |
2880 | if (encrypt) { | |
2881 | /* zero out any state we might have changed while encrypting */ | |
2882 | bzero(salt, ZIO_DATA_SALT_LEN); | |
2883 | bzero(iv, ZIO_DATA_IV_LEN); | |
2884 | bzero(mac, ZIO_DATA_MAC_LEN); | |
2885 | abd_return_buf(pabd, plainbuf, datalen); | |
2886 | abd_return_buf_copy(cabd, cipherbuf, datalen); | |
2887 | } else { | |
2888 | abd_return_buf_copy(pabd, plainbuf, datalen); | |
2889 | abd_return_buf(cabd, cipherbuf, datalen); | |
2890 | } | |
2891 | ||
4807c0ba | 2892 | spa_keystore_dsl_key_rele(spa, dck, FTAG); |
b5256303 TC |
2893 | |
2894 | return (ret); | |
2895 | } | |
f00ab3f2 | 2896 | |
af26a869 | 2897 | ZFS_MODULE_PARAM(zfs, zfs_, disable_ivset_guid_check, INT, ZMOD_RW, |
f00ab3f2 | 2898 | "Set to allow raw receives without IVset guids"); |