[linux-block.git] / include / net / tls.h

/*
 * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
 * Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef _TLS_OFFLOAD_H
#define _TLS_OFFLOAD_H

#include <linux/types.h>
#include <asm/byteorder.h>
#include <linux/crypto.h>
#include <linux/socket.h>
#include <linux/tcp.h>
#include <linux/mutex.h>
#include <linux/netdevice.h>
#include <linux/rcupdate.h>

#include <net/net_namespace.h>
#include <net/tcp.h>
#include <net/strparser.h>
#include <crypto/aead.h>
#include <uapi/linux/tls.h>

struct tls_rec;

/* Maximum data size carried in a TLS record */
#define TLS_MAX_PAYLOAD_SIZE		((size_t)1 << 14)

#define TLS_HEADER_SIZE			5
#define TLS_NONCE_OFFSET		TLS_HEADER_SIZE

#define TLS_CRYPTO_INFO_READY(info)	((info)->cipher_type)

#define TLS_AAD_SPACE_SIZE		13

#define TLS_MAX_IV_SIZE			16
#define TLS_MAX_SALT_SIZE		4
#define TLS_TAG_SIZE			16
#define TLS_MAX_REC_SEQ_SIZE		8
#define TLS_MAX_AAD_SIZE		TLS_AAD_SPACE_SIZE

/* For CCM mode, the full 16-bytes of IV is made of '4' fields of given sizes.
 *
 * IV[16] = b0[1] || implicit nonce[4] || explicit nonce[8] || length[3]
 *
 * The field 'length' is encoded in field 'b0' as '(length width - 1)'.
 * Hence b0 contains (3 - 1) = 2.
 */
#define TLS_AES_CCM_IV_B0_BYTE		2
#define TLS_SM4_CCM_IV_B0_BYTE		2

enum {
	TLS_BASE,
	TLS_SW,
	TLS_HW,
	TLS_HW_RECORD,
	TLS_NUM_CONFIG,
};

struct tx_work {
	struct delayed_work work;
	struct sock *sk;
};

struct tls_sw_context_tx {
	struct crypto_aead *aead_send;
	struct crypto_wait async_wait;
	struct tx_work tx_work;
	struct tls_rec *open_rec;
	struct list_head tx_list;
	atomic_t encrypt_pending;
	u8 async_capable:1;

#define BIT_TX_SCHEDULED	0
#define BIT_TX_CLOSING		1
	unsigned long tx_bitmask;
};

struct tls_strparser {
	struct sock *sk;

	u32 mark : 8;
	u32 stopped : 1;
	u32 copy_mode : 1;
	u32 mixed_decrypted : 1;
	u32 msg_ready : 1;

	struct strp_msg stm;

	struct sk_buff *anchor;
	struct work_struct work;
};

struct tls_sw_context_rx {
	struct crypto_aead *aead_recv;
	struct crypto_wait async_wait;
	struct sk_buff_head rx_list;	/* list of decrypted 'data' records */
	void (*saved_data_ready)(struct sock *sk);

	u8 reader_present;
	u8 async_capable:1;
	u8 zc_capable:1;
	u8 reader_contended:1;

	struct tls_strparser strp;

	atomic_t decrypt_pending;
	struct sk_buff_head async_hold;
	struct wait_queue_head wq;
};

struct tls_record_info {
	struct list_head list;
	u32 end_seq;
	int len;
	int num_frags;
	skb_frag_t frags[MAX_SKB_FRAGS];
};

#define TLS_DRIVER_STATE_SIZE_TX	16
struct tls_offload_context_tx {
	struct crypto_aead *aead_send;
	spinlock_t lock;	/* protects records list */
	struct list_head records_list;
	struct tls_record_info *open_record;
	struct tls_record_info *retransmit_hint;
	u64 hint_record_sn;
	u64 unacked_record_sn;

	struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
	void (*sk_destruct)(struct sock *sk);
	struct work_struct destruct_work;
	struct tls_context *ctx;
	/* The TLS layer reserves room for driver specific state
	 * Currently the belief is that there is not enough
	 * driver specific state to justify another layer of indirection
	 */
	u8 driver_state[TLS_DRIVER_STATE_SIZE_TX] __aligned(8);
};

