blob: 697df45c0bceee3864ef441280a83dbb69dfe3ef [file] [log] [blame]
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001/*
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>
38#include <asm/byteorder.h>
39#include <linux/crypto.h>
40#include <linux/socket.h>
41#include <linux/tcp.h>
David Brazdil0f672f62019-12-10 10:32:29 +000042#include <linux/skmsg.h>
43#include <linux/mutex.h>
44#include <linux/netdevice.h>
45#include <linux/rcupdate.h>
46
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000047#include <net/tcp.h>
48#include <net/strparser.h>
David Brazdil0f672f62019-12-10 10:32:29 +000049#include <crypto/aead.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000050#include <uapi/linux/tls.h>
51
52
53/* Maximum data size carried in a TLS record */
54#define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
55
56#define TLS_HEADER_SIZE 5
57#define TLS_NONCE_OFFSET TLS_HEADER_SIZE
58
59#define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
60
61#define TLS_RECORD_TYPE_DATA 0x17
62
63#define TLS_AAD_SPACE_SIZE 13
64#define TLS_DEVICE_NAME_MAX 32
65
David Brazdil0f672f62019-12-10 10:32:29 +000066#define MAX_IV_SIZE 16
67#define TLS_MAX_REC_SEQ_SIZE 8
68
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
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000078/*
79 * This structure defines the routines for Inline TLS driver.
80 * The following routines are optional and filled with a
81 * null pointer if not defined.
82 *
83 * @name: Its the name of registered Inline tls device
84 * @dev_list: Inline tls device list
85 * int (*feature)(struct tls_device *device);
86 * Called to return Inline TLS driver capability
87 *
88 * int (*hash)(struct tls_device *device, struct sock *sk);
89 * This function sets Inline driver for listen and program
90 * device specific functioanlity as required
91 *
92 * void (*unhash)(struct tls_device *device, struct sock *sk);
93 * This function cleans listen state set by Inline TLS driver
David Brazdil0f672f62019-12-10 10:32:29 +000094 *
95 * void (*release)(struct kref *kref);
96 * Release the registered device and allocated resources
97 * @kref: Number of reference to tls_device
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000098 */
99struct tls_device {
100 char name[TLS_DEVICE_NAME_MAX];
101 struct list_head dev_list;
102 int (*feature)(struct tls_device *device);
103 int (*hash)(struct tls_device *device, struct sock *sk);
104 void (*unhash)(struct tls_device *device, struct sock *sk);
David Brazdil0f672f62019-12-10 10:32:29 +0000105 void (*release)(struct kref *kref);
106 struct kref kref;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000107};
108
109enum {
110 TLS_BASE,
111 TLS_SW,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000112 TLS_HW,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000113 TLS_HW_RECORD,
114 TLS_NUM_CONFIG,
115};
116
David Brazdil0f672f62019-12-10 10:32:29 +0000117/* TLS records are maintained in 'struct tls_rec'. It stores the memory pages
118 * allocated or mapped for each TLS record. After encryption, the records are
119 * stores in a linked list.
120 */
121struct tls_rec {
122 struct list_head list;
123 int tx_ready;
124 int tx_flags;
125
126 struct sk_msg msg_plaintext;
127 struct sk_msg msg_encrypted;
128
129 /* AAD | msg_plaintext.sg.data | sg_tag */
130 struct scatterlist sg_aead_in[2];
131 /* AAD | msg_encrypted.sg.data (data contains overhead for hdr & iv & tag) */
132 struct scatterlist sg_aead_out[2];
133
134 char content_type;
135 struct scatterlist sg_content_type;
136
137 char aad_space[TLS_AAD_SPACE_SIZE];
138 u8 iv_data[MAX_IV_SIZE];
139 struct aead_request aead_req;
140 u8 aead_req_ctx[];
141};
142
143struct tls_msg {
144 struct strp_msg rxm;
145 u8 control;
146};
147
148struct tx_work {
149 struct delayed_work work;
150 struct sock *sk;
151};
152
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000153struct tls_sw_context_tx {
154 struct crypto_aead *aead_send;
155 struct crypto_wait async_wait;
David Brazdil0f672f62019-12-10 10:32:29 +0000156 struct tx_work tx_work;
157 struct tls_rec *open_rec;
158 struct list_head tx_list;
159 atomic_t encrypt_pending;
Olivier Deprez0e641232021-09-23 10:07:05 +0200160 /* protect crypto_wait with encrypt_pending */
161 spinlock_t encrypt_compl_lock;
David Brazdil0f672f62019-12-10 10:32:29 +0000162 int async_notify;
163 int async_capable;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000164
David Brazdil0f672f62019-12-10 10:32:29 +0000165#define BIT_TX_SCHEDULED 0
166#define BIT_TX_CLOSING 1
167 unsigned long tx_bitmask;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000168};
169
170struct tls_sw_context_rx {
171 struct crypto_aead *aead_recv;
172 struct crypto_wait async_wait;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000173 struct strparser strp;
David Brazdil0f672f62019-12-10 10:32:29 +0000174 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000175 void (*saved_data_ready)(struct sock *sk);
David Brazdil0f672f62019-12-10 10:32:29 +0000176
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000177 struct sk_buff *recv_pkt;
178 u8 control;
David Brazdil0f672f62019-12-10 10:32:29 +0000179 int async_capable;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000180 bool decrypted;
David Brazdil0f672f62019-12-10 10:32:29 +0000181 atomic_t decrypt_pending;
Olivier Deprez0e641232021-09-23 10:07:05 +0200182 /* protect crypto_wait with decrypt_pending*/
183 spinlock_t decrypt_compl_lock;
David Brazdil0f672f62019-12-10 10:32:29 +0000184 bool async_notify;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000185};
186
187struct tls_record_info {
188 struct list_head list;
189 u32 end_seq;
190 int len;
191 int num_frags;
192 skb_frag_t frags[MAX_SKB_FRAGS];
193};
194
195struct tls_offload_context_tx {
196 struct crypto_aead *aead_send;
197 spinlock_t lock; /* protects records list */
198 struct list_head records_list;
199 struct tls_record_info *open_record;
200 struct tls_record_info *retransmit_hint;
201 u64 hint_record_sn;
202 u64 unacked_record_sn;
203
204 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
205 void (*sk_destruct)(struct sock *sk);
David Brazdil0f672f62019-12-10 10:32:29 +0000206 u8 driver_state[] __aligned(8);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000207 /* The TLS layer reserves room for driver specific state
208 * Currently the belief is that there is not enough
209 * driver specific state to justify another layer of indirection
210 */
David Brazdil0f672f62019-12-10 10:32:29 +0000211#define TLS_DRIVER_STATE_SIZE_TX 16
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000212};
213
214#define TLS_OFFLOAD_CONTEXT_SIZE_TX \
David Brazdil0f672f62019-12-10 10:32:29 +0000215 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000216
David Brazdil0f672f62019-12-10 10:32:29 +0000217enum tls_context_flags {
218 TLS_RX_SYNC_RUNNING = 0,
219 /* Unlike RX where resync is driven entirely by the core in TX only
220 * the driver knows when things went out of sync, so we need the flag
221 * to be atomic.
222 */
223 TLS_TX_SYNC_SCHED = 1,
Olivier Deprez0e641232021-09-23 10:07:05 +0200224 /* tls_dev_del was called for the RX side, device state was released,
225 * but tls_ctx->netdev might still be kept, because TX-side driver
226 * resources might not be released yet. Used to prevent the second
227 * tls_dev_del call in tls_device_down if it happens simultaneously.
228 */
229 TLS_RX_DEV_CLOSED = 2,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000230};
231
232struct cipher_context {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000233 char *iv;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000234 char *rec_seq;
235};
236
237union tls_crypto_context {
238 struct tls_crypto_info info;
David Brazdil0f672f62019-12-10 10:32:29 +0000239 union {
240 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
241 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
242 };
243};
244
245struct tls_prot_info {
246 u16 version;
247 u16 cipher_type;
248 u16 prepend_size;
249 u16 tag_size;
250 u16 overhead_size;
251 u16 iv_size;
252 u16 salt_size;
253 u16 rec_seq_size;
254 u16 aad_size;
255 u16 tail_size;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000256};
257
258struct tls_context {
David Brazdil0f672f62019-12-10 10:32:29 +0000259 /* read-only cache line */
260 struct tls_prot_info prot_info;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000261
262 u8 tx_conf:3;
263 u8 rx_conf:3;
264
David Brazdil0f672f62019-12-10 10:32:29 +0000265 int (*push_pending_record)(struct sock *sk, int flags);
266 void (*sk_write_space)(struct sock *sk);
267
268 void *priv_ctx_tx;
269 void *priv_ctx_rx;
270
271 struct net_device *netdev;
272
273 /* rw cache line */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000274 struct cipher_context tx;
275 struct cipher_context rx;
276
277 struct scatterlist *partially_sent_record;
278 u16 partially_sent_offset;
David Brazdil0f672f62019-12-10 10:32:29 +0000279
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000280 bool in_tcp_sendpages;
David Brazdil0f672f62019-12-10 10:32:29 +0000281 bool pending_open_record_frags;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000282
David Brazdil0f672f62019-12-10 10:32:29 +0000283 struct mutex tx_lock; /* protects partially_sent_* fields and
284 * per-type TX fields
285 */
286 unsigned long flags;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000287
David Brazdil0f672f62019-12-10 10:32:29 +0000288 /* cache cold stuff */
289 struct proto *sk_proto;
290
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000291 void (*sk_destruct)(struct sock *sk);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000292
David Brazdil0f672f62019-12-10 10:32:29 +0000293 union tls_crypto_context crypto_send;
294 union tls_crypto_context crypto_recv;
295
296 struct list_head list;
297 refcount_t refcount;
298 struct rcu_head rcu;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000299};
300
David Brazdil0f672f62019-12-10 10:32:29 +0000301enum tls_offload_ctx_dir {
302 TLS_OFFLOAD_CTX_DIR_RX,
303 TLS_OFFLOAD_CTX_DIR_TX,
304};
305
306struct tlsdev_ops {
307 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
308 enum tls_offload_ctx_dir direction,
309 struct tls_crypto_info *crypto_info,
310 u32 start_offload_tcp_sn);
311 void (*tls_dev_del)(struct net_device *netdev,
312 struct tls_context *ctx,
313 enum tls_offload_ctx_dir direction);
314 int (*tls_dev_resync)(struct net_device *netdev,
315 struct sock *sk, u32 seq, u8 *rcd_sn,
316 enum tls_offload_ctx_dir direction);
317};
318
319enum tls_offload_sync_type {
320 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
321 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
322};
323
324#define TLS_DEVICE_RESYNC_NH_START_IVAL 2
325#define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
326
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000327struct tls_offload_context_rx {
328 /* sw must be the first member of tls_offload_context_rx */
329 struct tls_sw_context_rx sw;
David Brazdil0f672f62019-12-10 10:32:29 +0000330 enum tls_offload_sync_type resync_type;
331 /* this member is set regardless of resync_type, to avoid branches */
332 u8 resync_nh_reset:1;
333 /* CORE_NEXT_HINT-only member, but use the hole here */
334 u8 resync_nh_do_now:1;
335 union {
336 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
337 struct {
338 atomic64_t resync_req;
339 };
340 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
341 struct {
342 u32 decrypted_failed;
343 u32 decrypted_tgt;
344 } resync_nh;
345 };
346 u8 driver_state[] __aligned(8);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000347 /* The TLS layer reserves room for driver specific state
348 * Currently the belief is that there is not enough
349 * driver specific state to justify another layer of indirection
350 */
David Brazdil0f672f62019-12-10 10:32:29 +0000351#define TLS_DRIVER_STATE_SIZE_RX 8
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000352};
353
354#define TLS_OFFLOAD_CONTEXT_SIZE_RX \
David Brazdil0f672f62019-12-10 10:32:29 +0000355 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000356
David Brazdil0f672f62019-12-10 10:32:29 +0000357void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000358int wait_on_pending_writer(struct sock *sk, long *timeo);
359int tls_sk_query(struct sock *sk, int optname, char __user *optval,
360 int __user *optlen);
361int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
362 unsigned int optlen);
363
364int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
David Brazdil0f672f62019-12-10 10:32:29 +0000365void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
366void tls_sw_strparser_done(struct tls_context *tls_ctx);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000367int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
David Brazdil0f672f62019-12-10 10:32:29 +0000368int tls_sw_sendpage_locked(struct sock *sk, struct page *page,
369 int offset, size_t size, int flags);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000370int tls_sw_sendpage(struct sock *sk, struct page *page,
371 int offset, size_t size, int flags);
David Brazdil0f672f62019-12-10 10:32:29 +0000372void tls_sw_cancel_work_tx(struct tls_context *tls_ctx);
373void tls_sw_release_resources_tx(struct sock *sk);
374void tls_sw_free_ctx_tx(struct tls_context *tls_ctx);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000375void tls_sw_free_resources_rx(struct sock *sk);
376void tls_sw_release_resources_rx(struct sock *sk);
David Brazdil0f672f62019-12-10 10:32:29 +0000377void tls_sw_free_ctx_rx(struct tls_context *tls_ctx);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000378int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
379 int nonblock, int flags, int *addr_len);
David Brazdil0f672f62019-12-10 10:32:29 +0000380bool tls_sw_stream_read(const struct sock *sk);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000381ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
382 struct pipe_inode_info *pipe,
383 size_t len, unsigned int flags);
384
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000385int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
386int tls_device_sendpage(struct sock *sk, struct page *page,
387 int offset, size_t size, int flags);
David Brazdil0f672f62019-12-10 10:32:29 +0000388int tls_tx_records(struct sock *sk, int flags);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000389
390struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
391 u32 seq, u64 *p_record_sn);
392
393static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
394{
395 return rec->len == 0;
396}
397
398static inline u32 tls_record_start_seq(struct tls_record_info *rec)
399{
400 return rec->end_seq - rec->len;
401}
402
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000403int tls_push_sg(struct sock *sk, struct tls_context *ctx,
404 struct scatterlist *sg, u16 first_offset,
405 int flags);
David Brazdil0f672f62019-12-10 10:32:29 +0000406int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
407 int flags);
408void tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000409
David Brazdil0f672f62019-12-10 10:32:29 +0000410static inline struct tls_msg *tls_msg(struct sk_buff *skb)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000411{
David Brazdil0f672f62019-12-10 10:32:29 +0000412 return (struct tls_msg *)strp_msg(skb);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000413}
414
415static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
416{
417 return !!ctx->partially_sent_record;
418}
419
420static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
421{
422 return tls_ctx->pending_open_record_frags;
423}
424
David Brazdil0f672f62019-12-10 10:32:29 +0000425static inline bool is_tx_ready(struct tls_sw_context_tx *ctx)
426{
427 struct tls_rec *rec;
428
429 rec = list_first_entry(&ctx->tx_list, struct tls_rec, list);
430 if (!rec)
431 return false;
432
433 return READ_ONCE(rec->tx_ready);
434}
435
436static inline u16 tls_user_config(struct tls_context *ctx, bool tx)
437{
438 u16 config = tx ? ctx->tx_conf : ctx->rx_conf;
439
440 switch (config) {
441 case TLS_BASE:
442 return TLS_CONF_BASE;
443 case TLS_SW:
444 return TLS_CONF_SW;
445 case TLS_HW:
446 return TLS_CONF_HW;
447 case TLS_HW_RECORD:
448 return TLS_CONF_HW_RECORD;
449 }
450 return 0;
451}
452
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000453struct sk_buff *
454tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
455 struct sk_buff *skb);
456
457static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
458{
459#ifdef CONFIG_SOCK_VALIDATE_XMIT
David Brazdil0f672f62019-12-10 10:32:29 +0000460 return sk_fullsock(sk) &&
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000461 (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
462 &tls_validate_xmit_skb);
463#else
464 return false;
465#endif
466}
467
468static inline void tls_err_abort(struct sock *sk, int err)
469{
470 sk->sk_err = err;
471 sk->sk_error_report(sk);
472}
473
474static inline bool tls_bigint_increment(unsigned char *seq, int len)
475{
476 int i;
477
478 for (i = len - 1; i >= 0; i--) {
479 ++seq[i];
480 if (seq[i] != 0)
481 break;
482 }
483
484 return (i == -1);
485}
486
David Brazdil0f672f62019-12-10 10:32:29 +0000487static inline struct tls_context *tls_get_ctx(const struct sock *sk)
488{
489 struct inet_connection_sock *icsk = inet_csk(sk);
490
491 /* Use RCU on icsk_ulp_data only for sock diag code,
492 * TLS data path doesn't need rcu_dereference().
493 */
494 return (__force void *)icsk->icsk_ulp_data;
495}
496
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000497static inline void tls_advance_record_sn(struct sock *sk,
David Brazdil0f672f62019-12-10 10:32:29 +0000498 struct tls_prot_info *prot,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000499 struct cipher_context *ctx)
500{
David Brazdil0f672f62019-12-10 10:32:29 +0000501 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000502 tls_err_abort(sk, EBADMSG);
David Brazdil0f672f62019-12-10 10:32:29 +0000503
504 if (prot->version != TLS_1_3_VERSION)
505 tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
506 prot->iv_size);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000507}
508
509static inline void tls_fill_prepend(struct tls_context *ctx,
510 char *buf,
511 size_t plaintext_len,
David Brazdil0f672f62019-12-10 10:32:29 +0000512 unsigned char record_type,
513 int version)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000514{
David Brazdil0f672f62019-12-10 10:32:29 +0000515 struct tls_prot_info *prot = &ctx->prot_info;
516 size_t pkt_len, iv_size = prot->iv_size;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000517
David Brazdil0f672f62019-12-10 10:32:29 +0000518 pkt_len = plaintext_len + prot->tag_size;
519 if (version != TLS_1_3_VERSION) {
520 pkt_len += iv_size;
521
522 memcpy(buf + TLS_NONCE_OFFSET,
523 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
524 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000525
526 /* we cover nonce explicit here as well, so buf should be of
527 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
528 */
David Brazdil0f672f62019-12-10 10:32:29 +0000529 buf[0] = version == TLS_1_3_VERSION ?
530 TLS_RECORD_TYPE_DATA : record_type;
531 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
532 buf[1] = TLS_1_2_VERSION_MINOR;
533 buf[2] = TLS_1_2_VERSION_MAJOR;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000534 /* we can use IV for nonce explicit according to spec */
535 buf[3] = pkt_len >> 8;
536 buf[4] = pkt_len & 0xFF;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000537}
538
539static inline void tls_make_aad(char *buf,
540 size_t size,
541 char *record_sequence,
542 int record_sequence_size,
David Brazdil0f672f62019-12-10 10:32:29 +0000543 unsigned char record_type,
544 int version)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000545{
David Brazdil0f672f62019-12-10 10:32:29 +0000546 if (version != TLS_1_3_VERSION) {
547 memcpy(buf, record_sequence, record_sequence_size);
548 buf += 8;
549 } else {
550 size += TLS_CIPHER_AES_GCM_128_TAG_SIZE;
551 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000552
David Brazdil0f672f62019-12-10 10:32:29 +0000553 buf[0] = version == TLS_1_3_VERSION ?
554 TLS_RECORD_TYPE_DATA : record_type;
555 buf[1] = TLS_1_2_VERSION_MAJOR;
556 buf[2] = TLS_1_2_VERSION_MINOR;
557 buf[3] = size >> 8;
558 buf[4] = size & 0xFF;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000559}
560
David Brazdil0f672f62019-12-10 10:32:29 +0000561static inline void xor_iv_with_seq(int version, char *iv, char *seq)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000562{
David Brazdil0f672f62019-12-10 10:32:29 +0000563 int i;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000564
David Brazdil0f672f62019-12-10 10:32:29 +0000565 if (version == TLS_1_3_VERSION) {
566 for (i = 0; i < 8; i++)
567 iv[i + 4] ^= seq[i];
568 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000569}
570
David Brazdil0f672f62019-12-10 10:32:29 +0000571
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000572static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
573 const struct tls_context *tls_ctx)
574{
575 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
576}
577
578static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
579 const struct tls_context *tls_ctx)
580{
581 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
582}
583
584static inline struct tls_offload_context_tx *
585tls_offload_ctx_tx(const struct tls_context *tls_ctx)
586{
587 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
588}
589
David Brazdil0f672f62019-12-10 10:32:29 +0000590static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
591{
592 struct tls_context *ctx = tls_get_ctx(sk);
593
594 if (!ctx)
595 return false;
596 return !!tls_sw_ctx_tx(ctx);
597}
598
Olivier Deprez0e641232021-09-23 10:07:05 +0200599static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
600{
601 struct tls_context *ctx = tls_get_ctx(sk);
602
603 if (!ctx)
604 return false;
605 return !!tls_sw_ctx_rx(ctx);
606}
607
David Brazdil0f672f62019-12-10 10:32:29 +0000608void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
609void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
610
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000611static inline struct tls_offload_context_rx *
612tls_offload_ctx_rx(const struct tls_context *tls_ctx)
613{
614 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
615}
616
David Brazdil0f672f62019-12-10 10:32:29 +0000617#if IS_ENABLED(CONFIG_TLS_DEVICE)
618static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
619 enum tls_offload_ctx_dir direction)
620{
621 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
622 return tls_offload_ctx_tx(tls_ctx)->driver_state;
623 else
624 return tls_offload_ctx_rx(tls_ctx)->driver_state;
625}
626
627static inline void *
628tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
629{
630 return __tls_driver_ctx(tls_get_ctx(sk), direction);
631}
632#endif
633
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000634/* The TLS context is valid until sk_destruct is called */
635static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
636{
637 struct tls_context *tls_ctx = tls_get_ctx(sk);
638 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
639
David Brazdil0f672f62019-12-10 10:32:29 +0000640 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | 1);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000641}
642
David Brazdil0f672f62019-12-10 10:32:29 +0000643static inline void
644tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
645{
646 struct tls_context *tls_ctx = tls_get_ctx(sk);
647
648 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
649}
650
651static inline void tls_offload_tx_resync_request(struct sock *sk)
652{
653 struct tls_context *tls_ctx = tls_get_ctx(sk);
654
655 WARN_ON(test_and_set_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags));
656}
657
658/* Driver's seq tracking has to be disabled until resync succeeded */
659static inline bool tls_offload_tx_resync_pending(struct sock *sk)
660{
661 struct tls_context *tls_ctx = tls_get_ctx(sk);
662 bool ret;
663
664 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
665 smp_mb__after_atomic();
666 return ret;
667}
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000668
669int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
670 unsigned char *record_type);
671void tls_register_device(struct tls_device *device);
672void tls_unregister_device(struct tls_device *device);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000673int decrypt_skb(struct sock *sk, struct sk_buff *skb,
674 struct scatterlist *sgout);
David Brazdil0f672f62019-12-10 10:32:29 +0000675struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000676
677struct sk_buff *tls_validate_xmit_skb(struct sock *sk,
678 struct net_device *dev,
679 struct sk_buff *skb);
680
681int tls_sw_fallback_init(struct sock *sk,
682 struct tls_offload_context_tx *offload_ctx,
683 struct tls_crypto_info *crypto_info);
684
David Brazdil0f672f62019-12-10 10:32:29 +0000685#ifdef CONFIG_TLS_DEVICE
686void tls_device_init(void);
687void tls_device_cleanup(void);
688int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
689void tls_device_free_resources_tx(struct sock *sk);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000690int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000691void tls_device_offload_cleanup_rx(struct sock *sk);
David Brazdil0f672f62019-12-10 10:32:29 +0000692void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
693int tls_device_decrypted(struct sock *sk, struct sk_buff *skb);
694#else
695static inline void tls_device_init(void) {}
696static inline void tls_device_cleanup(void) {}
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000697
David Brazdil0f672f62019-12-10 10:32:29 +0000698static inline int
699tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
700{
701 return -EOPNOTSUPP;
702}
703
704static inline void tls_device_free_resources_tx(struct sock *sk) {}
705
706static inline int
707tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
708{
709 return -EOPNOTSUPP;
710}
711
712static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
713static inline void
714tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
715
716static inline int tls_device_decrypted(struct sock *sk, struct sk_buff *skb)
717{
718 return 0;
719}
720#endif
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000721#endif /* _TLS_OFFLOAD_H */