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/netdevice.h>
46 #include <net/strparser.h>
47 #include <crypto/aead.h>
48 #include <uapi/linux/tls.h>
51 /* Maximum data size carried in a TLS record */
52 #define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
54 #define TLS_HEADER_SIZE 5
55 #define TLS_NONCE_OFFSET TLS_HEADER_SIZE
57 #define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
59 #define TLS_RECORD_TYPE_DATA 0x17
61 #define TLS_AAD_SPACE_SIZE 13
62 #define TLS_DEVICE_NAME_MAX 32
64 #define MAX_IV_SIZE 16
65 #define TLS_MAX_REC_SEQ_SIZE 8
67 /* For AES-CCM, the full 16-bytes of IV is made of '4' fields of given sizes.
69 * IV[16] = b0[1] || implicit nonce[4] || explicit nonce[8] || length[3]
71 * The field 'length' is encoded in field 'b0' as '(length width - 1)'.
72 * Hence b0 contains (3 - 1) = 2.
74 #define TLS_AES_CCM_IV_B0_BYTE 2
77 * This structure defines the routines for Inline TLS driver.
78 * The following routines are optional and filled with a
79 * null pointer if not defined.
81 * @name: Its the name of registered Inline tls device
82 * @dev_list: Inline tls device list
83 * int (*feature)(struct tls_device *device);
84 * Called to return Inline TLS driver capability
86 * int (*hash)(struct tls_device *device, struct sock *sk);
87 * This function sets Inline driver for listen and program
88 * device specific functioanlity as required
90 * void (*unhash)(struct tls_device *device, struct sock *sk);
91 * This function cleans listen state set by Inline TLS driver
93 * void (*release)(struct kref *kref);
94 * Release the registered device and allocated resources
95 * @kref: Number of reference to tls_device
98 char name[TLS_DEVICE_NAME_MAX];
99 struct list_head dev_list;
100 int (*feature)(struct tls_device *device);
101 int (*hash)(struct tls_device *device, struct sock *sk);
102 void (*unhash)(struct tls_device *device, struct sock *sk);
103 void (*release)(struct kref *kref);
110 #ifdef CONFIG_TLS_DEVICE
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 unsigned long tx_bitmask;
168 struct tls_sw_context_rx {
169 struct crypto_aead *aead_recv;
170 struct crypto_wait async_wait;
171 struct strparser strp;
172 struct sk_buff_head rx_list; /* list of decrypted 'data' records */
173 void (*saved_data_ready)(struct sock *sk);
175 struct sk_buff *recv_pkt;
179 atomic_t decrypt_pending;
183 struct tls_record_info {
184 struct list_head list;
188 skb_frag_t frags[MAX_SKB_FRAGS];
191 struct tls_offload_context_tx {
192 struct crypto_aead *aead_send;
193 spinlock_t lock; /* protects records list */
194 struct list_head records_list;
195 struct tls_record_info *open_record;
196 struct tls_record_info *retransmit_hint;
198 u64 unacked_record_sn;
200 struct scatterlist sg_tx_data[MAX_SKB_FRAGS];
201 void (*sk_destruct)(struct sock *sk);
202 u8 driver_state[] __aligned(8);
203 /* The TLS layer reserves room for driver specific state
204 * Currently the belief is that there is not enough
205 * driver specific state to justify another layer of indirection
207 #define TLS_DRIVER_STATE_SIZE_TX 16
210 #define TLS_OFFLOAD_CONTEXT_SIZE_TX \
211 (sizeof(struct tls_offload_context_tx) + TLS_DRIVER_STATE_SIZE_TX)
213 enum tls_context_flags {
214 TLS_RX_SYNC_RUNNING = 0,
215 /* Unlike RX where resync is driven entirely by the core in TX only
216 * the driver knows when things went out of sync, so we need the flag
219 TLS_TX_SYNC_SCHED = 1,
222 struct cipher_context {
227 union tls_crypto_context {
228 struct tls_crypto_info info;
230 struct tls12_crypto_info_aes_gcm_128 aes_gcm_128;
231 struct tls12_crypto_info_aes_gcm_256 aes_gcm_256;
235 struct tls_prot_info {
249 /* read-only cache line */
250 struct tls_prot_info prot_info;
255 int (*push_pending_record)(struct sock *sk, int flags);
256 void (*sk_write_space)(struct sock *sk);
261 struct net_device *netdev;
264 struct cipher_context tx;
265 struct cipher_context rx;
267 struct scatterlist *partially_sent_record;
268 u16 partially_sent_offset;
270 bool in_tcp_sendpages;
271 bool pending_open_record_frags;
274 /* cache cold stuff */
275 void (*sk_destruct)(struct sock *sk);
276 void (*sk_proto_close)(struct sock *sk, long timeout);
278 int (*setsockopt)(struct sock *sk, int level,
279 int optname, char __user *optval,
280 unsigned int optlen);
281 int (*getsockopt)(struct sock *sk, int level,
282 int optname, char __user *optval,
284 int (*hash)(struct sock *sk);
285 void (*unhash)(struct sock *sk);
287 union tls_crypto_context crypto_send;
288 union tls_crypto_context crypto_recv;
290 struct list_head list;
294 enum tls_offload_ctx_dir {
295 TLS_OFFLOAD_CTX_DIR_RX,
296 TLS_OFFLOAD_CTX_DIR_TX,
300 int (*tls_dev_add)(struct net_device *netdev, struct sock *sk,
301 enum tls_offload_ctx_dir direction,
302 struct tls_crypto_info *crypto_info,
303 u32 start_offload_tcp_sn);
304 void (*tls_dev_del)(struct net_device *netdev,
305 struct tls_context *ctx,
306 enum tls_offload_ctx_dir direction);
307 int (*tls_dev_resync)(struct net_device *netdev,
308 struct sock *sk, u32 seq, u8 *rcd_sn,
309 enum tls_offload_ctx_dir direction);
312 enum tls_offload_sync_type {
313 TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ = 0,
314 TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT = 1,
317 #define TLS_DEVICE_RESYNC_NH_START_IVAL 2
318 #define TLS_DEVICE_RESYNC_NH_MAX_IVAL 128
320 struct tls_offload_context_rx {
321 /* sw must be the first member of tls_offload_context_rx */
322 struct tls_sw_context_rx sw;
323 enum tls_offload_sync_type resync_type;
324 /* this member is set regardless of resync_type, to avoid branches */
325 u8 resync_nh_reset:1;
326 /* CORE_NEXT_HINT-only member, but use the hole here */
327 u8 resync_nh_do_now:1;
329 /* TLS_OFFLOAD_SYNC_TYPE_DRIVER_REQ */
331 atomic64_t resync_req;
333 /* TLS_OFFLOAD_SYNC_TYPE_CORE_NEXT_HINT */
335 u32 decrypted_failed;
339 u8 driver_state[] __aligned(8);
340 /* The TLS layer reserves room for driver specific state
341 * Currently the belief is that there is not enough
342 * driver specific state to justify another layer of indirection
344 #define TLS_DRIVER_STATE_SIZE_RX 8
347 #define TLS_OFFLOAD_CONTEXT_SIZE_RX \
348 (sizeof(struct tls_offload_context_rx) + TLS_DRIVER_STATE_SIZE_RX)
350 void tls_ctx_free(struct tls_context *ctx);
351 int wait_on_pending_writer(struct sock *sk, long *timeo);
352 int tls_sk_query(struct sock *sk, int optname, char __user *optval,
354 int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
355 unsigned int optlen);
357 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
358 void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
359 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
360 int tls_sw_sendpage(struct sock *sk, struct page *page,
361 int offset, size_t size, int flags);
362 void tls_sw_close(struct sock *sk, long timeout);
363 void tls_sw_free_resources_tx(struct sock *sk);
364 void tls_sw_free_resources_rx(struct sock *sk);
365 void tls_sw_release_resources_rx(struct sock *sk);
366 int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
367 int nonblock, int flags, int *addr_len);
368 bool tls_sw_stream_read(const struct sock *sk);
369 ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
370 struct pipe_inode_info *pipe,
371 size_t len, unsigned int flags);
373 int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
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 void tls_device_free_resources_tx(struct sock *sk);
378 void tls_device_init(void);
379 void tls_device_cleanup(void);
380 int tls_tx_records(struct sock *sk, int flags);
382 struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context,
383 u32 seq, u64 *p_record_sn);
385 static inline bool tls_record_is_start_marker(struct tls_record_info *rec)
387 return rec->len == 0;
390 static inline u32 tls_record_start_seq(struct tls_record_info *rec)
392 return rec->end_seq - rec->len;
395 int tls_push_sg(struct sock *sk, struct tls_context *ctx,
396 struct scatterlist *sg, u16 first_offset,
398 int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
400 bool tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
402 static inline struct tls_msg *tls_msg(struct sk_buff *skb)
404 return (struct tls_msg *)strp_msg(skb);
407 static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
409 return !!ctx->partially_sent_record;
412 static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
414 return tls_ctx->pending_open_record_frags;
417 static inline bool is_tx_ready(struct tls_sw_context_tx *ctx)
421 rec = list_first_entry(&ctx->tx_list, struct tls_rec, list);
425 return READ_ONCE(rec->tx_ready);
429 tls_validate_xmit_skb(struct sock *sk, struct net_device *dev,
430 struct sk_buff *skb);
432 static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk)
434 #ifdef CONFIG_SOCK_VALIDATE_XMIT
435 return sk_fullsock(sk) &&
436 (smp_load_acquire(&sk->sk_validate_xmit_skb) ==
437 &tls_validate_xmit_skb);
443 static inline void tls_err_abort(struct sock *sk, int err)
446 sk->sk_error_report(sk);
449 static inline bool tls_bigint_increment(unsigned char *seq, int len)
453 for (i = len - 1; i >= 0; i--) {
462 static inline struct tls_context *tls_get_ctx(const struct sock *sk)
464 struct inet_connection_sock *icsk = inet_csk(sk);
466 return icsk->icsk_ulp_data;
469 static inline void tls_advance_record_sn(struct sock *sk,
470 struct tls_prot_info *prot,
471 struct cipher_context *ctx)
473 if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
474 tls_err_abort(sk, EBADMSG);
476 if (prot->version != TLS_1_3_VERSION)
477 tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
481 static inline void tls_fill_prepend(struct tls_context *ctx,
483 size_t plaintext_len,
484 unsigned char record_type,
487 struct tls_prot_info *prot = &ctx->prot_info;
488 size_t pkt_len, iv_size = prot->iv_size;
490 pkt_len = plaintext_len + prot->tag_size;
491 if (version != TLS_1_3_VERSION) {
494 memcpy(buf + TLS_NONCE_OFFSET,
495 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
498 /* we cover nonce explicit here as well, so buf should be of
499 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
501 buf[0] = version == TLS_1_3_VERSION ?
502 TLS_RECORD_TYPE_DATA : record_type;
503 /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
504 buf[1] = TLS_1_2_VERSION_MINOR;
505 buf[2] = TLS_1_2_VERSION_MAJOR;
506 /* we can use IV for nonce explicit according to spec */
507 buf[3] = pkt_len >> 8;
508 buf[4] = pkt_len & 0xFF;
511 static inline void tls_make_aad(char *buf,
513 char *record_sequence,
514 int record_sequence_size,
515 unsigned char record_type,
518 if (version != TLS_1_3_VERSION) {
519 memcpy(buf, record_sequence, record_sequence_size);
522 size += TLS_CIPHER_AES_GCM_128_TAG_SIZE;
525 buf[0] = version == TLS_1_3_VERSION ?
526 TLS_RECORD_TYPE_DATA : record_type;
527 buf[1] = TLS_1_2_VERSION_MAJOR;
528 buf[2] = TLS_1_2_VERSION_MINOR;
530 buf[4] = size & 0xFF;
533 static inline void xor_iv_with_seq(int version, char *iv, char *seq)
537 if (version == TLS_1_3_VERSION) {
538 for (i = 0; i < 8; i++)
544 static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
545 const struct tls_context *tls_ctx)
547 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
550 static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
551 const struct tls_context *tls_ctx)
553 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
556 static inline struct tls_offload_context_tx *
557 tls_offload_ctx_tx(const struct tls_context *tls_ctx)
559 return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx;
562 static inline bool tls_sw_has_ctx_tx(const struct sock *sk)
564 struct tls_context *ctx = tls_get_ctx(sk);
568 return !!tls_sw_ctx_tx(ctx);
571 void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
572 void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
574 static inline struct tls_offload_context_rx *
575 tls_offload_ctx_rx(const struct tls_context *tls_ctx)
577 return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx;
580 #if IS_ENABLED(CONFIG_TLS_DEVICE)
581 static inline void *__tls_driver_ctx(struct tls_context *tls_ctx,
582 enum tls_offload_ctx_dir direction)
584 if (direction == TLS_OFFLOAD_CTX_DIR_TX)
585 return tls_offload_ctx_tx(tls_ctx)->driver_state;
587 return tls_offload_ctx_rx(tls_ctx)->driver_state;
591 tls_driver_ctx(const struct sock *sk, enum tls_offload_ctx_dir direction)
593 return __tls_driver_ctx(tls_get_ctx(sk), direction);
597 /* The TLS context is valid until sk_destruct is called */
598 static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq)
600 struct tls_context *tls_ctx = tls_get_ctx(sk);
601 struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx);
603 atomic64_set(&rx_ctx->resync_req, ((u64)ntohl(seq) << 32) | 1);
607 tls_offload_rx_resync_set_type(struct sock *sk, enum tls_offload_sync_type type)
609 struct tls_context *tls_ctx = tls_get_ctx(sk);
611 tls_offload_ctx_rx(tls_ctx)->resync_type = type;
614 static inline void tls_offload_tx_resync_request(struct sock *sk)
616 struct tls_context *tls_ctx = tls_get_ctx(sk);
618 WARN_ON(test_and_set_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags));
621 /* Driver's seq tracking has to be disabled until resync succeeded */
622 static inline bool tls_offload_tx_resync_pending(struct sock *sk)
624 struct tls_context *tls_ctx = tls_get_ctx(sk);
627 ret = test_bit(TLS_TX_SYNC_SCHED, &tls_ctx->flags);
628 smp_mb__after_atomic();
632 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
633 unsigned char *record_type);
634 void tls_register_device(struct tls_device *device);
635 void tls_unregister_device(struct tls_device *device);
636 int tls_device_decrypted(struct sock *sk, struct sk_buff *skb);
637 int decrypt_skb(struct sock *sk, struct sk_buff *skb,
638 struct scatterlist *sgout);
639 struct sk_buff *tls_encrypt_skb(struct sk_buff *skb);
641 struct sk_buff *tls_validate_xmit_skb(struct sock *sk,
642 struct net_device *dev,
643 struct sk_buff *skb);
645 int tls_sw_fallback_init(struct sock *sk,
646 struct tls_offload_context_tx *offload_ctx,
647 struct tls_crypto_info *crypto_info);
649 int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
651 void tls_device_offload_cleanup_rx(struct sock *sk);
652 void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
654 #endif /* _TLS_OFFLOAD_H */