enum tls_context_flags {
	/* tls_device_down was called after the netdev went down, device state
	 * was released, and kTLS works in software, even though rx_conf is
	 * still TLS_HW (needed for transition).
	 */
	TLS_RX_DEV_DEGRADED = 0,
	/* Unlike RX where resync is driven entirely by the core in TX only
	 * the driver knows when things went out of sync, so we need the flag
	 * to be atomic.
	 */
	TLS_TX_SYNC_SCHED = 1,
	/* tls_dev_del was called for the RX side, device state was released,
	 * but tls_ctx->netdev might still be kept, because TX-side driver
	 * resources might not be released yet. Used to prevent the second
	 * tls_dev_del call in tls_device_down if it happens simultaneously.
	 */
	TLS_RX_DEV_CLOSED = 2,
};

struct cipher_context {
	char iv[TLS_MAX_IV_SIZE + TLS_MAX_SALT_SIZE];
	char rec_seq[TLS_MAX_REC_SEQ_SIZE];
};

union tls_crypto_context {
	struct tls_crypto_info info;
	union {
		struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
		struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
		struct tls12_crypto_info_chacha20_poly1305 chacha20_poly1305;
		struct tls12_crypto_info_sm4_gcm sm4_gcm;
		struct tls12_crypto_info_sm4_ccm sm4_ccm;
	};
};

struct tls_prot_info {
	u16 version;
	u16 cipher_type;
	u16 prepend_size;
	u16 tag_size;
	u16 overhead_size;
	u16 iv_size;
	u16 salt_size;
	u16 rec_seq_size;
	u16 aad_size;
	u16 tail_size;
};

struct tls_context {
	/* read-only cache line */
	struct tls_prot_info prot_info;

	u8 tx_conf:3;
	u8 rx_conf:3;
	u8 zerocopy_sendfile:1;
	u8 rx_no_pad:1;

	int (*push_pending_record)(struct sock *sk, int flags);
	void (*sk_write_space)(struct sock *sk);

	void *priv_ctx_tx;
	void *priv_ctx_rx;

	struct net_device __rcu *netdev;

	/* rw cache line */
	struct cipher_context tx;
	struct cipher_context rx;

	struct scatterlist *partially_sent_record;
	u16 partially_sent_offset;

	bool splicing_pages;
	bool pending_open_record_frags;

	struct mutex tx_lock; /* protects partially_sent_* fields and
			       * per-type TX fields
			       */
	unsigned long flags;

	/* cache cold stuff */
	struct proto *sk_proto;
	struct sock *sk;

	void (*sk_destruct)(struct sock *sk);

	union tls_crypto_context crypto_send;
	union tls_crypto_context crypto_recv;

	struct list_head list;
	refcount_t refcount;
	struct rcu_head rcu;
};

enum tls_offload_ctx_dir {
	TLS_OFFLOAD_CTX_DIR_RX,
	TLS_OFFLOAD_CTX_DIR_TX,
};

struct tlsdev_ops {
	int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
			   enum tls_offload_ctx_dir direction,
			   struct tls_crypto_info *crypto_info,
			   u32 start_offload_tcp_sn);
	void (*tls_dev_del)(struct net_device *netdev,
			    struct tls_context *ctx,
			    enum tls_offload_ctx_dir direction);
	int (*tls_dev_resync)(struct net_device *netdev,
			      struct sock *sk, u32 seq, u8 *rcd_sn,
			      enum tls_offload_ctx_dir direction);
};

enum tls_offload_sync_type {
	TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
	TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
	TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC = 2,
};

#define TLS_DEVICE_RESYNC_NH_START_IVAL		2
#define TLS_DEVICE_RESYNC_NH_MAX_IVAL		128

#define TLS_DEVICE_RESYNC_ASYNC_LOGMAX		13
struct tls_offload_resync_async {
	atomic64_t req;
	u16 loglen;
	u16 rcd_delta;
	u32 log[TLS_DEVICE_RESYNC_ASYNC_LOGMAX];
};

