nvme-auth: switch to use the kernel keyring
Subsystems (3)
cover nvme-auth: switch to use the kernel keyring
Hey all,
the current NVMe authentication code is using a hand-crafted key structure; idea was to have the initial implementation with a minimal set of dependencies. (And me not having a good grasp on how to use the kernel keyring :-) That had the drawback that keys always had to be specified on the nvme-cli commandline, which is far from ideal from a security standpoint.
So this patchset switches the authentication code over to use the kernel keyring. User-facing interface (namely argument to 'nvme connect') remain the same, but the key data is converted into keys which are stored as a new key type 'dhchap' with a random UUID as description in the kernel keyring.
With this I have updated the dhchap arguments to 'nvme connect' and the configfs interface to either be the keydata (ie the original interface) _or_ a key serial referring to a pre-populated dhchap key in the kernel keyring.
This allows for easier provisioning of keys and avoids the security risk from having to specify the key data on the kernel commandline.
The entire patchset can be found atgit://git.kernel.org/pub/scm/linux/kernel/git/hare/nvme.git
branch dhchap-keyring.v1
As usual, comments and reviews are welcome.
Hannes Reinecke (12):
nvme-auth: modify nvme_auth_transform_key() to return status
nvme-auth: use SHASH_DESC_ON_STACK
nvmet-auth: use SHASH_DESC_ON_STACK
nvme-auth: do not cache the transformed secret
nvme-keyring: add 'dhchap' key type
nvme-auth: switch to use 'struct key'
nvme-auth: drop nvme_dhchap_key structure and unused functions
nvme: parse dhchap keys during option parsing
nvmet-auth: parse dhchap key from configfs attribute
nvme: allow to pass in key serial number as dhchap secret
nvme-auth: wait for authentication to finish when changing keys
nvme: Unify Kconfig settings
drivers/nvme/common/Kconfig | 1 + drivers/nvme/common/auth.c | 245 +++++++++++++----------------- drivers/nvme/common/keyring.c | 266 +++++++++++++++++++++++++++++++++ drivers/nvme/host/Kconfig | 4 +- drivers/nvme/host/auth.c | 171 ++++++++++++++------- drivers/nvme/host/fabrics.c | 94 +++++++++--- drivers/nvme/host/fabrics.h | 12 +- drivers/nvme/host/nvme.h | 6 +- drivers/nvme/host/sysfs.c | 204 ++++++++++++++++++------- drivers/nvme/target/Kconfig | 3 +- drivers/nvme/target/auth.c | 238 ++++++++++++++++++----------- drivers/nvme/target/configfs.c | 61 ++++++-- drivers/nvme/target/nvmet.h | 13 +- include/linux/nvme-auth.h | 18 +-- include/linux/nvme-keyring.h | 22 ++- 15 files changed, 948 insertions(+), 410 deletions(-)
Signature · 1 line
2.35.3
PATCH 1/12 nvme-auth: modify nvme_auth_transform_key() to return status
Modify nvme_auth_transform_key() to return a status and provide the transformed data as argument on the command line as raw data.
--- drivers/nvme/common/auth.c | 80 +++++++++++++++++++++++--------------- drivers/nvme/host/auth.c | 40 ++++++++++--------- drivers/nvme/target/auth.c | 36 ++++++++--------- include/linux/nvme-auth.h | 4 +- 4 files changed, 89 insertions(+), 71 deletions(-)
drivers/nvme/common/auth.c +48 -32
@@ -237,81 +237,97 @@ void nvme_auth_free_key(struct nvme_dhchap_key *key) }EXPORT_SYMBOL_GPL (nvme_auth_free_key); -struct nvme_dhchap_key *nvme_auth_transform_key ( -struct nvme_dhchap_key *key,char *nqn) +int nvme_auth_transform_key (struct nvme_dhchap_key *key,char *nqn, +u8 **transformed_secret) {const char *hmac_name;struct crypto_shash *key_tfm;struct shash_desc *shash; -struct nvme_dhchap_key *transformed_key; -int ret, key_len; +u8 *transformed_data; +u8 *key_data; +size_t transformed_len; +int ret;if (!key) {pr_warn ("No key specified\n" ); -return ERR_PTR (-ENOKEY ); +return -ENOKEY ; } + key_data =kzalloc (key->len,GFP_KERNEL ); +if (!key_data) +return -ENOMEM ; +memcpy (key_data, key->key, key->len);if (key->hash ==0 ) { - key_len =nvme_auth_key_struct_size (key->len); - transformed_key =kmemdup (key, key_len,GFP_KERNEL ); -if (!transformed_key) -return ERR_PTR (-ENOMEM ); -return transformed_key; + *transformed_secret = key_data; +return key->len; } hmac_name =nvme_auth_hmac_name (key->hash);if (!hmac_name) {pr_warn ("Invalid key hash id %d\n" , key->hash); -return ERR_PTR (-EINVAL ); + ret = -EINVAL ; + goto out_free_data; } key_tfm =crypto_alloc_shash (hmac_name,0 ,0 ); -if (IS_ERR (key_tfm)) -return ERR_CAST (key_tfm); +if (IS_ERR (key_tfm)) { + ret =PTR_ERR (key_tfm); + goto out_free_data; + } + + transformed_len =crypto_shash_digestsize (key_tfm); +if (transformed_len != key->len) { +pr_warn ("incompatible digest size %ld for key (hash %s, len %ld)\n" , + transformed_len, hmac_name, key->len); + ret = -EINVAL ; + goto out_free_tfm; + } + + transformed_data =kzalloc (transformed_len,GFP_KERNEL ); +if (!transformed_data) { + ret = -ENOMEM ; + goto out_free_tfm; + } shash =kmalloc (sizeof (struct shash_desc ) +crypto_shash_descsize (key_tfm),GFP_KERNEL );if (!shash) { ret = -ENOMEM ; - goto out_free_key; - } - - key_len =crypto_shash_digestsize (key_tfm); - transformed_key =nvme_auth_alloc_key (key_len, key->hash); -if (!transformed_key) { - ret = -ENOMEM ; - goto out_free_shash; + goto out_free_transformed_data; } shash->tfm = key_tfm; ret =crypto_shash_setkey (key_tfm, key->key, key->len);if (ret <0 ) - goto out_free_transformed_key; + goto out_free_shash; ret =crypto_shash_init (shash);if (ret <0 ) - goto out_free_transformed_key; + goto out_free_shash; ret =crypto_shash_update (shash, nqn,strlen (nqn));if (ret <0 ) - goto out_free_transformed_key; + goto out_free_shash; ret =crypto_shash_update (shash,"NVMe-over-Fabrics" ,17 );if (ret <0 ) - goto out_free_transformed_key; - ret =crypto_shash_final (shash, transformed_key->key); + goto out_free_shash; + ret =crypto_shash_final (shash, transformed_data);if (ret <0 ) - goto out_free_transformed_key; + goto out_free_shash;kfree (shash);crypto_free_shash (key_tfm); + *transformed_secret = transformed_data; -return transformed_key; +return transformed_len; -out_free_transformed_key: -nvme_auth_free_key (transformed_key); out_free_shash:kfree (shash); -out_free_key: +out_free_transformed_data: +kfree (transformed_data); +out_free_tfm:crypto_free_shash (key_tfm); +out_free_data: +kfree (key_data); -return ERR_PTR (ret); +return ret; }EXPORT_SYMBOL_GPL (nvme_auth_transform_key);
drivers/nvme/host/auth.c +21 -19
@@ -24,7 +24,8 @@ struct nvme_dhchap_queue_context {struct nvme_ctrl *ctrl;struct crypto_shash *shash_tfm;struct crypto_kpp *dh_tfm; -struct nvme_dhchap_key *transformed_key; +u8 *transformed_secret; +size_t transformed_len;void *buf;int qid;int error;
@@ -436,21 +437,20 @@ static int nvme_auth_dhchap_setup_host_response(struct nvme_ctrl *ctrl,dev_dbg (ctrl->device,"%s: qid %d host response seq %u transaction %d\n" , __func__, chap->qid, chap->s1, chap->transaction); -if (!chap->transformed_key) { - chap->transformed_key =nvme_auth_transform_key (ctrl->host_key, - ctrl->opts->host->nqn); -if (IS_ERR (chap->transformed_key)) { - ret =PTR_ERR (chap->transformed_key); - chap->transformed_key =NULL ; +if (!chap->transformed_secret) { + ret =nvme_auth_transform_key (ctrl->host_key, + ctrl->opts->host->nqn, + &chap->transformed_secret); +if (ret <0 )return ret; - } + chap->transformed_len = ret; }else {dev_dbg (ctrl->device,"%s: qid %d re-using host response\n" , __func__, chap->qid); } ret =crypto_shash_setkey (chap->shash_tfm, - chap->transformed_key->key, chap->transformed_key->len); + chap->transformed_secret, chap->transformed_len);if (ret) {dev_warn (ctrl->device,"qid %d: failed to set key, error %d\n" , chap->qid, ret);
@@ -516,19 +516,20 @@ static int nvme_auth_dhchap_setup_ctrl_response(struct nvme_ctrl *ctrl, struct nvme_dhchap_queue_context *chap) {SHASH_DESC_ON_STACK (shash, chap->shash_tfm); -struct nvme_dhchap_key *transformed_key; +u8 *transformed_secret; +size_t transformed_len;u8 buf[4 ], *challenge = chap->c2;int ret; - transformed_key =nvme_auth_transform_key (ctrl->ctrl_key, - ctrl->opts->subsysnqn); -if (IS_ERR (transformed_key)) { - ret =PTR_ERR (transformed_key); + ret =nvme_auth_transform_key (ctrl->ctrl_key, + ctrl->opts->subsysnqn, + &transformed_secret); +if (ret <0 )return ret; - } + transformed_len = ret; ret =crypto_shash_setkey (chap->shash_tfm, - transformed_key->key, transformed_key->len); + transformed_secret, transformed_len);if (ret) {dev_warn (ctrl->device,"qid %d: failed to set key, error %d\n" , chap->qid, ret);
@@ -594,7 +595,7 @@ static int nvme_auth_dhchap_setup_ctrl_response(struct nvme_ctrl *ctrl, out:if (challenge != chap->c2)kfree (challenge); -nvme_auth_free_key (transformed_key); +kfree (transformed_secret);return ret; }
@@ -656,8 +657,9 @@ static int nvme_auth_dhchap_exponential(struct nvme_ctrl *ctrl,static void nvme_auth_reset_dhchap (struct nvme_dhchap_queue_context *chap) { -nvme_auth_free_key (chap->transformed_key); - chap->transformed_key =NULL ; +kfree (chap->transformed_secret); + chap->transformed_secret =NULL ; + chap->transformed_len =0 ;kfree_sensitive (chap->host_key); chap->host_key =NULL ; chap->host_key_len =0 ;
drivers/nvme/target/auth.c +18 -18
@@ -294,7 +294,8 @@ int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response,struct nvmet_ctrl *ctrl = req->sq->ctrl;const char *hash_name;u8 *challenge = req->sq->dhchap_c1; -struct nvme_dhchap_key *transformed_key; +u8 *transformed_secret; +size_t transformed_len;u8 buf[4 ];int ret;
@@ -318,15 +319,14 @@ int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response, goto out_free_tfm; } - transformed_key =nvme_auth_transform_key (ctrl->host_key, - ctrl->hostnqn); -if (IS_ERR (transformed_key)) { - ret =PTR_ERR (transformed_key); + ret =nvme_auth_transform_key (ctrl->host_key, ctrl->hostnqn, + &transformed_secret); +if (ret <0 ) goto out_free_tfm; - } - ret =crypto_shash_setkey (shash_tfm, transformed_key->key, - transformed_key->len); + transformed_len = ret; + ret =crypto_shash_setkey (shash_tfm, transformed_secret, + transformed_len);if (ret) goto out_free_response;
@@ -394,7 +394,7 @@ int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response,if (challenge != req->sq->dhchap_c1)kfree (challenge); out_free_response: -nvme_auth_free_key (transformed_key); +kfree (transformed_secret); out_free_tfm:crypto_free_shash (shash_tfm);return ret;
@@ -408,7 +408,8 @@ int nvmet_auth_ctrl_hash(struct nvmet_req *req, u8 *response,struct nvmet_ctrl *ctrl = req->sq->ctrl;const char *hash_name;u8 *challenge = req->sq->dhchap_c2; -struct nvme_dhchap_key *transformed_key; +u8 *transformed_secret; +size_t transformed_len;u8 buf[4 ];int ret;
@@ -432,15 +433,14 @@ int nvmet_auth_ctrl_hash(struct nvmet_req *req, u8 *response, goto out_free_tfm; } - transformed_key =nvme_auth_transform_key (ctrl->ctrl_key, - ctrl->subsysnqn); -if (IS_ERR (transformed_key)) { - ret =PTR_ERR (transformed_key); + ret =nvme_auth_transform_key (ctrl->ctrl_key, ctrl->subsysnqn, + &transformed_secret); +if (ret <0 ) goto out_free_tfm; - } + transformed_len = ret; - ret =crypto_shash_setkey (shash_tfm, transformed_key->key, - transformed_key->len); + ret =crypto_shash_setkey (shash_tfm, transformed_secret, + transformed_len);if (ret) goto out_free_response;
@@ -505,7 +505,7 @@ int nvmet_auth_ctrl_hash(struct nvmet_req *req, u8 *response,if (challenge != req->sq->dhchap_c2)kfree (challenge); out_free_response: -nvme_auth_free_key (transformed_key); +kfree (transformed_secret); out_free_tfm:crypto_free_shash (shash_tfm);return ret;
include/linux/nvme-auth.h +2 -2
@@ -29,8 +29,8 @@ struct nvme_dhchap_key *nvme_auth_extract_key(unsigned char *secret, u8 key_hash);void nvme_auth_free_key (struct nvme_dhchap_key *key);struct nvme_dhchap_key *nvme_auth_alloc_key (u32 len,u8 hash); -struct nvme_dhchap_key *nvme_auth_transform_key ( -struct nvme_dhchap_key *key,char *nqn); +int nvme_auth_transform_key (struct nvme_dhchap_key *key,char *nqn, +u8 **transformed_secret) ;int nvme_auth_generate_key (u8 *secret,struct nvme_dhchap_key **ret_key);int nvme_auth_augmented_challenge (u8 hmac_id,u8 *skey,size_t skey_len,u8 *challenge,u8 *aug,size_t hlen);
Signature · 1 line
2.35.3
Christoph Hellwig
maintainerRe: [PATCH 01/12] nvme-auth: modify nvme_auth_transform_key() to return status
Quoted 2 lines · Hannes Reinecke
Modify
nvme_auth_transform_key()to return a status and provide the transformed data as argument on the command line as raw data.
Well, it's pretty obvious that you do this from the code changes.
But why do you change it?
Hannes Reinecke
maintainerRe: [PATCH 01/12] nvme-auth: modify nvme_auth_transform_key() to return status
Quoted 8 lines · Christoph Hellwig
Quoted 2 lines · Hannes Reinecke
Modify
nvme_auth_transform_key()to return a status and provide the transformed data as argument on the command line as raw data.Well, it's pretty obvious that you do this from the code changes.
But why do you change it?
You are right, the description is incorrect.
Main point here is to return a raw byte string containing the transformed key data (and not a key structure). Doing so makes the following modifications easier to read. One hopes.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions GmbH, Frankenstr. 146, 90461 Nürnberg HRB 36809 (AG Nürnberg), GF: I. Totev, A. McDonald, W. Knoblich
PATCH 2/12 nvme-auth: use SHASH_DESC_ON_STACK
In reply to Hannes ReineckeUse SHASH_DESC_ON_STACK to avoid explicit allocation.
--- drivers/nvme/common/auth.c | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-)
drivers/nvme/common/auth.c +6 -17
@@ -242,7 +242,7 @@ int nvme_auth_transform_key(struct nvme_dhchap_key *key, char *nqn, {const char *hmac_name;struct crypto_shash *key_tfm; -struct shash_desc *shash; +SHASH_DESC_ON_STACK (shash, key_tfm);u8 *transformed_data;u8 *key_data;size_t transformed_len;
@@ -287,39 +287,28 @@ int nvme_auth_transform_key(struct nvme_dhchap_key *key, char *nqn, goto out_free_tfm; } - shash =kmalloc (sizeof (struct shash_desc ) + -crypto_shash_descsize (key_tfm), -GFP_KERNEL ); -if (!shash) { - ret = -ENOMEM ; - goto out_free_transformed_data; - } - shash->tfm = key_tfm; ret =crypto_shash_setkey (key_tfm, key->key, key->len);if (ret <0 ) - goto out_free_shash; + goto out_free_transformed_data; ret =crypto_shash_init (shash);if (ret <0 ) - goto out_free_shash; + goto out_free_transformed_data; ret =crypto_shash_update (shash, nqn,strlen (nqn));if (ret <0 ) - goto out_free_shash; + goto out_free_transformed_data; ret =crypto_shash_update (shash,"NVMe-over-Fabrics" ,17 );if (ret <0 ) - goto out_free_shash; + goto out_free_transformed_data; ret =crypto_shash_final (shash, transformed_data);if (ret <0 ) - goto out_free_shash; + goto out_free_transformed_data; -kfree (shash);crypto_free_shash (key_tfm); *transformed_secret = transformed_data;return transformed_len; -out_free_shash: -kfree (shash); out_free_transformed_data:kfree (transformed_data); out_free_tfm:
Signature · 1 line
2.35.3
Christoph Hellwig
maintainerRe: [PATCH 02/12] nvme-auth: use SHASH_DESC_ON_STACK
Quoted 1 line · Hannes Reinecke
Use
SHASH_DESC_ON_STACKto avoid explicit allocation.
Can you send these two as standalone patches for ASAP inclusion, please? They look nice and unrelated to the rest of the series.
Hannes Reinecke
maintainerRe: [PATCH 02/12] nvme-auth: use SHASH_DESC_ON_STACK
Quoted 6 lines · Christoph Hellwig
Quoted 1 line · Hannes Reinecke
Use
SHASH_DESC_ON_STACKto avoid explicit allocation.Can you send these two as standalone patches for ASAP inclusion, please? They look nice and unrelated to the rest of the series.
Why, sure.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions GmbH, Frankenstr. 146, 90461 Nürnberg HRB 36809 (AG Nürnberg), GF: I. Totev, A. McDonald, W. Knoblich
Christoph Hellwig
maintainerRe: [PATCH 02/12] nvme-auth: use SHASH_DESC_ON_STACK
Quoted 4 lines · Hannes Reinecke
Quoted 3 lines
Can you send these two as standalone patches for ASAP inclusion, please? They look nice and unrelated to the rest of the series.
Why,
Because it's nice to be able to queue up obvious simplifications and speedups ASAP while features tend to go through longer review cycles.
PATCH 3/12 nvmet-auth: use SHASH_DESC_ON_STACK
In reply to Hannes ReineckeUse SHASH_DESC_ON_STACK to avoid explicit allocation.
--- drivers/nvme/target/auth.c | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-)
drivers/nvme/target/auth.c +2 -10
@@ -290,7 +290,7 @@ int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response, unsigned int shash_len) {struct crypto_shash *shash_tfm; -struct shash_desc *shash; +SHASH_DESC_ON_STACK (shash, shash_tfm);struct nvmet_ctrl *ctrl = req->sq->ctrl;const char *hash_name;u8 *challenge = req->sq->dhchap_c1;
@@ -342,19 +342,13 @@ int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response, req->sq->dhchap_c1, challenge, shash_len);if (ret) - goto out_free_challenge; + goto out; }pr_debug ("ctrl %d qid %d host response seq %u transaction %d\n" , ctrl->cntlid, req->sq->qid, req->sq->dhchap_s1, req->sq->dhchap_tid); - shash =kzalloc (sizeof (*shash) +crypto_shash_descsize (shash_tfm), -GFP_KERNEL ); -if (!shash) { - ret = -ENOMEM ; - goto out_free_challenge; - } shash->tfm = shash_tfm; ret =crypto_shash_init (shash);if (ret)
@@ -389,8 +383,6 @@ int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response, goto out; ret =crypto_shash_final (shash, response); out: -kfree (shash); -out_free_challenge:if (challenge != req->sq->dhchap_c1)kfree (challenge); out_free_response:
Signature · 1 line
2.35.3
PATCH 4/12 nvme-auth: do not cache the transformed secret
In reply to Hannes ReineckeOnly saving so much, and doesn't bring much benefit.
--- drivers/nvme/host/auth.c | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-)
drivers/nvme/host/auth.c +11 -18
@@ -24,8 +24,6 @@ struct nvme_dhchap_queue_context {struct nvme_ctrl *ctrl;struct crypto_shash *shash_tfm;struct crypto_kpp *dh_tfm; -u8 *transformed_secret; -size_t transformed_len;void *buf;int qid;int error;
@@ -431,28 +429,25 @@ static int nvme_auth_dhchap_setup_host_response(struct nvme_ctrl *ctrl, struct nvme_dhchap_queue_context *chap) {SHASH_DESC_ON_STACK (shash, chap->shash_tfm); +u8 *transformed_secret; +size_t transformed_len;u8 buf[4 ], *challenge = chap->c1;int ret;dev_dbg (ctrl->device,"%s: qid %d host response seq %u transaction %d\n" , __func__, chap->qid, chap->s1, chap->transaction); -if (!chap->transformed_secret) { - ret =nvme_auth_transform_key (ctrl->host_key, - ctrl->opts->host->nqn, - &chap->transformed_secret); -if (ret <0 ) -return ret; - chap->transformed_len = ret; - }else { -dev_dbg (ctrl->device,"%s: qid %d re-using host response\n" , - __func__, chap->qid); - } + ret =nvme_auth_transform_key (ctrl->host_key, + ctrl->opts->host->nqn, + &transformed_secret); +if (ret <0 ) +return ret; + transformed_len = ret; ret =crypto_shash_setkey (chap->shash_tfm, - chap->transformed_secret, chap->transformed_len); + transformed_secret, transformed_len);if (ret) { -dev_warn (ctrl->device,"qid %d: failed to set key, error %d\n" , +dev_warn (ctrl->device,"qid %d: failed to set host key, error %d\n" , chap->qid, ret); goto out; }
@@ -509,6 +504,7 @@ static int nvme_auth_dhchap_setup_host_response(struct nvme_ctrl *ctrl, out:if (challenge != chap->c1)kfree (challenge); +kfree (transformed_secret);return ret; }
@@ -657,9 +653,6 @@ static int nvme_auth_dhchap_exponential(struct nvme_ctrl *ctrl,static void nvme_auth_reset_dhchap (struct nvme_dhchap_queue_context *chap) { -kfree (chap->transformed_secret); - chap->transformed_secret =NULL ; - chap->transformed_len =0 ;kfree_sensitive (chap->host_key); chap->host_key =NULL ; chap->host_key_len =0 ;
Signature · 1 line
2.35.3
Christoph Hellwig
maintainerRe: [PATCH 04/12] nvme-auth: do not cache the transformed secret
Quoted 1 line · Hannes Reinecke
Only saving so much, and doesn't bring much benefit.
Sabing what? Please spell out the rationale a bit better, the above leaves me more confused than before.
PATCH 5/12 nvme-keyring: add 'dhchap' key type
In reply to Hannes ReineckeAdd a 'dhchap' keytype to store DH-HMAC-CHAP secret keys. Keys are stored with a 'user-type' compatible payload, such that one can use 'user_read()' to access the raw contents and the 'read()' callback to get the base64-encoded key data in the DH-HMAC-CHAP secret representation.
--- drivers/nvme/common/keyring.c | 266 ++++++++++++++++++++++++++++++++++ include/linux/nvme-keyring.h | 22 ++- 2 files changed, 287 insertions(+), 1 deletion(-)
drivers/nvme/common/keyring.c +266 -0
@@ -4,6 +4,9 @@*/ #include <linux/module.h> +#include <linux/crc32.h> +#include <linux/base64.h> +#include <linux/unaligned.h> #include <linux/seq_file.h> #include <linux/key-type.h> #include <keys/user-type.h>
@@ -252,6 +255,262 @@ key_serial_t nvme_tls_psk_default(struct key *keyring, }EXPORT_SYMBOL_GPL (nvme_tls_psk_default); +static void nvme_dhchap_psk_describe (const struct key *key,struct seq_file *m) +{ +seq_puts (m, key->description); +seq_printf (m,": %u" , key->datalen); +} + +static bool nvme_dhchap_psk_match (const struct key *key, +const struct key_match_data *match_data) +{ +const char *match_id; +size_t match_len; + +if (!key->description) { +pr_debug ("%s: no key description\n" , __func__); +return false; + } +if (!match_data->raw_data) { +pr_debug ("%s: no match data\n" , __func__); +return false; + } + match_id = match_data->raw_data; + match_len =strlen (match_id); +pr_debug ("%s: match '%s' '%s' len %zd\n" , + __func__, match_id, key->description, match_len); + +return !memcmp (key->description, match_id, match_len); +} + +static int nvme_dhchap_psk_match_preparse (struct key_match_data *match_data) +{ + match_data->lookup_type =KEYRING_SEARCH_LOOKUP_ITERATE ; + match_data->cmp = nvme_dhchap_psk_match; +return 0 ; +} + +/** +* nvme_dhchap_psk_preparse - prepare DH-HMAC-CHAP key data +* @prep: preparsed payload of the key data +* +* Decode the DH-HMAC-CHAP key data passed in in @prep and +* store the resulting binary data. The binary data includes +* space for the CRC, the version, and the hmac identifier, +* but the data length is just the key data without the CRC. +* This allows the user to read the key data via the +* 'user_read()' function, but also to export the full +* key data including CRC via the 'read' callback from the key type. +*/ +static int nvme_dhchap_psk_preparse (struct key_preparsed_payload *prep) +{ +struct user_key_payload *upayload; +size_t datalen = prep->datalen, keylen; +int ret; +u32 crc; +u8 version, hmac; + +if (!prep->data) { +pr_debug ("%s: Empty data" , __func__); + prep->payload.data[0 ] =NULL ; + prep->quotalen =0 ; +return -EINVAL ; + } + +if (sscanf (prep->data,"DHHC-%01hhu:%02hhu:%*s" , &version, &hmac) !=2 ) { +pr_debug ("%s: invalid key data '%s'\n" , __func__, + (char *)prep->data); + prep->payload.data[0 ] =NULL ; + prep->quotalen =0 ; +return -EINVAL ; + } + +/* skip header and final ':' character */ + datalen -=11 ; + +/* keylen is the key length, 4 bytes CRC, 1 byte version, and 1 byte HMAC identifier */ +switch (datalen) { +case 48 : + keylen =38 ; +break ; +case 72 : + keylen =54 ; +break ; +case 92 : + keylen =70 ; +break ; +default : +pr_debug ("%s: Invalid data length %lu\n" , __func__, datalen); + prep->payload.data[0 ] =NULL ; + prep->quotalen =0 ; +return -EINVAL ; + } + + upayload =kzalloc (sizeof (*upayload) + keylen,GFP_KERNEL ); +if (!upayload) { + prep->payload.data[0 ] =NULL ; + prep->quotalen =0 ; +return -ENOMEM ; + } + +/* decode the data */ + prep->quotalen = keylen; + prep->payload.data[0 ] = upayload; + ret =base64_decode (prep->data +10 , datalen, upayload->data); +if (ret <0 ) { +pr_debug ("%s: Failed to decode key %s\n" , + __func__, (char *)prep->data +10 ); +return ret; + } + ret -=4 ; + crc = ~crc32 (~0 , upayload->data, ret); +if (get_unaligned_le32 (upayload->data + ret) != crc) { +pr_debug ("%s: CRC mismatch for key\n" , __func__); +/* CRC mismatch */ +return -EKEYREJECTED ; + } + upayload->data[ret +4 ] = version; + upayload->data[ret +5 ] = hmac; + upayload->datalen = ret; +return 0 ; +} + +static long nvme_dhchap_psk_read (const struct key *key,char *buffer,size_t buflen) +{ +const struct user_key_payload *upayload; +size_t datalen, keylen; +u8 version, hmac; +long ret; + + upayload =user_key_payload_locked (key); +switch (upayload->datalen) { +case 32 : + keylen =59 ; +break ; +case 48 : + keylen =83 ; +break ; +case 64 : + keylen =103 ; +break ; +default : +return -EINVAL ; + } + +if (!buffer || buflen ==0 ) +return keylen; + +if (buflen < keylen) +return -EINVAL ; + +memset (buffer,0 , buflen); + version = upayload->data[upayload->datalen +4 ]; + hmac = upayload->data[upayload->datalen +5 ]; + ret =sprintf (buffer,"DHHC-%01hhu:%02hhu:" , version, hmac); +if (ret <0 ) +return -ENOKEY ; +/* Include the trailing CRC */ + datalen = upayload->datalen +4 ; + ret +=base64_encode (upayload->data, datalen, buffer + ret); + buffer[ret] =':' ; + ret++; +return ret; +} + +static struct key_type nvme_dhchap_psk_key_type = { + .name ="dhchap" , + .flags =KEY_TYPE_NET_DOMAIN , + .preparse = nvme_dhchap_psk_preparse, + .free_preparse = user_free_preparse, + .match_preparse = nvme_dhchap_psk_match_preparse, + .instantiate = generic_key_instantiate, + .revoke = user_revoke, + .destroy = user_destroy, + .describe = nvme_dhchap_psk_describe, + .read = nvme_dhchap_psk_read, +}; + +struct key *nvme_dhchap_psk_refresh (struct key *keyring, +const u8 *data,size_t data_len) +{ +key_perm_t keyperm = +KEY_POS_SEARCH |KEY_POS_VIEW |KEY_POS_READ | +KEY_POS_WRITE |KEY_POS_LINK |KEY_POS_SETATTR | +KEY_USR_SEARCH |KEY_USR_VIEW |KEY_USR_READ ; +char *identity; +key_ref_t keyref; +key_serial_t keyring_id; +struct key *key; +uuid_t key_uuid; + +if (data ==NULL || !data_len) +return ERR_PTR (-EINVAL ); + +generate_random_uuid (key_uuid.b); + identity =kasprintf (GFP_KERNEL ,"%pU" , &key_uuid); +if (!identity) +return ERR_PTR (-ENOMEM ); +if (!keyring) + keyring = nvme_keyring; + keyring_id =key_serial (keyring); + +pr_debug ("keyring %x generate dhchap psk '%s'\n" , + keyring_id, identity); + keyref =key_create (make_key_ref (keyring, true), +"dhchap" , identity, data, data_len, + keyperm,KEY_ALLOC_NOT_IN_QUOTA | +KEY_ALLOC_BUILT_IN | +KEY_ALLOC_BYPASS_RESTRICTION ); +if (IS_ERR (keyref)) { +pr_warn ("refresh dhchap psk '%s' failed, error %ld\n" , + identity,PTR_ERR (keyref)); +kfree (identity); +return ERR_PTR (-ENOKEY ); + } + key =key_ref_to_ptr (keyref); +pr_debug ("generated dhchap psk %08x\n" ,key_serial (key)); +kfree (identity); +return key; +} +EXPORT_SYMBOL_GPL (nvme_dhchap_psk_refresh); + +struct key *nvme_dhchap_psk_lookup (struct key *keyring,const char *identity) +{ +key_ref_t keyref; +key_serial_t keyring_id; + +if (!keyring) + keyring = nvme_keyring; + keyring_id =key_serial (keyring); +pr_debug ("keyring %x lookup dhchap psk '%s'\n" , + keyring_id, identity); + + keyref =keyring_search (make_key_ref (keyring, true), + &nvme_dhchap_psk_key_type, + identity, false); +if (IS_ERR (keyref)) { +pr_debug ("lookup dhchap psk '%s' failed, error %ld\n" , + identity,PTR_ERR (keyref)); +return ERR_PTR (-ENOKEY ); + } + +return key_ref_to_ptr (keyref); +} +EXPORT_SYMBOL_GPL (nvme_dhchap_psk_lookup); + +u8 nvme_dhchap_psk_hash (struct key *key) +{ +const struct user_key_payload *upayload; +u8 hmac; + +if (!key) +return 0 ; + upayload =user_key_payload_locked (key); + hmac = upayload->data[upayload->datalen +5 ]; +return hmac; +} +EXPORT_SYMBOL_GPL (nvme_dhchap_psk_hash); +static int __init nvme_keyring_init (void ) {int err;
@@ -270,11 +529,18 @@ static int __init nvme_keyring_init(void)key_put (nvme_keyring);return err; } + err =register_key_type (&nvme_dhchap_psk_key_type); +if (err) { +unregister_key_type (&nvme_tls_psk_key_type); +key_put (nvme_keyring); +return err; + }return 0 ; } static void __exit nvme_keyring_exit(void) { +unregister_key_type (&nvme_dhchap_psk_key_type);unregister_key_type (&nvme_tls_psk_key_type);key_revoke (nvme_keyring);key_put (nvme_keyring);
include/linux/nvme-keyring.h +21 -1
@@ -18,9 +18,14 @@ key_serial_t nvme_tls_psk_default(struct key *keyring,key_serial_t nvme_keyring_id (void );struct key *nvme_tls_key_lookup (key_serial_t key_id); + +struct key *nvme_dhchap_psk_refresh (struct key *keyring, +const u8 *data,size_t data_len); +struct key *nvme_dhchap_psk_lookup (struct key *keyring,const char *identity); +u8 nvme_dhchap_psk_hash (struct key *key); +#else static inline struct key *nvme_tls_psk_refresh (struct key *keyring, -const char *hostnqn,char *subnqn,u8 hmac_id,u8 *data,size_t data_len,const char *digest) {return ERR_PTR (-ENOTSUPP );
@@ -38,5 +43,20 @@ static inline struct key *nvme_tls_key_lookup(key_serial_t key_id) {return ERR_PTR (-ENOTSUPP ); } +static inline struct key *nvme_dhchap_psk_refresh (struct key *keyring, +const char *hostnqn,const char *subnqn, +u8 *data,size_t data_len) +{ +return ERR_PTR (-ENOTSUPP ); +} +static inline struct key *nvme_dhchap_psk_lookup (struct key *keyring, +const char *hostnqn,const char *subnqn,u8 hmac); +{ +return ERR_PTR (-ENOTSUPP ); +} +u8 nvme_dhchap_psk_hash (struct key *key) +{ +return 0 ; +}#endif /* !CONFIG_NVME_KEYRING */ #endif /* _NVME_KEYRING_H */
Signature · 1 line
2.35.3
PATCH 6/12 nvme-auth: switch to use 'struct key'
In reply to Hannes ReineckeUse the new key type 'dhchap' to store the DH-HMAC-CHAP keys and modify handling function to use 'struct key'.
--- drivers/nvme/common/Kconfig | 1 + drivers/nvme/common/auth.c | 141 ++++++++++++++---------------------- drivers/nvme/host/Kconfig | 1 - drivers/nvme/host/auth.c | 28 ++++--- drivers/nvme/host/nvme.h | 4 +- drivers/nvme/host/sysfs.c | 25 +++---- drivers/nvme/target/Kconfig | 1 - drivers/nvme/target/auth.c | 40 +++++----- drivers/nvme/target/nvmet.h | 4 +- include/linux/nvme-auth.h | 8 +- 10 files changed, 113 insertions(+), 140 deletions(-)
drivers/nvme/common/Kconfig +1 -0
@@ -13,3 +13,4 @@ config NVME_AUTH select CRYPTO_DH select CRYPTO_DH_RFC7919_GROUPS select CRYPTO_HKDF + select NVME_KEYRING
drivers/nvme/common/auth.c +54 -87
204 lines not on this page · raw message
drivers/nvme/host/Kconfig +0 -1
@@ -114,7 +114,6 @@ config NVME_HOST_AUTH bool "NVMe over Fabrics In-Band Authentication in host side" depends on NVME_CORE select NVME_AUTH - select NVME_KEYRING help This provides support for NVMe over Fabrics In-Band Authentication in host side.
drivers/nvme/host/auth.c +18 -10
@@ -1048,14 +1048,22 @@ int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl)INIT_WORK (&ctrl->dhchap_auth_work, nvme_ctrl_auth_work);if (!ctrl->opts)return 0 ; - ret =nvme_auth_generate_key (ctrl->opts->dhchap_secret, - &ctrl->host_key); -if (ret) + ctrl->host_key =nvme_auth_extract_key (ctrl->opts->keyring, + ctrl->opts->dhchap_secret, +strlen (ctrl->opts->dhchap_secret)); +if (IS_ERR (ctrl->host_key)) { + ret =PTR_ERR (ctrl->host_key); + ctrl->host_key =NULL ;return ret; - ret =nvme_auth_generate_key (ctrl->opts->dhchap_ctrl_secret, - &ctrl->ctrl_key); -if (ret) + } + ctrl->ctrl_key =nvme_auth_extract_key (ctrl->opts->keyring, + ctrl->opts->dhchap_ctrl_secret, +strlen (ctrl->opts->dhchap_ctrl_secret)); +if (IS_ERR (ctrl->ctrl_key)) { + ret =PTR_ERR (ctrl->ctrl_key); + ctrl->ctrl_key =NULL ; goto err_free_dhchap_secret; + }if (!ctrl->opts->dhchap_secret && !ctrl->opts->dhchap_ctrl_secret)return 0 ;
@@ -1076,10 +1084,10 @@ int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl)return 0 ; err_free_dhchap_ctrl_secret: -nvme_auth_free_key (ctrl->ctrl_key); +key_put (ctrl->ctrl_key); ctrl->ctrl_key =NULL ; err_free_dhchap_secret: -nvme_auth_free_key (ctrl->host_key); +key_put (ctrl->host_key); ctrl->host_key =NULL ;return ret; }
@@ -1101,11 +1109,11 @@ void nvme_auth_free(struct nvme_ctrl *ctrl)kfree (ctrl->dhchap_ctxs); }if (ctrl->host_key) { -nvme_auth_free_key (ctrl->host_key); +key_put (ctrl->host_key); ctrl->host_key =NULL ; }if (ctrl->ctrl_key) { -nvme_auth_free_key (ctrl->ctrl_key); +key_put (ctrl->ctrl_key); ctrl->ctrl_key =NULL ; } }
drivers/nvme/host/nvme.h +2 -2
@@ -378,8 +378,8 @@ struct nvme_ctrl {struct work_struct dhchap_auth_work;struct mutex dhchap_auth_mutex;struct nvme_dhchap_queue_context *dhchap_ctxs; -struct nvme_dhchap_key *host_key; -struct nvme_dhchap_key *ctrl_key; +struct key *host_key; +struct key *ctrl_key;u16 transaction;#endif key_serial_t tls_pskid;
drivers/nvme/host/sysfs.c +11 -14
@@ -589,8 +589,6 @@ static ssize_t nvme_ctrl_dhchap_secret_store(struct device *dev,return -EINVAL ;if (count <7 )return -EINVAL ; -if (memcmp (buf,"DHHC-1:" ,7 )) -return -EINVAL ; dhchap_secret =kzalloc (count +1 ,GFP_KERNEL );if (!dhchap_secret)
@@ -598,13 +596,12 @@ static ssize_t nvme_ctrl_dhchap_secret_store(struct device *dev,memcpy (dhchap_secret, buf, count);nvme_auth_stop (ctrl);if (strcmp (dhchap_secret, opts->dhchap_secret)) { -struct nvme_dhchap_key *key, *host_key; -int ret; +struct key *key, *host_key; - ret =nvme_auth_generate_key (dhchap_secret, &key); -if (ret) { + key =nvme_auth_extract_key (opts->keyring, dhchap_secret, count); +if (IS_ERR (key)) {kfree (dhchap_secret); -return ret; +return PTR_ERR (key); }kfree (opts->dhchap_secret); opts->dhchap_secret = dhchap_secret;
@@ -612,7 +609,7 @@ static ssize_t nvme_ctrl_dhchap_secret_store(struct device *dev,mutex_lock (&ctrl->dhchap_auth_mutex); ctrl->host_key = key;mutex_unlock (&ctrl->dhchap_auth_mutex); -nvme_auth_free_key (host_key); +key_put (host_key); }else kfree (dhchap_secret);/* Start re-authentication */
@@ -656,13 +653,13 @@ static ssize_t nvme_ctrl_dhchap_ctrl_secret_store(struct device *dev,memcpy (dhchap_secret, buf, count);nvme_auth_stop (ctrl);if (strcmp (dhchap_secret, opts->dhchap_ctrl_secret)) { -struct nvme_dhchap_key *key, *ctrl_key; -int ret; +struct key *key, *ctrl_key; - ret =nvme_auth_generate_key (dhchap_secret, &key); -if (ret) { + key =nvme_auth_extract_key (opts->keyring, + dhchap_secret, count); +if (IS_ERR (key)) {kfree (dhchap_secret); -return ret; +return PTR_ERR (key); }kfree (opts->dhchap_ctrl_secret); opts->dhchap_ctrl_secret = dhchap_secret;
@@ -670,7 +667,7 @@ static ssize_t nvme_ctrl_dhchap_ctrl_secret_store(struct device *dev,mutex_lock (&ctrl->dhchap_auth_mutex); ctrl->ctrl_key = key;mutex_unlock (&ctrl->dhchap_auth_mutex); -nvme_auth_free_key (ctrl_key); +key_put (ctrl_key); }else kfree (dhchap_secret);/* Start re-authentication */
drivers/nvme/target/Kconfig +0 -1
@@ -5,7 +5,6 @@ config NVME_TARGET depends on BLOCK depends on CONFIGFS_FS select NVME_KEYRING if NVME_TARGET_TCP_TLS - select KEYS if NVME_TARGET_TCP_TLS select SGL_ALLOC help This enabled target side support for the NVMe protocol, that is
drivers/nvme/target/auth.c +22 -18
@@ -145,6 +145,7 @@ u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq)int ret =0 ;struct nvmet_host_link *p;struct nvmet_host *host =NULL ; +u8 host_hash, ctrl_hash;down_read (&nvmet_config_sem);if (nvmet_is_disc_subsys (ctrl->subsys))
@@ -190,42 +191,43 @@ u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq) ctrl->shash_id = host->dhchap_hash_id; } -/* Skip the 'DHHC-1:XX:' prefix */ -nvme_auth_free_key (ctrl->host_key); - ctrl->host_key =nvme_auth_extract_key (host->dhchap_secret +10 , - host->dhchap_key_hash); +key_put (ctrl->host_key); + ctrl->host_key =nvme_auth_extract_key (NULL , host->dhchap_secret, +strlen (host->dhchap_secret));if (IS_ERR (ctrl->host_key)) { ret =NVME_AUTH_DHCHAP_FAILURE_NOT_USABLE ; ctrl->host_key =NULL ; goto out_free_hash; } -pr_debug ("%s: using hash %s key %*ph\n" , __func__, - ctrl->host_key->hash >0 ? -nvme_auth_hmac_name (ctrl->host_key->hash) :"none" , - (int )ctrl->host_key->len, ctrl->host_key->key); + host_hash =nvme_dhchap_psk_hash (ctrl->host_key); +pr_debug ("%s: using hash %s key %u\n" , __func__, + ctrl_hash >0 ? +nvme_auth_hmac_name (ctrl_hash) :"none" , +key_serial (ctrl->host_key)); -nvme_auth_free_key (ctrl->ctrl_key); +key_put (ctrl->ctrl_key);if (!host->dhchap_ctrl_secret) { ctrl->ctrl_key =NULL ; goto out_unlock; } - ctrl->ctrl_key =nvme_auth_extract_key (host->dhchap_ctrl_secret +10 , - host->dhchap_ctrl_key_hash); + ctrl->ctrl_key =nvme_auth_extract_key (NULL , host->dhchap_ctrl_secret, +strlen (host->dhchap_ctrl_secret));if (IS_ERR (ctrl->ctrl_key)) { ret =NVME_AUTH_DHCHAP_FAILURE_NOT_USABLE ; ctrl->ctrl_key =NULL ; goto out_free_hash; } -pr_debug ("%s: using ctrl hash %s key %*ph\n" , __func__, - ctrl->ctrl_key->hash >0 ? -nvme_auth_hmac_name (ctrl->ctrl_key->hash) :"none" , - (int )ctrl->ctrl_key->len, ctrl->ctrl_key->key); + ctrl_hash =nvme_dhchap_psk_hash (ctrl->ctrl_key); +pr_debug ("%s: using ctrl hash %s key %u\n" , __func__, + ctrl_hash >0 ? +nvme_auth_hmac_name (ctrl_hash) :"none" , +key_serial (ctrl->ctrl_key)); out_free_hash:if (ret) {if (ctrl->host_key) { -nvme_auth_free_key (ctrl->host_key); +key_put (ctrl->host_key); ctrl->host_key =NULL ; } ctrl->shash_id =0 ;
@@ -263,11 +265,13 @@ void nvmet_destroy_auth(struct nvmet_ctrl *ctrl) ctrl->dh_key =NULL ;if (ctrl->host_key) { -nvme_auth_free_key (ctrl->host_key); +key_revoke (ctrl->host_key); +key_put (ctrl->host_key); ctrl->host_key =NULL ; }if (ctrl->ctrl_key) { -nvme_auth_free_key (ctrl->ctrl_key); +key_revoke (ctrl->ctrl_key); +key_put (ctrl->ctrl_key); ctrl->ctrl_key =NULL ; }#ifdef CONFIG_NVME_TARGET_TCP_TLS
drivers/nvme/target/nvmet.h +2 -2
@@ -294,8 +294,8 @@ struct nvmet_ctrl {bool pi_support;bool concat;#ifdef CONFIG_NVME_TARGET_AUTH -struct nvme_dhchap_key *host_key; -struct nvme_dhchap_key *ctrl_key; +struct key *host_key; +struct key *ctrl_key;u8 shash_id;struct crypto_kpp *dh_tfm;u8 dh_gid;
include/linux/nvme-auth.h +3 -5
@@ -25,13 +25,11 @@ size_t nvme_auth_hmac_hash_len(u8 hmac_id);u8 nvme_auth_hmac_id (const char *hmac_name);u32 nvme_auth_key_struct_size (u32 key_len); -struct nvme_dhchap_key *nvme_auth_extract_key (unsigned char *secret, -u8 key_hash); +struct key *nvme_auth_extract_key (struct key *keyring,const u8 *secret,size_t secret_len);void nvme_auth_free_key (struct nvme_dhchap_key *key);struct nvme_dhchap_key *nvme_auth_alloc_key (u32 len,u8 hash); -int nvme_auth_transform_key (struct nvme_dhchap_key *key,char *nqn, -u8 **transformed_secret) ; -int nvme_auth_generate_key (u8 *secret,struct nvme_dhchap_key **ret_key); +int nvme_auth_transform_key (struct key *key,char *nqn, +u8 **transformed_secret);int nvme_auth_augmented_challenge (u8 hmac_id,u8 *skey,size_t skey_len,u8 *challenge,u8 *aug,size_t hlen);int nvme_auth_gen_privkey (struct crypto_kpp *dh_tfm,u8 dh_gid);
Signature · 1 line
2.35.3
PATCH 7/12 nvme-auth: drop nvme_dhchap_key structure and unused functions
In reply to Hannes ReineckeDrop the hand-crafted nvme_dhchap_key structure and the now unused functions.
--- drivers/nvme/common/auth.c | 29 ----------------------------- include/linux/nvme-auth.h | 9 --------- 2 files changed, 38 deletions(-)
drivers/nvme/common/auth.c +0 -29
@@ -155,14 +155,6 @@ size_t nvme_auth_hmac_hash_len(u8 hmac_id) }EXPORT_SYMBOL_GPL (nvme_auth_hmac_hash_len); -u32 nvme_auth_key_struct_size (u32 key_len) -{ -struct nvme_dhchap_key key; - -return struct_size (&key, key, key_len); -} -EXPORT_SYMBOL_GPL (nvme_auth_key_struct_size); -struct key *nvme_auth_extract_key (struct key *keyring,const u8 *secret,size_t secret_len) {
@@ -176,27 +168,6 @@ struct key *nvme_auth_extract_key(struct key *keyring, const u8 *secret, }EXPORT_SYMBOL_GPL (nvme_auth_extract_key); -struct nvme_dhchap_key *nvme_auth_alloc_key (u32 len,u8 hash) -{ -u32 num_bytes =nvme_auth_key_struct_size (len); -struct nvme_dhchap_key *key =kzalloc (num_bytes,GFP_KERNEL ); - -if (key) { - key->len = len; - key->hash = hash; - } -return key; -} -EXPORT_SYMBOL_GPL (nvme_auth_alloc_key); - -void nvme_auth_free_key (struct nvme_dhchap_key *key) -{ -if (!key) -return ; -kfree_sensitive (key); -} -EXPORT_SYMBOL_GPL (nvme_auth_free_key); -int nvme_auth_transform_key (struct key *key,char *nqn,u8 **transformed_secret) {
include/linux/nvme-auth.h +0 -9
@@ -8,12 +8,6 @@#include <crypto/kpp.h> -struct nvme_dhchap_key { -size_t len; -u8 hash; -u8 key[]; -}; -u32 nvme_auth_get_seqnum (void );const char *nvme_auth_dhgroup_name (u8 dhgroup_id);const char *nvme_auth_dhgroup_kpp (u8 dhgroup_id);
@@ -24,10 +18,7 @@ const char *nvme_auth_digest_name(u8 hmac_id);size_t nvme_auth_hmac_hash_len (u8 hmac_id);u8 nvme_auth_hmac_id (const char *hmac_name); -u32 nvme_auth_key_struct_size (u32 key_len);struct key *nvme_auth_extract_key (struct key *keyring,const u8 *secret,size_t secret_len); -void nvme_auth_free_key (struct nvme_dhchap_key *key); -struct nvme_dhchap_key *nvme_auth_alloc_key (u32 len,u8 hash);int nvme_auth_transform_key (struct key *key,char *nqn,u8 **transformed_secret); int nvme_auth_augmented_challenge(u8 hmac_id, u8 *skey, size_t skey_len,
Signature · 1 line
2.35.3
Christoph Hellwig
maintainerRe: [PATCH 07/12] nvme-auth: drop nvme_dhchap_key structure and unused functions
Quoted 2 lines · Hannes Reinecke
Drop the hand-crafted
nvme_dhchap_keystructure and the now unused functions.
This should go into the previous patch instead of just creating dead code there.
Hannes Reinecke
maintainerRe: [PATCH 07/12] nvme-auth: drop nvme_dhchap_key structure and unused functions
Quoted 7 lines · Christoph Hellwig
Quoted 2 lines · Hannes Reinecke
Drop the hand-crafted
nvme_dhchap_keystructure and the now unused functions.This should go into the previous patch instead of just creating dead code there.
Will be doing so for the next round.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions GmbH, Frankenstr. 146, 90461 Nürnberg HRB 36809 (AG Nürnberg), GF: I. Totev, A. McDonald, W. Knoblich
PATCH 8/12 nvme: parse dhchap keys during option parsing
In reply to Hannes ReineckeWe really should parse the dhchap keys during option parsing to avoid having to pass around the plain dhchap secret. During options parsing we will create a 'dhchap' key with a random UUID as description, and store the key serial in the 'opts' structure.
This simplifies key handling as on every access the key needs to be looked up and checked for validity before accessing the key data.
--- drivers/nvme/host/auth.c | 113 ++++++++++++++++------ drivers/nvme/host/fabrics.c | 82 +++++++++++----- drivers/nvme/host/fabrics.h | 8 +- drivers/nvme/host/sysfs.c | 185 ++++++++++++++++++++++++++---------- 4 files changed, 278 insertions(+), 110 deletions(-)
drivers/nvme/host/auth.c +82 -31
@@ -527,7 +527,7 @@ static int nvme_auth_dhchap_setup_ctrl_response(struct nvme_ctrl *ctrl, ret =crypto_shash_setkey (chap->shash_tfm, transformed_secret, transformed_len);if (ret) { -dev_warn (ctrl->device,"qid %d: failed to set key, error %d\n" , +dev_warn (ctrl->device,"qid %d: failed to set ctrl key, error %d\n" , chap->qid, ret); goto out; }
@@ -959,11 +959,6 @@ int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid)return -ENOKEY ; } -if (ctrl->opts->dhchap_ctrl_secret && !ctrl->ctrl_key) { -dev_warn (ctrl->device,"qid %d: invalid ctrl key\n" , qid); -return -ENOKEY ; - } - chap = &ctrl->dhchap_ctxs[qid];cancel_work_sync (&chap->auth_work);queue_work (nvme_auth_wq, &chap->auth_work);
@@ -1039,6 +1034,26 @@ static void nvme_ctrl_auth_work(struct work_struct *work) } } +static void nvme_auth_clear_key (struct nvme_ctrl *ctrl,bool is_ctrl) +{ +struct key *key; + +if (is_ctrl) { + key = ctrl->ctrl_key; + ctrl->ctrl_key =NULL ; + }else { + key = ctrl->host_key; + ctrl->host_key =NULL ; + } +if (key) { +dev_dbg (ctrl->device,"%s: revoke%s key %08x\n" , + __func__, is_ctrl ?" ctrl" :"" , +key_serial (key)); +key_revoke (key); +key_put (key); + } +} +int nvme_auth_init_ctrl (struct nvme_ctrl *ctrl) {struct nvme_dhchap_queue_context *chap;
@@ -1048,31 +1063,70 @@ int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl)INIT_WORK (&ctrl->dhchap_auth_work, nvme_ctrl_auth_work);if (!ctrl->opts)return 0 ; - ctrl->host_key =nvme_auth_extract_key (ctrl->opts->keyring, - ctrl->opts->dhchap_secret, -strlen (ctrl->opts->dhchap_secret)); -if (IS_ERR (ctrl->host_key)) { - ret =PTR_ERR (ctrl->host_key); - ctrl->host_key =NULL ; -return ret; +if (!ctrl->opts->dhchap_key) { +nvme_auth_clear_key (ctrl, false); +nvme_auth_clear_key (ctrl, true); +return 0 ; } - ctrl->ctrl_key =nvme_auth_extract_key (ctrl->opts->keyring, - ctrl->opts->dhchap_ctrl_secret, -strlen (ctrl->opts->dhchap_ctrl_secret)); -if (IS_ERR (ctrl->ctrl_key)) { - ret =PTR_ERR (ctrl->ctrl_key); - ctrl->ctrl_key =NULL ; - goto err_free_dhchap_secret; + +if (ctrl->host_key) +nvme_auth_clear_key (ctrl, false); + + ctrl->host_key =key_get (ctrl->opts->dhchap_key); +if (!ctrl->host_key) { +dev_warn (ctrl->device, +"dhchap key %08x not present\n" , +key_serial (ctrl->opts->dhchap_key)); +return -ENOKEY ; + } +down_read (&ctrl->host_key->sem); + ret =key_validate (ctrl->host_key); +up_read (&ctrl->host_key->sem); +if (ret) { +dev_warn (ctrl->device, +"dhchap key %08x invalidated\n" , +key_serial (ctrl->host_key)); +key_put (ctrl->host_key); + ctrl->host_key =NULL ; +return -ENOKEY ; } +dev_dbg (ctrl->device, +"%s: using dhchap key %08x\n" , + __func__,key_serial (ctrl->host_key)); -if (!ctrl->opts->dhchap_secret && !ctrl->opts->dhchap_ctrl_secret) -return 0 ; +if (ctrl->ctrl_key) +nvme_auth_clear_key (ctrl, true); + +if (ctrl->opts->dhchap_ctrl_key) { + ctrl->ctrl_key =key_get (ctrl->opts->dhchap_ctrl_key); +if (!ctrl->ctrl_key) { +dev_warn (ctrl->device, +"dhchap ctrl key %08x not present\n" , +key_serial (ctrl->opts->dhchap_ctrl_key)); +return -ENOKEY ; + } +down_read (&ctrl->ctrl_key->sem); + ret =key_validate (ctrl->ctrl_key); +up_read (&ctrl->ctrl_key->sem); +if (ret) { +dev_warn (ctrl->device, +"dhchap ctrl key %08x invalidated\n" , +key_serial (ctrl->ctrl_key)); +key_put (ctrl->ctrl_key); + ctrl->ctrl_key =NULL ; +return -EKEYREVOKED ; + } +dev_dbg (ctrl->device, +"%s: using dhchap ctrl key %08x\n" , + __func__,key_serial (ctrl->ctrl_key)); + } ctrl->dhchap_ctxs =kvcalloc (ctrl_max_dhchaps (ctrl),sizeof (*chap),GFP_KERNEL );if (!ctrl->dhchap_ctxs) { - ret = -ENOMEM ; - goto err_free_dhchap_ctrl_secret; +nvme_auth_clear_key (ctrl, true); +nvme_auth_clear_key (ctrl, false); +return -ENOMEM ; }for (i =0 ; i <ctrl_max_dhchaps (ctrl); i++) {
@@ -1083,13 +1137,6 @@ int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl) }return 0 ; -err_free_dhchap_ctrl_secret: -key_put (ctrl->ctrl_key); - ctrl->ctrl_key =NULL ; -err_free_dhchap_secret: -key_put (ctrl->host_key); - ctrl->host_key =NULL ; -return ret; }EXPORT_SYMBOL_GPL (nvme_auth_init_ctrl);
@@ -1109,10 +1156,14 @@ void nvme_auth_free(struct nvme_ctrl *ctrl)kfree (ctrl->dhchap_ctxs); }if (ctrl->host_key) { +dev_dbg (ctrl->device,"%s: drop host key %08x\n" , + __func__,key_serial (ctrl->host_key));key_put (ctrl->host_key); ctrl->host_key =NULL ; }if (ctrl->ctrl_key) { +dev_dbg (ctrl->device,"%s: drop ctrl key %08x\n" , + __func__,key_serial (ctrl->ctrl_key));key_put (ctrl->ctrl_key); ctrl->ctrl_key =NULL ; }
drivers/nvme/host/fabrics.c +58 -24
137 lines not on this page · raw message
drivers/nvme/host/fabrics.h +4 -4
@@ -96,8 +96,8 @@ enum {* @discovery_nqn: indicates if the subsysnqn is the well-known discovery NQN. * @kato: Keep-alive timeout. * @host: Virtual NVMe host, contains the NQN and Host ID. -* @dhchap_secret: DH-HMAC-CHAP secret -* @dhchap_ctrl_secret: DH-HMAC-CHAP controller secret for bi-directional +* @dhchap_key: DH-HMAC-CHAP pre-shared key +* @dhchap_ctrl_key: DH-HMAC-CHAP controller pre-shared key for bi-directional * authentication * @keyring: Keyring to use for key lookups * @tls_key: TLS key for encrypted connections (TCP)
@@ -127,8 +127,8 @@ struct nvmf_ctrl_options {bool duplicate_connect;unsigned int kato;struct nvmf_host *host; -char *dhchap_secret; -char *dhchap_ctrl_secret; +struct key *dhchap_key; +struct key *dhchap_ctrl_key;struct key *keyring;struct key *tls_key;bool tls;
drivers/nvme/host/sysfs.c +134 -51
247 lines not on this page · raw message
Signature · 1 line
2.35.3
PATCH 9/12 nvmet-auth: parse dhchap key from configfs attribute
In reply to Hannes ReineckeWhen writing a new dhchap key to the 'dhchap_secret' attribute we should be parsing it directly and only use the pointer to the inserted key. This avoids having to pass around a pointer with the actual data. There is only one snag with that; the dhchap controller secret is stored under the host configfs directory, so we have no indication as to which subsystem the dhchap secret matches. So store it with the host NQN as subsystem NQN to indicate that it's a controller secret applicable for any subsystem for this host.
--- drivers/nvme/target/auth.c | 176 +++++++++++++++++++++------------ drivers/nvme/target/configfs.c | 59 ++++++++--- drivers/nvme/target/nvmet.h | 7 +- 3 files changed, 159 insertions(+), 83 deletions(-)
drivers/nvme/target/auth.c +111 -65
@@ -20,54 +20,76 @@#include "nvmet.h" +void nvmet_auth_revoke_key (struct nvmet_host *host,bool set_ctrl) +{ +struct key *key =ERR_PTR (-ENOKEY ); + +if (set_ctrl) { +if (host->dhchap_ctrl_key) { + key = host->dhchap_ctrl_key; + host->dhchap_ctrl_key =NULL ; + } + }else { +if (host->dhchap_key) { + key = host->dhchap_key; + host->dhchap_key =NULL ; + } + } +if (!IS_ERR (key)) { +pr_debug ("%s: revoke %s key %08x\n" , + __func__, set_ctrl ?"ctrl" :"host" , +key_serial (key)); +key_revoke (key); +key_put (key); + } +} +int nvmet_auth_set_key (struct nvmet_host *host,const char *secret,bool set_ctrl) {unsigned char key_hash; -char *dhchap_secret; +struct key *key; +size_t len;if (!strlen (secret)) { -if (set_ctrl) { -kfree (host->dhchap_ctrl_secret); - host->dhchap_ctrl_secret =NULL ; - host->dhchap_ctrl_key_hash =0 ; - }else { -kfree (host->dhchap_secret); - host->dhchap_secret =NULL ; - host->dhchap_key_hash =0 ; - } +nvmet_auth_revoke_key (host, set_ctrl);return 0 ; } -if (sscanf (secret,"DHHC-1:%hhd:%*s" , &key_hash) !=1 ) -return -EINVAL ; -if (key_hash >3 ) { -pr_warn ("Invalid DH-HMAC-CHAP hash id %d\n" , - key_hash); -return -EINVAL ; + + len =strcspn (secret,"\n" ); + key =nvme_auth_extract_key (NULL , secret, len); +if (IS_ERR (key)) { +pr_debug ("%s: invalid key specification\n" , __func__); +return PTR_ERR (key); + } +down_read (&key->sem); +if (key_validate (key)) { +pr_warn ("%s: key %08x invalidated\n" , + __func__,key_serial (key)); +up_read (&key->sem); +key_put (key); +return -EKEYREVOKED ; } + + key_hash =nvme_dhchap_psk_hash (key);if (key_hash >0 ) {/* Validate selected hash algorithm */ const char *hmac =nvme_auth_hmac_name (key_hash);if (!crypto_has_shash (hmac,0 ,0 )) {pr_err ("DH-HMAC-CHAP hash %s unsupported\n" , hmac); +up_read (&key->sem); +key_put (key);return -ENOTSUPP ; } } - dhchap_secret =kstrdup (secret,GFP_KERNEL ); -if (!dhchap_secret) -return -ENOMEM ; -down_write (&nvmet_config_sem); +up_read (&key->sem); +nvmet_auth_revoke_key (host, set_ctrl);if (set_ctrl) { -kfree (host->dhchap_ctrl_secret); - host->dhchap_ctrl_secret =strim (dhchap_secret); - host->dhchap_ctrl_key_hash = key_hash; + host->dhchap_ctrl_key = key; }else { -kfree (host->dhchap_secret); - host->dhchap_secret =strim (dhchap_secret); - host->dhchap_key_hash = key_hash; + host->dhchap_key = key; } -up_write (&nvmet_config_sem);return 0 ; }
@@ -145,7 +167,8 @@ u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq)int ret =0 ;struct nvmet_host_link *p;struct nvmet_host *host =NULL ; -u8 host_hash, ctrl_hash; +struct key *key; +key_serial_t key_id;down_read (&nvmet_config_sem);if (nvmet_is_disc_subsys (ctrl->subsys))
@@ -179,7 +202,7 @@ u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq) goto out_unlock; } -if (!host->dhchap_secret) { +if (!host->dhchap_key) {pr_debug ("No authentication provided\n" ); goto out_unlock; }
@@ -191,47 +214,68 @@ u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq) ctrl->shash_id = host->dhchap_hash_id; } -key_put (ctrl->host_key); - ctrl->host_key =nvme_auth_extract_key (NULL , host->dhchap_secret, -strlen (host->dhchap_secret)); -if (IS_ERR (ctrl->host_key)) { - ret =NVME_AUTH_DHCHAP_FAILURE_NOT_USABLE ; - ctrl->host_key =NULL ; - goto out_free_hash; + key =key_get (host->dhchap_key); +if (!key) { +pr_warn ("%s: host key %08x not found\n" , + __func__,key_serial (host->dhchap_key)); + goto out_unlock; } - host_hash =nvme_dhchap_psk_hash (ctrl->host_key); -pr_debug ("%s: using hash %s key %u\n" , __func__, - ctrl_hash >0 ? -nvme_auth_hmac_name (ctrl_hash) :"none" , -key_serial (ctrl->host_key)); - -key_put (ctrl->ctrl_key); -if (!host->dhchap_ctrl_secret) { - ctrl->ctrl_key =NULL ; +down_read (&key->sem); + ret =key_validate (key); +if (!ret) { +if (ctrl->host_key) { +pr_debug ("%s: drop host key %08x\n" , + __func__,key_serial (ctrl->host_key)); +key_put (ctrl->host_key); + } + ctrl->host_key = key; + } + key_id =key_serial (key); +up_read (&key->sem); +if (ret) { +pr_debug ("key id %08x invalidated\n" , key_id); +key_put (key); + key =ERR_PTR (-EKEYREVOKED ); + } +pr_debug ("%s: using dhchap hash %s key %08x\n" , __func__, +nvme_auth_hmac_name (ctrl->shash_id), key_id); + +if (!host->dhchap_ctrl_key) { +if (ctrl->ctrl_key) { +pr_debug ("%s: drop ctrl key %08x\n" , + __func__,key_serial (ctrl->ctrl_key)); +key_put (ctrl->ctrl_key); + ctrl->ctrl_key =NULL ; + } goto out_unlock; } - ctrl->ctrl_key =nvme_auth_extract_key (NULL , host->dhchap_ctrl_secret, -strlen (host->dhchap_ctrl_secret)); -if (IS_ERR (ctrl->ctrl_key)) { - ret =NVME_AUTH_DHCHAP_FAILURE_NOT_USABLE ; - ctrl->ctrl_key =NULL ; - goto out_free_hash; + key =key_get (host->dhchap_ctrl_key); +if (!key) { +pr_warn ("%s: ctrl key %08x not found\n" , + __func__,key_serial (host->dhchap_ctrl_key)); + goto out_unlock; } - ctrl_hash =nvme_dhchap_psk_hash (ctrl->ctrl_key); -pr_debug ("%s: using ctrl hash %s key %u\n" , __func__, - ctrl_hash >0 ? -nvme_auth_hmac_name (ctrl_hash) :"none" , -key_serial (ctrl->ctrl_key)); - -out_free_hash: -if (ret) { -if (ctrl->host_key) { -key_put (ctrl->host_key); - ctrl->host_key =NULL ; +down_read (&key->sem); + ret =key_validate (key); +if (!ret) { +if (ctrl->ctrl_key) { +pr_debug ("%s: drop ctrl key %08x\n" , + __func__,key_serial (ctrl->ctrl_key)); +key_put (ctrl->ctrl_key); } - ctrl->shash_id =0 ; + ctrl->ctrl_key = key; } + key_id =key_serial (key); +up_read (&key->sem); +if (ret) { +pr_debug ("ctrl key id %08x invalidated\n" , key_id); +key_put (key); + goto out_unlock; + } +pr_debug ("%s: using dhchap ctrl hash %s key %08x\n" , __func__, +nvme_auth_hmac_name (ctrl->shash_id), key_id); + out_unlock:up_read (&nvmet_config_sem);
@@ -265,12 +309,14 @@ void nvmet_destroy_auth(struct nvmet_ctrl *ctrl) ctrl->dh_key =NULL ;if (ctrl->host_key) { -key_revoke (ctrl->host_key); +pr_debug ("%s: drop host key %08x\n" , + __func__,key_serial (ctrl->host_key));key_put (ctrl->host_key); ctrl->host_key =NULL ; }if (ctrl->ctrl_key) { -key_revoke (ctrl->ctrl_key); +pr_debug ("%s: drop ctrl key %08x\n" , + __func__,key_serial (ctrl->ctrl_key));key_put (ctrl->ctrl_key); ctrl->ctrl_key =NULL ; }
drivers/nvme/target/configfs.c +45 -14
96 lines not on this page · raw message
drivers/nvme/target/nvmet.h +3 -4
@@ -374,10 +374,8 @@ static inline struct nvmet_subsys *namespaces_to_subsys(struct nvmet_host {struct config_group group; -u8 *dhchap_secret; -u8 *dhchap_ctrl_secret; -u8 dhchap_key_hash; -u8 dhchap_ctrl_key_hash; +struct key *dhchap_key; +struct key *dhchap_ctrl_key;u8 dhchap_hash_id;u8 dhchap_dhgroup_id; };
@@ -880,6 +878,7 @@ u32 nvmet_auth_send_data_len(struct nvmet_req *req);void nvmet_execute_auth_send (struct nvmet_req *req);u32 nvmet_auth_receive_data_len (struct nvmet_req *req);void nvmet_execute_auth_receive (struct nvmet_req *req); +void nvmet_auth_revoke_key (struct nvmet_host *host,bool set_ctrl);int nvmet_auth_set_key (struct nvmet_host *host,const char *secret,bool set_ctrl);int nvmet_auth_set_host_hash (struct nvmet_host *host,const char *hash);
Signature · 1 line
2.35.3
PATCH 10/12 nvme: allow to pass in key serial number as dhchap secret
In reply to Hannes ReineckeIn order to use pre-populated keys update the parsing for DH-HMAC-CHAP secret to allow for a key serial number instead of an encoded binary secret.
--- drivers/nvme/common/auth.c | 22 ++++++++++--- drivers/nvme/host/auth.c | 17 ++++++++-- drivers/nvme/host/fabrics.c | 24 ++++++++++---- drivers/nvme/host/fabrics.h | 4 +++ drivers/nvme/host/nvme.h | 2 ++ drivers/nvme/host/sysfs.c | 60 ++++++++++++++++++++++------------ drivers/nvme/target/auth.c | 20 ++++++++++-- drivers/nvme/target/configfs.c | 10 +++--- drivers/nvme/target/nvmet.h | 2 ++ include/linux/nvme-auth.h | 3 +- 10 files changed, 122 insertions(+), 42 deletions(-)
drivers/nvme/common/auth.c +17 -5
@@ -156,14 +156,26 @@ size_t nvme_auth_hmac_hash_len(u8 hmac_id)EXPORT_SYMBOL_GPL (nvme_auth_hmac_hash_len);struct key *nvme_auth_extract_key (struct key *keyring,const u8 *secret, -size_t secret_len) +size_t secret_len,bool *generated) { +key_serial_t key_id;struct key *key; - key =nvme_dhchap_psk_refresh (keyring, secret, secret_len); -if (!IS_ERR (key)) -pr_debug ("generated dhchap key %08x\n" , -key_serial (key)); +if (kstrtouint (secret,0 , &key_id)) { + key =nvme_dhchap_psk_refresh (keyring, + secret, secret_len); +if (!IS_ERR (key)) { + *generated = true; +pr_debug ("generated dhchap key %08x\n" , +key_serial (key)); + } + }else if (key_id >0 ) { + key =nvme_tls_key_lookup (key_id); +if (!IS_ERR (key)) + *generated = false; + }else { + key =ERR_PTR (-EINVAL ); + }return key; }EXPORT_SYMBOL_GPL (nvme_auth_extract_key);
drivers/nvme/host/auth.c +15 -2
@@ -1037,19 +1037,29 @@ static void nvme_ctrl_auth_work(struct work_struct *work)static void nvme_auth_clear_key (struct nvme_ctrl *ctrl,bool is_ctrl) {struct key *key; +bool generated;if (is_ctrl) { key = ctrl->ctrl_key; ctrl->ctrl_key =NULL ; + generated = ctrl->ctrl_key_generated; + ctrl->ctrl_key_generated = false; }else { key = ctrl->host_key; ctrl->host_key =NULL ; + generated = ctrl->host_key_generated; + ctrl->host_key_generated = false; }if (key) { -dev_dbg (ctrl->device,"%s: revoke%s key %08x\n" , +if (generated) { +dev_dbg (ctrl->device,"%s: revoke%s key %08x\n" , + __func__, is_ctrl ?" ctrl" :"" , +key_serial (key)); +key_revoke (key); + } +dev_dbg (ctrl->device,"%s: drop%s key %08x\n" , __func__, is_ctrl ?" ctrl" :"" ,key_serial (key)); -key_revoke (key);key_put (key); } }
@@ -1079,6 +1089,8 @@ int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl) key_serial(ctrl->opts->dhchap_key));return -ENOKEY ; } +/* Key has been generated during option parsing */ + ctrl->host_key_generated = false;down_read (&ctrl->host_key->sem); ret =key_validate (ctrl->host_key);up_read (&ctrl->host_key->sem);
@@ -1105,6 +1117,7 @@ int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl) key_serial(ctrl->opts->dhchap_ctrl_key));return -ENOKEY ; } + ctrl->ctrl_key_generated = false;down_read (&ctrl->ctrl_key->sem); ret =key_validate (ctrl->ctrl_key);up_read (&ctrl->ctrl_key->sem);
drivers/nvme/host/fabrics.c +18 -6
@@ -741,7 +741,9 @@ static int nvmf_parse_options(struct nvmf_ctrl_options *opts, opts->keyring =NULL ; opts->concat = false; opts->dhchap_key =NULL ; + opts->dhchap_key_generated = false; opts->dhchap_ctrl_key =NULL ; + opts->dhchap_ctrl_key_generated = false; options = o =kstrdup (buf,GFP_KERNEL );if (!options)
@@ -1095,7 +1097,8 @@ static int nvmf_parse_options(struct nvmf_ctrl_options *opts,if (host_secret) {pr_debug ("lookup host identity '%s'\n" , host_secret); key =nvme_auth_extract_key (opts->keyring, host_secret, -strlen (host_secret)); +strlen (host_secret), + &opts->dhchap_key_generated);if (IS_ERR (key)) { ret =PTR_ERR (key); goto out;
@@ -1110,7 +1113,8 @@ static int nvmf_parse_options(struct nvmf_ctrl_options *opts, }pr_debug ("lookup ctrl identity '%s'\n" , ctrl_secret); key =nvme_auth_extract_key (opts->keyring, ctrl_secret, -strlen (ctrl_secret)); +strlen (ctrl_secret), + &opts->dhchap_ctrl_key_generated);if (IS_ERR (key)) { ret =PTR_ERR (key); goto out;
@@ -1315,15 +1319,23 @@ void nvmf_free_options(struct nvmf_ctrl_options *opts)kfree (opts->host_traddr);kfree (opts->host_iface);if (opts->dhchap_key) { -pr_debug ("revoke dhchap key %08x\n" , +if (opts->dhchap_key_generated) { +pr_debug ("revoke dhchap key %08x\n" , +key_serial (opts->dhchap_key)); +key_revoke (opts->dhchap_key); + } +pr_debug ("drop dhchap key %08x\n" ,key_serial (opts->dhchap_key)); -key_revoke (opts->dhchap_key);key_put (opts->dhchap_key); }if (opts->dhchap_ctrl_key) { -pr_debug ("revoke dhchap ctrl key %08x\n" , +if (opts->dhchap_ctrl_key_generated) { +pr_debug ("revoke dhchap ctrl key %08x\n" , +key_serial (opts->dhchap_ctrl_key)); +key_revoke (opts->dhchap_key); + } +pr_debug ("drop dhchap ctrl key %08x\n" ,key_serial (opts->dhchap_ctrl_key)); -key_revoke (opts->dhchap_key);key_put (opts->dhchap_ctrl_key); }kfree (opts);
drivers/nvme/host/fabrics.h +4 -0
@@ -99,6 +99,8 @@ enum {* @dhchap_key: DH-HMAC-CHAP pre-shared key * @dhchap_ctrl_key: DH-HMAC-CHAP controller pre-shared key for bi-directional * authentication +* @dhchap_key_generated: True if the @dhchap_key has been auto-generated +* @dhchap_ctrl_key_generated: True if @dhchap_ctrl_key has been auto-generated * @keyring: Keyring to use for key lookups * @tls_key: TLS key for encrypted connections (TCP) * @tls: Start TLS encrypted connections (TCP)
@@ -129,6 +131,8 @@ struct nvmf_ctrl_options {struct nvmf_host *host;struct key *dhchap_key;struct key *dhchap_ctrl_key; +bool dhchap_key_generated; +bool dhchap_ctrl_key_generated;struct key *keyring;struct key *tls_key;bool tls;
drivers/nvme/host/nvme.h +2 -0
@@ -381,6 +381,8 @@ struct nvme_ctrl {struct key *host_key;struct key *ctrl_key;u16 transaction; +bool host_key_generated; +bool ctrl_key_generated;#endif key_serial_t tls_pskid;
drivers/nvme/host/sysfs.c +39 -21
143 lines not on this page · raw message
drivers/nvme/target/auth.c +17 -3
@@ -23,23 +23,34 @@void nvmet_auth_revoke_key (struct nvmet_host *host,bool set_ctrl) {struct key *key =ERR_PTR (-ENOKEY ); +bool generated = false;if (set_ctrl) {if (host->dhchap_ctrl_key) { key = host->dhchap_ctrl_key; + generated = host->dhchap_ctrl_key_generated; host->dhchap_ctrl_key =NULL ; + host->dhchap_ctrl_key_generated = false; } }else {if (host->dhchap_key) { key = host->dhchap_key; + generated = host->dhchap_key_generated; host->dhchap_key =NULL ; + host->dhchap_key_generated = false; } }if (!IS_ERR (key)) { -pr_debug ("%s: revoke %s key %08x\n" , +if (generated) { +pr_debug ("%s: revoke %s key %08x\n" , + __func__, set_ctrl ?"ctrl" :"host" , +key_serial (key)); +key_revoke (key); +synchronize_rcu (); + } +pr_debug ("%s: drop %s key %08x\n" , __func__, set_ctrl ?"ctrl" :"host" ,key_serial (key)); -key_revoke (key);key_put (key); } }
@@ -48,6 +59,7 @@ int nvmet_auth_set_key(struct nvmet_host *host, const char *secret, bool set_ctrl) {unsigned char key_hash; +bool generated = false;struct key *key;size_t len;
@@ -57,7 +69,7 @@ int nvmet_auth_set_key(struct nvmet_host *host, const char *secret, } len =strcspn (secret,"\n" ); - key =nvme_auth_extract_key (NULL , secret, len); + key =nvme_auth_extract_key (NULL , secret, len, &generated);if (IS_ERR (key)) {pr_debug ("%s: invalid key specification\n" , __func__);return PTR_ERR (key);
@@ -87,8 +99,10 @@ int nvmet_auth_set_key(struct nvmet_host *host, const char *secret,nvmet_auth_revoke_key (host, set_ctrl);if (set_ctrl) { host->dhchap_ctrl_key = key; + host->dhchap_ctrl_key_generated = generated; }else { host->dhchap_key = key; + host->dhchap_key_generated = generated; }return 0 ; }
drivers/nvme/target/configfs.c +6 -4
@@ -2114,13 +2114,14 @@ static ssize_t nvmet_host_dhchap_key_show(struct config_item *item,down_read (&key->sem);if (key_validate (key)) ret =sprintf (page,"<invalidated>\n" ); -else { +else if (host->dhchap_key_generated) { ret = key->type->read (key, page,PAGE_SIZE );if (ret >0 ) { page[ret] ='\n' ; ret++; } - } + }else + ret =sprintf (page,"%08x\n" ,key_serial (key));up_read (&key->sem);key_put (key); }
@@ -2161,13 +2162,14 @@ static ssize_t nvmet_host_dhchap_ctrl_key_show(struct config_item *item,down_read (&key->sem);if (key_validate (key)) ret =sprintf (page,"<invalidated>\n" ); -else { +else if (host->dhchap_ctrl_key_generated) { ret = key->type->read (key, page,PAGE_SIZE );if (ret >0 ) { page[ret] ='\n' ; ret++; } - } + }else + ret =sprintf (page,"%08x\n" ,key_serial (key));up_read (&key->sem);key_put (key); }
drivers/nvme/target/nvmet.h +2 -0
@@ -375,7 +375,9 @@ static inline struct nvmet_subsys *namespaces_to_subsys(struct nvmet_host {struct config_group group;struct key *dhchap_key; +bool dhchap_key_generated;struct key *dhchap_ctrl_key; +bool dhchap_ctrl_key_generated;u8 dhchap_hash_id;u8 dhchap_dhgroup_id; };
include/linux/nvme-auth.h +2 -1
@@ -18,7 +18,8 @@ const char *nvme_auth_digest_name(u8 hmac_id);size_t nvme_auth_hmac_hash_len (u8 hmac_id);u8 nvme_auth_hmac_id (const char *hmac_name); -struct key *nvme_auth_extract_key (struct key *keyring,const u8 *secret,size_t secret_len); +struct key *nvme_auth_extract_key (struct key *keyring,const u8 *secret,size_t secret_len, +bool *generated);int nvme_auth_transform_key (struct key *key,char *nqn,u8 **transformed_secret); int nvme_auth_augmented_challenge(u8 hmac_id, u8 *skey, size_t skey_len,
Signature · 1 line
2.35.3
PATCH 11/12 nvme-auth: wait for authentication to finish when changing keys
In reply to Hannes ReineckeWhen changing DH-HMAC-CHAP keys in sysfs we need to wait for authentication to complete on all queues. Otherwise the user might change the keys while authentication is in progress, causing the authentication to fail and I/O to be interrupted.
--- drivers/nvme/host/sysfs.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-)
drivers/nvme/host/sysfs.c +2 -4
@@ -649,7 +649,7 @@ static ssize_t nvme_ctrl_dhchap_secret_store(struct device *dev,/* Start re-authentication */ dev_info (ctrl->device,"re-authenticating controller\n" );queue_work (nvme_wq, &ctrl->dhchap_auth_work); - +flush_work (&ctrl->dhchap_auth_work);return count; }
@@ -714,7 +714,6 @@ static ssize_t nvme_ctrl_dhchap_ctrl_secret_store(struct device *dev,if (generated) {dev_dbg (ctrl->dev,"revoke key %08x\n" ,key_serial (key));key_revoke (key); -synchronize_rcu (); }key_put (key);kfree (dhchap_secret);
@@ -726,7 +725,6 @@ static ssize_t nvme_ctrl_dhchap_ctrl_secret_store(struct device *dev,dev_dbg (ctrl->dev,"revoke key %08x\n" ,key_serial (old_key));key_revoke (old_key); -synchronize_rcu (); } ctrl->ctrl_key = key; ctrl->ctrl_key_generated = generated;
@@ -736,7 +734,7 @@ static ssize_t nvme_ctrl_dhchap_ctrl_secret_store(struct device *dev,/* Start re-authentication */ dev_info (ctrl->device,"re-authenticating controller\n" );queue_work (nvme_wq, &ctrl->dhchap_auth_work); - +flush_work (&ctrl->dhchap_auth_work);return count; }
Signature · 1 line
2.35.3
PATCH 12/12 nvme: Unify Kconfig settings
In reply to Hannes ReineckeAs authentication now requires the keyring to be present streamline the Kconfig setting to always select the same symbols for both host and target.
--- drivers/nvme/host/Kconfig | 3 ++- drivers/nvme/target/Kconfig | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-)
drivers/nvme/host/Kconfig +2 -1
@@ -100,8 +100,9 @@ config NVME_TCP config NVME_TCP_TLS bool "NVMe over Fabrics TCP TLS encryption support" depends on NVME_TCP + select TLS select NET_HANDSHAKE - select KEYS + select NVME_KEYRING help Enables TLS encryption for NVMe TCP using the netlink handshake API.
drivers/nvme/target/Kconfig +2 -0
@@ -96,7 +96,9 @@ config NVME_TARGET_TCP config NVME_TARGET_TCP_TLS bool "NVMe over Fabrics TCP target TLS encryption support" depends on NVME_TARGET_TCP + select TLS select NET_HANDSHAKE + select NVME_KEYRING help Enables TLS encryption for the NVMe TCP target using the netlink handshake API.
Signature · 1 line
2.35.3
Christoph Hellwig
maintainerRe: [PATCH 12/12] nvme: Unify Kconfig settings
Quoted 2 lines · Hannes Reinecke
As authentication now requires the keyring to be present streamline the
Kconfigsetting to always select the same symbols for both host and target.
This fails to apply with the select tcp fixes from Alistair.
But I also totally fail to understand the commit message. Either some library code is needed and we need to select it, or it is not and we don't need it. Being uniform should not matter.
So when respinning this please explain what is fixed, and split it into separate host vs target patches.
Hannes Reinecke
maintainerRe: [PATCH 12/12] nvme: Unify Kconfig settings
Quoted 4 lines · Christoph Hellwig
Quoted 2 lines · Hannes Reinecke
As authentication now requires the keyring to be present streamline the
Kconfigsetting to always select the same symbols for both host and target.
Quoted 9 lines
This fails to apply with the select tcp fixes from Alistair.
But I also totally fail to understand the commit message. Either some library code is needed and we need to select it, or it is not and we don't need it. Being uniform should not matter.
So when respinning this please explain what is fixed, and split it into separate host vs target patches.
Sure.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions GmbH, Frankenstr. 146, 90461 Nürnberg HRB 36809 (AG Nürnberg), GF: I. Totev, A. McDonald, W. Knoblich
Christoph Hellwig
maintainerCan you create documentation on how to actually use the keyring interface? As I just got into the TLS the complete lack of documentation there left me a bit stunned and I'd rather avoid that for new interfaces.
Hannes Reinecke
maintainerQuoted 4 lines · Christoph Hellwig
Can you create documentation on how to actually use the keyring interface? As I just got into the TLS the complete lack of documentation there left me a bit stunned and I'd rather avoid that for new interfaces.
Well ... We _do_ have a wiki page on the nvme-cli github:
https://github.com/linux-nvme/nvme-cli/wiki/How-to-Set-Up-TLS-for-NVMe%E2%80%90TCP
which I found a better place than the kernel Documentation.
It does lack information about secure concatenation, true; I'll be adding that. And we have blktests for TLS and secure concatenation nowadays (nvme/062 and nvme/063).
I'll probably add another blktest for the new interface to test with pre-populated keys.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions GmbH, Frankenstr. 146, 90461 Nürnberg HRB 36809 (AG Nürnberg), GF: I. Totev, A. McDonald, W. Knoblich
Sagi Grimberg
maintainerQuoted 8 lines · Hannes Reinecke
Hey all,
the current NVMe authentication code is using a hand-crafted key structure; idea was to have the initial implementation with a minimal set of dependencies. (And me not having a good grasp on how to use the kernel keyring :-) That had the drawback that keys always had to be specified on the nvme-cli commandline, which is far from ideal from a security standpoint.
Quoted 4 lines
So this patchset switches the authentication code over to use the kernel keyring. User-facing interface (namely argument to 'nvme connect') remain the same, but the key data is converted into keys which are stored as a new key type 'dhchap' with a random UUID as description in the kernel keyring.
A welcome change Hannes.
Did not look into the patches yet, but we should start logging deprecation messages on the existing interface I think.