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 #include <linux/module.h>
37 #include <net/inet_common.h>
38 #include <linux/highmem.h>
39 #include <linux/netdevice.h>
40 #include <linux/sched/signal.h>
41 #include <linux/inetdevice.h>
42 #include <linux/inet_diag.h>
46 #include <net/tls_toe.h>
50 MODULE_AUTHOR("Mellanox Technologies");
51 MODULE_DESCRIPTION("Transport Layer Security Support");
52 MODULE_LICENSE("Dual BSD/GPL");
53 MODULE_ALIAS_TCP_ULP("tls");
61 #define CIPHER_SIZE_DESC(cipher) [cipher] = { \
62 .iv = cipher ## _IV_SIZE, \
63 .key = cipher ## _KEY_SIZE, \
64 .salt = cipher ## _SALT_SIZE, \
65 .tag = cipher ## _TAG_SIZE, \
66 .rec_seq = cipher ## _REC_SEQ_SIZE, \
69 const struct tls_cipher_size_desc tls_cipher_size_desc[] = {
70 CIPHER_SIZE_DESC(TLS_CIPHER_AES_GCM_128),
71 CIPHER_SIZE_DESC(TLS_CIPHER_AES_GCM_256),
72 CIPHER_SIZE_DESC(TLS_CIPHER_AES_CCM_128),
73 CIPHER_SIZE_DESC(TLS_CIPHER_CHACHA20_POLY1305),
74 CIPHER_SIZE_DESC(TLS_CIPHER_SM4_GCM),
75 CIPHER_SIZE_DESC(TLS_CIPHER_SM4_CCM),
78 static const struct proto *saved_tcpv6_prot;
79 static DEFINE_MUTEX(tcpv6_prot_mutex);
80 static const struct proto *saved_tcpv4_prot;
81 static DEFINE_MUTEX(tcpv4_prot_mutex);
82 static struct proto tls_prots[TLS_NUM_PROTS][TLS_NUM_CONFIG][TLS_NUM_CONFIG];
83 static struct proto_ops tls_proto_ops[TLS_NUM_PROTS][TLS_NUM_CONFIG][TLS_NUM_CONFIG];
84 static void build_protos(struct proto prot[TLS_NUM_CONFIG][TLS_NUM_CONFIG],
85 const struct proto *base);
87 void update_sk_prot(struct sock *sk, struct tls_context *ctx)
89 int ip_ver = sk->sk_family == AF_INET6 ? TLSV6 : TLSV4;
91 WRITE_ONCE(sk->sk_prot,
92 &tls_prots[ip_ver][ctx->tx_conf][ctx->rx_conf]);
93 WRITE_ONCE(sk->sk_socket->ops,
94 &tls_proto_ops[ip_ver][ctx->tx_conf][ctx->rx_conf]);
97 int wait_on_pending_writer(struct sock *sk, long *timeo)
100 DEFINE_WAIT_FUNC(wait, woken_wake_function);
102 add_wait_queue(sk_sleep(sk), &wait);
109 if (signal_pending(current)) {
110 rc = sock_intr_errno(*timeo);
114 if (sk_wait_event(sk, timeo,
115 !READ_ONCE(sk->sk_write_pending), &wait))
118 remove_wait_queue(sk_sleep(sk), &wait);
122 int tls_push_sg(struct sock *sk,
123 struct tls_context *ctx,
124 struct scatterlist *sg,
129 struct msghdr msg = {
130 .msg_flags = MSG_SENDPAGE_NOTLAST | MSG_SPLICE_PAGES | flags,
135 int offset = first_offset;
137 size = sg->length - offset;
138 offset += sg->offset;
140 ctx->splicing_pages = true;
143 msg.msg_flags = flags;
145 /* is sending application-limited? */
146 tcp_rate_check_app_limited(sk);
149 bvec_set_page(&bvec, p, size, offset);
150 iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, &bvec, 1, size);
152 ret = tcp_sendmsg_locked(sk, &msg, size);
161 offset -= sg->offset;
162 ctx->partially_sent_offset = offset;
163 ctx->partially_sent_record = (void *)sg;
164 ctx->splicing_pages = false;
169 sk_mem_uncharge(sk, sg->length);
178 ctx->splicing_pages = false;
183 static int tls_handle_open_record(struct sock *sk, int flags)
185 struct tls_context *ctx = tls_get_ctx(sk);
187 if (tls_is_pending_open_record(ctx))
188 return ctx->push_pending_record(sk, flags);
193 int tls_process_cmsg(struct sock *sk, struct msghdr *msg,
194 unsigned char *record_type)
196 struct cmsghdr *cmsg;
199 for_each_cmsghdr(cmsg, msg) {
200 if (!CMSG_OK(msg, cmsg))
202 if (cmsg->cmsg_level != SOL_TLS)
205 switch (cmsg->cmsg_type) {
206 case TLS_SET_RECORD_TYPE:
207 if (cmsg->cmsg_len < CMSG_LEN(sizeof(*record_type)))
210 if (msg->msg_flags & MSG_MORE)
213 rc = tls_handle_open_record(sk, msg->msg_flags);
217 *record_type = *(unsigned char *)CMSG_DATA(cmsg);
228 int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
231 struct scatterlist *sg;
234 sg = ctx->partially_sent_record;
235 offset = ctx->partially_sent_offset;
237 ctx->partially_sent_record = NULL;
238 return tls_push_sg(sk, ctx, sg, offset, flags);
241 void tls_free_partial_record(struct sock *sk, struct tls_context *ctx)
243 struct scatterlist *sg;
245 for (sg = ctx->partially_sent_record; sg; sg = sg_next(sg)) {
246 put_page(sg_page(sg));
247 sk_mem_uncharge(sk, sg->length);
249 ctx->partially_sent_record = NULL;
252 static void tls_write_space(struct sock *sk)
254 struct tls_context *ctx = tls_get_ctx(sk);
256 /* If splicing_pages call lower protocol write space handler
257 * to ensure we wake up any waiting operations there. For example
258 * if splicing pages where to call sk_wait_event.
260 if (ctx->splicing_pages) {
261 ctx->sk_write_space(sk);
265 #ifdef CONFIG_TLS_DEVICE
266 if (ctx->tx_conf == TLS_HW)
267 tls_device_write_space(sk, ctx);
270 tls_sw_write_space(sk, ctx);
272 ctx->sk_write_space(sk);
276 * tls_ctx_free() - free TLS ULP context
277 * @sk: socket to with @ctx is attached
278 * @ctx: TLS context structure
280 * Free TLS context. If @sk is %NULL caller guarantees that the socket
281 * to which @ctx was attached has no outstanding references.
283 void tls_ctx_free(struct sock *sk, struct tls_context *ctx)
288 memzero_explicit(&ctx->crypto_send, sizeof(ctx->crypto_send));
289 memzero_explicit(&ctx->crypto_recv, sizeof(ctx->crypto_recv));
290 mutex_destroy(&ctx->tx_lock);
298 static void tls_sk_proto_cleanup(struct sock *sk,
299 struct tls_context *ctx, long timeo)
301 if (unlikely(sk->sk_write_pending) &&
302 !wait_on_pending_writer(sk, &timeo))
303 tls_handle_open_record(sk, 0);
305 /* We need these for tls_sw_fallback handling of other packets */
306 if (ctx->tx_conf == TLS_SW) {
307 kfree(ctx->tx.rec_seq);
309 tls_sw_release_resources_tx(sk);
310 TLS_DEC_STATS(sock_net(sk), LINUX_MIB_TLSCURRTXSW);
311 } else if (ctx->tx_conf == TLS_HW) {
312 tls_device_free_resources_tx(sk);
313 TLS_DEC_STATS(sock_net(sk), LINUX_MIB_TLSCURRTXDEVICE);
316 if (ctx->rx_conf == TLS_SW) {
317 tls_sw_release_resources_rx(sk);
318 TLS_DEC_STATS(sock_net(sk), LINUX_MIB_TLSCURRRXSW);
319 } else if (ctx->rx_conf == TLS_HW) {
320 tls_device_offload_cleanup_rx(sk);
321 TLS_DEC_STATS(sock_net(sk), LINUX_MIB_TLSCURRRXDEVICE);
325 static void tls_sk_proto_close(struct sock *sk, long timeout)
327 struct inet_connection_sock *icsk = inet_csk(sk);
328 struct tls_context *ctx = tls_get_ctx(sk);
329 long timeo = sock_sndtimeo(sk, 0);
332 if (ctx->tx_conf == TLS_SW)
333 tls_sw_cancel_work_tx(ctx);
336 free_ctx = ctx->tx_conf != TLS_HW && ctx->rx_conf != TLS_HW;
338 if (ctx->tx_conf != TLS_BASE || ctx->rx_conf != TLS_BASE)
339 tls_sk_proto_cleanup(sk, ctx, timeo);
341 write_lock_bh(&sk->sk_callback_lock);
343 rcu_assign_pointer(icsk->icsk_ulp_data, NULL);
344 WRITE_ONCE(sk->sk_prot, ctx->sk_proto);
345 if (sk->sk_write_space == tls_write_space)
346 sk->sk_write_space = ctx->sk_write_space;
347 write_unlock_bh(&sk->sk_callback_lock);
349 if (ctx->tx_conf == TLS_SW)
350 tls_sw_free_ctx_tx(ctx);
351 if (ctx->rx_conf == TLS_SW || ctx->rx_conf == TLS_HW)
352 tls_sw_strparser_done(ctx);
353 if (ctx->rx_conf == TLS_SW)
354 tls_sw_free_ctx_rx(ctx);
355 ctx->sk_proto->close(sk, timeout);
358 tls_ctx_free(sk, ctx);
361 static int do_tls_getsockopt_conf(struct sock *sk, char __user *optval,
362 int __user *optlen, int tx)
365 struct tls_context *ctx = tls_get_ctx(sk);
366 struct tls_crypto_info *crypto_info;
367 struct cipher_context *cctx;
370 if (get_user(len, optlen))
373 if (!optval || (len < sizeof(*crypto_info))) {
383 /* get user crypto info */
385 crypto_info = &ctx->crypto_send.info;
388 crypto_info = &ctx->crypto_recv.info;
392 if (!TLS_CRYPTO_INFO_READY(crypto_info)) {
397 if (len == sizeof(*crypto_info)) {
398 if (copy_to_user(optval, crypto_info, sizeof(*crypto_info)))
403 switch (crypto_info->cipher_type) {
404 case TLS_CIPHER_AES_GCM_128: {
405 struct tls12_crypto_info_aes_gcm_128 *
406 crypto_info_aes_gcm_128 =
407 container_of(crypto_info,
408 struct tls12_crypto_info_aes_gcm_128,
411 if (len != sizeof(*crypto_info_aes_gcm_128)) {
415 memcpy(crypto_info_aes_gcm_128->iv,
416 cctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
417 TLS_CIPHER_AES_GCM_128_IV_SIZE);
418 memcpy(crypto_info_aes_gcm_128->rec_seq, cctx->rec_seq,
419 TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE);
420 if (copy_to_user(optval,
421 crypto_info_aes_gcm_128,
422 sizeof(*crypto_info_aes_gcm_128)))
426 case TLS_CIPHER_AES_GCM_256: {
427 struct tls12_crypto_info_aes_gcm_256 *
428 crypto_info_aes_gcm_256 =
429 container_of(crypto_info,
430 struct tls12_crypto_info_aes_gcm_256,
433 if (len != sizeof(*crypto_info_aes_gcm_256)) {
437 memcpy(crypto_info_aes_gcm_256->iv,
438 cctx->iv + TLS_CIPHER_AES_GCM_256_SALT_SIZE,
439 TLS_CIPHER_AES_GCM_256_IV_SIZE);
440 memcpy(crypto_info_aes_gcm_256->rec_seq, cctx->rec_seq,
441 TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE);
442 if (copy_to_user(optval,
443 crypto_info_aes_gcm_256,
444 sizeof(*crypto_info_aes_gcm_256)))
448 case TLS_CIPHER_AES_CCM_128: {
449 struct tls12_crypto_info_aes_ccm_128 *aes_ccm_128 =
450 container_of(crypto_info,
451 struct tls12_crypto_info_aes_ccm_128, info);
453 if (len != sizeof(*aes_ccm_128)) {
457 memcpy(aes_ccm_128->iv,
458 cctx->iv + TLS_CIPHER_AES_CCM_128_SALT_SIZE,
459 TLS_CIPHER_AES_CCM_128_IV_SIZE);
460 memcpy(aes_ccm_128->rec_seq, cctx->rec_seq,
461 TLS_CIPHER_AES_CCM_128_REC_SEQ_SIZE);
462 if (copy_to_user(optval, aes_ccm_128, sizeof(*aes_ccm_128)))
466 case TLS_CIPHER_CHACHA20_POLY1305: {
467 struct tls12_crypto_info_chacha20_poly1305 *chacha20_poly1305 =
468 container_of(crypto_info,
469 struct tls12_crypto_info_chacha20_poly1305,
472 if (len != sizeof(*chacha20_poly1305)) {
476 memcpy(chacha20_poly1305->iv,
477 cctx->iv + TLS_CIPHER_CHACHA20_POLY1305_SALT_SIZE,
478 TLS_CIPHER_CHACHA20_POLY1305_IV_SIZE);
479 memcpy(chacha20_poly1305->rec_seq, cctx->rec_seq,
480 TLS_CIPHER_CHACHA20_POLY1305_REC_SEQ_SIZE);
481 if (copy_to_user(optval, chacha20_poly1305,
482 sizeof(*chacha20_poly1305)))
486 case TLS_CIPHER_SM4_GCM: {
487 struct tls12_crypto_info_sm4_gcm *sm4_gcm_info =
488 container_of(crypto_info,
489 struct tls12_crypto_info_sm4_gcm, info);
491 if (len != sizeof(*sm4_gcm_info)) {
495 memcpy(sm4_gcm_info->iv,
496 cctx->iv + TLS_CIPHER_SM4_GCM_SALT_SIZE,
497 TLS_CIPHER_SM4_GCM_IV_SIZE);
498 memcpy(sm4_gcm_info->rec_seq, cctx->rec_seq,
499 TLS_CIPHER_SM4_GCM_REC_SEQ_SIZE);
500 if (copy_to_user(optval, sm4_gcm_info, sizeof(*sm4_gcm_info)))
504 case TLS_CIPHER_SM4_CCM: {
505 struct tls12_crypto_info_sm4_ccm *sm4_ccm_info =
506 container_of(crypto_info,
507 struct tls12_crypto_info_sm4_ccm, info);
509 if (len != sizeof(*sm4_ccm_info)) {
513 memcpy(sm4_ccm_info->iv,
514 cctx->iv + TLS_CIPHER_SM4_CCM_SALT_SIZE,
515 TLS_CIPHER_SM4_CCM_IV_SIZE);
516 memcpy(sm4_ccm_info->rec_seq, cctx->rec_seq,
517 TLS_CIPHER_SM4_CCM_REC_SEQ_SIZE);
518 if (copy_to_user(optval, sm4_ccm_info, sizeof(*sm4_ccm_info)))
522 case TLS_CIPHER_ARIA_GCM_128: {
523 struct tls12_crypto_info_aria_gcm_128 *
524 crypto_info_aria_gcm_128 =
525 container_of(crypto_info,
526 struct tls12_crypto_info_aria_gcm_128,
529 if (len != sizeof(*crypto_info_aria_gcm_128)) {
533 memcpy(crypto_info_aria_gcm_128->iv,
534 cctx->iv + TLS_CIPHER_ARIA_GCM_128_SALT_SIZE,
535 TLS_CIPHER_ARIA_GCM_128_IV_SIZE);
536 memcpy(crypto_info_aria_gcm_128->rec_seq, cctx->rec_seq,
537 TLS_CIPHER_ARIA_GCM_128_REC_SEQ_SIZE);
538 if (copy_to_user(optval,
539 crypto_info_aria_gcm_128,
540 sizeof(*crypto_info_aria_gcm_128)))
544 case TLS_CIPHER_ARIA_GCM_256: {
545 struct tls12_crypto_info_aria_gcm_256 *
546 crypto_info_aria_gcm_256 =
547 container_of(crypto_info,
548 struct tls12_crypto_info_aria_gcm_256,
551 if (len != sizeof(*crypto_info_aria_gcm_256)) {
555 memcpy(crypto_info_aria_gcm_256->iv,
556 cctx->iv + TLS_CIPHER_ARIA_GCM_256_SALT_SIZE,
557 TLS_CIPHER_ARIA_GCM_256_IV_SIZE);
558 memcpy(crypto_info_aria_gcm_256->rec_seq, cctx->rec_seq,
559 TLS_CIPHER_ARIA_GCM_256_REC_SEQ_SIZE);
560 if (copy_to_user(optval,
561 crypto_info_aria_gcm_256,
562 sizeof(*crypto_info_aria_gcm_256)))
574 static int do_tls_getsockopt_tx_zc(struct sock *sk, char __user *optval,
577 struct tls_context *ctx = tls_get_ctx(sk);
581 if (get_user(len, optlen))
584 if (len != sizeof(value))
587 value = ctx->zerocopy_sendfile;
588 if (copy_to_user(optval, &value, sizeof(value)))
594 static int do_tls_getsockopt_no_pad(struct sock *sk, char __user *optval,
597 struct tls_context *ctx = tls_get_ctx(sk);
600 if (ctx->prot_info.version != TLS_1_3_VERSION)
603 if (get_user(len, optlen))
605 if (len < sizeof(value))
609 if (ctx->rx_conf == TLS_SW || ctx->rx_conf == TLS_HW)
610 value = ctx->rx_no_pad;
614 if (put_user(sizeof(value), optlen))
616 if (copy_to_user(optval, &value, sizeof(value)))
622 static int do_tls_getsockopt(struct sock *sk, int optname,
623 char __user *optval, int __user *optlen)
632 rc = do_tls_getsockopt_conf(sk, optval, optlen,
635 case TLS_TX_ZEROCOPY_RO:
636 rc = do_tls_getsockopt_tx_zc(sk, optval, optlen);
638 case TLS_RX_EXPECT_NO_PAD:
639 rc = do_tls_getsockopt_no_pad(sk, optval, optlen);
651 static int tls_getsockopt(struct sock *sk, int level, int optname,
652 char __user *optval, int __user *optlen)
654 struct tls_context *ctx = tls_get_ctx(sk);
656 if (level != SOL_TLS)
657 return ctx->sk_proto->getsockopt(sk, level,
658 optname, optval, optlen);
660 return do_tls_getsockopt(sk, optname, optval, optlen);
663 static int do_tls_setsockopt_conf(struct sock *sk, sockptr_t optval,
664 unsigned int optlen, int tx)
666 struct tls_crypto_info *crypto_info;
667 struct tls_crypto_info *alt_crypto_info;
668 struct tls_context *ctx = tls_get_ctx(sk);
673 if (sockptr_is_null(optval) || (optlen < sizeof(*crypto_info)))
677 crypto_info = &ctx->crypto_send.info;
678 alt_crypto_info = &ctx->crypto_recv.info;
680 crypto_info = &ctx->crypto_recv.info;
681 alt_crypto_info = &ctx->crypto_send.info;
684 /* Currently we don't support set crypto info more than one time */
685 if (TLS_CRYPTO_INFO_READY(crypto_info))
688 rc = copy_from_sockptr(crypto_info, optval, sizeof(*crypto_info));
691 goto err_crypto_info;
695 if (crypto_info->version != TLS_1_2_VERSION &&
696 crypto_info->version != TLS_1_3_VERSION) {
698 goto err_crypto_info;
701 /* Ensure that TLS version and ciphers are same in both directions */
702 if (TLS_CRYPTO_INFO_READY(alt_crypto_info)) {
703 if (alt_crypto_info->version != crypto_info->version ||
704 alt_crypto_info->cipher_type != crypto_info->cipher_type) {
706 goto err_crypto_info;
710 switch (crypto_info->cipher_type) {
711 case TLS_CIPHER_AES_GCM_128:
712 optsize = sizeof(struct tls12_crypto_info_aes_gcm_128);
714 case TLS_CIPHER_AES_GCM_256: {
715 optsize = sizeof(struct tls12_crypto_info_aes_gcm_256);
718 case TLS_CIPHER_AES_CCM_128:
719 optsize = sizeof(struct tls12_crypto_info_aes_ccm_128);
721 case TLS_CIPHER_CHACHA20_POLY1305:
722 optsize = sizeof(struct tls12_crypto_info_chacha20_poly1305);
724 case TLS_CIPHER_SM4_GCM:
725 optsize = sizeof(struct tls12_crypto_info_sm4_gcm);
727 case TLS_CIPHER_SM4_CCM:
728 optsize = sizeof(struct tls12_crypto_info_sm4_ccm);
730 case TLS_CIPHER_ARIA_GCM_128:
731 if (crypto_info->version != TLS_1_2_VERSION) {
733 goto err_crypto_info;
735 optsize = sizeof(struct tls12_crypto_info_aria_gcm_128);
737 case TLS_CIPHER_ARIA_GCM_256:
738 if (crypto_info->version != TLS_1_2_VERSION) {
740 goto err_crypto_info;
742 optsize = sizeof(struct tls12_crypto_info_aria_gcm_256);
746 goto err_crypto_info;
749 if (optlen != optsize) {
751 goto err_crypto_info;
754 rc = copy_from_sockptr_offset(crypto_info + 1, optval,
755 sizeof(*crypto_info),
756 optlen - sizeof(*crypto_info));
759 goto err_crypto_info;
763 rc = tls_set_device_offload(sk, ctx);
766 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSTXDEVICE);
767 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSCURRTXDEVICE);
769 rc = tls_set_sw_offload(sk, ctx, 1);
771 goto err_crypto_info;
772 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSTXSW);
773 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSCURRTXSW);
777 rc = tls_set_device_offload_rx(sk, ctx);
780 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSRXDEVICE);
781 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSCURRRXDEVICE);
783 rc = tls_set_sw_offload(sk, ctx, 0);
785 goto err_crypto_info;
786 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSRXSW);
787 TLS_INC_STATS(sock_net(sk), LINUX_MIB_TLSCURRRXSW);
790 tls_sw_strparser_arm(sk, ctx);
797 update_sk_prot(sk, ctx);
799 ctx->sk_write_space = sk->sk_write_space;
800 sk->sk_write_space = tls_write_space;
802 struct tls_sw_context_rx *rx_ctx = tls_sw_ctx_rx(ctx);
804 tls_strp_check_rcv(&rx_ctx->strp);
809 memzero_explicit(crypto_info, sizeof(union tls_crypto_context));
813 static int do_tls_setsockopt_tx_zc(struct sock *sk, sockptr_t optval,
816 struct tls_context *ctx = tls_get_ctx(sk);
819 if (sockptr_is_null(optval) || optlen != sizeof(value))
822 if (copy_from_sockptr(&value, optval, sizeof(value)))
828 ctx->zerocopy_sendfile = value;
833 static int do_tls_setsockopt_no_pad(struct sock *sk, sockptr_t optval,
836 struct tls_context *ctx = tls_get_ctx(sk);
840 if (ctx->prot_info.version != TLS_1_3_VERSION ||
841 sockptr_is_null(optval) || optlen < sizeof(val))
844 rc = copy_from_sockptr(&val, optval, sizeof(val));
849 rc = check_zeroed_sockptr(optval, sizeof(val), optlen - sizeof(val));
851 return rc == 0 ? -EINVAL : rc;
855 if (ctx->rx_conf == TLS_SW || ctx->rx_conf == TLS_HW) {
856 ctx->rx_no_pad = val;
857 tls_update_rx_zc_capable(ctx);
865 static int do_tls_setsockopt(struct sock *sk, int optname, sockptr_t optval,
874 rc = do_tls_setsockopt_conf(sk, optval, optlen,
878 case TLS_TX_ZEROCOPY_RO:
880 rc = do_tls_setsockopt_tx_zc(sk, optval, optlen);
883 case TLS_RX_EXPECT_NO_PAD:
884 rc = do_tls_setsockopt_no_pad(sk, optval, optlen);
893 static int tls_setsockopt(struct sock *sk, int level, int optname,
894 sockptr_t optval, unsigned int optlen)
896 struct tls_context *ctx = tls_get_ctx(sk);
898 if (level != SOL_TLS)
899 return ctx->sk_proto->setsockopt(sk, level, optname, optval,
902 return do_tls_setsockopt(sk, optname, optval, optlen);
905 struct tls_context *tls_ctx_create(struct sock *sk)
907 struct inet_connection_sock *icsk = inet_csk(sk);
908 struct tls_context *ctx;
910 ctx = kzalloc(sizeof(*ctx), GFP_ATOMIC);
914 mutex_init(&ctx->tx_lock);
915 rcu_assign_pointer(icsk->icsk_ulp_data, ctx);
916 ctx->sk_proto = READ_ONCE(sk->sk_prot);
921 static void build_proto_ops(struct proto_ops ops[TLS_NUM_CONFIG][TLS_NUM_CONFIG],
922 const struct proto_ops *base)
924 ops[TLS_BASE][TLS_BASE] = *base;
926 ops[TLS_SW ][TLS_BASE] = ops[TLS_BASE][TLS_BASE];
927 ops[TLS_SW ][TLS_BASE].sendpage_locked = tls_sw_sendpage_locked;
929 ops[TLS_BASE][TLS_SW ] = ops[TLS_BASE][TLS_BASE];
930 ops[TLS_BASE][TLS_SW ].splice_read = tls_sw_splice_read;
932 ops[TLS_SW ][TLS_SW ] = ops[TLS_SW ][TLS_BASE];
933 ops[TLS_SW ][TLS_SW ].splice_read = tls_sw_splice_read;
935 #ifdef CONFIG_TLS_DEVICE
936 ops[TLS_HW ][TLS_BASE] = ops[TLS_BASE][TLS_BASE];
937 ops[TLS_HW ][TLS_BASE].sendpage_locked = NULL;
939 ops[TLS_HW ][TLS_SW ] = ops[TLS_BASE][TLS_SW ];
940 ops[TLS_HW ][TLS_SW ].sendpage_locked = NULL;
942 ops[TLS_BASE][TLS_HW ] = ops[TLS_BASE][TLS_SW ];
944 ops[TLS_SW ][TLS_HW ] = ops[TLS_SW ][TLS_SW ];
946 ops[TLS_HW ][TLS_HW ] = ops[TLS_HW ][TLS_SW ];
947 ops[TLS_HW ][TLS_HW ].sendpage_locked = NULL;
949 #ifdef CONFIG_TLS_TOE
950 ops[TLS_HW_RECORD][TLS_HW_RECORD] = *base;
954 static void tls_build_proto(struct sock *sk)
956 int ip_ver = sk->sk_family == AF_INET6 ? TLSV6 : TLSV4;
957 struct proto *prot = READ_ONCE(sk->sk_prot);
959 /* Build IPv6 TLS whenever the address of tcpv6 _prot changes */
960 if (ip_ver == TLSV6 &&
961 unlikely(prot != smp_load_acquire(&saved_tcpv6_prot))) {
962 mutex_lock(&tcpv6_prot_mutex);
963 if (likely(prot != saved_tcpv6_prot)) {
964 build_protos(tls_prots[TLSV6], prot);
965 build_proto_ops(tls_proto_ops[TLSV6],
967 smp_store_release(&saved_tcpv6_prot, prot);
969 mutex_unlock(&tcpv6_prot_mutex);
972 if (ip_ver == TLSV4 &&
973 unlikely(prot != smp_load_acquire(&saved_tcpv4_prot))) {
974 mutex_lock(&tcpv4_prot_mutex);
975 if (likely(prot != saved_tcpv4_prot)) {
976 build_protos(tls_prots[TLSV4], prot);
977 build_proto_ops(tls_proto_ops[TLSV4],
979 smp_store_release(&saved_tcpv4_prot, prot);
981 mutex_unlock(&tcpv4_prot_mutex);
985 static void build_protos(struct proto prot[TLS_NUM_CONFIG][TLS_NUM_CONFIG],
986 const struct proto *base)
988 prot[TLS_BASE][TLS_BASE] = *base;
989 prot[TLS_BASE][TLS_BASE].setsockopt = tls_setsockopt;
990 prot[TLS_BASE][TLS_BASE].getsockopt = tls_getsockopt;
991 prot[TLS_BASE][TLS_BASE].close = tls_sk_proto_close;
993 prot[TLS_SW][TLS_BASE] = prot[TLS_BASE][TLS_BASE];
994 prot[TLS_SW][TLS_BASE].sendmsg = tls_sw_sendmsg;
995 prot[TLS_SW][TLS_BASE].sendpage = tls_sw_sendpage;
997 prot[TLS_BASE][TLS_SW] = prot[TLS_BASE][TLS_BASE];
998 prot[TLS_BASE][TLS_SW].recvmsg = tls_sw_recvmsg;
999 prot[TLS_BASE][TLS_SW].sock_is_readable = tls_sw_sock_is_readable;
1000 prot[TLS_BASE][TLS_SW].close = tls_sk_proto_close;
1002 prot[TLS_SW][TLS_SW] = prot[TLS_SW][TLS_BASE];
1003 prot[TLS_SW][TLS_SW].recvmsg = tls_sw_recvmsg;
1004 prot[TLS_SW][TLS_SW].sock_is_readable = tls_sw_sock_is_readable;
1005 prot[TLS_SW][TLS_SW].close = tls_sk_proto_close;
1007 #ifdef CONFIG_TLS_DEVICE
1008 prot[TLS_HW][TLS_BASE] = prot[TLS_BASE][TLS_BASE];
1009 prot[TLS_HW][TLS_BASE].sendmsg = tls_device_sendmsg;
1010 prot[TLS_HW][TLS_BASE].sendpage = tls_device_sendpage;
1012 prot[TLS_HW][TLS_SW] = prot[TLS_BASE][TLS_SW];
1013 prot[TLS_HW][TLS_SW].sendmsg = tls_device_sendmsg;
1014 prot[TLS_HW][TLS_SW].sendpage = tls_device_sendpage;
1016 prot[TLS_BASE][TLS_HW] = prot[TLS_BASE][TLS_SW];
1018 prot[TLS_SW][TLS_HW] = prot[TLS_SW][TLS_SW];
1020 prot[TLS_HW][TLS_HW] = prot[TLS_HW][TLS_SW];
1022 #ifdef CONFIG_TLS_TOE
1023 prot[TLS_HW_RECORD][TLS_HW_RECORD] = *base;
1024 prot[TLS_HW_RECORD][TLS_HW_RECORD].hash = tls_toe_hash;
1025 prot[TLS_HW_RECORD][TLS_HW_RECORD].unhash = tls_toe_unhash;
1029 static int tls_init(struct sock *sk)
1031 struct tls_context *ctx;
1034 tls_build_proto(sk);
1036 #ifdef CONFIG_TLS_TOE
1037 if (tls_toe_bypass(sk))
1041 /* The TLS ulp is currently supported only for TCP sockets
1042 * in ESTABLISHED state.
1043 * Supporting sockets in LISTEN state will require us
1044 * to modify the accept implementation to clone rather then
1045 * share the ulp context.
1047 if (sk->sk_state != TCP_ESTABLISHED)
1050 /* allocate tls context */
1051 write_lock_bh(&sk->sk_callback_lock);
1052 ctx = tls_ctx_create(sk);
1058 ctx->tx_conf = TLS_BASE;
1059 ctx->rx_conf = TLS_BASE;
1060 update_sk_prot(sk, ctx);
1062 write_unlock_bh(&sk->sk_callback_lock);
1066 static void tls_update(struct sock *sk, struct proto *p,
1067 void (*write_space)(struct sock *sk))
1069 struct tls_context *ctx;
1071 WARN_ON_ONCE(sk->sk_prot == p);
1073 ctx = tls_get_ctx(sk);
1075 ctx->sk_write_space = write_space;
1078 /* Pairs with lockless read in sk_clone_lock(). */
1079 WRITE_ONCE(sk->sk_prot, p);
1080 sk->sk_write_space = write_space;
1084 static u16 tls_user_config(struct tls_context *ctx, bool tx)
1086 u16 config = tx ? ctx->tx_conf : ctx->rx_conf;
1090 return TLS_CONF_BASE;
1096 return TLS_CONF_HW_RECORD;
1101 static int tls_get_info(const struct sock *sk, struct sk_buff *skb)
1103 u16 version, cipher_type;
1104 struct tls_context *ctx;
1105 struct nlattr *start;
1108 start = nla_nest_start_noflag(skb, INET_ULP_INFO_TLS);
1113 ctx = rcu_dereference(inet_csk(sk)->icsk_ulp_data);
1118 version = ctx->prot_info.version;
1120 err = nla_put_u16(skb, TLS_INFO_VERSION, version);
1124 cipher_type = ctx->prot_info.cipher_type;
1126 err = nla_put_u16(skb, TLS_INFO_CIPHER, cipher_type);
1130 err = nla_put_u16(skb, TLS_INFO_TXCONF, tls_user_config(ctx, true));
1134 err = nla_put_u16(skb, TLS_INFO_RXCONF, tls_user_config(ctx, false));
1138 if (ctx->tx_conf == TLS_HW && ctx->zerocopy_sendfile) {
1139 err = nla_put_flag(skb, TLS_INFO_ZC_RO_TX);
1143 if (ctx->rx_no_pad) {
1144 err = nla_put_flag(skb, TLS_INFO_RX_NO_PAD);
1150 nla_nest_end(skb, start);
1155 nla_nest_cancel(skb, start);
1159 static size_t tls_get_info_size(const struct sock *sk)
1163 size += nla_total_size(0) + /* INET_ULP_INFO_TLS */
1164 nla_total_size(sizeof(u16)) + /* TLS_INFO_VERSION */
1165 nla_total_size(sizeof(u16)) + /* TLS_INFO_CIPHER */
1166 nla_total_size(sizeof(u16)) + /* TLS_INFO_RXCONF */
1167 nla_total_size(sizeof(u16)) + /* TLS_INFO_TXCONF */
1168 nla_total_size(0) + /* TLS_INFO_ZC_RO_TX */
1169 nla_total_size(0) + /* TLS_INFO_RX_NO_PAD */
1175 static int __net_init tls_init_net(struct net *net)
1179 net->mib.tls_statistics = alloc_percpu(struct linux_tls_mib);
1180 if (!net->mib.tls_statistics)
1183 err = tls_proc_init(net);
1185 goto err_free_stats;
1189 free_percpu(net->mib.tls_statistics);
1193 static void __net_exit tls_exit_net(struct net *net)
1196 free_percpu(net->mib.tls_statistics);
1199 static struct pernet_operations tls_proc_ops = {
1200 .init = tls_init_net,
1201 .exit = tls_exit_net,
1204 static struct tcp_ulp_ops tcp_tls_ulp_ops __read_mostly = {
1206 .owner = THIS_MODULE,
1208 .update = tls_update,
1209 .get_info = tls_get_info,
1210 .get_info_size = tls_get_info_size,
1213 static int __init tls_register(void)
1217 err = register_pernet_subsys(&tls_proc_ops);
1221 err = tls_strp_dev_init();
1225 err = tls_device_init();
1229 tcp_register_ulp(&tcp_tls_ulp_ops);
1233 tls_strp_dev_exit();
1235 unregister_pernet_subsys(&tls_proc_ops);
1239 static void __exit tls_unregister(void)
1241 tcp_unregister_ulp(&tcp_tls_ulp_ops);
1242 tls_strp_dev_exit();
1243 tls_device_cleanup();
1244 unregister_pernet_subsys(&tls_proc_ops);
1247 module_init(tls_register);
1248 module_exit(tls_unregister);