#define TLS_DRIVER_STATE_SIZE_RX	8
struct tls_offload_context_rx {
	/* sw must be the first member of tls_offload_context_rx */
	struct tls_sw_context_rx sw;
	enum tls_offload_sync_type resync_type;
	/* this member is set regardless of resync_type, to avoid branches */
	u8 resync_nh_reset:1;
	/* CORE_NEXT_HINT-only member, but use the hole here */
	u8 resync_nh_do_now:1;
	union {
		/* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
		struct {
			atomic64_t resync_req;
		};
		/* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
		struct {
			u32 decrypted_failed;
			u32 decrypted_tgt;
		} resync_nh;
		/* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC */
		struct {
			struct tls_offload_resync_async *resync_async;
		};
	};
	/* The TLS layer reserves room for driver specific state
	 * Currently the belief is that there is not enough
	 * driver specific state to justify another layer of indirection
	 */
	u8 driver_state[TLS_DRIVER_STATE_SIZE_RX] __aligned(8);
};

struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
				       u32 seq, u64 *p_record_sn);

static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
{
	return rec->len == 0;
}

static inline u32 tls_record_start_seq(struct tls_record_info *rec)
{
	return rec->end_seq - rec->len;
}

struct sk_buff *
tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
		      struct sk_buff *skb);
struct sk_buff *
tls_validate_xmit_skb_sw(struct sock *sk, struct net_device *dev,
			 struct sk_buff *skb);

static inline bool tls_is_skb_tx_device_offloaded(const struct sk_buff *skb)
{
#ifdef CONFIG_TLS_DEVICE
	struct sock *sk = skb->sk;

	return sk && sk_fullsock(sk) &&
	       (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
	       &tls_validate_xmit_skb);
#else
	return false;
#endif
}

static inline struct tls_context *tls_get_ctx(const struct sock *sk)
{
	struct inet_connection_sock *icsk = inet_csk(sk);

	/* Use RCU on icsk_ulp_data only for sock diag code,
	 * TLS data path doesn't need rcu_dereference().
	 */
	return (__force void *)icsk->icsk_ulp_data;
}

static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
		const struct tls_context *tls_ctx)
{
	return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
}

static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
		const struct tls_context *tls_ctx)
{
	return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
}

static inline struct tls_offload_context_tx *
tls_offload_ctx_tx(const struct tls_context *tls_ctx)
{
	return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
}

static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
{
	struct tls_context *ctx = tls_get_ctx(sk);

	if (!ctx)
		return false;
	return !!tls_sw_ctx_tx(ctx);
}

static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
{
	struct tls_context *ctx = tls_get_ctx(sk);

	if (!ctx)
		return false;
	return !!tls_sw_ctx_rx(ctx);
}

static inline struct tls_offload_context_rx *
tls_offload_ctx_rx(const struct tls_context *tls_ctx)
{
	return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
}

static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
				     enum tls_offload_ctx_dir direction)
{
	if (direction == TLS_OFFLOAD_CTX_DIR_TX)
		return tls_offload_ctx_tx(tls_ctx)->driver_state;
	else
		return tls_offload_ctx_rx(tls_ctx)->driver_state;
}

static inline void *
tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
{
	return __tls_driver_ctx(tls_get_ctx(sk), direction);
}

#define RESYNC_REQ BIT(0)
#define RESYNC_REQ_ASYNC BIT(1)
/* The TLS context is valid until sk_destruct is called */
static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
{
	struct tls_context *tls_ctx = tls_get_ctx(sk);
	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);

	atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | RESYNC_REQ);
}

/* Log all TLS record header TCP sequences in [seq, seq+len] */
static inline void
tls_offload_rx_resync_async_request_start(struct sock *sk, __be32 seq, u16 len)
{
	struct tls_context *tls_ctx = tls_get_ctx(sk);
	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);

	atomic64_set(&rx_ctx->resync_async->req, ((u64)ntohl(seq) << 32) |
		     ((u64)len << 16) | RESYNC_REQ | RESYNC_REQ_ASYNC);
	rx_ctx->resync_async->loglen = 0;
	rx_ctx->resync_async->rcd_delta = 0;
}

static inline void
tls_offload_rx_resync_async_request_end(struct sock *sk, __be32 seq)
{
	struct tls_context *tls_ctx = tls_get_ctx(sk);
	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);

	atomic64_set(&rx_ctx->resync_async->req,
		     ((u64)ntohl(seq) << 32) | RESYNC_REQ);
}

static inline void
tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
{
	struct tls_context *tls_ctx = tls_get_ctx(sk);

	tls_offload_ctx_rx(tls_ctx)->resync_type = type;
}

/* Driver's seq tracking has to be disabled until resync succeeded */
static inline bool tls_offload_tx_resync_pending(struct sock *sk)
{
	struct tls_context *tls_ctx = tls_get_ctx(sk);
	bool ret;

	ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
	smp_mb__after_atomic();
	return ret;
}

struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);

#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);

static inline bool tls_is_sk_rx_device_offloaded(struct sock *sk)
{
	if (!sk_fullsock(sk) ||
	    smp_load_acquire(&sk->sk_destruct) != tls_device_sk_destruct)
		return false;
	return tls_get_ctx(sk)->rx_conf == TLS_HW;
}
#endif
#endif /* _TLS_OFFLOAD_H */
Commit	Line	Data
3c4d7559 DW	1	/*
	2	* Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
	3	* Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. All rights reserved.
	4	*
	5	* This software is available to you under a choice of one of two
	6	* licenses. You may choose to be licensed under the terms of the GNU
	7	* General Public License (GPL) Version 2, available from the file
	8	* COPYING in the main directory of this source tree, or the
	9	* OpenIB.org BSD license below:
	10	*
	11	* Redistribution and use in source and binary forms, with or
	12	* without modification, are permitted provided that the following
	13	* conditions are met:
	14	*
	15	* - Redistributions of source code must retain the above
	16	* copyright notice, this list of conditions and the following
	17	* disclaimer.
	18	*
	19	* - Redistributions in binary form must reproduce the above
	20	* copyright notice, this list of conditions and the following
	21	* disclaimer in the documentation and/or other materials
	22	* provided with the distribution.
	23	*
	24	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	25	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	26	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	27	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	28	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	29	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	30	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	31	* SOFTWARE.
	32	*/
	33
	34	#ifndef _TLS_OFFLOAD_H
	35	#define _TLS_OFFLOAD_H
	36
	37	#include <linux/types.h>
b9f3eb49	38	#include <asm/byteorder.h>
a54667f6	39	#include <linux/crypto.h>
b9f3eb49 DL	40	#include <linux/socket.h>
b9f3eb49 DL	41	#include <linux/tcp.h>
79ffe608	42	#include <linux/mutex.h>
2e361176	43	#include <linux/netdevice.h>
15a7dea7	44	#include <linux/rcupdate.h>
d829e9c4	45
d26b698d	46	#include <net/net_namespace.h>
b9f3eb49	47	#include <net/tcp.h>
c46234eb	48	#include <net/strparser.h>
a42055e8	49	#include <crypto/aead.h>
3c4d7559 DW	50	#include <uapi/linux/tls.h>
3c4d7559 DW	51
58790314	52	struct tls_rec;
3c4d7559 DW	53
	54	/* Maximum data size carried in a TLS record */
	55	#define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
	56
	57	#define TLS_HEADER_SIZE 5
	58	#define TLS_NONCE_OFFSET TLS_HEADER_SIZE
	59
	60	#define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
	61
3c4d7559	62	#define TLS_AAD_SPACE_SIZE 13
dd0bed16	63
bee6b7b3	64	#define TLS_MAX_IV_SIZE 16
1c1cb311	65	#define TLS_MAX_SALT_SIZE 4
a8340cc0	66	#define TLS_TAG_SIZE 16
89fec474	67	#define TLS_MAX_REC_SEQ_SIZE 8
50a07aa5	68	#define TLS_MAX_AAD_SIZE TLS_AAD_SPACE_SIZE
f295b3ae	69
128cfb88	70	/* For CCM mode, the full 16-bytes of IV is made of '4' fields of given sizes.
f295b3ae VG	71	*
	72	* IV[16] = b0[1] \|\| implicit nonce[4] \|\| explicit nonce[8] \|\| length[3]
	73	*
	74	* The field 'length' is encoded in field 'b0' as '(length width - 1)'.
	75	* Hence b0 contains (3 - 1) = 2.
	76	*/
	77	#define TLS_AES_CCM_IV_B0_BYTE 2
128cfb88	78	#define TLS_SM4_CCM_IV_B0_BYTE 2
f295b3ae	79
4799ac81 BP	80	enum {
	81	TLS_BASE,
	82	TLS_SW,
4799ac81	83	TLS_HW,
4799ac81 BP	84	TLS_HW_RECORD,
	85	TLS_NUM_CONFIG,
	86	};
	87
