1 // SPDX-License-Identifier: GPL-2.0
11 #include <linux/key.h>
12 #include <linux/key-type.h>
13 #include <keys/user-type.h>
14 #include <keys/encrypted-type.h>
15 #include "nd-core.h"
23 MODULE_PARM_DESC(key_revalidate, "Require key validation at init.");
27 static void *key_data(struct key *key)  in key_data()  argument
29 	struct encrypted_key_payload *epayload = dereference_key_locked(key);  in key_data()
31 	lockdep_assert_held_read(&key->sem);  in key_data()
33 	return epayload->decrypted_data;  in key_data()
36 static void nvdimm_put_key(struct key *key)  in nvdimm_put_key()  argument
38 	if (!key)  in nvdimm_put_key()
41 	up_read(&key->sem);  in nvdimm_put_key()
42 	key_put(key);  in nvdimm_put_key()
46  * Retrieve kernel key for DIMM and request from user space if
47  * necessary. Returns a key held for read and must be put by
50 static struct key *nvdimm_request_key(struct nvdimm *nvdimm)  in nvdimm_request_key()
52 	struct key *key = NULL;  in nvdimm_request_key()  local
55 	struct device *dev = &nvdimm->dev;  in nvdimm_request_key()
57 	sprintf(desc, "%s%s", NVDIMM_PREFIX, nvdimm->dimm_id);  in nvdimm_request_key()
58 	key = request_key(&key_type_encrypted, desc, "");  in nvdimm_request_key()
59 	if (IS_ERR(key)) {  in nvdimm_request_key()
60 		if (PTR_ERR(key) == -ENOKEY)  in nvdimm_request_key()
61 			dev_dbg(dev, "request_key() found no key\n");  in nvdimm_request_key()
64 		key = NULL;  in nvdimm_request_key()
68 		down_read(&key->sem);  in nvdimm_request_key()
69 		epayload = dereference_key_locked(key);  in nvdimm_request_key()
70 		if (epayload->decrypted_datalen != NVDIMM_PASSPHRASE_LEN) {  in nvdimm_request_key()
71 			up_read(&key->sem);  in nvdimm_request_key()
72 			key_put(key);  in nvdimm_request_key()
73 			key = NULL;  in nvdimm_request_key()
77 	return key;  in nvdimm_request_key()
81 		struct key **key)  in nvdimm_get_key_payload()  argument
83 	*key = nvdimm_request_key(nvdimm);  in nvdimm_get_key_payload()
84 	if (!*key)  in nvdimm_get_key_payload()
87 	return key_data(*key);  in nvdimm_get_key_payload()
90 static struct key *nvdimm_lookup_user_key(struct nvdimm *nvdimm,  in nvdimm_lookup_user_key()
94 	struct key *key;  in nvdimm_lookup_user_key()  local
96 	struct device *dev = &nvdimm->dev;  in nvdimm_lookup_user_key()
102 	key = key_ref_to_ptr(keyref);  in nvdimm_lookup_user_key()
103 	if (key->type != &key_type_encrypted) {  in nvdimm_lookup_user_key()
104 		key_put(key);  in nvdimm_lookup_user_key()
108 	dev_dbg(dev, "%s: key found: %#x\n", __func__, key_serial(key));  in nvdimm_lookup_user_key()
110 	down_read_nested(&key->sem, subclass);  in nvdimm_lookup_user_key()
111 	epayload = dereference_key_locked(key);  in nvdimm_lookup_user_key()
112 	if (epayload->decrypted_datalen != NVDIMM_PASSPHRASE_LEN) {  in nvdimm_lookup_user_key()
113 		up_read(&key->sem);  in nvdimm_lookup_user_key()
114 		key_put(key);  in nvdimm_lookup_user_key()
115 		key = NULL;  in nvdimm_lookup_user_key()
117 	return key;  in nvdimm_lookup_user_key()
121 		key_serial_t id, int subclass, struct key **key)  in nvdimm_get_user_key_payload()  argument
123 	*key = NULL;  in nvdimm_get_user_key_payload()
131 	*key = nvdimm_lookup_user_key(nvdimm, id, subclass);  in nvdimm_get_user_key_payload()
132 	if (!*key)  in nvdimm_get_user_key_payload()
135 	return key_data(*key);  in nvdimm_get_user_key_payload()
141 	struct key *key;  in nvdimm_key_revalidate()  local
145 	if (!nvdimm->sec.ops->change_key)  in nvdimm_key_revalidate()
146 		return -EOPNOTSUPP;  in nvdimm_key_revalidate()
148 	data = nvdimm_get_key_payload(nvdimm, &key);  in nvdimm_key_revalidate()
151 	 * Send the same key to the hardware as new and old key to  in nvdimm_key_revalidate()
152 	 * verify that the key is good.  in nvdimm_key_revalidate()
154 	rc = nvdimm->sec.ops->change_key(nvdimm, data, data, NVDIMM_USER);  in nvdimm_key_revalidate()
156 		nvdimm_put_key(key);  in nvdimm_key_revalidate()
160 	nvdimm_put_key(key);  in nvdimm_key_revalidate()
161 	nvdimm->sec.flags = nvdimm_security_flags(nvdimm, NVDIMM_USER);  in nvdimm_key_revalidate()
167 	struct device *dev = &nvdimm->dev;  in __nvdimm_security_unlock()
169 	struct key *key;  in __nvdimm_security_unlock()  local
174 	lockdep_assert_held(&nvdimm_bus->reconfig_mutex);  in __nvdimm_security_unlock()
176 	if (!nvdimm->sec.ops || !nvdimm->sec.ops->unlock  in __nvdimm_security_unlock()
177 			|| !nvdimm->sec.flags)  in __nvdimm_security_unlock()
178 		return -EIO;  in __nvdimm_security_unlock()
180 	/* cxl_test needs this to pre-populate the security state */  in __nvdimm_security_unlock()
182 		nvdimm->sec.flags = nvdimm_security_flags(nvdimm, NVDIMM_USER);  in __nvdimm_security_unlock()
185 	if (test_bit(NVDIMM_SECURITY_DISABLED, &nvdimm->sec.flags))  in __nvdimm_security_unlock()
188 	if (test_bit(NDD_SECURITY_OVERWRITE, &nvdimm->flags)) {  in __nvdimm_security_unlock()
190 		return -EBUSY;  in __nvdimm_security_unlock()
194 	 * If the pre-OS has unlocked the DIMM, attempt to send the key  in __nvdimm_security_unlock()
196 	 * to revalidate the key against the hardware results in a  in __nvdimm_security_unlock()
198 	 * have the key, security is being managed pre-OS.  in __nvdimm_security_unlock()
200 	if (test_bit(NVDIMM_SECURITY_UNLOCKED, &nvdimm->sec.flags)) {  in __nvdimm_security_unlock()
206 		data = nvdimm_get_key_payload(nvdimm, &key);  in __nvdimm_security_unlock()
208 	rc = nvdimm->sec.ops->unlock(nvdimm, data);  in __nvdimm_security_unlock()
209 	dev_dbg(dev, "key: %d unlock: %s\n", key_serial(key),  in __nvdimm_security_unlock()
212 		set_bit(NDD_INCOHERENT, &nvdimm->flags);  in __nvdimm_security_unlock()
214 	nvdimm_put_key(key);  in __nvdimm_security_unlock()
215 	nvdimm->sec.flags = nvdimm_security_flags(nvdimm, NVDIMM_USER);  in __nvdimm_security_unlock()
232 	struct device *dev = &nvdimm->dev;  in check_security_state()
234 	if (test_bit(NVDIMM_SECURITY_FROZEN, &nvdimm->sec.flags)) {  in check_security_state()
236 				nvdimm->sec.flags);  in check_security_state()
237 		return -EIO;  in check_security_state()
240 	if (test_bit(NDD_SECURITY_OVERWRITE, &nvdimm->flags)) {  in check_security_state()
242 		return -EBUSY;  in check_security_state()
251 	struct device *dev = &nvdimm->dev;  in security_disable()
253 	struct key *key;  in security_disable()  local
258 	lockdep_assert_held(&nvdimm_bus->reconfig_mutex);  in security_disable()
260 	if (!nvdimm->sec.ops || !nvdimm->sec.flags)  in security_disable()
261 		return -EOPNOTSUPP;  in security_disable()
263 	if (pass_type == NVDIMM_USER && !nvdimm->sec.ops->disable)  in security_disable()
264 		return -EOPNOTSUPP;  in security_disable()
266 	if (pass_type == NVDIMM_MASTER && !nvdimm->sec.ops->disable_master)  in security_disable()
267 		return -EOPNOTSUPP;  in security_disable()
274 			NVDIMM_BASE_KEY, &key);  in security_disable()
276 		return -ENOKEY;  in security_disable()
279 		rc = nvdimm->sec.ops->disable_master(nvdimm, data);  in security_disable()
280 		dev_dbg(dev, "key: %d disable_master: %s\n", key_serial(key),  in security_disable()
283 		rc = nvdimm->sec.ops->disable(nvdimm, data);  in security_disable()
284 		dev_dbg(dev, "key: %d disable: %s\n", key_serial(key),  in security_disable()
288 	nvdimm_put_key(key);  in security_disable()
290 		nvdimm->sec.ext_flags = nvdimm_security_flags(nvdimm, NVDIMM_MASTER);  in security_disable()
292 		nvdimm->sec.flags = nvdimm_security_flags(nvdimm, NVDIMM_USER);  in security_disable()
300 	struct device *dev = &nvdimm->dev;  in security_update()
302 	struct key *key, *newkey;  in security_update()  local
307 	lockdep_assert_held(&nvdimm_bus->reconfig_mutex);  in security_update()
309 	if (!nvdimm->sec.ops || !nvdimm->sec.ops->change_key  in security_update()
310 			|| !nvdimm->sec.flags)  in security_update()
311 		return -EOPNOTSUPP;  in security_update()
318 			NVDIMM_BASE_KEY, &key);  in security_update()
320 		return -ENOKEY;  in security_update()
325 		nvdimm_put_key(key);  in security_update()
326 		return -ENOKEY;  in security_update()
329 	rc = nvdimm->sec.ops->change_key(nvdimm, data, newdata, pass_type);  in security_update()
330 	dev_dbg(dev, "key: %d %d update%s: %s\n",  in security_update()
331 			key_serial(key), key_serial(newkey),  in security_update()
336 	nvdimm_put_key(key);  in security_update()
338 		nvdimm->sec.ext_flags = nvdimm_security_flags(nvdimm,  in security_update()
341 		nvdimm->sec.flags = nvdimm_security_flags(nvdimm,  in security_update()
349 	struct device *dev = &nvdimm->dev;  in security_erase()
351 	struct key *key = NULL;  in security_erase()  local
356 	lockdep_assert_held(&nvdimm_bus->reconfig_mutex);  in security_erase()
358 	if (!nvdimm->sec.ops || !nvdimm->sec.ops->erase  in security_erase()
359 			|| !nvdimm->sec.flags)  in security_erase()
360 		return -EOPNOTSUPP;  in security_erase()
366 	if (!test_bit(NVDIMM_SECURITY_UNLOCKED, &nvdimm->sec.ext_flags)  in security_erase()
370 		return -EOPNOTSUPP;  in security_erase()
374 			NVDIMM_BASE_KEY, &key);  in security_erase()
376 		return -ENOKEY;  in security_erase()
378 	rc = nvdimm->sec.ops->erase(nvdimm, data, pass_type);  in security_erase()
380 		set_bit(NDD_INCOHERENT, &nvdimm->flags);  in security_erase()
381 	dev_dbg(dev, "key: %d erase%s: %s\n", key_serial(key),  in security_erase()
385 	nvdimm_put_key(key);  in security_erase()
386 	nvdimm->sec.flags = nvdimm_security_flags(nvdimm, NVDIMM_USER);  in security_erase()
392 	struct device *dev = &nvdimm->dev;  in security_overwrite()
394 	struct key *key = NULL;  in security_overwrite()  local
399 	lockdep_assert_held(&nvdimm_bus->reconfig_mutex);  in security_overwrite()
401 	if (!nvdimm->sec.ops || !nvdimm->sec.ops->overwrite  in security_overwrite()
402 			|| !nvdimm->sec.flags)  in security_overwrite()
403 		return -EOPNOTSUPP;  in security_overwrite()
410 			NVDIMM_BASE_KEY, &key);  in security_overwrite()
412 		return -ENOKEY;  in security_overwrite()
414 	rc = nvdimm->sec.ops->overwrite(nvdimm, data);  in security_overwrite()
416 		set_bit(NDD_INCOHERENT, &nvdimm->flags);  in security_overwrite()
417 	dev_dbg(dev, "key: %d overwrite submission: %s\n", key_serial(key),  in security_overwrite()
420 	nvdimm_put_key(key);  in security_overwrite()
422 		set_bit(NDD_SECURITY_OVERWRITE, &nvdimm->flags);  in security_overwrite()
423 		set_bit(NDD_WORK_PENDING, &nvdimm->flags);  in security_overwrite()
424 		set_bit(NVDIMM_SECURITY_OVERWRITE, &nvdimm->sec.flags);  in security_overwrite()
430 		queue_delayed_work(system_wq, &nvdimm->dwork, 0);  in security_overwrite()
438 	struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(&nvdimm->dev);  in __nvdimm_security_overwrite_query()
443 	lockdep_assert_held(&nvdimm_bus->reconfig_mutex);  in __nvdimm_security_overwrite_query()
449 	if (!test_bit(NDD_WORK_PENDING, &nvdimm->flags))  in __nvdimm_security_overwrite_query()
452 	tmo = nvdimm->sec.overwrite_tmo;  in __nvdimm_security_overwrite_query()
454 	if (!nvdimm->sec.ops || !nvdimm->sec.ops->query_overwrite  in __nvdimm_security_overwrite_query()
455 			|| !nvdimm->sec.flags)  in __nvdimm_security_overwrite_query()
458 	rc = nvdimm->sec.ops->query_overwrite(nvdimm);  in __nvdimm_security_overwrite_query()
459 	if (rc == -EBUSY) {  in __nvdimm_security_overwrite_query()
463 		queue_delayed_work(system_wq, &nvdimm->dwork, tmo * HZ);  in __nvdimm_security_overwrite_query()
464 		nvdimm->sec.overwrite_tmo = min(15U * 60U, tmo);  in __nvdimm_security_overwrite_query()
469 		dev_dbg(&nvdimm->dev, "overwrite failed\n");  in __nvdimm_security_overwrite_query()
471 		dev_dbg(&nvdimm->dev, "overwrite completed\n");  in __nvdimm_security_overwrite_query()
478 	nvdimm->sec.overwrite_tmo = 0;  in __nvdimm_security_overwrite_query()
479 	clear_bit(NDD_SECURITY_OVERWRITE, &nvdimm->flags);  in __nvdimm_security_overwrite_query()
480 	clear_bit(NDD_WORK_PENDING, &nvdimm->flags);  in __nvdimm_security_overwrite_query()
481 	nvdimm->sec.flags = nvdimm_security_flags(nvdimm, NVDIMM_USER);  in __nvdimm_security_overwrite_query()
482 	nvdimm->sec.ext_flags = nvdimm_security_flags(nvdimm, NVDIMM_MASTER);  in __nvdimm_security_overwrite_query()
483 	if (nvdimm->sec.overwrite_state)  in __nvdimm_security_overwrite_query()
484 		sysfs_notify_dirent(nvdimm->sec.overwrite_state);  in __nvdimm_security_overwrite_query()
485 	put_device(&nvdimm->dev);  in __nvdimm_security_overwrite_query()
493 	nvdimm_bus_lock(&nvdimm->dev);  in nvdimm_security_overwrite_query()
495 	nvdimm_bus_unlock(&nvdimm->dev);  in nvdimm_security_overwrite_query()
527 	unsigned int key, newkey;  in nvdimm_security_store()  local
535 		return -EINVAL;  in nvdimm_security_store()
540 		return -EINVAL;  in nvdimm_security_store()
542 		rc = kstrtouint(keystr, 0, &key);  in nvdimm_security_store()
552 		dev_dbg(dev, "disable %u\n", key);  in nvdimm_security_store()
553 		rc = security_disable(nvdimm, key, NVDIMM_USER);  in nvdimm_security_store()
555 		dev_dbg(dev, "disable_master %u\n", key);  in nvdimm_security_store()
556 		rc = security_disable(nvdimm, key, NVDIMM_MASTER);  in nvdimm_security_store()
558 		dev_dbg(dev, "%s %u %u\n", ops[i].name, key, newkey);  in nvdimm_security_store()
559 		rc = security_update(nvdimm, key, newkey, i == OP_UPDATE  in nvdimm_security_store()
562 		dev_dbg(dev, "%s %u\n", ops[i].name, key);  in nvdimm_security_store()
563 		if (atomic_read(&nvdimm->busy)) {  in nvdimm_security_store()
565 			return -EBUSY;  in nvdimm_security_store()
567 		rc = security_erase(nvdimm, key, i == OP_ERASE  in nvdimm_security_store()
570 		dev_dbg(dev, "overwrite %u\n", key);  in nvdimm_security_store()
571 		if (atomic_read(&nvdimm->busy)) {  in nvdimm_security_store()
573 			return -EBUSY;  in nvdimm_security_store()
575 		rc = security_overwrite(nvdimm, key);  in nvdimm_security_store()
577 		return -EINVAL;  in nvdimm_security_store()