nvme: In-band authentication support
Subsystems (5)
Hannes Reinecke
maintainerv6 cover nvme: In-band authentication support
Hi all,
recent updates to the NVMe spec have added definitions for in-band authentication, and seeing that it provides some real benefit especially for NVMe-TCP here's an attempt to implement it.
Tricky bit here is that the specification orients itself on TLS 1.3, but supports only the FFDHE groups. Which of course the kernel doesn't support. I've been able to come up with a patch for this, but as this is my first attempt to fix anything in the crypto area I would invite people more familiar with these matters to have a look.
Also note that this is just for in-band authentication. Secure concatenation (ie starting TLS with the negotiated parameters) is not implemented; one would need to update the kernel TLS implementation for this, which at this time is beyond scope.
As usual, comments and reviews are welcome.
Changes to v5:
- Unify nvme_auth_generate_key()
- Unify nvme_auth_extract_key()
- Include reviews from Sagi
Changes to v4:
- Validate against blktest suite
- Fixup base64 decoding
- Transform secret with correct hmac algorithm
Changes to v3:
- Renamed parameter to 'dhchap_ctrl_key'
- Fixed bi-directional authentication
- Included reviews from Sagi
- Fixed base64 algorithm for transport encoding
Changes to v2:
- Dropped non-standard algorithms
- Reworked base64 based on fs/crypto/fname.c
- Fixup crash with no keys
Changes to the original submission:
- Included reviews from Vladislav
- Included reviews from Sagi
- Implemented re-authentication support
- Fixed up key handling
Hannes Reinecke (12):
crypto: add crypto_has_shash()
crypto: add crypto_has_kpp()
crypto/ffdhe: Finite Field DH Ephemeral Parameters lib/base64: RFC4648-compliant base64 encoding
nvme: add definitions for NVMe In-Band authentication
nvme-fabrics: decode 'authentication required' connect error
nvme: Implement In-Band authentication
nvme-auth: Diffie-Hellman key exchange support
nvmet: Parse fabrics commands on all queues
nvmet: Implement basic In-Band Authentication
nvmet-auth: Diffie-Hellman key exchange support
nvmet-auth: expire authentication sessions
crypto/Kconfig | 8 + crypto/Makefile | 1 + crypto/ffdhe_helper.c | 880 ++++++++++++++ crypto/kpp.c | 6 + crypto/shash.c | 6 + drivers/nvme/host/Kconfig | 12 + drivers/nvme/host/Makefile | 1 + drivers/nvme/host/auth.c | 1539 ++++++++++++++++++++++++ drivers/nvme/host/auth.h | 34 + drivers/nvme/host/core.c | 141 ++- drivers/nvme/host/fabrics.c | 83 +- drivers/nvme/host/fabrics.h | 7 + drivers/nvme/host/nvme.h | 35 + drivers/nvme/host/tcp.c | 1 + drivers/nvme/host/trace.c | 32 + drivers/nvme/target/Kconfig | 13 + drivers/nvme/target/Makefile | 1 + drivers/nvme/target/admin-cmd.c | 4 + drivers/nvme/target/auth.c | 529 ++++++++ drivers/nvme/target/configfs.c | 138 ++- drivers/nvme/target/core.c | 10 + drivers/nvme/target/fabrics-cmd-auth.c | 513 ++++++++ drivers/nvme/target/fabrics-cmd.c | 30 +- drivers/nvme/target/nvmet.h | 77 ++ include/crypto/ffdhe.h | 24 + include/crypto/hash.h | 2 + include/crypto/kpp.h | 2 + include/linux/base64.h | 16 + include/linux/nvme.h | 186 ++- lib/Makefile | 2 +- lib/base64.c | 103 ++ 31 files changed, 4424 insertions(+), 12 deletions(-) create mode 100644 crypto/ffdhe_helper.c create mode 100644 drivers/nvme/host/auth.c create mode 100644 drivers/nvme/host/auth.h create mode 100644 drivers/nvme/target/auth.c create mode 100644 drivers/nvme/target/fabrics-cmd-auth.c create mode 100644 include/crypto/ffdhe.h create mode 100644 include/linux/base64.h create mode 100644 lib/base64.c
Signature · 1 line
2.29.2
Hannes Reinecke
maintainerPATCH v6 1/12 crypto: add crypto_has_shash()
Add helper function to determine if a given synchronous hash is supported.
--- crypto/shash.c | 6 ++++++ include/crypto/hash.h | 2 ++ 2 files changed, 8 insertions(+)
crypto/shash.c +6 -0
@@ -521,6 +521,12 @@ struct crypto_shash *crypto_alloc_shash(const char *alg_name, u32 type, }EXPORT_SYMBOL_GPL (crypto_alloc_shash); +int crypto_has_shash (const char *alg_name,u32 type,u32 mask) +{ +return crypto_type_has_alg (alg_name, &crypto_shash_type, type, mask); +} +EXPORT_SYMBOL_GPL (crypto_has_shash); +static int shash_prepare_alg (struct shash_alg *alg) {struct crypto_alg *base = &alg->base;
include/crypto/hash.h +2 -0
@@ -718,6 +718,8 @@ static inline void ahash_request_set_crypt(struct ahash_request *req,struct crypto_shash *crypto_alloc_shash (const char *alg_name,u32 type,u32 mask); +int crypto_has_shash (const char *alg_name,u32 type,u32 mask); +static inline struct crypto_tfm *crypto_shash_tfm (struct crypto_shash *tfm) {return &tfm->base;
Signature · 1 line
2.29.2
Hannes Reinecke
maintainerPATCH v6 2/12 crypto: add crypto_has_kpp()
In reply to Hannes ReineckeAdd helper function to determine if a given key-agreement protocol primitive is supported.
--- crypto/kpp.c | 6 ++++++ include/crypto/kpp.h | 2 ++ 2 files changed, 8 insertions(+)
crypto/kpp.c +6 -0
@@ -87,6 +87,12 @@ struct crypto_kpp *crypto_alloc_kpp(const char *alg_name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alloc_kpp); +int crypto_has_kpp (const char *alg_name,u32 type,u32 mask) +{ +return crypto_type_has_alg (alg_name, &crypto_kpp_type, type, mask); +} +EXPORT_SYMBOL_GPL (crypto_has_kpp); +static void kpp_prepare_alg (struct kpp_alg *alg) {struct crypto_alg *base = &alg->base;
include/crypto/kpp.h +2 -0
@@ -104,6 +104,8 @@ struct kpp_alg {*/ struct crypto_kpp *crypto_alloc_kpp (const char *alg_name,u32 type,u32 mask); +int crypto_has_kpp (const char *alg_name,u32 type,u32 mask); +static inline struct crypto_tfm *crypto_kpp_tfm (struct crypto_kpp *tfm) {return &tfm->base;
Signature · 1 line
2.29.2
Hannes Reinecke
maintainerPATCH v6 3/12 crypto/ffdhe: Finite Field DH Ephemeral Parameters
In reply to Hannes ReineckeAdd helper functions to generaten Finite Field DH Ephemeral Parameters as specified in RFC 7919.
--- crypto/Kconfig | 8 + crypto/Makefile | 1 + crypto/ffdhe_helper.c | 880 +++++++++++++++++++++++++++++++++++++++++ include/crypto/ffdhe.h | 24 ++ 4 files changed, 913 insertions(+) create mode 100644 crypto/ffdhe_helper.c create mode 100644 include/crypto/ffdhe.h
crypto/Kconfig +8 -0
@@ -231,6 +231,14 @@ config CRYPTO_DH help Generic implementation of the Diffie-Hellman algorithm. +config CRYPTO_FFDHE + tristate "Finite Field DH (RFC 7919) ephemeral parameters" + select CRYPTO_DH + select CRYPTO_KPP + select CRYPTO_RNG_DEFAULT + help + Generic implementation of the Finite Field DH algorithm + config CRYPTO_ECC tristate select CRYPTO_RNG_DEFAULT
crypto/Makefile +1 -0
@@ -178,6 +178,7 @@ obj-$(CONFIG_CRYPTO_OFB) += ofb.o obj-$(CONFIG_CRYPTO_ECC) += ecc.o obj-$(CONFIG_CRYPTO_ESSIV) += essiv.o obj-$(CONFIG_CRYPTO_CURVE25519) += curve25519-generic.o +obj-$(CONFIG_CRYPTO_FFDHE) += ffdhe_helper.o ecdh_generic-y += ecdh.o ecdh_generic-y += ecdh_helper.o
crypto/ffdhe_helper.c new file +880 -0
880 lines not on this page · raw message
include/crypto/ffdhe.h new file +24 -0
@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* +* Finite-Field Diffie-Hellman definition according to RFC 7919 +* +* Copyright (c) 2021, SUSE Software Products +* Authors: Hannes Reinecke <[email protected]> +*/ +#ifndef _CRYPTO_FFDHE_ +#define _CRYPTO_FFDHE_ + +/** +* crypto_ffdhe_params() - Generate FFDHE params +* @params: DH params +* @bits: Bitsize of the FFDHE parameters +* +* This functions sets the FFDHE parameter for @bits in @params. +* Valid bit sizes are 2048, 3072, 4096, 6144, or 8194. +* +* Returns: 0 on success, errno on failure. +*/ + +int crypto_ffdhe_params (struct dh *p,int bits); + +#endif /* _CRYPTO_FFDHE_H */
Signature · 1 line
2.29.2
Re: [PATCH 03/12] crypto/ffdhe: Finite Field DH Ephemeral Parameters
Quoted 6 lines · Hannes Reinecke
Add helper functions to generaten Finite Field DH Ephemeral Parameters as specified in RFC 7919.
Signed-off-by Hannes Reinecke <[email protected]>Reviewed-by Sagi Grimberg <[email protected]>Reviewed-by Himanshu Madhani <[email protected]>
Looks good.
Hannes Reinecke
maintainerPATCH v6 4/12 lib/base64: RFC4648-compliant base64 encoding
In reply to Hannes ReineckeAdd RFC4648-compliant base64 encoding and decoding routines, based on the base64url encoding in fs/crypto/fname.c.
--- include/linux/base64.h | 16 +++++++ lib/Makefile | 2 +- lib/base64.c | 103 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 include/linux/base64.h create mode 100644 lib/base64.c
include/linux/base64.h new file +16 -0
@@ -0,0 +1,16 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* base64 encoding, lifted from fs/crypto/fname.c. +*/ + +#ifndef _LINUX_BASE64_H +#define _LINUX_BASE64_H + +#include <linux/types.h> + +#define BASE64_CHARS (nbytes) DIV_ROUND_UP((nbytes) * 4, 3) + +int base64_encode (const u8 *src,int len,char *dst); +int base64_decode (const char *src,int len,u8 *dst); + +#endif /* _LINUX_BASE64_H */
lib/Makefile +1 -1
@@ -46,7 +46,7 @@ obj-y += bcd.o sort.o parser.o debug_locks.o random32.o \ bust_spinlocks.o kasprintf.o bitmap.o scatterlist.o \ list_sort.o uuid.o iov_iter.o clz_ctz.o \ bsearch.o find_bit.o llist.o memweight.o kfifo.o \ - percpu-refcount.o rhashtable.o \ + percpu-refcount.o rhashtable.o base64.o \ once.o refcount.o usercopy.o errseq.o bucket_locks.o \ generic-radix-tree.o obj-$(CONFIG_STRING_SELFTEST) += test_string.o
lib/base64.c new file +103 -0
103 lines not on this page · raw message
Signature · 1 line
2.29.2
Re: [PATCH 04/12] lib/base64: RFC4648-compliant base64 encoding
Hannes Reinecke
maintainerPATCH v6 5/12 nvme: add definitions for NVMe In-Band authentication
In reply to Hannes ReineckeAdd new definitions for NVMe In-band authentication as defined in the NVMe Base Specification v2.0.
--- include/linux/nvme.h | 186 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 185 insertions(+), 1 deletion(-)
include/linux/nvme.h +185 -1
@@ -19,6 +19,7 @@#define NVMF_TRSVCID_SIZE 32#define NVMF_TRADDR_SIZE 256#define NVMF_TSAS_SIZE 256 +#define NVMF_AUTH_HASH_LEN 64#define NVME_DISC_SUBSYS_NAME "nqn.2014-08.org.nvmexpress.discovery"
@@ -1278,6 +1279,8 @@ enum nvmf_capsule_command { nvme_fabrics_type_property_set =0x00 , nvme_fabrics_type_connect =0x01 , nvme_fabrics_type_property_get =0x04 , + nvme_fabrics_type_auth_send =0x05 , + nvme_fabrics_type_auth_receive = 0x06, };#define nvme_fabrics_type_name (type) { type, #type }
@@ -1285,7 +1288,9 @@ enum nvmf_capsule_command {__print_symbolic (type, \nvme_fabrics_type_name (nvme_fabrics_type_property_set), \nvme_fabrics_type_name (nvme_fabrics_type_connect), \ -nvme_fabrics_type_name (nvme_fabrics_type_property_get)) +nvme_fabrics_type_name (nvme_fabrics_type_property_get), \ +nvme_fabrics_type_name (nvme_fabrics_type_auth_send), \ +nvme_fabrics_type_name (nvme_fabrics_type_auth_receive))/* * If not fabrics command, fctype will be ignored.
@@ -1415,6 +1420,183 @@ struct nvmf_property_get_command {__u8 resv4[16 ]; }; +struct nvmf_auth_send_command { +__u8 opcode; +__u8 resv1; +__u16 command_id; +__u8 fctype; +__u8 resv2[19 ]; +union nvme_data_ptr dptr; +__u8 resv3; +__u8 spsp0; +__u8 spsp1; +__u8 secp; +__le32 tl; +__u8 resv4[16 ]; +}; + +struct nvmf_auth_receive_command { +__u8 opcode; +__u8 resv1; +__u16 command_id; +__u8 fctype; +__u8 resv2[19 ]; +union nvme_data_ptr dptr; +__u8 resv3; +__u8 spsp0; +__u8 spsp1; +__u8 secp; +__le32 al; +__u8 resv4[16 ]; +}; + +/* Value for secp */ +enum { +NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER =0xe9 , +}; + +/* Defined value for auth_type */ +enum { +NVME_AUTH_COMMON_MESSAGES =0x00 , +NVME_AUTH_DHCHAP_MESSAGES =0x01 , +}; + +/* Defined messages for auth_id */ +enum { +NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE =0x00 , +NVME_AUTH_DHCHAP_MESSAGE_CHALLENGE =0x01 , +NVME_AUTH_DHCHAP_MESSAGE_REPLY =0x02 , +NVME_AUTH_DHCHAP_MESSAGE_SUCCESS1 =0x03 , +NVME_AUTH_DHCHAP_MESSAGE_SUCCESS2 =0x04 , +NVME_AUTH_DHCHAP_MESSAGE_FAILURE2 =0xf0 , +NVME_AUTH_DHCHAP_MESSAGE_FAILURE1 =0xf1 , +}; + +struct nvmf_auth_dhchap_protocol_descriptor { +__u8 authid; +__u8 rsvd; +__u8 halen; +__u8 dhlen; +__u8 idlist[60 ]; +}; + +enum { +NVME_AUTH_DHCHAP_AUTH_ID =0x01 , +}; + +/* Defined hash functions for DH-HMAC-CHAP authentication */ +enum { +NVME_AUTH_DHCHAP_SHA256 =0x01 , +NVME_AUTH_DHCHAP_SHA384 =0x02 , +NVME_AUTH_DHCHAP_SHA512 =0x03 , +}; + +/* Defined Diffie-Hellman group identifiers for DH-HMAC-CHAP authentication */ +enum { +NVME_AUTH_DHCHAP_DHGROUP_NULL =0x00 , +NVME_AUTH_DHCHAP_DHGROUP_2048 =0x01 , +NVME_AUTH_DHCHAP_DHGROUP_3072 =0x02 , +NVME_AUTH_DHCHAP_DHGROUP_4096 =0x03 , +NVME_AUTH_DHCHAP_DHGROUP_6144 =0x04 , +NVME_AUTH_DHCHAP_DHGROUP_8192 =0x05 , +}; + +union nvmf_auth_protocol { +struct nvmf_auth_dhchap_protocol_descriptor dhchap; +}; + +struct nvmf_auth_dhchap_negotiate_data { +__u8 auth_type; +__u8 auth_id; +__le16 rsvd; +__le16 t_id; +__u8 sc_c; +__u8 napd; +union nvmf_auth_protocol auth_protocol[]; +}; + +struct nvmf_auth_dhchap_challenge_data { +__u8 auth_type; +__u8 auth_id; +__u16 rsvd1; +__le16 t_id; +__u8 hl; +__u8 rsvd2; +__u8 hashid; +__u8 dhgid; +__le16 dhvlen; +__le32 seqnum; +/* 'hl' bytes of challenge value */ +__u8 cval[]; +/* followed by 'dhvlen' bytes of DH value */ +}; + +struct nvmf_auth_dhchap_reply_data { +__u8 auth_type; +__u8 auth_id; +__le16 rsvd1; +__le16 t_id; +__u8 hl; +__u8 rsvd2; +__u8 cvalid; +__u8 rsvd3; +__le16 dhvlen; +__le32 seqnum; +/* 'hl' bytes of response data */ +__u8 rval[]; +/* followed by 'hl' bytes of Challenge value */ +/* followed by 'dhvlen' bytes of DH value */ +}; + +enum { +NVME_AUTH_DHCHAP_RESPONSE_VALID = (1 <<0 ), +}; + +struct nvmf_auth_dhchap_success1_data { +__u8 auth_type; +__u8 auth_id; +__le16 rsvd1; +__le16 t_id; +__u8 hl; +__u8 rsvd2; +__u8 rvalid; +__u8 rsvd3[7 ]; +/* 'hl' bytes of response value if 'rvalid' is set */ +__u8 rval[]; +}; + +struct nvmf_auth_dhchap_success2_data { +__u8 auth_type; +__u8 auth_id; +__le16 rsvd1; +__le16 t_id; +__u8 rsvd2[10 ]; +}; + +struct nvmf_auth_dhchap_failure_data { +__u8 auth_type; +__u8 auth_id; +__le16 rsvd1; +__le16 t_id; +__u8 rescode; +__u8 rescode_exp; +}; + +enum { +NVME_AUTH_DHCHAP_FAILURE_REASON_FAILED =0x01 , +}; + +enum { +NVME_AUTH_DHCHAP_FAILURE_FAILED =0x01 , +NVME_AUTH_DHCHAP_FAILURE_NOT_USABLE =0x02 , +NVME_AUTH_DHCHAP_FAILURE_CONCAT_MISMATCH =0x03 , +NVME_AUTH_DHCHAP_FAILURE_HASH_UNUSABLE =0x04 , +NVME_AUTH_DHCHAP_FAILURE_DHGROUP_UNUSABLE =0x05 , +NVME_AUTH_DHCHAP_FAILURE_INCORRECT_PAYLOAD =0x06 , +NVME_AUTH_DHCHAP_FAILURE_INCORRECT_MESSAGE =0x07 , +}; + +struct nvme_dbbuf {__u8 opcode;__u8 flags;
@@ -1458,6 +1640,8 @@ struct nvme_command {struct nvmf_connect_command connect;struct nvmf_property_set_command prop_set;struct nvmf_property_get_command prop_get; +struct nvmf_auth_send_command auth_send; +struct nvmf_auth_receive_command auth_receive;struct nvme_dbbuf dbbuf;struct nvme_directive_cmd directive; };
Signature · 1 line
2.29.2
Re: [PATCH 05/12] nvme: add definitions for NVMe In-Band authentication
Quoted 7 lines · Hannes Reinecke
Add new definitions for NVMe In-band authentication as defined in the NVMe Base Specification v2.0.
Signed-off-by Hannes Reinecke <[email protected]>Reviewed-by Sagi Grimberg <[email protected]>Reviewed-by Himanshu Madhani <[email protected]>---
Looks good.
Hannes Reinecke
maintainerPATCH v6 6/12 nvme-fabrics: decode 'authentication required' connect error
In reply to Hannes ReineckeThe 'connect' command might fail with NVME_SC_AUTH_REQUIRED, so we should be decoding this error, too.
--- drivers/nvme/host/fabrics.c | 4 ++++ 1 file changed, 4 insertions(+)
drivers/nvme/host/fabrics.c +4 -0
@@ -332,6 +332,10 @@ static void nvmf_log_connect_error(struct nvme_ctrl *ctrl,dev_err (ctrl->device,"Connect command failed: host path error\n" );break ; +case NVME_SC_AUTH_REQUIRED : +dev_err (ctrl->device, +"Connect command failed: authentication required\n" ); +break ;default : dev_err(ctrl->device, "Connect command failed, error wo/DNR bit: %d\n",
Signature · 1 line
2.29.2
Hannes Reinecke
maintainerPATCH v6 7/12 nvme: Implement In-Band authentication
In reply to Hannes ReineckeImplement NVMe-oF In-Band authentication according to NVMe TPAR 8006. This patch adds two new fabric options 'dhchap_secret' to specify the pre-shared key (in ASCII respresentation according to NVMe 2.0 section 8.13.5.8 'Secret representation') and 'dhchap_ctrl_secret' to specify the pre-shared controller key for bi-directional authentication of both the host and the controller.
Re-authentication can be triggered by writing the PSK into the new controller sysfs attribute 'dhchap_secret' or 'dhchap_ctrl_secret'.
--- drivers/nvme/host/Kconfig | 11 + drivers/nvme/host/Makefile | 1 + drivers/nvme/host/auth.c | 1139 +++++++++++++++++++++++++++++++++++ drivers/nvme/host/auth.h | 26 + drivers/nvme/host/core.c | 141 ++++- drivers/nvme/host/fabrics.c | 79 ++- drivers/nvme/host/fabrics.h | 7 + drivers/nvme/host/nvme.h | 35 ++ drivers/nvme/host/tcp.c | 1 + drivers/nvme/host/trace.c | 32 + 10 files changed, 1465 insertions(+), 7 deletions(-) create mode 100644 drivers/nvme/host/auth.c create mode 100644 drivers/nvme/host/auth.h
drivers/nvme/host/Kconfig +11 -0
@@ -83,3 +83,14 @@ config NVME_TCP from https://github.com/linux-nvme/nvme-cli. If unsure, say N. + +config NVME_AUTH + bool "NVM Express over Fabrics In-Band Authentication" + depends on NVME_CORE + select CRYPTO_HMAC + select CRYPTO_SHA256 + select CRYPTO_SHA512 + help + This provides support for NVMe over Fabrics In-Band Authentication. + + If unsure, say N.
drivers/nvme/host/Makefile +1 -0
@@ -15,6 +15,7 @@ nvme-core-$(CONFIG_NVME_MULTIPATH) += multipath.o nvme-core-$(CONFIG_BLK_DEV_ZONED) += zns.o nvme-core-$(CONFIG_FAULT_INJECTION_DEBUG_FS) += fault_inject.o nvme-core-$(CONFIG_NVME_HWMON) += hwmon.o +nvme-core-$(CONFIG_NVME_AUTH) += auth.o nvme-y += pci.o
drivers/nvme/host/auth.c new file +1139 -0
1,139 lines not on this page · raw message
drivers/nvme/host/auth.h new file +26 -0
@@ -0,0 +1,26 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Copyright (c) 2021 Hannes Reinecke, SUSE Software Solutions +*/ + +#ifndef _NVME_AUTH_H +#define _NVME_AUTH_H + +#include <crypto/kpp.h> + +const char *nvme_auth_dhgroup_name (int dhgroup_id); +int nvme_auth_dhgroup_pubkey_size (int dhgroup_id); +int nvme_auth_dhgroup_privkey_size (int dhgroup_id); +const char *nvme_auth_dhgroup_kpp (int dhgroup_id); +int nvme_auth_dhgroup_id (const char *dhgroup_name); + +const char *nvme_auth_hmac_name (int hmac_id); +const char *nvme_auth_digest_name (int hmac_id); +int nvme_auth_hmac_hash_len (int hmac_id); +int nvme_auth_hmac_id (const char *hmac_name); + +unsigned char *nvme_auth_extract_secret (unsigned char *secret, +u8 key_hash,size_t *key_len); +u8 *nvme_auth_transform_key (u8 *key,size_t key_len,u8 key_hash,char *nqn); + +#endif /* _NVME_AUTH_H */
drivers/nvme/host/core.c +137 -4
223 lines not on this page · raw message
drivers/nvme/host/fabrics.c +76 -3
134 lines not on this page · raw message
drivers/nvme/host/fabrics.h +7 -0
@@ -68,6 +68,8 @@ enum {NVMF_OPT_FAIL_FAST_TMO =1 <<20 ,NVMF_OPT_HOST_IFACE =1 <<21 ,NVMF_OPT_DISCOVERY =1 <<22 , +NVMF_OPT_DHCHAP_SECRET =1 <<23 , + NVMF_OPT_DHCHAP_CTRL_SECRET = 1 << 24, };/**
@@ -97,6 +99,9 @@ enum {* @max_reconnects: maximum number of allowed reconnect attempts before removing * the controller, (-1) means reconnect forever, zero means remove * immediately; +* @dhchap_secret: DH-HMAC-CHAP secret +* @dhchap_ctrl_secret: DH-HMAC-CHAP controller secret for bi-directional +* authentication * @disable_sqflow: disable controller sq flow control * @hdr_digest: generate/verify header digest (TCP) * @data_digest: generate/verify data digest (TCP)
@@ -121,6 +126,8 @@ struct nvmf_ctrl_options {unsigned int kato;struct nvmf_host *host;int max_reconnects; +char *dhchap_secret; +char *dhchap_ctrl_secret;bool disable_sqflow;bool hdr_digest;bool data_digest;
drivers/nvme/host/nvme.h +35 -0
@@ -324,6 +324,19 @@ struct nvme_ctrl {struct work_struct ana_work;#endif +#ifdef CONFIG_NVME_AUTH +struct work_struct dhchap_auth_work; +struct list_head dhchap_auth_list; +struct mutex dhchap_auth_mutex; +unsigned char *dhchap_key; +unsigned char *dhchap_ctrl_key; +size_t dhchap_key_len; +size_t dhchap_ctrl_key_len; +u8 dhchap_key_hash; +u8 dhchap_ctrl_key_hash; +u16 transaction; +#endif +/* Power saving configuration */ u64 ps_max_latency_us;bool apst_enabled;
@@ -910,6 +923,28 @@ static inline bool nvme_ctrl_sgl_supported(struct nvme_ctrl *ctrl)return ctrl->sgls & ((1 <<0 ) | (1 <<1 )); } +#ifdef CONFIG_NVME_AUTH +void nvme_auth_init_ctrl (struct nvme_ctrl *ctrl); +void nvme_auth_stop (struct nvme_ctrl *ctrl); +int nvme_auth_negotiate (struct nvme_ctrl *ctrl,int qid); +int nvme_auth_wait (struct nvme_ctrl *ctrl,int qid); +void nvme_auth_reset (struct nvme_ctrl *ctrl); +void nvme_auth_free (struct nvme_ctrl *ctrl); +int nvme_auth_generate_key (struct nvme_ctrl *ctrl,u8 *secret,bool set_ctrl); +#else +static inline void nvme_auth_init_ctrl (struct nvme_ctrl *ctrl) {}; +static inline void nvme_auth_stop (struct nvme_ctrl *ctrl) {}; +static inline int nvme_auth_negotiate (struct nvme_ctrl *ctrl,int qid) +{ +return -EPROTONOSUPPORT ; +} +static inline int nvme_auth_wait (struct nvme_ctrl *ctrl,int qid) +{ +return NVME_SC_AUTH_REQUIRED ; +} +static inline void nvme_auth_free (struct nvme_ctrl *ctrl) {}; +#endif +u32 nvme_command_effects (struct nvme_ctrl *ctrl,struct nvme_ns *ns,u8 opcode);int nvme_execute_passthru_rq (struct request *rq);
drivers/nvme/host/tcp.c +1 -0
@@ -2096,6 +2096,7 @@ static void nvme_tcp_error_recovery_work(struct work_struct *work) struct nvme_tcp_ctrl, err_work);struct nvme_ctrl *ctrl = &tcp_ctrl->ctrl; +nvme_auth_stop (ctrl);nvme_stop_keep_alive (ctrl);nvme_tcp_teardown_io_queues (ctrl, false);/* unquiesce to fail fast pending requests */
drivers/nvme/host/trace.c +32 -0
@@ -287,6 +287,34 @@ static const char *nvme_trace_fabrics_property_get(struct trace_seq *p, u8 *spc)return ret; } +static const char *nvme_trace_fabrics_auth_send (struct trace_seq *p,u8 *spc) +{ +const char *ret =trace_seq_buffer_ptr (p); +u8 spsp0 = spc[1 ]; +u8 spsp1 = spc[2 ]; +u8 secp = spc[3 ]; +u32 tl =get_unaligned_le32 (spc +4 ); + +trace_seq_printf (p,"spsp0=%02x, spsp1=%02x, secp=%02x, tl=%u" , + spsp0, spsp1, secp, tl); +trace_seq_putc (p,0 ); +return ret; +} + +static const char *nvme_trace_fabrics_auth_receive (struct trace_seq *p,u8 *spc) +{ +const char *ret =trace_seq_buffer_ptr (p); +u8 spsp0 = spc[1 ]; +u8 spsp1 = spc[2 ]; +u8 secp = spc[3 ]; +u32 al =get_unaligned_le32 (spc +4 ); + +trace_seq_printf (p,"spsp0=%02x, spsp1=%02x, secp=%02x, al=%u" , + spsp0, spsp1, secp, al); +trace_seq_putc (p,0 ); +return ret; +} +static const char *nvme_trace_fabrics_common (struct trace_seq *p,u8 *spc) {const char *ret =trace_seq_buffer_ptr (p);
@@ -306,6 +334,10 @@ const char *nvme_trace_parse_fabrics_cmd(struct trace_seq *p,return nvme_trace_fabrics_connect (p, spc);case nvme_fabrics_type_property_get:return nvme_trace_fabrics_property_get (p, spc); +case nvme_fabrics_type_auth_send: +return nvme_trace_fabrics_auth_send (p, spc); +case nvme_fabrics_type_auth_receive: +return nvme_trace_fabrics_auth_receive (p, spc);default :return nvme_trace_fabrics_common (p, spc); }
Signature · 1 line
2.29.2
Sagi Grimberg
maintainerRe: [PATCH 07/12] nvme: Implement In-Band authentication
Quoted 2 lines
+int
nvme_auth_generate_key(struct nvme_ctrl *ctrl, u8 *secret, bool set_ctrl)
Maybe instead of set_ctrl introduct struct dhchap_key and pass a pointer into that?
Quoted 19 lines
drivers/nvme/host/auth.c new file +19
-0+{ +u8 *key; +size_t key_len; +u8 key_hash; + +if (!secret) +return 0 ; + +if (sscanf (secret,"DHHC-1:%hhd:%*s:" , &key_hash) !=1 ) +return -EINVAL ; + +/* Pass in the secret without the 'DHHC-1:XX:' prefix */ + key =nvme_auth_extract_secret (secret +10 , key_hash, + &key_len); +if (IS_ERR (key)) { +dev_dbg (ctrl->device,"failed to extract key, error %ld\n" , +PTR_ERR (key)); +return PTR_ERR (key); + }
drivers/nvme/host/auth.c line 824
Quoted 10 lines
drivers/nvme/host/auth.c new file +10
-0+ +if (set_ctrl) { + ctrl->dhchap_ctrl_key = key; + ctrl->dhchap_ctrl_key_len = key_len; + ctrl->dhchap_ctrl_key_hash = key_hash; + }else { + ctrl->dhchap_key = key; + ctrl->dhchap_key_len = key_len; + ctrl->dhchap_key_hash = key_hash; + }
Then it becomes:
dhchap_key->key = key; dhchap_key->len = key_len; dhchap_key->hash = key_hash;
Hannes Reinecke
maintainerRe: [PATCH 07/12] nvme: Implement In-Band authentication
Quoted 33 lines · Sagi Grimberg
Quoted 3 lines
+int
nvme_auth_generate_key(struct nvme_ctrl *ctrl, u8 *secret, bool set_ctrl)Maybe instead of
set_ctrlintroduct structdhchap_keyand pass a pointer into that?Quoted 26 lines
drivers/nvme/host/auth.c new file +26
-0+{ + u8 *key; + size_t key_len; + u8 key_hash; + + if (!secret) + return 0; + + if (sscanf(secret, "DHHC-1:%hhd:%*s:", &key_hash) != 1) + return -EINVAL; + + /* Pass in the secret without the 'DHHC-1:XX:' prefix */ + key = nvme_auth_extract_secret(secret + 10, key_hash, + &key_len); + if (IS_ERR(key)) { + dev_dbg(ctrl->device, "failed to extract key, error %ld\n", + PTR_ERR(key)); + return PTR_ERR(key); + } + + if (set_ctrl) { + ctrl->dhchap_ctrl_key = key; + ctrl->dhchap_ctrl_key_len = key_len; + ctrl->dhchap_ctrl_key_hash = key_hash; + } else { + ctrl->dhchap_key = key;
Quoted 8 lines
Quoted 3 lines
+
ctrl->dhchap_key_len=key_len;
+ctrl->dhchap_key_hash=key_hash;
+ }Then it becomes:
dhchap_key->key = key;
dhchap_key->len =key_len;
dhchap_key->hash =key_hash;
Good point.
Will be folding it in.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Re: [PATCH 07/12] nvme: Implement In-Band authentication
In reply to Hannes ReineckeQuoted 170 lines · Hannes Reinecke
Implement NVMe-oF In-Band authentication according to NVMe TPAR 8006. This patch adds two new fabric options '
dhchap_secret' to specify the pre-shared key (in ASCII respresentation according to NVMe 2.0 section 8.13.5.8 'Secret representation') and 'dhchap_ctrl_secret' to specify the pre-shared controller key for bi-directional authentication of both the host and the controller.
Re-authentication can be triggered by writing the PSK into the new controller sysfs attribute 'dhchap_secret' or 'dhchap_ctrl_secret'.Signed-off-by Hannes Reinecke <[email protected]>--- drivers/nvme/host/Kconfig | 11 + drivers/nvme/host/Makefile | 1 + drivers/nvme/host/auth.c | 1139 +++++++++++++++++++++++++++++++++++ drivers/nvme/host/auth.h | 26 + drivers/nvme/host/core.c | 141 ++++- drivers/nvme/host/fabrics.c | 79 ++- drivers/nvme/host/fabrics.h | 7 + drivers/nvme/host/nvme.h | 35 ++ drivers/nvme/host/tcp.c | 1 + drivers/nvme/host/trace.c | 32 + 10 files changed, 1465 insertions(+), 7 deletions(-)create mode 100644
drivers/nvme/host/auth.c
create mode 100644drivers/nvme/host/auth.hdrivers/nvme/host/Kconfig +11
-0@@ -83,3 +83,14 @@ config NVME_TCP from https://github.com/linux-nvme/nvme-cli. If unsure, say N. + +config NVME_AUTH + bool "NVM Express over Fabrics In-Band Authentication" + depends on NVME_CORE + select CRYPTO_HMAC + select CRYPTO_SHA256 + select CRYPTO_SHA512 + help + This provides support for NVMe over Fabrics In-Band Authentication. + + If unsure, say N.drivers/nvme/host/Makefile +1
-0@@ -15,6 +15,7 @@ nvme-core-$(CONFIG_NVME_MULTIPATH) += multipath.o nvme-core-$(CONFIG_BLK_DEV_ZONED) += zns.o nvme-core-$(CONFIG_FAULT_INJECTION_DEBUG_FS) += fault_inject.o nvme-core-$(CONFIG_NVME_HWMON) += hwmon.o +nvme-core-$(CONFIG_NVME_AUTH) += auth.o nvme-y += pci.odrivers/nvme/host/auth.c new file +108
-0@@ -0,0 +1,1139 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Copyright (c) 2020 Hannes Reinecke, SUSE Linux +*/ + +#include <linux/crc32.h> +#include <linux/base64.h> +#include <asm/unaligned.h> +#include <crypto/hash.h> +#include <crypto/dh.h> +#include <crypto/ffdhe.h> +#include "nvme.h" +#include "fabrics.h" +#include "auth.h" + +static atomic_t nvme_dhchap_seqnum =ATOMIC_INIT (0 ); + +struct nvme_dhchap_queue_context { +struct list_head entry; +struct work_struct auth_work; +struct nvme_ctrl *ctrl; +struct crypto_shash *shash_tfm; +void *buf; +size_t buf_size; +int qid; +int error; +u32 s1; +u32 s2; +u16 transaction; +u8 status; +u8 hash_id; +u8 hash_len; +u8 dhgroup_id; +u8 c1[64 ]; +u8 c2[64 ]; +u8 response[64 ]; +u8 *host_response; +}; + +static struct nvme_auth_dhgroup_map { +int id; +const char name[16 ]; +const char kpp[16 ]; +int privkey_size; +int pubkey_size; +} dhgroup_map[] = { + { .id =NVME_AUTH_DHCHAP_DHGROUP_NULL , + .name ="null" , .kpp ="null" , + .privkey_size =0 , .pubkey_size =0 }, + { .id =NVME_AUTH_DHCHAP_DHGROUP_2048 , + .name ="ffdhe2048" , .kpp ="dh" , + .privkey_size =256 , .pubkey_size =256 }, + { .id =NVME_AUTH_DHCHAP_DHGROUP_3072 , + .name ="ffdhe3072" , .kpp ="dh" , + .privkey_size =384 , .pubkey_size =384 }, + { .id =NVME_AUTH_DHCHAP_DHGROUP_4096 , + .name ="ffdhe4096" , .kpp ="dh" , + .privkey_size =512 , .pubkey_size =512 }, + { .id =NVME_AUTH_DHCHAP_DHGROUP_6144 , + .name ="ffdhe6144" , .kpp ="dh" , + .privkey_size =768 , .pubkey_size =768 }, + { .id =NVME_AUTH_DHCHAP_DHGROUP_8192 , + .name ="ffdhe8192" , .kpp ="dh" , + .privkey_size =1024 , .pubkey_size =1024 }, +}; + +const char *nvme_auth_dhgroup_name (int dhgroup_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (dhgroup_map); i++) { +if (dhgroup_map[i].id == dhgroup_id) +return dhgroup_map[i].name; + } +return NULL ; +} +EXPORT_SYMBOL_GPL (nvme_auth_dhgroup_name); + +int nvme_auth_dhgroup_pubkey_size (int dhgroup_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (dhgroup_map); i++) { +if (dhgroup_map[i].id == dhgroup_id) +return dhgroup_map[i].pubkey_size; + } +return -1 ; +} +EXPORT_SYMBOL_GPL (nvme_auth_dhgroup_pubkey_size); + +int nvme_auth_dhgroup_privkey_size (int dhgroup_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (dhgroup_map); i++) { +if (dhgroup_map[i].id == dhgroup_id) +return dhgroup_map[i].privkey_size; + } +return -1 ; +} +EXPORT_SYMBOL_GPL (nvme_auth_dhgroup_privkey_size); + +const char *nvme_auth_dhgroup_kpp (int dhgroup_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (dhgroup_map); i++) { +if (dhgroup_map[i].id == dhgroup_id)
drivers/nvme/host/auth.c line 118
Quoted 10 lines
drivers/nvme/host/auth.c new file +10
-0+return dhgroup_map[i].kpp; + } +return NULL ; +} +EXPORT_SYMBOL_GPL (nvme_auth_dhgroup_kpp); + +int nvme_auth_dhgroup_id (const char *dhgroup_name) +{ +int i; +
nit:
for above declaration s/int/size_t or unsigned int ? for all helpers ...
Quoted 70 lines
drivers/nvme/host/auth.c new file +70
-0+for (i =0 ; i <ARRAY_SIZE (dhgroup_map); i++) { +if (!strncmp (dhgroup_map[i].name, dhgroup_name, +strlen (dhgroup_map[i].name))) +return dhgroup_map[i].id; + } +return -1 ; +} +EXPORT_SYMBOL_GPL (nvme_auth_dhgroup_id); + +static struct nvme_dhchap_hash_map { +int id; +int len; +const char hmac[15 ]; +const char digest[15 ]; +} hash_map[] = { + {.id =NVME_AUTH_DHCHAP_SHA256 , .len =32 , + .hmac ="hmac(sha256)" , .digest ="sha256" }, + {.id =NVME_AUTH_DHCHAP_SHA384 , .len =48 , + .hmac ="hmac(sha384)" , .digest ="sha384" }, + {.id =NVME_AUTH_DHCHAP_SHA512 , .len =64 , + .hmac ="hmac(sha512)" , .digest ="sha512" }, +}; + +const char *nvme_auth_hmac_name (int hmac_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (hash_map); i++) { +if (hash_map[i].id == hmac_id) +return hash_map[i].hmac; + } +return NULL ; +} +EXPORT_SYMBOL_GPL (nvme_auth_hmac_name); + +const char *nvme_auth_digest_name (int hmac_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (hash_map); i++) { +if (hash_map[i].id == hmac_id) +return hash_map[i].digest; + } +return NULL ; +} +EXPORT_SYMBOL_GPL (nvme_auth_digest_name); + +int nvme_auth_hmac_id (const char *hmac_name) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (hash_map); i++) { +if (!strncmp (hash_map[i].hmac, hmac_name, +strlen (hash_map[i].hmac))) +return hash_map[i].id; + } +return -1 ; +} +EXPORT_SYMBOL_GPL (nvme_auth_hmac_id); + +int nvme_auth_hmac_hash_len (int hmac_id) +{ +int i; + +for (i =0 ; i <ARRAY_SIZE (hash_map); i++) { +if (hash_map[i].id == hmac_id) +return hash_map[i].len; + } +return 0 ; +}
drivers/nvme/host/auth.c line 198
Quoted 10 lines
drivers/nvme/host/auth.c new file +10
-0+EXPORT_SYMBOL_GPL (nvme_auth_hmac_hash_len); + +unsigned char *nvme_auth_extract_secret (unsigned char *secret,u8 key_hash, +size_t *out_len) +{ +unsigned char *key, *p; +u32 crc; +int key_len; +size_t allocated_len =strlen (secret); +
nit:- reverse tree would nice above
Quoted 5 lines
drivers/nvme/host/auth.c new file +5
-0+/* Secret might be affixed with a ':' */ + p =strrchr (secret,':' ); +if (p) + allocated_len = p - secret; + key =kzalloc (allocated_len,GFP_KERNEL );
drivers/nvme/host/auth.c line 213
Quoted 10 lines
drivers/nvme/host/auth.c new file +10
-0+if (!key) +return ERR_PTR (-ENOMEM ); + + key_len =base64_decode (secret, allocated_len, key); +if (key_len <0 ) { +pr_debug ("base64 key decoding error %d\n" , + key_len); +return ERR_PTR (key_len); + } + if (key_len != 36 && key_len != 52 &&
nit:- new line before above if
Quoted 125 lines
drivers/nvme/host/auth.c new file +125
-0+ key_len != 68) { +pr_err ("Invalid DH-HMAC-CHAP key len %d\n" , + key_len); +kfree_sensitive (key); +return ERR_PTR (-EINVAL ); + } +if (key_hash >0 && + (key_len -4 ) !=nvme_auth_hmac_hash_len (key_hash)) { +pr_err ("Invalid DH-HMAC-CHAP key len %d for %s\n" , key_len, +nvme_auth_hmac_name (key_hash)); +kfree_sensitive (key); +return ERR_PTR (-EINVAL ); + } + +/* The last four bytes is the CRC in little-endian format */ + key_len -=4 ; +/* +* The linux implementation doesn't do pre- and post-increments, +* so we have to do it manually. +*/ + crc = ~crc32 (~0 , key, key_len); + +if (get_unaligned_le32 (key + key_len) != crc) { +pr_err ("DH-HMAC-CHAP key crc mismatch (key %08x, crc %08x)\n" , +get_unaligned_le32 (key + key_len), crc); +kfree_sensitive (key); +return ERR_PTR (-EKEYREJECTED ); + } + *out_len = key_len; +return key; +} +EXPORT_SYMBOL_GPL (nvme_auth_extract_secret); + +u8 *nvme_auth_transform_key (u8 *key,size_t key_len,u8 key_hash,char *nqn) +{ +const char *hmac_name =nvme_auth_hmac_name (key_hash); +struct crypto_shash *key_tfm; +struct shash_desc *shash; +u8 *transformed_key; +int ret; + +if (key_hash ==0 ) { + transformed_key =kmemdup (key, key_len,GFP_KERNEL ); +return transformed_key ? transformed_key :ERR_PTR (-ENOMEM ); + } + +if (!key || !key_len) { +pr_warn ("No key specified\n" ); +return ERR_PTR (-ENOKEY ); + } +if (!hmac_name) { +pr_warn ("Invalid key hash id %d\n" , key_hash); +return ERR_PTR (-EINVAL ); + } + + key_tfm =crypto_alloc_shash (hmac_name,0 ,0 ); +if (IS_ERR (key_tfm)) +return (u8 *)key_tfm; + + shash =kmalloc (sizeof (struct shash_desc ) + +crypto_shash_descsize (key_tfm), +GFP_KERNEL ); +if (!shash) { + ret = -ENOMEM ; + goto out_free_key; + } + + transformed_key =kzalloc (crypto_shash_digestsize (key_tfm),GFP_KERNEL ); +if (!transformed_key) { + ret = -ENOMEM ; + goto out_free_shash; + } + + shash->tfm = key_tfm; + ret =crypto_shash_setkey (key_tfm, key, key_len); +if (ret <0 ) + goto out_free_shash; + ret =crypto_shash_init (shash); +if (ret <0 ) + goto out_free_shash; + ret =crypto_shash_update (shash, nqn,strlen (nqn)); +if (ret <0 ) + goto out_free_shash; + ret =crypto_shash_update (shash,"NVMe-over-Fabrics" ,17 ); +if (ret <0 ) + goto out_free_shash; + ret =crypto_shash_final (shash, transformed_key); +out_free_shash: +kfree (shash); +out_free_key: +crypto_free_shash (key_tfm); +if (ret <0 ) { +kfree_sensitive (transformed_key); +return ERR_PTR (ret); + } +return transformed_key; +} +EXPORT_SYMBOL_GPL (nvme_auth_transform_key); + +static int nvme_auth_send (struct nvme_ctrl *ctrl,int qid, +void *data,size_t tl) +{ +struct nvme_command cmd = {}; +blk_mq_req_flags_t flags = qid ==NVME_QID_ANY ? +0 :BLK_MQ_REQ_NOWAIT |BLK_MQ_REQ_RESERVED ; +struct request_queue *q = qid ==NVME_QID_ANY ? + ctrl->fabrics_q : ctrl->connect_q; +int ret; + + cmd.auth_send.opcode = nvme_fabrics_command; + cmd.auth_send.fctype = nvme_fabrics_type_auth_send; + cmd.auth_send.secp =NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER ; + cmd.auth_send.spsp0 =0x01 ; + cmd.auth_send.spsp1 =0x01 ; + cmd.auth_send.tl =cpu_to_le32 (tl); + + ret =__nvme_submit_sync_cmd (q, &cmd,NULL , data, tl,0 , qid, +0 , flags); +if (ret >0 ) +dev_warn (ctrl->device, +"qid %d auth_send failed with status %d\n" , qid, ret); +else if (ret <0 ) +dev_err (ctrl->device, +"qid %d auth_send failed with error %d\n" , qid, ret); +return ret;
drivers/nvme/host/auth.c line 348
Quoted 10 lines
drivers/nvme/host/auth.c new file +10
-0+} + +static int nvme_auth_receive (struct nvme_ctrl *ctrl,int qid, +void *buf,size_t al) +{ +struct nvme_command cmd = {}; +blk_mq_req_flags_t flags = qid ==NVME_QID_ANY ? +0 :BLK_MQ_REQ_NOWAIT |BLK_MQ_REQ_RESERVED ; +struct request_queue *q = qid ==NVME_QID_ANY ? + ctrl->fabrics_q : ctrl->connect_q;
above code is repeated for flags and q (correct me if I'm wrong), it makes sense to create one liner helpers something like name could be better :-
1. nvme_req_flags_from_qid()
2. nvme_blk_queue_from_qid()
Quoted 23 lines
drivers/nvme/host/auth.c new file +23
-0+int ret; + + cmd.auth_receive.opcode = nvme_fabrics_command; + cmd.auth_receive.fctype = nvme_fabrics_type_auth_receive; + cmd.auth_receive.secp =NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER ; + cmd.auth_receive.spsp0 =0x01 ; + cmd.auth_receive.spsp1 =0x01 ; + cmd.auth_receive.al =cpu_to_le32 (al); + + ret =__nvme_submit_sync_cmd (q, &cmd,NULL , buf, al,0 , qid, +0 , flags); +if (ret >0 ) { +dev_warn (ctrl->device, +"qid %d auth_recv failed with status %x\n" , qid, ret); + ret = -EIO ; + }else if (ret <0 ) { +dev_err (ctrl->device, +"qid %d auth_recv failed with error %d\n" , qid, ret); + } + +return ret; +} +
Hannes Reinecke
maintainerPATCH v6 8/12 nvme-auth: Diffie-Hellman key exchange support
In reply to Hannes ReineckeImplement Diffie-Hellman key exchange using FFDHE groups for NVMe In-Band Authentication.
--- drivers/nvme/host/Kconfig | 1 + drivers/nvme/host/auth.c | 412 +++++++++++++++++++++++++++++++++++++- drivers/nvme/host/auth.h | 8 + 3 files changed, 415 insertions(+), 6 deletions(-)
drivers/nvme/host/Kconfig +1 -0
@@ -90,6 +90,7 @@ config NVME_AUTH select CRYPTO_HMAC select CRYPTO_SHA256 select CRYPTO_SHA512 + select CRYPTO_FFDHE help This provides support for NVMe over Fabrics In-Band Authentication.
drivers/nvme/host/auth.c +406 -6
504 lines not on this page · raw message
drivers/nvme/host/auth.h +8 -0
@@ -22,5 +22,13 @@ int nvme_auth_hmac_id(const char *hmac_name);unsigned char *nvme_auth_extract_secret (unsigned char *secret,u8 key_hash,size_t *key_len);u8 *nvme_auth_transform_key (u8 *key,size_t key_len,u8 key_hash,char *nqn); +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,int dh_gid); +int nvme_auth_gen_pubkey (struct crypto_kpp *dh_tfm, +u8 *host_key,size_t host_key_len); +int nvme_auth_gen_shared_secret (struct crypto_kpp *dh_tfm, +u8 *ctrl_key,size_t ctrl_key_len, +u8 *sess_key,size_t sess_key_len);#endif /* _NVME_AUTH_H */
Signature · 1 line
2.29.2
Hannes Reinecke
maintainerPATCH v6 9/12 nvmet: Parse fabrics commands on all queues
In reply to Hannes ReineckeFabrics commands might be sent to all queues, not just the admin one.
--- drivers/nvme/target/core.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/nvme/target/core.c +2 -0
@@ -943,6 +943,8 @@ bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq,if (unlikely (!req->sq->ctrl))/* will return an error for any non-connect command: */ status =nvmet_parse_connect_cmd (req); +else if (nvme_is_fabrics (req->cmd)) + status =nvmet_parse_fabrics_cmd (req);else if (likely (req->sq->qid !=0 )) status =nvmet_parse_io_cmd (req);else
Signature · 1 line
2.29.2
Re: [PATCH 09/12] nvmet: Parse fabrics commands on all queues
Quoted 5 lines · Hannes Reinecke
Fabrics commands might be sent to all queues, not just the admin one.
Signed-off-by Hannes Reinecke <[email protected]>Reviewed-by Sagi Grimberg <[email protected]>Reviewed-by Himanshu Madhani <[email protected]>
Looks good.
Hannes Reinecke
maintainerPATCH v6 10/12 nvmet: Implement basic In-Band Authentication
In reply to Hannes ReineckeImplement NVMe-oF In-Band authentication according to NVMe TPAR 8006. This patch adds three additional configfs entries 'dhchap_key', 'dhchap_ctrl_key', and 'dhchap_hash' to the 'host' configfs directory. The 'dhchap_key' and 'dhchap_ctrl_key' entries need to be in the ASCII format as specified in NVMe Base Specification v2.0 section 8.13.5.8 'Secret representation'.
'dhchap_hash' defaults to 'hmac(sha256)', and can be written to to switch to a different HMAC algorithm.
--- drivers/nvme/target/Kconfig | 12 + drivers/nvme/target/Makefile | 1 + drivers/nvme/target/admin-cmd.c | 4 + drivers/nvme/target/auth.c | 384 ++++++++++++++++++++ drivers/nvme/target/configfs.c | 107 +++++- drivers/nvme/target/core.c | 8 + drivers/nvme/target/fabrics-cmd-auth.c | 484 +++++++++++++++++++++++++ drivers/nvme/target/fabrics-cmd.c | 30 +- drivers/nvme/target/nvmet.h | 68 ++++ 9 files changed, 1095 insertions(+), 3 deletions(-) create mode 100644 drivers/nvme/target/auth.c create mode 100644 drivers/nvme/target/fabrics-cmd-auth.c
drivers/nvme/target/Kconfig +12 -0
@@ -83,3 +83,15 @@ config NVME_TARGET_TCP devices over TCP. If unsure, say N. + +config NVME_TARGET_AUTH + bool "NVMe over Fabrics In-band Authentication support" + depends on NVME_TARGET + depends on NVME_AUTH + select CRYPTO_HMAC + select CRYPTO_SHA256 + select CRYPTO_SHA512 + help + This enables support for NVMe over Fabrics In-band Authentication + + If unsure, say N.
drivers/nvme/target/Makefile +1 -0
@@ -13,6 +13,7 @@ nvmet-y += core.o configfs.o admin-cmd.o fabrics-cmd.o \ discovery.o io-cmd-file.o io-cmd-bdev.o nvmet-$(CONFIG_NVME_TARGET_PASSTHRU) += passthru.o nvmet-$(CONFIG_BLK_DEV_ZONED) += zns.o +nvmet-$(CONFIG_NVME_TARGET_AUTH) += fabrics-cmd-auth.o auth.o nvme-loop-y += loop.o nvmet-rdma-y += rdma.o nvmet-fc-y += fc.o
drivers/nvme/target/admin-cmd.c +4 -0
@@ -1014,6 +1014,10 @@ u16 nvmet_parse_admin_cmd(struct nvmet_req *req)if (nvme_is_fabrics (cmd))return nvmet_parse_fabrics_cmd (req); + +if (unlikely (!nvmet_check_auth_status (req))) +return NVME_SC_AUTH_REQUIRED |NVME_SC_DNR ; +if (nvmet_is_disc_subsys (nvmet_req_subsys (req)))return nvmet_parse_discovery_cmd (req);
drivers/nvme/target/auth.c new file +384 -0
384 lines not on this page · raw message
drivers/nvme/target/configfs.c +106 -1
136 lines not on this page · raw message
drivers/nvme/target/core.c +8 -0
@@ -793,6 +793,7 @@ void nvmet_sq_destroy(struct nvmet_sq *sq)wait_for_completion (&sq->confirm_done);wait_for_completion (&sq->free_done);percpu_ref_exit (&sq->ref); +nvmet_auth_sq_free (sq);if (ctrl) {/*
@@ -1271,6 +1272,11 @@ u16 nvmet_check_ctrl_status(struct nvmet_req *req) req->cmd->common.opcode, req->sq->qid);return NVME_SC_CMD_SEQ_ERROR |NVME_SC_DNR ; } + +if (unlikely (!nvmet_check_auth_status (req))) { +pr_warn ("qid %d not authenticated\n" , req->sq->qid); +return NVME_SC_AUTH_REQUIRED |NVME_SC_DNR ; + }return 0 ; }
@@ -1461,6 +1467,8 @@ static void nvmet_ctrl_free(struct kref *ref)flush_work (&ctrl->async_event_work);cancel_work_sync (&ctrl->fatal_err_work); +nvmet_destroy_auth (ctrl); +ida_simple_remove (&cntlid_ida, ctrl->cntlid);nvmet_async_events_free (ctrl);
drivers/nvme/target/fabrics-cmd-auth.c new file +484 -0
484 lines not on this page · raw message
drivers/nvme/target/fabrics-cmd.c +28 -2
@@ -93,6 +93,14 @@ u16 nvmet_parse_fabrics_cmd(struct nvmet_req *req)case nvme_fabrics_type_property_get: req->execute = nvmet_execute_prop_get;break ; +#ifdef CONFIG_NVME_TARGET_AUTH +case nvme_fabrics_type_auth_send: + req->execute = nvmet_execute_auth_send; +break ; +case nvme_fabrics_type_auth_receive: + req->execute = nvmet_execute_auth_receive; +break ; +#endif default :pr_debug ("received unknown capsule type 0x%x\n" , cmd->fabrics.fctype);
@@ -173,6 +181,7 @@ static void nvmet_execute_admin_connect(struct nvmet_req *req)struct nvmf_connect_data *d;struct nvmet_ctrl *ctrl =NULL ;u16 status =0 ; +int ret;if (!nvmet_check_transfer_len (req,sizeof (struct nvmf_connect_data )))return ;
@@ -215,18 +224,32 @@ static void nvmet_execute_admin_connect(struct nvmet_req *req)uuid_copy (&ctrl->hostid, &d->hostid); + ret =nvmet_setup_auth (ctrl); +if (ret <0 ) { +pr_err ("Failed to setup authentication, error %d\n" , ret); +nvmet_ctrl_put (ctrl); +if (ret == -EPERM ) + status = (NVME_SC_CONNECT_INVALID_HOST |NVME_SC_DNR ); +else + status =NVME_SC_INTERNAL ; + goto out; + } + status =nvmet_install_queue (ctrl, req);if (status) {nvmet_ctrl_put (ctrl); goto out; } -pr_info ("creating %s controller %d for subsystem %s for NQN %s%s.\n" , +pr_info ("creating %s controller %d for subsystem %s for NQN %s%s%s.\n" ,nvmet_is_disc_subsys (ctrl->subsys) ?"discovery" :"nvm" , ctrl->cntlid, ctrl->subsys->subsysnqn, ctrl->hostnqn, - ctrl->pi_support ?" T10-PI is enabled" :"" ); + ctrl->pi_support ?" T10-PI is enabled" :"" , +nvmet_has_auth (ctrl) ?" with DH-HMAC-CHAP" :"" ); req->cqe->result.u16 =cpu_to_le16 (ctrl->cntlid); +if (nvmet_has_auth (ctrl)) +nvmet_init_auth (ctrl, req); out:kfree (d); complete:
@@ -286,6 +309,9 @@ static void nvmet_execute_io_connect(struct nvmet_req *req) req->cqe->result.u16 =cpu_to_le16 (ctrl->cntlid);pr_debug ("adding queue %d to ctrl %d.\n" , qid, ctrl->cntlid); + req->cqe->result.u16 =cpu_to_le16 (ctrl->cntlid); +if (nvmet_has_auth (ctrl)) +nvmet_init_auth (ctrl, req); out:kfree (d);
drivers/nvme/target/nvmet.h +68 -0
90 lines not on this page · raw message
Signature · 1 line
2.29.2
Sagi Grimberg
maintainerRe: [PATCH 10/12] nvmet: Implement basic In-Band Authentication
Quoted 55 lines
drivers/nvme/target/fabrics-cmd-auth.c new file +54
-0+void nvmet_execute_auth_send (struct nvmet_req *req) +{ +struct nvmet_ctrl *ctrl = req->sq->ctrl; +struct nvmf_auth_dhchap_success2_data *data; +void *d; +u32 tl; +u16 status =0 ; + +if (req->cmd->auth_send.secp !=NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER ) { + status =NVME_SC_INVALID_FIELD |NVME_SC_DNR ; + req->error_loc = + offsetof(struct nvmf_auth_send_command , secp); + goto done; + } +if (req->cmd->auth_send.spsp0 !=0x01 ) { + status =NVME_SC_INVALID_FIELD |NVME_SC_DNR ; + req->error_loc = + offsetof(struct nvmf_auth_send_command , spsp0); + goto done; + } +if (req->cmd->auth_send.spsp1 !=0x01 ) { + status =NVME_SC_INVALID_FIELD |NVME_SC_DNR ; + req->error_loc = + offsetof(struct nvmf_auth_send_command , spsp1); + goto done; + } + tl =le32_to_cpu (req->cmd->auth_send.tl); +if (!tl) { + status =NVME_SC_INVALID_FIELD |NVME_SC_DNR ; + req->error_loc = + offsetof(struct nvmf_auth_send_command , tl); + goto done; + } +if (!nvmet_check_transfer_len (req, tl)) { +pr_debug ("%s: transfer length mismatch (%u)\n" , __func__, tl); +return ; + } + + d =kmalloc (tl,GFP_KERNEL ); +if (!d) { + status =NVME_SC_INTERNAL ; + goto done; + } + + status =nvmet_copy_from_sgl (req,0 , d, tl); +if (status) { +kfree (d); + goto done; + } + + data = d; +pr_debug ("%s: ctrl %d qid %d type %d id %d step %x\n" , __func__, + ctrl->cntlid, req->sq->qid, data->auth_type, data->auth_id, + req->sq->dhchap_step);
drivers/nvme/target/fabrics-cmd-auth.c line 208
Quoted 10 lines
drivers/nvme/target/fabrics-cmd-auth.c new file +10
-0+if (data->auth_type !=NVME_AUTH_COMMON_MESSAGES && + data->auth_type !=NVME_AUTH_DHCHAP_MESSAGES ) + goto done_failure1; +if (data->auth_type ==NVME_AUTH_COMMON_MESSAGES ) { +if (data->auth_id ==NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE ) { +/* Restart negotiation */ +pr_debug ("%s: ctrl %d qid %d reset negotiation\n" , __func__, + ctrl->cntlid, req->sq->qid); +if (!req->sq->qid) { + status =nvmet_setup_auth (ctrl);
Aren't you leaking memory here?
Hannes Reinecke
maintainerRe: [PATCH 10/12] nvmet: Implement basic In-Band Authentication
Quoted 60 lines · Sagi Grimberg
Quoted 60 lines
drivers/nvme/target/fabrics-cmd-auth.c new file +9
-0+void nvmet_execute_auth_send (struct nvmet_req *req) +{ + struct nvmet_ctrl *ctrl = req->sq->ctrl; + struct nvmf_auth_dhchap_success2_data *data; + void *d; + u32 tl; + u16 status = 0; + + if (req->cmd->auth_send.secp !=
NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, secp); + goto done;
+ }
+ if (req->cmd->auth_send.spsp0!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp0); + goto done;
+ }
+ if (req->cmd->auth_send.spsp1!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp1); + goto done;
+ }
+ tl =le32_to_cpu(req->cmd->auth_send.tl);
+ if (!tl) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, tl);
+ goto done;
+ }
+ if (!nvmet_check_transfer_len(req, tl)) {
+pr_debug("%s: transfer length mismatch (%u)\n", __func__, tl); + return;
+ }drivers/nvme/target/fabrics-cmd-auth.c new file +21
-0+ + d = kmalloc(tl, GFP_KERNEL); + if (!d) { + status = NVME_SC_INTERNAL; + goto done; + } + + status = nvmet_copy_from_sgl(req, 0, d, tl); + if (status) { + kfree(d); + goto done; + } + + data = d; + pr_debug("%s: ctrl %d qid %d type %d id %d step %x\n", __func__, + ctrl->cntlid, req->sq->qid, data->auth_type, data->auth_id, + req->sq->dhchap_step); + if (data->auth_type != NVME_AUTH_COMMON_MESSAGES && + data->auth_type != NVME_AUTH_DHCHAP_MESSAGES) + goto done_failure1; + if (data->auth_type == NVME_AUTH_COMMON_MESSAGES) {
Quoted 9 lines
Quoted 6 lines
+ if (
data->auth_id==NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE) { + /* Restart negotiation */
+ pr_debug("%s: ctrl %d qid %d reset negotiation\n",__func__, +ctrl->cntlid,req->sq->qid);
+ if (!req->sq->qid) {
+ status =nvmet_setup_auth(ctrl);Aren't you leaking memory here?
Hmm. Might. Will be checking.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Hannes Reinecke
maintainerRe: [PATCH 10/12] nvmet: Implement basic In-Band Authentication
In reply to Sagi GrimbergQuoted 60 lines · Sagi Grimberg
Quoted 60 lines
drivers/nvme/target/fabrics-cmd-auth.c new file +9
-0+void nvmet_execute_auth_send (struct nvmet_req *req) +{ + struct nvmet_ctrl *ctrl = req->sq->ctrl; + struct nvmf_auth_dhchap_success2_data *data; + void *d; + u32 tl; + u16 status = 0; + + if (req->cmd->auth_send.secp !=
NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, secp); + goto done;
+ }
+ if (req->cmd->auth_send.spsp0!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp0); + goto done;
+ }
+ if (req->cmd->auth_send.spsp1!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp1); + goto done;
+ }
+ tl =le32_to_cpu(req->cmd->auth_send.tl);
+ if (!tl) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, tl);
+ goto done;
+ }
+ if (!nvmet_check_transfer_len(req, tl)) {
+pr_debug("%s: transfer length mismatch (%u)\n", __func__, tl); + return;
+ }drivers/nvme/target/fabrics-cmd-auth.c new file +21
-0+ + d = kmalloc(tl, GFP_KERNEL); + if (!d) { + status = NVME_SC_INTERNAL; + goto done; + } + + status = nvmet_copy_from_sgl(req, 0, d, tl); + if (status) { + kfree(d); + goto done; + } + + data = d; + pr_debug("%s: ctrl %d qid %d type %d id %d step %x\n", __func__, + ctrl->cntlid, req->sq->qid, data->auth_type, data->auth_id, + req->sq->dhchap_step); + if (data->auth_type != NVME_AUTH_COMMON_MESSAGES && + data->auth_type != NVME_AUTH_DHCHAP_MESSAGES) + goto done_failure1; + if (data->auth_type == NVME_AUTH_COMMON_MESSAGES) {
Quoted 8 lines
Quoted 6 lines
+ if (
data->auth_id==NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE) { + /* Restart negotiation */
+ pr_debug("%s: ctrl %d qid %d reset negotiation\n",__func__, +ctrl->cntlid,req->sq->qid);
+ if (!req->sq->qid) {
+ status =nvmet_setup_auth(ctrl);Aren't you leaking memory here?
I've checked, and I _think_ everything is in order.
Any particular concerns?
( 'd' is free at 'done_kfree', and we never exit without going through it AFAICS).
Have I missed something?
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Sagi Grimberg
maintainerRe: [PATCH 10/12] nvmet: Implement basic In-Band Authentication
Quoted 70 lines · Hannes Reinecke
Quoted 60 lines · Sagi Grimberg
Quoted 60 lines
drivers/nvme/target/fabrics-cmd-auth.c new file +9
-0+void nvmet_execute_auth_send (struct nvmet_req *req) +{ + struct nvmet_ctrl *ctrl = req->sq->ctrl; + struct nvmf_auth_dhchap_success2_data *data; + void *d; + u32 tl; + u16 status = 0; + + if (req->cmd->auth_send.secp !=
NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, secp); + goto done;
+ }
+ if (req->cmd->auth_send.spsp0!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp0); + goto done;
+ }
+ if (req->cmd->auth_send.spsp1!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp1); + goto done;
+ }
+ tl =le32_to_cpu(req->cmd->auth_send.tl);
+ if (!tl) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, tl);
+ goto done;
+ }
+ if (!nvmet_check_transfer_len(req, tl)) {
+pr_debug("%s: transfer length mismatch (%u)\n", __func__, tl); + return;
+ }drivers/nvme/target/fabrics-cmd-auth.c new file +21
-0+ + d = kmalloc(tl, GFP_KERNEL); + if (!d) { + status = NVME_SC_INTERNAL; + goto done; + } + + status = nvmet_copy_from_sgl(req, 0, d, tl); + if (status) { + kfree(d); + goto done; + } + + data = d; + pr_debug("%s: ctrl %d qid %d type %d id %d step %x\n", __func__, + ctrl->cntlid, req->sq->qid, data->auth_type, data->auth_id, + req->sq->dhchap_step); + if (data->auth_type != NVME_AUTH_COMMON_MESSAGES && + data->auth_type != NVME_AUTH_DHCHAP_MESSAGES) + goto done_failure1; + if (data->auth_type == NVME_AUTH_COMMON_MESSAGES) {Quoted 8 lines
Quoted 6 lines
+ if (
data->auth_id==NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE) { + /* Restart negotiation */
+ pr_debug("%s: ctrl %d qid %d reset negotiation\n",__func__, +ctrl->cntlid,req->sq->qid);
+ if (!req->sq->qid) {
+ status =nvmet_setup_auth(ctrl);Aren't you leaking memory here?
Quoted 5 lines
I've checked, and I _think_ everything is in order.
Any particular concerns?
( 'd' is free at 'done_kfree', and we never exit without going through it AFAICS).
Have I missed something?
You are calling nvmet_setup_auth for re-authentication, who is calling nvmet_destroy_auth to free the controller auth stuff?
Don't you need something like:
--
if (!req->sq->qid) {
nvmet_destroy_auth(ctrl);
status = nvmet_setup_auth(ctrl);
...
}--
Hannes Reinecke
maintainerRe: [PATCH 10/12] nvmet: Implement basic In-Band Authentication
Quoted 80 lines · Sagi Grimberg
Quoted 71 lines · Hannes Reinecke
Quoted 61 lines · Sagi Grimberg
Quoted 61 lines
drivers/nvme/target/fabrics-cmd-auth.c new file +9
-0+void nvmet_execute_auth_send (struct nvmet_req *req) +{ + struct nvmet_ctrl *ctrl = req->sq->ctrl; + struct nvmf_auth_dhchap_success2_data *data; + void *d; + u32 tl; + u16 status = 0; + + if (req->cmd->auth_send.secp !=
NVME_AUTH_DHCHAP_PROTOCOL_IDENTIFIER) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, secp); + goto done;
+ }
+ if (req->cmd->auth_send.spsp0!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp0); + goto done;
+ }
+ if (req->cmd->auth_send.spsp1!=0x01) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, spsp1); + goto done;
+ }
+ tl =le32_to_cpu(req->cmd->auth_send.tl);
+ if (!tl) {
+ status =NVME_SC_INVALID_FIELD|NVME_SC_DNR;
+req->error_loc=
+offsetof(struct nvmf_auth_send_command, tl);
+ goto done;
+ }
+ if (!nvmet_check_transfer_len(req, tl)) {
+pr_debug("%s: transfer length mismatch (%u)\n", __func__, tl); + return;
+ }drivers/nvme/target/fabrics-cmd-auth.c new file +22
-0+ + d = kmalloc(tl, GFP_KERNEL); + if (!d) { + status = NVME_SC_INTERNAL; + goto done; + } + + status = nvmet_copy_from_sgl(req, 0, d, tl); + if (status) { + kfree(d); + goto done; + } + + data = d; + pr_debug("%s: ctrl %d qid %d type %d id %d step %x\n", __func__, + ctrl->cntlid, req->sq->qid, data->auth_type, data->auth_id, + req->sq->dhchap_step); + if (data->auth_type != NVME_AUTH_COMMON_MESSAGES && + data->auth_type != NVME_AUTH_DHCHAP_MESSAGES) + goto done_failure1; + if (data->auth_type == NVME_AUTH_COMMON_MESSAGES) { + if (data->auth_id == NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE) {Quoted 8 lines
Quoted 6 lines
+ /* Restart negotiation */
+ pr_debug("%s: ctrl %d qid %d reset negotiation\n",__func__,
+ctrl->cntlid,req->sq->qid);
+ if (!req->sq->qid) {
+ status =nvmet_setup_auth(ctrl);Aren't you leaking memory here?
Quoted 5 lines
I've checked, and I _think_ everything is in order.
Any particular concerns?
( 'd' is free at 'done_kfree', and we never exit without going through it AFAICS).
Have I missed something?
Quoted 11 lines
You are calling
nvmet_setup_authfor re-authentication, who is callingnvmet_destroy_authto free the controller auth stuff?Don't you need something like:
Signature · 6 lines
if (!req->sq->qid) { nvmet_destroy_auth(ctrl); status = nvmet_setup_auth(ctrl); ... } --
nvme_setup_auth() should be re-entrant, ie it'll free old and reallocate new keys as required. Hence no need to call nvmet_destroy_auth(). At least that's the plan.
Always possible that I messed up things somewhere.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Sagi Grimberg
maintainerRe: [PATCH 10/12] nvmet: Implement basic In-Band Authentication
Quoted 30 lines
Quoted 18 lines
Quoted 10 lines
Quoted 10 lines
Quoted 9 lines
+ if (
data->auth_type==NVME_AUTH_COMMON_MESSAGES) { + if (data->auth_id==NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE) { + /* Restart negotiation */
+ pr_debug("%s: ctrl %d qid %d reset negotiation\n",__func__,
+ctrl->cntlid,req->sq->qid);
+ if (!req->sq->qid) {
+ status =nvmet_setup_auth(ctrl);Quoted 7 lines
Quoted 1 line
Aren't you leaking memory here?
I've checked, and I _think_ everything is in order.
Any particular concerns?
( 'd' is free at 'done_kfree', and we never exit without going through it AFAICS).
Have I missed something?Quoted 11 lines
You are calling
nvmet_setup_authfor re-authentication, who is callingnvmet_destroy_authto free the controller auth stuff?Don't you need something like:
Signature · 6 lines
if (!req->sq->qid) { nvmet_destroy_auth(ctrl); status = nvmet_setup_auth(ctrl); ... } --
Quoted 3 lines
nvme_setup_auth()should be re-entrant, ie it'll free old and reallocate new keys as required. Hence no need to callnvmet_destroy_auth(). At least that's the plan.
OK, I see.
Quoted 1 line
Always possible that I messed up things somewhere.
Worth checking with kmemleak but it looks ok to me.
Hannes Reinecke
maintainerPATCH v6 11/12 nvmet-auth: Diffie-Hellman key exchange support
In reply to Hannes ReineckeImplement Diffie-Hellman key exchange using FFDHE groups for NVMe In-Band Authentication.
This patch adds a new host configfs attribute 'dhchap_dhgroup' to select the FFDHE group to use.
--- drivers/nvme/target/Kconfig | 1 + drivers/nvme/target/auth.c | 152 ++++++++++++++++++++++++- drivers/nvme/target/configfs.c | 31 +++++ drivers/nvme/target/fabrics-cmd-auth.c | 19 +++- drivers/nvme/target/nvmet.h | 8 ++ 5 files changed, 203 insertions(+), 8 deletions(-)
drivers/nvme/target/Kconfig +1 -0
@@ -91,6 +91,7 @@ config NVME_TARGET_AUTH select CRYPTO_HMAC select CRYPTO_SHA256 select CRYPTO_SHA512 + select CRYPTO_FFDHE help This enables support for NVMe over Fabrics In-band Authentication
drivers/nvme/target/auth.c +148 -4
185 lines not on this page · raw message
drivers/nvme/target/configfs.c +31 -0
@@ -1784,10 +1784,41 @@ static ssize_t nvmet_host_dhchap_hash_store(struct config_item *item,CONFIGFS_ATTR (nvmet_host_, dhchap_hash); +static ssize_t nvmet_host_dhchap_dhgroup_show (struct config_item *item, +char *page) +{ +struct nvmet_host *host =to_host (item); +const char *dhgroup =nvme_auth_dhgroup_name (host->dhchap_dhgroup_id); + +return sprintf (page,"%s\n" , dhgroup ? dhgroup :"none" ); +} + +static ssize_t nvmet_host_dhchap_dhgroup_store (struct config_item *item, +const char *page,size_t count) +{ +struct nvmet_host *host =to_host (item); +int dhgroup_id; + + dhgroup_id =nvme_auth_dhgroup_id (page); +if (dhgroup_id <0 ) +return -EINVAL ; +if (dhgroup_id !=NVME_AUTH_DHCHAP_DHGROUP_NULL ) { +const char *kpp =nvme_auth_dhgroup_kpp (dhgroup_id); + +if (!crypto_has_kpp (kpp,0 ,0 )) +return -EINVAL ; + } + host->dhchap_dhgroup_id = dhgroup_id; +return count; +} + +CONFIGFS_ATTR (nvmet_host_, dhchap_dhgroup); +static struct configfs_attribute *nvmet_host_attrs[] = { &nvmet_host_attr_dhchap_key, &nvmet_host_attr_dhchap_ctrl_key, &nvmet_host_attr_dhchap_hash, + &nvmet_host_attr_dhchap_dhgroup,NULL , };#endif /* CONFIG_NVME_TARGET_AUTH */
drivers/nvme/target/fabrics-cmd-auth.c +15 -4
@@ -61,7 +61,7 @@ static u16 nvmet_auth_negotiate(struct nvmet_req *req, void *d) data->auth_protocol[0].dhchap.dhlen; i++) {int tmp_dhgid = data->auth_protocol[0 ].dhchap.idlist[i]; -if (tmp_dhgid ==NVME_AUTH_DHCHAP_DHGROUP_NULL ) { +if (tmp_dhgid != ctrl->dh_gid) { dhgid = tmp_dhgid;break ; }
@@ -71,7 +71,6 @@ static u16 nvmet_auth_negotiate(struct nvmet_req *req, void *d) __func__, ctrl->cntlid, req->sq->qid);return NVME_AUTH_DHCHAP_FAILURE_DHGROUP_UNUSABLE ; } - ctrl->dh_gid = dhgid;pr_debug ("%s: ctrl %d qid %d: selected DH group %s (%d)\n" , __func__, ctrl->cntlid, req->sq->qid,nvme_auth_dhgroup_name (ctrl->dh_gid), ctrl->dh_gid);
@@ -90,7 +89,11 @@ static u16 nvmet_auth_reply(struct nvmet_req *req, void *d) data->hl, data->cvalid, dhvlen);if (dhvlen) { -return NVME_AUTH_DHCHAP_FAILURE_INCORRECT_PAYLOAD ; +if (!ctrl->dh_tfm) +return NVME_AUTH_DHCHAP_FAILURE_INCORRECT_PAYLOAD ; +if (nvmet_auth_ctrl_sesskey (req, data->rval +2 * data->hl, + dhvlen) <0 ) +return NVME_AUTH_DHCHAP_FAILURE_DHGROUP_UNUSABLE ; } response =kmalloc (data->hl,GFP_KERNEL );
@@ -318,6 +321,8 @@ static int nvmet_auth_challenge(struct nvmet_req *req, void *d, int al)int hash_len =nvme_auth_hmac_hash_len (ctrl->shash_id);int data_size =sizeof (*d) + hash_len; +if (ctrl->dh_tfm) + data_size += ctrl->dh_keysize;if (al < data_size) {pr_debug ("%s: buffer too small (al %d need %d)\n" , __func__, al, data_size);
@@ -336,9 +341,15 @@ static int nvmet_auth_challenge(struct nvmet_req *req, void *d, int al)return -ENOMEM ;get_random_bytes (req->sq->dhchap_c1, data->hl);memcpy (data->cval, req->sq->dhchap_c1, data->hl); +if (ctrl->dh_tfm) { + data->dhgid = ctrl->dh_gid; + data->dhvlen =cpu_to_le32 (ctrl->dh_keysize); + ret =nvmet_auth_ctrl_exponential (req, data->cval + data->hl, + ctrl->dh_keysize); + }pr_debug ("%s: ctrl %d qid %d seq %d transaction %d hl %d dhvlen %d\n" , __func__, ctrl->cntlid, req->sq->qid, req->sq->dhchap_s1, - req->sq->dhchap_tid, data->hl,0 ); + req->sq->dhchap_tid, data->hl, ctrl->dh_keysize);return ret; }
drivers/nvme/target/nvmet.h +8 -0
@@ -230,7 +230,10 @@ struct nvmet_ctrl {size_t dhchap_ctrl_key_len;u8 dhchap_ctrl_key_hash;u8 shash_id; +struct crypto_kpp *dh_tfm;u32 dh_gid; +u8 *dh_key; +u32 dh_keysize;#endif };
@@ -705,6 +708,7 @@ int nvmet_setup_auth(struct nvmet_ctrl *ctrl);void nvmet_init_auth (struct nvmet_ctrl *ctrl,struct nvmet_req *req);void nvmet_destroy_auth (struct nvmet_ctrl *ctrl);void nvmet_auth_sq_free (struct nvmet_sq *sq); +int nvmet_setup_dhgroup (struct nvmet_ctrl *ctrl,int dhgroup_id);bool nvmet_check_auth_status (struct nvmet_req *req);int nvmet_auth_host_hash (struct nvmet_req *req,u8 *response,unsigned int hash_len);
@@ -714,6 +718,10 @@ static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl) {return ctrl->dhchap_key !=NULL ; } +int nvmet_auth_ctrl_exponential (struct nvmet_req *req, +u8 *buf,int buf_size); +int nvmet_auth_ctrl_sesskey (struct nvmet_req *req, +u8 *buf,int buf_size);#else static inline int nvmet_setup_auth (struct nvmet_ctrl *ctrl) {
Signature · 1 line
2.29.2
Hannes Reinecke
maintainerPATCH v6 12/12 nvmet-auth: expire authentication sessions
In reply to Hannes ReineckeEach authentication step is required to be completed within the KATO interval (or two minutes if not set). So add a workqueue function to reset the transaction ID and the expected next protocol step; this will automatically the next authentication command referring to the terminated authentication.
--- drivers/nvme/target/auth.c | 1 + drivers/nvme/target/fabrics-cmd-auth.c | 20 +++++++++++++++++++- drivers/nvme/target/nvmet.h | 1 + 3 files changed, 21 insertions(+), 1 deletion(-)
drivers/nvme/target/auth.c +1 -0
@@ -222,6 +222,7 @@ int nvmet_setup_auth(struct nvmet_ctrl *ctrl)void nvmet_auth_sq_free (struct nvmet_sq *sq) { +cancel_delayed_work (&sq->auth_expired_work);kfree (sq->dhchap_c1); sq->dhchap_c1 =NULL ;kfree (sq->dhchap_c2);
drivers/nvme/target/fabrics-cmd-auth.c +19 -1
@@ -12,9 +12,22 @@#include "nvmet.h" #include "../host/auth.h" +static void nvmet_auth_expired_work (struct work_struct *work) +{ +struct nvmet_sq *sq =container_of (to_delayed_work (work), + struct nvmet_sq, auth_expired_work); + +pr_debug ("%s: ctrl %d qid %d transaction %u expired, resetting\n" , + __func__, sq->ctrl->cntlid, sq->qid, sq->dhchap_tid); + sq->dhchap_step =NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE ; + sq->dhchap_tid =-1 ; +} +void nvmet_init_auth (struct nvmet_ctrl *ctrl,struct nvmet_req *req) {/* Initialize in-band authentication */ +INIT_DELAYED_WORK (&req->sq->auth_expired_work, + nvmet_auth_expired_work); req->sq->authenticated = false; req->sq->dhchap_step =NVME_AUTH_DHCHAP_MESSAGE_NEGOTIATE ; req->cqe->result.u32 |=0x2 <<16 ;
@@ -305,8 +318,13 @@ void nvmet_execute_auth_send(struct nvmet_req *req) req->cqe->result.u64 =0 ;nvmet_req_complete (req, status);if (req->sq->dhchap_step !=NVME_AUTH_DHCHAP_MESSAGE_SUCCESS2 && - req->sq->dhchap_step !=NVME_AUTH_DHCHAP_MESSAGE_FAILURE2 ) + req->sq->dhchap_step !=NVME_AUTH_DHCHAP_MESSAGE_FAILURE2 ) { +unsigned long auth_expire_secs = ctrl->kato ? ctrl->kato :120 ; + +mod_delayed_work (system_wq, &req->sq->auth_expired_work, + auth_expire_secs *HZ );return ; + }/* Final states, clear up variables */ nvmet_auth_sq_free (req->sq);if (req->sq->dhchap_step ==NVME_AUTH_DHCHAP_MESSAGE_FAILURE2 )
drivers/nvme/target/nvmet.h +1 -0
@@ -109,6 +109,7 @@ struct nvmet_sq {u32 sqhd;bool sqhd_disabled;#ifdef CONFIG_NVME_TARGET_AUTH +struct delayed_work auth_expired_work;bool authenticated;u16 dhchap_tid;u16 dhchap_status;
Signature · 1 line
2.29.2
Re: [PATCH 12/12] nvmet-auth: expire authentication sessions
Sagi Grimberg
maintainerQuoted 17 lines · Hannes Reinecke
Hi all,
recent updates to the NVMe spec have added definitions for in-band authentication, and seeing that it provides some real benefit especially for NVMe-TCP here's an attempt to implement it.
Tricky bit here is that the specification orients itself on TLS 1.3, but supports only the FFDHE groups. Which of course the kernel doesn't support. I've been able to come up with a patch for this, but as this is my first attempt to fix anything in the crypto area I would invite people more familiar with these matters to have a look.
Also note that this is just for in-band authentication. Secure concatenation (ie starting TLS with the negotiated parameters) is not implemented; one would need to update the kernel TLS implementation for this, which at this time is beyond scope.
Quoted 5 lines
As usual, comments and reviews are welcome.
Changes to v5:
- Unifynvme_auth_generate_key()
- Unifynvme_auth_extract_key()
You mean nvme_auth_extract_secret() ?
Quoted 1 line
- Include reviews from Sagi
What about the bug fix folded in?
Hannes Reinecke
maintainerQuoted 20 lines · Sagi Grimberg
Quoted 17 lines · Hannes Reinecke
Hi all,
recent updates to the NVMe spec have added definitions for in-band authentication, and seeing that it provides some real benefit especially for NVMe-TCP here's an attempt to implement it.
Tricky bit here is that the specification orients itself on TLS 1.3, but supports only the FFDHE groups. Which of course the kernel doesn't support. I've been able to come up with a patch for this, but as this is my first attempt to fix anything in the crypto area I would invite people more familiar with these matters to have a look.
Also note that this is just for in-band authentication. Secure concatenation (ie starting TLS with the negotiated parameters) is not implemented; one would need to update the kernel TLS implementation for this, which at this time is beyond scope.
Quoted 8 lines
Quoted 5 lines
As usual, comments and reviews are welcome.
Changes to v5:
- Unifynvme_auth_generate_key()
- Unifynvme_auth_extract_key()You mean
nvme_auth_extract_secret()?
Yes.
Quoted 3 lines
Quoted 1 line
- Include reviews from Sagi
What about the bug fix folded in?
Yeah, and that, to
Forgot to mention it.
Also note that I've already folded the nvme-cli patches into the git repository to ease testing; I gather that the interface won't change that much anymore, so I felt justified in doing so.
And I got tired of explaining to interested parties how to build a non-standard nvme-cli :-)
But that's why I didn't post separate patches for nvme-cli.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Sagi Grimberg
maintainerQuoted 26 lines
Quoted 18 lines
Quoted 18 lines
Hi all,
recent updates to the NVMe spec have added definitions for in-band authentication, and seeing that it provides some real benefit especially for NVMe-TCP here's an attempt to implement it.
Tricky bit here is that the specification orients itself on TLS 1.3, but supports only the FFDHE groups. Which of course the kernel doesn't support. I've been able to come up with a patch for this, but as this is my first attempt to fix anything in the crypto area I would invite people more familiar with these matters to have a look.
Also note that this is just for in-band authentication. Secure concatenation (ie starting TLS with the negotiated parameters) is not implemented; one would need to update the kernel TLS implementation for this, which at this time is beyond scope.
Quoted 8 lines
Quoted 5 lines
As usual, comments and reviews are welcome.
Changes to v5:
- Unifynvme_auth_generate_key()
- Unifynvme_auth_extract_key()You mean
nvme_auth_extract_secret()?
Quoted 8 lines
Yes.
Quoted 3 lines
Quoted 1 line
- Include reviews from Sagi
What about the bug fix folded in?
Yeah, and that, to
Forgot to mention it.
It is not the code that you shared in the other thread right?
Quoted 4 lines
Also note that I've already folded the nvme-cli patches into the git repository to ease testing; I gather that the interface won't change that much anymore, so I felt justified in doing so.
It's ok, we can still change if we want to.
Hannes Reinecke
maintainerQuoted 28 lines · Sagi Grimberg
Quoted 28 lines
Quoted 18 lines
Quoted 18 lines
Hi all,
recent updates to the NVMe spec have added definitions for in-band authentication, and seeing that it provides some real benefit especially for NVMe-TCP here's an attempt to implement it.
Tricky bit here is that the specification orients itself on TLS 1.3, but supports only the FFDHE groups. Which of course the kernel doesn't support. I've been able to come up with a patch for this, but as this is my first attempt to fix anything in the crypto area I would invite people more familiar with these matters to have a look.
Also note that this is just for in-band authentication. Secure concatenation (ie starting TLS with the negotiated parameters) is not implemented; one would need to update the kernel TLS implementation for this, which at this time is beyond scope.
Quoted 8 lines
Quoted 5 lines
As usual, comments and reviews are welcome.
Changes to v5:
- Unifynvme_auth_generate_key()
- Unifynvme_auth_extract_key()You mean
nvme_auth_extract_secret()?Yes.
Quoted 9 lines
Quoted 6 lines
Quoted 3 lines
Quoted 1 line
- Include reviews from Sagi
What about the bug fix folded in?
Yeah, and that, to
Forgot to mention it.It is not the code that you shared in the other thread right?
Yes, it is.
It has been folded into v6.
And test 043 has been updated to check for this issue.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Sagi Grimberg
maintainerQuoted 10 lines
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines
What about the bug fix folded in?
Yeah, and that, to
Forgot to mention it.It is not the code that you shared in the other thread right?
Yes, it is.
It has been folded into v6.
I don't see it in patch 07/12
Hannes Reinecke
maintainerQuoted 6 lines · Sagi Grimberg
Quoted 6 lines
Quoted 6 lines
Quoted 5 lines
Quoted 2 lines
What about the bug fix folded in?
Yeah, and that, to
Forgot to mention it.
Quoted 6 lines
Quoted 4 lines
Quoted 2 lines
It is not the code that you shared in the other thread right?
Yes, it is.
It has been folded into v6.I don't see it in patch 07/12
+ ret = nvme_auth_process_dhchap_success1(ctrl, chap);
+ if (ret) {
+ /* Controller authentication failed */
+ goto fail2;
+ }
+
v5 had 'if (ret < 0) [' here.
Cheers,
Hannes
Signature · 4 lines
Dr. Hannes Reinecke Kernel Storage Architect [email protected] +49 911 74053 688 SUSE Software Solutions Germany GmbH, 90409 Nürnberg GF: F. Imendörffer, HRB 36809 (AG Nürnberg)
Sagi Grimberg
maintainerQuoted 9 lines
(quoted diff) +6
-0+ ret = nvme_auth_process_dhchap_success1(ctrl, chap); + if (ret) { + /* Controller authentication failed */ + goto fail2; + } +v5 had 'if (ret < 0) [' here.
Right, thanks.