[thirdparty/linux.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 <net/tcp.h>
#include <net/strparser.h>

#include <uapi/linux/tls.h>


/* 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_DATA		0x17

#define TLS_AAD_SPACE_SIZE		13

struct tls_sw_context {
	struct crypto_aead *aead_send;
	struct crypto_aead *aead_recv;
	struct crypto_wait async_wait;

	/* Receive context */
	struct strparser strp;
	void (*saved_data_ready)(struct sock *sk);
	unsigned int (*sk_poll)(struct file *file, struct socket *sock,
				struct poll_table_struct *wait);
	struct sk_buff *recv_pkt;
	u8 control;
	bool decrypted;

	/* Sending context */
	char aad_space[TLS_AAD_SPACE_SIZE];

	unsigned int sg_plaintext_size;
	int sg_plaintext_num_elem;
	struct scatterlist sg_plaintext_data[MAX_SKB_FRAGS];

	unsigned int sg_encrypted_size;
	int sg_encrypted_num_elem;
	struct scatterlist sg_encrypted_data[MAX_SKB_FRAGS];

	/* AAD | sg_plaintext_data | sg_tag */
	struct scatterlist sg_aead_in[2];
	/* AAD | sg_encrypted_data (data contain overhead for hdr&iv&tag) */
	struct scatterlist sg_aead_out[2];
};

enum {
	TLS_PENDING_CLOSED_RECORD
};

struct cipher_context {
	u16 prepend_size;
	u16 tag_size;
	u16 overhead_size;
	u16 iv_size;
	char *iv;
	u16 rec_seq_size;
	char *rec_seq;
};

struct tls_context {
	union {
		struct tls_crypto_info crypto_send;
		struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128;
	};
	union {
		struct tls_crypto_info crypto_recv;
		struct tls12_crypto_info_aes_gcm_128 crypto_recv_aes_gcm_128;
	};

	void *priv_ctx;

	u8 conf:2;

	struct cipher_context tx;
	struct cipher_context rx;

	struct scatterlist *partially_sent_record;
	u16 partially_sent_offset;
	unsigned long flags;

	u16 pending_open_record_frags;
	int (*push_pending_record)(struct sock *sk, int flags);

	void (*sk_write_space)(struct sock *sk);
	void (*sk_proto_close)(struct sock *sk, long timeout);

	int  (*setsockopt)(struct sock *sk, int level,
			   int optname, char __user *optval,
			   unsigned int optlen);
	int  (*getsockopt)(struct sock *sk, int level,
			   int optname, char __user *optval,
			   int __user *optlen);
};

int wait_on_pending_writer(struct sock *sk, long *timeo);
int tls_sk_query(struct sock *sk, int optname, char __user *optval,
		int __user *optlen);
int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
		  unsigned int optlen);


int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
int tls_sw_sendpage(struct sock *sk, struct page *page,
		    int offset, size_t size, int flags);
void tls_sw_close(struct sock *sk, long timeout);
void tls_sw_free_resources(struct sock *sk);
int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
		   int nonblock, int flags, int *addr_len);
unsigned int tls_sw_poll(struct file *file, struct socket *sock,
			 struct poll_table_struct *wait);
ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
			   struct pipe_inode_info *pipe,
			   size_t len, unsigned int flags);

void tls_sk_destruct(struct sock *sk, struct tls_context *ctx);
void tls_icsk_clean_acked(struct sock *sk);

int tls_push_sg(struct sock *sk, struct tls_context *ctx,
		struct scatterlist *sg, u16 first_offset,
		int flags);
int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx,
				   int flags, long *timeo);

static inline bool tls_is_pending_closed_record(struct tls_context *ctx)
{
	return test_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags);
}

static inline int tls_complete_pending_work(struct sock *sk,
					    struct tls_context *ctx,
					    int flags, long *timeo)
{
	int rc = 0;

	if (unlikely(sk->sk_write_pending))
		rc = wait_on_pending_writer(sk, timeo);

	if (!rc && tls_is_pending_closed_record(ctx))
		rc = tls_push_pending_closed_record(sk, ctx, flags, timeo);

	return rc;
}

