2 * Copyright (c) 2016-2017, Mellanox Technologies. 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/netdevice.h>
44 #include <linux/rcupdate.h>
46 #include <net/net_namespace.h>
48 #include <net/strparser.h>
49 #include <crypto/aead.h>
50 #include <uapi/linux/tls.h>
53 /* Maximum data size carried in a TLS record */
54 #define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
56 #define TLS_HEADER_SIZE 5
57 #define TLS_NONCE_OFFSET TLS_HEADER_SIZE
59 #define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
61 #define TLS_RECORD_TYPE_DATA 0x17
63 #define TLS_AAD_SPACE_SIZE 13
65 #define MAX_IV_SIZE 16
66 #define TLS_MAX_REC_SEQ_SIZE 8
68 /* For AES-CCM, the full 16-bytes of IV is made of '4' fields of given sizes.
70 * IV[16] = b0[1] || implicit nonce[4] || explicit nonce[8] || length[3]
72 * The field 'length' is encoded in field 'b0' as '(length width - 1)'.
73 * Hence b0 contains (3 - 1) = 2.
75 #define TLS_AES_CCM_IV_B0_BYTE 2
77 #define __TLS_INC_STATS(net, field) \
78 __SNMP_INC_STATS((net)->mib.tls_statistics, field)
79 #define TLS_INC_STATS(net, field) \
80 SNMP_INC_STATS((net)->mib.tls_statistics, field)
81 #define __TLS_DEC_STATS(net, field) \
82 __SNMP_DEC_STATS((net)->mib.tls_statistics, field)
83 #define TLS_DEC_STATS(net, field) \
84 SNMP_DEC_STATS((net)->mib.tls_statistics, field)
94 /* 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.
99 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;
141 #define BIT_TX_SCHEDULED 0
142 #define BIT_TX_CLOSING 1
143 unsigned long tx_bitmask;
146 struct tls_sw_context_rx {
147 struct crypto_aead *aead_recv;
148 struct crypto_wait async_wait;
149 struct strparser strp;
150 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
151 void (*saved_data_ready)(struct sock *sk);
153 struct sk_buff *recv_pkt;
157 atomic_t decrypt_pending;
161 struct tls_record_info {
162 struct list_head list;
166 skb_frag_t frags[MAX_SKB_FRAGS];
169 struct tls_offload_context_tx {
170 struct crypto_aead *aead_send;
171 spinlock_t lock; /* protects records list */
172 struct list_head records_list;
173 struct tls_record_info *open_record;
174 struct tls_record_info *retransmit_hint;
176 u64 unacked_record_sn;
178 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
179 void (*sk_destruct)(struct sock *sk);
180 u8 driver_state[] __aligned(8);
181 /* The TLS layer reserves room for driver specific state
182 * Currently the belief is that there is not enough
183 * driver specific state to justify another layer of indirection
185 #define TLS_DRIVER_STATE_SIZE_TX 16
188 #define TLS_OFFLOAD_CONTEXT_SIZE_TX \
189 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
191 enum tls_context_flags {
192 TLS_RX_SYNC_RUNNING = 0,
193 /* Unlike RX where resync is driven entirely by the core in TX only
194 * the driver knows when things went out of sync, so we need the flag
197 TLS_TX_SYNC_SCHED = 1,
200 struct cipher_context {
205 union tls_crypto_context {
206 struct tls_crypto_info info;
208 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
209 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
213 struct tls_prot_info {
227 /* read-only cache line */
228 struct tls_prot_info prot_info;
233 int (*push_pending_record)(struct sock *sk, int flags);
234 void (*sk_write_space)(struct sock *sk);
239 struct net_device *netdev;
242 struct cipher_context tx;
243 struct cipher_context rx;
245 struct scatterlist *partially_sent_record;
246 u16 partially_sent_offset;
248 bool in_tcp_sendpages;
249 bool pending_open_record_frags;
252 /* cache cold stuff */
253 struct proto *sk_proto;
255 void (*sk_destruct)(struct sock *sk);
257 union tls_crypto_context crypto_send;
258 union tls_crypto_context crypto_recv;
260 struct list_head list;
265 enum tls_offload_ctx_dir {
266 TLS_OFFLOAD_CTX_DIR_RX,
267 TLS_OFFLOAD_CTX_DIR_TX,
271 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
272 enum tls_offload_ctx_dir direction,
273 struct tls_crypto_info *crypto_info,
274 u32 start_offload_tcp_sn);
275 void (*tls_dev_del)(struct net_device *netdev,
276 struct tls_context *ctx,
277 enum tls_offload_ctx_dir direction);
278 int (*tls_dev_resync)(struct net_device *netdev,
279 struct sock *sk, u32 seq, u8 *rcd_sn,
280 enum tls_offload_ctx_dir direction);
283 enum tls_offload_sync_type {
284 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
285 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
288 #define TLS_DEVICE_RESYNC_NH_START_IVAL 2
289 #define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
291 struct tls_offload_context_rx {
292 /* sw must be the first member of tls_offload_context_rx */
293 struct tls_sw_context_rx sw;
294 enum tls_offload_sync_type resync_type;
295 /* this member is set regardless of resync_type, to avoid branches */
296 u8 resync_nh_reset:1;
297 /* CORE_NEXT_HINT-only member, but use the hole here */
298 u8 resync_nh_do_now:1;
300 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
302 atomic64_t resync_req;
304 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
306 u32 decrypted_failed;
310 u8 driver_state[] __aligned(8);
311 /* The TLS layer reserves room for driver specific state
312 * Currently the belief is that there is not enough
313 * driver specific state to justify another layer of indirection
315 #define TLS_DRIVER_STATE_SIZE_RX 8
318 #define TLS_OFFLOAD_CONTEXT_SIZE_RX \
319 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
321 struct tls_context *tls_ctx_create(struct sock *sk);
322 void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
323 void update_sk_prot(struct sock *sk, struct tls_context *ctx);
325 int wait_on_pending_writer(struct sock *sk, long *timeo);
326 int tls_sk_query(struct sock *sk, int optname, char __user *optval,
328 int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
329 unsigned int optlen);
331 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
332 void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
333 void tls_sw_strparser_done(struct tls_context *tls_ctx);
334 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
335 int tls_sw_sendpage(struct sock *sk, struct page *page,
336 int offset, size_t size, int flags);
337 void tls_sw_cancel_work_tx(struct tls_context *tls_ctx);
338 void tls_sw_release_resources_tx(struct sock *sk);
339 void tls_sw_free_ctx_tx(struct tls_context *tls_ctx);
340 void tls_sw_free_resources_rx(struct sock *sk);
341 void tls_sw_release_resources_rx(struct sock *sk);
342 void tls_sw_free_ctx_rx(struct tls_context *tls_ctx);
343 int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
344 int nonblock, int flags, int *addr_len);
345 bool tls_sw_stream_read(const struct sock *sk);
346 ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
347 struct pipe_inode_info *pipe,
348 size_t len, unsigned int flags);
350 int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
351 int tls_device_sendpage(struct sock *sk, struct page *page,
352 int offset, size_t size, int flags);
353 int tls_tx_records(struct sock *sk, int flags);
355 struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
356 u32 seq, u64 *p_record_sn);
358 static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
360 return rec->len == 0;
363 static inline u32 tls_record_start_seq(struct tls_record_info *rec)
365 return rec->end_seq - rec->len;
368 int tls_push_sg(struct sock *sk, struct tls_context *ctx,
369 struct scatterlist *sg, u16 first_offset,
371 int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
373 bool tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
375 static inline struct tls_msg *tls_msg(struct sk_buff *skb)
377 return (struct tls_msg *)strp_msg(skb);
380 static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
382 return !!ctx->partially_sent_record;
385 static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
387 return tls_ctx->pending_open_record_frags;
390 static inline bool is_tx_ready(struct tls_sw_context_tx *ctx)
394 rec = list_first_entry(&ctx->tx_list, struct tls_rec, list);
398 return READ_ONCE(rec->tx_ready);
401 static inline u16 tls_user_config(struct tls_context *ctx, bool tx)
403 u16 config = tx ? ctx->tx_conf : ctx->rx_conf;
407 return TLS_CONF_BASE;
413 return TLS_CONF_HW_RECORD;
419 tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
420 struct sk_buff *skb);
422 static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
424 #ifdef CONFIG_SOCK_VALIDATE_XMIT
425 return sk_fullsock(sk) &&
426 (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
427 &tls_validate_xmit_skb);
433 static inline void tls_err_abort(struct sock *sk, int err)
436 sk->sk_error_report(sk);
439 static inline bool tls_bigint_increment(unsigned char *seq, int len)
443 for (i = len - 1; i >= 0; i--) {
452 static inline struct tls_context *tls_get_ctx(const struct sock *sk)
454 struct inet_connection_sock *icsk = inet_csk(sk);
456 /* Use RCU on icsk_ulp_data only for sock diag code,
457 * TLS data path doesn't need rcu_dereference().
459 return (__force void *)icsk->icsk_ulp_data;
462 static inline void tls_advance_record_sn(struct sock *sk,
463 struct tls_prot_info *prot,
464 struct cipher_context *ctx)
466 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
467 tls_err_abort(sk, EBADMSG);
469 if (prot->version != TLS_1_3_VERSION)
470 tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
474 static inline void tls_fill_prepend(struct tls_context *ctx,
476 size_t plaintext_len,
477 unsigned char record_type,
480 struct tls_prot_info *prot = &ctx->prot_info;
481 size_t pkt_len, iv_size = prot->iv_size;
483 pkt_len = plaintext_len + prot->tag_size;
484 if (version != TLS_1_3_VERSION) {
487 memcpy(buf + TLS_NONCE_OFFSET,
488 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
491 /* we cover nonce explicit here as well, so buf should be of
492 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
494 buf[0] = version == TLS_1_3_VERSION ?
495 TLS_RECORD_TYPE_DATA : record_type;
496 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
497 buf[1] = TLS_1_2_VERSION_MINOR;
498 buf[2] = TLS_1_2_VERSION_MAJOR;
499 /* we can use IV for nonce explicit according to spec */
500 buf[3] = pkt_len >> 8;
501 buf[4] = pkt_len & 0xFF;
504 static inline void tls_make_aad(char *buf,
506 char *record_sequence,
507 int record_sequence_size,
508 unsigned char record_type,
511 if (version != TLS_1_3_VERSION) {
512 memcpy(buf, record_sequence, record_sequence_size);
515 size += TLS_CIPHER_AES_GCM_128_TAG_SIZE;
518 buf[0] = version == TLS_1_3_VERSION ?
519 TLS_RECORD_TYPE_DATA : record_type;
520 buf[1] = TLS_1_2_VERSION_MAJOR;
521 buf[2] = TLS_1_2_VERSION_MINOR;
523 buf[4] = size & 0xFF;
526 static inline void xor_iv_with_seq(int version, char *iv, char *seq)
530 if (version == TLS_1_3_VERSION) {
531 for (i = 0; i < 8; i++)
537 static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
538 const struct tls_context *tls_ctx)
540 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
543 static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
544 const struct tls_context *tls_ctx)
546 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
549 static inline struct tls_offload_context_tx *
550 tls_offload_ctx_tx(const struct tls_context *tls_ctx)
552 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
555 static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
557 struct tls_context *ctx = tls_get_ctx(sk);
561 return !!tls_sw_ctx_tx(ctx);
564 void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
565 void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
567 static inline struct tls_offload_context_rx *
568 tls_offload_ctx_rx(const struct tls_context *tls_ctx)
570 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
573 #if IS_ENABLED(CONFIG_TLS_DEVICE)
574 static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
575 enum tls_offload_ctx_dir direction)
577 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
578 return tls_offload_ctx_tx(tls_ctx)->driver_state;
580 return tls_offload_ctx_rx(tls_ctx)->driver_state;
584 tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
586 return __tls_driver_ctx(tls_get_ctx(sk), direction);
590 /* The TLS context is valid until sk_destruct is called */
591 static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
593 struct tls_context *tls_ctx = tls_get_ctx(sk);
594 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
596 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | 1);
600 tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
602 struct tls_context *tls_ctx = tls_get_ctx(sk);
604 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
607 /* Driver's seq tracking has to be disabled until resync succeeded */
608 static inline bool tls_offload_tx_resync_pending(struct sock *sk)
610 struct tls_context *tls_ctx = tls_get_ctx(sk);
613 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
614 smp_mb__after_atomic();
618 int __net_init tls_proc_init(struct net *net);
619 void __net_exit tls_proc_fini(struct net *net);
621 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
622 unsigned char *record_type);
623 int decrypt_skb(struct sock *sk, struct sk_buff *skb,
624 struct scatterlist *sgout);
625 struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
627 struct sk_buff *tls_validate_xmit_skb(struct sock *sk,
628 struct net_device *dev,
629 struct sk_buff *skb);
631 int tls_sw_fallback_init(struct sock *sk,
632 struct tls_offload_context_tx *offload_ctx,
633 struct tls_crypto_info *crypto_info);
635 #ifdef CONFIG_TLS_DEVICE
636 void tls_device_init(void);
637 void tls_device_cleanup(void);
638 int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
639 void tls_device_free_resources_tx(struct sock *sk);
640 int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
641 void tls_device_offload_cleanup_rx(struct sock *sk);
642 void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
643 void tls_offload_tx_resync_request(struct sock *sk, u32 got_seq, u32 exp_seq);
644 int tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
645 struct sk_buff *skb, struct strp_msg *rxm);
647 static inline void tls_device_init(void) {}
648 static inline void tls_device_cleanup(void) {}
651 tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
656 static inline void tls_device_free_resources_tx(struct sock *sk) {}
659 tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
664 static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
666 tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
669 tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx,
670 struct sk_buff *skb, struct strp_msg *rxm)
675 #endif /* _TLS_OFFLOAD_H */