a42055e8 VG	88	struct tx_work {
	89	struct delayed_work work;
	90	struct sock *sk;
	91	};
	92
	93	struct tls_sw_context_tx {
	94	struct crypto_aead *aead_send;
	95	struct crypto_wait async_wait;
	96	struct tx_work tx_work;
	97	struct tls_rec *open_rec;
9932a29a	98	struct list_head tx_list;
a42055e8	99	atomic_t encrypt_pending;
5c5458ec	100	u8 async_capable:1;
a42055e8 VG	101
a42055e8 VG	102	#define BIT_TX_SCHEDULED 0
f87e62d4	103	#define BIT_TX_CLOSING 1
a42055e8	104	unsigned long tx_bitmask;
3c4d7559 DW	105	};
3c4d7559 DW	106
84c61fe1 JK	107	struct tls_strparser {
	108	struct sock *sk;
	109
	110	u32 mark : 8;
	111	u32 stopped : 1;
	112	u32 copy_mode : 1;
eca9bfaf	113	u32 mixed_decrypted : 1;
84c61fe1 JK	114	u32 msg_ready : 1;
	115
	116	struct strp_msg stm;
	117
	118	struct sk_buff *anchor;
	119	struct work_struct work;
	120	};
	121
f66de3ee BP	122	struct tls_sw_context_rx {
	123	struct crypto_aead *aead_recv;
	124	struct crypto_wait async_wait;
692d7b5d	125	struct sk_buff_head rx_list; /* list of decrypted 'data' records */
f66de3ee	126	void (saved_data_ready)(struct sock sk);
924ad65e	127
4cbc325e	128	u8 reader_present;
5c5458ec	129	u8 async_capable:1;
88527790	130	u8 zc_capable:1;
4cbc325e	131	u8 reader_contended:1;
84c61fe1 JK	132
	133	struct tls_strparser strp;
	134
94524d8f	135	atomic_t decrypt_pending;
c618db2a	136	struct sk_buff_head async_hold;
4cbc325e	137	struct wait_queue_head wq;
94524d8f VG	138	};
94524d8f VG	139
e8f69799 IL	140	struct tls_record_info {
	141	struct list_head list;
	142	u32 end_seq;
	143	int len;
	144	int num_frags;
	145	skb_frag_t frags[MAX_SKB_FRAGS];
	146	};
	147
9f0c8245	148	#define TLS_DRIVER_STATE_SIZE_TX 16
d80a1b9d	149	struct tls_offload_context_tx {
e8f69799 IL	150	struct crypto_aead *aead_send;
	151	spinlock_t lock; /* protects records list */
	152	struct list_head records_list;
	153	struct tls_record_info *open_record;
	154	struct tls_record_info *retransmit_hint;
	155	u64 hint_record_sn;
	156	u64 unacked_record_sn;
	157
	158	struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
	159	void (sk_destruct)(struct sock sk);
7adc91e0 TT	160	struct work_struct destruct_work;
7adc91e0 TT	161	struct tls_context *ctx;
e8f69799 IL	162	/* The TLS layer reserves room for driver specific state
	163	* Currently the belief is that there is not enough
	164	* driver specific state to justify another layer of indirection
	165	*/
9f0c8245	166	u8 driver_state[TLS_DRIVER_STATE_SIZE_TX] __aligned(8);
e8f69799 IL	167	};
e8f69799 IL	168
e52972c1	169	enum tls_context_flags {
c55dcdd4 MM	170	/* tls_device_down was called after the netdev went down, device state
	171	* was released, and kTLS works in software, even though rx_conf is
	172	* still TLS_HW (needed for transition).
	173	*/
	174	TLS_RX_DEV_DEGRADED = 0,
50180074 JK	175	/* Unlike RX where resync is driven entirely by the core in TX only
	176	* the driver knows when things went out of sync, so we need the flag
	177	* to be atomic.
	178	*/
	179	TLS_TX_SYNC_SCHED = 1,
025cc2fb MM	180	/* tls_dev_del was called for the RX side, device state was released,
	181	* but tls_ctx->netdev might still be kept, because TX-side driver
	182	* resources might not be released yet. Used to prevent the second
	183	* tls_dev_del call in tls_device_down if it happens simultaneously.
	184	*/
	185	TLS_RX_DEV_CLOSED = 2,
e52972c1 JK	186	};
e52972c1 JK	187
dbe42559	188	struct cipher_context {
1c1cb311	189	char iv[TLS_MAX_IV_SIZE + TLS_MAX_SALT_SIZE];
6d5029e5	190	char rec_seq[TLS_MAX_REC_SEQ_SIZE];
dbe42559 DW	191	};
dbe42559 DW	192
86029d10 SD	193	union tls_crypto_context {
86029d10 SD	194	struct tls_crypto_info info;
fb99bce7 DW	195	union {
	196	struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
	197	struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
923c40c4	198	struct tls12_crypto_info_chacha20_poly1305 chacha20_poly1305;
39d8fb96 TZ	199	struct tls12_crypto_info_sm4_gcm sm4_gcm;
39d8fb96 TZ	200	struct tls12_crypto_info_sm4_ccm sm4_ccm;
fb99bce7	201	};
86029d10 SD	202	};
86029d10 SD	203
4509de14 VG	204	struct tls_prot_info {
	205	u16 version;
	206	u16 cipher_type;
	207	u16 prepend_size;
	208	u16 tag_size;
	209	u16 overhead_size;
	210	u16 iv_size;
f295b3ae	211	u16 salt_size;
4509de14 VG	212	u16 rec_seq_size;
	213	u16 aad_size;
	214	u16 tail_size;
	215	};
	216