static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
{
	return !!ctx->partially_sent_record;
}

static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
{
	return tls_ctx->pending_open_record_frags;
}

static inline void tls_err_abort(struct sock *sk, int err)
{
	sk->sk_err = err;
	sk->sk_error_report(sk);
}

static inline bool tls_bigint_increment(unsigned char *seq, int len)
{
	int i;

	for (i = len - 1; i >= 0; i--) {
		++seq[i];
		if (seq[i] != 0)
			break;
	}

	return (i == -1);
}

static inline void tls_advance_record_sn(struct sock *sk,
					 struct cipher_context *ctx)
{
	if (tls_bigint_increment(ctx->rec_seq, ctx->rec_seq_size))
		tls_err_abort(sk, EBADMSG);
	tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
			     ctx->iv_size);
}

static inline void tls_fill_prepend(struct tls_context *ctx,
			     char *buf,
			     size_t plaintext_len,
			     unsigned char record_type)
{
	size_t pkt_len, iv_size = ctx->tx.iv_size;

	pkt_len = plaintext_len + iv_size + ctx->tx.tag_size;

	/* we cover nonce explicit here as well, so buf should be of
	 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
	 */
	buf[0] = record_type;
	buf[1] = TLS_VERSION_MINOR(ctx->crypto_send.version);
	buf[2] = TLS_VERSION_MAJOR(ctx->crypto_send.version);
	/* we can use IV for nonce explicit according to spec */
	buf[3] = pkt_len >> 8;
	buf[4] = pkt_len & 0xFF;
	memcpy(buf + TLS_NONCE_OFFSET,
	       ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
}

static inline void tls_make_aad(char *buf,
				size_t size,
				char *record_sequence,
				int record_sequence_size,
				unsigned char record_type)
{
	memcpy(buf, record_sequence, record_sequence_size);

	buf[8] = record_type;
	buf[9] = TLS_1_2_VERSION_MAJOR;
	buf[10] = TLS_1_2_VERSION_MINOR;
	buf[11] = size >> 8;
	buf[12] = size & 0xFF;
}

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

	return icsk->icsk_ulp_data;
}

static inline struct tls_sw_context *tls_sw_ctx(
		const struct tls_context *tls_ctx)
{
	return (struct tls_sw_context *)tls_ctx->priv_ctx;
}

static inline struct tls_offload_context *tls_offload_ctx(
		const struct tls_context *tls_ctx)
{
	return (struct tls_offload_context *)tls_ctx->priv_ctx;
}

int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
		      unsigned char *record_type);

#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>
	41	#include <linux/tcp.h>
	42	#include <net/tcp.h>
c46234eb	43	#include <net/strparser.h>
3c4d7559 DW	44
	45	#include <uapi/linux/tls.h>
	46
	47
	48	/* Maximum data size carried in a TLS record */
	49	#define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
	50
	51	#define TLS_HEADER_SIZE 5
	52	#define TLS_NONCE_OFFSET TLS_HEADER_SIZE
	53
	54	#define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
	55
	56	#define TLS_RECORD_TYPE_DATA 0x17
	57
	58	#define TLS_AAD_SPACE_SIZE 13
	59
	60	struct tls_sw_context {
	61	struct crypto_aead *aead_send;
c46234eb	62	struct crypto_aead *aead_recv;
a54667f6	63	struct crypto_wait async_wait;
3c4d7559	64
c46234eb DW	65	/* Receive context */
	66	struct strparser strp;
	67	void (saved_data_ready)(struct sock sk);
	68	unsigned int (sk_poll)(struct file file, struct socket *sock,
	69	struct poll_table_struct *wait);
	70	struct sk_buff *recv_pkt;
	71	u8 control;
	72	bool decrypted;
	73
3c4d7559 DW	74	/* Sending context */
	75	char aad_space[TLS_AAD_SPACE_SIZE];
	76
	77	unsigned int sg_plaintext_size;
	78	int sg_plaintext_num_elem;
	79	struct scatterlist sg_plaintext_data[MAX_SKB_FRAGS];
	80
	81	unsigned int sg_encrypted_size;
	82	int sg_encrypted_num_elem;
	83	struct scatterlist sg_encrypted_data[MAX_SKB_FRAGS];
	84
	85	/* AAD \| sg_plaintext_data \| sg_tag */
	86	struct scatterlist sg_aead_in[2];
	87	/* AAD \| sg_encrypted_data (data contain overhead for hdr&iv&tag) */
	88	struct scatterlist sg_aead_out[2];
	89	};
	90
	91	enum {
	92	TLS_PENDING_CLOSED_RECORD
	93	};
	94
