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>
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
64 #define TLS_DEVICE_NAME_MAX 32
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
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.
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
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
92 * void (*unhash)(struct tls_device *device, struct sock *sk);
93 * This function cleans listen state set by Inline TLS driver
95 * void (*release)(struct kref *kref);
96 * Release the registered device and allocated resources
97 * @kref: Number of reference to 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);
105 void (*release)(struct kref *kref);
117 /* 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.
122 struct list_head list;
127 struct sk_msg msg_plaintext;
128 struct sk_msg msg_encrypted;
130 /* AAD | msg_plaintext.sg.data | sg_tag */
131 struct scatterlist sg_aead_in[2];
132 /* AAD | msg_encrypted.sg.data (data contains overhead for hdr & iv & tag) */
133 struct scatterlist sg_aead_out[2];
136 struct scatterlist sg_content_type;
138 char aad_space[TLS_AAD_SPACE_SIZE];
139 u8 iv_data[MAX_IV_SIZE];
140 struct aead_request aead_req;
150 struct delayed_work work;
154 struct tls_sw_context_tx {
155 struct crypto_aead *aead_send;
156 struct crypto_wait async_wait;
157 struct tx_work tx_work;
158 struct tls_rec *open_rec;
159 struct list_head tx_list;
160 atomic_t encrypt_pending;
164 #define BIT_TX_SCHEDULED 0
165 #define BIT_TX_CLOSING 1
166 unsigned long tx_bitmask;
169 struct tls_sw_context_rx {
170 struct crypto_aead *aead_recv;
171 struct crypto_wait async_wait;
172 struct strparser strp;
173 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
174 void (*saved_data_ready)(struct sock *sk);
176 struct sk_buff *recv_pkt;
180 atomic_t decrypt_pending;
184 struct tls_record_info {
185 struct list_head list;
189 skb_frag_t frags[MAX_SKB_FRAGS];
192 struct tls_offload_context_tx {
193 struct crypto_aead *aead_send;
194 spinlock_t lock; /* protects records list */
195 struct list_head records_list;
196 struct tls_record_info *open_record;
197 struct tls_record_info *retransmit_hint;
199 u64 unacked_record_sn;
201 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
202 void (*sk_destruct)(struct sock *sk);
203 u8 driver_state[] __aligned(8);
204 /* The TLS layer reserves room for driver specific state
205 * Currently the belief is that there is not enough
206 * driver specific state to justify another layer of indirection
208 #define TLS_DRIVER_STATE_SIZE_TX 16
211 #define TLS_OFFLOAD_CONTEXT_SIZE_TX \
212 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
214 enum tls_context_flags {
215 TLS_RX_SYNC_RUNNING = 0,
216 /* Unlike RX where resync is driven entirely by the core in TX only
217 * the driver knows when things went out of sync, so we need the flag
220 TLS_TX_SYNC_SCHED = 1,
223 struct cipher_context {
228 union tls_crypto_context {
229 struct tls_crypto_info info;
231 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
232 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
236 struct tls_prot_info {
250 /* read-only cache line */
251 struct tls_prot_info prot_info;
256 int (*push_pending_record)(struct sock *sk, int flags);
257 void (*sk_write_space)(struct sock *sk);
262 struct net_device *netdev;
265 struct cipher_context tx;
266 struct cipher_context rx;
268 struct scatterlist *partially_sent_record;
269 u16 partially_sent_offset;
271 bool in_tcp_sendpages;
272 bool pending_open_record_frags;
274 struct mutex tx_lock; /* protects partially_sent_* fields and
279 /* cache cold stuff */
280 struct proto *sk_proto;
282 void (*sk_destruct)(struct sock *sk);
284 union tls_crypto_context crypto_send;
285 union tls_crypto_context crypto_recv;
287 struct list_head list;
292 enum tls_offload_ctx_dir {
293 TLS_OFFLOAD_CTX_DIR_RX,
294 TLS_OFFLOAD_CTX_DIR_TX,
298 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
299 enum tls_offload_ctx_dir direction,
300 struct tls_crypto_info *crypto_info,
301 u32 start_offload_tcp_sn);
302 void (*tls_dev_del)(struct net_device *netdev,
303 struct tls_context *ctx,
304 enum tls_offload_ctx_dir direction);
305 int (*tls_dev_resync)(struct net_device *netdev,
306 struct sock *sk, u32 seq, u8 *rcd_sn,
307 enum tls_offload_ctx_dir direction);
310 enum tls_offload_sync_type {
311 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
312 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
315 #define TLS_DEVICE_RESYNC_NH_START_IVAL 2
316 #define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
318 struct tls_offload_context_rx {
319 /* sw must be the first member of tls_offload_context_rx */
320 struct tls_sw_context_rx sw;
321 enum tls_offload_sync_type resync_type;
322 /* this member is set regardless of resync_type, to avoid branches */
323 u8 resync_nh_reset:1;
324 /* CORE_NEXT_HINT-only member, but use the hole here */
325 u8 resync_nh_do_now:1;
327 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
329 atomic64_t resync_req;
331 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
333 u32 decrypted_failed;
337 u8 driver_state[] __aligned(8);
338 /* The TLS layer reserves room for driver specific state
339 * Currently the belief is that there is not enough
340 * driver specific state to justify another layer of indirection
342 #define TLS_DRIVER_STATE_SIZE_RX 8
345 #define TLS_OFFLOAD_CONTEXT_SIZE_RX \
346 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
348 void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
349 int wait_on_pending_writer(struct sock *sk, long *timeo);
350 int tls_sk_query(struct sock *sk, int optname, char __user *optval,
352 int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
353 unsigned int optlen);
355 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
356 void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
357 void tls_sw_strparser_done(struct tls_context *tls_ctx);
358 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
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 bool 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 struct tls_context *tls_get_ctx(const struct sock *sk)
478 struct inet_connection_sock *icsk = inet_csk(sk);
480 /* Use RCU on icsk_ulp_data only for sock diag code,
481 * TLS data path doesn't need rcu_dereference().
483 return (__force void *)icsk->icsk_ulp_data;
486 static inline void tls_advance_record_sn(struct sock *sk,
487 struct tls_prot_info *prot,
488 struct cipher_context *ctx)
490 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
491 tls_err_abort(sk, EBADMSG);
493 if (prot->version != TLS_1_3_VERSION)
494 tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
498 static inline void tls_fill_prepend(struct tls_context *ctx,
500 size_t plaintext_len,
501 unsigned char record_type,
504 struct tls_prot_info *prot = &ctx->prot_info;
505 size_t pkt_len, iv_size = prot->iv_size;
507 pkt_len = plaintext_len + prot->tag_size;
508 if (version != TLS_1_3_VERSION) {
511 memcpy(buf + TLS_NONCE_OFFSET,
512 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
515 /* we cover nonce explicit here as well, so buf should be of
516 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
518 buf[0] = version == TLS_1_3_VERSION ?
519 TLS_RECORD_TYPE_DATA : record_type;
520 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
521 buf[1] = TLS_1_2_VERSION_MINOR;
522 buf[2] = TLS_1_2_VERSION_MAJOR;
523 /* we can use IV for nonce explicit according to spec */
524 buf[3] = pkt_len >> 8;
525 buf[4] = pkt_len & 0xFF;
528 static inline void tls_make_aad(char *buf,
530 char *record_sequence,
531 int record_sequence_size,
532 unsigned char record_type,
535 if (version != TLS_1_3_VERSION) {
536 memcpy(buf, record_sequence, record_sequence_size);
539 size += TLS_CIPHER_AES_GCM_128_TAG_SIZE;
542 buf[0] = version == TLS_1_3_VERSION ?
543 TLS_RECORD_TYPE_DATA : record_type;
544 buf[1] = TLS_1_2_VERSION_MAJOR;
545 buf[2] = TLS_1_2_VERSION_MINOR;
547 buf[4] = size & 0xFF;
550 static inline void xor_iv_with_seq(int version, char *iv, char *seq)
554 if (version == TLS_1_3_VERSION) {
555 for (i = 0; i < 8; i++)
561 static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
562 const struct tls_context *tls_ctx)
564 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
567 static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
568 const struct tls_context *tls_ctx)
570 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
573 static inline struct tls_offload_context_tx *
574 tls_offload_ctx_tx(const struct tls_context *tls_ctx)
576 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
579 static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
581 struct tls_context *ctx = tls_get_ctx(sk);
585 return !!tls_sw_ctx_tx(ctx);
588 void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
589 void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
591 static inline struct tls_offload_context_rx *
592 tls_offload_ctx_rx(const struct tls_context *tls_ctx)
594 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
597 #if IS_ENABLED(CONFIG_TLS_DEVICE)
598 static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
599 enum tls_offload_ctx_dir direction)
601 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
602 return tls_offload_ctx_tx(tls_ctx)->driver_state;
604 return tls_offload_ctx_rx(tls_ctx)->driver_state;
608 tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
610 return __tls_driver_ctx(tls_get_ctx(sk), direction);
614 /* The TLS context is valid until sk_destruct is called */
615 static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
617 struct tls_context *tls_ctx = tls_get_ctx(sk);
618 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
620 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | 1);
624 tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
626 struct tls_context *tls_ctx = tls_get_ctx(sk);
628 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
631 static inline void tls_offload_tx_resync_request(struct sock *sk)
633 struct tls_context *tls_ctx = tls_get_ctx(sk);
635 WARN_ON(test_and_set_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags));
638 /* Driver's seq tracking has to be disabled until resync succeeded */
639 static inline bool tls_offload_tx_resync_pending(struct sock *sk)
641 struct tls_context *tls_ctx = tls_get_ctx(sk);
644 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
645 smp_mb__after_atomic();
649 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
650 unsigned char *record_type);
651 void tls_register_device(struct tls_device *device);
652 void tls_unregister_device(struct tls_device *device);
653 int decrypt_skb(struct sock *sk, struct sk_buff *skb,
654 struct scatterlist *sgout);
655 struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
657 struct sk_buff *tls_validate_xmit_skb(struct sock *sk,
658 struct net_device *dev,
659 struct sk_buff *skb);
661 int tls_sw_fallback_init(struct sock *sk,
662 struct tls_offload_context_tx *offload_ctx,
663 struct tls_crypto_info *crypto_info);
665 #ifdef CONFIG_TLS_DEVICE
666 void tls_device_init(void);
667 void tls_device_cleanup(void);
668 int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
669 void tls_device_free_resources_tx(struct sock *sk);
670 int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
671 void tls_device_offload_cleanup_rx(struct sock *sk);
672 void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
673 int tls_device_decrypted(struct sock *sk, struct sk_buff *skb);
675 static inline void tls_device_init(void) {}
676 static inline void tls_device_cleanup(void) {}
679 tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
684 static inline void tls_device_free_resources_tx(struct sock *sk) {}
687 tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
692 static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
694 tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
696 static inline int tls_device_decrypted(struct sock *sk, struct sk_buff *skb)
701 #endif /* _TLS_OFFLOAD_H */