2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2014-2019 Netflix Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 #include "opt_inet6.h"
35 #include <sys/param.h>
36 #include <sys/kernel.h>
40 #include <sys/mutex.h>
41 #include <sys/rmlock.h>
43 #include <sys/protosw.h>
44 #include <sys/refcount.h>
46 #include <sys/socket.h>
47 #include <sys/socketvar.h>
48 #include <sys/sysctl.h>
49 #include <sys/taskqueue.h>
50 #include <sys/kthread.h>
52 #include <sys/vmmeter.h>
53 #if defined(__aarch64__) || defined(__amd64__) || defined(__i386__)
54 #include <machine/pcb.h>
56 #include <machine/vmparam.h>
58 #include <net/if_var.h>
60 #include <net/netisr.h>
61 #include <net/rss_config.h>
63 #include <net/route.h>
64 #include <net/route/nhop.h>
65 #if defined(INET) || defined(INET6)
66 #include <netinet/in.h>
67 #include <netinet/in_pcb.h>
69 #include <netinet/tcp_var.h>
71 #include <netinet/tcp_offload.h>
73 #include <opencrypto/xform.h>
74 #include <vm/uma_dbg.h>
76 #include <vm/vm_pageout.h>
77 #include <vm/vm_page.h>
81 STAILQ_HEAD(, mbuf) m_head;
82 STAILQ_HEAD(, socket) so_head;
84 } __aligned(CACHE_LINE_SIZE);
86 static struct ktls_wq *ktls_wq;
87 static struct proc *ktls_proc;
88 LIST_HEAD(, ktls_crypto_backend) ktls_backends;
89 static struct rmlock ktls_backends_lock;
90 static uma_zone_t ktls_session_zone;
91 static uint16_t ktls_cpuid_lookup[MAXCPU];
93 SYSCTL_NODE(_kern_ipc, OID_AUTO, tls, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
94 "Kernel TLS offload");
95 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, stats, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
96 "Kernel TLS offload stats");
98 static int ktls_allow_unload;
99 SYSCTL_INT(_kern_ipc_tls, OID_AUTO, allow_unload, CTLFLAG_RDTUN,
100 &ktls_allow_unload, 0, "Allow software crypto modules to unload");
103 static int ktls_bind_threads = 1;
105 static int ktls_bind_threads;
107 SYSCTL_INT(_kern_ipc_tls, OID_AUTO, bind_threads, CTLFLAG_RDTUN,
108 &ktls_bind_threads, 0,
109 "Bind crypto threads to cores or domains at boot");
111 static u_int ktls_maxlen = 16384;
112 SYSCTL_UINT(_kern_ipc_tls, OID_AUTO, maxlen, CTLFLAG_RWTUN,
113 &ktls_maxlen, 0, "Maximum TLS record size");
115 static int ktls_number_threads;
116 SYSCTL_INT(_kern_ipc_tls_stats, OID_AUTO, threads, CTLFLAG_RD,
117 &ktls_number_threads, 0,
118 "Number of TLS threads in thread-pool");
120 static bool ktls_offload_enable;
121 SYSCTL_BOOL(_kern_ipc_tls, OID_AUTO, enable, CTLFLAG_RW,
122 &ktls_offload_enable, 0,
123 "Enable support for kernel TLS offload");
125 static bool ktls_cbc_enable = true;
126 SYSCTL_BOOL(_kern_ipc_tls, OID_AUTO, cbc_enable, CTLFLAG_RW,
128 "Enable Support of AES-CBC crypto for kernel TLS");
130 static counter_u64_t ktls_tasks_active;
131 SYSCTL_COUNTER_U64(_kern_ipc_tls, OID_AUTO, tasks_active, CTLFLAG_RD,
132 &ktls_tasks_active, "Number of active tasks");
134 static counter_u64_t ktls_cnt_tx_queued;
135 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, sw_tx_inqueue, CTLFLAG_RD,
137 "Number of TLS records in queue to tasks for SW encryption");
139 static counter_u64_t ktls_cnt_rx_queued;
140 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, sw_rx_inqueue, CTLFLAG_RD,
142 "Number of TLS sockets in queue to tasks for SW decryption");
144 static counter_u64_t ktls_offload_total;
145 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, offload_total,
146 CTLFLAG_RD, &ktls_offload_total,
147 "Total successful TLS setups (parameters set)");
149 static counter_u64_t ktls_offload_enable_calls;
150 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, enable_calls,
151 CTLFLAG_RD, &ktls_offload_enable_calls,
152 "Total number of TLS enable calls made");
154 static counter_u64_t ktls_offload_active;
155 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, active, CTLFLAG_RD,
156 &ktls_offload_active, "Total Active TLS sessions");
158 static counter_u64_t ktls_offload_corrupted_records;
159 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, corrupted_records, CTLFLAG_RD,
160 &ktls_offload_corrupted_records, "Total corrupted TLS records received");
162 static counter_u64_t ktls_offload_failed_crypto;
163 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, failed_crypto, CTLFLAG_RD,
164 &ktls_offload_failed_crypto, "Total TLS crypto failures");
166 static counter_u64_t ktls_switch_to_ifnet;
167 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_to_ifnet, CTLFLAG_RD,
168 &ktls_switch_to_ifnet, "TLS sessions switched from SW to ifnet");
170 static counter_u64_t ktls_switch_to_sw;
171 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_to_sw, CTLFLAG_RD,
172 &ktls_switch_to_sw, "TLS sessions switched from ifnet to SW");
174 static counter_u64_t ktls_switch_failed;
175 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_failed, CTLFLAG_RD,
176 &ktls_switch_failed, "TLS sessions unable to switch between SW and ifnet");
178 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, sw, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
179 "Software TLS session stats");
180 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, ifnet, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
181 "Hardware (ifnet) TLS session stats");
183 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, toe, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
184 "TOE TLS session stats");
187 static counter_u64_t ktls_sw_cbc;
188 SYSCTL_COUNTER_U64(_kern_ipc_tls_sw, OID_AUTO, cbc, CTLFLAG_RD, &ktls_sw_cbc,
189 "Active number of software TLS sessions using AES-CBC");
191 static counter_u64_t ktls_sw_gcm;
192 SYSCTL_COUNTER_U64(_kern_ipc_tls_sw, OID_AUTO, gcm, CTLFLAG_RD, &ktls_sw_gcm,
193 "Active number of software TLS sessions using AES-GCM");
195 static counter_u64_t ktls_ifnet_cbc;
196 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, cbc, CTLFLAG_RD,
198 "Active number of ifnet TLS sessions using AES-CBC");
200 static counter_u64_t ktls_ifnet_gcm;
201 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, gcm, CTLFLAG_RD,
203 "Active number of ifnet TLS sessions using AES-GCM");
205 static counter_u64_t ktls_ifnet_reset;
206 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset, CTLFLAG_RD,
207 &ktls_ifnet_reset, "TLS sessions updated to a new ifnet send tag");
209 static counter_u64_t ktls_ifnet_reset_dropped;
210 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset_dropped, CTLFLAG_RD,
211 &ktls_ifnet_reset_dropped,
212 "TLS sessions dropped after failing to update ifnet send tag");
214 static counter_u64_t ktls_ifnet_reset_failed;
215 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset_failed, CTLFLAG_RD,
216 &ktls_ifnet_reset_failed,
217 "TLS sessions that failed to allocate a new ifnet send tag");
219 static int ktls_ifnet_permitted;
220 SYSCTL_UINT(_kern_ipc_tls_ifnet, OID_AUTO, permitted, CTLFLAG_RWTUN,
221 &ktls_ifnet_permitted, 1,
222 "Whether to permit hardware (ifnet) TLS sessions");
225 static counter_u64_t ktls_toe_cbc;
226 SYSCTL_COUNTER_U64(_kern_ipc_tls_toe, OID_AUTO, cbc, CTLFLAG_RD,
228 "Active number of TOE TLS sessions using AES-CBC");
230 static counter_u64_t ktls_toe_gcm;
231 SYSCTL_COUNTER_U64(_kern_ipc_tls_toe, OID_AUTO, gcm, CTLFLAG_RD,
233 "Active number of TOE TLS sessions using AES-GCM");
236 static MALLOC_DEFINE(M_KTLS, "ktls", "Kernel TLS");
238 static void ktls_cleanup(struct ktls_session *tls);
239 #if defined(INET) || defined(INET6)
240 static void ktls_reset_send_tag(void *context, int pending);
242 static void ktls_work_thread(void *ctx);
245 ktls_crypto_backend_register(struct ktls_crypto_backend *be)
247 struct ktls_crypto_backend *curr_be, *tmp;
249 if (be->api_version != KTLS_API_VERSION) {
250 printf("KTLS: API version mismatch (%d vs %d) for %s\n",
251 be->api_version, KTLS_API_VERSION,
256 rm_wlock(&ktls_backends_lock);
257 printf("KTLS: Registering crypto method %s with prio %d\n",
259 if (LIST_EMPTY(&ktls_backends)) {
260 LIST_INSERT_HEAD(&ktls_backends, be, next);
262 LIST_FOREACH_SAFE(curr_be, &ktls_backends, next, tmp) {
263 if (curr_be->prio < be->prio) {
264 LIST_INSERT_BEFORE(curr_be, be, next);
267 if (LIST_NEXT(curr_be, next) == NULL) {
268 LIST_INSERT_AFTER(curr_be, be, next);
273 rm_wunlock(&ktls_backends_lock);
278 ktls_crypto_backend_deregister(struct ktls_crypto_backend *be)
280 struct ktls_crypto_backend *tmp;
283 * Don't error if the backend isn't registered. This permits
284 * MOD_UNLOAD handlers to use this function unconditionally.
286 rm_wlock(&ktls_backends_lock);
287 LIST_FOREACH(tmp, &ktls_backends, next) {
292 rm_wunlock(&ktls_backends_lock);
296 if (!ktls_allow_unload) {
297 rm_wunlock(&ktls_backends_lock);
299 "KTLS: Deregistering crypto method %s is not supported\n",
305 rm_wunlock(&ktls_backends_lock);
309 LIST_REMOVE(be, next);
310 rm_wunlock(&ktls_backends_lock);
314 #if defined(INET) || defined(INET6)
316 ktls_get_cpu(struct socket *so)
323 cpuid = rss_hash2cpuid(inp->inp_flowid, inp->inp_flowtype);
324 if (cpuid != NETISR_CPUID_NONE)
328 * Just use the flowid to shard connections in a repeatable
329 * fashion. Note that some crypto backends rely on the
330 * serialization provided by having the same connection use
333 cpuid = ktls_cpuid_lookup[inp->inp_flowid % ktls_number_threads];
339 ktls_init(void *dummy __unused)
346 ktls_tasks_active = counter_u64_alloc(M_WAITOK);
347 ktls_cnt_tx_queued = counter_u64_alloc(M_WAITOK);
348 ktls_cnt_rx_queued = counter_u64_alloc(M_WAITOK);
349 ktls_offload_total = counter_u64_alloc(M_WAITOK);
350 ktls_offload_enable_calls = counter_u64_alloc(M_WAITOK);
351 ktls_offload_active = counter_u64_alloc(M_WAITOK);
352 ktls_offload_corrupted_records = counter_u64_alloc(M_WAITOK);
353 ktls_offload_failed_crypto = counter_u64_alloc(M_WAITOK);
354 ktls_switch_to_ifnet = counter_u64_alloc(M_WAITOK);
355 ktls_switch_to_sw = counter_u64_alloc(M_WAITOK);
356 ktls_switch_failed = counter_u64_alloc(M_WAITOK);
357 ktls_sw_cbc = counter_u64_alloc(M_WAITOK);
358 ktls_sw_gcm = counter_u64_alloc(M_WAITOK);
359 ktls_ifnet_cbc = counter_u64_alloc(M_WAITOK);
360 ktls_ifnet_gcm = counter_u64_alloc(M_WAITOK);
361 ktls_ifnet_reset = counter_u64_alloc(M_WAITOK);
362 ktls_ifnet_reset_dropped = counter_u64_alloc(M_WAITOK);
363 ktls_ifnet_reset_failed = counter_u64_alloc(M_WAITOK);
365 ktls_toe_cbc = counter_u64_alloc(M_WAITOK);
366 ktls_toe_gcm = counter_u64_alloc(M_WAITOK);
369 rm_init(&ktls_backends_lock, "ktls backends");
370 LIST_INIT(&ktls_backends);
372 ktls_wq = malloc(sizeof(*ktls_wq) * (mp_maxid + 1), M_KTLS,
375 ktls_session_zone = uma_zcreate("ktls_session",
376 sizeof(struct ktls_session),
377 NULL, NULL, NULL, NULL,
381 * Initialize the workqueues to run the TLS work. We create a
382 * work queue for each CPU.
385 STAILQ_INIT(&ktls_wq[i].m_head);
386 STAILQ_INIT(&ktls_wq[i].so_head);
387 mtx_init(&ktls_wq[i].mtx, "ktls work queue", NULL, MTX_DEF);
388 error = kproc_kthread_add(ktls_work_thread, &ktls_wq[i],
389 &ktls_proc, &td, 0, 0, "KTLS", "thr_%d", i);
391 panic("Can't add KTLS thread %d error %d", i, error);
394 * Bind threads to cores. If ktls_bind_threads is >
395 * 1, then we bind to the NUMA domain.
397 if (ktls_bind_threads) {
398 if (ktls_bind_threads > 1) {
400 CPU_COPY(&cpuset_domain[pc->pc_domain], &mask);
404 error = cpuset_setthread(td->td_tid, &mask);
407 "Unable to bind KTLS thread for CPU %d error %d",
410 ktls_cpuid_lookup[ktls_number_threads] = i;
411 ktls_number_threads++;
413 printf("KTLS: Initialized %d threads\n", ktls_number_threads);
415 SYSINIT(ktls, SI_SUB_SMP + 1, SI_ORDER_ANY, ktls_init, NULL);
417 #if defined(INET) || defined(INET6)
419 ktls_create_session(struct socket *so, struct tls_enable *en,
420 struct ktls_session **tlsp)
422 struct ktls_session *tls;
425 /* Only TLS 1.0 - 1.3 are supported. */
426 if (en->tls_vmajor != TLS_MAJOR_VER_ONE)
428 if (en->tls_vminor < TLS_MINOR_VER_ZERO ||
429 en->tls_vminor > TLS_MINOR_VER_THREE)
432 if (en->auth_key_len < 0 || en->auth_key_len > TLS_MAX_PARAM_SIZE)
434 if (en->cipher_key_len < 0 || en->cipher_key_len > TLS_MAX_PARAM_SIZE)
436 if (en->iv_len < 0 || en->iv_len > sizeof(tls->params.iv))
439 /* All supported algorithms require a cipher key. */
440 if (en->cipher_key_len == 0)
443 /* No flags are currently supported. */
447 /* Common checks for supported algorithms. */
448 switch (en->cipher_algorithm) {
449 case CRYPTO_AES_NIST_GCM_16:
451 * auth_algorithm isn't used, but permit GMAC values
454 switch (en->auth_algorithm) {
456 #ifdef COMPAT_FREEBSD12
457 /* XXX: Really 13.0-current COMPAT. */
458 case CRYPTO_AES_128_NIST_GMAC:
459 case CRYPTO_AES_192_NIST_GMAC:
460 case CRYPTO_AES_256_NIST_GMAC:
466 if (en->auth_key_len != 0)
468 if ((en->tls_vminor == TLS_MINOR_VER_TWO &&
469 en->iv_len != TLS_AEAD_GCM_LEN) ||
470 (en->tls_vminor == TLS_MINOR_VER_THREE &&
471 en->iv_len != TLS_1_3_GCM_IV_LEN))
475 switch (en->auth_algorithm) {
476 case CRYPTO_SHA1_HMAC:
478 * TLS 1.0 requires an implicit IV. TLS 1.1+
479 * all use explicit IVs.
481 if (en->tls_vminor == TLS_MINOR_VER_ZERO) {
482 if (en->iv_len != TLS_CBC_IMPLICIT_IV_LEN)
488 case CRYPTO_SHA2_256_HMAC:
489 case CRYPTO_SHA2_384_HMAC:
490 /* Ignore any supplied IV. */
496 if (en->auth_key_len == 0)
503 tls = uma_zalloc(ktls_session_zone, M_WAITOK | M_ZERO);
505 counter_u64_add(ktls_offload_active, 1);
507 refcount_init(&tls->refcount, 1);
508 TASK_INIT(&tls->reset_tag_task, 0, ktls_reset_send_tag, tls);
510 tls->wq_index = ktls_get_cpu(so);
512 tls->params.cipher_algorithm = en->cipher_algorithm;
513 tls->params.auth_algorithm = en->auth_algorithm;
514 tls->params.tls_vmajor = en->tls_vmajor;
515 tls->params.tls_vminor = en->tls_vminor;
516 tls->params.flags = en->flags;
517 tls->params.max_frame_len = min(TLS_MAX_MSG_SIZE_V10_2, ktls_maxlen);
519 /* Set the header and trailer lengths. */
520 tls->params.tls_hlen = sizeof(struct tls_record_layer);
521 switch (en->cipher_algorithm) {
522 case CRYPTO_AES_NIST_GCM_16:
524 * TLS 1.2 uses a 4 byte implicit IV with an explicit 8 byte
525 * nonce. TLS 1.3 uses a 12 byte implicit IV.
527 if (en->tls_vminor < TLS_MINOR_VER_THREE)
528 tls->params.tls_hlen += sizeof(uint64_t);
529 tls->params.tls_tlen = AES_GMAC_HASH_LEN;
532 * TLS 1.3 includes optional padding which we
533 * do not support, and also puts the "real" record
534 * type at the end of the encrypted data.
536 if (en->tls_vminor == TLS_MINOR_VER_THREE)
537 tls->params.tls_tlen += sizeof(uint8_t);
539 tls->params.tls_bs = 1;
542 switch (en->auth_algorithm) {
543 case CRYPTO_SHA1_HMAC:
544 if (en->tls_vminor == TLS_MINOR_VER_ZERO) {
545 /* Implicit IV, no nonce. */
547 tls->params.tls_hlen += AES_BLOCK_LEN;
549 tls->params.tls_tlen = AES_BLOCK_LEN +
552 case CRYPTO_SHA2_256_HMAC:
553 tls->params.tls_hlen += AES_BLOCK_LEN;
554 tls->params.tls_tlen = AES_BLOCK_LEN +
557 case CRYPTO_SHA2_384_HMAC:
558 tls->params.tls_hlen += AES_BLOCK_LEN;
559 tls->params.tls_tlen = AES_BLOCK_LEN +
563 panic("invalid hmac");
565 tls->params.tls_bs = AES_BLOCK_LEN;
568 panic("invalid cipher");
571 KASSERT(tls->params.tls_hlen <= MBUF_PEXT_HDR_LEN,
572 ("TLS header length too long: %d", tls->params.tls_hlen));
573 KASSERT(tls->params.tls_tlen <= MBUF_PEXT_TRAIL_LEN,
574 ("TLS trailer length too long: %d", tls->params.tls_tlen));
576 if (en->auth_key_len != 0) {
577 tls->params.auth_key_len = en->auth_key_len;
578 tls->params.auth_key = malloc(en->auth_key_len, M_KTLS,
580 error = copyin(en->auth_key, tls->params.auth_key,
586 tls->params.cipher_key_len = en->cipher_key_len;
587 tls->params.cipher_key = malloc(en->cipher_key_len, M_KTLS, M_WAITOK);
588 error = copyin(en->cipher_key, tls->params.cipher_key,
594 * This holds the implicit portion of the nonce for GCM and
595 * the initial implicit IV for TLS 1.0. The explicit portions
596 * of the IV are generated in ktls_frame().
598 if (en->iv_len != 0) {
599 tls->params.iv_len = en->iv_len;
600 error = copyin(en->iv, tls->params.iv, en->iv_len);
605 * For TLS 1.2, generate an 8-byte nonce as a counter
606 * to generate unique explicit IVs.
608 * Store this counter in the last 8 bytes of the IV
609 * array so that it is 8-byte aligned.
611 if (en->cipher_algorithm == CRYPTO_AES_NIST_GCM_16 &&
612 en->tls_vminor == TLS_MINOR_VER_TWO)
613 arc4rand(tls->params.iv + 8, sizeof(uint64_t), 0);
624 static struct ktls_session *
625 ktls_clone_session(struct ktls_session *tls)
627 struct ktls_session *tls_new;
629 tls_new = uma_zalloc(ktls_session_zone, M_WAITOK | M_ZERO);
631 counter_u64_add(ktls_offload_active, 1);
633 refcount_init(&tls_new->refcount, 1);
635 /* Copy fields from existing session. */
636 tls_new->params = tls->params;
637 tls_new->wq_index = tls->wq_index;
639 /* Deep copy keys. */
640 if (tls_new->params.auth_key != NULL) {
641 tls_new->params.auth_key = malloc(tls->params.auth_key_len,
643 memcpy(tls_new->params.auth_key, tls->params.auth_key,
644 tls->params.auth_key_len);
647 tls_new->params.cipher_key = malloc(tls->params.cipher_key_len, M_KTLS,
649 memcpy(tls_new->params.cipher_key, tls->params.cipher_key,
650 tls->params.cipher_key_len);
657 ktls_cleanup(struct ktls_session *tls)
660 counter_u64_add(ktls_offload_active, -1);
662 case TCP_TLS_MODE_SW:
663 MPASS(tls->be != NULL);
664 switch (tls->params.cipher_algorithm) {
666 counter_u64_add(ktls_sw_cbc, -1);
668 case CRYPTO_AES_NIST_GCM_16:
669 counter_u64_add(ktls_sw_gcm, -1);
674 case TCP_TLS_MODE_IFNET:
675 switch (tls->params.cipher_algorithm) {
677 counter_u64_add(ktls_ifnet_cbc, -1);
679 case CRYPTO_AES_NIST_GCM_16:
680 counter_u64_add(ktls_ifnet_gcm, -1);
683 if (tls->snd_tag != NULL)
684 m_snd_tag_rele(tls->snd_tag);
687 case TCP_TLS_MODE_TOE:
688 switch (tls->params.cipher_algorithm) {
690 counter_u64_add(ktls_toe_cbc, -1);
692 case CRYPTO_AES_NIST_GCM_16:
693 counter_u64_add(ktls_toe_gcm, -1);
699 if (tls->params.auth_key != NULL) {
700 zfree(tls->params.auth_key, M_KTLS);
701 tls->params.auth_key = NULL;
702 tls->params.auth_key_len = 0;
704 if (tls->params.cipher_key != NULL) {
705 zfree(tls->params.cipher_key, M_KTLS);
706 tls->params.cipher_key = NULL;
707 tls->params.cipher_key_len = 0;
709 explicit_bzero(tls->params.iv, sizeof(tls->params.iv));
712 #if defined(INET) || defined(INET6)
716 ktls_try_toe(struct socket *so, struct ktls_session *tls, int direction)
724 if (inp->inp_flags2 & INP_FREED) {
728 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
732 if (inp->inp_socket == NULL) {
737 if (!(tp->t_flags & TF_TOE)) {
742 error = tcp_offload_alloc_tls_session(tp, tls, direction);
745 tls->mode = TCP_TLS_MODE_TOE;
746 switch (tls->params.cipher_algorithm) {
748 counter_u64_add(ktls_toe_cbc, 1);
750 case CRYPTO_AES_NIST_GCM_16:
751 counter_u64_add(ktls_toe_gcm, 1);
760 * Common code used when first enabling ifnet TLS on a connection or
761 * when allocating a new ifnet TLS session due to a routing change.
762 * This function allocates a new TLS send tag on whatever interface
763 * the connection is currently routed over.
766 ktls_alloc_snd_tag(struct inpcb *inp, struct ktls_session *tls, bool force,
767 struct m_snd_tag **mstp)
769 union if_snd_tag_alloc_params params;
771 struct nhop_object *nh;
776 if (inp->inp_flags2 & INP_FREED) {
780 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
784 if (inp->inp_socket == NULL) {
791 * Check administrative controls on ifnet TLS to determine if
792 * ifnet TLS should be denied.
794 * - Always permit 'force' requests.
795 * - ktls_ifnet_permitted == 0: always deny.
797 if (!force && ktls_ifnet_permitted == 0) {
803 * XXX: Use the cached route in the inpcb to find the
804 * interface. This should perhaps instead use
805 * rtalloc1_fib(dst, 0, 0, fibnum). Since KTLS is only
806 * enabled after a connection has completed key negotiation in
807 * userland, the cached route will be present in practice.
809 nh = inp->inp_route.ro_nh;
818 * Allocate a TLS + ratelimit tag if the connection has an
819 * existing pacing rate.
821 if (tp->t_pacing_rate != -1 &&
822 (ifp->if_capenable & IFCAP_TXTLS_RTLMT) != 0) {
823 params.hdr.type = IF_SND_TAG_TYPE_TLS_RATE_LIMIT;
824 params.tls_rate_limit.inp = inp;
825 params.tls_rate_limit.tls = tls;
826 params.tls_rate_limit.max_rate = tp->t_pacing_rate;
828 params.hdr.type = IF_SND_TAG_TYPE_TLS;
829 params.tls.inp = inp;
830 params.tls.tls = tls;
832 params.hdr.flowid = inp->inp_flowid;
833 params.hdr.flowtype = inp->inp_flowtype;
834 params.hdr.numa_domain = inp->inp_numa_domain;
837 if ((ifp->if_capenable & IFCAP_NOMAP) == 0) {
841 if (inp->inp_vflag & INP_IPV6) {
842 if ((ifp->if_capenable & IFCAP_TXTLS6) == 0) {
847 if ((ifp->if_capenable & IFCAP_TXTLS4) == 0) {
852 error = m_snd_tag_alloc(ifp, ¶ms, mstp);
859 ktls_try_ifnet(struct socket *so, struct ktls_session *tls, bool force)
861 struct m_snd_tag *mst;
864 error = ktls_alloc_snd_tag(so->so_pcb, tls, force, &mst);
866 tls->mode = TCP_TLS_MODE_IFNET;
868 switch (tls->params.cipher_algorithm) {
870 counter_u64_add(ktls_ifnet_cbc, 1);
872 case CRYPTO_AES_NIST_GCM_16:
873 counter_u64_add(ktls_ifnet_gcm, 1);
881 ktls_try_sw(struct socket *so, struct ktls_session *tls, int direction)
883 struct rm_priotracker prio;
884 struct ktls_crypto_backend *be;
887 * Choose the best software crypto backend. Backends are
888 * stored in sorted priority order (larget value == most
889 * important at the head of the list), so this just stops on
890 * the first backend that claims the session by returning
893 if (ktls_allow_unload)
894 rm_rlock(&ktls_backends_lock, &prio);
895 LIST_FOREACH(be, &ktls_backends, next) {
896 if (be->try(so, tls, direction) == 0)
898 KASSERT(tls->cipher == NULL,
899 ("ktls backend leaked a cipher pointer"));
902 if (ktls_allow_unload)
906 if (ktls_allow_unload)
907 rm_runlock(&ktls_backends_lock, &prio);
910 tls->mode = TCP_TLS_MODE_SW;
911 switch (tls->params.cipher_algorithm) {
913 counter_u64_add(ktls_sw_cbc, 1);
915 case CRYPTO_AES_NIST_GCM_16:
916 counter_u64_add(ktls_sw_gcm, 1);
923 * KTLS RX stores data in the socket buffer as a list of TLS records,
924 * where each record is stored as a control message containg the TLS
925 * header followed by data mbufs containing the decrypted data. This
926 * is different from KTLS TX which always uses an mb_ext_pgs mbuf for
927 * both encrypted and decrypted data. TLS records decrypted by a NIC
928 * should be queued to the socket buffer as records, but encrypted
929 * data which needs to be decrypted by software arrives as a stream of
930 * regular mbufs which need to be converted. In addition, there may
931 * already be pending encrypted data in the socket buffer when KTLS RX
934 * To manage not-yet-decrypted data for KTLS RX, the following scheme
937 * - A single chain of NOTREADY mbufs is hung off of sb_mtls.
939 * - ktls_check_rx checks this chain of mbufs reading the TLS header
940 * from the first mbuf. Once all of the data for that TLS record is
941 * queued, the socket is queued to a worker thread.
943 * - The worker thread calls ktls_decrypt to decrypt TLS records in
944 * the TLS chain. Each TLS record is detached from the TLS chain,
945 * decrypted, and inserted into the regular socket buffer chain as
946 * record starting with a control message holding the TLS header and
947 * a chain of mbufs holding the encrypted data.
951 sb_mark_notready(struct sockbuf *sb)
958 sb->sb_mbtail = NULL;
959 sb->sb_lastrecord = NULL;
960 for (; m != NULL; m = m->m_next) {
961 KASSERT(m->m_nextpkt == NULL, ("%s: m_nextpkt != NULL",
963 KASSERT((m->m_flags & M_NOTAVAIL) == 0, ("%s: mbuf not avail",
965 KASSERT(sb->sb_acc >= m->m_len, ("%s: sb_acc < m->m_len",
967 m->m_flags |= M_NOTREADY;
968 sb->sb_acc -= m->m_len;
969 sb->sb_tlscc += m->m_len;
972 KASSERT(sb->sb_acc == 0 && sb->sb_tlscc == sb->sb_ccc,
973 ("%s: acc %u tlscc %u ccc %u", __func__, sb->sb_acc, sb->sb_tlscc,
978 ktls_enable_rx(struct socket *so, struct tls_enable *en)
980 struct ktls_session *tls;
983 if (!ktls_offload_enable)
986 counter_u64_add(ktls_offload_enable_calls, 1);
989 * This should always be true since only the TCP socket option
990 * invokes this function.
992 if (so->so_proto->pr_protocol != IPPROTO_TCP)
996 * XXX: Don't overwrite existing sessions. We should permit
997 * this to support rekeying in the future.
999 if (so->so_rcv.sb_tls_info != NULL)
1002 if (en->cipher_algorithm == CRYPTO_AES_CBC && !ktls_cbc_enable)
1005 /* TLS 1.3 is not yet supported. */
1006 if (en->tls_vmajor == TLS_MAJOR_VER_ONE &&
1007 en->tls_vminor == TLS_MINOR_VER_THREE)
1010 error = ktls_create_session(so, en, &tls);
1015 error = ktls_try_toe(so, tls, KTLS_RX);
1018 error = ktls_try_sw(so, tls, KTLS_RX);
1025 /* Mark the socket as using TLS offload. */
1026 SOCKBUF_LOCK(&so->so_rcv);
1027 so->so_rcv.sb_tls_seqno = be64dec(en->rec_seq);
1028 so->so_rcv.sb_tls_info = tls;
1029 so->so_rcv.sb_flags |= SB_TLS_RX;
1031 /* Mark existing data as not ready until it can be decrypted. */
1032 sb_mark_notready(&so->so_rcv);
1033 ktls_check_rx(&so->so_rcv);
1034 SOCKBUF_UNLOCK(&so->so_rcv);
1036 counter_u64_add(ktls_offload_total, 1);
1042 ktls_enable_tx(struct socket *so, struct tls_enable *en)
1044 struct ktls_session *tls;
1048 if (!ktls_offload_enable)
1051 counter_u64_add(ktls_offload_enable_calls, 1);
1054 * This should always be true since only the TCP socket option
1055 * invokes this function.
1057 if (so->so_proto->pr_protocol != IPPROTO_TCP)
1061 * XXX: Don't overwrite existing sessions. We should permit
1062 * this to support rekeying in the future.
1064 if (so->so_snd.sb_tls_info != NULL)
1067 if (en->cipher_algorithm == CRYPTO_AES_CBC && !ktls_cbc_enable)
1070 /* TLS requires ext pgs */
1071 if (mb_use_ext_pgs == 0)
1074 error = ktls_create_session(so, en, &tls);
1078 /* Prefer TOE -> ifnet TLS -> software TLS. */
1080 error = ktls_try_toe(so, tls, KTLS_TX);
1083 error = ktls_try_ifnet(so, tls, false);
1085 error = ktls_try_sw(so, tls, KTLS_TX);
1092 error = sblock(&so->so_snd, SBL_WAIT);
1099 * Write lock the INP when setting sb_tls_info so that
1100 * routines in tcp_ratelimit.c can read sb_tls_info while
1101 * holding the INP lock.
1105 SOCKBUF_LOCK(&so->so_snd);
1106 so->so_snd.sb_tls_seqno = be64dec(en->rec_seq);
1107 so->so_snd.sb_tls_info = tls;
1108 if (tls->mode != TCP_TLS_MODE_SW)
1109 so->so_snd.sb_flags |= SB_TLS_IFNET;
1110 SOCKBUF_UNLOCK(&so->so_snd);
1112 sbunlock(&so->so_snd);
1114 counter_u64_add(ktls_offload_total, 1);
1120 ktls_get_rx_mode(struct socket *so)
1122 struct ktls_session *tls;
1127 INP_WLOCK_ASSERT(inp);
1128 SOCKBUF_LOCK(&so->so_rcv);
1129 tls = so->so_rcv.sb_tls_info;
1131 mode = TCP_TLS_MODE_NONE;
1134 SOCKBUF_UNLOCK(&so->so_rcv);
1139 ktls_get_tx_mode(struct socket *so)
1141 struct ktls_session *tls;
1146 INP_WLOCK_ASSERT(inp);
1147 SOCKBUF_LOCK(&so->so_snd);
1148 tls = so->so_snd.sb_tls_info;
1150 mode = TCP_TLS_MODE_NONE;
1153 SOCKBUF_UNLOCK(&so->so_snd);
1158 * Switch between SW and ifnet TLS sessions as requested.
1161 ktls_set_tx_mode(struct socket *so, int mode)
1163 struct ktls_session *tls, *tls_new;
1168 case TCP_TLS_MODE_SW:
1169 case TCP_TLS_MODE_IFNET:
1176 INP_WLOCK_ASSERT(inp);
1177 SOCKBUF_LOCK(&so->so_snd);
1178 tls = so->so_snd.sb_tls_info;
1180 SOCKBUF_UNLOCK(&so->so_snd);
1184 if (tls->mode == mode) {
1185 SOCKBUF_UNLOCK(&so->so_snd);
1189 tls = ktls_hold(tls);
1190 SOCKBUF_UNLOCK(&so->so_snd);
1193 tls_new = ktls_clone_session(tls);
1195 if (mode == TCP_TLS_MODE_IFNET)
1196 error = ktls_try_ifnet(so, tls_new, true);
1198 error = ktls_try_sw(so, tls_new, KTLS_TX);
1200 counter_u64_add(ktls_switch_failed, 1);
1207 error = sblock(&so->so_snd, SBL_WAIT);
1209 counter_u64_add(ktls_switch_failed, 1);
1217 * If we raced with another session change, keep the existing
1220 if (tls != so->so_snd.sb_tls_info) {
1221 counter_u64_add(ktls_switch_failed, 1);
1222 sbunlock(&so->so_snd);
1229 SOCKBUF_LOCK(&so->so_snd);
1230 so->so_snd.sb_tls_info = tls_new;
1231 if (tls_new->mode != TCP_TLS_MODE_SW)
1232 so->so_snd.sb_flags |= SB_TLS_IFNET;
1233 SOCKBUF_UNLOCK(&so->so_snd);
1234 sbunlock(&so->so_snd);
1237 * Drop two references on 'tls'. The first is for the
1238 * ktls_hold() above. The second drops the reference from the
1241 KASSERT(tls->refcount >= 2, ("too few references on old session"));
1245 if (mode == TCP_TLS_MODE_IFNET)
1246 counter_u64_add(ktls_switch_to_ifnet, 1);
1248 counter_u64_add(ktls_switch_to_sw, 1);
1255 * Try to allocate a new TLS send tag. This task is scheduled when
1256 * ip_output detects a route change while trying to transmit a packet
1257 * holding a TLS record. If a new tag is allocated, replace the tag
1258 * in the TLS session. Subsequent packets on the connection will use
1259 * the new tag. If a new tag cannot be allocated, drop the
1263 ktls_reset_send_tag(void *context, int pending)
1265 struct epoch_tracker et;
1266 struct ktls_session *tls;
1267 struct m_snd_tag *old, *new;
1272 MPASS(pending == 1);
1278 * Free the old tag first before allocating a new one.
1279 * ip[6]_output_send() will treat a NULL send tag the same as
1280 * an ifp mismatch and drop packets until a new tag is
1283 * Write-lock the INP when changing tls->snd_tag since
1284 * ip[6]_output_send() holds a read-lock when reading the
1289 tls->snd_tag = NULL;
1292 m_snd_tag_rele(old);
1294 error = ktls_alloc_snd_tag(inp, tls, true, &new);
1299 mtx_pool_lock(mtxpool_sleep, tls);
1300 tls->reset_pending = false;
1301 mtx_pool_unlock(mtxpool_sleep, tls);
1302 if (!in_pcbrele_wlocked(inp))
1305 counter_u64_add(ktls_ifnet_reset, 1);
1308 * XXX: Should we kick tcp_output explicitly now that
1309 * the send tag is fixed or just rely on timers?
1312 NET_EPOCH_ENTER(et);
1314 if (!in_pcbrele_wlocked(inp)) {
1315 if (!(inp->inp_flags & INP_TIMEWAIT) &&
1316 !(inp->inp_flags & INP_DROPPED)) {
1317 tp = intotcpcb(inp);
1318 CURVNET_SET(tp->t_vnet);
1319 tp = tcp_drop(tp, ECONNABORTED);
1323 counter_u64_add(ktls_ifnet_reset_dropped, 1);
1329 counter_u64_add(ktls_ifnet_reset_failed, 1);
1332 * Leave reset_pending true to avoid future tasks while
1333 * the socket goes away.
1341 ktls_output_eagain(struct inpcb *inp, struct ktls_session *tls)
1347 INP_LOCK_ASSERT(inp);
1350 * See if we should schedule a task to update the send tag for
1353 mtx_pool_lock(mtxpool_sleep, tls);
1354 if (!tls->reset_pending) {
1355 (void) ktls_hold(tls);
1358 tls->reset_pending = true;
1359 taskqueue_enqueue(taskqueue_thread, &tls->reset_tag_task);
1361 mtx_pool_unlock(mtxpool_sleep, tls);
1367 ktls_modify_txrtlmt(struct ktls_session *tls, uint64_t max_pacing_rate)
1369 union if_snd_tag_modify_params params = {
1370 .rate_limit.max_rate = max_pacing_rate,
1371 .rate_limit.flags = M_NOWAIT,
1373 struct m_snd_tag *mst;
1377 /* Can't get to the inp, but it should be locked. */
1378 /* INP_LOCK_ASSERT(inp); */
1380 MPASS(tls->mode == TCP_TLS_MODE_IFNET);
1382 if (tls->snd_tag == NULL) {
1384 * Resetting send tag, ignore this change. The
1385 * pending reset may or may not see this updated rate
1386 * in the tcpcb. If it doesn't, we will just lose
1392 MPASS(tls->snd_tag != NULL);
1393 MPASS(tls->snd_tag->type == IF_SND_TAG_TYPE_TLS_RATE_LIMIT);
1397 return (ifp->if_snd_tag_modify(mst, ¶ms));
1403 ktls_destroy(struct ktls_session *tls)
1405 struct rm_priotracker prio;
1408 if (tls->be != NULL && ktls_allow_unload) {
1409 rm_rlock(&ktls_backends_lock, &prio);
1410 tls->be->use_count--;
1411 rm_runlock(&ktls_backends_lock, &prio);
1413 uma_zfree(ktls_session_zone, tls);
1417 ktls_seq(struct sockbuf *sb, struct mbuf *m)
1420 for (; m != NULL; m = m->m_next) {
1421 KASSERT((m->m_flags & M_EXTPG) != 0,
1422 ("ktls_seq: mapped mbuf %p", m));
1424 m->m_epg_seqno = sb->sb_tls_seqno;
1430 * Add TLS framing (headers and trailers) to a chain of mbufs. Each
1431 * mbuf in the chain must be an unmapped mbuf. The payload of the
1432 * mbuf must be populated with the payload of each TLS record.
1434 * The record_type argument specifies the TLS record type used when
1435 * populating the TLS header.
1437 * The enq_count argument on return is set to the number of pages of
1438 * payload data for this entire chain that need to be encrypted via SW
1439 * encryption. The returned value should be passed to ktls_enqueue
1440 * when scheduling encryption of this chain of mbufs. To handle the
1441 * special case of empty fragments for TLS 1.0 sessions, an empty
1442 * fragment counts as one page.
1445 ktls_frame(struct mbuf *top, struct ktls_session *tls, int *enq_cnt,
1446 uint8_t record_type)
1448 struct tls_record_layer *tlshdr;
1454 maxlen = tls->params.max_frame_len;
1456 for (m = top; m != NULL; m = m->m_next) {
1458 * All mbufs in the chain should be TLS records whose
1459 * payload does not exceed the maximum frame length.
1461 * Empty TLS records are permitted when using CBC.
1463 KASSERT(m->m_len <= maxlen &&
1464 (tls->params.cipher_algorithm == CRYPTO_AES_CBC ?
1465 m->m_len >= 0 : m->m_len > 0),
1466 ("ktls_frame: m %p len %d\n", m, m->m_len));
1469 * TLS frames require unmapped mbufs to store session
1472 KASSERT((m->m_flags & M_EXTPG) != 0,
1473 ("ktls_frame: mapped mbuf %p (top = %p)\n", m, top));
1477 /* Save a reference to the session. */
1478 m->m_epg_tls = ktls_hold(tls);
1480 m->m_epg_hdrlen = tls->params.tls_hlen;
1481 m->m_epg_trllen = tls->params.tls_tlen;
1482 if (tls->params.cipher_algorithm == CRYPTO_AES_CBC) {
1486 * AES-CBC pads messages to a multiple of the
1487 * block size. Note that the padding is
1488 * applied after the digest and the encryption
1489 * is done on the "plaintext || mac || padding".
1490 * At least one byte of padding is always
1493 * Compute the final trailer length assuming
1494 * at most one block of padding.
1495 * tls->params.sb_tls_tlen is the maximum
1496 * possible trailer length (padding + digest).
1497 * delta holds the number of excess padding
1498 * bytes if the maximum were used. Those
1499 * extra bytes are removed.
1501 bs = tls->params.tls_bs;
1502 delta = (tls_len + tls->params.tls_tlen) & (bs - 1);
1503 m->m_epg_trllen -= delta;
1505 m->m_len += m->m_epg_hdrlen + m->m_epg_trllen;
1507 /* Populate the TLS header. */
1508 tlshdr = (void *)m->m_epg_hdr;
1509 tlshdr->tls_vmajor = tls->params.tls_vmajor;
1512 * TLS 1.3 masquarades as TLS 1.2 with a record type
1513 * of TLS_RLTYPE_APP.
1515 if (tls->params.tls_vminor == TLS_MINOR_VER_THREE &&
1516 tls->params.tls_vmajor == TLS_MAJOR_VER_ONE) {
1517 tlshdr->tls_vminor = TLS_MINOR_VER_TWO;
1518 tlshdr->tls_type = TLS_RLTYPE_APP;
1519 /* save the real record type for later */
1520 m->m_epg_record_type = record_type;
1521 m->m_epg_trail[0] = record_type;
1523 tlshdr->tls_vminor = tls->params.tls_vminor;
1524 tlshdr->tls_type = record_type;
1526 tlshdr->tls_length = htons(m->m_len - sizeof(*tlshdr));
1529 * Store nonces / explicit IVs after the end of the
1532 * For GCM with TLS 1.2, an 8 byte nonce is copied
1533 * from the end of the IV. The nonce is then
1534 * incremented for use by the next record.
1536 * For CBC, a random nonce is inserted for TLS 1.1+.
1538 if (tls->params.cipher_algorithm == CRYPTO_AES_NIST_GCM_16 &&
1539 tls->params.tls_vminor == TLS_MINOR_VER_TWO) {
1540 noncep = (uint64_t *)(tls->params.iv + 8);
1541 be64enc(tlshdr + 1, *noncep);
1543 } else if (tls->params.cipher_algorithm == CRYPTO_AES_CBC &&
1544 tls->params.tls_vminor >= TLS_MINOR_VER_ONE)
1545 arc4rand(tlshdr + 1, AES_BLOCK_LEN, 0);
1548 * When using SW encryption, mark the mbuf not ready.
1549 * It will be marked ready via sbready() after the
1550 * record has been encrypted.
1552 * When using ifnet TLS, unencrypted TLS records are
1553 * sent down the stack to the NIC.
1555 if (tls->mode == TCP_TLS_MODE_SW) {
1556 m->m_flags |= M_NOTREADY;
1557 m->m_epg_nrdy = m->m_epg_npgs;
1558 if (__predict_false(tls_len == 0)) {
1559 /* TLS 1.0 empty fragment. */
1562 *enq_cnt += m->m_epg_npgs;
1568 ktls_check_rx(struct sockbuf *sb)
1570 struct tls_record_layer hdr;
1575 SOCKBUF_LOCK_ASSERT(sb);
1576 KASSERT(sb->sb_flags & SB_TLS_RX, ("%s: sockbuf %p isn't TLS RX",
1578 so = __containerof(sb, struct socket, so_rcv);
1580 if (sb->sb_flags & SB_TLS_RX_RUNNING)
1583 /* Is there enough queued for a TLS header? */
1584 if (sb->sb_tlscc < sizeof(hdr)) {
1585 if ((sb->sb_state & SBS_CANTRCVMORE) != 0 && sb->sb_tlscc != 0)
1586 so->so_error = EMSGSIZE;
1590 m_copydata(sb->sb_mtls, 0, sizeof(hdr), (void *)&hdr);
1592 /* Is the entire record queued? */
1593 if (sb->sb_tlscc < sizeof(hdr) + ntohs(hdr.tls_length)) {
1594 if ((sb->sb_state & SBS_CANTRCVMORE) != 0)
1595 so->so_error = EMSGSIZE;
1599 sb->sb_flags |= SB_TLS_RX_RUNNING;
1602 wq = &ktls_wq[so->so_rcv.sb_tls_info->wq_index];
1604 STAILQ_INSERT_TAIL(&wq->so_head, so, so_ktls_rx_list);
1605 running = wq->running;
1606 mtx_unlock(&wq->mtx);
1609 counter_u64_add(ktls_cnt_rx_queued, 1);
1612 static struct mbuf *
1613 ktls_detach_record(struct sockbuf *sb, int len)
1615 struct mbuf *m, *n, *top;
1618 SOCKBUF_LOCK_ASSERT(sb);
1619 MPASS(len <= sb->sb_tlscc);
1622 * If TLS chain is the exact size of the record,
1623 * just grab the whole record.
1626 if (sb->sb_tlscc == len) {
1628 sb->sb_mtlstail = NULL;
1633 * While it would be nice to use m_split() here, we need
1634 * to know exactly what m_split() allocates to update the
1635 * accounting, so do it inline instead.
1638 for (m = top; remain > m->m_len; m = m->m_next)
1641 /* Easy case: don't have to split 'm'. */
1642 if (remain == m->m_len) {
1643 sb->sb_mtls = m->m_next;
1644 if (sb->sb_mtls == NULL)
1645 sb->sb_mtlstail = NULL;
1651 * Need to allocate an mbuf to hold the remainder of 'm'. Try
1652 * with M_NOWAIT first.
1654 n = m_get(M_NOWAIT, MT_DATA);
1657 * Use M_WAITOK with socket buffer unlocked. If
1658 * 'sb_mtls' changes while the lock is dropped, return
1659 * NULL to force the caller to retry.
1663 n = m_get(M_WAITOK, MT_DATA);
1666 if (sb->sb_mtls != top) {
1671 n->m_flags |= M_NOTREADY;
1673 /* Store remainder in 'n'. */
1674 n->m_len = m->m_len - remain;
1675 if (m->m_flags & M_EXT) {
1676 n->m_data = m->m_data + remain;
1679 bcopy(mtod(m, caddr_t) + remain, mtod(n, caddr_t), n->m_len);
1682 /* Trim 'm' and update accounting. */
1683 m->m_len -= n->m_len;
1684 sb->sb_tlscc -= n->m_len;
1685 sb->sb_ccc -= n->m_len;
1687 /* Account for 'n'. */
1688 sballoc_ktls_rx(sb, n);
1690 /* Insert 'n' into the TLS chain. */
1692 n->m_next = m->m_next;
1693 if (sb->sb_mtlstail == m)
1694 sb->sb_mtlstail = n;
1696 /* Detach the record from the TLS chain. */
1700 MPASS(m_length(top, NULL) == len);
1701 for (m = top; m != NULL; m = m->m_next)
1702 sbfree_ktls_rx(sb, m);
1703 sb->sb_tlsdcc = len;
1710 ktls_decrypt(struct socket *so)
1712 char tls_header[MBUF_PEXT_HDR_LEN];
1713 struct ktls_session *tls;
1715 struct tls_record_layer *hdr;
1716 struct tls_get_record tgr;
1717 struct mbuf *control, *data, *m;
1719 int error, remain, tls_len, trail_len;
1721 hdr = (struct tls_record_layer *)tls_header;
1724 KASSERT(sb->sb_flags & SB_TLS_RX_RUNNING,
1725 ("%s: socket %p not running", __func__, so));
1727 tls = sb->sb_tls_info;
1731 /* Is there enough queued for a TLS header? */
1732 if (sb->sb_tlscc < tls->params.tls_hlen)
1735 m_copydata(sb->sb_mtls, 0, tls->params.tls_hlen, tls_header);
1736 tls_len = sizeof(*hdr) + ntohs(hdr->tls_length);
1738 if (hdr->tls_vmajor != tls->params.tls_vmajor ||
1739 hdr->tls_vminor != tls->params.tls_vminor)
1741 else if (tls_len < tls->params.tls_hlen || tls_len >
1742 tls->params.tls_hlen + TLS_MAX_MSG_SIZE_V10_2 +
1743 tls->params.tls_tlen)
1747 if (__predict_false(error != 0)) {
1749 * We have a corrupted record and are likely
1750 * out of sync. The connection isn't
1751 * recoverable at this point, so abort it.
1754 counter_u64_add(ktls_offload_corrupted_records, 1);
1756 CURVNET_SET(so->so_vnet);
1757 so->so_proto->pr_usrreqs->pru_abort(so);
1758 so->so_error = error;
1763 /* Is the entire record queued? */
1764 if (sb->sb_tlscc < tls_len)
1768 * Split out the portion of the mbuf chain containing
1771 data = ktls_detach_record(sb, tls_len);
1774 MPASS(sb->sb_tlsdcc == tls_len);
1776 seqno = sb->sb_tls_seqno;
1781 error = tls->sw_decrypt(tls, hdr, data, seqno, &trail_len);
1783 counter_u64_add(ktls_offload_failed_crypto, 1);
1786 if (sb->sb_tlsdcc == 0) {
1788 * sbcut/drop/flush discarded these
1796 * Drop this TLS record's data, but keep
1797 * decrypting subsequent records.
1799 sb->sb_ccc -= tls_len;
1802 CURVNET_SET(so->so_vnet);
1803 so->so_error = EBADMSG;
1804 sorwakeup_locked(so);
1813 /* Allocate the control mbuf. */
1814 tgr.tls_type = hdr->tls_type;
1815 tgr.tls_vmajor = hdr->tls_vmajor;
1816 tgr.tls_vminor = hdr->tls_vminor;
1817 tgr.tls_length = htobe16(tls_len - tls->params.tls_hlen -
1819 control = sbcreatecontrol_how(&tgr, sizeof(tgr),
1820 TLS_GET_RECORD, IPPROTO_TCP, M_WAITOK);
1823 if (sb->sb_tlsdcc == 0) {
1824 /* sbcut/drop/flush discarded these mbufs. */
1825 MPASS(sb->sb_tlscc == 0);
1832 * Clear the 'dcc' accounting in preparation for
1833 * adding the decrypted record.
1835 sb->sb_ccc -= tls_len;
1839 /* If there is no payload, drop all of the data. */
1840 if (tgr.tls_length == htobe16(0)) {
1845 remain = tls->params.tls_hlen;
1846 while (remain > 0) {
1847 if (data->m_len > remain) {
1848 data->m_data += remain;
1849 data->m_len -= remain;
1852 remain -= data->m_len;
1853 data = m_free(data);
1856 /* Trim trailer and clear M_NOTREADY. */
1857 remain = be16toh(tgr.tls_length);
1859 for (m = data; remain > m->m_len; m = m->m_next) {
1860 m->m_flags &= ~M_NOTREADY;
1866 m->m_flags &= ~M_NOTREADY;
1868 /* Set EOR on the final mbuf. */
1869 m->m_flags |= M_EOR;
1872 sbappendcontrol_locked(sb, data, control, 0);
1875 sb->sb_flags &= ~SB_TLS_RX_RUNNING;
1877 if ((sb->sb_state & SBS_CANTRCVMORE) != 0 && sb->sb_tlscc > 0)
1878 so->so_error = EMSGSIZE;
1880 sorwakeup_locked(so);
1883 SOCKBUF_UNLOCK_ASSERT(sb);
1885 CURVNET_SET(so->so_vnet);
1892 ktls_enqueue_to_free(struct mbuf *m)
1897 /* Mark it for freeing. */
1898 m->m_epg_flags |= EPG_FLAG_2FREE;
1899 wq = &ktls_wq[m->m_epg_tls->wq_index];
1901 STAILQ_INSERT_TAIL(&wq->m_head, m, m_epg_stailq);
1902 running = wq->running;
1903 mtx_unlock(&wq->mtx);
1909 ktls_enqueue(struct mbuf *m, struct socket *so, int page_count)
1914 KASSERT(((m->m_flags & (M_EXTPG | M_NOTREADY)) ==
1915 (M_EXTPG | M_NOTREADY)),
1916 ("ktls_enqueue: %p not unready & nomap mbuf\n", m));
1917 KASSERT(page_count != 0, ("enqueueing TLS mbuf with zero page count"));
1919 KASSERT(m->m_epg_tls->mode == TCP_TLS_MODE_SW, ("!SW TLS mbuf"));
1921 m->m_epg_enc_cnt = page_count;
1924 * Save a pointer to the socket. The caller is responsible
1925 * for taking an additional reference via soref().
1929 wq = &ktls_wq[m->m_epg_tls->wq_index];
1931 STAILQ_INSERT_TAIL(&wq->m_head, m, m_epg_stailq);
1932 running = wq->running;
1933 mtx_unlock(&wq->mtx);
1936 counter_u64_add(ktls_cnt_tx_queued, 1);
1939 static __noinline void
1940 ktls_encrypt(struct mbuf *top)
1942 struct ktls_session *tls;
1945 vm_paddr_t parray[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1946 struct iovec src_iov[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1947 struct iovec dst_iov[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1949 int error, i, len, npages, off, total_pages;
1953 tls = top->m_epg_tls;
1954 KASSERT(tls != NULL, ("tls = NULL, top = %p\n", top));
1955 KASSERT(so != NULL, ("so = NULL, top = %p\n", top));
1957 top->m_epg_so = NULL;
1959 total_pages = top->m_epg_enc_cnt;
1963 * Encrypt the TLS records in the chain of mbufs starting with
1964 * 'top'. 'total_pages' gives us a total count of pages and is
1965 * used to know when we have finished encrypting the TLS
1966 * records originally queued with 'top'.
1968 * NB: These mbufs are queued in the socket buffer and
1969 * 'm_next' is traversing the mbufs in the socket buffer. The
1970 * socket buffer lock is not held while traversing this chain.
1971 * Since the mbufs are all marked M_NOTREADY their 'm_next'
1972 * pointers should be stable. However, the 'm_next' of the
1973 * last mbuf encrypted is not necessarily NULL. It can point
1974 * to other mbufs appended while 'top' was on the TLS work
1977 * Each mbuf holds an entire TLS record.
1980 for (m = top; npages != total_pages; m = m->m_next) {
1981 KASSERT(m->m_epg_tls == tls,
1982 ("different TLS sessions in a single mbuf chain: %p vs %p",
1983 tls, m->m_epg_tls));
1984 KASSERT((m->m_flags & (M_EXTPG | M_NOTREADY)) ==
1985 (M_EXTPG | M_NOTREADY),
1986 ("%p not unready & nomap mbuf (top = %p)\n", m, top));
1987 KASSERT(npages + m->m_epg_npgs <= total_pages,
1988 ("page count mismatch: top %p, total_pages %d, m %p", top,
1992 * Generate source and destination ivoecs to pass to
1993 * the SW encryption backend. For writable mbufs, the
1994 * destination iovec is a copy of the source and
1995 * encryption is done in place. For file-backed mbufs
1996 * (from sendfile), anonymous wired pages are
1997 * allocated and assigned to the destination iovec.
1999 is_anon = (m->m_epg_flags & EPG_FLAG_ANON) != 0;
2001 off = m->m_epg_1st_off;
2002 for (i = 0; i < m->m_epg_npgs; i++, off = 0) {
2003 len = m_epg_pagelen(m, i, off);
2004 src_iov[i].iov_len = len;
2005 src_iov[i].iov_base =
2006 (char *)(void *)PHYS_TO_DMAP(m->m_epg_pa[i]) +
2010 dst_iov[i].iov_base = src_iov[i].iov_base;
2011 dst_iov[i].iov_len = src_iov[i].iov_len;
2015 pg = vm_page_alloc(NULL, 0, VM_ALLOC_NORMAL |
2016 VM_ALLOC_NOOBJ | VM_ALLOC_NODUMP | VM_ALLOC_WIRED);
2021 parray[i] = VM_PAGE_TO_PHYS(pg);
2022 dst_iov[i].iov_base =
2023 (char *)(void *)PHYS_TO_DMAP(parray[i]) + off;
2024 dst_iov[i].iov_len = len;
2027 if (__predict_false(m->m_epg_npgs == 0)) {
2028 /* TLS 1.0 empty fragment. */
2033 error = (*tls->sw_encrypt)(tls,
2034 (const struct tls_record_layer *)m->m_epg_hdr,
2035 m->m_epg_trail, src_iov, dst_iov, i, m->m_epg_seqno,
2036 m->m_epg_record_type);
2038 counter_u64_add(ktls_offload_failed_crypto, 1);
2043 * For file-backed mbufs, release the file-backed
2044 * pages and replace them in the ext_pgs array with
2045 * the anonymous wired pages allocated above.
2048 /* Free the old pages. */
2049 m->m_ext.ext_free(m);
2051 /* Replace them with the new pages. */
2052 for (i = 0; i < m->m_epg_npgs; i++)
2053 m->m_epg_pa[i] = parray[i];
2055 /* Use the basic free routine. */
2056 m->m_ext.ext_free = mb_free_mext_pgs;
2058 /* Pages are now writable. */
2059 m->m_epg_flags |= EPG_FLAG_ANON;
2063 * Drop a reference to the session now that it is no
2064 * longer needed. Existing code depends on encrypted
2065 * records having no associated session vs
2066 * yet-to-be-encrypted records having an associated
2069 m->m_epg_tls = NULL;
2073 CURVNET_SET(so->so_vnet);
2075 (void)(*so->so_proto->pr_usrreqs->pru_ready)(so, top, npages);
2077 so->so_proto->pr_usrreqs->pru_abort(so);
2079 mb_free_notready(top, total_pages);
2088 ktls_work_thread(void *ctx)
2090 struct ktls_wq *wq = ctx;
2092 struct socket *so, *son;
2093 STAILQ_HEAD(, mbuf) local_m_head;
2094 STAILQ_HEAD(, socket) local_so_head;
2096 #if defined(__aarch64__) || defined(__amd64__) || defined(__i386__)
2101 while (STAILQ_EMPTY(&wq->m_head) &&
2102 STAILQ_EMPTY(&wq->so_head)) {
2103 wq->running = false;
2104 mtx_sleep(wq, &wq->mtx, 0, "-", 0);
2108 STAILQ_INIT(&local_m_head);
2109 STAILQ_CONCAT(&local_m_head, &wq->m_head);
2110 STAILQ_INIT(&local_so_head);
2111 STAILQ_CONCAT(&local_so_head, &wq->so_head);
2112 mtx_unlock(&wq->mtx);
2114 STAILQ_FOREACH_SAFE(m, &local_m_head, m_epg_stailq, n) {
2115 if (m->m_epg_flags & EPG_FLAG_2FREE) {
2116 ktls_free(m->m_epg_tls);
2117 uma_zfree(zone_mbuf, m);
2120 counter_u64_add(ktls_cnt_tx_queued, -1);
2124 STAILQ_FOREACH_SAFE(so, &local_so_head, so_ktls_rx_list, son) {
2126 counter_u64_add(ktls_cnt_rx_queued, -1);