blob: c875c0a445a690fcf1910bd1deff15534683710d [file] [log] [blame]
Dave Watson3c4d7552017-06-14 11:37:39 -07001/*
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>
Dmitry V. Levinb9f3eb42017-11-14 06:30:11 +030038#include <asm/byteorder.h>
Vakul Garga54667f2018-01-31 21:34:37 +053039#include <linux/crypto.h>
Dmitry V. Levinb9f3eb42017-11-14 06:30:11 +030040#include <linux/socket.h>
41#include <linux/tcp.h>
Daniel Borkmannd829e9c2018-10-13 02:45:59 +020042#include <linux/skmsg.h>
Jakub Kicinski79ffe602019-11-05 14:24:35 -080043#include <linux/mutex.h>
Jakub Kicinski2e361172019-06-05 14:11:39 -070044#include <linux/netdevice.h>
Jakub Kicinski15a7dea2019-08-30 12:25:47 +020045#include <linux/rcupdate.h>
Daniel Borkmannd829e9c2018-10-13 02:45:59 +020046
Jakub Kicinskid26b6982019-10-04 16:19:24 -070047#include <net/net_namespace.h>
Dmitry V. Levinb9f3eb42017-11-14 06:30:11 +030048#include <net/tcp.h>
Dave Watsonc46234e2018-03-22 10:10:35 -070049#include <net/strparser.h>
Vakul Garga42055e2018-09-21 09:46:13 +053050#include <crypto/aead.h>
Dave Watson3c4d7552017-06-14 11:37:39 -070051#include <uapi/linux/tls.h>
52
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
62#define TLS_RECORD_TYPE_DATA 0x17
63
64#define TLS_AAD_SPACE_SIZE 13
Atul Guptadd0bed12018-03-31 21:41:52 +053065
Vakul Gargf295b3a2019-03-20 02:03:36 +000066#define MAX_IV_SIZE 16
Jakub Kicinski89fec472019-06-10 21:40:00 -070067#define TLS_MAX_REC_SEQ_SIZE 8
Vakul Gargf295b3a2019-03-20 02:03:36 +000068
69/* For AES-CCM, the full 16-bytes of IV is made of '4' fields of given sizes.
70 *
71 * IV[16] = b0[1] || implicit nonce[4] || explicit nonce[8] || length[3]
72 *
73 * The field 'length' is encoded in field 'b0' as '(length width - 1)'.
74 * Hence b0 contains (3 - 1) = 2.
75 */
76#define TLS_AES_CCM_IV_B0_BYTE 2
77
Jakub Kicinskid26b6982019-10-04 16:19:24 -070078#define __TLS_INC_STATS(net, field) \
79 __SNMP_INC_STATS((net)->mib.tls_statistics, field)
80#define TLS_INC_STATS(net, field) \
81 SNMP_INC_STATS((net)->mib.tls_statistics, field)
82#define __TLS_DEC_STATS(net, field) \
83 __SNMP_DEC_STATS((net)->mib.tls_statistics, field)
84#define TLS_DEC_STATS(net, field) \
85 SNMP_DEC_STATS((net)->mib.tls_statistics, field)
86
Boris Pismenny4799ac82018-07-13 14:33:43 +030087enum {
88 TLS_BASE,
89 TLS_SW,
Boris Pismenny4799ac82018-07-13 14:33:43 +030090 TLS_HW,
Boris Pismenny4799ac82018-07-13 14:33:43 +030091 TLS_HW_RECORD,
92 TLS_NUM_CONFIG,
93};
94
Vakul Garga42055e2018-09-21 09:46:13 +053095/* TLS records are maintained in 'struct tls_rec'. It stores the memory pages
96 * allocated or mapped for each TLS record. After encryption, the records are
97 * stores in a linked list.
98 */
99struct tls_rec {
100 struct list_head list;
Vakul Garg9932a292018-09-24 15:35:56 +0530101 int tx_ready;
Vakul Garga42055e2018-09-21 09:46:13 +0530102 int tx_flags;
Dave Watson3c4d7552017-06-14 11:37:39 -0700103
Daniel Borkmannd829e9c2018-10-13 02:45:59 +0200104 struct sk_msg msg_plaintext;
105 struct sk_msg msg_encrypted;
Vakul Garga42055e2018-09-21 09:46:13 +0530106
Daniel Borkmannd829e9c2018-10-13 02:45:59 +0200107 /* AAD | msg_plaintext.sg.data | sg_tag */
108 struct scatterlist sg_aead_in[2];
109 /* AAD | msg_encrypted.sg.data (data contains overhead for hdr & iv & tag) */
110 struct scatterlist sg_aead_out[2];
Vakul Garga42055e2018-09-21 09:46:13 +0530111
Dave Watson130b3922019-01-30 21:58:31 +0000112 char content_type;
113 struct scatterlist sg_content_type;
114
Vakul Garga42055e2018-09-21 09:46:13 +0530115 char aad_space[TLS_AAD_SPACE_SIZE];
Vakul Gargf295b3a2019-03-20 02:03:36 +0000116 u8 iv_data[MAX_IV_SIZE];
Vakul Garga42055e2018-09-21 09:46:13 +0530117 struct aead_request aead_req;
118 u8 aead_req_ctx[];
119};
120
Vakul Garg2b794c42019-02-23 08:42:37 +0000121struct tls_msg {
122 struct strp_msg rxm;
123 u8 control;
124};
125
Vakul Garga42055e2018-09-21 09:46:13 +0530126struct tx_work {
127 struct delayed_work work;
128 struct sock *sk;
129};
130
131struct tls_sw_context_tx {
132 struct crypto_aead *aead_send;
133 struct crypto_wait async_wait;
134 struct tx_work tx_work;
135 struct tls_rec *open_rec;
Vakul Garg9932a292018-09-24 15:35:56 +0530136 struct list_head tx_list;
Vakul Garga42055e2018-09-21 09:46:13 +0530137 atomic_t encrypt_pending;
Vinay Kumar Yadav0cada332020-05-23 01:40:31 +0530138 /* protect crypto_wait with encrypt_pending */
139 spinlock_t encrypt_compl_lock;
Vakul Garga42055e2018-09-21 09:46:13 +0530140 int async_notify;
Jakub Kicinski5c5458e2019-10-06 21:09:31 -0700141 u8 async_capable:1;
Vakul Garga42055e2018-09-21 09:46:13 +0530142
143#define BIT_TX_SCHEDULED 0
John Fastabendf87e62d2019-07-19 10:29:16 -0700144#define BIT_TX_CLOSING 1
Vakul Garga42055e2018-09-21 09:46:13 +0530145 unsigned long tx_bitmask;
Dave Watson3c4d7552017-06-14 11:37:39 -0700146};
147
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300148struct tls_sw_context_rx {
149 struct crypto_aead *aead_recv;
150 struct crypto_wait async_wait;
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300151 struct strparser strp;
Vakul Garg692d7b52019-01-16 10:40:16 +0000152 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300153 void (*saved_data_ready)(struct sock *sk);
John Fastabend924ad652018-10-13 02:46:00 +0200154
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300155 struct sk_buff *recv_pkt;
156 u8 control;
Jakub Kicinski5c5458e2019-10-06 21:09:31 -0700157 u8 async_capable:1;
Jakub Kicinskibc76e5b2019-10-06 21:09:32 -0700158 u8 decrypted:1;
Vakul Garg94524d82018-08-29 15:26:55 +0530159 atomic_t decrypt_pending;
Vinay Kumar Yadav0cada332020-05-23 01:40:31 +0530160 /* protect crypto_wait with decrypt_pending*/
161 spinlock_t decrypt_compl_lock;
Vakul Garg94524d82018-08-29 15:26:55 +0530162 bool async_notify;
163};
164
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300165struct tls_record_info {
166 struct list_head list;
167 u32 end_seq;
168 int len;
169 int num_frags;
170 skb_frag_t frags[MAX_SKB_FRAGS];
171};
172
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300173struct tls_offload_context_tx {
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300174 struct crypto_aead *aead_send;
175 spinlock_t lock; /* protects records list */
176 struct list_head records_list;
177 struct tls_record_info *open_record;
178 struct tls_record_info *retransmit_hint;
179 u64 hint_record_sn;
180 u64 unacked_record_sn;
181
182 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
183 void (*sk_destruct)(struct sock *sk);
Jakub Kicinski2e361172019-06-05 14:11:39 -0700184 u8 driver_state[] __aligned(8);
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300185 /* The TLS layer reserves room for driver specific state
186 * Currently the belief is that there is not enough
187 * driver specific state to justify another layer of indirection
188 */
Jakub Kicinski2d6b51c2019-06-05 14:11:38 -0700189#define TLS_DRIVER_STATE_SIZE_TX 16
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300190};
191
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300192#define TLS_OFFLOAD_CONTEXT_SIZE_TX \
Jakub Kicinski2e361172019-06-05 14:11:39 -0700193 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300194
Jakub Kicinskie52972c2019-06-04 12:00:12 -0700195enum tls_context_flags {
196 TLS_RX_SYNC_RUNNING = 0,
Jakub Kicinski50180072019-06-10 21:40:09 -0700197 /* Unlike RX where resync is driven entirely by the core in TX only
198 * the driver knows when things went out of sync, so we need the flag
199 * to be atomic.
200 */
201 TLS_TX_SYNC_SCHED = 1,
Jakub Kicinskie52972c2019-06-04 12:00:12 -0700202};
203
Dave Watsondbe42552018-03-22 10:10:06 -0700204struct cipher_context {
Dave Watsondbe42552018-03-22 10:10:06 -0700205 char *iv;
Dave Watsondbe42552018-03-22 10:10:06 -0700206 char *rec_seq;
207};
208
Sabrina Dubroca86029d12018-09-12 17:44:42 +0200209union tls_crypto_context {
210 struct tls_crypto_info info;
Dave Watsonfb99bce2019-01-30 21:58:05 +0000211 union {
212 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
213 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
214 };
Sabrina Dubroca86029d12018-09-12 17:44:42 +0200215};
216
Vakul Garg4509de12019-02-14 07:11:35 +0000217struct tls_prot_info {
218 u16 version;
219 u16 cipher_type;
220 u16 prepend_size;
221 u16 tag_size;
222 u16 overhead_size;
223 u16 iv_size;
Vakul Gargf295b3a2019-03-20 02:03:36 +0000224 u16 salt_size;
Vakul Garg4509de12019-02-14 07:11:35 +0000225 u16 rec_seq_size;
226 u16 aad_size;
227 u16 tail_size;
228};
229
Dave Watson3c4d7552017-06-14 11:37:39 -0700230struct tls_context {
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700231 /* read-only cache line */
Vakul Garg4509de12019-02-14 07:11:35 +0000232 struct tls_prot_info prot_info;
233
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300234 u8 tx_conf:3;
235 u8 rx_conf:3;
Ilya Lesokhin6d882072017-11-13 10:22:45 +0200236
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700237 int (*push_pending_record)(struct sock *sk, int flags);
238 void (*sk_write_space)(struct sock *sk);
239
240 void *priv_ctx_tx;
241 void *priv_ctx_rx;
242
243 struct net_device *netdev;
244
245 /* rw cache line */
Dave Watsondbe42552018-03-22 10:10:06 -0700246 struct cipher_context tx;
Dave Watsonc46234e2018-03-22 10:10:35 -0700247 struct cipher_context rx;
Dave Watson3c4d7552017-06-14 11:37:39 -0700248
249 struct scatterlist *partially_sent_record;
250 u16 partially_sent_offset;
Vakul Garga42055e2018-09-21 09:46:13 +0530251
Dave Watsonc212d2c2018-05-01 13:05:39 -0700252 bool in_tcp_sendpages;
Daniel Borkmannd829e9c2018-10-13 02:45:59 +0200253 bool pending_open_record_frags;
Jakub Kicinski79ffe602019-11-05 14:24:35 -0800254
255 struct mutex tx_lock; /* protects partially_sent_* fields and
256 * per-type TX fields
257 */
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700258 unsigned long flags;
Dave Watson3c4d7552017-06-14 11:37:39 -0700259
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700260 /* cache cold stuff */
John Fastabend32857cf2019-07-19 10:29:18 -0700261 struct proto *sk_proto;
262
Boris Pismenny4799ac82018-07-13 14:33:43 +0300263 void (*sk_destruct)(struct sock *sk);
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700264
265 union tls_crypto_context crypto_send;
266 union tls_crypto_context crypto_recv;
267
268 struct list_head list;
269 refcount_t refcount;
Jakub Kicinski15a7dea2019-08-30 12:25:47 +0200270 struct rcu_head rcu;
Dave Watson3c4d7552017-06-14 11:37:39 -0700271};
272
Jakub Kicinskida68b4a2019-04-25 12:32:03 -0700273enum tls_offload_ctx_dir {
274 TLS_OFFLOAD_CTX_DIR_RX,
275 TLS_OFFLOAD_CTX_DIR_TX,
276};
277
278struct tlsdev_ops {
279 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
280 enum tls_offload_ctx_dir direction,
281 struct tls_crypto_info *crypto_info,
282 u32 start_offload_tcp_sn);
283 void (*tls_dev_del)(struct net_device *netdev,
284 struct tls_context *ctx,
285 enum tls_offload_ctx_dir direction);
Dirk van der Merweb5d9a832019-07-08 19:53:13 -0700286 int (*tls_dev_resync)(struct net_device *netdev,
287 struct sock *sk, u32 seq, u8 *rcd_sn,
288 enum tls_offload_ctx_dir direction);
Jakub Kicinskida68b4a2019-04-25 12:32:03 -0700289};
290
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700291enum tls_offload_sync_type {
292 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
293 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
Boris Pismennyed9b7642020-06-08 19:11:38 +0300294 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC = 2,
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700295};
296
297#define TLS_DEVICE_RESYNC_NH_START_IVAL 2
298#define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
299
Boris Pismennyed9b7642020-06-08 19:11:38 +0300300#define TLS_DEVICE_RESYNC_ASYNC_LOGMAX 13
301struct tls_offload_resync_async {
302 atomic64_t req;
303 u32 loglen;
304 u32 log[TLS_DEVICE_RESYNC_ASYNC_LOGMAX];
305};
306
Boris Pismenny4799ac82018-07-13 14:33:43 +0300307struct tls_offload_context_rx {
308 /* sw must be the first member of tls_offload_context_rx */
309 struct tls_sw_context_rx sw;
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700310 enum tls_offload_sync_type resync_type;
311 /* this member is set regardless of resync_type, to avoid branches */
312 u8 resync_nh_reset:1;
313 /* CORE_NEXT_HINT-only member, but use the hole here */
314 u8 resync_nh_do_now:1;
315 union {
316 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
317 struct {
318 atomic64_t resync_req;
319 };
320 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
321 struct {
322 u32 decrypted_failed;
323 u32 decrypted_tgt;
324 } resync_nh;
Boris Pismennyed9b7642020-06-08 19:11:38 +0300325 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC */
326 struct {
327 struct tls_offload_resync_async *resync_async;
328 };
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700329 };
Jakub Kicinski2e361172019-06-05 14:11:39 -0700330 u8 driver_state[] __aligned(8);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300331 /* The TLS layer reserves room for driver specific state
332 * Currently the belief is that there is not enough
333 * driver specific state to justify another layer of indirection
334 */
Jakub Kicinski2d6b51c2019-06-05 14:11:38 -0700335#define TLS_DRIVER_STATE_SIZE_RX 8
Boris Pismenny4799ac82018-07-13 14:33:43 +0300336};
337
338#define TLS_OFFLOAD_CONTEXT_SIZE_RX \
Jakub Kicinski2e361172019-06-05 14:11:39 -0700339 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
Boris Pismenny4799ac82018-07-13 14:33:43 +0300340
Jakub Kicinski08700da2019-10-03 11:18:57 -0700341struct tls_context *tls_ctx_create(struct sock *sk);
Jakub Kicinski15a7dea2019-08-30 12:25:47 +0200342void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
Jakub Kicinski08700da2019-10-03 11:18:57 -0700343void update_sk_prot(struct sock *sk, struct tls_context *ctx);
344
Dave Watson3c4d7552017-06-14 11:37:39 -0700345int wait_on_pending_writer(struct sock *sk, long *timeo);
346int tls_sk_query(struct sock *sk, int optname, char __user *optval,
347 int __user *optlen);
348int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
349 unsigned int optlen);
350
Dave Watsonc46234e2018-03-22 10:10:35 -0700351int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
Jakub Kicinski318892a2019-07-19 10:29:14 -0700352void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
John Fastabend313ab002019-07-19 10:29:17 -0700353void tls_sw_strparser_done(struct tls_context *tls_ctx);
Dave Watson3c4d7552017-06-14 11:37:39 -0700354int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
Willem de Bruijnd4ffb022019-11-18 10:40:51 -0500355int tls_sw_sendpage_locked(struct sock *sk, struct page *page,
356 int offset, size_t size, int flags);
Dave Watson3c4d7552017-06-14 11:37:39 -0700357int tls_sw_sendpage(struct sock *sk, struct page *page,
358 int offset, size_t size, int flags);
John Fastabendf87e62d2019-07-19 10:29:16 -0700359void tls_sw_cancel_work_tx(struct tls_context *tls_ctx);
John Fastabend313ab002019-07-19 10:29:17 -0700360void tls_sw_release_resources_tx(struct sock *sk);
361void tls_sw_free_ctx_tx(struct tls_context *tls_ctx);
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300362void tls_sw_free_resources_rx(struct sock *sk);
Boris Pismenny39f56e12018-07-13 14:33:41 +0300363void tls_sw_release_resources_rx(struct sock *sk);
John Fastabend313ab002019-07-19 10:29:17 -0700364void tls_sw_free_ctx_rx(struct tls_context *tls_ctx);
Dave Watsonc46234e2018-03-22 10:10:35 -0700365int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
366 int nonblock, int flags, int *addr_len);
John Fastabend924ad652018-10-13 02:46:00 +0200367bool tls_sw_stream_read(const struct sock *sk);
Dave Watsonc46234e2018-03-22 10:10:35 -0700368ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
369 struct pipe_inode_info *pipe,
370 size_t len, unsigned int flags);
Dave Watson3c4d7552017-06-14 11:37:39 -0700371
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300372int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
373int tls_device_sendpage(struct sock *sk, struct page *page,
374 int offset, size_t size, int flags);
Vakul Garga42055e2018-09-21 09:46:13 +0530375int tls_tx_records(struct sock *sk, int flags);
Dave Watson3c4d7552017-06-14 11:37:39 -0700376
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300377struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300378 u32 seq, u64 *p_record_sn);
379
380static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
381{
382 return rec->len == 0;
383}
384
385static inline u32 tls_record_start_seq(struct tls_record_info *rec)
386{
387 return rec->end_seq - rec->len;
388}
389
Dave Watson3c4d7552017-06-14 11:37:39 -0700390int tls_push_sg(struct sock *sk, struct tls_context *ctx,
391 struct scatterlist *sg, u16 first_offset,
392 int flags);
Vakul Garga42055e2018-09-21 09:46:13 +0530393int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
394 int flags);
Jakub Kicinskic5daa6c2019-11-27 12:16:44 -0800395void tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
Vakul Garga42055e2018-09-21 09:46:13 +0530396
Vakul Garg2b794c42019-02-23 08:42:37 +0000397static inline struct tls_msg *tls_msg(struct sk_buff *skb)
398{
399 return (struct tls_msg *)strp_msg(skb);
400}
401
Boris Pismenny94850252019-02-27 17:38:03 +0200402static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
Dave Watson3c4d7552017-06-14 11:37:39 -0700403{
Boris Pismenny94850252019-02-27 17:38:03 +0200404 return !!ctx->partially_sent_record;
Dave Watson3c4d7552017-06-14 11:37:39 -0700405}
406
Dave Watson3c4d7552017-06-14 11:37:39 -0700407static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
408{
409 return tls_ctx->pending_open_record_frags;
410}
411
Vakul Garg9932a292018-09-24 15:35:56 +0530412static inline bool is_tx_ready(struct tls_sw_context_tx *ctx)
Vakul Garga42055e2018-09-21 09:46:13 +0530413{
414 struct tls_rec *rec;
Vakul Garga42055e2018-09-21 09:46:13 +0530415
Vakul Garg9932a292018-09-24 15:35:56 +0530416 rec = list_first_entry(&ctx->tx_list, struct tls_rec, list);
Vakul Garga42055e2018-09-21 09:46:13 +0530417 if (!rec)
418 return false;
419
Vakul Garg9932a292018-09-24 15:35:56 +0530420 return READ_ONCE(rec->tx_ready);
Vakul Garga42055e2018-09-21 09:46:13 +0530421}
422
Davide Caratti26811cc2019-08-30 12:25:49 +0200423static inline u16 tls_user_config(struct tls_context *ctx, bool tx)
424{
425 u16 config = tx ? ctx->tx_conf : ctx->rx_conf;
426
427 switch (config) {
428 case TLS_BASE:
429 return TLS_CONF_BASE;
430 case TLS_SW:
431 return TLS_CONF_SW;
432 case TLS_HW:
433 return TLS_CONF_HW;
434 case TLS_HW_RECORD:
435 return TLS_CONF_HW_RECORD;
436 }
437 return 0;
438}
439
Boris Pismenny4799ac82018-07-13 14:33:43 +0300440struct sk_buff *
441tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
442 struct sk_buff *skb);
443
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300444static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
445{
Boris Pismenny4799ac82018-07-13 14:33:43 +0300446#ifdef CONFIG_SOCK_VALIDATE_XMIT
Jakub Kicinskib4f47f32019-04-08 17:59:50 -0700447 return sk_fullsock(sk) &&
Boris Pismenny4799ac82018-07-13 14:33:43 +0300448 (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
449 &tls_validate_xmit_skb);
450#else
451 return false;
452#endif
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300453}
454
Dave Watsonf4a8e432018-03-22 10:10:15 -0700455static inline void tls_err_abort(struct sock *sk, int err)
Dave Watson3c4d7552017-06-14 11:37:39 -0700456{
Dave Watsonf4a8e432018-03-22 10:10:15 -0700457 sk->sk_err = err;
Dave Watson3c4d7552017-06-14 11:37:39 -0700458 sk->sk_error_report(sk);
459}
460
461static inline bool tls_bigint_increment(unsigned char *seq, int len)
462{
463 int i;
464
465 for (i = len - 1; i >= 0; i--) {
466 ++seq[i];
467 if (seq[i] != 0)
468 break;
469 }
470
471 return (i == -1);
472}
473
Vakul Garg4509de12019-02-14 07:11:35 +0000474static inline struct tls_context *tls_get_ctx(const struct sock *sk)
475{
476 struct inet_connection_sock *icsk = inet_csk(sk);
477
Jakub Kicinski15a7dea2019-08-30 12:25:47 +0200478 /* Use RCU on icsk_ulp_data only for sock diag code,
479 * TLS data path doesn't need rcu_dereference().
480 */
481 return (__force void *)icsk->icsk_ulp_data;
Vakul Garg4509de12019-02-14 07:11:35 +0000482}
483
Dave Watson3c4d7552017-06-14 11:37:39 -0700484static inline void tls_advance_record_sn(struct sock *sk,
Jakub Kicinskifb0f8862019-06-03 15:17:05 -0700485 struct tls_prot_info *prot,
486 struct cipher_context *ctx)
Dave Watson3c4d7552017-06-14 11:37:39 -0700487{
Vakul Garg4509de12019-02-14 07:11:35 +0000488 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
Dave Watsonf4a8e432018-03-22 10:10:15 -0700489 tls_err_abort(sk, EBADMSG);
Dave Watson130b3922019-01-30 21:58:31 +0000490
Jakub Kicinskifb0f8862019-06-03 15:17:05 -0700491 if (prot->version != TLS_1_3_VERSION)
Dave Watson130b3922019-01-30 21:58:31 +0000492 tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
Vakul Garg4509de12019-02-14 07:11:35 +0000493 prot->iv_size);
Dave Watson3c4d7552017-06-14 11:37:39 -0700494}
495
496static inline void tls_fill_prepend(struct tls_context *ctx,
497 char *buf,
498 size_t plaintext_len,
Dave Watson130b3922019-01-30 21:58:31 +0000499 unsigned char record_type,
500 int version)
Dave Watson3c4d7552017-06-14 11:37:39 -0700501{
Vakul Garg4509de12019-02-14 07:11:35 +0000502 struct tls_prot_info *prot = &ctx->prot_info;
503 size_t pkt_len, iv_size = prot->iv_size;
Dave Watson3c4d7552017-06-14 11:37:39 -0700504
Vakul Garg4509de12019-02-14 07:11:35 +0000505 pkt_len = plaintext_len + prot->tag_size;
Dave Watson130b3922019-01-30 21:58:31 +0000506 if (version != TLS_1_3_VERSION) {
507 pkt_len += iv_size;
508
509 memcpy(buf + TLS_NONCE_OFFSET,
510 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
511 }
Dave Watson3c4d7552017-06-14 11:37:39 -0700512
513 /* we cover nonce explicit here as well, so buf should be of
514 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
515 */
Dave Watson130b3922019-01-30 21:58:31 +0000516 buf[0] = version == TLS_1_3_VERSION ?
517 TLS_RECORD_TYPE_DATA : record_type;
518 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
519 buf[1] = TLS_1_2_VERSION_MINOR;
520 buf[2] = TLS_1_2_VERSION_MAJOR;
Dave Watson3c4d7552017-06-14 11:37:39 -0700521 /* we can use IV for nonce explicit according to spec */
522 buf[3] = pkt_len >> 8;
523 buf[4] = pkt_len & 0xFF;
Dave Watson3c4d7552017-06-14 11:37:39 -0700524}
525
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200526static inline void tls_make_aad(char *buf,
527 size_t size,
528 char *record_sequence,
529 int record_sequence_size,
Dave Watson130b3922019-01-30 21:58:31 +0000530 unsigned char record_type,
531 int version)
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200532{
Dave Watson130b3922019-01-30 21:58:31 +0000533 if (version != TLS_1_3_VERSION) {
534 memcpy(buf, record_sequence, record_sequence_size);
535 buf += 8;
536 } else {
537 size += TLS_CIPHER_AES_GCM_128_TAG_SIZE;
538 }
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200539
Dave Watson130b3922019-01-30 21:58:31 +0000540 buf[0] = version == TLS_1_3_VERSION ?
541 TLS_RECORD_TYPE_DATA : record_type;
542 buf[1] = TLS_1_2_VERSION_MAJOR;
543 buf[2] = TLS_1_2_VERSION_MINOR;
544 buf[3] = size >> 8;
545 buf[4] = size & 0xFF;
546}
547
548static inline void xor_iv_with_seq(int version, char *iv, char *seq)
549{
550 int i;
551
552 if (version == TLS_1_3_VERSION) {
553 for (i = 0; i < 8; i++)
554 iv[i + 4] ^= seq[i];
555 }
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200556}
557
Dave Watson3c4d7552017-06-14 11:37:39 -0700558
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300559static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
Dave Watson3c4d7552017-06-14 11:37:39 -0700560 const struct tls_context *tls_ctx)
561{
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300562 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
563}
564
565static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
566 const struct tls_context *tls_ctx)
567{
568 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
Dave Watson3c4d7552017-06-14 11:37:39 -0700569}
570
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300571static inline struct tls_offload_context_tx *
572tls_offload_ctx_tx(const struct tls_context *tls_ctx)
Dave Watson3c4d7552017-06-14 11:37:39 -0700573{
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300574 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
Dave Watson3c4d7552017-06-14 11:37:39 -0700575}
576
John Fastabend0608c692018-12-20 11:35:35 -0800577static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
578{
579 struct tls_context *ctx = tls_get_ctx(sk);
580
581 if (!ctx)
582 return false;
583 return !!tls_sw_ctx_tx(ctx);
584}
585
John Fastabende91de6a2020-05-29 16:06:59 -0700586static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
587{
588 struct tls_context *ctx = tls_get_ctx(sk);
589
590 if (!ctx)
591 return false;
592 return !!tls_sw_ctx_rx(ctx);
593}
594
Boris Pismenny7463d3a2019-02-27 17:38:04 +0200595void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
596void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
597
Boris Pismenny4799ac82018-07-13 14:33:43 +0300598static inline struct tls_offload_context_rx *
599tls_offload_ctx_rx(const struct tls_context *tls_ctx)
600{
601 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
602}
603
Jakub Kicinski2e361172019-06-05 14:11:39 -0700604#if IS_ENABLED(CONFIG_TLS_DEVICE)
605static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
606 enum tls_offload_ctx_dir direction)
607{
608 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
609 return tls_offload_ctx_tx(tls_ctx)->driver_state;
610 else
611 return tls_offload_ctx_rx(tls_ctx)->driver_state;
612}
613
614static inline void *
615tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
616{
617 return __tls_driver_ctx(tls_get_ctx(sk), direction);
618}
619#endif
620
Boris Pismennyed9b7642020-06-08 19:11:38 +0300621#define RESYNC_REQ BIT(0)
622#define RESYNC_REQ_ASYNC BIT(1)
Boris Pismenny4799ac82018-07-13 14:33:43 +0300623/* The TLS context is valid until sk_destruct is called */
624static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
625{
626 struct tls_context *tls_ctx = tls_get_ctx(sk);
627 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
628
Boris Pismennyed9b7642020-06-08 19:11:38 +0300629 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | RESYNC_REQ);
630}
631
632/* Log all TLS record header TCP sequences in [seq, seq+len] */
633static inline void
634tls_offload_rx_resync_async_request_start(struct sock *sk, __be32 seq, u16 len)
635{
636 struct tls_context *tls_ctx = tls_get_ctx(sk);
637 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
638
639 atomic64_set(&rx_ctx->resync_async->req, ((u64)ntohl(seq) << 32) |
640 (len << 16) | RESYNC_REQ | RESYNC_REQ_ASYNC);
641 rx_ctx->resync_async->loglen = 0;
642}
643
644static inline void
645tls_offload_rx_resync_async_request_end(struct sock *sk, __be32 seq)
646{
647 struct tls_context *tls_ctx = tls_get_ctx(sk);
648 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
649
650 atomic64_set(&rx_ctx->resync_async->req,
651 ((u64)ntohl(seq) << 32) | RESYNC_REQ);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300652}
653
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700654static inline void
655tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
656{
657 struct tls_context *tls_ctx = tls_get_ctx(sk);
658
659 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
660}
Boris Pismenny4799ac82018-07-13 14:33:43 +0300661
Jakub Kicinski50180072019-06-10 21:40:09 -0700662/* Driver's seq tracking has to be disabled until resync succeeded */
663static inline bool tls_offload_tx_resync_pending(struct sock *sk)
664{
665 struct tls_context *tls_ctx = tls_get_ctx(sk);
666 bool ret;
667
668 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
669 smp_mb__after_atomic();
670 return ret;
671}
672
Jakub Kicinskid26b6982019-10-04 16:19:24 -0700673int __net_init tls_proc_init(struct net *net);
674void __net_exit tls_proc_fini(struct net *net);
675
Dave Watson3c4d7552017-06-14 11:37:39 -0700676int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
677 unsigned char *record_type);
Boris Pismennydafb67f2018-07-13 14:33:40 +0300678int decrypt_skb(struct sock *sk, struct sk_buff *skb,
679 struct scatterlist *sgout);
Dirk van der Merweb9727d72019-06-05 14:11:40 -0700680struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
Dave Watson3c4d7552017-06-14 11:37:39 -0700681
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300682struct sk_buff *tls_validate_xmit_skb(struct sock *sk,
683 struct net_device *dev,
684 struct sk_buff *skb);
685
686int tls_sw_fallback_init(struct sock *sk,
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300687 struct tls_offload_context_tx *offload_ctx,
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300688 struct tls_crypto_info *crypto_info);
689
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700690#ifdef CONFIG_TLS_DEVICE
691void tls_device_init(void);
692void tls_device_cleanup(void);
Jakub Kicinski8d5a49e2019-12-17 14:12:01 -0800693void tls_device_sk_destruct(struct sock *sk);
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700694int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
695void tls_device_free_resources_tx(struct sock *sk);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300696int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300697void tls_device_offload_cleanup_rx(struct sock *sk);
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700698void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
Jakub Kicinski8538d292019-10-04 16:19:22 -0700699void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
Jakub Kicinski4de30a82019-10-06 21:09:30 -0700700int tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
701 struct sk_buff *skb, struct strp_msg *rxm);
Jakub Kicinski8d5a49e2019-12-17 14:12:01 -0800702
703static inline bool tls_is_sk_rx_device_offloaded(struct sock *sk)
704{
705 if (!sk_fullsock(sk) ||
706 smp_load_acquire(&sk->sk_destruct) != tls_device_sk_destruct)
707 return false;
708 return tls_get_ctx(sk)->rx_conf == TLS_HW;
709}
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700710#else
711static inline void tls_device_init(void) {}
712static inline void tls_device_cleanup(void) {}
Boris Pismenny4799ac82018-07-13 14:33:43 +0300713
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700714static inline int
715tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
716{
717 return -EOPNOTSUPP;
718}
719
720static inline void tls_device_free_resources_tx(struct sock *sk) {}
721
722static inline int
723tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
724{
725 return -EOPNOTSUPP;
726}
727
728static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
729static inline void
730tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
731
Jakub Kicinski4de30a82019-10-06 21:09:30 -0700732static inline int
733tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
734 struct sk_buff *skb, struct strp_msg *rxm)
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700735{
736 return 0;
737}
738#endif
Dave Watson3c4d7552017-06-14 11:37:39 -0700739#endif /* _TLS_OFFLOAD_H */