[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;

struct tls_cipher_size_desc {
	unsigned int iv;
	unsigned int key;
	unsigned int salt;
	unsigned int tag;
	unsigned int rec_seq;
};

extern const struct tls_cipher_size_desc tls_cipher_size_desc[];

/* 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_RECORD_TYPE_ALERT		0x15
#define TLS_RECORD_TYPE_HANDSHAKE	0x16
#define TLS_RECORD_TYPE_DATA		0x17

#define TLS_AAD_SPACE_SIZE		13

#define MAX_IV_SIZE			16
#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;
	/* protect crypto_wait with encrypt_pending */
	spinlock_t encrypt_compl_lock;
	int async_notify;
	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 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;
	/* protect crypto_wait with decrypt_pending*/
	spinlock_t decrypt_compl_lock;
	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];
};

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;
	u8 driver_state[] __aligned(8);
	/* 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
	 */
#define TLS_DRIVER_STATE_SIZE_TX	16
};

#define TLS_OFFLOAD_CONTEXT_SIZE_TX                                            \
	(sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)

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;
	char *rec_seq;
};

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 in_tcp_sendpages;
	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];
};

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;
		};
	};
	u8 driver_state[] __aligned(8);
	/* 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
	 */
#define TLS_DRIVER_STATE_SIZE_RX	8
};

