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>
45 MODULE_AUTHOR("Mellanox Technologies");
46 MODULE_DESCRIPTION("Transport Layer Security Support");
47 MODULE_LICENSE("Dual BSD/GPL");
61 static struct proto *saved_tcpv6_prot;
62 static DEFINE_MUTEX(tcpv6_prot_mutex);
63 static LIST_HEAD(device_list);
64 static DEFINE_MUTEX(device_mutex);
65 static struct proto tls_prots[TLS_NUM_PROTS][TLS_NUM_CONFIG][TLS_NUM_CONFIG];
66 static struct proto_ops tls_sw_proto_ops;
68 static void update_sk_prot(struct sock *sk, struct tls_context *ctx)
70 int ip_ver = sk->sk_family == AF_INET6 ? TLSV6 : TLSV4;
72 sk->sk_prot = &tls_prots[ip_ver][ctx->tx_conf][ctx->rx_conf];
75 int wait_on_pending_writer(struct sock *sk, long *timeo)
78 DEFINE_WAIT_FUNC(wait, woken_wake_function);
80 add_wait_queue(sk_sleep(sk), &wait);
87 if (signal_pending(current)) {
88 rc = sock_intr_errno(*timeo);
92 if (sk_wait_event(sk, timeo, !sk->sk_write_pending, &wait))
95 remove_wait_queue(sk_sleep(sk), &wait);
99 int tls_push_sg(struct sock *sk,
100 struct tls_context *ctx,
101 struct scatterlist *sg,
105 int sendpage_flags = flags | MSG_SENDPAGE_NOTLAST;
109 int offset = first_offset;
111 size = sg->length - offset;
112 offset += sg->offset;
116 sendpage_flags = flags;
118 /* is sending application-limited? */
119 tcp_rate_check_app_limited(sk);
122 ret = do_tcp_sendpages(sk, p, offset, size, sendpage_flags);
131 offset -= sg->offset;
132 ctx->partially_sent_offset = offset;
133 ctx->partially_sent_record = (void *)sg;
138 sk_mem_uncharge(sk, sg->length);
147 clear_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags);
152 static int tls_handle_open_record(struct sock *sk, int flags)
154 struct tls_context *ctx = tls_get_ctx(sk);
156 if (tls_is_pending_open_record(ctx))
157 return ctx->push_pending_record(sk, flags);
162 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
163 unsigned char *record_type)
165 struct cmsghdr *cmsg;
168 for_each_cmsghdr(cmsg, msg) {
169 if (!CMSG_OK(msg, cmsg))
171 if (cmsg->cmsg_level != SOL_TLS)
174 switch (cmsg->cmsg_type) {
175 case TLS_SET_RECORD_TYPE:
176 if (cmsg->cmsg_len < CMSG_LEN(sizeof(*record_type)))
179 if (msg->msg_flags & MSG_MORE)
182 rc = tls_handle_open_record(sk, msg->msg_flags);
186 *record_type = *(unsigned char *)CMSG_DATA(cmsg);
197 int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx,
198 int flags, long *timeo)
200 struct scatterlist *sg;
203 if (!tls_is_partially_sent_record(ctx))
204 return ctx->push_pending_record(sk, flags);
206 sg = ctx->partially_sent_record;
207 offset = ctx->partially_sent_offset;
209 ctx->partially_sent_record = NULL;
210 return tls_push_sg(sk, ctx, sg, offset, flags);
213 static void tls_write_space(struct sock *sk)
215 struct tls_context *ctx = tls_get_ctx(sk);
217 if (!sk->sk_write_pending && tls_is_pending_closed_record(ctx)) {
218 gfp_t sk_allocation = sk->sk_allocation;
222 sk->sk_allocation = GFP_ATOMIC;
223 rc = tls_push_pending_closed_record(sk, ctx,
227 sk->sk_allocation = sk_allocation;
233 ctx->sk_write_space(sk);
236 static void tls_sk_proto_close(struct sock *sk, long timeout)
238 struct tls_context *ctx = tls_get_ctx(sk);
239 long timeo = sock_sndtimeo(sk, 0);
240 void (*sk_proto_close)(struct sock *sk, long timeout);
243 sk_proto_close = ctx->sk_proto_close;
245 if (ctx->tx_conf == TLS_HW_RECORD && ctx->rx_conf == TLS_HW_RECORD)
246 goto skip_tx_cleanup;
248 if (ctx->tx_conf == TLS_BASE && ctx->rx_conf == TLS_BASE) {
251 goto skip_tx_cleanup;
254 if (!tls_complete_pending_work(sk, ctx, 0, &timeo))
255 tls_handle_open_record(sk, 0);
257 if (ctx->partially_sent_record) {
258 struct scatterlist *sg = ctx->partially_sent_record;
261 put_page(sg_page(sg));
262 sk_mem_uncharge(sk, sg->length);
270 /* We need these for tls_sw_fallback handling of other packets */
271 if (ctx->tx_conf == TLS_SW) {
272 kfree(ctx->tx.rec_seq);
274 tls_sw_free_resources_tx(sk);
277 if (ctx->rx_conf == TLS_SW) {
278 kfree(ctx->rx.rec_seq);
280 tls_sw_free_resources_rx(sk);
285 sk_proto_close(sk, timeout);
286 /* free ctx for TLS_HW_RECORD, used by tcp_set_state
287 * for sk->sk_prot->unhash [tls_hw_unhash]
289 if (ctx && ctx->tx_conf == TLS_HW_RECORD &&
290 ctx->rx_conf == TLS_HW_RECORD)
294 static int do_tls_getsockopt_tx(struct sock *sk, char __user *optval,
298 struct tls_context *ctx = tls_get_ctx(sk);
299 struct tls_crypto_info *crypto_info;
302 if (get_user(len, optlen))
305 if (!optval || (len < sizeof(*crypto_info))) {
315 /* get user crypto info */
316 crypto_info = &ctx->crypto_send;
318 if (!TLS_CRYPTO_INFO_READY(crypto_info)) {
323 if (len == sizeof(*crypto_info)) {
324 if (copy_to_user(optval, crypto_info, sizeof(*crypto_info)))
329 switch (crypto_info->cipher_type) {
330 case TLS_CIPHER_AES_GCM_128: {
331 struct tls12_crypto_info_aes_gcm_128 *
332 crypto_info_aes_gcm_128 =
333 container_of(crypto_info,
334 struct tls12_crypto_info_aes_gcm_128,
337 if (len != sizeof(*crypto_info_aes_gcm_128)) {
342 memcpy(crypto_info_aes_gcm_128->iv,
343 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
344 TLS_CIPHER_AES_GCM_128_IV_SIZE);
345 memcpy(crypto_info_aes_gcm_128->rec_seq, ctx->tx.rec_seq,
346 TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE);
348 if (copy_to_user(optval,
349 crypto_info_aes_gcm_128,
350 sizeof(*crypto_info_aes_gcm_128)))
362 static int do_tls_getsockopt(struct sock *sk, int optname,
363 char __user *optval, int __user *optlen)
369 rc = do_tls_getsockopt_tx(sk, optval, optlen);
378 static int tls_getsockopt(struct sock *sk, int level, int optname,
379 char __user *optval, int __user *optlen)
381 struct tls_context *ctx = tls_get_ctx(sk);
383 if (level != SOL_TLS)
384 return ctx->getsockopt(sk, level, optname, optval, optlen);
386 return do_tls_getsockopt(sk, optname, optval, optlen);
389 static int do_tls_setsockopt_conf(struct sock *sk, char __user *optval,
390 unsigned int optlen, int tx)
392 struct tls_crypto_info *crypto_info;
393 struct tls_context *ctx = tls_get_ctx(sk);
397 if (!optval || (optlen < sizeof(*crypto_info))) {
403 crypto_info = &ctx->crypto_send;
405 crypto_info = &ctx->crypto_recv;
407 /* Currently we don't support set crypto info more than one time */
408 if (TLS_CRYPTO_INFO_READY(crypto_info)) {
413 rc = copy_from_user(crypto_info, optval, sizeof(*crypto_info));
416 goto err_crypto_info;
420 if (crypto_info->version != TLS_1_2_VERSION) {
422 goto err_crypto_info;
425 switch (crypto_info->cipher_type) {
426 case TLS_CIPHER_AES_GCM_128: {
427 if (optlen != sizeof(struct tls12_crypto_info_aes_gcm_128)) {
429 goto err_crypto_info;
431 rc = copy_from_user(crypto_info + 1, optval + sizeof(*crypto_info),
432 optlen - sizeof(*crypto_info));
435 goto err_crypto_info;
441 goto err_crypto_info;
445 rc = tls_set_sw_offload(sk, ctx, 1);
448 rc = tls_set_sw_offload(sk, ctx, 0);
453 goto err_crypto_info;
459 update_sk_prot(sk, ctx);
461 ctx->sk_write_space = sk->sk_write_space;
462 sk->sk_write_space = tls_write_space;
464 sk->sk_socket->ops = &tls_sw_proto_ops;
469 memset(crypto_info, 0, sizeof(*crypto_info));
474 static int do_tls_setsockopt(struct sock *sk, int optname,
475 char __user *optval, unsigned int optlen)
483 rc = do_tls_setsockopt_conf(sk, optval, optlen,
494 static int tls_setsockopt(struct sock *sk, int level, int optname,
495 char __user *optval, unsigned int optlen)
497 struct tls_context *ctx = tls_get_ctx(sk);
499 if (level != SOL_TLS)
500 return ctx->setsockopt(sk, level, optname, optval, optlen);
502 return do_tls_setsockopt(sk, optname, optval, optlen);
505 static struct tls_context *create_ctx(struct sock *sk)
507 struct inet_connection_sock *icsk = inet_csk(sk);
508 struct tls_context *ctx;
510 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
514 icsk->icsk_ulp_data = ctx;
518 static int tls_hw_prot(struct sock *sk)
520 struct tls_context *ctx;
521 struct tls_device *dev;
524 mutex_lock(&device_mutex);
525 list_for_each_entry(dev, &device_list, dev_list) {
526 if (dev->feature && dev->feature(dev)) {
527 ctx = create_ctx(sk);
531 ctx->hash = sk->sk_prot->hash;
532 ctx->unhash = sk->sk_prot->unhash;
533 ctx->sk_proto_close = sk->sk_prot->close;
534 ctx->rx_conf = TLS_HW_RECORD;
535 ctx->tx_conf = TLS_HW_RECORD;
536 update_sk_prot(sk, ctx);
542 mutex_unlock(&device_mutex);
546 static void tls_hw_unhash(struct sock *sk)
548 struct tls_context *ctx = tls_get_ctx(sk);
549 struct tls_device *dev;
551 mutex_lock(&device_mutex);
552 list_for_each_entry(dev, &device_list, dev_list) {
554 dev->unhash(dev, sk);
556 mutex_unlock(&device_mutex);
560 static int tls_hw_hash(struct sock *sk)
562 struct tls_context *ctx = tls_get_ctx(sk);
563 struct tls_device *dev;
567 mutex_lock(&device_mutex);
568 list_for_each_entry(dev, &device_list, dev_list) {
570 err |= dev->hash(dev, sk);
572 mutex_unlock(&device_mutex);
579 static void build_protos(struct proto prot[TLS_NUM_CONFIG][TLS_NUM_CONFIG],
582 prot[TLS_BASE][TLS_BASE] = *base;
583 prot[TLS_BASE][TLS_BASE].setsockopt = tls_setsockopt;
584 prot[TLS_BASE][TLS_BASE].getsockopt = tls_getsockopt;
585 prot[TLS_BASE][TLS_BASE].close = tls_sk_proto_close;
587 prot[TLS_SW][TLS_BASE] = prot[TLS_BASE][TLS_BASE];
588 prot[TLS_SW][TLS_BASE].sendmsg = tls_sw_sendmsg;
589 prot[TLS_SW][TLS_BASE].sendpage = tls_sw_sendpage;
591 prot[TLS_BASE][TLS_SW] = prot[TLS_BASE][TLS_BASE];
592 prot[TLS_BASE][TLS_SW].recvmsg = tls_sw_recvmsg;
593 prot[TLS_BASE][TLS_SW].close = tls_sk_proto_close;
595 prot[TLS_SW][TLS_SW] = prot[TLS_SW][TLS_BASE];
596 prot[TLS_SW][TLS_SW].recvmsg = tls_sw_recvmsg;
597 prot[TLS_SW][TLS_SW].close = tls_sk_proto_close;
599 prot[TLS_HW_RECORD][TLS_HW_RECORD] = *base;
600 prot[TLS_HW_RECORD][TLS_HW_RECORD].hash = tls_hw_hash;
601 prot[TLS_HW_RECORD][TLS_HW_RECORD].unhash = tls_hw_unhash;
602 prot[TLS_HW_RECORD][TLS_HW_RECORD].close = tls_sk_proto_close;
605 static int tls_init(struct sock *sk)
607 int ip_ver = sk->sk_family == AF_INET6 ? TLSV6 : TLSV4;
608 struct tls_context *ctx;
614 /* The TLS ulp is currently supported only for TCP sockets
615 * in ESTABLISHED state.
616 * Supporting sockets in LISTEN state will require us
617 * to modify the accept implementation to clone rather then
618 * share the ulp context.
620 if (sk->sk_state != TCP_ESTABLISHED)
623 /* allocate tls context */
624 ctx = create_ctx(sk);
629 ctx->setsockopt = sk->sk_prot->setsockopt;
630 ctx->getsockopt = sk->sk_prot->getsockopt;
631 ctx->sk_proto_close = sk->sk_prot->close;
633 /* Build IPv6 TLS whenever the address of tcpv6_prot changes */
634 if (ip_ver == TLSV6 &&
635 unlikely(sk->sk_prot != smp_load_acquire(&saved_tcpv6_prot))) {
636 mutex_lock(&tcpv6_prot_mutex);
637 if (likely(sk->sk_prot != saved_tcpv6_prot)) {
638 build_protos(tls_prots[TLSV6], sk->sk_prot);
639 smp_store_release(&saved_tcpv6_prot, sk->sk_prot);
641 mutex_unlock(&tcpv6_prot_mutex);
644 ctx->tx_conf = TLS_BASE;
645 ctx->rx_conf = TLS_BASE;
646 update_sk_prot(sk, ctx);
651 void tls_register_device(struct tls_device *device)
653 mutex_lock(&device_mutex);
654 list_add_tail(&device->dev_list, &device_list);
655 mutex_unlock(&device_mutex);
657 EXPORT_SYMBOL(tls_register_device);
659 void tls_unregister_device(struct tls_device *device)
661 mutex_lock(&device_mutex);
662 list_del(&device->dev_list);
663 mutex_unlock(&device_mutex);
665 EXPORT_SYMBOL(tls_unregister_device);
667 static struct tcp_ulp_ops tcp_tls_ulp_ops __read_mostly = {
670 .user_visible = true,
671 .owner = THIS_MODULE,
675 static int __init tls_register(void)
677 build_protos(tls_prots[TLSV4], &tcp_prot);
679 tls_sw_proto_ops = inet_stream_ops;
680 tls_sw_proto_ops.poll = tls_sw_poll;
681 tls_sw_proto_ops.splice_read = tls_sw_splice_read;
683 tcp_register_ulp(&tcp_tls_ulp_ops);
688 static void __exit tls_unregister(void)
690 tcp_unregister_ulp(&tcp_tls_ulp_ops);
693 module_init(tls_register);
694 module_exit(tls_unregister);