2 * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
3 * Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. All rights reserved.
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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
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.
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
34 #ifndef _TLS_OFFLOAD_H
35 #define _TLS_OFFLOAD_H
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>
42 #include <linux/skmsg.h>
43 #include <linux/mutex.h>
44 #include <linux/netdevice.h>
45 #include <linux/rcupdate.h>
47 #include <net/net_namespace.h>
49 #include <net/strparser.h>
50 #include <crypto/aead.h>
51 #include <uapi/linux/tls.h>
54 /* Maximum data size carried in a TLS record */
55 #define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
57 #define TLS_HEADER_SIZE 5
58 #define TLS_NONCE_OFFSET TLS_HEADER_SIZE
60 #define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
62 #define TLS_RECORD_TYPE_DATA 0x17
64 #define TLS_AAD_SPACE_SIZE 13
66 #define MAX_IV_SIZE 16
67 #define TLS_MAX_REC_SEQ_SIZE 8
69 /* For AES-CCM, the full 16-bytes of IV is made of '4' fields of given sizes.
71 * IV[16] = b0[1] || implicit nonce[4] || explicit nonce[8] || length[3]
73 * The field 'length' is encoded in field 'b0' as '(length width - 1)'.
74 * Hence b0 contains (3 - 1) = 2.
76 #define TLS_AES_CCM_IV_B0_BYTE 2
78 #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)
95 /* 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.
100 struct list_head list;
104 struct sk_msg msg_plaintext;
105 struct sk_msg msg_encrypted;
107 /* 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];
113 struct scatterlist sg_content_type;
115 char aad_space[TLS_AAD_SPACE_SIZE];
116 u8 iv_data[MAX_IV_SIZE];
117 struct aead_request aead_req;
127 struct delayed_work work;
131 struct 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;
136 struct list_head tx_list;
137 atomic_t encrypt_pending;
138 /* protect crypto_wait with encrypt_pending */
139 spinlock_t encrypt_compl_lock;
143 #define BIT_TX_SCHEDULED 0
144 #define BIT_TX_CLOSING 1
145 unsigned long tx_bitmask;
148 struct tls_sw_context_rx {
149 struct crypto_aead *aead_recv;
150 struct crypto_wait async_wait;
151 struct strparser strp;
152 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
153 void (*saved_data_ready)(struct sock *sk);
155 struct sk_buff *recv_pkt;
159 atomic_t decrypt_pending;
160 /* protect crypto_wait with decrypt_pending*/
161 spinlock_t decrypt_compl_lock;
165 struct tls_record_info {
166 struct list_head list;
170 skb_frag_t frags[MAX_SKB_FRAGS];
173 struct tls_offload_context_tx {
174 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;
180 u64 unacked_record_sn;
182 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
183 void (*sk_destruct)(struct sock *sk);
184 u8 driver_state[] __aligned(8);
185 /* 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
189 #define TLS_DRIVER_STATE_SIZE_TX 16
192 #define TLS_OFFLOAD_CONTEXT_SIZE_TX \
193 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
195 enum tls_context_flags {
196 TLS_RX_SYNC_RUNNING = 0,
197 /* 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
201 TLS_TX_SYNC_SCHED = 1,
204 struct cipher_context {
209 union tls_crypto_context {
210 struct tls_crypto_info info;
212 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
213 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
214 struct tls12_crypto_info_chacha20_poly1305 chacha20_poly1305;
218 struct tls_prot_info {
232 /* read-only cache line */
233 struct tls_prot_info prot_info;
238 int (*push_pending_record)(struct sock *sk, int flags);
239 void (*sk_write_space)(struct sock *sk);
244 struct net_device *netdev;
247 struct cipher_context tx;
248 struct cipher_context rx;
250 struct scatterlist *partially_sent_record;
251 u16 partially_sent_offset;
253 bool in_tcp_sendpages;
254 bool pending_open_record_frags;
256 struct mutex tx_lock; /* protects partially_sent_* fields and
261 /* cache cold stuff */
262 struct proto *sk_proto;
264 void (*sk_destruct)(struct sock *sk);
266 union tls_crypto_context crypto_send;
267 union tls_crypto_context crypto_recv;
269 struct list_head list;
274 enum tls_offload_ctx_dir {
275 TLS_OFFLOAD_CTX_DIR_RX,
276 TLS_OFFLOAD_CTX_DIR_TX,
280 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
281 enum tls_offload_ctx_dir direction,
282 struct tls_crypto_info *crypto_info,
283 u32 start_offload_tcp_sn);
284 void (*tls_dev_del)(struct net_device *netdev,
285 struct tls_context *ctx,
286 enum tls_offload_ctx_dir direction);
287 int (*tls_dev_resync)(struct net_device *netdev,
288 struct sock *sk, u32 seq, u8 *rcd_sn,
289 enum tls_offload_ctx_dir direction);
292 enum tls_offload_sync_type {
293 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
294 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
295 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC = 2,
298 #define TLS_DEVICE_RESYNC_NH_START_IVAL 2
299 #define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
301 #define TLS_DEVICE_RESYNC_ASYNC_LOGMAX 13
302 struct tls_offload_resync_async {
306 u32 log[TLS_DEVICE_RESYNC_ASYNC_LOGMAX];
309 struct tls_offload_context_rx {
310 /* sw must be the first member of tls_offload_context_rx */
311 struct tls_sw_context_rx sw;
312 enum tls_offload_sync_type resync_type;
313 /* this member is set regardless of resync_type, to avoid branches */
314 u8 resync_nh_reset:1;
315 /* CORE_NEXT_HINT-only member, but use the hole here */
316 u8 resync_nh_do_now:1;
318 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
320 atomic64_t resync_req;
322 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
324 u32 decrypted_failed;
327 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ_ASYNC */
329 struct tls_offload_resync_async *resync_async;
332 u8 driver_state[] __aligned(8);
333 /* The TLS layer reserves room for driver specific state
334 * Currently the belief is that there is not enough
335 * driver specific state to justify another layer of indirection
337 #define TLS_DRIVER_STATE_SIZE_RX 8
340 #define TLS_OFFLOAD_CONTEXT_SIZE_RX \
341 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
343 struct tls_context *tls_ctx_create(struct sock *sk);
344 void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
345 void update_sk_prot(struct sock *sk, struct tls_context *ctx);
347 int wait_on_pending_writer(struct sock *sk, long *timeo);
348 int tls_sk_query(struct sock *sk, int optname, char __user *optval,
350 int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
351 unsigned int optlen);
353 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
354 void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
355 void tls_sw_strparser_done(struct tls_context *tls_ctx);
356 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
357 int tls_sw_sendpage_locked(struct sock *sk, struct page *page,
358 int offset, size_t size, int flags);
359 int tls_sw_sendpage(struct sock *sk, struct page *page,
360 int offset, size_t size, int flags);
361 void tls_sw_cancel_work_tx(struct tls_context *tls_ctx);
362 void tls_sw_release_resources_tx(struct sock *sk);
363 void tls_sw_free_ctx_tx(struct tls_context *tls_ctx);
364 void tls_sw_free_resources_rx(struct sock *sk);
365 void tls_sw_release_resources_rx(struct sock *sk);
366 void tls_sw_free_ctx_rx(struct tls_context *tls_ctx);
367 int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
368 int nonblock, int flags, int *addr_len);
369 bool tls_sw_stream_read(const struct sock *sk);
370 ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
371 struct pipe_inode_info *pipe,
372 size_t len, unsigned int flags);
374 int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
375 int tls_device_sendpage(struct sock *sk, struct page *page,
376 int offset, size_t size, int flags);
377 int tls_tx_records(struct sock *sk, int flags);
379 struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
380 u32 seq, u64 *p_record_sn);
382 static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
384 return rec->len == 0;
387 static inline u32 tls_record_start_seq(struct tls_record_info *rec)
389 return rec->end_seq - rec->len;
392 int tls_push_sg(struct sock *sk, struct tls_context *ctx,
393 struct scatterlist *sg, u16 first_offset,
395 int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
397 void tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
399 static inline struct tls_msg *tls_msg(struct sk_buff *skb)
401 return (struct tls_msg *)strp_msg(skb);
404 static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
406 return !!ctx->partially_sent_record;
409 static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
411 return tls_ctx->pending_open_record_frags;
414 static inline bool is_tx_ready(struct tls_sw_context_tx *ctx)
418 rec = list_first_entry(&ctx->tx_list, struct tls_rec, list);
422 return READ_ONCE(rec->tx_ready);
425 static inline u16 tls_user_config(struct tls_context *ctx, bool tx)
427 u16 config = tx ? ctx->tx_conf : ctx->rx_conf;
431 return TLS_CONF_BASE;
437 return TLS_CONF_HW_RECORD;
443 tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
444 struct sk_buff *skb);
446 static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
448 #ifdef CONFIG_SOCK_VALIDATE_XMIT
449 return sk_fullsock(sk) &&
450 (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
451 &tls_validate_xmit_skb);
457 static inline void tls_err_abort(struct sock *sk, int err)
460 sk->sk_error_report(sk);
463 static inline bool tls_bigint_increment(unsigned char *seq, int len)
467 for (i = len - 1; i >= 0; i--) {
476 static inline void tls_bigint_subtract(unsigned char *seq, int n)
481 BUILD_BUG_ON(TLS_MAX_REC_SEQ_SIZE != 8);
484 rcd_sn = be64_to_cpu(*p);
485 *p = cpu_to_be64(rcd_sn - n);
488 static inline struct tls_context *tls_get_ctx(const struct sock *sk)
490 struct inet_connection_sock *icsk = inet_csk(sk);
492 /* Use RCU on icsk_ulp_data only for sock diag code,
493 * TLS data path doesn't need rcu_dereference().
495 return (__force void *)icsk->icsk_ulp_data;
498 static inline void tls_advance_record_sn(struct sock *sk,
499 struct tls_prot_info *prot,
500 struct cipher_context *ctx)
502 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
503 tls_err_abort(sk, EBADMSG);
505 if (prot->version != TLS_1_3_VERSION &&
506 prot->cipher_type != TLS_CIPHER_CHACHA20_POLY1305)
507 tls_bigint_increment(ctx->iv + prot->salt_size,
511 static inline void tls_fill_prepend(struct tls_context *ctx,
513 size_t plaintext_len,
514 unsigned char record_type)
516 struct tls_prot_info *prot = &ctx->prot_info;
517 size_t pkt_len, iv_size = prot->iv_size;
519 pkt_len = plaintext_len + prot->tag_size;
520 if (prot->version != TLS_1_3_VERSION &&
521 prot->cipher_type != TLS_CIPHER_CHACHA20_POLY1305) {
524 memcpy(buf + TLS_NONCE_OFFSET,
525 ctx->tx.iv + prot->salt_size, iv_size);
528 /* we cover nonce explicit here as well, so buf should be of
529 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
531 buf[0] = prot->version == TLS_1_3_VERSION ?
532 TLS_RECORD_TYPE_DATA : record_type;
533 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
534 buf[1] = TLS_1_2_VERSION_MINOR;
535 buf[2] = TLS_1_2_VERSION_MAJOR;
536 /* we can use IV for nonce explicit according to spec */
537 buf[3] = pkt_len >> 8;
538 buf[4] = pkt_len & 0xFF;
541 static inline void tls_make_aad(char *buf,
543 char *record_sequence,
544 unsigned char record_type,
545 struct tls_prot_info *prot)
547 if (prot->version != TLS_1_3_VERSION) {
548 memcpy(buf, record_sequence, prot->rec_seq_size);
551 size += prot->tag_size;
554 buf[0] = prot->version == TLS_1_3_VERSION ?
555 TLS_RECORD_TYPE_DATA : record_type;
556 buf[1] = TLS_1_2_VERSION_MAJOR;
557 buf[2] = TLS_1_2_VERSION_MINOR;
559 buf[4] = size & 0xFF;
562 static inline void xor_iv_with_seq(struct tls_prot_info *prot, char *iv, char *seq)
566 if (prot->version == TLS_1_3_VERSION ||
567 prot->cipher_type == TLS_CIPHER_CHACHA20_POLY1305) {
568 for (i = 0; i < 8; i++)
574 static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
575 const struct tls_context *tls_ctx)
577 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
580 static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
581 const struct tls_context *tls_ctx)
583 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
586 static inline struct tls_offload_context_tx *
587 tls_offload_ctx_tx(const struct tls_context *tls_ctx)
589 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
592 static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
594 struct tls_context *ctx = tls_get_ctx(sk);
598 return !!tls_sw_ctx_tx(ctx);
601 static inline bool tls_sw_has_ctx_rx(const struct sock *sk)
603 struct tls_context *ctx = tls_get_ctx(sk);
607 return !!tls_sw_ctx_rx(ctx);
610 void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
611 void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
613 static inline struct tls_offload_context_rx *
614 tls_offload_ctx_rx(const struct tls_context *tls_ctx)
616 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
619 #if IS_ENABLED(CONFIG_TLS_DEVICE)
620 static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
621 enum tls_offload_ctx_dir direction)
623 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
624 return tls_offload_ctx_tx(tls_ctx)->driver_state;
626 return tls_offload_ctx_rx(tls_ctx)->driver_state;
630 tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
632 return __tls_driver_ctx(tls_get_ctx(sk), direction);
636 #define RESYNC_REQ BIT(0)
637 #define RESYNC_REQ_ASYNC BIT(1)
638 /* The TLS context is valid until sk_destruct is called */
639 static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
641 struct tls_context *tls_ctx = tls_get_ctx(sk);
642 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
644 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | RESYNC_REQ);
647 /* Log all TLS record header TCP sequences in [seq, seq+len] */
649 tls_offload_rx_resync_async_request_start(struct sock *sk, __be32 seq, u16 len)
651 struct tls_context *tls_ctx = tls_get_ctx(sk);
652 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
654 atomic64_set(&rx_ctx->resync_async->req, ((u64)ntohl(seq) << 32) |
655 ((u64)len << 16) | RESYNC_REQ | RESYNC_REQ_ASYNC);
656 rx_ctx->resync_async->loglen = 0;
657 rx_ctx->resync_async->rcd_delta = 0;
661 tls_offload_rx_resync_async_request_end(struct sock *sk, __be32 seq)
663 struct tls_context *tls_ctx = tls_get_ctx(sk);
664 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
666 atomic64_set(&rx_ctx->resync_async->req,
667 ((u64)ntohl(seq) << 32) | RESYNC_REQ);
671 tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
673 struct tls_context *tls_ctx = tls_get_ctx(sk);
675 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
678 /* Driver's seq tracking has to be disabled until resync succeeded */
679 static inline bool tls_offload_tx_resync_pending(struct sock *sk)
681 struct tls_context *tls_ctx = tls_get_ctx(sk);
684 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
685 smp_mb__after_atomic();
689 int __net_init tls_proc_init(struct net *net);
690 void __net_exit tls_proc_fini(struct net *net);
692 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
693 unsigned char *record_type);
694 int decrypt_skb(struct sock *sk, struct sk_buff *skb,
695 struct scatterlist *sgout);
696 struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
698 int tls_sw_fallback_init(struct sock *sk,
699 struct tls_offload_context_tx *offload_ctx,
700 struct tls_crypto_info *crypto_info);
702 #ifdef CONFIG_TLS_DEVICE
703 void tls_device_init(void);
704 void tls_device_cleanup(void);
705 void tls_device_sk_destruct(struct sock *sk);
706 int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
707 void tls_device_free_resources_tx(struct sock *sk);
708 int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
709 void tls_device_offload_cleanup_rx(struct sock *sk);
710 void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
711 void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
712 int tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
713 struct sk_buff *skb, struct strp_msg *rxm);
715 static inline bool tls_is_sk_rx_device_offloaded(struct sock *sk)
717 if (!sk_fullsock(sk) ||
718 smp_load_acquire(&sk->sk_destruct) != tls_device_sk_destruct)
720 return tls_get_ctx(sk)->rx_conf == TLS_HW;
723 static inline void tls_device_init(void) {}
724 static inline void tls_device_cleanup(void) {}
727 tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
732 static inline void tls_device_free_resources_tx(struct sock *sk) {}
735 tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
740 static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
742 tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
745 tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
746 struct sk_buff *skb, struct strp_msg *rxm)
751 #endif /* _TLS_OFFLOAD_H */