3c4d7559	217	struct tls_context {
f0aaa2c9	218	/* read-only cache line */
4509de14 VG	219	struct tls_prot_info prot_info;
4509de14 VG	220
f0aaa2c9 JK	221	u8 tx_conf:3;
f0aaa2c9 JK	222	u8 rx_conf:3;
c1318b39	223	u8 zerocopy_sendfile:1;
88527790	224	u8 rx_no_pad:1;
3c4d7559	225
f0aaa2c9 JK	226	int (push_pending_record)(struct sock sk, int flags);
f0aaa2c9 JK	227	void (sk_write_space)(struct sock sk);
f66de3ee BP	228
	229	void *priv_ctx_tx;
	230	void *priv_ctx_rx;
3c4d7559	231
94ce3b64	232	struct net_device __rcu *netdev;
6d88207f	233
f0aaa2c9	234	/* rw cache line */
dbe42559	235	struct cipher_context tx;
c46234eb	236	struct cipher_context rx;
3c4d7559 DW	237
	238	struct scatterlist *partially_sent_record;
	239	u16 partially_sent_offset;
a42055e8	240
e117dcfd	241	bool splicing_pages;
d829e9c4	242	bool pending_open_record_frags;
79ffe608 JK	243
	244	struct mutex tx_lock; /* protects partially_sent_* fields and
	245	* per-type TX fields
	246	*/
f0aaa2c9	247	unsigned long flags;
3c4d7559	248
f0aaa2c9	249	/* cache cold stuff */
32857cf5	250	struct proto *sk_proto;
c55dcdd4	251	struct sock *sk;
32857cf5	252
4799ac81	253	void (sk_destruct)(struct sock sk);
f0aaa2c9 JK	254
	255	union tls_crypto_context crypto_send;
	256	union tls_crypto_context crypto_recv;
	257
	258	struct list_head list;
	259	refcount_t refcount;
15a7dea7	260	struct rcu_head rcu;
3c4d7559 DW	261	};
3c4d7559 DW	262
da68b4ad JK	263	enum tls_offload_ctx_dir {
	264	TLS_OFFLOAD_CTX_DIR_RX,
	265	TLS_OFFLOAD_CTX_DIR_TX,
	266	};
	267
	268	struct tlsdev_ops {
	269	int (tls_dev_add)(struct net_device netdev, struct sock *sk,
	270	enum tls_offload_ctx_dir direction,
	271	struct tls_crypto_info *crypto_info,
	272	u32 start_offload_tcp_sn);
	273	void (tls_dev_del)(struct net_device netdev,
	274	struct tls_context *ctx,
	275	enum tls_offload_ctx_dir direction);
b5d9a834 DM	276	int (tls_dev_resync)(struct net_device netdev,
	277	struct sock sk, u32 seq, u8 rcd_sn,
	278	enum tls_offload_ctx_dir direction);
da68b4ad JK	279	};
da68b4ad JK	280
f953d33b JK	281	enum tls_offload_sync_type {
	282	TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
	283	TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
ed9b7646	284	TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC = 2,
f953d33b JK	285	};
	286
	287	#define TLS_DEVICE_RESYNC_NH_START_IVAL 2
	288	#define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
	289