dbe42559 DW	95	struct cipher_context {
	96	u16 prepend_size;
	97	u16 tag_size;
	98	u16 overhead_size;
	99	u16 iv_size;
	100	char *iv;
	101	u16 rec_seq_size;
	102	char *rec_seq;
	103	};
	104
3c4d7559 DW	105	struct tls_context {
	106	union {
	107	struct tls_crypto_info crypto_send;
	108	struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128;
	109	};
c46234eb DW	110	union {
	111	struct tls_crypto_info crypto_recv;
	112	struct tls12_crypto_info_aes_gcm_128 crypto_recv_aes_gcm_128;
	113	};
3c4d7559 DW	114
	115	void *priv_ctx;
	116
58371585	117	u8 conf:2;
6d88207f	118
dbe42559	119	struct cipher_context tx;
c46234eb	120	struct cipher_context rx;
3c4d7559 DW	121
	122	struct scatterlist *partially_sent_record;
	123	u16 partially_sent_offset;
	124	unsigned long flags;
	125
	126	u16 pending_open_record_frags;
	127	int (push_pending_record)(struct sock sk, int flags);
3c4d7559 DW	128
	129	void (sk_write_space)(struct sock sk);
	130	void (sk_proto_close)(struct sock sk, long timeout);
	131
	132	int (setsockopt)(struct sock sk, int level,
	133	int optname, char __user *optval,
	134	unsigned int optlen);
	135	int (getsockopt)(struct sock sk, int level,
	136	int optname, char __user *optval,
	137	int __user *optlen);
	138	};
	139
	140	int wait_on_pending_writer(struct sock sk, long timeo);
	141	int tls_sk_query(struct sock sk, int optname, char __user optval,
	142	int __user *optlen);
	143	int tls_sk_attach(struct sock sk, int optname, char __user optval,
	144	unsigned int optlen);
	145
	146
c46234eb	147	int tls_set_sw_offload(struct sock sk, struct tls_context ctx, int tx);
3c4d7559 DW	148	int tls_sw_sendmsg(struct sock sk, struct msghdr msg, size_t size);
	149	int tls_sw_sendpage(struct sock sk, struct page page,
	150	int offset, size_t size, int flags);
	151	void tls_sw_close(struct sock *sk, long timeout);
c46234eb DW	152	void tls_sw_free_resources(struct sock *sk);
	153	int tls_sw_recvmsg(struct sock sk, struct msghdr msg, size_t len,
	154	int nonblock, int flags, int *addr_len);
	155	unsigned int tls_sw_poll(struct file file, struct socket sock,
	156	struct poll_table_struct *wait);
	157	ssize_t tls_sw_splice_read(struct socket sock, loff_t ppos,
	158	struct pipe_inode_info *pipe,
	159	size_t len, unsigned int flags);
3c4d7559 DW	160
	161	void tls_sk_destruct(struct sock sk, struct tls_context ctx);
	162	void tls_icsk_clean_acked(struct sock *sk);
	163
	164	int tls_push_sg(struct sock sk, struct tls_context ctx,
	165	struct scatterlist *sg, u16 first_offset,
	166	int flags);
	167	int tls_push_pending_closed_record(struct sock sk, struct tls_context ctx,
	168	int flags, long *timeo);
	169
	170	static inline bool tls_is_pending_closed_record(struct tls_context *ctx)
	171	{
	172	return test_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags);
	173	}
	174
	175	static inline int tls_complete_pending_work(struct sock *sk,
	176	struct tls_context *ctx,
	177	int flags, long *timeo)
	178	{
	179	int rc = 0;
	180
	181	if (unlikely(sk->sk_write_pending))
	182	rc = wait_on_pending_writer(sk, timeo);
	183
	184	if (!rc && tls_is_pending_closed_record(ctx))
	185	rc = tls_push_pending_closed_record(sk, ctx, flags, timeo);
	186
	187	return rc;
	188	}
	189
	190	static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
	191	{
	192	return !!ctx->partially_sent_record;
	193	}
	194
	195	static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
	196	{
	197	return tls_ctx->pending_open_record_frags;
	198	}
	199
