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>
44 MODULE_AUTHOR("Mellanox Technologies");
45 MODULE_DESCRIPTION("Transport Layer Security Support");
46 MODULE_LICENSE("Dual BSD/GPL");
48 static struct proto tls_base_prot;
49 static struct proto tls_sw_prot;
51 int wait_on_pending_writer(struct sock *sk, long *timeo)
54 DEFINE_WAIT_FUNC(wait, woken_wake_function);
56 add_wait_queue(sk_sleep(sk), &wait);
63 if (signal_pending(current)) {
64 rc = sock_intr_errno(*timeo);
68 if (sk_wait_event(sk, timeo, !sk->sk_write_pending, &wait))
71 remove_wait_queue(sk_sleep(sk), &wait);
75 int tls_push_sg(struct sock *sk,
76 struct tls_context *ctx,
77 struct scatterlist *sg,
81 int sendpage_flags = flags | MSG_SENDPAGE_NOTLAST;
85 int offset = first_offset;
87 size = sg->length - offset;
92 sendpage_flags = flags;
94 /* is sending application-limited? */
95 tcp_rate_check_app_limited(sk);
98 ret = do_tcp_sendpages(sk, p, offset, size, sendpage_flags);
107 offset -= sg->offset;
108 ctx->partially_sent_offset = offset;
109 ctx->partially_sent_record = (void *)sg;
114 sk_mem_uncharge(sk, sg->length);
123 clear_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags);
128 static int tls_handle_open_record(struct sock *sk, int flags)
130 struct tls_context *ctx = tls_get_ctx(sk);
132 if (tls_is_pending_open_record(ctx))
133 return ctx->push_pending_record(sk, flags);
138 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
139 unsigned char *record_type)
141 struct cmsghdr *cmsg;
144 for_each_cmsghdr(cmsg, msg) {
145 if (!CMSG_OK(msg, cmsg))
147 if (cmsg->cmsg_level != SOL_TLS)
150 switch (cmsg->cmsg_type) {
151 case TLS_SET_RECORD_TYPE:
152 if (cmsg->cmsg_len < CMSG_LEN(sizeof(*record_type)))
155 if (msg->msg_flags & MSG_MORE)
158 rc = tls_handle_open_record(sk, msg->msg_flags);
162 *record_type = *(unsigned char *)CMSG_DATA(cmsg);
173 int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx,
174 int flags, long *timeo)
176 struct scatterlist *sg;
179 if (!tls_is_partially_sent_record(ctx))
180 return ctx->push_pending_record(sk, flags);
182 sg = ctx->partially_sent_record;
183 offset = ctx->partially_sent_offset;
185 ctx->partially_sent_record = NULL;
186 return tls_push_sg(sk, ctx, sg, offset, flags);
189 static void tls_write_space(struct sock *sk)
191 struct tls_context *ctx = tls_get_ctx(sk);
193 if (!sk->sk_write_pending && tls_is_pending_closed_record(ctx)) {
194 gfp_t sk_allocation = sk->sk_allocation;
198 sk->sk_allocation = GFP_ATOMIC;
199 rc = tls_push_pending_closed_record(sk, ctx,
203 sk->sk_allocation = sk_allocation;
209 ctx->sk_write_space(sk);
212 static void tls_sk_proto_close(struct sock *sk, long timeout)
214 struct tls_context *ctx = tls_get_ctx(sk);
215 long timeo = sock_sndtimeo(sk, 0);
216 void (*sk_proto_close)(struct sock *sk, long timeout);
220 if (!tls_complete_pending_work(sk, ctx, 0, &timeo))
221 tls_handle_open_record(sk, 0);
223 if (ctx->partially_sent_record) {
224 struct scatterlist *sg = ctx->partially_sent_record;
227 put_page(sg_page(sg));
228 sk_mem_uncharge(sk, sg->length);
235 ctx->free_resources(sk);
239 sk_proto_close = ctx->sk_proto_close;
243 sk_proto_close(sk, timeout);
246 static int do_tls_getsockopt_tx(struct sock *sk, char __user *optval,
250 struct tls_context *ctx = tls_get_ctx(sk);
251 struct tls_crypto_info *crypto_info;
254 if (get_user(len, optlen))
257 if (!optval || (len < sizeof(*crypto_info))) {
267 /* get user crypto info */
268 crypto_info = &ctx->crypto_send;
270 if (!TLS_CRYPTO_INFO_READY(crypto_info)) {
275 if (len == sizeof(*crypto_info)) {
276 if (copy_to_user(optval, crypto_info, sizeof(*crypto_info)))
281 switch (crypto_info->cipher_type) {
282 case TLS_CIPHER_AES_GCM_128: {
283 struct tls12_crypto_info_aes_gcm_128 *
284 crypto_info_aes_gcm_128 =
285 container_of(crypto_info,
286 struct tls12_crypto_info_aes_gcm_128,
289 if (len != sizeof(*crypto_info_aes_gcm_128)) {
294 memcpy(crypto_info_aes_gcm_128->iv, ctx->iv,
295 TLS_CIPHER_AES_GCM_128_IV_SIZE);
297 if (copy_to_user(optval,
298 crypto_info_aes_gcm_128,
299 sizeof(*crypto_info_aes_gcm_128)))
311 static int do_tls_getsockopt(struct sock *sk, int optname,
312 char __user *optval, int __user *optlen)
318 rc = do_tls_getsockopt_tx(sk, optval, optlen);
327 static int tls_getsockopt(struct sock *sk, int level, int optname,
328 char __user *optval, int __user *optlen)
330 struct tls_context *ctx = tls_get_ctx(sk);
332 if (level != SOL_TLS)
333 return ctx->getsockopt(sk, level, optname, optval, optlen);
335 return do_tls_getsockopt(sk, optname, optval, optlen);
338 static int do_tls_setsockopt_tx(struct sock *sk, char __user *optval,
341 struct tls_crypto_info *crypto_info, tmp_crypto_info;
342 struct tls_context *ctx = tls_get_ctx(sk);
343 struct proto *prot = NULL;
346 if (!optval || (optlen < sizeof(*crypto_info))) {
351 rc = copy_from_user(&tmp_crypto_info, optval, sizeof(*crypto_info));
358 if (tmp_crypto_info.version != TLS_1_2_VERSION) {
363 /* get user crypto info */
364 crypto_info = &ctx->crypto_send;
366 /* Currently we don't support set crypto info more than one time */
367 if (TLS_CRYPTO_INFO_READY(crypto_info))
370 switch (tmp_crypto_info.cipher_type) {
371 case TLS_CIPHER_AES_GCM_128: {
372 if (optlen != sizeof(struct tls12_crypto_info_aes_gcm_128)) {
379 sizeof(struct tls12_crypto_info_aes_gcm_128));
383 goto err_crypto_info;
392 ctx->sk_write_space = sk->sk_write_space;
393 sk->sk_write_space = tls_write_space;
395 ctx->sk_proto_close = sk->sk_prot->close;
397 /* currently SW is default, we will have ethtool in future */
398 rc = tls_set_sw_offload(sk, ctx);
401 goto err_crypto_info;
407 memset(crypto_info, 0, sizeof(*crypto_info));
412 static int do_tls_setsockopt(struct sock *sk, int optname,
413 char __user *optval, unsigned int optlen)
420 rc = do_tls_setsockopt_tx(sk, optval, optlen);
430 static int tls_setsockopt(struct sock *sk, int level, int optname,
431 char __user *optval, unsigned int optlen)
433 struct tls_context *ctx = tls_get_ctx(sk);
435 if (level != SOL_TLS)
436 return ctx->setsockopt(sk, level, optname, optval, optlen);
438 return do_tls_setsockopt(sk, optname, optval, optlen);
441 static int tls_init(struct sock *sk)
443 struct inet_connection_sock *icsk = inet_csk(sk);
444 struct tls_context *ctx;
447 /* allocate tls context */
448 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
453 icsk->icsk_ulp_data = ctx;
454 ctx->setsockopt = sk->sk_prot->setsockopt;
455 ctx->getsockopt = sk->sk_prot->getsockopt;
456 sk->sk_prot = &tls_base_prot;
461 static struct tcp_ulp_ops tcp_tls_ulp_ops __read_mostly = {
463 .owner = THIS_MODULE,
467 static int __init tls_register(void)
469 tls_base_prot = tcp_prot;
470 tls_base_prot.setsockopt = tls_setsockopt;
471 tls_base_prot.getsockopt = tls_getsockopt;
473 tls_sw_prot = tls_base_prot;
474 tls_sw_prot.sendmsg = tls_sw_sendmsg;
475 tls_sw_prot.sendpage = tls_sw_sendpage;
476 tls_sw_prot.close = tls_sk_proto_close;
478 tcp_register_ulp(&tcp_tls_ulp_ops);
483 static void __exit tls_unregister(void)
485 tcp_unregister_ulp(&tcp_tls_ulp_ops);
488 module_init(tls_register);
489 module_exit(tls_unregister);