ed9b7646 BP	290	#define TLS_DEVICE_RESYNC_ASYNC_LOGMAX 13
	291	struct tls_offload_resync_async {
	292	atomic64_t req;
138559b9 TT	293	u16 loglen;
138559b9 TT	294	u16 rcd_delta;
ed9b7646 BP	295	u32 log[TLS_DEVICE_RESYNC_ASYNC_LOGMAX];
	296	};
	297
9f0c8245	298	#define TLS_DRIVER_STATE_SIZE_RX 8
4799ac81 BP	299	struct tls_offload_context_rx {
	300	/* sw must be the first member of tls_offload_context_rx */
	301	struct tls_sw_context_rx sw;
f953d33b JK	302	enum tls_offload_sync_type resync_type;
	303	/* this member is set regardless of resync_type, to avoid branches */
	304	u8 resync_nh_reset:1;
	305	/* CORE_NEXT_HINT-only member, but use the hole here */
	306	u8 resync_nh_do_now:1;
	307	union {
	308	/* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
	309	struct {
	310	atomic64_t resync_req;
	311	};
	312	/* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
	313	struct {
	314	u32 decrypted_failed;
	315	u32 decrypted_tgt;
	316	} resync_nh;
ed9b7646 BP	317	/* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC */
	318	struct {
	319	struct tls_offload_resync_async *resync_async;
	320	};
f953d33b	321	};
4799ac81 BP	322	/* The TLS layer reserves room for driver specific state
	323	* Currently the belief is that there is not enough
	324	* driver specific state to justify another layer of indirection
	325	*/
9f0c8245	326	u8 driver_state[TLS_DRIVER_STATE_SIZE_RX] __aligned(8);
4799ac81 BP	327	};
4799ac81 BP	328
d80a1b9d	329	struct tls_record_info tls_get_record(struct tls_offload_context_tx context,
e8f69799 IL	330	u32 seq, u64 *p_record_sn);
	331
	332	static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
	333	{
	334	return rec->len == 0;
	335	}
	336
	337	static inline u32 tls_record_start_seq(struct tls_record_info *rec)
	338	{
	339	return rec->end_seq - rec->len;
	340	}
3c4d7559	341
4799ac81 BP	342	struct sk_buff *
	343	tls_validate_xmit_skb(struct sock sk, struct net_device dev,
	344	struct sk_buff *skb);
c55dcdd4 MM	345	struct sk_buff *
	346	tls_validate_xmit_skb_sw(struct sock sk, struct net_device dev,
	347	struct sk_buff *skb);
4799ac81	348
ed3c9a2f	349	static inline bool tls_is_skb_tx_device_offloaded(const struct sk_buff *skb)
e8f69799	350	{
ed3c9a2f JK	351	#ifdef CONFIG_TLS_DEVICE
	352	struct sock *sk = skb->sk;
	353
	354	return sk && sk_fullsock(sk) &&
4799ac81 BP	355	(smp_load_acquire(&sk->sk_validate_xmit_skb) ==
	356	&tls_validate_xmit_skb);
	357	#else
	358	return false;
	359	#endif
e8f69799 IL	360	}
e8f69799 IL	361
4509de14 VG	362	static inline struct tls_context tls_get_ctx(const struct sock sk)
	363	{
	364	struct inet_connection_sock *icsk = inet_csk(sk);
	365
15a7dea7 JK	366	/* Use RCU on icsk_ulp_data only for sock diag code,
	367	* TLS data path doesn't need rcu_dereference().
	368	*/
	369	return (__force void *)icsk->icsk_ulp_data;
4509de14 VG	370	}
4509de14 VG	371
f66de3ee BP	372	static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
	373	const struct tls_context *tls_ctx)
	374	{
	375	return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
	376	}
	377
	378	static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
3c4d7559 DW	379	const struct tls_context *tls_ctx)
3c4d7559 DW	380	{
f66de3ee	381	return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
3c4d7559 DW	382	}
3c4d7559 DW	383
d80a1b9d BP	384	static inline struct tls_offload_context_tx *
d80a1b9d BP	385	tls_offload_ctx_tx(const struct tls_context *tls_ctx)
3c4d7559	386	{
d80a1b9d	387	return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
3c4d7559 DW	388	}
3c4d7559 DW	389
0608c69c JF	390	static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
	391	{
	392	struct tls_context *ctx = tls_get_ctx(sk);
	393
	394	if (!ctx)
	395	return false;
	396	return !!tls_sw_ctx_tx(ctx);
	397	}
	398