f4a8e43f	200	static inline void tls_err_abort(struct sock *sk, int err)
3c4d7559	201	{
f4a8e43f	202	sk->sk_err = err;
3c4d7559 DW	203	sk->sk_error_report(sk);
	204	}
	205
	206	static inline bool tls_bigint_increment(unsigned char *seq, int len)
	207	{
	208	int i;
	209
	210	for (i = len - 1; i >= 0; i--) {
	211	++seq[i];
	212	if (seq[i] != 0)
	213	break;
	214	}
	215
	216	return (i == -1);
	217	}
	218
	219	static inline void tls_advance_record_sn(struct sock *sk,
dbe42559	220	struct cipher_context *ctx)
3c4d7559 DW	221	{
3c4d7559 DW	222	if (tls_bigint_increment(ctx->rec_seq, ctx->rec_seq_size))
f4a8e43f	223	tls_err_abort(sk, EBADMSG);
3c4d7559 DW	224	tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
	225	ctx->iv_size);
	226	}
	227
	228	static inline void tls_fill_prepend(struct tls_context *ctx,
	229	char *buf,
	230	size_t plaintext_len,
	231	unsigned char record_type)
	232	{
dbe42559	233	size_t pkt_len, iv_size = ctx->tx.iv_size;
3c4d7559	234
dbe42559	235	pkt_len = plaintext_len + iv_size + ctx->tx.tag_size;
3c4d7559 DW	236
	237	/* we cover nonce explicit here as well, so buf should be of
	238	* size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
	239	*/
	240	buf[0] = record_type;
	241	buf[1] = TLS_VERSION_MINOR(ctx->crypto_send.version);
	242	buf[2] = TLS_VERSION_MAJOR(ctx->crypto_send.version);
	243	/* we can use IV for nonce explicit according to spec */
	244	buf[3] = pkt_len >> 8;
	245	buf[4] = pkt_len & 0xFF;
	246	memcpy(buf + TLS_NONCE_OFFSET,
dbe42559	247	ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
3c4d7559 DW	248	}
3c4d7559 DW	249
213ef6e7 IL	250	static inline void tls_make_aad(char *buf,
	251	size_t size,
	252	char *record_sequence,
	253	int record_sequence_size,
	254	unsigned char record_type)
	255	{
	256	memcpy(buf, record_sequence, record_sequence_size);
	257
	258	buf[8] = record_type;
	259	buf[9] = TLS_1_2_VERSION_MAJOR;
	260	buf[10] = TLS_1_2_VERSION_MINOR;
	261	buf[11] = size >> 8;
	262	buf[12] = size & 0xFF;
	263	}
	264
3c4d7559 DW	265	static inline struct tls_context tls_get_ctx(const struct sock sk)
	266	{
	267	struct inet_connection_sock *icsk = inet_csk(sk);
	268
	269	return icsk->icsk_ulp_data;
	270	}
	271
	272	static inline struct tls_sw_context *tls_sw_ctx(
	273	const struct tls_context *tls_ctx)
	274	{
	275	return (struct tls_sw_context *)tls_ctx->priv_ctx;
	276	}
	277
	278	static inline struct tls_offload_context *tls_offload_ctx(
	279	const struct tls_context *tls_ctx)
	280	{
	281	return (struct tls_offload_context *)tls_ctx->priv_ctx;
	282	}
	283
	284	int tls_proccess_cmsg(struct sock sk, struct msghdr msg,
	285	unsigned char *record_type);
	286
	287	#endif /* _TLS_OFFLOAD_H */