#define TLS_OFFLOAD_CONTEXT_SIZE_RX					\
	(sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)

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_sk_tx_device_offloaded(struct sock *sk)
{
#ifdef CONFIG_SOCK_VALIDATE_XMIT
	return 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	53
2d2c5ea2 TT	54	struct tls_cipher_size_desc {
	55	unsigned int iv;
	56	unsigned int key;
	57	unsigned int salt;
	58	unsigned int tag;
	59	unsigned int rec_seq;
	60	};
	61
	62	extern const struct tls_cipher_size_desc tls_cipher_size_desc[];
	63
3c4d7559 DW	64	/* Maximum data size carried in a TLS record */
	65	#define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
	66
	67	#define TLS_HEADER_SIZE 5
	68	#define TLS_NONCE_OFFSET TLS_HEADER_SIZE
	69
	70	#define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
	71
5e052dda CL	72	#define TLS_RECORD_TYPE_ALERT 0x15
5e052dda CL	73	#define TLS_RECORD_TYPE_HANDSHAKE 0x16
3c4d7559 DW	74	#define TLS_RECORD_TYPE_DATA 0x17
	75
	76	#define TLS_AAD_SPACE_SIZE 13
dd0bed16	77
f295b3ae	78	#define MAX_IV_SIZE 16
a8340cc0	79	#define TLS_TAG_SIZE 16
89fec474	80	#define TLS_MAX_REC_SEQ_SIZE 8
50a07aa5	81	#define TLS_MAX_AAD_SIZE TLS_AAD_SPACE_SIZE
f295b3ae	82
128cfb88	83	/* For CCM mode, the full 16-bytes of IV is made of '4' fields of given sizes.
f295b3ae VG	84	*
	85	* IV[16] = b0[1] \|\| implicit nonce[4] \|\| explicit nonce[8] \|\| length[3]
	86	*
	87	* The field 'length' is encoded in field 'b0' as '(length width - 1)'.
	88	* Hence b0 contains (3 - 1) = 2.
	89	*/
	90	#define TLS_AES_CCM_IV_B0_BYTE 2
128cfb88	91	#define TLS_SM4_CCM_IV_B0_BYTE 2
f295b3ae	92
4799ac81 BP	93	enum {
	94	TLS_BASE,
	95	TLS_SW,
4799ac81	96	TLS_HW,
4799ac81 BP	97	TLS_HW_RECORD,
	98	TLS_NUM_CONFIG,
	99	};
	100
a42055e8 VG	101	struct tx_work {
	102	struct delayed_work work;
	103	struct sock *sk;
	104	};
	105
	106	struct tls_sw_context_tx {
	107	struct crypto_aead *aead_send;
	108	struct crypto_wait async_wait;
	109	struct tx_work tx_work;
	110	struct tls_rec *open_rec;
9932a29a	111	struct list_head tx_list;
a42055e8	112	atomic_t encrypt_pending;
0cada332 VKY	113	/* protect crypto_wait with encrypt_pending */
0cada332 VKY	114	spinlock_t encrypt_compl_lock;
a42055e8	115	int async_notify;
5c5458ec	116	u8 async_capable:1;
a42055e8 VG	117
a42055e8 VG	118	#define BIT_TX_SCHEDULED 0
f87e62d4	119	#define BIT_TX_CLOSING 1
a42055e8	120	unsigned long tx_bitmask;
3c4d7559 DW	121	};
3c4d7559 DW	122
84c61fe1 JK	123	struct tls_strparser {
	124	struct sock *sk;
	125
	126	u32 mark : 8;
	127	u32 stopped : 1;
	128	u32 copy_mode : 1;
	129	u32 msg_ready : 1;
	130
	131	struct strp_msg stm;
	132
	133	struct sk_buff *anchor;
	134	struct work_struct work;
	135	};
	136
f66de3ee BP	137	struct tls_sw_context_rx {
	138	struct crypto_aead *aead_recv;
	139	struct crypto_wait async_wait;
692d7b5d	140	struct sk_buff_head rx_list; /* list of decrypted 'data' records */
f66de3ee	141	void (saved_data_ready)(struct sock sk);
924ad65e	142
4cbc325e	143	u8 reader_present;
5c5458ec	144	u8 async_capable:1;
88527790	145	u8 zc_capable:1;
4cbc325e	146	u8 reader_contended:1;
84c61fe1 JK	147
	148	struct tls_strparser strp;
	149
94524d8f	150	atomic_t decrypt_pending;
0cada332 VKY	151	/* protect crypto_wait with decrypt_pending*/
0cada332 VKY	152	spinlock_t decrypt_compl_lock;
c618db2a	153	struct sk_buff_head async_hold;
4cbc325e	154	struct wait_queue_head wq;
94524d8f VG	155	};
94524d8f VG	156
e8f69799 IL	157	struct tls_record_info {
	158	struct list_head list;
	159	u32 end_seq;
	160	int len;
	161	int num_frags;
	162	skb_frag_t frags[MAX_SKB_FRAGS];
	163	};
	164
d80a1b9d	165	struct tls_offload_context_tx {
e8f69799 IL	166	struct crypto_aead *aead_send;
	167	spinlock_t lock; /* protects records list */
	168	struct list_head records_list;
	169	struct tls_record_info *open_record;
	170	struct tls_record_info *retransmit_hint;
	171	u64 hint_record_sn;
	172	u64 unacked_record_sn;
	173
	174	struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
	175	void (sk_destruct)(struct sock sk);
7adc91e0 TT	176	struct work_struct destruct_work;
7adc91e0 TT	177	struct tls_context *ctx;
2e361176	178	u8 driver_state[] __aligned(8);
e8f69799 IL	179	/* The TLS layer reserves room for driver specific state
	180	* Currently the belief is that there is not enough
	181	* driver specific state to justify another layer of indirection
	182	*/
2d6b51c6	183	#define TLS_DRIVER_STATE_SIZE_TX 16
e8f69799 IL	184	};
e8f69799 IL	185
d80a1b9d	186	#define TLS_OFFLOAD_CONTEXT_SIZE_TX \
2e361176	187	(sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
e8f69799	188
e52972c1	189	enum tls_context_flags {
c55dcdd4 MM	190	/* tls_device_down was called after the netdev went down, device state
	191	* was released, and kTLS works in software, even though rx_conf is
	192	* still TLS_HW (needed for transition).
	193	*/
	194	TLS_RX_DEV_DEGRADED = 0,
50180074 JK	195	/* Unlike RX where resync is driven entirely by the core in TX only
	196	* the driver knows when things went out of sync, so we need the flag
	197	* to be atomic.
	198	*/
	199	TLS_TX_SYNC_SCHED = 1,
025cc2fb MM	200	/* tls_dev_del was called for the RX side, device state was released,
	201	* but tls_ctx->netdev might still be kept, because TX-side driver
	202	* resources might not be released yet. Used to prevent the second
	203	* tls_dev_del call in tls_device_down if it happens simultaneously.
	204	*/
	205	TLS_RX_DEV_CLOSED = 2,
e52972c1 JK	206	};
e52972c1 JK	207
dbe42559	208	struct cipher_context {
dbe42559	209	char *iv;
dbe42559 DW	210	char *rec_seq;
	211	};
	212
86029d10 SD	213	union tls_crypto_context {
86029d10 SD	214	struct tls_crypto_info info;
fb99bce7 DW	215	union {
	216	struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
	217	struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
923c40c4	218	struct tls12_crypto_info_chacha20_poly1305 chacha20_poly1305;
39d8fb96 TZ	219	struct tls12_crypto_info_sm4_gcm sm4_gcm;
39d8fb96 TZ	220	struct tls12_crypto_info_sm4_ccm sm4_ccm;
fb99bce7	221	};
86029d10 SD	222	};
86029d10 SD	223
4509de14 VG	224	struct tls_prot_info {
	225	u16 version;
	226	u16 cipher_type;
	227	u16 prepend_size;
	228	u16 tag_size;
	229	u16 overhead_size;
	230	u16 iv_size;
f295b3ae	231	u16 salt_size;
4509de14 VG	232	u16 rec_seq_size;
	233	u16 aad_size;
	234	u16 tail_size;
	235	};
	236
3c4d7559	237	struct tls_context {
f0aaa2c9	238	/* read-only cache line */
4509de14 VG	239	struct tls_prot_info prot_info;
4509de14 VG	240
f0aaa2c9 JK	241	u8 tx_conf:3;
f0aaa2c9 JK	242	u8 rx_conf:3;
c1318b39	243	u8 zerocopy_sendfile:1;
88527790	244	u8 rx_no_pad:1;
3c4d7559	245
f0aaa2c9 JK	246	int (push_pending_record)(struct sock sk, int flags);
f0aaa2c9 JK	247	void (sk_write_space)(struct sock sk);
f66de3ee BP	248
	249	void *priv_ctx_tx;
	250	void *priv_ctx_rx;
3c4d7559	251
94ce3b64	252	struct net_device __rcu *netdev;
6d88207f	253
f0aaa2c9	254	/* rw cache line */
dbe42559	255	struct cipher_context tx;
c46234eb	256	struct cipher_context rx;
3c4d7559 DW	257
	258	struct scatterlist *partially_sent_record;
	259	u16 partially_sent_offset;
a42055e8	260
c212d2c7	261	bool in_tcp_sendpages;
d829e9c4	262	bool pending_open_record_frags;
79ffe608 JK	263
	264	struct mutex tx_lock; /* protects partially_sent_* fields and
	265	* per-type TX fields
	266	*/
f0aaa2c9	267	unsigned long flags;
3c4d7559	268
f0aaa2c9	269	/* cache cold stuff */
32857cf5	270	struct proto *sk_proto;
c55dcdd4	271	struct sock *sk;
32857cf5	272
4799ac81	273	void (sk_destruct)(struct sock sk);
f0aaa2c9 JK	274
	275	union tls_crypto_context crypto_send;
	276	union tls_crypto_context crypto_recv;
	277
	278	struct list_head list;
	279	refcount_t refcount;
15a7dea7	280	struct rcu_head rcu;
3c4d7559 DW	281	};
3c4d7559 DW	282
da68b4ad JK	283	enum tls_offload_ctx_dir {
	284	TLS_OFFLOAD_CTX_DIR_RX,
	285	TLS_OFFLOAD_CTX_DIR_TX,
	286	};
	287
	288	struct tlsdev_ops {
	289	int (tls_dev_add)(struct net_device netdev, struct sock *sk,
	290	enum tls_offload_ctx_dir direction,
	291	struct tls_crypto_info *crypto_info,
	292	u32 start_offload_tcp_sn);
	293	void (tls_dev_del)(struct net_device netdev,
	294	struct tls_context *ctx,
	295	enum tls_offload_ctx_dir direction);
b5d9a834 DM	296	int (tls_dev_resync)(struct net_device netdev,
	297	struct sock sk, u32 seq, u8 rcd_sn,
	298	enum tls_offload_ctx_dir direction);
da68b4ad JK	299	};
da68b4ad JK	300
f953d33b JK	301	enum tls_offload_sync_type {
	302	TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
	303	TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
ed9b7646	304	TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC = 2,
f953d33b JK	305	};
	306
	307	#define TLS_DEVICE_RESYNC_NH_START_IVAL 2
	308	#define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
	309
ed9b7646 BP	310	#define TLS_DEVICE_RESYNC_ASYNC_LOGMAX 13
	311	struct tls_offload_resync_async {
	312	atomic64_t req;
138559b9 TT	313	u16 loglen;
138559b9 TT	314	u16 rcd_delta;
ed9b7646 BP	315	u32 log[TLS_DEVICE_RESYNC_ASYNC_LOGMAX];
	316	};
	317
4799ac81 BP	318	struct tls_offload_context_rx {
	319	/* sw must be the first member of tls_offload_context_rx */
	320	struct tls_sw_context_rx sw;
f953d33b JK	321	enum tls_offload_sync_type resync_type;
	322	/* this member is set regardless of resync_type, to avoid branches */
	323	u8 resync_nh_reset:1;
	324	/* CORE_NEXT_HINT-only member, but use the hole here */
	325	u8 resync_nh_do_now:1;
	326	union {
	327	/* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
	328	struct {
	329	atomic64_t resync_req;
	330	};
	331	/* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
	332	struct {
	333	u32 decrypted_failed;
	334	u32 decrypted_tgt;
	335	} resync_nh;
ed9b7646 BP	336	/* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC */
	337	struct {
	338	struct tls_offload_resync_async *resync_async;
	339	};
f953d33b	340	};
2e361176	341	u8 driver_state[] __aligned(8);
4799ac81 BP	342	/* The TLS layer reserves room for driver specific state
	343	* Currently the belief is that there is not enough
	344	* driver specific state to justify another layer of indirection
	345	*/
2d6b51c6	346	#define TLS_DRIVER_STATE_SIZE_RX 8
4799ac81 BP	347	};
	348
	349	#define TLS_OFFLOAD_CONTEXT_SIZE_RX \
2e361176	350	(sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
4799ac81	351
d80a1b9d	352	struct tls_record_info tls_get_record(struct tls_offload_context_tx context,
e8f69799 IL	353	u32 seq, u64 *p_record_sn);
	354
	355	static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
	356	{
	357	return rec->len == 0;
	358	}
	359
	360	static inline u32 tls_record_start_seq(struct tls_record_info *rec)
	361	{
	362	return rec->end_seq - rec->len;
	363	}
3c4d7559	364
4799ac81 BP	365	struct sk_buff *
	366	tls_validate_xmit_skb(struct sock sk, struct net_device dev,
	367	struct sk_buff *skb);
c55dcdd4 MM	368	struct sk_buff *
	369	tls_validate_xmit_skb_sw(struct sock sk, struct net_device dev,
	370	struct sk_buff *skb);
4799ac81	371
e8f69799 IL	372	static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
e8f69799 IL	373	{
4799ac81	374	#ifdef CONFIG_SOCK_VALIDATE_XMIT
b4f47f38	375	return sk_fullsock(sk) &&
4799ac81 BP	376	(smp_load_acquire(&sk->sk_validate_xmit_skb) ==
	377	&tls_validate_xmit_skb);
	378	#else
	379	return false;
	380	#endif
e8f69799 IL	381	}
e8f69799 IL	382
4509de14 VG	383	static inline struct tls_context tls_get_ctx(const struct sock sk)
	384	{
	385	struct inet_connection_sock *icsk = inet_csk(sk);
	386
15a7dea7 JK	387	/* Use RCU on icsk_ulp_data only for sock diag code,
	388	* TLS data path doesn't need rcu_dereference().
	389	*/
	390	return (__force void *)icsk->icsk_ulp_data;
4509de14 VG	391	}
4509de14 VG	392
f66de3ee BP	393	static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
	394	const struct tls_context *tls_ctx)
	395	{
	396	return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
	397	}
	398
	399	static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
3c4d7559 DW	400	const struct tls_context *tls_ctx)
3c4d7559 DW	401	{
f66de3ee	402	return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
3c4d7559 DW	403	}
3c4d7559 DW	404
d80a1b9d BP	405	static inline struct tls_offload_context_tx *
d80a1b9d BP	406	tls_offload_ctx_tx(const struct tls_context *tls_ctx)
3c4d7559	407	{
d80a1b9d	408	return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
3c4d7559 DW	409	}
3c4d7559 DW	410
0608c69c JF	411	static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
	412	{
	413	struct tls_context *ctx = tls_get_ctx(sk);
	414
	415	if (!ctx)
	416	return false;
	417	return !!tls_sw_ctx_tx(ctx);
	418	}
	419
e91de6af JF	420	static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
	421	{
	422	struct tls_context *ctx = tls_get_ctx(sk);
	423
	424	if (!ctx)
	425	return false;
	426	return !!tls_sw_ctx_rx(ctx);
	427	}
	428
4799ac81 BP	429	static inline struct tls_offload_context_rx *
	430	tls_offload_ctx_rx(const struct tls_context *tls_ctx)
	431	{
	432	return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
	433	}
	434
2e361176 JK	435	static inline void __tls_driver_ctx(struct tls_context tls_ctx,
	436	enum tls_offload_ctx_dir direction)
	437	{
	438	if (direction == TLS_OFFLOAD_CTX_DIR_TX)
	439	return tls_offload_ctx_tx(tls_ctx)->driver_state;
	440	else
	441	return tls_offload_ctx_rx(tls_ctx)->driver_state;
	442	}
	443
	444	static inline void *
	445	tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
	446	{
	447	return __tls_driver_ctx(tls_get_ctx(sk), direction);
	448	}
2e361176	449
ed9b7646 BP	450	#define RESYNC_REQ BIT(0)
ed9b7646 BP	451	#define RESYNC_REQ_ASYNC BIT(1)
4799ac81 BP	452	/* The TLS context is valid until sk_destruct is called */
	453	static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
	454	{
	455	struct tls_context *tls_ctx = tls_get_ctx(sk);
	456	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
	457
ed9b7646 BP	458	atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) \| RESYNC_REQ);
	459	}
	460
	461	/* Log all TLS record header TCP sequences in [seq, seq+len] */
	462	static inline void
	463	tls_offload_rx_resync_async_request_start(struct sock *sk, __be32 seq, u16 len)
	464	{
	465	struct tls_context *tls_ctx = tls_get_ctx(sk);
	466	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
	467
	468	atomic64_set(&rx_ctx->resync_async->req, ((u64)ntohl(seq) << 32) \|
a6ed3ebc	469	((u64)len << 16) \| RESYNC_REQ \| RESYNC_REQ_ASYNC);
ed9b7646	470	rx_ctx->resync_async->loglen = 0;
138559b9	471	rx_ctx->resync_async->rcd_delta = 0;
ed9b7646 BP	472	}
	473
	474	static inline void
	475	tls_offload_rx_resync_async_request_end(struct sock *sk, __be32 seq)
	476	{
	477	struct tls_context *tls_ctx = tls_get_ctx(sk);
	478	struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
	479
	480	atomic64_set(&rx_ctx->resync_async->req,
	481	((u64)ntohl(seq) << 32) \| RESYNC_REQ);
4799ac81 BP	482	}
4799ac81 BP	483
f953d33b JK	484	static inline void
	485	tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
	486	{
	487	struct tls_context *tls_ctx = tls_get_ctx(sk);
	488
	489	tls_offload_ctx_rx(tls_ctx)->resync_type = type;
	490	}
4799ac81	491
50180074 JK	492	/* Driver's seq tracking has to be disabled until resync succeeded */
	493	static inline bool tls_offload_tx_resync_pending(struct sock *sk)
	494	{
	495	struct tls_context *tls_ctx = tls_get_ctx(sk);
	496	bool ret;
	497
	498	ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
	499	smp_mb__after_atomic();
	500	return ret;
	501	}
	502
b9727d7f	503	struct sk_buff tls_encrypt_skb(struct sk_buff skb);
3c4d7559	504
be2fbc15	505	#ifdef CONFIG_TLS_DEVICE
8d5a49e9	506	void tls_device_sk_destruct(struct sock *sk);
8538d29c	507	void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
8d5a49e9 JK	508
	509	static inline bool tls_is_sk_rx_device_offloaded(struct sock *sk)
	510	{
	511	if (!sk_fullsock(sk) \|\|
	512	smp_load_acquire(&sk->sk_destruct) != tls_device_sk_destruct)
	513	return false;
	514	return tls_get_ctx(sk)->rx_conf == TLS_HW;
	515	}
be2fbc15	516	#endif
3c4d7559	517	#endif /* _TLS_OFFLOAD_H */