* [PATCH 1/8] net/handshake: Store the key serial number on completion
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-15 13:40 ` Chuck Lever
2025-08-15 5:02 ` [PATCH 2/8] net/handshake: Make handshake_req_cancel public alistair23
` (6 subsequent siblings)
7 siblings, 1 reply; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
Allow userspace to include a key serial number when completing a
handshake with the HANDSHAKE_CMD_DONE command.
We then store this serial number and will provide it back to userspace
in the future. This allows userspace to save data to the keyring and
then restore that data later.
This will be used to support the TLS KeyUpdate operation, as now
userspace can resume information about a established session.
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
Documentation/netlink/specs/handshake.yaml | 4 ++++
drivers/nvme/host/tcp.c | 3 ++-
drivers/nvme/target/tcp.c | 3 ++-
include/net/handshake.h | 3 ++-
include/uapi/linux/handshake.h | 1 +
net/handshake/genl.c | 5 +++--
net/handshake/tlshd.c | 15 +++++++++++++--
net/sunrpc/svcsock.c | 3 ++-
net/sunrpc/xprtsock.c | 3 ++-
9 files changed, 31 insertions(+), 9 deletions(-)
diff --git a/Documentation/netlink/specs/handshake.yaml b/Documentation/netlink/specs/handshake.yaml
index 95c3fade7a8d..e76b10ef62f2 100644
--- a/Documentation/netlink/specs/handshake.yaml
+++ b/Documentation/netlink/specs/handshake.yaml
@@ -87,6 +87,9 @@ attribute-sets:
name: remote-auth
type: u32
multi-attr: true
+ -
+ name: key-serial
+ type: u32
operations:
list:
@@ -123,6 +126,7 @@ operations:
- status
- sockfd
- remote-auth
+ - key-serial
mcast-groups:
list:
diff --git a/drivers/nvme/host/tcp.c b/drivers/nvme/host/tcp.c
index c0fe8cfb7229..bb7317a3f1a9 100644
--- a/drivers/nvme/host/tcp.c
+++ b/drivers/nvme/host/tcp.c
@@ -1673,7 +1673,8 @@ static void nvme_tcp_set_queue_io_cpu(struct nvme_tcp_queue *queue)
qid, queue->io_cpu);
}
-static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid)
+static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid,
+ key_serial_t user_key_serial)
{
struct nvme_tcp_queue *queue = data;
struct nvme_tcp_ctrl *ctrl = queue->ctrl;
diff --git a/drivers/nvme/target/tcp.c b/drivers/nvme/target/tcp.c
index 470bf37e5a63..93fce316267d 100644
--- a/drivers/nvme/target/tcp.c
+++ b/drivers/nvme/target/tcp.c
@@ -1780,7 +1780,8 @@ static int nvmet_tcp_tls_key_lookup(struct nvmet_tcp_queue *queue,
}
static void nvmet_tcp_tls_handshake_done(void *data, int status,
- key_serial_t peerid)
+ key_serial_t peerid,
+ key_serial_t user_key_serial)
{
struct nvmet_tcp_queue *queue = data;
diff --git a/include/net/handshake.h b/include/net/handshake.h
index 8ebd4f9ed26e..449bed8c2557 100644
--- a/include/net/handshake.h
+++ b/include/net/handshake.h
@@ -18,7 +18,8 @@ enum {
};
typedef void (*tls_done_func_t)(void *data, int status,
- key_serial_t peerid);
+ key_serial_t peerid,
+ key_serial_t user_key_serial);
struct tls_handshake_args {
struct socket *ta_sock;
diff --git a/include/uapi/linux/handshake.h b/include/uapi/linux/handshake.h
index 662e7de46c54..46753116ba43 100644
--- a/include/uapi/linux/handshake.h
+++ b/include/uapi/linux/handshake.h
@@ -55,6 +55,7 @@ enum {
HANDSHAKE_A_DONE_STATUS = 1,
HANDSHAKE_A_DONE_SOCKFD,
HANDSHAKE_A_DONE_REMOTE_AUTH,
+ HANDSHAKE_A_DONE_KEY_SERIAL,
__HANDSHAKE_A_DONE_MAX,
HANDSHAKE_A_DONE_MAX = (__HANDSHAKE_A_DONE_MAX - 1)
diff --git a/net/handshake/genl.c b/net/handshake/genl.c
index f55d14d7b726..bf64323bb5e1 100644
--- a/net/handshake/genl.c
+++ b/net/handshake/genl.c
@@ -16,10 +16,11 @@ static const struct nla_policy handshake_accept_nl_policy[HANDSHAKE_A_ACCEPT_HAN
};
/* HANDSHAKE_CMD_DONE - do */
-static const struct nla_policy handshake_done_nl_policy[HANDSHAKE_A_DONE_REMOTE_AUTH + 1] = {
+static const struct nla_policy handshake_done_nl_policy[HANDSHAKE_A_DONE_KEY_SERIAL + 1] = {
[HANDSHAKE_A_DONE_STATUS] = { .type = NLA_U32, },
[HANDSHAKE_A_DONE_SOCKFD] = { .type = NLA_S32, },
[HANDSHAKE_A_DONE_REMOTE_AUTH] = { .type = NLA_U32, },
+ [HANDSHAKE_A_DONE_KEY_SERIAL] = { .type = NLA_U32, },
};
/* Ops table for handshake */
@@ -35,7 +36,7 @@ static const struct genl_split_ops handshake_nl_ops[] = {
.cmd = HANDSHAKE_CMD_DONE,
.doit = handshake_nl_done_doit,
.policy = handshake_done_nl_policy,
- .maxattr = HANDSHAKE_A_DONE_REMOTE_AUTH,
+ .maxattr = HANDSHAKE_A_DONE_KEY_SERIAL,
.flags = GENL_CMD_CAP_DO,
},
};
diff --git a/net/handshake/tlshd.c b/net/handshake/tlshd.c
index 081093dfd553..cb1ee8ebf2ea 100644
--- a/net/handshake/tlshd.c
+++ b/net/handshake/tlshd.c
@@ -26,7 +26,8 @@
struct tls_handshake_req {
void (*th_consumer_done)(void *data, int status,
- key_serial_t peerid);
+ key_serial_t peerid,
+ key_serial_t user_key_serial);
void *th_consumer_data;
int th_type;
@@ -39,6 +40,8 @@ struct tls_handshake_req {
unsigned int th_num_peerids;
key_serial_t th_peerid[5];
+
+ key_serial_t user_key_serial;
};
static struct tls_handshake_req *
@@ -55,6 +58,7 @@ tls_handshake_req_init(struct handshake_req *req,
treq->th_num_peerids = 0;
treq->th_certificate = TLS_NO_CERT;
treq->th_privkey = TLS_NO_PRIVKEY;
+ treq->user_key_serial = TLS_NO_PRIVKEY;
return treq;
}
@@ -83,6 +87,13 @@ static void tls_handshake_remote_peerids(struct tls_handshake_req *treq,
if (i >= treq->th_num_peerids)
break;
}
+
+ nla_for_each_attr(nla, head, len, rem) {
+ if (nla_type(nla) == HANDSHAKE_A_DONE_KEY_SERIAL) {
+ treq->user_key_serial = nla_get_u32(nla);
+ break;
+ }
+ }
}
/**
@@ -105,7 +116,7 @@ static void tls_handshake_done(struct handshake_req *req,
set_bit(HANDSHAKE_F_REQ_SESSION, &req->hr_flags);
treq->th_consumer_done(treq->th_consumer_data, -status,
- treq->th_peerid[0]);
+ treq->th_peerid[0], treq->user_key_serial);
}
#if IS_ENABLED(CONFIG_KEYS)
diff --git a/net/sunrpc/svcsock.c b/net/sunrpc/svcsock.c
index 46c156b121db..3a325d7f2049 100644
--- a/net/sunrpc/svcsock.c
+++ b/net/sunrpc/svcsock.c
@@ -423,7 +423,8 @@ static void svc_tcp_kill_temp_xprt(struct svc_xprt *xprt)
* is present" flag on the xprt and let an upper layer enforce local
* security policy.
*/
-static void svc_tcp_handshake_done(void *data, int status, key_serial_t peerid)
+static void svc_tcp_handshake_done(void *data, int status, key_serial_t peerid,
+ key_serial_t user_key_serial)
{
struct svc_xprt *xprt = data;
struct svc_sock *svsk = container_of(xprt, struct svc_sock, sk_xprt);
diff --git a/net/sunrpc/xprtsock.c b/net/sunrpc/xprtsock.c
index c5f7bbf5775f..8edd095b3a40 100644
--- a/net/sunrpc/xprtsock.c
+++ b/net/sunrpc/xprtsock.c
@@ -2591,7 +2591,8 @@ static int xs_tcp_tls_finish_connecting(struct rpc_xprt *lower_xprt,
* @peerid: serial number of key containing the remote's identity
*
*/
-static void xs_tls_handshake_done(void *data, int status, key_serial_t peerid)
+static void xs_tls_handshake_done(void *data, int status, key_serial_t peerid,
+ key_serial_t user_key_serial)
{
struct rpc_xprt *lower_xprt = data;
struct sock_xprt *lower_transport =
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* Re: [PATCH 1/8] net/handshake: Store the key serial number on completion
2025-08-15 5:02 ` [PATCH 1/8] net/handshake: Store the key serial number on completion alistair23
@ 2025-08-15 13:40 ` Chuck Lever
0 siblings, 0 replies; 15+ messages in thread
From: Chuck Lever @ 2025-08-15 13:40 UTC (permalink / raw)
To: alistair23, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, Alistair Francis
On 8/15/25 1:02 AM, alistair23@gmail.com wrote:
> From: Alistair Francis <alistair.francis@wdc.com>
>
> Allow userspace to include a key serial number when completing a
> handshake with the HANDSHAKE_CMD_DONE command.
>
> We then store this serial number and will provide it back to userspace
> in the future. This allows userspace to save data to the keyring and
> then restore that data later.
>
> This will be used to support the TLS KeyUpdate operation, as now
> userspace can resume information about a established session.
Hi Alistair, thanks for continuing to pursue this functionality.
I'll need some time to go over this series more carefully, but a few
mechanical issues stand out immediately. See below.
> Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
> ---
> Documentation/netlink/specs/handshake.yaml | 4 ++++
> drivers/nvme/host/tcp.c | 3 ++-
> drivers/nvme/target/tcp.c | 3 ++-
> include/net/handshake.h | 3 ++-
> include/uapi/linux/handshake.h | 1 +
> net/handshake/genl.c | 5 +++--
> net/handshake/tlshd.c | 15 +++++++++++++--
> net/sunrpc/svcsock.c | 3 ++-
> net/sunrpc/xprtsock.c | 3 ++-
> 9 files changed, 31 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/netlink/specs/handshake.yaml b/Documentation/netlink/specs/handshake.yaml
> index 95c3fade7a8d..e76b10ef62f2 100644
> --- a/Documentation/netlink/specs/handshake.yaml
> +++ b/Documentation/netlink/specs/handshake.yaml
> @@ -87,6 +87,9 @@ attribute-sets:
> name: remote-auth
> type: u32
> multi-attr: true
> + -
> + name: key-serial
> + type: u32
Let's choose a less generic name for this type. All of the peer IDs are
"key serial numbers", I think? What do you think of "session-id" or
"session-ctx" ?
> operations:
> list:
> @@ -123,6 +126,7 @@ operations:
> - status
> - sockfd
> - remote-auth
> + - key-serial
>
> mcast-groups:
> list:
> diff --git a/drivers/nvme/host/tcp.c b/drivers/nvme/host/tcp.c
> index c0fe8cfb7229..bb7317a3f1a9 100644
> --- a/drivers/nvme/host/tcp.c
> +++ b/drivers/nvme/host/tcp.c
> @@ -1673,7 +1673,8 @@ static void nvme_tcp_set_queue_io_cpu(struct nvme_tcp_queue *queue)
> qid, queue->io_cpu);
> }
>
> -static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid)
> +static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid,
> + key_serial_t user_key_serial)
I have a patch series that adds a parameter to ->done as well. I think
it's time to consider defining a struct that carries all of this info
instead of adding more new parameters to ->done. That can be done as a
separate patch, perhaps.
> {
> struct nvme_tcp_queue *queue = data;
> struct nvme_tcp_ctrl *ctrl = queue->ctrl;
> diff --git a/drivers/nvme/target/tcp.c b/drivers/nvme/target/tcp.c
> index 470bf37e5a63..93fce316267d 100644
> --- a/drivers/nvme/target/tcp.c
> +++ b/drivers/nvme/target/tcp.c
> @@ -1780,7 +1780,8 @@ static int nvmet_tcp_tls_key_lookup(struct nvmet_tcp_queue *queue,
> }
>
> static void nvmet_tcp_tls_handshake_done(void *data, int status,
> - key_serial_t peerid)
> + key_serial_t peerid,
> + key_serial_t user_key_serial)
> {
> struct nvmet_tcp_queue *queue = data;
>
> diff --git a/include/net/handshake.h b/include/net/handshake.h
> index 8ebd4f9ed26e..449bed8c2557 100644
> --- a/include/net/handshake.h
> +++ b/include/net/handshake.h
> @@ -18,7 +18,8 @@ enum {
> };
>
> typedef void (*tls_done_func_t)(void *data, int status,
> - key_serial_t peerid);
> + key_serial_t peerid,
> + key_serial_t user_key_serial);
>
> struct tls_handshake_args {
> struct socket *ta_sock;
> diff --git a/include/uapi/linux/handshake.h b/include/uapi/linux/handshake.h
> index 662e7de46c54..46753116ba43 100644
> --- a/include/uapi/linux/handshake.h
> +++ b/include/uapi/linux/handshake.h
> @@ -55,6 +55,7 @@ enum {
> HANDSHAKE_A_DONE_STATUS = 1,
> HANDSHAKE_A_DONE_SOCKFD,
> HANDSHAKE_A_DONE_REMOTE_AUTH,
> + HANDSHAKE_A_DONE_KEY_SERIAL,
As above, KEY_SERIAL is too generic IMO.
I suppose Hannes' "A_KEYRING" is a similar vague, generic sounding
argument name... Though I'm not sure it has as specific a function as
key-serial will have.
> __HANDSHAKE_A_DONE_MAX,
> HANDSHAKE_A_DONE_MAX = (__HANDSHAKE_A_DONE_MAX - 1)
> diff --git a/net/handshake/genl.c b/net/handshake/genl.c
> index f55d14d7b726..bf64323bb5e1 100644
> --- a/net/handshake/genl.c
> +++ b/net/handshake/genl.c
> @@ -16,10 +16,11 @@ static const struct nla_policy handshake_accept_nl_policy[HANDSHAKE_A_ACCEPT_HAN
> };
>
> /* HANDSHAKE_CMD_DONE - do */
> -static const struct nla_policy handshake_done_nl_policy[HANDSHAKE_A_DONE_REMOTE_AUTH + 1] = {
> +static const struct nla_policy handshake_done_nl_policy[HANDSHAKE_A_DONE_KEY_SERIAL + 1] = {
> [HANDSHAKE_A_DONE_STATUS] = { .type = NLA_U32, },
> [HANDSHAKE_A_DONE_SOCKFD] = { .type = NLA_S32, },
> [HANDSHAKE_A_DONE_REMOTE_AUTH] = { .type = NLA_U32, },
> + [HANDSHAKE_A_DONE_KEY_SERIAL] = { .type = NLA_U32, },
> };
>
> /* Ops table for handshake */
> @@ -35,7 +36,7 @@ static const struct genl_split_ops handshake_nl_ops[] = {
> .cmd = HANDSHAKE_CMD_DONE,
> .doit = handshake_nl_done_doit,
> .policy = handshake_done_nl_policy,
> - .maxattr = HANDSHAKE_A_DONE_REMOTE_AUTH,
> + .maxattr = HANDSHAKE_A_DONE_KEY_SERIAL,
> .flags = GENL_CMD_CAP_DO,
> },
> };
> diff --git a/net/handshake/tlshd.c b/net/handshake/tlshd.c
> index 081093dfd553..cb1ee8ebf2ea 100644
> --- a/net/handshake/tlshd.c
> +++ b/net/handshake/tlshd.c
> @@ -26,7 +26,8 @@
>
> struct tls_handshake_req {
> void (*th_consumer_done)(void *data, int status,
> - key_serial_t peerid);
> + key_serial_t peerid,
> + key_serial_t user_key_serial);
> void *th_consumer_data;
>
> int th_type;
> @@ -39,6 +40,8 @@ struct tls_handshake_req {
>
> unsigned int th_num_peerids;
> key_serial_t th_peerid[5];
> +
> + key_serial_t user_key_serial;
> };
>
> static struct tls_handshake_req *
> @@ -55,6 +58,7 @@ tls_handshake_req_init(struct handshake_req *req,
> treq->th_num_peerids = 0;
> treq->th_certificate = TLS_NO_CERT;
> treq->th_privkey = TLS_NO_PRIVKEY;
> + treq->user_key_serial = TLS_NO_PRIVKEY;
> return treq;
> }
>
> @@ -83,6 +87,13 @@ static void tls_handshake_remote_peerids(struct tls_handshake_req *treq,
> if (i >= treq->th_num_peerids)
> break;
> }
> +
> + nla_for_each_attr(nla, head, len, rem) {
> + if (nla_type(nla) == HANDSHAKE_A_DONE_KEY_SERIAL) {
> + treq->user_key_serial = nla_get_u32(nla);
> + break;
> + }
> + }
> }
>
> /**
> @@ -105,7 +116,7 @@ static void tls_handshake_done(struct handshake_req *req,
> set_bit(HANDSHAKE_F_REQ_SESSION, &req->hr_flags);
>
> treq->th_consumer_done(treq->th_consumer_data, -status,
> - treq->th_peerid[0]);
> + treq->th_peerid[0], treq->user_key_serial);
> }
>
> #if IS_ENABLED(CONFIG_KEYS)
> diff --git a/net/sunrpc/svcsock.c b/net/sunrpc/svcsock.c
> index 46c156b121db..3a325d7f2049 100644
> --- a/net/sunrpc/svcsock.c
> +++ b/net/sunrpc/svcsock.c
> @@ -423,7 +423,8 @@ static void svc_tcp_kill_temp_xprt(struct svc_xprt *xprt)
> * is present" flag on the xprt and let an upper layer enforce local
> * security policy.
> */
> -static void svc_tcp_handshake_done(void *data, int status, key_serial_t peerid)
> +static void svc_tcp_handshake_done(void *data, int status, key_serial_t peerid,
> + key_serial_t user_key_serial)
> {
> struct svc_xprt *xprt = data;
> struct svc_sock *svsk = container_of(xprt, struct svc_sock, sk_xprt);
> diff --git a/net/sunrpc/xprtsock.c b/net/sunrpc/xprtsock.c
> index c5f7bbf5775f..8edd095b3a40 100644
> --- a/net/sunrpc/xprtsock.c
> +++ b/net/sunrpc/xprtsock.c
> @@ -2591,7 +2591,8 @@ static int xs_tcp_tls_finish_connecting(struct rpc_xprt *lower_xprt,
> * @peerid: serial number of key containing the remote's identity
> *
> */
> -static void xs_tls_handshake_done(void *data, int status, key_serial_t peerid)
> +static void xs_tls_handshake_done(void *data, int status, key_serial_t peerid,
> + key_serial_t user_key_serial)
> {
> struct rpc_xprt *lower_xprt = data;
> struct sock_xprt *lower_transport =
--
Chuck Lever
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 2/8] net/handshake: Make handshake_req_cancel public
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
2025-08-15 5:02 ` [PATCH 1/8] net/handshake: Store the key serial number on completion alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-15 20:03 ` kernel test robot
2025-08-15 5:02 ` [PATCH 3/8] net/handshake: Expose handshake_sk_destruct_req publically alistair23
` (5 subsequent siblings)
7 siblings, 1 reply; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
As part of supporting KeyUpdate we are going to want to call
handshake_req_cancel() to cancel an existing handshake in order to
instead start a KeyUpdate request.
This is required to avoid hash conflicts when handshake_req_hash_add()
is called as part of submitting the KeyUpdate request.
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
include/net/handshake.h | 2 ++
net/handshake/handshake-test.c | 1 +
net/handshake/handshake.h | 1 -
3 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/include/net/handshake.h b/include/net/handshake.h
index 449bed8c2557..8a64729614e1 100644
--- a/include/net/handshake.h
+++ b/include/net/handshake.h
@@ -43,6 +43,8 @@ int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags);
bool tls_handshake_cancel(struct sock *sk);
void tls_handshake_close(struct socket *sock);
+bool handshake_req_cancel(struct sock *sk);
+
u8 tls_get_record_type(const struct sock *sk, const struct cmsghdr *msg);
void tls_alert_recv(const struct sock *sk, const struct msghdr *msg,
u8 *level, u8 *description);
diff --git a/net/handshake/handshake-test.c b/net/handshake/handshake-test.c
index 55442b2f518a..c338b9977a71 100644
--- a/net/handshake/handshake-test.c
+++ b/net/handshake/handshake-test.c
@@ -13,6 +13,7 @@
#include <net/sock.h>
#include <net/genetlink.h>
#include <net/netns/generic.h>
+#include <net/handshake.h>
#include <uapi/linux/handshake.h>
#include "handshake.h"
diff --git a/net/handshake/handshake.h b/net/handshake/handshake.h
index a48163765a7a..55c25eaba0f4 100644
--- a/net/handshake/handshake.h
+++ b/net/handshake/handshake.h
@@ -88,6 +88,5 @@ int handshake_req_submit(struct socket *sock, struct handshake_req *req,
gfp_t flags);
void handshake_complete(struct handshake_req *req, unsigned int status,
struct genl_info *info);
-bool handshake_req_cancel(struct sock *sk);
#endif /* _INTERNAL_HANDSHAKE_H */
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* Re: [PATCH 2/8] net/handshake: Make handshake_req_cancel public
2025-08-15 5:02 ` [PATCH 2/8] net/handshake: Make handshake_req_cancel public alistair23
@ 2025-08-15 20:03 ` kernel test robot
0 siblings, 0 replies; 15+ messages in thread
From: kernel test robot @ 2025-08-15 20:03 UTC (permalink / raw)
To: alistair23, chuck.lever, hare, kernel-tls-handshake, netdev,
linux-kernel, linux-doc, linux-nvme, linux-nfs
Cc: llvm, oe-kbuild-all, kbusch, axboe, hch, sagi, kch, alistair23,
Alistair Francis
Hi,
kernel test robot noticed the following build warnings:
[auto build test WARNING on trondmy-nfs/linux-next]
[also build test WARNING on net/main net-next/main linus/master linux-nvme/for-next v6.17-rc1 next-20250815]
[cannot apply to horms-ipvs/master]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/alistair23-gmail-com/net-handshake-Store-the-key-serial-number-on-completion/20250815-130804
base: git://git.linux-nfs.org/projects/trondmy/linux-nfs.git linux-next
patch link: https://lore.kernel.org/r/20250815050210.1518439-3-alistair.francis%40wdc.com
patch subject: [PATCH 2/8] net/handshake: Make handshake_req_cancel public
config: arm-mps2_defconfig (https://download.01.org/0day-ci/archive/20250816/202508160354.iNoLUr4h-lkp@intel.com/config)
compiler: clang version 22.0.0git (https://github.com/llvm/llvm-project 93d24b6b7b148c47a2fa228a4ef31524fa1d9f3f)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250816/202508160354.iNoLUr4h-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202508160354.iNoLUr4h-lkp@intel.com/
All warnings (new ones prefixed by >>):
>> net/handshake/request.c:312:6: warning: no previous prototype for function 'handshake_req_cancel' [-Wmissing-prototypes]
312 | bool handshake_req_cancel(struct sock *sk)
| ^
net/handshake/request.c:312:1: note: declare 'static' if the function is not intended to be used outside of this translation unit
312 | bool handshake_req_cancel(struct sock *sk)
| ^
| static
1 warning generated.
vim +/handshake_req_cancel +312 net/handshake/request.c
3b3009ea8abb71 Chuck Lever 2023-04-17 300
3b3009ea8abb71 Chuck Lever 2023-04-17 301 /**
3b3009ea8abb71 Chuck Lever 2023-04-17 302 * handshake_req_cancel - Cancel an in-progress handshake
3b3009ea8abb71 Chuck Lever 2023-04-17 303 * @sk: socket on which there is an ongoing handshake
3b3009ea8abb71 Chuck Lever 2023-04-17 304 *
3b3009ea8abb71 Chuck Lever 2023-04-17 305 * Request cancellation races with request completion. To determine
3b3009ea8abb71 Chuck Lever 2023-04-17 306 * who won, callers examine the return value from this function.
3b3009ea8abb71 Chuck Lever 2023-04-17 307 *
3b3009ea8abb71 Chuck Lever 2023-04-17 308 * Return values:
3b3009ea8abb71 Chuck Lever 2023-04-17 309 * %true - Uncompleted handshake request was canceled
3b3009ea8abb71 Chuck Lever 2023-04-17 310 * %false - Handshake request already completed or not found
3b3009ea8abb71 Chuck Lever 2023-04-17 311 */
3b3009ea8abb71 Chuck Lever 2023-04-17 @312 bool handshake_req_cancel(struct sock *sk)
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 3/8] net/handshake: Expose handshake_sk_destruct_req publically
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
2025-08-15 5:02 ` [PATCH 1/8] net/handshake: Store the key serial number on completion alistair23
2025-08-15 5:02 ` [PATCH 2/8] net/handshake: Make handshake_req_cancel public alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-15 21:48 ` kernel test robot
2025-08-15 5:02 ` [PATCH 4/8] tls: Allow callers to clear errors alistair23
` (4 subsequent siblings)
7 siblings, 1 reply; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
Define a `handshake_sk_destruct_req()` function and expose it publically
so that other subsystems can destruct the handshake req.
This will be used as part of the KeyUpdate to ensure any existing
requests anre cancelled and destructed if required.
This is required to avoid hash conflicts when handshake_req_hash_add()
is called as part of submitting the KeyUpdate request.
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
include/net/handshake.h | 1 +
net/handshake/request.c | 17 +++++++++++++++++
2 files changed, 18 insertions(+)
diff --git a/include/net/handshake.h b/include/net/handshake.h
index 8a64729614e1..fab4760049c6 100644
--- a/include/net/handshake.h
+++ b/include/net/handshake.h
@@ -43,6 +43,7 @@ int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags);
bool tls_handshake_cancel(struct sock *sk);
void tls_handshake_close(struct socket *sock);
+void handshake_sk_destruct_req(struct sock *sk);
bool handshake_req_cancel(struct sock *sk);
u8 tls_get_record_type(const struct sock *sk, const struct cmsghdr *msg);
diff --git a/net/handshake/request.c b/net/handshake/request.c
index 274d2c89b6b2..bb727a9ad042 100644
--- a/net/handshake/request.c
+++ b/net/handshake/request.c
@@ -341,3 +341,20 @@ bool handshake_req_cancel(struct sock *sk)
return true;
}
EXPORT_SYMBOL(handshake_req_cancel);
+
+/**
+ * handshake_sk_destruct_req - destroy an existing request
+ * @sk: socket on which there is an existing request
+ */
+void handshake_sk_destruct_req(struct sock *sk)
+{
+ struct handshake_req *req;
+
+ req = handshake_req_hash_lookup(sk);
+ if (!req)
+ return;
+
+ trace_handshake_destruct(sock_net(sk), req, sk);
+ handshake_req_destroy(req);
+}
+EXPORT_SYMBOL(handshake_sk_destruct_req);
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* Re: [PATCH 3/8] net/handshake: Expose handshake_sk_destruct_req publically
2025-08-15 5:02 ` [PATCH 3/8] net/handshake: Expose handshake_sk_destruct_req publically alistair23
@ 2025-08-15 21:48 ` kernel test robot
0 siblings, 0 replies; 15+ messages in thread
From: kernel test robot @ 2025-08-15 21:48 UTC (permalink / raw)
To: alistair23, chuck.lever, hare, kernel-tls-handshake, netdev,
linux-kernel, linux-doc, linux-nvme, linux-nfs
Cc: llvm, oe-kbuild-all, kbusch, axboe, hch, sagi, kch, alistair23,
Alistair Francis
Hi,
kernel test robot noticed the following build warnings:
[auto build test WARNING on trondmy-nfs/linux-next]
[also build test WARNING on net/main net-next/main linus/master linux-nvme/for-next v6.17-rc1 next-20250815]
[cannot apply to horms-ipvs/master]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/alistair23-gmail-com/net-handshake-Store-the-key-serial-number-on-completion/20250815-130804
base: git://git.linux-nfs.org/projects/trondmy/linux-nfs.git linux-next
patch link: https://lore.kernel.org/r/20250815050210.1518439-4-alistair.francis%40wdc.com
patch subject: [PATCH 3/8] net/handshake: Expose handshake_sk_destruct_req publically
config: arm-mps2_defconfig (https://download.01.org/0day-ci/archive/20250816/202508160510.XOTeniWX-lkp@intel.com/config)
compiler: clang version 22.0.0git (https://github.com/llvm/llvm-project 93d24b6b7b148c47a2fa228a4ef31524fa1d9f3f)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250816/202508160510.XOTeniWX-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202508160510.XOTeniWX-lkp@intel.com/
All warnings (new ones prefixed by >>):
net/handshake/request.c:312:6: warning: no previous prototype for function 'handshake_req_cancel' [-Wmissing-prototypes]
312 | bool handshake_req_cancel(struct sock *sk)
| ^
net/handshake/request.c:312:1: note: declare 'static' if the function is not intended to be used outside of this translation unit
312 | bool handshake_req_cancel(struct sock *sk)
| ^
| static
>> net/handshake/request.c:349:6: warning: no previous prototype for function 'handshake_sk_destruct_req' [-Wmissing-prototypes]
349 | void handshake_sk_destruct_req(struct sock *sk)
| ^
net/handshake/request.c:349:1: note: declare 'static' if the function is not intended to be used outside of this translation unit
349 | void handshake_sk_destruct_req(struct sock *sk)
| ^
| static
2 warnings generated.
vim +/handshake_sk_destruct_req +349 net/handshake/request.c
344
345 /**
346 * handshake_sk_destruct_req - destroy an existing request
347 * @sk: socket on which there is an existing request
348 */
> 349 void handshake_sk_destruct_req(struct sock *sk)
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 4/8] tls: Allow callers to clear errors
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
` (2 preceding siblings ...)
2025-08-15 5:02 ` [PATCH 3/8] net/handshake: Expose handshake_sk_destruct_req publically alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-15 17:02 ` Jakub Kicinski
2025-08-15 5:02 ` [PATCH 5/8] net/handshake: Support KeyUpdate message types alistair23
` (3 subsequent siblings)
7 siblings, 1 reply; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
As part of supporting KeyUpdate we are going to pass errors up to the
callers of TLS to indaicate a KeyUpdate. Those layers will need to handle
the KeyUpdate and as part of that clear the error.
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
include/net/tls.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/include/net/tls.h b/include/net/tls.h
index 857340338b69..7de960225da2 100644
--- a/include/net/tls.h
+++ b/include/net/tls.h
@@ -493,6 +493,13 @@ static inline bool tls_offload_tx_resync_pending(struct sock *sk)
struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
+static inline void tls_clear_err(struct sock *sk)
+{
+ WRITE_ONCE(sk->sk_err, 0);
+ /* Paired with smp_rmb() in tcp_poll() */
+ smp_wmb();
+}
+
#ifdef CONFIG_TLS_DEVICE
void tls_device_sk_destruct(struct sock *sk);
void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* Re: [PATCH 4/8] tls: Allow callers to clear errors
2025-08-15 5:02 ` [PATCH 4/8] tls: Allow callers to clear errors alistair23
@ 2025-08-15 17:02 ` Jakub Kicinski
0 siblings, 0 replies; 15+ messages in thread
From: Jakub Kicinski @ 2025-08-15 17:02 UTC (permalink / raw)
To: alistair23
Cc: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs, kbusch, axboe, hch, sagi, kch,
Alistair Francis
On Fri, 15 Aug 2025 15:02:06 +1000 alistair23@gmail.com wrote:
> As part of supporting KeyUpdate we are going to pass errors up to the
> callers of TLS to indaicate a KeyUpdate. Those layers will need to handle
> the KeyUpdate and as part of that clear the error.
> +static inline void tls_clear_err(struct sock *sk)
> +{
> + WRITE_ONCE(sk->sk_err, 0);
> + /* Paired with smp_rmb() in tcp_poll() */
> + smp_wmb();
Please explain how the key error ends up recorded on the socket.
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 5/8] net/handshake: Support KeyUpdate message types
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
` (3 preceding siblings ...)
2025-08-15 5:02 ` [PATCH 4/8] tls: Allow callers to clear errors alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-15 5:02 ` [PATCH 6/8] nvme-tcp: Support KeyUpdate alistair23
` (2 subsequent siblings)
7 siblings, 0 replies; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
When reporting the msg-type to userspace let's also support reporting
KeyUpdate events. This supports reporting a client/server event and if
the other side requested a KeyUpdateRequest.
Link: https://datatracker.ietf.org/doc/html/rfc8446#section-4.6.3
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
Documentation/netlink/specs/handshake.yaml | 15 +++++++++-
Documentation/networking/tls-handshake.rst | 4 +--
drivers/nvme/host/tcp.c | 12 ++++++--
drivers/nvme/target/tcp.c | 11 ++++++--
include/net/handshake.h | 11 ++++++--
include/uapi/linux/handshake.h | 13 +++++++++
net/handshake/tlshd.c | 33 ++++++++++++++++++----
7 files changed, 83 insertions(+), 16 deletions(-)
diff --git a/Documentation/netlink/specs/handshake.yaml b/Documentation/netlink/specs/handshake.yaml
index e76b10ef62f2..8e6275af1ff8 100644
--- a/Documentation/netlink/specs/handshake.yaml
+++ b/Documentation/netlink/specs/handshake.yaml
@@ -21,12 +21,17 @@ definitions:
type: enum
name: msg-type
value-start: 0
- entries: [unspec, clienthello, serverhello]
+ entries: [unspec, clienthello, serverhello, clientkeyupdate, clientkeyupdaterequest, serverkeyupdate, serverkeyupdaterequest]
-
type: enum
name: auth
value-start: 0
entries: [unspec, unauth, psk, x509]
+ -
+ type: enum
+ name: key-update-type
+ value-start: 0
+ entries: [unspec, send, received, received_request_update]
attribute-sets:
-
@@ -74,6 +79,13 @@ attribute-sets:
-
name: keyring
type: u32
+ -
+ name: key-update-request
+ type: u32
+ enum: key-update-type
+ -
+ name: key-serial
+ type: u32
-
name: done
attributes:
@@ -116,6 +128,7 @@ operations:
- certificate
- peername
- keyring
+ - key-serial
-
name: done
doc: Handler reports handshake completion
diff --git a/Documentation/networking/tls-handshake.rst b/Documentation/networking/tls-handshake.rst
index 6f5ea1646a47..64a70847bd8b 100644
--- a/Documentation/networking/tls-handshake.rst
+++ b/Documentation/networking/tls-handshake.rst
@@ -108,7 +108,7 @@ To initiate a client-side TLS handshake with a pre-shared key, use:
.. code-block:: c
- ret = tls_client_hello_psk(args, gfp_flags);
+ ret = tls_client_hello_psk(args, gfp_flags, handshake_key_update_type);
However, in this case, the consumer fills in the @ta_my_peerids array
with serial numbers of keys containing the peer identities it wishes
@@ -138,7 +138,7 @@ or
.. code-block:: c
- ret = tls_server_hello_psk(args, gfp_flags);
+ ret = tls_server_hello_psk(args, gfp_flags, handshake_key_update_type);
The argument structure is filled in as above.
diff --git a/drivers/nvme/host/tcp.c b/drivers/nvme/host/tcp.c
index bb7317a3f1a9..cc3332529355 100644
--- a/drivers/nvme/host/tcp.c
+++ b/drivers/nvme/host/tcp.c
@@ -19,6 +19,7 @@
#include <linux/blk-mq.h>
#include <net/busy_poll.h>
#include <trace/events/sock.h>
+#include <uapi/linux/handshake.h>
#include "nvme.h"
#include "fabrics.h"
@@ -205,6 +206,10 @@ static struct workqueue_struct *nvme_tcp_wq;
static const struct blk_mq_ops nvme_tcp_mq_ops;
static const struct blk_mq_ops nvme_tcp_admin_mq_ops;
static int nvme_tcp_try_send(struct nvme_tcp_queue *queue);
+static int nvme_tcp_start_tls(struct nvme_ctrl *nctrl,
+ struct nvme_tcp_queue *queue,
+ key_serial_t pskid,
+ handshake_key_update_type keyupdate);
static inline struct nvme_tcp_ctrl *to_tcp_ctrl(struct nvme_ctrl *ctrl)
{
@@ -1708,7 +1713,8 @@ static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid,
static int nvme_tcp_start_tls(struct nvme_ctrl *nctrl,
struct nvme_tcp_queue *queue,
- key_serial_t pskid)
+ key_serial_t pskid,
+ handshake_key_update_type keyupdate)
{
int qid = nvme_tcp_queue_id(queue);
int ret;
@@ -1730,7 +1736,7 @@ static int nvme_tcp_start_tls(struct nvme_ctrl *nctrl,
args.ta_timeout_ms = tls_handshake_timeout * 1000;
queue->tls_err = -EOPNOTSUPP;
init_completion(&queue->tls_complete);
- ret = tls_client_hello_psk(&args, GFP_KERNEL);
+ ret = tls_client_hello_psk(&args, GFP_KERNEL, keyupdate);
if (ret) {
dev_err(nctrl->device, "queue %d: failed to start TLS: %d\n",
qid, ret);
@@ -1880,7 +1886,7 @@ static int nvme_tcp_alloc_queue(struct nvme_ctrl *nctrl, int qid,
/* If PSKs are configured try to start TLS */
if (nvme_tcp_tls_configured(nctrl) && pskid) {
- ret = nvme_tcp_start_tls(nctrl, queue, pskid);
+ ret = nvme_tcp_start_tls(nctrl, queue, pskid, HANDSHAKE_KEY_UPDATE_TYPE_UNSPEC);
if (ret)
goto err_init_connect;
}
diff --git a/drivers/nvme/target/tcp.c b/drivers/nvme/target/tcp.c
index 93fce316267d..5eaab9c858be 100644
--- a/drivers/nvme/target/tcp.c
+++ b/drivers/nvme/target/tcp.c
@@ -214,6 +214,10 @@ static struct workqueue_struct *nvmet_tcp_wq;
static const struct nvmet_fabrics_ops nvmet_tcp_ops;
static void nvmet_tcp_free_cmd(struct nvmet_tcp_cmd *c);
static void nvmet_tcp_free_cmd_buffers(struct nvmet_tcp_cmd *cmd);
+#ifdef CONFIG_NVME_TARGET_TCP_TLS
+static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue,
+ handshake_key_update_type keyupdate);
+#endif
static inline u16 nvmet_tcp_cmd_tag(struct nvmet_tcp_queue *queue,
struct nvmet_tcp_cmd *cmd)
@@ -1833,7 +1837,8 @@ static void nvmet_tcp_tls_handshake_timeout(struct work_struct *w)
kref_put(&queue->kref, nvmet_tcp_release_queue);
}
-static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue)
+static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue,
+ handshake_key_update_type keyupdate)
{
int ret = -EOPNOTSUPP;
struct tls_handshake_args args;
@@ -1852,7 +1857,7 @@ static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue)
args.ta_keyring = key_serial(queue->port->nport->keyring);
args.ta_timeout_ms = tls_handshake_timeout * 1000;
- ret = tls_server_hello_psk(&args, GFP_KERNEL);
+ ret = tls_server_hello_psk(&args, GFP_KERNEL, keyupdate);
if (ret) {
kref_put(&queue->kref, nvmet_tcp_release_queue);
pr_err("failed to start TLS, err=%d\n", ret);
@@ -1934,7 +1939,7 @@ static void nvmet_tcp_alloc_queue(struct nvmet_tcp_port *port,
sk->sk_data_ready = port->data_ready;
write_unlock_bh(&sk->sk_callback_lock);
if (!nvmet_tcp_try_peek_pdu(queue)) {
- if (!nvmet_tcp_tls_handshake(queue))
+ if (!nvmet_tcp_tls_handshake(queue, HANDSHAKE_KEY_UPDATE_TYPE_UNSPEC))
return;
/* TLS handshake failed, terminate the connection */
goto out_destroy_sq;
diff --git a/include/net/handshake.h b/include/net/handshake.h
index fab4760049c6..8f791c55edc9 100644
--- a/include/net/handshake.h
+++ b/include/net/handshake.h
@@ -10,6 +10,10 @@
#ifndef _NET_HANDSHAKE_H
#define _NET_HANDSHAKE_H
+#include <uapi/linux/handshake.h>
+
+#define handshake_key_update_type u32
+
enum {
TLS_NO_KEYRING = 0,
TLS_NO_PEERID = 0,
@@ -32,13 +36,16 @@ struct tls_handshake_args {
key_serial_t ta_my_privkey;
unsigned int ta_num_peerids;
key_serial_t ta_my_peerids[5];
+ key_serial_t user_key_serial;
};
int tls_client_hello_anon(const struct tls_handshake_args *args, gfp_t flags);
int tls_client_hello_x509(const struct tls_handshake_args *args, gfp_t flags);
-int tls_client_hello_psk(const struct tls_handshake_args *args, gfp_t flags);
+int tls_client_hello_psk(const struct tls_handshake_args *args, gfp_t flags,
+ handshake_key_update_type keyupdate);
int tls_server_hello_x509(const struct tls_handshake_args *args, gfp_t flags);
-int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags);
+int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags,
+ handshake_key_update_type keyupdate);
bool tls_handshake_cancel(struct sock *sk);
void tls_handshake_close(struct socket *sock);
diff --git a/include/uapi/linux/handshake.h b/include/uapi/linux/handshake.h
index 46753116ba43..f615b8226dba 100644
--- a/include/uapi/linux/handshake.h
+++ b/include/uapi/linux/handshake.h
@@ -19,6 +19,10 @@ enum handshake_msg_type {
HANDSHAKE_MSG_TYPE_UNSPEC,
HANDSHAKE_MSG_TYPE_CLIENTHELLO,
HANDSHAKE_MSG_TYPE_SERVERHELLO,
+ HANDSHAKE_MSG_TYPE_CLIENTKEYUPDATE,
+ HANDSHAKE_MSG_TYPE_CLIENTKEYUPDATEREQUEST,
+ HANDSHAKE_MSG_TYPE_SERVERKEYUPDATE,
+ HANDSHAKE_MSG_TYPE_SERVERKEYUPDATEREQUEST,
};
enum handshake_auth {
@@ -28,6 +32,13 @@ enum handshake_auth {
HANDSHAKE_AUTH_X509,
};
+enum handshake_key_update_type {
+ HANDSHAKE_KEY_UPDATE_TYPE_UNSPEC,
+ HANDSHAKE_KEY_UPDATE_TYPE_SEND,
+ HANDSHAKE_KEY_UPDATE_TYPE_RECEIVED,
+ HANDSHAKE_KEY_UPDATE_TYPE_RECEIVED_REQUEST_UPDATE,
+};
+
enum {
HANDSHAKE_A_X509_CERT = 1,
HANDSHAKE_A_X509_PRIVKEY,
@@ -46,6 +57,8 @@ enum {
HANDSHAKE_A_ACCEPT_CERTIFICATE,
HANDSHAKE_A_ACCEPT_PEERNAME,
HANDSHAKE_A_ACCEPT_KEYRING,
+ HANDSHAKE_A_ACCEPT_KEY_UPDATE_REQUEST,
+ HANDSHAKE_A_ACCEPT_KEY_SERIAL,
__HANDSHAKE_A_ACCEPT_MAX,
HANDSHAKE_A_ACCEPT_MAX = (__HANDSHAKE_A_ACCEPT_MAX - 1)
diff --git a/net/handshake/tlshd.c b/net/handshake/tlshd.c
index cb1ee8ebf2ea..ceedb2e78697 100644
--- a/net/handshake/tlshd.c
+++ b/net/handshake/tlshd.c
@@ -41,6 +41,8 @@ struct tls_handshake_req {
unsigned int th_num_peerids;
key_serial_t th_peerid[5];
+ int th_key_update_request;
+
key_serial_t user_key_serial;
};
@@ -58,7 +60,8 @@ tls_handshake_req_init(struct handshake_req *req,
treq->th_num_peerids = 0;
treq->th_certificate = TLS_NO_CERT;
treq->th_privkey = TLS_NO_PRIVKEY;
- treq->user_key_serial = TLS_NO_PRIVKEY;
+ treq->user_key_serial = args->user_key_serial;
+
return treq;
}
@@ -265,6 +268,16 @@ static int tls_handshake_accept(struct handshake_req *req,
break;
}
+ ret = nla_put_u32(msg, HANDSHAKE_A_ACCEPT_KEY_SERIAL,
+ treq->user_key_serial);
+ if (ret < 0)
+ goto out_cancel;
+
+ ret = nla_put_u32(msg, HANDSHAKE_A_ACCEPT_KEY_UPDATE_REQUEST,
+ treq->th_key_update_request);
+ if (ret < 0)
+ goto out_cancel;
+
genlmsg_end(msg, hdr);
return genlmsg_reply(msg, info);
@@ -348,7 +361,8 @@ EXPORT_SYMBOL(tls_client_hello_x509);
* %-ESRCH: No user agent is available
* %-ENOMEM: Memory allocation failed
*/
-int tls_client_hello_psk(const struct tls_handshake_args *args, gfp_t flags)
+int tls_client_hello_psk(const struct tls_handshake_args *args, gfp_t flags,
+ handshake_key_update_type keyupdate)
{
struct tls_handshake_req *treq;
struct handshake_req *req;
@@ -362,7 +376,11 @@ int tls_client_hello_psk(const struct tls_handshake_args *args, gfp_t flags)
if (!req)
return -ENOMEM;
treq = tls_handshake_req_init(req, args);
- treq->th_type = HANDSHAKE_MSG_TYPE_CLIENTHELLO;
+ if (keyupdate != HANDSHAKE_KEY_UPDATE_TYPE_UNSPEC)
+ treq->th_type = HANDSHAKE_MSG_TYPE_CLIENTKEYUPDATE;
+ else
+ treq->th_type = HANDSHAKE_MSG_TYPE_CLIENTHELLO;
+ treq->th_key_update_request = keyupdate;
treq->th_auth_mode = HANDSHAKE_AUTH_PSK;
treq->th_num_peerids = args->ta_num_peerids;
for (i = 0; i < args->ta_num_peerids; i++)
@@ -410,7 +428,8 @@ EXPORT_SYMBOL(tls_server_hello_x509);
* %-ESRCH: No user agent is available
* %-ENOMEM: Memory allocation failed
*/
-int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags)
+int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags,
+ handshake_key_update_type keyupdate)
{
struct tls_handshake_req *treq;
struct handshake_req *req;
@@ -419,7 +438,11 @@ int tls_server_hello_psk(const struct tls_handshake_args *args, gfp_t flags)
if (!req)
return -ENOMEM;
treq = tls_handshake_req_init(req, args);
- treq->th_type = HANDSHAKE_MSG_TYPE_SERVERHELLO;
+ if (keyupdate != HANDSHAKE_KEY_UPDATE_TYPE_UNSPEC)
+ treq->th_type = HANDSHAKE_MSG_TYPE_SERVERKEYUPDATE;
+ else
+ treq->th_type = HANDSHAKE_MSG_TYPE_SERVERHELLO;
+ treq->th_key_update_request = keyupdate;
treq->th_auth_mode = HANDSHAKE_AUTH_PSK;
treq->th_num_peerids = 1;
treq->th_peerid[0] = args->ta_my_peerids[0];
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* [PATCH 6/8] nvme-tcp: Support KeyUpdate
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
` (4 preceding siblings ...)
2025-08-15 5:02 ` [PATCH 5/8] net/handshake: Support KeyUpdate message types alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-18 12:52 ` Hannes Reinecke
2025-08-15 5:02 ` [PATCH 7/8] net/handshake: Support decoding the HandshakeType alistair23
2025-08-15 5:02 ` [PATCH 8/8] nvmet-tcp: Support KeyUpdate alistair23
7 siblings, 1 reply; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
If the nvme_tcp_try_send() or nvme_tcp_try_recv() functions return
EKEYEXPIRED then the underlying TLS keys need to be updated. This occurs
on an KeyUpdate event.
If the NVMe Target (TLS server) initiates a KeyUpdate this patch will
allow the NVMe layer to process the KeyUpdate request and forward the
request to userspace. Userspace must then update the key to keep the
connection alive.
This patch allows us to handle the NVMe target sending a KeyUpdate
request without aborting the connection. At this time we don't support
initiating a KeyUpdate.
Link: https://datatracker.ietf.org/doc/html/rfc8446#section-4.6.3
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
drivers/nvme/host/tcp.c | 63 ++++++++++++++++++++++++++++++++++++++++-
1 file changed, 62 insertions(+), 1 deletion(-)
diff --git a/drivers/nvme/host/tcp.c b/drivers/nvme/host/tcp.c
index cc3332529355..0c14d3ad58af 100644
--- a/drivers/nvme/host/tcp.c
+++ b/drivers/nvme/host/tcp.c
@@ -171,6 +171,7 @@ struct nvme_tcp_queue {
bool tls_enabled;
u32 rcv_crc;
u32 snd_crc;
+ key_serial_t user_key_serial;
__le32 exp_ddgst;
__le32 recv_ddgst;
struct completion tls_complete;
@@ -1313,6 +1314,7 @@ static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
struct nvme_tcp_request *req;
unsigned int noreclaim_flag;
int ret = 1;
+ enum nvme_ctrl_state state = nvme_ctrl_state(&(queue->ctrl->ctrl));
if (!queue->request) {
queue->request = nvme_tcp_fetch_request(queue);
@@ -1347,6 +1349,29 @@ static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
done:
if (ret == -EAGAIN) {
ret = 0;
+ } else if (ret == -EKEYEXPIRED &&
+ state != NVME_CTRL_CONNECTING &&
+ state != NVME_CTRL_RESETTING) {
+ int qid = nvme_tcp_queue_id(queue);
+
+ dev_dbg(queue->ctrl->ctrl.device,
+ "updating key for queue %d\n", qid);
+
+ nvme_change_ctrl_state(&(queue->ctrl->ctrl), NVME_CTRL_RESETTING);
+ tls_clear_err(queue->sock->sk);
+ handshake_req_cancel(queue->sock->sk);
+ handshake_sk_destruct_req(queue->sock->sk);
+
+ ret = nvme_tcp_start_tls(&(queue->ctrl->ctrl),
+ queue, queue->ctrl->ctrl.tls_pskid,
+ HANDSHAKE_KEY_UPDATE_TYPE_RECEIVED);
+
+ if (ret < 0) {
+ dev_err(queue->ctrl->ctrl.device,
+ "failed to update the keys %d\n", ret);
+ nvme_tcp_fail_request(queue->request);
+ nvme_tcp_done_send_req(queue);
+ }
} else if (ret < 0) {
dev_err(queue->ctrl->ctrl.device,
"failed to send request %d\n", ret);
@@ -1383,6 +1408,7 @@ static void nvme_tcp_io_work(struct work_struct *w)
do {
bool pending = false;
int result;
+ enum nvme_ctrl_state state = nvme_ctrl_state(&(queue->ctrl->ctrl));
if (mutex_trylock(&queue->send_mutex)) {
result = nvme_tcp_try_send(queue);
@@ -1396,8 +1422,34 @@ static void nvme_tcp_io_work(struct work_struct *w)
result = nvme_tcp_try_recv(queue);
if (result > 0)
pending = true;
- else if (unlikely(result < 0))
+ else if (unlikely(result < 0)) {
+ if (result == -EKEYEXPIRED &&
+ state != NVME_CTRL_CONNECTING &&
+ state != NVME_CTRL_RESETTING) {
+ int qid = nvme_tcp_queue_id(queue);
+
+ dev_dbg(queue->ctrl->ctrl.device,
+ "updating key for queue %d\n", qid);
+
+ nvme_change_ctrl_state(&(queue->ctrl->ctrl), NVME_CTRL_RESETTING);
+ tls_clear_err(queue->sock->sk);
+ handshake_req_cancel(queue->sock->sk);
+ handshake_sk_destruct_req(queue->sock->sk);
+
+ result = nvme_tcp_start_tls(&(queue->ctrl->ctrl),
+ queue, queue->ctrl->ctrl.tls_pskid,
+ HANDSHAKE_KEY_UPDATE_TYPE_RECEIVED);
+
+ if (result < 0) {
+ dev_err(queue->ctrl->ctrl.device,
+ "failed to update the keys %d\n", result);
+ nvme_tcp_fail_request(queue->request);
+ nvme_tcp_done_send_req(queue);
+ }
+ }
+
return;
+ }
/* did we get some space after spending time in recv? */
if (nvme_tcp_queue_has_pending(queue) &&
@@ -1705,6 +1757,7 @@ static void nvme_tcp_tls_done(void *data, int status, key_serial_t pskid,
ctrl->ctrl.tls_pskid = key_serial(tls_key);
key_put(tls_key);
queue->tls_err = 0;
+ queue->user_key_serial = user_key_serial;
}
out_complete:
@@ -1734,6 +1787,7 @@ static int nvme_tcp_start_tls(struct nvme_ctrl *nctrl,
keyring = key_serial(nctrl->opts->keyring);
args.ta_keyring = keyring;
args.ta_timeout_ms = tls_handshake_timeout * 1000;
+ args.user_key_serial = queue->user_key_serial;
queue->tls_err = -EOPNOTSUPP;
init_completion(&queue->tls_complete);
ret = tls_client_hello_psk(&args, GFP_KERNEL, keyupdate);
@@ -1742,7 +1796,14 @@ static int nvme_tcp_start_tls(struct nvme_ctrl *nctrl,
qid, ret);
return ret;
}
+ if (keyupdate) {
+ dev_dbg(nctrl->device,
+ "queue %d: TLS keyupdate complete\n", qid);
+ return 0;
+ }
+
ret = wait_for_completion_interruptible_timeout(&queue->tls_complete, tmo);
+
if (ret <= 0) {
if (ret == 0)
ret = -ETIMEDOUT;
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* Re: [PATCH 6/8] nvme-tcp: Support KeyUpdate
2025-08-15 5:02 ` [PATCH 6/8] nvme-tcp: Support KeyUpdate alistair23
@ 2025-08-18 12:52 ` Hannes Reinecke
0 siblings, 0 replies; 15+ messages in thread
From: Hannes Reinecke @ 2025-08-18 12:52 UTC (permalink / raw)
To: alistair23, chuck.lever, hare, kernel-tls-handshake, netdev,
linux-kernel, linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, Alistair Francis
On 8/15/25 07:02, alistair23@gmail.com wrote:
> From: Alistair Francis <alistair.francis@wdc.com>
>
> If the nvme_tcp_try_send() or nvme_tcp_try_recv() functions return
> EKEYEXPIRED then the underlying TLS keys need to be updated. This occurs
> on an KeyUpdate event.
>
> If the NVMe Target (TLS server) initiates a KeyUpdate this patch will
> allow the NVMe layer to process the KeyUpdate request and forward the
> request to userspace. Userspace must then update the key to keep the
> connection alive.
>
> This patch allows us to handle the NVMe target sending a KeyUpdate
> request without aborting the connection. At this time we don't support
> initiating a KeyUpdate.
>
> Link: https://datatracker.ietf.org/doc/html/rfc8446#section-4.6.3
> Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
> ---
> drivers/nvme/host/tcp.c | 63 ++++++++++++++++++++++++++++++++++++++++-
> 1 file changed, 62 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/nvme/host/tcp.c b/drivers/nvme/host/tcp.c
> index cc3332529355..0c14d3ad58af 100644
> --- a/drivers/nvme/host/tcp.c
> +++ b/drivers/nvme/host/tcp.c
> @@ -171,6 +171,7 @@ struct nvme_tcp_queue {
> bool tls_enabled;
> u32 rcv_crc;
> u32 snd_crc;
> + key_serial_t user_key_serial;
> __le32 exp_ddgst;
> __le32 recv_ddgst;
> struct completion tls_complete;
> @@ -1313,6 +1314,7 @@ static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
> struct nvme_tcp_request *req;
> unsigned int noreclaim_flag;
> int ret = 1;
> + enum nvme_ctrl_state state = nvme_ctrl_state(&(queue->ctrl->ctrl));
>
> if (!queue->request) {
> queue->request = nvme_tcp_fetch_request(queue);
> @@ -1347,6 +1349,29 @@ static int nvme_tcp_try_send(struct nvme_tcp_queue *queue)
> done:
> if (ret == -EAGAIN) {
> ret = 0;
> + } else if (ret == -EKEYEXPIRED &&
> + state != NVME_CTRL_CONNECTING &&
> + state != NVME_CTRL_RESETTING) {
> + int qid = nvme_tcp_queue_id(queue);
> +
> + dev_dbg(queue->ctrl->ctrl.device,
> + "updating key for queue %d\n", qid);
> +
> + nvme_change_ctrl_state(&(queue->ctrl->ctrl), NVME_CTRL_RESETTING);
Rah. Don't do that.
The 'resetting' state is tied to the resetting mechanism
(LIVE->RESETTING->CONNECTING->LIVE) and is being relied on
for the timeout handler. Setting it manually will confuse error
handling.
And really, having the key update in two places is a bit ... odd.
I'd rather stop the I/O queue in nvme_tcp_io_work() once a
EKEYEXPIRED error has been hit, and start the key update via
nvme_tcp_start_tls() function directly from there.
No need to change the controller state.
Cheers,
Hannes
--
Dr. Hannes Reinecke Kernel Storage Architect
hare@suse.de +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
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 7/8] net/handshake: Support decoding the HandshakeType
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
` (5 preceding siblings ...)
2025-08-15 5:02 ` [PATCH 6/8] nvme-tcp: Support KeyUpdate alistair23
@ 2025-08-15 5:02 ` alistair23
2025-08-15 13:40 ` Chuck Lever
2025-08-15 5:02 ` [PATCH 8/8] nvmet-tcp: Support KeyUpdate alistair23
7 siblings, 1 reply; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
Support decoding the HandshakeType as part of the TLS handshake
protocol.
Link: https://datatracker.ietf.org/doc/html/rfc8446#section-4
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
include/net/handshake.h | 1 +
include/net/tls_prot.h | 17 +++++++++++++++++
net/handshake/alert.c | 26 ++++++++++++++++++++++++++
3 files changed, 44 insertions(+)
diff --git a/include/net/handshake.h b/include/net/handshake.h
index 8f791c55edc9..d13dc6299c37 100644
--- a/include/net/handshake.h
+++ b/include/net/handshake.h
@@ -54,6 +54,7 @@ void handshake_sk_destruct_req(struct sock *sk);
bool handshake_req_cancel(struct sock *sk);
u8 tls_get_record_type(const struct sock *sk, const struct cmsghdr *msg);
+u8 tls_get_handshake_type(const struct sock *sk, const struct cmsghdr *cmsg);
void tls_alert_recv(const struct sock *sk, const struct msghdr *msg,
u8 *level, u8 *description);
diff --git a/include/net/tls_prot.h b/include/net/tls_prot.h
index 68a40756440b..5125e7c22cb3 100644
--- a/include/net/tls_prot.h
+++ b/include/net/tls_prot.h
@@ -23,6 +23,23 @@ enum {
TLS_RECORD_TYPE_ACK = 26,
};
+/*
+ * TLS Record protocol: HandshakeType
+ */
+enum {
+ TLS_HANDSHAKE_TYPE_CLIENT_HELLO = 1,
+ TLS_HANDSHAKE_TYPE_SERVER_HELLO = 2,
+ TLS_HANDSHAKE_TYPE_NEW_SESSION_TICKET = 4,
+ TLS_HANDSHAKE_TYPE_END_OF_EARLY_DATA = 5,
+ TLS_HANDSHAKE_TYPE_ENCRYPTED_EXTENSIONS = 8,
+ TLS_HANDSHAKE_TYPE_CERTIFICATE = 11,
+ TLS_HANDSHAKE_TYPE_CERTIFICATE_REQUEST = 13,
+ TLS_HANDSHAKE_TYPE_CERTIFICATE_VERIFY = 15,
+ TLS_HANDSHAKE_TYPE_FINISHED = 20,
+ TLS_HANDSHAKE_TYPE_KEY_UPDATE = 24,
+ TLS_HANDSHAKE_TYPE_MESSAGE_HASH = 254,
+};
+
/*
* TLS Alert protocol: AlertLevel
*/
diff --git a/net/handshake/alert.c b/net/handshake/alert.c
index 329d91984683..7e16ef5ed913 100644
--- a/net/handshake/alert.c
+++ b/net/handshake/alert.c
@@ -86,6 +86,32 @@ u8 tls_get_record_type(const struct sock *sk, const struct cmsghdr *cmsg)
}
EXPORT_SYMBOL(tls_get_record_type);
+/**
+ * tls_get_handshake_type - Look for TLS HANDSHAKE_TYPE information
+ * @sk: socket (for IP address information)
+ * @cmsg: incoming message to be parsed
+ *
+ * Returns zero or a TLS_HANDSHAKE_TYPE value.
+ */
+u8 tls_get_handshake_type(const struct sock *sk, const struct cmsghdr *cmsg)
+{
+ u8 record_type, msg_type;
+
+ if (cmsg->cmsg_level != SOL_TLS)
+ return 0;
+ if (cmsg->cmsg_type != TLS_GET_RECORD_TYPE)
+ return 0;
+
+ record_type = *((u8 *)CMSG_DATA(cmsg));
+
+ if (record_type != TLS_RECORD_TYPE_HANDSHAKE)
+ return 0;
+
+ msg_type = *((u8 *)CMSG_DATA(cmsg) + 4);
+ return msg_type;
+}
+EXPORT_SYMBOL(tls_get_handshake_type);
+
/**
* tls_alert_recv - Parse TLS Alert messages
* @sk: socket (for IP address information)
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread* Re: [PATCH 7/8] net/handshake: Support decoding the HandshakeType
2025-08-15 5:02 ` [PATCH 7/8] net/handshake: Support decoding the HandshakeType alistair23
@ 2025-08-15 13:40 ` Chuck Lever
0 siblings, 0 replies; 15+ messages in thread
From: Chuck Lever @ 2025-08-15 13:40 UTC (permalink / raw)
To: alistair23, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, Alistair Francis
On 8/15/25 1:02 AM, alistair23@gmail.com wrote:
> From: Alistair Francis <alistair.francis@wdc.com>
>
> Support decoding the HandshakeType as part of the TLS handshake
> protocol.
>
> Link: https://datatracker.ietf.org/doc/html/rfc8446#section-4
> Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
> ---
> include/net/handshake.h | 1 +
> include/net/tls_prot.h | 17 +++++++++++++++++
> net/handshake/alert.c | 26 ++++++++++++++++++++++++++
> 3 files changed, 44 insertions(+)
>
> diff --git a/include/net/handshake.h b/include/net/handshake.h
> index 8f791c55edc9..d13dc6299c37 100644
> --- a/include/net/handshake.h
> +++ b/include/net/handshake.h
> @@ -54,6 +54,7 @@ void handshake_sk_destruct_req(struct sock *sk);
> bool handshake_req_cancel(struct sock *sk);
>
> u8 tls_get_record_type(const struct sock *sk, const struct cmsghdr *msg);
> +u8 tls_get_handshake_type(const struct sock *sk, const struct cmsghdr *cmsg);
> void tls_alert_recv(const struct sock *sk, const struct msghdr *msg,
> u8 *level, u8 *description);
>
> diff --git a/include/net/tls_prot.h b/include/net/tls_prot.h
> index 68a40756440b..5125e7c22cb3 100644
> --- a/include/net/tls_prot.h
> +++ b/include/net/tls_prot.h
> @@ -23,6 +23,23 @@ enum {
> TLS_RECORD_TYPE_ACK = 26,
> };
>
> +/*
> + * TLS Record protocol: HandshakeType
RFC 8664 Section 4 describes the handshake sub-protocol. AFAIU the
handshake type is part of that protocol, not part of the record
sub-protocol ...
Also, it appears these numbers are managed by and made extensible by an
IANA registry:
https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-7
Let's cite that URL here, and can you include the additional numbers
found in that registry? Or, if we're adding only the type numbers
needed for KeyUpdate here, let's mention the registry anyway and note
that there are other numbers in use.
> + */
> +enum {
> + TLS_HANDSHAKE_TYPE_CLIENT_HELLO = 1,
> + TLS_HANDSHAKE_TYPE_SERVER_HELLO = 2,
> + TLS_HANDSHAKE_TYPE_NEW_SESSION_TICKET = 4,
> + TLS_HANDSHAKE_TYPE_END_OF_EARLY_DATA = 5,
> + TLS_HANDSHAKE_TYPE_ENCRYPTED_EXTENSIONS = 8,
> + TLS_HANDSHAKE_TYPE_CERTIFICATE = 11,
> + TLS_HANDSHAKE_TYPE_CERTIFICATE_REQUEST = 13,
> + TLS_HANDSHAKE_TYPE_CERTIFICATE_VERIFY = 15,
> + TLS_HANDSHAKE_TYPE_FINISHED = 20,
> + TLS_HANDSHAKE_TYPE_KEY_UPDATE = 24,
> + TLS_HANDSHAKE_TYPE_MESSAGE_HASH = 254,
> +};
> +
> /*
> * TLS Alert protocol: AlertLevel
> */
> diff --git a/net/handshake/alert.c b/net/handshake/alert.c
> index 329d91984683..7e16ef5ed913 100644
> --- a/net/handshake/alert.c
> +++ b/net/handshake/alert.c
> @@ -86,6 +86,32 @@ u8 tls_get_record_type(const struct sock *sk, const struct cmsghdr *cmsg)
> }
> EXPORT_SYMBOL(tls_get_record_type);
>
> +/**
> + * tls_get_handshake_type - Look for TLS HANDSHAKE_TYPE information
> + * @sk: socket (for IP address information)
> + * @cmsg: incoming message to be parsed
> + *
> + * Returns zero or a TLS_HANDSHAKE_TYPE value.
> + */
> +u8 tls_get_handshake_type(const struct sock *sk, const struct cmsghdr *cmsg)
> +{
> + u8 record_type, msg_type;
> +
> + if (cmsg->cmsg_level != SOL_TLS)
> + return 0;
> + if (cmsg->cmsg_type != TLS_GET_RECORD_TYPE)
> + return 0;
> +
> + record_type = *((u8 *)CMSG_DATA(cmsg));
> +
> + if (record_type != TLS_RECORD_TYPE_HANDSHAKE)
> + return 0;
> +
> + msg_type = *((u8 *)CMSG_DATA(cmsg) + 4);
> + return msg_type;
> +}
> +EXPORT_SYMBOL(tls_get_handshake_type);
> +
> /**
> * tls_alert_recv - Parse TLS Alert messages
> * @sk: socket (for IP address information)
--
Chuck Lever
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 8/8] nvmet-tcp: Support KeyUpdate
2025-08-15 5:02 [PATCH 0/8] nvme-tcp: Support receiving KeyUpdate requests alistair23
` (6 preceding siblings ...)
2025-08-15 5:02 ` [PATCH 7/8] net/handshake: Support decoding the HandshakeType alistair23
@ 2025-08-15 5:02 ` alistair23
7 siblings, 0 replies; 15+ messages in thread
From: alistair23 @ 2025-08-15 5:02 UTC (permalink / raw)
To: chuck.lever, hare, kernel-tls-handshake, netdev, linux-kernel,
linux-doc, linux-nvme, linux-nfs
Cc: kbusch, axboe, hch, sagi, kch, alistair23, Alistair Francis
From: Alistair Francis <alistair.francis@wdc.com>
If the nvmet_tcp_try_recv() function return EKEYEXPIRED or if we receive
a KeyUpdate handshake type then the underlying TLS keys need to be
updated.
If the NVMe Host (TLS client) initiates a KeyUpdate this patch will
allow the NVMe layer to process the KeyUpdate request and forward the
request to userspace. Userspace must then update the key to keep the
connection alive.
This patch allows us to handle the NVMe host sending a KeyUpdate
request without aborting the connection. At this time we don't support
initiating a KeyUpdate.
Link: https://datatracker.ietf.org/doc/html/rfc8446#section-4.6.3
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
---
drivers/nvme/target/tcp.c | 59 +++++++++++++++++++++++++++++++++++++--
1 file changed, 56 insertions(+), 3 deletions(-)
diff --git a/drivers/nvme/target/tcp.c b/drivers/nvme/target/tcp.c
index 5eaab9c858be..1dc6fa28d08c 100644
--- a/drivers/nvme/target/tcp.c
+++ b/drivers/nvme/target/tcp.c
@@ -175,6 +175,7 @@ struct nvmet_tcp_queue {
/* TLS state */
key_serial_t tls_pskid;
+ key_serial_t user_key_serial;
struct delayed_work tls_handshake_tmo_work;
unsigned long poll_end;
@@ -836,6 +837,11 @@ static int nvmet_tcp_try_send_one(struct nvmet_tcp_queue *queue,
return 1;
}
+#ifdef CONFIG_NVME_TARGET_TCP_TLS
+static int nvmet_tcp_try_peek_pdu(struct nvmet_tcp_queue *queue);
+static void nvmet_tcp_tls_handshake_timeout(struct work_struct *w);
+#endif
+
static int nvmet_tcp_try_send(struct nvmet_tcp_queue *queue,
int budget, int *sends)
{
@@ -1114,7 +1120,7 @@ static int nvmet_tcp_tls_record_ok(struct nvmet_tcp_queue *queue,
struct msghdr *msg, char *cbuf)
{
struct cmsghdr *cmsg = (struct cmsghdr *)cbuf;
- u8 ctype, level, description;
+ u8 ctype, htype, level, description;
int ret = 0;
ctype = tls_get_record_type(queue->sock->sk, cmsg);
@@ -1135,6 +1141,29 @@ static int nvmet_tcp_tls_record_ok(struct nvmet_tcp_queue *queue,
ret = -EAGAIN;
}
break;
+ case TLS_RECORD_TYPE_HANDSHAKE:
+ htype = tls_get_handshake_type(queue->sock->sk, cmsg);
+
+#ifdef CONFIG_NVME_TARGET_TCP_TLS
+ if (htype == TLS_HANDSHAKE_TYPE_KEY_UPDATE) {
+ tls_clear_err(queue->sock->sk);
+ handshake_req_cancel(queue->sock->sk);
+ handshake_sk_destruct_req(queue->sock->sk);
+ queue->state = NVMET_TCP_Q_TLS_HANDSHAKE;
+
+ /* Restore the default callbacks before starting upcall */
+ read_lock_bh(&queue->sock->sk->sk_callback_lock);
+ queue->sock->sk->sk_user_data = NULL;
+ queue->sock->sk->sk_data_ready = queue->data_ready;
+ read_unlock_bh(&queue->sock->sk->sk_callback_lock);
+
+ return nvmet_tcp_tls_handshake(queue, HANDSHAKE_KEY_UPDATE_TYPE_RECEIVED);
+ }
+#endif
+ pr_err("queue %d: TLS handshake %d unhandled\n",
+ queue->idx, htype);
+ ret = -EAGAIN;
+ break;
default:
/* discard this record type */
pr_err("queue %d: TLS record %d unhandled\n",
@@ -1344,7 +1373,29 @@ static int nvmet_tcp_try_recv(struct nvmet_tcp_queue *queue,
for (i = 0; i < budget; i++) {
ret = nvmet_tcp_try_recv_one(queue);
if (unlikely(ret < 0)) {
- nvmet_tcp_socket_error(queue, ret);
+ if (ret == -EKEYEXPIRED &&
+ queue->state != NVMET_TCP_Q_DISCONNECTING &&
+ queue->state != NVMET_TCP_Q_TLS_HANDSHAKE) {
+#ifdef CONFIG_NVME_TARGET_TCP_TLS
+ tls_clear_err(queue->sock->sk);
+ handshake_req_cancel(queue->sock->sk);
+ handshake_sk_destruct_req(queue->sock->sk);
+ queue->state = NVMET_TCP_Q_TLS_HANDSHAKE;
+
+ /* Restore the default callbacks before starting upcall */
+ read_lock_bh(&queue->sock->sk->sk_callback_lock);
+ queue->sock->sk->sk_user_data = NULL;
+ queue->sock->sk->sk_data_ready = queue->data_ready;
+ read_unlock_bh(&queue->sock->sk->sk_callback_lock);
+
+ ret = nvmet_tcp_tls_handshake(queue,
+ HANDSHAKE_KEY_UPDATE_TYPE_RECEIVED);
+#else
+ nvmet_tcp_socket_error(queue, ret);
+#endif
+ } else {
+ nvmet_tcp_socket_error(queue, ret);
+ }
goto done;
} else if (ret == 0) {
break;
@@ -1798,6 +1849,7 @@ static void nvmet_tcp_tls_handshake_done(void *data, int status,
}
if (!status) {
queue->tls_pskid = peerid;
+ queue->user_key_serial = user_key_serial;
queue->state = NVMET_TCP_Q_CONNECTING;
} else
queue->state = NVMET_TCP_Q_FAILED;
@@ -1843,7 +1895,7 @@ static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue,
int ret = -EOPNOTSUPP;
struct tls_handshake_args args;
- if (queue->state != NVMET_TCP_Q_TLS_HANDSHAKE) {
+ if (queue->state != NVMET_TCP_Q_TLS_HANDSHAKE && !keyupdate) {
pr_warn("cannot start TLS in state %d\n", queue->state);
return -EINVAL;
}
@@ -1856,6 +1908,7 @@ static int nvmet_tcp_tls_handshake(struct nvmet_tcp_queue *queue,
args.ta_data = queue;
args.ta_keyring = key_serial(queue->port->nport->keyring);
args.ta_timeout_ms = tls_handshake_timeout * 1000;
+ args.user_key_serial = queue->user_key_serial;
ret = tls_server_hello_psk(&args, GFP_KERNEL, keyupdate);
if (ret) {
--
2.50.1
^ permalink raw reply related [flat|nested] 15+ messages in thread