2 * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
3 * Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. All rights reserved.
4 * Copyright (c) 2016-2017, Lance Chao <lancerchao@fb.com>. All rights reserved.
5 * Copyright (c) 2016, Fridolin Pokorny <fridolin.pokorny@gmail.com>. All rights reserved.
6 * Copyright (c) 2016, Nikos Mavrogiannopoulos <nmav@gnutls.org>. All rights reserved.
7 * Copyright (c) 2018, Covalent IO, Inc. http://covalent.io
9 * This software is available to you under a choice of one of two
10 * licenses. You may choose to be licensed under the terms of the GNU
11 * General Public License (GPL) Version 2, available from the file
12 * COPYING in the main directory of this source tree, or the
13 * OpenIB.org BSD license below:
15 * Redistribution and use in source and binary forms, with or
16 * without modification, are permitted provided that the following
19 * - Redistributions of source code must retain the above
20 * copyright notice, this list of conditions and the following
23 * - Redistributions in binary form must reproduce the above
24 * copyright notice, this list of conditions and the following
25 * disclaimer in the documentation and/or other materials
26 * provided with the distribution.
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
29 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
31 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
32 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
33 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38 #include <linux/sched/signal.h>
39 #include <linux/module.h>
40 #include <crypto/aead.h>
42 #include <net/strparser.h>
45 static int __skb_nsg(struct sk_buff *skb, int offset, int len,
46 unsigned int recursion_level)
48 int start = skb_headlen(skb);
49 int i, chunk = start - offset;
50 struct sk_buff *frag_iter;
53 if (unlikely(recursion_level >= 24))
66 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
69 WARN_ON(start > offset + len);
71 end = start + skb_frag_size(&skb_shinfo(skb)->frags[i]);
85 if (unlikely(skb_has_frag_list(skb))) {
86 skb_walk_frags(skb, frag_iter) {
89 WARN_ON(start > offset + len);
91 end = start + frag_iter->len;
96 ret = __skb_nsg(frag_iter, offset - start, chunk,
98 if (unlikely(ret < 0))
113 /* Return the number of scatterlist elements required to completely map the
114 * skb, or -EMSGSIZE if the recursion depth is exceeded.
116 static int skb_nsg(struct sk_buff *skb, int offset, int len)
118 return __skb_nsg(skb, offset, len, 0);
121 static int padding_length(struct tls_sw_context_rx *ctx,
122 struct tls_prot_info *prot, struct sk_buff *skb)
124 struct strp_msg *rxm = strp_msg(skb);
127 /* Determine zero-padding length */
128 if (prot->version == TLS_1_3_VERSION) {
129 char content_type = 0;
133 while (content_type == 0) {
134 if (back > rxm->full_len - prot->prepend_size)
136 err = skb_copy_bits(skb,
137 rxm->offset + rxm->full_len - back,
146 ctx->control = content_type;
151 static void tls_decrypt_done(struct crypto_async_request *req, int err)
153 struct aead_request *aead_req = (struct aead_request *)req;
154 struct scatterlist *sgout = aead_req->dst;
155 struct scatterlist *sgin = aead_req->src;
156 struct tls_sw_context_rx *ctx;
157 struct tls_context *tls_ctx;
158 struct tls_prot_info *prot;
159 struct scatterlist *sg;
164 skb = (struct sk_buff *)req->data;
165 tls_ctx = tls_get_ctx(skb->sk);
166 ctx = tls_sw_ctx_rx(tls_ctx);
167 prot = &tls_ctx->prot_info;
169 /* Propagate if there was an err */
172 TLS_INC_STATS(sock_net(skb->sk),
173 LINUX_MIB_TLSDECRYPTERROR);
174 ctx->async_wait.err = err;
175 tls_err_abort(skb->sk, err);
177 struct strp_msg *rxm = strp_msg(skb);
180 pad = padding_length(ctx, prot, skb);
182 ctx->async_wait.err = pad;
183 tls_err_abort(skb->sk, pad);
185 rxm->full_len -= pad;
186 rxm->offset += prot->prepend_size;
187 rxm->full_len -= prot->overhead_size;
191 /* After using skb->sk to propagate sk through crypto async callback
192 * we need to NULL it again.
197 /* Free the destination pages if skb was not decrypted inplace */
199 /* Skip the first S/G entry as it points to AAD */
200 for_each_sg(sg_next(sgout), sg, UINT_MAX, pages) {
203 put_page(sg_page(sg));
209 pending = atomic_dec_return(&ctx->decrypt_pending);
211 if (!pending && READ_ONCE(ctx->async_notify))
212 complete(&ctx->async_wait.completion);
215 static int tls_do_decryption(struct sock *sk,
217 struct scatterlist *sgin,
218 struct scatterlist *sgout,
221 struct aead_request *aead_req,
224 struct tls_context *tls_ctx = tls_get_ctx(sk);
225 struct tls_prot_info *prot = &tls_ctx->prot_info;
226 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
229 aead_request_set_tfm(aead_req, ctx->aead_recv);
230 aead_request_set_ad(aead_req, prot->aad_size);
231 aead_request_set_crypt(aead_req, sgin, sgout,
232 data_len + prot->tag_size,
236 /* Using skb->sk to push sk through to crypto async callback
237 * handler. This allows propagating errors up to the socket
238 * if needed. It _must_ be cleared in the async handler
239 * before consume_skb is called. We _know_ skb->sk is NULL
240 * because it is a clone from strparser.
243 aead_request_set_callback(aead_req,
244 CRYPTO_TFM_REQ_MAY_BACKLOG,
245 tls_decrypt_done, skb);
246 atomic_inc(&ctx->decrypt_pending);
248 aead_request_set_callback(aead_req,
249 CRYPTO_TFM_REQ_MAY_BACKLOG,
250 crypto_req_done, &ctx->async_wait);
253 ret = crypto_aead_decrypt(aead_req);
254 if (ret == -EINPROGRESS) {
258 ret = crypto_wait_req(ret, &ctx->async_wait);
262 atomic_dec(&ctx->decrypt_pending);
267 static void tls_trim_both_msgs(struct sock *sk, int target_size)
269 struct tls_context *tls_ctx = tls_get_ctx(sk);
270 struct tls_prot_info *prot = &tls_ctx->prot_info;
271 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
272 struct tls_rec *rec = ctx->open_rec;
274 sk_msg_trim(sk, &rec->msg_plaintext, target_size);
276 target_size += prot->overhead_size;
277 sk_msg_trim(sk, &rec->msg_encrypted, target_size);
280 static int tls_alloc_encrypted_msg(struct sock *sk, int len)
282 struct tls_context *tls_ctx = tls_get_ctx(sk);
283 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
284 struct tls_rec *rec = ctx->open_rec;
285 struct sk_msg *msg_en = &rec->msg_encrypted;
287 return sk_msg_alloc(sk, msg_en, len, 0);
290 static int tls_clone_plaintext_msg(struct sock *sk, int required)
292 struct tls_context *tls_ctx = tls_get_ctx(sk);
293 struct tls_prot_info *prot = &tls_ctx->prot_info;
294 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
295 struct tls_rec *rec = ctx->open_rec;
296 struct sk_msg *msg_pl = &rec->msg_plaintext;
297 struct sk_msg *msg_en = &rec->msg_encrypted;
300 /* We add page references worth len bytes from encrypted sg
301 * at the end of plaintext sg. It is guaranteed that msg_en
302 * has enough required room (ensured by caller).
304 len = required - msg_pl->sg.size;
306 /* Skip initial bytes in msg_en's data to be able to use
307 * same offset of both plain and encrypted data.
309 skip = prot->prepend_size + msg_pl->sg.size;
311 return sk_msg_clone(sk, msg_pl, msg_en, skip, len);
314 static struct tls_rec *tls_get_rec(struct sock *sk)
316 struct tls_context *tls_ctx = tls_get_ctx(sk);
317 struct tls_prot_info *prot = &tls_ctx->prot_info;
318 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
319 struct sk_msg *msg_pl, *msg_en;
323 mem_size = sizeof(struct tls_rec) + crypto_aead_reqsize(ctx->aead_send);
325 rec = kzalloc(mem_size, sk->sk_allocation);
329 msg_pl = &rec->msg_plaintext;
330 msg_en = &rec->msg_encrypted;
335 sg_init_table(rec->sg_aead_in, 2);
336 sg_set_buf(&rec->sg_aead_in[0], rec->aad_space, prot->aad_size);
337 sg_unmark_end(&rec->sg_aead_in[1]);
339 sg_init_table(rec->sg_aead_out, 2);
340 sg_set_buf(&rec->sg_aead_out[0], rec->aad_space, prot->aad_size);
341 sg_unmark_end(&rec->sg_aead_out[1]);
346 static void tls_free_rec(struct sock *sk, struct tls_rec *rec)
348 sk_msg_free(sk, &rec->msg_encrypted);
349 sk_msg_free(sk, &rec->msg_plaintext);
353 static void tls_free_open_rec(struct sock *sk)
355 struct tls_context *tls_ctx = tls_get_ctx(sk);
356 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
357 struct tls_rec *rec = ctx->open_rec;
360 tls_free_rec(sk, rec);
361 ctx->open_rec = NULL;
365 int tls_tx_records(struct sock *sk, int flags)
367 struct tls_context *tls_ctx = tls_get_ctx(sk);
368 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
369 struct tls_rec *rec, *tmp;
370 struct sk_msg *msg_en;
371 int tx_flags, rc = 0;
373 if (tls_is_partially_sent_record(tls_ctx)) {
374 rec = list_first_entry(&ctx->tx_list,
375 struct tls_rec, list);
378 tx_flags = rec->tx_flags;
382 rc = tls_push_partial_record(sk, tls_ctx, tx_flags);
386 /* Full record has been transmitted.
387 * Remove the head of tx_list
389 list_del(&rec->list);
390 sk_msg_free(sk, &rec->msg_plaintext);
394 /* Tx all ready records */
395 list_for_each_entry_safe(rec, tmp, &ctx->tx_list, list) {
396 if (READ_ONCE(rec->tx_ready)) {
398 tx_flags = rec->tx_flags;
402 msg_en = &rec->msg_encrypted;
403 rc = tls_push_sg(sk, tls_ctx,
404 &msg_en->sg.data[msg_en->sg.curr],
409 list_del(&rec->list);
410 sk_msg_free(sk, &rec->msg_plaintext);
418 if (rc < 0 && rc != -EAGAIN)
419 tls_err_abort(sk, EBADMSG);
424 static void tls_encrypt_done(struct crypto_async_request *req, int err)
426 struct aead_request *aead_req = (struct aead_request *)req;
427 struct sock *sk = req->data;
428 struct tls_context *tls_ctx = tls_get_ctx(sk);
429 struct tls_prot_info *prot = &tls_ctx->prot_info;
430 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
431 struct scatterlist *sge;
432 struct sk_msg *msg_en;
437 rec = container_of(aead_req, struct tls_rec, aead_req);
438 msg_en = &rec->msg_encrypted;
440 sge = sk_msg_elem(msg_en, msg_en->sg.curr);
441 sge->offset -= prot->prepend_size;
442 sge->length += prot->prepend_size;
444 /* Check if error is previously set on socket */
445 if (err || sk->sk_err) {
448 /* If err is already set on socket, return the same code */
450 ctx->async_wait.err = sk->sk_err;
452 ctx->async_wait.err = err;
453 tls_err_abort(sk, err);
458 struct tls_rec *first_rec;
460 /* Mark the record as ready for transmission */
461 smp_store_mb(rec->tx_ready, true);
463 /* If received record is at head of tx_list, schedule tx */
464 first_rec = list_first_entry(&ctx->tx_list,
465 struct tls_rec, list);
466 if (rec == first_rec)
470 pending = atomic_dec_return(&ctx->encrypt_pending);
472 if (!pending && READ_ONCE(ctx->async_notify))
473 complete(&ctx->async_wait.completion);
478 /* Schedule the transmission */
479 if (!test_and_set_bit(BIT_TX_SCHEDULED, &ctx->tx_bitmask))
480 schedule_delayed_work(&ctx->tx_work.work, 1);
483 static int tls_do_encryption(struct sock *sk,
484 struct tls_context *tls_ctx,
485 struct tls_sw_context_tx *ctx,
486 struct aead_request *aead_req,
487 size_t data_len, u32 start)
489 struct tls_prot_info *prot = &tls_ctx->prot_info;
490 struct tls_rec *rec = ctx->open_rec;
491 struct sk_msg *msg_en = &rec->msg_encrypted;
492 struct scatterlist *sge = sk_msg_elem(msg_en, start);
493 int rc, iv_offset = 0;
495 /* For CCM based ciphers, first byte of IV is a constant */
496 if (prot->cipher_type == TLS_CIPHER_AES_CCM_128) {
497 rec->iv_data[0] = TLS_AES_CCM_IV_B0_BYTE;
501 memcpy(&rec->iv_data[iv_offset], tls_ctx->tx.iv,
502 prot->iv_size + prot->salt_size);
504 xor_iv_with_seq(prot->version, rec->iv_data, tls_ctx->tx.rec_seq);
506 sge->offset += prot->prepend_size;
507 sge->length -= prot->prepend_size;
509 msg_en->sg.curr = start;
511 aead_request_set_tfm(aead_req, ctx->aead_send);
512 aead_request_set_ad(aead_req, prot->aad_size);
513 aead_request_set_crypt(aead_req, rec->sg_aead_in,
515 data_len, rec->iv_data);
517 aead_request_set_callback(aead_req, CRYPTO_TFM_REQ_MAY_BACKLOG,
518 tls_encrypt_done, sk);
520 /* Add the record in tx_list */
521 list_add_tail((struct list_head *)&rec->list, &ctx->tx_list);
522 atomic_inc(&ctx->encrypt_pending);
524 rc = crypto_aead_encrypt(aead_req);
525 if (!rc || rc != -EINPROGRESS) {
526 atomic_dec(&ctx->encrypt_pending);
527 sge->offset -= prot->prepend_size;
528 sge->length += prot->prepend_size;
532 WRITE_ONCE(rec->tx_ready, true);
533 } else if (rc != -EINPROGRESS) {
534 list_del(&rec->list);
538 /* Unhook the record from context if encryption is not failure */
539 ctx->open_rec = NULL;
540 tls_advance_record_sn(sk, prot, &tls_ctx->tx);
544 static int tls_split_open_record(struct sock *sk, struct tls_rec *from,
545 struct tls_rec **to, struct sk_msg *msg_opl,
546 struct sk_msg *msg_oen, u32 split_point,
547 u32 tx_overhead_size, u32 *orig_end)
549 u32 i, j, bytes = 0, apply = msg_opl->apply_bytes;
550 struct scatterlist *sge, *osge, *nsge;
551 u32 orig_size = msg_opl->sg.size;
552 struct scatterlist tmp = { };
553 struct sk_msg *msg_npl;
557 new = tls_get_rec(sk);
560 ret = sk_msg_alloc(sk, &new->msg_encrypted, msg_opl->sg.size +
561 tx_overhead_size, 0);
563 tls_free_rec(sk, new);
567 *orig_end = msg_opl->sg.end;
568 i = msg_opl->sg.start;
569 sge = sk_msg_elem(msg_opl, i);
570 while (apply && sge->length) {
571 if (sge->length > apply) {
572 u32 len = sge->length - apply;
574 get_page(sg_page(sge));
575 sg_set_page(&tmp, sg_page(sge), len,
576 sge->offset + apply);
581 apply -= sge->length;
582 bytes += sge->length;
585 sk_msg_iter_var_next(i);
586 if (i == msg_opl->sg.end)
588 sge = sk_msg_elem(msg_opl, i);
592 msg_opl->sg.curr = i;
593 msg_opl->sg.copybreak = 0;
594 msg_opl->apply_bytes = 0;
595 msg_opl->sg.size = bytes;
597 msg_npl = &new->msg_plaintext;
598 msg_npl->apply_bytes = apply;
599 msg_npl->sg.size = orig_size - bytes;
601 j = msg_npl->sg.start;
602 nsge = sk_msg_elem(msg_npl, j);
604 memcpy(nsge, &tmp, sizeof(*nsge));
605 sk_msg_iter_var_next(j);
606 nsge = sk_msg_elem(msg_npl, j);
609 osge = sk_msg_elem(msg_opl, i);
610 while (osge->length) {
611 memcpy(nsge, osge, sizeof(*nsge));
613 sk_msg_iter_var_next(i);
614 sk_msg_iter_var_next(j);
617 osge = sk_msg_elem(msg_opl, i);
618 nsge = sk_msg_elem(msg_npl, j);
622 msg_npl->sg.curr = j;
623 msg_npl->sg.copybreak = 0;
629 static void tls_merge_open_record(struct sock *sk, struct tls_rec *to,
630 struct tls_rec *from, u32 orig_end)
632 struct sk_msg *msg_npl = &from->msg_plaintext;
633 struct sk_msg *msg_opl = &to->msg_plaintext;
634 struct scatterlist *osge, *nsge;
638 sk_msg_iter_var_prev(i);
639 j = msg_npl->sg.start;
641 osge = sk_msg_elem(msg_opl, i);
642 nsge = sk_msg_elem(msg_npl, j);
644 if (sg_page(osge) == sg_page(nsge) &&
645 osge->offset + osge->length == nsge->offset) {
646 osge->length += nsge->length;
647 put_page(sg_page(nsge));
650 msg_opl->sg.end = orig_end;
651 msg_opl->sg.curr = orig_end;
652 msg_opl->sg.copybreak = 0;
653 msg_opl->apply_bytes = msg_opl->sg.size + msg_npl->sg.size;
654 msg_opl->sg.size += msg_npl->sg.size;
656 sk_msg_free(sk, &to->msg_encrypted);
657 sk_msg_xfer_full(&to->msg_encrypted, &from->msg_encrypted);
662 static int tls_push_record(struct sock *sk, int flags,
663 unsigned char record_type)
665 struct tls_context *tls_ctx = tls_get_ctx(sk);
666 struct tls_prot_info *prot = &tls_ctx->prot_info;
667 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
668 struct tls_rec *rec = ctx->open_rec, *tmp = NULL;
669 u32 i, split_point, uninitialized_var(orig_end);
670 struct sk_msg *msg_pl, *msg_en;
671 struct aead_request *req;
678 msg_pl = &rec->msg_plaintext;
679 msg_en = &rec->msg_encrypted;
681 split_point = msg_pl->apply_bytes;
682 split = split_point && split_point < msg_pl->sg.size;
683 if (unlikely((!split &&
685 prot->overhead_size > msg_en->sg.size) ||
688 prot->overhead_size > msg_en->sg.size))) {
690 split_point = msg_en->sg.size;
693 rc = tls_split_open_record(sk, rec, &tmp, msg_pl, msg_en,
694 split_point, prot->overhead_size,
698 /* This can happen if above tls_split_open_record allocates
699 * a single large encryption buffer instead of two smaller
700 * ones. In this case adjust pointers and continue without
703 if (!msg_pl->sg.size) {
704 tls_merge_open_record(sk, rec, tmp, orig_end);
705 msg_pl = &rec->msg_plaintext;
706 msg_en = &rec->msg_encrypted;
709 sk_msg_trim(sk, msg_en, msg_pl->sg.size +
710 prot->overhead_size);
713 rec->tx_flags = flags;
714 req = &rec->aead_req;
717 sk_msg_iter_var_prev(i);
719 rec->content_type = record_type;
720 if (prot->version == TLS_1_3_VERSION) {
721 /* Add content type to end of message. No padding added */
722 sg_set_buf(&rec->sg_content_type, &rec->content_type, 1);
723 sg_mark_end(&rec->sg_content_type);
724 sg_chain(msg_pl->sg.data, msg_pl->sg.end + 1,
725 &rec->sg_content_type);
727 sg_mark_end(sk_msg_elem(msg_pl, i));
730 if (msg_pl->sg.end < msg_pl->sg.start) {
731 sg_chain(&msg_pl->sg.data[msg_pl->sg.start],
732 MAX_SKB_FRAGS - msg_pl->sg.start + 1,
736 i = msg_pl->sg.start;
737 sg_chain(rec->sg_aead_in, 2, &msg_pl->sg.data[i]);
740 sk_msg_iter_var_prev(i);
741 sg_mark_end(sk_msg_elem(msg_en, i));
743 i = msg_en->sg.start;
744 sg_chain(rec->sg_aead_out, 2, &msg_en->sg.data[i]);
746 tls_make_aad(rec->aad_space, msg_pl->sg.size + prot->tail_size,
747 tls_ctx->tx.rec_seq, prot->rec_seq_size,
748 record_type, prot->version);
750 tls_fill_prepend(tls_ctx,
751 page_address(sg_page(&msg_en->sg.data[i])) +
752 msg_en->sg.data[i].offset,
753 msg_pl->sg.size + prot->tail_size,
754 record_type, prot->version);
756 tls_ctx->pending_open_record_frags = false;
758 rc = tls_do_encryption(sk, tls_ctx, ctx, req,
759 msg_pl->sg.size + prot->tail_size, i);
761 if (rc != -EINPROGRESS) {
762 tls_err_abort(sk, EBADMSG);
764 tls_ctx->pending_open_record_frags = true;
765 tls_merge_open_record(sk, rec, tmp, orig_end);
768 ctx->async_capable = 1;
771 msg_pl = &tmp->msg_plaintext;
772 msg_en = &tmp->msg_encrypted;
773 sk_msg_trim(sk, msg_en, msg_pl->sg.size + prot->overhead_size);
774 tls_ctx->pending_open_record_frags = true;
778 return tls_tx_records(sk, flags);
781 static int bpf_exec_tx_verdict(struct sk_msg *msg, struct sock *sk,
782 bool full_record, u8 record_type,
783 size_t *copied, int flags)
785 struct tls_context *tls_ctx = tls_get_ctx(sk);
786 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
787 struct sk_msg msg_redir = { };
788 struct sk_psock *psock;
789 struct sock *sk_redir;
795 policy = !(flags & MSG_SENDPAGE_NOPOLICY);
796 psock = sk_psock_get(sk);
797 if (!psock || !policy) {
798 err = tls_push_record(sk, flags, record_type);
799 if (err && err != -EINPROGRESS) {
800 *copied -= sk_msg_free(sk, msg);
801 tls_free_open_rec(sk);
806 enospc = sk_msg_full(msg);
807 if (psock->eval == __SK_NONE) {
808 delta = msg->sg.size;
809 psock->eval = sk_psock_msg_verdict(sk, psock, msg);
810 delta -= msg->sg.size;
812 if (msg->cork_bytes && msg->cork_bytes > msg->sg.size &&
813 !enospc && !full_record) {
819 if (msg->apply_bytes && msg->apply_bytes < send)
820 send = msg->apply_bytes;
822 switch (psock->eval) {
824 err = tls_push_record(sk, flags, record_type);
825 if (err && err != -EINPROGRESS) {
826 *copied -= sk_msg_free(sk, msg);
827 tls_free_open_rec(sk);
832 sk_redir = psock->sk_redir;
833 memcpy(&msg_redir, msg, sizeof(*msg));
834 if (msg->apply_bytes < send)
835 msg->apply_bytes = 0;
837 msg->apply_bytes -= send;
838 sk_msg_return_zero(sk, msg, send);
839 msg->sg.size -= send;
841 err = tcp_bpf_sendmsg_redir(sk_redir, &msg_redir, send, flags);
844 *copied -= sk_msg_free_nocharge(sk, &msg_redir);
847 if (msg->sg.size == 0)
848 tls_free_open_rec(sk);
852 sk_msg_free_partial(sk, msg, send);
853 if (msg->apply_bytes < send)
854 msg->apply_bytes = 0;
856 msg->apply_bytes -= send;
857 if (msg->sg.size == 0)
858 tls_free_open_rec(sk);
859 *copied -= (send + delta);
864 bool reset_eval = !ctx->open_rec;
868 msg = &rec->msg_plaintext;
869 if (!msg->apply_bytes)
873 psock->eval = __SK_NONE;
874 if (psock->sk_redir) {
875 sock_put(psock->sk_redir);
876 psock->sk_redir = NULL;
883 sk_psock_put(sk, psock);
887 static int tls_sw_push_pending_record(struct sock *sk, int flags)
889 struct tls_context *tls_ctx = tls_get_ctx(sk);
890 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
891 struct tls_rec *rec = ctx->open_rec;
892 struct sk_msg *msg_pl;
898 msg_pl = &rec->msg_plaintext;
899 copied = msg_pl->sg.size;
903 return bpf_exec_tx_verdict(msg_pl, sk, true, TLS_RECORD_TYPE_DATA,
907 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size)
909 long timeo = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
910 struct tls_context *tls_ctx = tls_get_ctx(sk);
911 struct tls_prot_info *prot = &tls_ctx->prot_info;
912 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
913 bool async_capable = ctx->async_capable;
914 unsigned char record_type = TLS_RECORD_TYPE_DATA;
915 bool is_kvec = iov_iter_is_kvec(&msg->msg_iter);
916 bool eor = !(msg->msg_flags & MSG_MORE);
917 size_t try_to_copy, copied = 0;
918 struct sk_msg *msg_pl, *msg_en;
928 if (msg->msg_flags & ~(MSG_MORE | MSG_DONTWAIT | MSG_NOSIGNAL))
931 mutex_lock(&tls_ctx->tx_lock);
934 if (unlikely(msg->msg_controllen)) {
935 ret = tls_proccess_cmsg(sk, msg, &record_type);
937 if (ret == -EINPROGRESS)
939 else if (ret != -EAGAIN)
944 while (msg_data_left(msg)) {
953 rec = ctx->open_rec = tls_get_rec(sk);
959 msg_pl = &rec->msg_plaintext;
960 msg_en = &rec->msg_encrypted;
962 orig_size = msg_pl->sg.size;
964 try_to_copy = msg_data_left(msg);
965 record_room = TLS_MAX_PAYLOAD_SIZE - msg_pl->sg.size;
966 if (try_to_copy >= record_room) {
967 try_to_copy = record_room;
971 required_size = msg_pl->sg.size + try_to_copy +
974 if (!sk_stream_memory_free(sk))
975 goto wait_for_sndbuf;
978 ret = tls_alloc_encrypted_msg(sk, required_size);
981 goto wait_for_memory;
983 /* Adjust try_to_copy according to the amount that was
984 * actually allocated. The difference is due
985 * to max sg elements limit
987 try_to_copy -= required_size - msg_en->sg.size;
991 if (!is_kvec && (full_record || eor) && !async_capable) {
992 u32 first = msg_pl->sg.end;
994 ret = sk_msg_zerocopy_from_iter(sk, &msg->msg_iter,
995 msg_pl, try_to_copy);
997 goto fallback_to_reg_send;
1000 copied += try_to_copy;
1002 sk_msg_sg_copy_set(msg_pl, first);
1003 ret = bpf_exec_tx_verdict(msg_pl, sk, full_record,
1004 record_type, &copied,
1007 if (ret == -EINPROGRESS)
1009 else if (ret == -ENOMEM)
1010 goto wait_for_memory;
1011 else if (ctx->open_rec && ret == -ENOSPC)
1013 else if (ret != -EAGAIN)
1018 copied -= try_to_copy;
1019 sk_msg_sg_copy_clear(msg_pl, first);
1020 iov_iter_revert(&msg->msg_iter,
1021 msg_pl->sg.size - orig_size);
1022 fallback_to_reg_send:
1023 sk_msg_trim(sk, msg_pl, orig_size);
1026 required_size = msg_pl->sg.size + try_to_copy;
1028 ret = tls_clone_plaintext_msg(sk, required_size);
1033 /* Adjust try_to_copy according to the amount that was
1034 * actually allocated. The difference is due
1035 * to max sg elements limit
1037 try_to_copy -= required_size - msg_pl->sg.size;
1039 sk_msg_trim(sk, msg_en,
1040 msg_pl->sg.size + prot->overhead_size);
1044 ret = sk_msg_memcopy_from_iter(sk, &msg->msg_iter,
1045 msg_pl, try_to_copy);
1050 /* Open records defined only if successfully copied, otherwise
1051 * we would trim the sg but not reset the open record frags.
1053 tls_ctx->pending_open_record_frags = true;
1054 copied += try_to_copy;
1055 if (full_record || eor) {
1056 ret = bpf_exec_tx_verdict(msg_pl, sk, full_record,
1057 record_type, &copied,
1060 if (ret == -EINPROGRESS)
1062 else if (ret == -ENOMEM)
1063 goto wait_for_memory;
1064 else if (ret != -EAGAIN) {
1075 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1077 ret = sk_stream_wait_memory(sk, &timeo);
1081 tls_trim_both_msgs(sk, orig_size);
1085 if (ctx->open_rec && msg_en->sg.size < required_size)
1086 goto alloc_encrypted;
1091 } else if (num_zc) {
1092 /* Wait for pending encryptions to get completed */
1093 smp_store_mb(ctx->async_notify, true);
1095 if (atomic_read(&ctx->encrypt_pending))
1096 crypto_wait_req(-EINPROGRESS, &ctx->async_wait);
1098 reinit_completion(&ctx->async_wait.completion);
1100 WRITE_ONCE(ctx->async_notify, false);
1102 if (ctx->async_wait.err) {
1103 ret = ctx->async_wait.err;
1108 /* Transmit if any encryptions have completed */
1109 if (test_and_clear_bit(BIT_TX_SCHEDULED, &ctx->tx_bitmask)) {
1110 cancel_delayed_work(&ctx->tx_work.work);
1111 tls_tx_records(sk, msg->msg_flags);
1115 ret = sk_stream_error(sk, msg->msg_flags, ret);
1118 mutex_unlock(&tls_ctx->tx_lock);
1119 return copied ? copied : ret;
1122 static int tls_sw_do_sendpage(struct sock *sk, struct page *page,
1123 int offset, size_t size, int flags)
1125 long timeo = sock_sndtimeo(sk, flags & MSG_DONTWAIT);
1126 struct tls_context *tls_ctx = tls_get_ctx(sk);
1127 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
1128 struct tls_prot_info *prot = &tls_ctx->prot_info;
1129 unsigned char record_type = TLS_RECORD_TYPE_DATA;
1130 struct sk_msg *msg_pl;
1131 struct tls_rec *rec;
1139 eor = !(flags & (MSG_MORE | MSG_SENDPAGE_NOTLAST));
1140 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
1142 /* Call the sk_stream functions to manage the sndbuf mem. */
1144 size_t copy, required_size;
1152 rec = ctx->open_rec;
1154 rec = ctx->open_rec = tls_get_rec(sk);
1160 msg_pl = &rec->msg_plaintext;
1162 full_record = false;
1163 record_room = TLS_MAX_PAYLOAD_SIZE - msg_pl->sg.size;
1165 if (copy >= record_room) {
1170 required_size = msg_pl->sg.size + copy + prot->overhead_size;
1172 if (!sk_stream_memory_free(sk))
1173 goto wait_for_sndbuf;
1175 ret = tls_alloc_encrypted_msg(sk, required_size);
1178 goto wait_for_memory;
1180 /* Adjust copy according to the amount that was
1181 * actually allocated. The difference is due
1182 * to max sg elements limit
1184 copy -= required_size - msg_pl->sg.size;
1188 sk_msg_page_add(msg_pl, page, copy, offset);
1189 sk_mem_charge(sk, copy);
1195 tls_ctx->pending_open_record_frags = true;
1196 if (full_record || eor || sk_msg_full(msg_pl)) {
1197 ret = bpf_exec_tx_verdict(msg_pl, sk, full_record,
1198 record_type, &copied, flags);
1200 if (ret == -EINPROGRESS)
1202 else if (ret == -ENOMEM)
1203 goto wait_for_memory;
1204 else if (ret != -EAGAIN) {
1213 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
1215 ret = sk_stream_wait_memory(sk, &timeo);
1218 tls_trim_both_msgs(sk, msg_pl->sg.size);
1227 /* Transmit if any encryptions have completed */
1228 if (test_and_clear_bit(BIT_TX_SCHEDULED, &ctx->tx_bitmask)) {
1229 cancel_delayed_work(&ctx->tx_work.work);
1230 tls_tx_records(sk, flags);
1234 ret = sk_stream_error(sk, flags, ret);
1235 return copied ? copied : ret;
1238 int tls_sw_sendpage_locked(struct sock *sk, struct page *page,
1239 int offset, size_t size, int flags)
1241 if (flags & ~(MSG_MORE | MSG_DONTWAIT | MSG_NOSIGNAL |
1242 MSG_SENDPAGE_NOTLAST | MSG_SENDPAGE_NOPOLICY |
1243 MSG_NO_SHARED_FRAGS))
1246 return tls_sw_do_sendpage(sk, page, offset, size, flags);
1249 int tls_sw_sendpage(struct sock *sk, struct page *page,
1250 int offset, size_t size, int flags)
1252 struct tls_context *tls_ctx = tls_get_ctx(sk);
1255 if (flags & ~(MSG_MORE | MSG_DONTWAIT | MSG_NOSIGNAL |
1256 MSG_SENDPAGE_NOTLAST | MSG_SENDPAGE_NOPOLICY))
1259 mutex_lock(&tls_ctx->tx_lock);
1261 ret = tls_sw_do_sendpage(sk, page, offset, size, flags);
1263 mutex_unlock(&tls_ctx->tx_lock);
1267 static struct sk_buff *tls_wait_data(struct sock *sk, struct sk_psock *psock,
1268 int flags, long timeo, int *err)
1270 struct tls_context *tls_ctx = tls_get_ctx(sk);
1271 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1272 struct sk_buff *skb;
1273 DEFINE_WAIT_FUNC(wait, woken_wake_function);
1275 while (!(skb = ctx->recv_pkt) && sk_psock_queue_empty(psock)) {
1277 *err = sock_error(sk);
1281 if (sk->sk_shutdown & RCV_SHUTDOWN)
1284 if (sock_flag(sk, SOCK_DONE))
1287 if ((flags & MSG_DONTWAIT) || !timeo) {
1292 add_wait_queue(sk_sleep(sk), &wait);
1293 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
1294 sk_wait_event(sk, &timeo,
1295 ctx->recv_pkt != skb ||
1296 !sk_psock_queue_empty(psock),
1298 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
1299 remove_wait_queue(sk_sleep(sk), &wait);
1301 /* Handle signals */
1302 if (signal_pending(current)) {
1303 *err = sock_intr_errno(timeo);
1311 static int tls_setup_from_iter(struct sock *sk, struct iov_iter *from,
1312 int length, int *pages_used,
1313 unsigned int *size_used,
1314 struct scatterlist *to,
1317 int rc = 0, i = 0, num_elem = *pages_used, maxpages;
1318 struct page *pages[MAX_SKB_FRAGS];
1319 unsigned int size = *size_used;
1320 ssize_t copied, use;
1323 while (length > 0) {
1325 maxpages = to_max_pages - num_elem;
1326 if (maxpages == 0) {
1330 copied = iov_iter_get_pages(from, pages,
1338 iov_iter_advance(from, copied);
1343 use = min_t(int, copied, PAGE_SIZE - offset);
1345 sg_set_page(&to[num_elem],
1346 pages[i], use, offset);
1347 sg_unmark_end(&to[num_elem]);
1348 /* We do not uncharge memory from this API */
1357 /* Mark the end in the last sg entry if newly added */
1358 if (num_elem > *pages_used)
1359 sg_mark_end(&to[num_elem - 1]);
1362 iov_iter_revert(from, size - *size_used);
1364 *pages_used = num_elem;
1369 /* This function decrypts the input skb into either out_iov or in out_sg
1370 * or in skb buffers itself. The input parameter 'zc' indicates if
1371 * zero-copy mode needs to be tried or not. With zero-copy mode, either
1372 * out_iov or out_sg must be non-NULL. In case both out_iov and out_sg are
1373 * NULL, then the decryption happens inside skb buffers itself, i.e.
1374 * zero-copy gets disabled and 'zc' is updated.
1377 static int decrypt_internal(struct sock *sk, struct sk_buff *skb,
1378 struct iov_iter *out_iov,
1379 struct scatterlist *out_sg,
1380 int *chunk, bool *zc, bool async)
1382 struct tls_context *tls_ctx = tls_get_ctx(sk);
1383 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1384 struct tls_prot_info *prot = &tls_ctx->prot_info;
1385 struct strp_msg *rxm = strp_msg(skb);
1386 int n_sgin, n_sgout, nsg, mem_size, aead_size, err, pages = 0;
1387 struct aead_request *aead_req;
1388 struct sk_buff *unused;
1389 u8 *aad, *iv, *mem = NULL;
1390 struct scatterlist *sgin = NULL;
1391 struct scatterlist *sgout = NULL;
1392 const int data_len = rxm->full_len - prot->overhead_size +
1396 if (*zc && (out_iov || out_sg)) {
1398 n_sgout = iov_iter_npages(out_iov, INT_MAX) + 1;
1400 n_sgout = sg_nents(out_sg);
1401 n_sgin = skb_nsg(skb, rxm->offset + prot->prepend_size,
1402 rxm->full_len - prot->prepend_size);
1406 n_sgin = skb_cow_data(skb, 0, &unused);
1412 /* Increment to accommodate AAD */
1413 n_sgin = n_sgin + 1;
1415 nsg = n_sgin + n_sgout;
1417 aead_size = sizeof(*aead_req) + crypto_aead_reqsize(ctx->aead_recv);
1418 mem_size = aead_size + (nsg * sizeof(struct scatterlist));
1419 mem_size = mem_size + prot->aad_size;
1420 mem_size = mem_size + crypto_aead_ivsize(ctx->aead_recv);
1422 /* Allocate a single block of memory which contains
1423 * aead_req || sgin[] || sgout[] || aad || iv.
1424 * This order achieves correct alignment for aead_req, sgin, sgout.
1426 mem = kmalloc(mem_size, sk->sk_allocation);
1430 /* Segment the allocated memory */
1431 aead_req = (struct aead_request *)mem;
1432 sgin = (struct scatterlist *)(mem + aead_size);
1433 sgout = sgin + n_sgin;
1434 aad = (u8 *)(sgout + n_sgout);
1435 iv = aad + prot->aad_size;
1437 /* For CCM based ciphers, first byte of nonce+iv is always '2' */
1438 if (prot->cipher_type == TLS_CIPHER_AES_CCM_128) {
1444 err = skb_copy_bits(skb, rxm->offset + TLS_HEADER_SIZE,
1445 iv + iv_offset + prot->salt_size,
1451 if (prot->version == TLS_1_3_VERSION)
1452 memcpy(iv + iv_offset, tls_ctx->rx.iv,
1453 crypto_aead_ivsize(ctx->aead_recv));
1455 memcpy(iv + iv_offset, tls_ctx->rx.iv, prot->salt_size);
1457 xor_iv_with_seq(prot->version, iv, tls_ctx->rx.rec_seq);
1460 tls_make_aad(aad, rxm->full_len - prot->overhead_size +
1462 tls_ctx->rx.rec_seq, prot->rec_seq_size,
1463 ctx->control, prot->version);
1466 sg_init_table(sgin, n_sgin);
1467 sg_set_buf(&sgin[0], aad, prot->aad_size);
1468 err = skb_to_sgvec(skb, &sgin[1],
1469 rxm->offset + prot->prepend_size,
1470 rxm->full_len - prot->prepend_size);
1478 sg_init_table(sgout, n_sgout);
1479 sg_set_buf(&sgout[0], aad, prot->aad_size);
1482 err = tls_setup_from_iter(sk, out_iov, data_len,
1483 &pages, chunk, &sgout[1],
1486 goto fallback_to_reg_recv;
1487 } else if (out_sg) {
1488 memcpy(sgout, out_sg, n_sgout * sizeof(*sgout));
1490 goto fallback_to_reg_recv;
1493 fallback_to_reg_recv:
1500 /* Prepare and submit AEAD request */
1501 err = tls_do_decryption(sk, skb, sgin, sgout, iv,
1502 data_len, aead_req, async);
1503 if (err == -EINPROGRESS)
1506 /* Release the pages in case iov was mapped to pages */
1507 for (; pages > 0; pages--)
1508 put_page(sg_page(&sgout[pages]));
1514 static int decrypt_skb_update(struct sock *sk, struct sk_buff *skb,
1515 struct iov_iter *dest, int *chunk, bool *zc,
1518 struct tls_context *tls_ctx = tls_get_ctx(sk);
1519 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1520 struct tls_prot_info *prot = &tls_ctx->prot_info;
1521 struct strp_msg *rxm = strp_msg(skb);
1524 if (!ctx->decrypted) {
1525 if (tls_ctx->rx_conf == TLS_HW) {
1526 err = tls_device_decrypted(sk, tls_ctx, skb, rxm);
1531 /* Still not decrypted after tls_device */
1532 if (!ctx->decrypted) {
1533 err = decrypt_internal(sk, skb, dest, NULL, chunk, zc,
1536 if (err == -EINPROGRESS)
1537 tls_advance_record_sn(sk, prot,
1539 else if (err == -EBADMSG)
1540 TLS_INC_STATS(sock_net(sk),
1541 LINUX_MIB_TLSDECRYPTERROR);
1548 pad = padding_length(ctx, prot, skb);
1552 rxm->full_len -= pad;
1553 rxm->offset += prot->prepend_size;
1554 rxm->full_len -= prot->overhead_size;
1555 tls_advance_record_sn(sk, prot, &tls_ctx->rx);
1557 ctx->saved_data_ready(sk);
1565 int decrypt_skb(struct sock *sk, struct sk_buff *skb,
1566 struct scatterlist *sgout)
1571 return decrypt_internal(sk, skb, NULL, sgout, &chunk, &zc, false);
1574 static bool tls_sw_advance_skb(struct sock *sk, struct sk_buff *skb,
1577 struct tls_context *tls_ctx = tls_get_ctx(sk);
1578 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1581 struct strp_msg *rxm = strp_msg(skb);
1583 if (len < rxm->full_len) {
1585 rxm->full_len -= len;
1591 /* Finished with message */
1592 ctx->recv_pkt = NULL;
1593 __strp_unpause(&ctx->strp);
1598 /* This function traverses the rx_list in tls receive context to copies the
1599 * decrypted records into the buffer provided by caller zero copy is not
1600 * true. Further, the records are removed from the rx_list if it is not a peek
1601 * case and the record has been consumed completely.
1603 static int process_rx_list(struct tls_sw_context_rx *ctx,
1612 struct sk_buff *skb = skb_peek(&ctx->rx_list);
1615 struct tls_msg *tlm;
1618 /* Set the record type in 'control' if caller didn't pass it */
1621 ctrl = tlm->control;
1624 while (skip && skb) {
1625 struct strp_msg *rxm = strp_msg(skb);
1628 /* Cannot process a record of different type */
1629 if (ctrl != tlm->control)
1632 if (skip < rxm->full_len)
1635 skip = skip - rxm->full_len;
1636 skb = skb_peek_next(skb, &ctx->rx_list);
1639 while (len && skb) {
1640 struct sk_buff *next_skb;
1641 struct strp_msg *rxm = strp_msg(skb);
1642 int chunk = min_t(unsigned int, rxm->full_len - skip, len);
1646 /* Cannot process a record of different type */
1647 if (ctrl != tlm->control)
1650 /* Set record type if not already done. For a non-data record,
1651 * do not proceed if record type could not be copied.
1654 int cerr = put_cmsg(msg, SOL_TLS, TLS_GET_RECORD_TYPE,
1655 sizeof(ctrl), &ctrl);
1657 if (ctrl != TLS_RECORD_TYPE_DATA) {
1658 if (cerr || msg->msg_flags & MSG_CTRUNC)
1665 if (!zc || (rxm->full_len - skip) > len) {
1666 int err = skb_copy_datagram_msg(skb, rxm->offset + skip,
1673 copied = copied + chunk;
1675 /* Consume the data from record if it is non-peek case*/
1677 rxm->offset = rxm->offset + chunk;
1678 rxm->full_len = rxm->full_len - chunk;
1680 /* Return if there is unconsumed data in the record */
1681 if (rxm->full_len - skip)
1685 /* The remaining skip-bytes must lie in 1st record in rx_list.
1686 * So from the 2nd record, 'skip' should be 0.
1691 msg->msg_flags |= MSG_EOR;
1693 next_skb = skb_peek_next(skb, &ctx->rx_list);
1696 skb_unlink(skb, &ctx->rx_list);
1707 int tls_sw_recvmsg(struct sock *sk,
1714 struct tls_context *tls_ctx = tls_get_ctx(sk);
1715 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1716 struct tls_prot_info *prot = &tls_ctx->prot_info;
1717 struct sk_psock *psock;
1718 unsigned char control = 0;
1719 ssize_t decrypted = 0;
1720 struct strp_msg *rxm;
1721 struct tls_msg *tlm;
1722 struct sk_buff *skb;
1725 int target, err = 0;
1727 bool is_kvec = iov_iter_is_kvec(&msg->msg_iter);
1728 bool is_peek = flags & MSG_PEEK;
1733 if (unlikely(flags & MSG_ERRQUEUE))
1734 return sock_recv_errqueue(sk, msg, len, SOL_IP, IP_RECVERR);
1736 psock = sk_psock_get(sk);
1739 /* Process pending decrypted records. It must be non-zero-copy */
1740 err = process_rx_list(ctx, msg, &control, &cmsg, 0, len, false,
1743 tls_err_abort(sk, err);
1752 target = sock_rcvlowat(sk, flags & MSG_WAITALL, len);
1754 timeo = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
1756 while (len && (decrypted + copied < target || ctx->recv_pkt)) {
1757 bool retain_skb = false;
1764 skb = tls_wait_data(sk, psock, flags, timeo, &err);
1767 int ret = __tcp_bpf_recvmsg(sk, psock,
1779 if (prot->version == TLS_1_3_VERSION)
1782 tlm->control = ctx->control;
1785 rxm = strp_msg(skb);
1787 to_decrypt = rxm->full_len - prot->overhead_size;
1789 if (to_decrypt <= len && !is_kvec && !is_peek &&
1790 ctx->control == TLS_RECORD_TYPE_DATA &&
1791 prot->version != TLS_1_3_VERSION)
1794 /* Do not use async mode if record is non-data */
1795 if (ctx->control == TLS_RECORD_TYPE_DATA)
1796 async_capable = ctx->async_capable;
1798 async_capable = false;
1800 err = decrypt_skb_update(sk, skb, &msg->msg_iter,
1801 &chunk, &zc, async_capable);
1802 if (err < 0 && err != -EINPROGRESS) {
1803 tls_err_abort(sk, EBADMSG);
1807 if (err == -EINPROGRESS) {
1810 } else if (prot->version == TLS_1_3_VERSION) {
1811 tlm->control = ctx->control;
1814 /* If the type of records being processed is not known yet,
1815 * set it to record type just dequeued. If it is already known,
1816 * but does not match the record type just dequeued, go to end.
1817 * We always get record type here since for tls1.2, record type
1818 * is known just after record is dequeued from stream parser.
1819 * For tls1.3, we disable async.
1823 control = tlm->control;
1824 else if (control != tlm->control)
1830 cerr = put_cmsg(msg, SOL_TLS, TLS_GET_RECORD_TYPE,
1831 sizeof(control), &control);
1833 if (control != TLS_RECORD_TYPE_DATA) {
1834 if (cerr || msg->msg_flags & MSG_CTRUNC) {
1842 goto pick_next_record;
1845 if (rxm->full_len > len) {
1849 chunk = rxm->full_len;
1852 err = skb_copy_datagram_msg(skb, rxm->offset,
1858 rxm->offset = rxm->offset + chunk;
1859 rxm->full_len = rxm->full_len - chunk;
1870 /* For async or peek case, queue the current skb */
1871 if (async || is_peek || retain_skb) {
1872 skb_queue_tail(&ctx->rx_list, skb);
1876 if (tls_sw_advance_skb(sk, skb, chunk)) {
1877 /* Return full control message to
1878 * userspace before trying to parse
1879 * another message type
1881 msg->msg_flags |= MSG_EOR;
1882 if (ctx->control != TLS_RECORD_TYPE_DATA)
1891 /* Wait for all previously submitted records to be decrypted */
1892 smp_store_mb(ctx->async_notify, true);
1893 if (atomic_read(&ctx->decrypt_pending)) {
1894 err = crypto_wait_req(-EINPROGRESS, &ctx->async_wait);
1896 /* one of async decrypt failed */
1897 tls_err_abort(sk, err);
1903 reinit_completion(&ctx->async_wait.completion);
1905 WRITE_ONCE(ctx->async_notify, false);
1907 /* Drain records from the rx_list & copy if required */
1908 if (is_peek || is_kvec)
1909 err = process_rx_list(ctx, msg, &control, &cmsg, copied,
1910 decrypted, false, is_peek);
1912 err = process_rx_list(ctx, msg, &control, &cmsg, 0,
1913 decrypted, true, is_peek);
1915 tls_err_abort(sk, err);
1921 copied += decrypted;
1926 sk_psock_put(sk, psock);
1927 return copied ? : err;
1930 ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
1931 struct pipe_inode_info *pipe,
1932 size_t len, unsigned int flags)
1934 struct tls_context *tls_ctx = tls_get_ctx(sock->sk);
1935 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1936 struct strp_msg *rxm = NULL;
1937 struct sock *sk = sock->sk;
1938 struct sk_buff *skb;
1947 timeo = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
1949 skb = tls_wait_data(sk, NULL, flags, timeo, &err);
1951 goto splice_read_end;
1953 if (!ctx->decrypted) {
1954 err = decrypt_skb_update(sk, skb, NULL, &chunk, &zc, false);
1956 /* splice does not support reading control messages */
1957 if (ctx->control != TLS_RECORD_TYPE_DATA) {
1959 goto splice_read_end;
1963 tls_err_abort(sk, EBADMSG);
1964 goto splice_read_end;
1968 rxm = strp_msg(skb);
1970 chunk = min_t(unsigned int, rxm->full_len, len);
1971 copied = skb_splice_bits(skb, sk, rxm->offset, pipe, chunk, flags);
1973 goto splice_read_end;
1975 if (likely(!(flags & MSG_PEEK)))
1976 tls_sw_advance_skb(sk, skb, copied);
1980 return copied ? : err;
1983 bool tls_sw_stream_read(const struct sock *sk)
1985 struct tls_context *tls_ctx = tls_get_ctx(sk);
1986 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
1987 bool ingress_empty = true;
1988 struct sk_psock *psock;
1991 psock = sk_psock(sk);
1993 ingress_empty = list_empty(&psock->ingress_msg);
1996 return !ingress_empty || ctx->recv_pkt ||
1997 !skb_queue_empty(&ctx->rx_list);
2000 static int tls_read_size(struct strparser *strp, struct sk_buff *skb)
2002 struct tls_context *tls_ctx = tls_get_ctx(strp->sk);
2003 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
2004 struct tls_prot_info *prot = &tls_ctx->prot_info;
2005 char header[TLS_HEADER_SIZE + MAX_IV_SIZE];
2006 struct strp_msg *rxm = strp_msg(skb);
2007 size_t cipher_overhead;
2008 size_t data_len = 0;
2011 /* Verify that we have a full TLS header, or wait for more data */
2012 if (rxm->offset + prot->prepend_size > skb->len)
2015 /* Sanity-check size of on-stack buffer. */
2016 if (WARN_ON(prot->prepend_size > sizeof(header))) {
2021 /* Linearize header to local buffer */
2022 ret = skb_copy_bits(skb, rxm->offset, header, prot->prepend_size);
2027 ctx->control = header[0];
2029 data_len = ((header[4] & 0xFF) | (header[3] << 8));
2031 cipher_overhead = prot->tag_size;
2032 if (prot->version != TLS_1_3_VERSION)
2033 cipher_overhead += prot->iv_size;
2035 if (data_len > TLS_MAX_PAYLOAD_SIZE + cipher_overhead +
2040 if (data_len < cipher_overhead) {
2045 /* Note that both TLS1.3 and TLS1.2 use TLS_1_2 version here */
2046 if (header[1] != TLS_1_2_VERSION_MINOR ||
2047 header[2] != TLS_1_2_VERSION_MAJOR) {
2052 tls_device_rx_resync_new_rec(strp->sk, data_len + TLS_HEADER_SIZE,
2053 TCP_SKB_CB(skb)->seq + rxm->offset);
2054 return data_len + TLS_HEADER_SIZE;
2057 tls_err_abort(strp->sk, ret);
2062 static void tls_queue(struct strparser *strp, struct sk_buff *skb)
2064 struct tls_context *tls_ctx = tls_get_ctx(strp->sk);
2065 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
2069 ctx->recv_pkt = skb;
2072 ctx->saved_data_ready(strp->sk);
2075 static void tls_data_ready(struct sock *sk)
2077 struct tls_context *tls_ctx = tls_get_ctx(sk);
2078 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
2079 struct sk_psock *psock;
2081 strp_data_ready(&ctx->strp);
2083 psock = sk_psock_get(sk);
2084 if (psock && !list_empty(&psock->ingress_msg)) {
2085 ctx->saved_data_ready(sk);
2086 sk_psock_put(sk, psock);
2090 void tls_sw_cancel_work_tx(struct tls_context *tls_ctx)
2092 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
2094 set_bit(BIT_TX_CLOSING, &ctx->tx_bitmask);
2095 set_bit(BIT_TX_SCHEDULED, &ctx->tx_bitmask);
2096 cancel_delayed_work_sync(&ctx->tx_work.work);
2099 void tls_sw_release_resources_tx(struct sock *sk)
2101 struct tls_context *tls_ctx = tls_get_ctx(sk);
2102 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
2103 struct tls_rec *rec, *tmp;
2105 /* Wait for any pending async encryptions to complete */
2106 smp_store_mb(ctx->async_notify, true);
2107 if (atomic_read(&ctx->encrypt_pending))
2108 crypto_wait_req(-EINPROGRESS, &ctx->async_wait);
2110 tls_tx_records(sk, -1);
2112 /* Free up un-sent records in tx_list. First, free
2113 * the partially sent record if any at head of tx_list.
2115 if (tls_ctx->partially_sent_record) {
2116 tls_free_partial_record(sk, tls_ctx);
2117 rec = list_first_entry(&ctx->tx_list,
2118 struct tls_rec, list);
2119 list_del(&rec->list);
2120 sk_msg_free(sk, &rec->msg_plaintext);
2124 list_for_each_entry_safe(rec, tmp, &ctx->tx_list, list) {
2125 list_del(&rec->list);
2126 sk_msg_free(sk, &rec->msg_encrypted);
2127 sk_msg_free(sk, &rec->msg_plaintext);
2131 crypto_free_aead(ctx->aead_send);
2132 tls_free_open_rec(sk);
2135 void tls_sw_free_ctx_tx(struct tls_context *tls_ctx)
2137 struct tls_sw_context_tx *ctx = tls_sw_ctx_tx(tls_ctx);
2142 void tls_sw_release_resources_rx(struct sock *sk)
2144 struct tls_context *tls_ctx = tls_get_ctx(sk);
2145 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
2147 kfree(tls_ctx->rx.rec_seq);
2148 kfree(tls_ctx->rx.iv);
2150 if (ctx->aead_recv) {
2151 kfree_skb(ctx->recv_pkt);
2152 ctx->recv_pkt = NULL;
2153 skb_queue_purge(&ctx->rx_list);
2154 crypto_free_aead(ctx->aead_recv);
2155 strp_stop(&ctx->strp);
2156 /* If tls_sw_strparser_arm() was not called (cleanup paths)
2157 * we still want to strp_stop(), but sk->sk_data_ready was
2160 if (ctx->saved_data_ready) {
2161 write_lock_bh(&sk->sk_callback_lock);
2162 sk->sk_data_ready = ctx->saved_data_ready;
2163 write_unlock_bh(&sk->sk_callback_lock);
2168 void tls_sw_strparser_done(struct tls_context *tls_ctx)
2170 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
2172 strp_done(&ctx->strp);
2175 void tls_sw_free_ctx_rx(struct tls_context *tls_ctx)
2177 struct tls_sw_context_rx *ctx = tls_sw_ctx_rx(tls_ctx);
2182 void tls_sw_free_resources_rx(struct sock *sk)
2184 struct tls_context *tls_ctx = tls_get_ctx(sk);
2186 tls_sw_release_resources_rx(sk);
2187 tls_sw_free_ctx_rx(tls_ctx);
2190 /* The work handler to transmitt the encrypted records in tx_list */
2191 static void tx_work_handler(struct work_struct *work)
2193 struct delayed_work *delayed_work = to_delayed_work(work);
2194 struct tx_work *tx_work = container_of(delayed_work,
2195 struct tx_work, work);
2196 struct sock *sk = tx_work->sk;
2197 struct tls_context *tls_ctx = tls_get_ctx(sk);
2198 struct tls_sw_context_tx *ctx;
2200 if (unlikely(!tls_ctx))
2203 ctx = tls_sw_ctx_tx(tls_ctx);
2204 if (test_bit(BIT_TX_CLOSING, &ctx->tx_bitmask))
2207 if (!test_and_clear_bit(BIT_TX_SCHEDULED, &ctx->tx_bitmask))
2209 mutex_lock(&tls_ctx->tx_lock);
2211 tls_tx_records(sk, -1);
2213 mutex_unlock(&tls_ctx->tx_lock);
2216 void tls_sw_write_space(struct sock *sk, struct tls_context *ctx)
2218 struct tls_sw_context_tx *tx_ctx = tls_sw_ctx_tx(ctx);
2220 /* Schedule the transmission if tx list is ready */
2221 if (is_tx_ready(tx_ctx) &&
2222 !test_and_set_bit(BIT_TX_SCHEDULED, &tx_ctx->tx_bitmask))
2223 schedule_delayed_work(&tx_ctx->tx_work.work, 0);
2226 void tls_sw_strparser_arm(struct sock *sk, struct tls_context *tls_ctx)
2228 struct tls_sw_context_rx *rx_ctx = tls_sw_ctx_rx(tls_ctx);
2230 write_lock_bh(&sk->sk_callback_lock);
2231 rx_ctx->saved_data_ready = sk->sk_data_ready;
2232 sk->sk_data_ready = tls_data_ready;
2233 write_unlock_bh(&sk->sk_callback_lock);
2235 strp_check_rcv(&rx_ctx->strp);
2238 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx)
2240 struct tls_context *tls_ctx = tls_get_ctx(sk);
2241 struct tls_prot_info *prot = &tls_ctx->prot_info;
2242 struct tls_crypto_info *crypto_info;
2243 struct tls12_crypto_info_aes_gcm_128 *gcm_128_info;
2244 struct tls12_crypto_info_aes_gcm_256 *gcm_256_info;
2245 struct tls12_crypto_info_aes_ccm_128 *ccm_128_info;
2246 struct tls_sw_context_tx *sw_ctx_tx = NULL;
2247 struct tls_sw_context_rx *sw_ctx_rx = NULL;
2248 struct cipher_context *cctx;
2249 struct crypto_aead **aead;
2250 struct strp_callbacks cb;
2251 u16 nonce_size, tag_size, iv_size, rec_seq_size, salt_size;
2252 struct crypto_tfm *tfm;
2253 char *iv, *rec_seq, *key, *salt, *cipher_name;
2263 if (!ctx->priv_ctx_tx) {
2264 sw_ctx_tx = kzalloc(sizeof(*sw_ctx_tx), GFP_KERNEL);
2269 ctx->priv_ctx_tx = sw_ctx_tx;
2272 (struct tls_sw_context_tx *)ctx->priv_ctx_tx;
2275 if (!ctx->priv_ctx_rx) {
2276 sw_ctx_rx = kzalloc(sizeof(*sw_ctx_rx), GFP_KERNEL);
2281 ctx->priv_ctx_rx = sw_ctx_rx;
2284 (struct tls_sw_context_rx *)ctx->priv_ctx_rx;
2289 crypto_init_wait(&sw_ctx_tx->async_wait);
2290 crypto_info = &ctx->crypto_send.info;
2292 aead = &sw_ctx_tx->aead_send;
2293 INIT_LIST_HEAD(&sw_ctx_tx->tx_list);
2294 INIT_DELAYED_WORK(&sw_ctx_tx->tx_work.work, tx_work_handler);
2295 sw_ctx_tx->tx_work.sk = sk;
2297 crypto_init_wait(&sw_ctx_rx->async_wait);
2298 crypto_info = &ctx->crypto_recv.info;
2300 skb_queue_head_init(&sw_ctx_rx->rx_list);
2301 aead = &sw_ctx_rx->aead_recv;
2304 switch (crypto_info->cipher_type) {
2305 case TLS_CIPHER_AES_GCM_128: {
2306 nonce_size = TLS_CIPHER_AES_GCM_128_IV_SIZE;
2307 tag_size = TLS_CIPHER_AES_GCM_128_TAG_SIZE;
2308 iv_size = TLS_CIPHER_AES_GCM_128_IV_SIZE;
2309 iv = ((struct tls12_crypto_info_aes_gcm_128 *)crypto_info)->iv;
2310 rec_seq_size = TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE;
2312 ((struct tls12_crypto_info_aes_gcm_128 *)crypto_info)->rec_seq;
2314 (struct tls12_crypto_info_aes_gcm_128 *)crypto_info;
2315 keysize = TLS_CIPHER_AES_GCM_128_KEY_SIZE;
2316 key = gcm_128_info->key;
2317 salt = gcm_128_info->salt;
2318 salt_size = TLS_CIPHER_AES_GCM_128_SALT_SIZE;
2319 cipher_name = "gcm(aes)";
2322 case TLS_CIPHER_AES_GCM_256: {
2323 nonce_size = TLS_CIPHER_AES_GCM_256_IV_SIZE;
2324 tag_size = TLS_CIPHER_AES_GCM_256_TAG_SIZE;
2325 iv_size = TLS_CIPHER_AES_GCM_256_IV_SIZE;
2326 iv = ((struct tls12_crypto_info_aes_gcm_256 *)crypto_info)->iv;
2327 rec_seq_size = TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE;
2329 ((struct tls12_crypto_info_aes_gcm_256 *)crypto_info)->rec_seq;
2331 (struct tls12_crypto_info_aes_gcm_256 *)crypto_info;
2332 keysize = TLS_CIPHER_AES_GCM_256_KEY_SIZE;
2333 key = gcm_256_info->key;
2334 salt = gcm_256_info->salt;
2335 salt_size = TLS_CIPHER_AES_GCM_256_SALT_SIZE;
2336 cipher_name = "gcm(aes)";
2339 case TLS_CIPHER_AES_CCM_128: {
2340 nonce_size = TLS_CIPHER_AES_CCM_128_IV_SIZE;
2341 tag_size = TLS_CIPHER_AES_CCM_128_TAG_SIZE;
2342 iv_size = TLS_CIPHER_AES_CCM_128_IV_SIZE;
2343 iv = ((struct tls12_crypto_info_aes_ccm_128 *)crypto_info)->iv;
2344 rec_seq_size = TLS_CIPHER_AES_CCM_128_REC_SEQ_SIZE;
2346 ((struct tls12_crypto_info_aes_ccm_128 *)crypto_info)->rec_seq;
2348 (struct tls12_crypto_info_aes_ccm_128 *)crypto_info;
2349 keysize = TLS_CIPHER_AES_CCM_128_KEY_SIZE;
2350 key = ccm_128_info->key;
2351 salt = ccm_128_info->salt;
2352 salt_size = TLS_CIPHER_AES_CCM_128_SALT_SIZE;
2353 cipher_name = "ccm(aes)";
2361 /* Sanity-check the sizes for stack allocations. */
2362 if (iv_size > MAX_IV_SIZE || nonce_size > MAX_IV_SIZE ||
2363 rec_seq_size > TLS_MAX_REC_SEQ_SIZE) {
2368 if (crypto_info->version == TLS_1_3_VERSION) {
2370 prot->aad_size = TLS_HEADER_SIZE;
2371 prot->tail_size = 1;
2373 prot->aad_size = TLS_AAD_SPACE_SIZE;
2374 prot->tail_size = 0;
2377 prot->version = crypto_info->version;
2378 prot->cipher_type = crypto_info->cipher_type;
2379 prot->prepend_size = TLS_HEADER_SIZE + nonce_size;
2380 prot->tag_size = tag_size;
2381 prot->overhead_size = prot->prepend_size +
2382 prot->tag_size + prot->tail_size;
2383 prot->iv_size = iv_size;
2384 prot->salt_size = salt_size;
2385 cctx->iv = kmalloc(iv_size + salt_size, GFP_KERNEL);
2390 /* Note: 128 & 256 bit salt are the same size */
2391 prot->rec_seq_size = rec_seq_size;
2392 memcpy(cctx->iv, salt, salt_size);
2393 memcpy(cctx->iv + salt_size, iv, iv_size);
2394 cctx->rec_seq = kmemdup(rec_seq, rec_seq_size, GFP_KERNEL);
2395 if (!cctx->rec_seq) {
2401 *aead = crypto_alloc_aead(cipher_name, 0, 0);
2402 if (IS_ERR(*aead)) {
2403 rc = PTR_ERR(*aead);
2409 ctx->push_pending_record = tls_sw_push_pending_record;
2411 rc = crypto_aead_setkey(*aead, key, keysize);
2416 rc = crypto_aead_setauthsize(*aead, prot->tag_size);
2421 tfm = crypto_aead_tfm(sw_ctx_rx->aead_recv);
2423 if (crypto_info->version == TLS_1_3_VERSION)
2424 sw_ctx_rx->async_capable = 0;
2426 sw_ctx_rx->async_capable =
2427 !!(tfm->__crt_alg->cra_flags &
2430 /* Set up strparser */
2431 memset(&cb, 0, sizeof(cb));
2432 cb.rcv_msg = tls_queue;
2433 cb.parse_msg = tls_read_size;
2435 strp_init(&sw_ctx_rx->strp, sk, &cb);
2441 crypto_free_aead(*aead);
2444 kfree(cctx->rec_seq);
2445 cctx->rec_seq = NULL;
2451 kfree(ctx->priv_ctx_tx);
2452 ctx->priv_ctx_tx = NULL;
2454 kfree(ctx->priv_ctx_rx);
2455 ctx->priv_ctx_rx = NULL;