blob: 526cb2c3b724e7b3db8f8690235ffd2922df3e3b [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
Tianjia Zhang128cfb82021-09-28 14:28:43 +080069/* For CCM mode, the full 16-bytes of IV is made of '4' fields of given sizes.
Vakul Gargf295b3a2019-03-20 02:03:36 +000070 *
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
Tianjia Zhang128cfb82021-09-28 14:28:43 +080077#define TLS_SM4_CCM_IV_B0_BYTE 2
Vakul Gargf295b3a2019-03-20 02:03:36 +000078
Jakub Kicinskid26b6982019-10-04 16:19:24 -070079#define __TLS_INC_STATS(net, field) \
80 __SNMP_INC_STATS((net)->mib.tls_statistics, field)
81#define TLS_INC_STATS(net, field) \
82 SNMP_INC_STATS((net)->mib.tls_statistics, field)
Jakub Kicinskid26b6982019-10-04 16:19:24 -070083#define TLS_DEC_STATS(net, field) \
84 SNMP_DEC_STATS((net)->mib.tls_statistics, field)
85
Boris Pismenny4799ac82018-07-13 14:33:43 +030086enum {
87 TLS_BASE,
88 TLS_SW,
Boris Pismenny4799ac82018-07-13 14:33:43 +030089 TLS_HW,
Boris Pismenny4799ac82018-07-13 14:33:43 +030090 TLS_HW_RECORD,
91 TLS_NUM_CONFIG,
92};
93
Vakul Garga42055e2018-09-21 09:46:13 +053094/* TLS records are maintained in 'struct tls_rec'. It stores the memory pages
95 * allocated or mapped for each TLS record. After encryption, the records are
96 * stores in a linked list.
97 */
98struct tls_rec {
99 struct list_head list;
Vakul Garg9932a292018-09-24 15:35:56 +0530100 int tx_ready;
Vakul Garga42055e2018-09-21 09:46:13 +0530101 int tx_flags;
Dave Watson3c4d7552017-06-14 11:37:39 -0700102
Daniel Borkmannd829e9c2018-10-13 02:45:59 +0200103 struct sk_msg msg_plaintext;
104 struct sk_msg msg_encrypted;
Vakul Garga42055e2018-09-21 09:46:13 +0530105
Daniel Borkmannd829e9c2018-10-13 02:45:59 +0200106 /* AAD | msg_plaintext.sg.data | sg_tag */
107 struct scatterlist sg_aead_in[2];
108 /* AAD | msg_encrypted.sg.data (data contains overhead for hdr & iv & tag) */
109 struct scatterlist sg_aead_out[2];
Vakul Garga42055e2018-09-21 09:46:13 +0530110
Dave Watson130b3922019-01-30 21:58:31 +0000111 char content_type;
112 struct scatterlist sg_content_type;
113
Vakul Garga42055e2018-09-21 09:46:13 +0530114 char aad_space[TLS_AAD_SPACE_SIZE];
Vakul Gargf295b3a2019-03-20 02:03:36 +0000115 u8 iv_data[MAX_IV_SIZE];
Vakul Garga42055e2018-09-21 09:46:13 +0530116 struct aead_request aead_req;
117 u8 aead_req_ctx[];
118};
119
Vakul Garg2b794c42019-02-23 08:42:37 +0000120struct tls_msg {
121 struct strp_msg rxm;
122 u8 control;
123};
124
Vakul Garga42055e2018-09-21 09:46:13 +0530125struct tx_work {
126 struct delayed_work work;
127 struct sock *sk;
128};
129
130struct tls_sw_context_tx {
131 struct crypto_aead *aead_send;
132 struct crypto_wait async_wait;
133 struct tx_work tx_work;
134 struct tls_rec *open_rec;
Vakul Garg9932a292018-09-24 15:35:56 +0530135 struct list_head tx_list;
Vakul Garga42055e2018-09-21 09:46:13 +0530136 atomic_t encrypt_pending;
Vinay Kumar Yadav0cada332020-05-23 01:40:31 +0530137 /* protect crypto_wait with encrypt_pending */
138 spinlock_t encrypt_compl_lock;
Vakul Garga42055e2018-09-21 09:46:13 +0530139 int async_notify;
Jakub Kicinski5c5458e2019-10-06 21:09:31 -0700140 u8 async_capable:1;
Vakul Garga42055e2018-09-21 09:46:13 +0530141
142#define BIT_TX_SCHEDULED 0
John Fastabendf87e62d2019-07-19 10:29:16 -0700143#define BIT_TX_CLOSING 1
Vakul Garga42055e2018-09-21 09:46:13 +0530144 unsigned long tx_bitmask;
Dave Watson3c4d7552017-06-14 11:37:39 -0700145};
146
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300147struct tls_sw_context_rx {
148 struct crypto_aead *aead_recv;
149 struct crypto_wait async_wait;
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300150 struct strparser strp;
Vakul Garg692d7b52019-01-16 10:40:16 +0000151 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300152 void (*saved_data_ready)(struct sock *sk);
John Fastabend924ad652018-10-13 02:46:00 +0200153
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300154 struct sk_buff *recv_pkt;
155 u8 control;
Jakub Kicinski5c5458e2019-10-06 21:09:31 -0700156 u8 async_capable:1;
Jakub Kicinskibc76e5b2019-10-06 21:09:32 -0700157 u8 decrypted:1;
Vakul Garg94524d82018-08-29 15:26:55 +0530158 atomic_t decrypt_pending;
Vinay Kumar Yadav0cada332020-05-23 01:40:31 +0530159 /* protect crypto_wait with decrypt_pending*/
160 spinlock_t decrypt_compl_lock;
Vakul Garg94524d82018-08-29 15:26:55 +0530161 bool async_notify;
162};
163
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300164struct tls_record_info {
165 struct list_head list;
166 u32 end_seq;
167 int len;
168 int num_frags;
169 skb_frag_t frags[MAX_SKB_FRAGS];
170};
171
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300172struct tls_offload_context_tx {
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300173 struct crypto_aead *aead_send;
174 spinlock_t lock; /* protects records list */
175 struct list_head records_list;
176 struct tls_record_info *open_record;
177 struct tls_record_info *retransmit_hint;
178 u64 hint_record_sn;
179 u64 unacked_record_sn;
180
181 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
182 void (*sk_destruct)(struct sock *sk);
Jakub Kicinski2e361172019-06-05 14:11:39 -0700183 u8 driver_state[] __aligned(8);
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300184 /* The TLS layer reserves room for driver specific state
185 * Currently the belief is that there is not enough
186 * driver specific state to justify another layer of indirection
187 */
Jakub Kicinski2d6b51c2019-06-05 14:11:38 -0700188#define TLS_DRIVER_STATE_SIZE_TX 16
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300189};
190
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300191#define TLS_OFFLOAD_CONTEXT_SIZE_TX \
Jakub Kicinski2e361172019-06-05 14:11:39 -0700192 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300193
Jakub Kicinskie52972c2019-06-04 12:00:12 -0700194enum tls_context_flags {
Maxim Mikityanskiyc55dcdd2021-06-01 15:08:00 +0300195 /* tls_device_down was called after the netdev went down, device state
196 * was released, and kTLS works in software, even though rx_conf is
197 * still TLS_HW (needed for transition).
198 */
199 TLS_RX_DEV_DEGRADED = 0,
Jakub Kicinski50180072019-06-10 21:40:09 -0700200 /* Unlike RX where resync is driven entirely by the core in TX only
201 * the driver knows when things went out of sync, so we need the flag
202 * to be atomic.
203 */
204 TLS_TX_SYNC_SCHED = 1,
Maxim Mikityanskiy025cc2f2020-11-25 14:18:10 -0800205 /* tls_dev_del was called for the RX side, device state was released,
206 * but tls_ctx->netdev might still be kept, because TX-side driver
207 * resources might not be released yet. Used to prevent the second
208 * tls_dev_del call in tls_device_down if it happens simultaneously.
209 */
210 TLS_RX_DEV_CLOSED = 2,
Jakub Kicinskie52972c2019-06-04 12:00:12 -0700211};
212
Dave Watsondbe42552018-03-22 10:10:06 -0700213struct cipher_context {
Dave Watsondbe42552018-03-22 10:10:06 -0700214 char *iv;
Dave Watsondbe42552018-03-22 10:10:06 -0700215 char *rec_seq;
216};
217
Sabrina Dubroca86029d12018-09-12 17:44:42 +0200218union tls_crypto_context {
219 struct tls_crypto_info info;
Dave Watsonfb99bce2019-01-30 21:58:05 +0000220 union {
221 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
222 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
Vadim Fedorenko923c40c2020-11-24 18:24:47 +0300223 struct tls12_crypto_info_chacha20_poly1305 chacha20_poly1305;
Tianjia Zhang39d8fb92021-10-25 21:04:39 +0800224 struct tls12_crypto_info_sm4_gcm sm4_gcm;
225 struct tls12_crypto_info_sm4_ccm sm4_ccm;
Dave Watsonfb99bce2019-01-30 21:58:05 +0000226 };
Sabrina Dubroca86029d12018-09-12 17:44:42 +0200227};
228
Vakul Garg4509de12019-02-14 07:11:35 +0000229struct tls_prot_info {
230 u16 version;
231 u16 cipher_type;
232 u16 prepend_size;
233 u16 tag_size;
234 u16 overhead_size;
235 u16 iv_size;
Vakul Gargf295b3a2019-03-20 02:03:36 +0000236 u16 salt_size;
Vakul Garg4509de12019-02-14 07:11:35 +0000237 u16 rec_seq_size;
238 u16 aad_size;
239 u16 tail_size;
240};
241
Dave Watson3c4d7552017-06-14 11:37:39 -0700242struct tls_context {
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700243 /* read-only cache line */
Vakul Garg4509de12019-02-14 07:11:35 +0000244 struct tls_prot_info prot_info;
245
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300246 u8 tx_conf:3;
247 u8 rx_conf:3;
Ilya Lesokhin6d882072017-11-13 10:22:45 +0200248
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700249 int (*push_pending_record)(struct sock *sk, int flags);
250 void (*sk_write_space)(struct sock *sk);
251
252 void *priv_ctx_tx;
253 void *priv_ctx_rx;
254
255 struct net_device *netdev;
256
257 /* rw cache line */
Dave Watsondbe42552018-03-22 10:10:06 -0700258 struct cipher_context tx;
Dave Watsonc46234e2018-03-22 10:10:35 -0700259 struct cipher_context rx;
Dave Watson3c4d7552017-06-14 11:37:39 -0700260
261 struct scatterlist *partially_sent_record;
262 u16 partially_sent_offset;
Vakul Garga42055e2018-09-21 09:46:13 +0530263
Dave Watsonc212d2c2018-05-01 13:05:39 -0700264 bool in_tcp_sendpages;
Daniel Borkmannd829e9c2018-10-13 02:45:59 +0200265 bool pending_open_record_frags;
Jakub Kicinski79ffe602019-11-05 14:24:35 -0800266
267 struct mutex tx_lock; /* protects partially_sent_* fields and
268 * per-type TX fields
269 */
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700270 unsigned long flags;
Dave Watson3c4d7552017-06-14 11:37:39 -0700271
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700272 /* cache cold stuff */
John Fastabend32857cf2019-07-19 10:29:18 -0700273 struct proto *sk_proto;
Maxim Mikityanskiyc55dcdd2021-06-01 15:08:00 +0300274 struct sock *sk;
John Fastabend32857cf2019-07-19 10:29:18 -0700275
Boris Pismenny4799ac82018-07-13 14:33:43 +0300276 void (*sk_destruct)(struct sock *sk);
Jakub Kicinskif0aaa2c2019-06-03 15:17:04 -0700277
278 union tls_crypto_context crypto_send;
279 union tls_crypto_context crypto_recv;
280
281 struct list_head list;
282 refcount_t refcount;
Jakub Kicinski15a7dea2019-08-30 12:25:47 +0200283 struct rcu_head rcu;
Dave Watson3c4d7552017-06-14 11:37:39 -0700284};
285
Jakub Kicinskida68b4a2019-04-25 12:32:03 -0700286enum tls_offload_ctx_dir {
287 TLS_OFFLOAD_CTX_DIR_RX,
288 TLS_OFFLOAD_CTX_DIR_TX,
289};
290
291struct tlsdev_ops {
292 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
293 enum tls_offload_ctx_dir direction,
294 struct tls_crypto_info *crypto_info,
295 u32 start_offload_tcp_sn);
296 void (*tls_dev_del)(struct net_device *netdev,
297 struct tls_context *ctx,
298 enum tls_offload_ctx_dir direction);
Dirk van der Merweb5d9a832019-07-08 19:53:13 -0700299 int (*tls_dev_resync)(struct net_device *netdev,
300 struct sock *sk, u32 seq, u8 *rcd_sn,
301 enum tls_offload_ctx_dir direction);
Jakub Kicinskida68b4a2019-04-25 12:32:03 -0700302};
303
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700304enum tls_offload_sync_type {
305 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
306 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
Boris Pismennyed9b7642020-06-08 19:11:38 +0300307 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC = 2,
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700308};
309
310#define TLS_DEVICE_RESYNC_NH_START_IVAL 2
311#define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
312
Boris Pismennyed9b7642020-06-08 19:11:38 +0300313#define TLS_DEVICE_RESYNC_ASYNC_LOGMAX 13
314struct tls_offload_resync_async {
315 atomic64_t req;
Tariq Toukan138559b2020-11-15 15:14:48 +0200316 u16 loglen;
317 u16 rcd_delta;
Boris Pismennyed9b7642020-06-08 19:11:38 +0300318 u32 log[TLS_DEVICE_RESYNC_ASYNC_LOGMAX];
319};
320
Boris Pismenny4799ac82018-07-13 14:33:43 +0300321struct tls_offload_context_rx {
322 /* sw must be the first member of tls_offload_context_rx */
323 struct tls_sw_context_rx sw;
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700324 enum tls_offload_sync_type resync_type;
325 /* this member is set regardless of resync_type, to avoid branches */
326 u8 resync_nh_reset:1;
327 /* CORE_NEXT_HINT-only member, but use the hole here */
328 u8 resync_nh_do_now:1;
329 union {
330 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
331 struct {
332 atomic64_t resync_req;
333 };
334 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
335 struct {
336 u32 decrypted_failed;
337 u32 decrypted_tgt;
338 } resync_nh;
Boris Pismennyed9b7642020-06-08 19:11:38 +0300339 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC */
340 struct {
341 struct tls_offload_resync_async *resync_async;
342 };
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700343 };
Jakub Kicinski2e361172019-06-05 14:11:39 -0700344 u8 driver_state[] __aligned(8);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300345 /* The TLS layer reserves room for driver specific state
346 * Currently the belief is that there is not enough
347 * driver specific state to justify another layer of indirection
348 */
Jakub Kicinski2d6b51c2019-06-05 14:11:38 -0700349#define TLS_DRIVER_STATE_SIZE_RX 8
Boris Pismenny4799ac82018-07-13 14:33:43 +0300350};
351
352#define TLS_OFFLOAD_CONTEXT_SIZE_RX \
Jakub Kicinski2e361172019-06-05 14:11:39 -0700353 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
Boris Pismenny4799ac82018-07-13 14:33:43 +0300354
Jakub Kicinski08700da2019-10-03 11:18:57 -0700355struct tls_context *tls_ctx_create(struct sock *sk);
Jakub Kicinski15a7dea2019-08-30 12:25:47 +0200356void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
Jakub Kicinski08700da2019-10-03 11:18:57 -0700357void update_sk_prot(struct sock *sk, struct tls_context *ctx);
358
Dave Watson3c4d7552017-06-14 11:37:39 -0700359int wait_on_pending_writer(struct sock *sk, long *timeo);
360int tls_sk_query(struct sock *sk, int optname, char __user *optval,
361 int __user *optlen);
362int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
363 unsigned int optlen);
Daniel Jordanda353fac2021-10-27 17:59:20 -0400364void tls_err_abort(struct sock *sk, int err);
Dave Watson3c4d7552017-06-14 11:37:39 -0700365
Dave Watsonc46234e2018-03-22 10:10:35 -0700366int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
Jakub Kicinski318892a2019-07-19 10:29:14 -0700367void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
John Fastabend313ab002019-07-19 10:29:17 -0700368void tls_sw_strparser_done(struct tls_context *tls_ctx);
Dave Watson3c4d7552017-06-14 11:37:39 -0700369int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
Willem de Bruijnd4ffb022019-11-18 10:40:51 -0500370int tls_sw_sendpage_locked(struct sock *sk, struct page *page,
371 int offset, size_t size, int flags);
Dave Watson3c4d7552017-06-14 11:37:39 -0700372int tls_sw_sendpage(struct sock *sk, struct page *page,
373 int offset, size_t size, int flags);
John Fastabendf87e62d2019-07-19 10:29:16 -0700374void tls_sw_cancel_work_tx(struct tls_context *tls_ctx);
John Fastabend313ab002019-07-19 10:29:17 -0700375void tls_sw_release_resources_tx(struct sock *sk);
376void tls_sw_free_ctx_tx(struct tls_context *tls_ctx);
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300377void tls_sw_free_resources_rx(struct sock *sk);
Boris Pismenny39f56e12018-07-13 14:33:41 +0300378void tls_sw_release_resources_rx(struct sock *sk);
John Fastabend313ab002019-07-19 10:29:17 -0700379void tls_sw_free_ctx_rx(struct tls_context *tls_ctx);
Dave Watsonc46234e2018-03-22 10:10:35 -0700380int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
381 int nonblock, int flags, int *addr_len);
Cong Wang7b50ecf2021-10-08 13:33:03 -0700382bool tls_sw_sock_is_readable(struct sock *sk);
Dave Watsonc46234e2018-03-22 10:10:35 -0700383ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
384 struct pipe_inode_info *pipe,
385 size_t len, unsigned int flags);
Dave Watson3c4d7552017-06-14 11:37:39 -0700386
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300387int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
388int tls_device_sendpage(struct sock *sk, struct page *page,
389 int offset, size_t size, int flags);
Vakul Garga42055e2018-09-21 09:46:13 +0530390int tls_tx_records(struct sock *sk, int flags);
Dave Watson3c4d7552017-06-14 11:37:39 -0700391
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300392struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300393 u32 seq, u64 *p_record_sn);
394
395static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
396{
397 return rec->len == 0;
398}
399
400static inline u32 tls_record_start_seq(struct tls_record_info *rec)
401{
402 return rec->end_seq - rec->len;
403}
404
Dave Watson3c4d7552017-06-14 11:37:39 -0700405int tls_push_sg(struct sock *sk, struct tls_context *ctx,
406 struct scatterlist *sg, u16 first_offset,
407 int flags);
Vakul Garga42055e2018-09-21 09:46:13 +0530408int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
409 int flags);
Jakub Kicinskic5daa6c2019-11-27 12:16:44 -0800410void tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
Vakul Garga42055e2018-09-21 09:46:13 +0530411
Vakul Garg2b794c42019-02-23 08:42:37 +0000412static inline struct tls_msg *tls_msg(struct sk_buff *skb)
413{
414 return (struct tls_msg *)strp_msg(skb);
415}
416
Boris Pismenny94850252019-02-27 17:38:03 +0200417static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
Dave Watson3c4d7552017-06-14 11:37:39 -0700418{
Boris Pismenny94850252019-02-27 17:38:03 +0200419 return !!ctx->partially_sent_record;
Dave Watson3c4d7552017-06-14 11:37:39 -0700420}
421
Dave Watson3c4d7552017-06-14 11:37:39 -0700422static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
423{
424 return tls_ctx->pending_open_record_frags;
425}
426
Vakul Garg9932a292018-09-24 15:35:56 +0530427static inline bool is_tx_ready(struct tls_sw_context_tx *ctx)
Vakul Garga42055e2018-09-21 09:46:13 +0530428{
429 struct tls_rec *rec;
Vakul Garga42055e2018-09-21 09:46:13 +0530430
Vakul Garg9932a292018-09-24 15:35:56 +0530431 rec = list_first_entry(&ctx->tx_list, struct tls_rec, list);
Vakul Garga42055e2018-09-21 09:46:13 +0530432 if (!rec)
433 return false;
434
Vakul Garg9932a292018-09-24 15:35:56 +0530435 return READ_ONCE(rec->tx_ready);
Vakul Garga42055e2018-09-21 09:46:13 +0530436}
437
Davide Caratti26811cc2019-08-30 12:25:49 +0200438static inline u16 tls_user_config(struct tls_context *ctx, bool tx)
439{
440 u16 config = tx ? ctx->tx_conf : ctx->rx_conf;
441
442 switch (config) {
443 case TLS_BASE:
444 return TLS_CONF_BASE;
445 case TLS_SW:
446 return TLS_CONF_SW;
447 case TLS_HW:
448 return TLS_CONF_HW;
449 case TLS_HW_RECORD:
450 return TLS_CONF_HW_RECORD;
451 }
452 return 0;
453}
454
Boris Pismenny4799ac82018-07-13 14:33:43 +0300455struct sk_buff *
456tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
457 struct sk_buff *skb);
Maxim Mikityanskiyc55dcdd2021-06-01 15:08:00 +0300458struct sk_buff *
459tls_validate_xmit_skb_sw(struct sock *sk, struct net_device *dev,
460 struct sk_buff *skb);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300461
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300462static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
463{
Boris Pismenny4799ac82018-07-13 14:33:43 +0300464#ifdef CONFIG_SOCK_VALIDATE_XMIT
Jakub Kicinskib4f47f32019-04-08 17:59:50 -0700465 return sk_fullsock(sk) &&
Boris Pismenny4799ac82018-07-13 14:33:43 +0300466 (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
467 &tls_validate_xmit_skb);
468#else
469 return false;
470#endif
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300471}
472
Dave Watson3c4d7552017-06-14 11:37:39 -0700473static inline bool tls_bigint_increment(unsigned char *seq, int len)
474{
475 int i;
476
477 for (i = len - 1; i >= 0; i--) {
478 ++seq[i];
479 if (seq[i] != 0)
480 break;
481 }
482
483 return (i == -1);
484}
485
Tariq Toukan138559b2020-11-15 15:14:48 +0200486static inline void tls_bigint_subtract(unsigned char *seq, int n)
487{
488 u64 rcd_sn;
489 __be64 *p;
490
491 BUILD_BUG_ON(TLS_MAX_REC_SEQ_SIZE != 8);
492
493 p = (__be64 *)seq;
494 rcd_sn = be64_to_cpu(*p);
495 *p = cpu_to_be64(rcd_sn - n);
496}
497
Vakul Garg4509de12019-02-14 07:11:35 +0000498static inline struct tls_context *tls_get_ctx(const struct sock *sk)
499{
500 struct inet_connection_sock *icsk = inet_csk(sk);
501
Jakub Kicinski15a7dea2019-08-30 12:25:47 +0200502 /* Use RCU on icsk_ulp_data only for sock diag code,
503 * TLS data path doesn't need rcu_dereference().
504 */
505 return (__force void *)icsk->icsk_ulp_data;
Vakul Garg4509de12019-02-14 07:11:35 +0000506}
507
Dave Watson3c4d7552017-06-14 11:37:39 -0700508static inline void tls_advance_record_sn(struct sock *sk,
Jakub Kicinskifb0f8862019-06-03 15:17:05 -0700509 struct tls_prot_info *prot,
510 struct cipher_context *ctx)
Dave Watson3c4d7552017-06-14 11:37:39 -0700511{
Vakul Garg4509de12019-02-14 07:11:35 +0000512 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
Daniel Jordanda353fac2021-10-27 17:59:20 -0400513 tls_err_abort(sk, -EBADMSG);
Dave Watson130b3922019-01-30 21:58:31 +0000514
Vadim Fedorenkoa6acbe62020-11-24 18:24:48 +0300515 if (prot->version != TLS_1_3_VERSION &&
516 prot->cipher_type != TLS_CIPHER_CHACHA20_POLY1305)
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300517 tls_bigint_increment(ctx->iv + prot->salt_size,
Vakul Garg4509de12019-02-14 07:11:35 +0000518 prot->iv_size);
Dave Watson3c4d7552017-06-14 11:37:39 -0700519}
520
521static inline void tls_fill_prepend(struct tls_context *ctx,
522 char *buf,
523 size_t plaintext_len,
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300524 unsigned char record_type)
Dave Watson3c4d7552017-06-14 11:37:39 -0700525{
Vakul Garg4509de12019-02-14 07:11:35 +0000526 struct tls_prot_info *prot = &ctx->prot_info;
527 size_t pkt_len, iv_size = prot->iv_size;
Dave Watson3c4d7552017-06-14 11:37:39 -0700528
Vakul Garg4509de12019-02-14 07:11:35 +0000529 pkt_len = plaintext_len + prot->tag_size;
Vadim Fedorenkoa6acbe62020-11-24 18:24:48 +0300530 if (prot->version != TLS_1_3_VERSION &&
531 prot->cipher_type != TLS_CIPHER_CHACHA20_POLY1305) {
Dave Watson130b3922019-01-30 21:58:31 +0000532 pkt_len += iv_size;
533
534 memcpy(buf + TLS_NONCE_OFFSET,
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300535 ctx->tx.iv + prot->salt_size, iv_size);
Dave Watson130b3922019-01-30 21:58:31 +0000536 }
Dave Watson3c4d7552017-06-14 11:37:39 -0700537
538 /* we cover nonce explicit here as well, so buf should be of
539 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
540 */
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300541 buf[0] = prot->version == TLS_1_3_VERSION ?
Dave Watson130b3922019-01-30 21:58:31 +0000542 TLS_RECORD_TYPE_DATA : record_type;
543 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
544 buf[1] = TLS_1_2_VERSION_MINOR;
545 buf[2] = TLS_1_2_VERSION_MAJOR;
Dave Watson3c4d7552017-06-14 11:37:39 -0700546 /* we can use IV for nonce explicit according to spec */
547 buf[3] = pkt_len >> 8;
548 buf[4] = pkt_len & 0xFF;
Dave Watson3c4d7552017-06-14 11:37:39 -0700549}
550
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200551static inline void tls_make_aad(char *buf,
552 size_t size,
553 char *record_sequence,
Dave Watson130b3922019-01-30 21:58:31 +0000554 unsigned char record_type,
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300555 struct tls_prot_info *prot)
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200556{
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300557 if (prot->version != TLS_1_3_VERSION) {
558 memcpy(buf, record_sequence, prot->rec_seq_size);
Dave Watson130b3922019-01-30 21:58:31 +0000559 buf += 8;
560 } else {
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300561 size += prot->tag_size;
Dave Watson130b3922019-01-30 21:58:31 +0000562 }
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200563
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300564 buf[0] = prot->version == TLS_1_3_VERSION ?
Dave Watson130b3922019-01-30 21:58:31 +0000565 TLS_RECORD_TYPE_DATA : record_type;
566 buf[1] = TLS_1_2_VERSION_MAJOR;
567 buf[2] = TLS_1_2_VERSION_MINOR;
568 buf[3] = size >> 8;
569 buf[4] = size & 0xFF;
570}
571
Vadim Fedorenko6942a282020-11-24 18:24:46 +0300572static inline void xor_iv_with_seq(struct tls_prot_info *prot, char *iv, char *seq)
Dave Watson130b3922019-01-30 21:58:31 +0000573{
574 int i;
575
Vadim Fedorenkoa6acbe62020-11-24 18:24:48 +0300576 if (prot->version == TLS_1_3_VERSION ||
577 prot->cipher_type == TLS_CIPHER_CHACHA20_POLY1305) {
Dave Watson130b3922019-01-30 21:58:31 +0000578 for (i = 0; i < 8; i++)
579 iv[i + 4] ^= seq[i];
580 }
Ilya Lesokhin213ef6e2017-11-13 10:22:47 +0200581}
582
Dave Watson3c4d7552017-06-14 11:37:39 -0700583
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300584static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
Dave Watson3c4d7552017-06-14 11:37:39 -0700585 const struct tls_context *tls_ctx)
586{
Boris Pismennyf66de3e2018-04-30 10:16:15 +0300587 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
588}
589
590static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
591 const struct tls_context *tls_ctx)
592{
593 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
Dave Watson3c4d7552017-06-14 11:37:39 -0700594}
595
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300596static inline struct tls_offload_context_tx *
597tls_offload_ctx_tx(const struct tls_context *tls_ctx)
Dave Watson3c4d7552017-06-14 11:37:39 -0700598{
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300599 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
Dave Watson3c4d7552017-06-14 11:37:39 -0700600}
601
John Fastabend0608c692018-12-20 11:35:35 -0800602static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
603{
604 struct tls_context *ctx = tls_get_ctx(sk);
605
606 if (!ctx)
607 return false;
608 return !!tls_sw_ctx_tx(ctx);
609}
610
John Fastabende91de6a2020-05-29 16:06:59 -0700611static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
612{
613 struct tls_context *ctx = tls_get_ctx(sk);
614
615 if (!ctx)
616 return false;
617 return !!tls_sw_ctx_rx(ctx);
618}
619
Boris Pismenny7463d3a2019-02-27 17:38:04 +0200620void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
621void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
622
Boris Pismenny4799ac82018-07-13 14:33:43 +0300623static inline struct tls_offload_context_rx *
624tls_offload_ctx_rx(const struct tls_context *tls_ctx)
625{
626 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
627}
628
Jakub Kicinski2e361172019-06-05 14:11:39 -0700629#if IS_ENABLED(CONFIG_TLS_DEVICE)
630static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
631 enum tls_offload_ctx_dir direction)
632{
633 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
634 return tls_offload_ctx_tx(tls_ctx)->driver_state;
635 else
636 return tls_offload_ctx_rx(tls_ctx)->driver_state;
637}
638
639static inline void *
640tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
641{
642 return __tls_driver_ctx(tls_get_ctx(sk), direction);
643}
644#endif
645
Boris Pismennyed9b7642020-06-08 19:11:38 +0300646#define RESYNC_REQ BIT(0)
647#define RESYNC_REQ_ASYNC BIT(1)
Boris Pismenny4799ac82018-07-13 14:33:43 +0300648/* The TLS context is valid until sk_destruct is called */
649static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
650{
651 struct tls_context *tls_ctx = tls_get_ctx(sk);
652 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
653
Boris Pismennyed9b7642020-06-08 19:11:38 +0300654 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | RESYNC_REQ);
655}
656
657/* Log all TLS record header TCP sequences in [seq, seq+len] */
658static inline void
659tls_offload_rx_resync_async_request_start(struct sock *sk, __be32 seq, u16 len)
660{
661 struct tls_context *tls_ctx = tls_get_ctx(sk);
662 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
663
664 atomic64_set(&rx_ctx->resync_async->req, ((u64)ntohl(seq) << 32) |
Colin Ian Kinga6ed3eb2020-06-30 15:27:46 +0100665 ((u64)len << 16) | RESYNC_REQ | RESYNC_REQ_ASYNC);
Boris Pismennyed9b7642020-06-08 19:11:38 +0300666 rx_ctx->resync_async->loglen = 0;
Tariq Toukan138559b2020-11-15 15:14:48 +0200667 rx_ctx->resync_async->rcd_delta = 0;
Boris Pismennyed9b7642020-06-08 19:11:38 +0300668}
669
670static inline void
671tls_offload_rx_resync_async_request_end(struct sock *sk, __be32 seq)
672{
673 struct tls_context *tls_ctx = tls_get_ctx(sk);
674 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
675
676 atomic64_set(&rx_ctx->resync_async->req,
677 ((u64)ntohl(seq) << 32) | RESYNC_REQ);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300678}
679
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700680static inline void
681tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
682{
683 struct tls_context *tls_ctx = tls_get_ctx(sk);
684
685 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
686}
Boris Pismenny4799ac82018-07-13 14:33:43 +0300687
Jakub Kicinski50180072019-06-10 21:40:09 -0700688/* Driver's seq tracking has to be disabled until resync succeeded */
689static inline bool tls_offload_tx_resync_pending(struct sock *sk)
690{
691 struct tls_context *tls_ctx = tls_get_ctx(sk);
692 bool ret;
693
694 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
695 smp_mb__after_atomic();
696 return ret;
697}
698
Jakub Kicinskid26b6982019-10-04 16:19:24 -0700699int __net_init tls_proc_init(struct net *net);
700void __net_exit tls_proc_fini(struct net *net);
701
Dave Watson3c4d7552017-06-14 11:37:39 -0700702int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
703 unsigned char *record_type);
Boris Pismennydafb67f2018-07-13 14:33:40 +0300704int decrypt_skb(struct sock *sk, struct sk_buff *skb,
705 struct scatterlist *sgout);
Dirk van der Merweb9727d72019-06-05 14:11:40 -0700706struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
Dave Watson3c4d7552017-06-14 11:37:39 -0700707
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300708int tls_sw_fallback_init(struct sock *sk,
Boris Pismennyd80a1b9d2018-07-13 14:33:39 +0300709 struct tls_offload_context_tx *offload_ctx,
Ilya Lesokhine8f69792018-04-30 10:16:16 +0300710 struct tls_crypto_info *crypto_info);
711
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700712#ifdef CONFIG_TLS_DEVICE
713void tls_device_init(void);
714void tls_device_cleanup(void);
Jakub Kicinski8d5a49e2019-12-17 14:12:01 -0800715void tls_device_sk_destruct(struct sock *sk);
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700716int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
717void tls_device_free_resources_tx(struct sock *sk);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300718int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
Boris Pismenny4799ac82018-07-13 14:33:43 +0300719void tls_device_offload_cleanup_rx(struct sock *sk);
Jakub Kicinskif953d33b2019-06-10 21:40:02 -0700720void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
Jakub Kicinski8538d292019-10-04 16:19:22 -0700721void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
Jakub Kicinski4de30a82019-10-06 21:09:30 -0700722int tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
723 struct sk_buff *skb, struct strp_msg *rxm);
Jakub Kicinski8d5a49e2019-12-17 14:12:01 -0800724
725static inline bool tls_is_sk_rx_device_offloaded(struct sock *sk)
726{
727 if (!sk_fullsock(sk) ||
728 smp_load_acquire(&sk->sk_destruct) != tls_device_sk_destruct)
729 return false;
730 return tls_get_ctx(sk)->rx_conf == TLS_HW;
731}
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700732#else
733static inline void tls_device_init(void) {}
734static inline void tls_device_cleanup(void) {}
Boris Pismenny4799ac82018-07-13 14:33:43 +0300735
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700736static inline int
737tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
738{
739 return -EOPNOTSUPP;
740}
741
742static inline void tls_device_free_resources_tx(struct sock *sk) {}
743
744static inline int
745tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
746{
747 return -EOPNOTSUPP;
748}
749
750static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
751static inline void
752tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
753
Jakub Kicinski4de30a82019-10-06 21:09:30 -0700754static inline int
755tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
756 struct sk_buff *skb, struct strp_msg *rxm)
Jakub Kicinskibe2fbc12019-09-02 21:31:05 -0700757{
758 return 0;
759}
760#endif
Dave Watson3c4d7552017-06-14 11:37:39 -0700761#endif /* _TLS_OFFLOAD_H */