e91de6af JF	399	static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
	400	{
	401	struct tls_context *ctx = tls_get_ctx(sk);
	402
	403	if (!ctx)
	404	return false;
	405	return !!tls_sw_ctx_rx(ctx);
	406	}
	407
4799ac81 BP	408	static inline struct tls_offload_context_rx *
	409	tls_offload_ctx_rx(const struct tls_context *tls_ctx)
	410	{
	411	return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
	412	}
	413
2e361176 JK	414	static inline void __tls_driver_ctx(struct tls_context tls_ctx,
	415	enum tls_offload_ctx_dir direction)
	416	{
	417	if (direction == TLS_OFFLOAD_CTX_DIR_TX)
	418	return tls_offload_ctx_tx(tls_ctx)->driver_state;
	419	else
	420	return tls_offload_ctx_rx(tls_ctx)->driver_state;
	421	}
	422
	423	static inline void *
	424	tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
	425	{
	426	return __tls_driver_ctx(tls_get_ctx(sk), direction);
	427	}
2e361176	428
ed9b7646 BP	429	#define RESYNC_REQ BIT(0)
ed9b7646 BP	430	#define RESYNC_REQ_ASYNC BIT(1)
4799ac81 BP	431	/* The TLS context is valid until sk_destruct is called */
	432	static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
	433	{
	434	struct tls_context *tls_ctx = tls_get_ctx(sk);
	435	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
	436
ed9b7646 BP	437	atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) \| RESYNC_REQ);
	438	}
	439
	440	/* Log all TLS record header TCP sequences in [seq, seq+len] */
	441	static inline void
	442	tls_offload_rx_resync_async_request_start(struct sock *sk, __be32 seq, u16 len)
	443	{
	444	struct tls_context *tls_ctx = tls_get_ctx(sk);
	445	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
	446
	447	atomic64_set(&rx_ctx->resync_async->req, ((u64)ntohl(seq) << 32) \|
a6ed3ebc	448	((u64)len << 16) \| RESYNC_REQ \| RESYNC_REQ_ASYNC);
ed9b7646	449	rx_ctx->resync_async->loglen = 0;
138559b9	450	rx_ctx->resync_async->rcd_delta = 0;
ed9b7646 BP	451	}
	452
	453	static inline void
	454	tls_offload_rx_resync_async_request_end(struct sock *sk, __be32 seq)
	455	{
	456	struct tls_context *tls_ctx = tls_get_ctx(sk);
	457	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
	458
	459	atomic64_set(&rx_ctx->resync_async->req,
	460	((u64)ntohl(seq) << 32) \| RESYNC_REQ);
4799ac81 BP	461	}
4799ac81 BP	462
f953d33b JK	463	static inline void
	464	tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
	465	{
	466	struct tls_context *tls_ctx = tls_get_ctx(sk);
	467
	468	tls_offload_ctx_rx(tls_ctx)->resync_type = type;
	469	}
4799ac81	470
50180074 JK	471	/* Driver's seq tracking has to be disabled until resync succeeded */
	472	static inline bool tls_offload_tx_resync_pending(struct sock *sk)
	473	{
	474	struct tls_context *tls_ctx = tls_get_ctx(sk);
	475	bool ret;
	476
	477	ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
	478	smp_mb__after_atomic();
	479	return ret;
	480	}
	481
b9727d7f	482	struct sk_buff tls_encrypt_skb(struct sk_buff skb);
3c4d7559	483
be2fbc15	484	#ifdef CONFIG_TLS_DEVICE
8d5a49e9	485	void tls_device_sk_destruct(struct sock *sk);
8538d29c	486	void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
8d5a49e9 JK	487
	488	static inline bool tls_is_sk_rx_device_offloaded(struct sock *sk)
	489	{
	490	if (!sk_fullsock(sk) \|\|
	491	smp_load_acquire(&sk->sk_destruct) != tls_device_sk_destruct)
	492	return false;
	493	return tls_get_ctx(sk)->rx_conf == TLS_HW;
	494	}
be2fbc15	495	#endif
3c4d7559	496	#endif /* _TLS_OFFLOAD_H */