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 #if defined(INET) || defined(INET6)
64 #include <netinet/in.h>
65 #include <netinet/in_pcb.h>
67 #include <netinet/tcp_var.h>
69 #include <netinet/tcp_offload.h>
71 #include <opencrypto/xform.h>
72 #include <vm/uma_dbg.h>
74 #include <vm/vm_pageout.h>
75 #include <vm/vm_page.h>
79 STAILQ_HEAD(, mbuf_ext_pgs) head;
81 } __aligned(CACHE_LINE_SIZE);
83 static struct ktls_wq *ktls_wq;
84 static struct proc *ktls_proc;
85 LIST_HEAD(, ktls_crypto_backend) ktls_backends;
86 static struct rmlock ktls_backends_lock;
87 static uma_zone_t ktls_session_zone;
88 static uint16_t ktls_cpuid_lookup[MAXCPU];
90 SYSCTL_NODE(_kern_ipc, OID_AUTO, tls, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
91 "Kernel TLS offload");
92 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, stats, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
93 "Kernel TLS offload stats");
95 static int ktls_allow_unload;
96 SYSCTL_INT(_kern_ipc_tls, OID_AUTO, allow_unload, CTLFLAG_RDTUN,
97 &ktls_allow_unload, 0, "Allow software crypto modules to unload");
100 static int ktls_bind_threads = 1;
102 static int ktls_bind_threads;
104 SYSCTL_INT(_kern_ipc_tls, OID_AUTO, bind_threads, CTLFLAG_RDTUN,
105 &ktls_bind_threads, 0,
106 "Bind crypto threads to cores or domains at boot");
108 static u_int ktls_maxlen = 16384;
109 SYSCTL_UINT(_kern_ipc_tls, OID_AUTO, maxlen, CTLFLAG_RWTUN,
110 &ktls_maxlen, 0, "Maximum TLS record size");
112 static int ktls_number_threads;
113 SYSCTL_INT(_kern_ipc_tls_stats, OID_AUTO, threads, CTLFLAG_RD,
114 &ktls_number_threads, 0,
115 "Number of TLS threads in thread-pool");
117 static bool ktls_offload_enable;
118 SYSCTL_BOOL(_kern_ipc_tls, OID_AUTO, enable, CTLFLAG_RW,
119 &ktls_offload_enable, 0,
120 "Enable support for kernel TLS offload");
122 static bool ktls_cbc_enable = true;
123 SYSCTL_BOOL(_kern_ipc_tls, OID_AUTO, cbc_enable, CTLFLAG_RW,
125 "Enable Support of AES-CBC crypto for kernel TLS");
127 static counter_u64_t ktls_tasks_active;
128 SYSCTL_COUNTER_U64(_kern_ipc_tls, OID_AUTO, tasks_active, CTLFLAG_RD,
129 &ktls_tasks_active, "Number of active tasks");
131 static counter_u64_t ktls_cnt_on;
132 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, so_inqueue, CTLFLAG_RD,
133 &ktls_cnt_on, "Number of TLS records in queue to tasks for SW crypto");
135 static counter_u64_t ktls_offload_total;
136 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, offload_total,
137 CTLFLAG_RD, &ktls_offload_total,
138 "Total successful TLS setups (parameters set)");
140 static counter_u64_t ktls_offload_enable_calls;
141 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, enable_calls,
142 CTLFLAG_RD, &ktls_offload_enable_calls,
143 "Total number of TLS enable calls made");
145 static counter_u64_t ktls_offload_active;
146 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, active, CTLFLAG_RD,
147 &ktls_offload_active, "Total Active TLS sessions");
149 static counter_u64_t ktls_offload_failed_crypto;
150 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, failed_crypto, CTLFLAG_RD,
151 &ktls_offload_failed_crypto, "Total TLS crypto failures");
153 static counter_u64_t ktls_switch_to_ifnet;
154 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_to_ifnet, CTLFLAG_RD,
155 &ktls_switch_to_ifnet, "TLS sessions switched from SW to ifnet");
157 static counter_u64_t ktls_switch_to_sw;
158 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_to_sw, CTLFLAG_RD,
159 &ktls_switch_to_sw, "TLS sessions switched from ifnet to SW");
161 static counter_u64_t ktls_switch_failed;
162 SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_failed, CTLFLAG_RD,
163 &ktls_switch_failed, "TLS sessions unable to switch between SW and ifnet");
165 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, sw, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
166 "Software TLS session stats");
167 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, ifnet, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
168 "Hardware (ifnet) TLS session stats");
170 SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, toe, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
171 "TOE TLS session stats");
174 static counter_u64_t ktls_sw_cbc;
175 SYSCTL_COUNTER_U64(_kern_ipc_tls_sw, OID_AUTO, cbc, CTLFLAG_RD, &ktls_sw_cbc,
176 "Active number of software TLS sessions using AES-CBC");
178 static counter_u64_t ktls_sw_gcm;
179 SYSCTL_COUNTER_U64(_kern_ipc_tls_sw, OID_AUTO, gcm, CTLFLAG_RD, &ktls_sw_gcm,
180 "Active number of software TLS sessions using AES-GCM");
182 static counter_u64_t ktls_ifnet_cbc;
183 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, cbc, CTLFLAG_RD,
185 "Active number of ifnet TLS sessions using AES-CBC");
187 static counter_u64_t ktls_ifnet_gcm;
188 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, gcm, CTLFLAG_RD,
190 "Active number of ifnet TLS sessions using AES-GCM");
192 static counter_u64_t ktls_ifnet_reset;
193 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset, CTLFLAG_RD,
194 &ktls_ifnet_reset, "TLS sessions updated to a new ifnet send tag");
196 static counter_u64_t ktls_ifnet_reset_dropped;
197 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset_dropped, CTLFLAG_RD,
198 &ktls_ifnet_reset_dropped,
199 "TLS sessions dropped after failing to update ifnet send tag");
201 static counter_u64_t ktls_ifnet_reset_failed;
202 SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset_failed, CTLFLAG_RD,
203 &ktls_ifnet_reset_failed,
204 "TLS sessions that failed to allocate a new ifnet send tag");
206 static int ktls_ifnet_permitted;
207 SYSCTL_UINT(_kern_ipc_tls_ifnet, OID_AUTO, permitted, CTLFLAG_RWTUN,
208 &ktls_ifnet_permitted, 1,
209 "Whether to permit hardware (ifnet) TLS sessions");
212 static counter_u64_t ktls_toe_cbc;
213 SYSCTL_COUNTER_U64(_kern_ipc_tls_toe, OID_AUTO, cbc, CTLFLAG_RD,
215 "Active number of TOE TLS sessions using AES-CBC");
217 static counter_u64_t ktls_toe_gcm;
218 SYSCTL_COUNTER_U64(_kern_ipc_tls_toe, OID_AUTO, gcm, CTLFLAG_RD,
220 "Active number of TOE TLS sessions using AES-GCM");
223 static MALLOC_DEFINE(M_KTLS, "ktls", "Kernel TLS");
225 static void ktls_cleanup(struct ktls_session *tls);
226 #if defined(INET) || defined(INET6)
227 static void ktls_reset_send_tag(void *context, int pending);
229 static void ktls_work_thread(void *ctx);
232 ktls_crypto_backend_register(struct ktls_crypto_backend *be)
234 struct ktls_crypto_backend *curr_be, *tmp;
236 if (be->api_version != KTLS_API_VERSION) {
237 printf("KTLS: API version mismatch (%d vs %d) for %s\n",
238 be->api_version, KTLS_API_VERSION,
243 rm_wlock(&ktls_backends_lock);
244 printf("KTLS: Registering crypto method %s with prio %d\n",
246 if (LIST_EMPTY(&ktls_backends)) {
247 LIST_INSERT_HEAD(&ktls_backends, be, next);
249 LIST_FOREACH_SAFE(curr_be, &ktls_backends, next, tmp) {
250 if (curr_be->prio < be->prio) {
251 LIST_INSERT_BEFORE(curr_be, be, next);
254 if (LIST_NEXT(curr_be, next) == NULL) {
255 LIST_INSERT_AFTER(curr_be, be, next);
260 rm_wunlock(&ktls_backends_lock);
265 ktls_crypto_backend_deregister(struct ktls_crypto_backend *be)
267 struct ktls_crypto_backend *tmp;
270 * Don't error if the backend isn't registered. This permits
271 * MOD_UNLOAD handlers to use this function unconditionally.
273 rm_wlock(&ktls_backends_lock);
274 LIST_FOREACH(tmp, &ktls_backends, next) {
279 rm_wunlock(&ktls_backends_lock);
283 if (!ktls_allow_unload) {
284 rm_wunlock(&ktls_backends_lock);
286 "KTLS: Deregistering crypto method %s is not supported\n",
292 rm_wunlock(&ktls_backends_lock);
296 LIST_REMOVE(be, next);
297 rm_wunlock(&ktls_backends_lock);
301 #if defined(INET) || defined(INET6)
303 ktls_get_cpu(struct socket *so)
310 cpuid = rss_hash2cpuid(inp->inp_flowid, inp->inp_flowtype);
311 if (cpuid != NETISR_CPUID_NONE)
315 * Just use the flowid to shard connections in a repeatable
316 * fashion. Note that some crypto backends rely on the
317 * serialization provided by having the same connection use
320 cpuid = ktls_cpuid_lookup[inp->inp_flowid % ktls_number_threads];
326 ktls_init(void *dummy __unused)
333 ktls_tasks_active = counter_u64_alloc(M_WAITOK);
334 ktls_cnt_on = counter_u64_alloc(M_WAITOK);
335 ktls_offload_total = counter_u64_alloc(M_WAITOK);
336 ktls_offload_enable_calls = counter_u64_alloc(M_WAITOK);
337 ktls_offload_active = counter_u64_alloc(M_WAITOK);
338 ktls_offload_failed_crypto = counter_u64_alloc(M_WAITOK);
339 ktls_switch_to_ifnet = counter_u64_alloc(M_WAITOK);
340 ktls_switch_to_sw = counter_u64_alloc(M_WAITOK);
341 ktls_switch_failed = counter_u64_alloc(M_WAITOK);
342 ktls_sw_cbc = counter_u64_alloc(M_WAITOK);
343 ktls_sw_gcm = counter_u64_alloc(M_WAITOK);
344 ktls_ifnet_cbc = counter_u64_alloc(M_WAITOK);
345 ktls_ifnet_gcm = counter_u64_alloc(M_WAITOK);
346 ktls_ifnet_reset = counter_u64_alloc(M_WAITOK);
347 ktls_ifnet_reset_dropped = counter_u64_alloc(M_WAITOK);
348 ktls_ifnet_reset_failed = counter_u64_alloc(M_WAITOK);
350 ktls_toe_cbc = counter_u64_alloc(M_WAITOK);
351 ktls_toe_gcm = counter_u64_alloc(M_WAITOK);
354 rm_init(&ktls_backends_lock, "ktls backends");
355 LIST_INIT(&ktls_backends);
357 ktls_wq = malloc(sizeof(*ktls_wq) * (mp_maxid + 1), M_KTLS,
360 ktls_session_zone = uma_zcreate("ktls_session",
361 sizeof(struct ktls_session),
362 NULL, NULL, NULL, NULL,
366 * Initialize the workqueues to run the TLS work. We create a
367 * work queue for each CPU.
370 STAILQ_INIT(&ktls_wq[i].head);
371 mtx_init(&ktls_wq[i].mtx, "ktls work queue", NULL, MTX_DEF);
372 error = kproc_kthread_add(ktls_work_thread, &ktls_wq[i],
373 &ktls_proc, &td, 0, 0, "KTLS", "thr_%d", i);
375 panic("Can't add KTLS thread %d error %d", i, error);
378 * Bind threads to cores. If ktls_bind_threads is >
379 * 1, then we bind to the NUMA domain.
381 if (ktls_bind_threads) {
382 if (ktls_bind_threads > 1) {
384 CPU_COPY(&cpuset_domain[pc->pc_domain], &mask);
388 error = cpuset_setthread(td->td_tid, &mask);
391 "Unable to bind KTLS thread for CPU %d error %d",
394 ktls_cpuid_lookup[ktls_number_threads] = i;
395 ktls_number_threads++;
397 printf("KTLS: Initialized %d threads\n", ktls_number_threads);
399 SYSINIT(ktls, SI_SUB_SMP + 1, SI_ORDER_ANY, ktls_init, NULL);
401 #if defined(INET) || defined(INET6)
403 ktls_create_session(struct socket *so, struct tls_enable *en,
404 struct ktls_session **tlsp)
406 struct ktls_session *tls;
409 /* Only TLS 1.0 - 1.3 are supported. */
410 if (en->tls_vmajor != TLS_MAJOR_VER_ONE)
412 if (en->tls_vminor < TLS_MINOR_VER_ZERO ||
413 en->tls_vminor > TLS_MINOR_VER_THREE)
416 if (en->auth_key_len < 0 || en->auth_key_len > TLS_MAX_PARAM_SIZE)
418 if (en->cipher_key_len < 0 || en->cipher_key_len > TLS_MAX_PARAM_SIZE)
420 if (en->iv_len < 0 || en->iv_len > sizeof(tls->params.iv))
423 /* All supported algorithms require a cipher key. */
424 if (en->cipher_key_len == 0)
427 /* No flags are currently supported. */
431 /* Common checks for supported algorithms. */
432 switch (en->cipher_algorithm) {
433 case CRYPTO_AES_NIST_GCM_16:
435 * auth_algorithm isn't used, but permit GMAC values
438 switch (en->auth_algorithm) {
440 #ifdef COMPAT_FREEBSD12
441 /* XXX: Really 13.0-current COMPAT. */
442 case CRYPTO_AES_128_NIST_GMAC:
443 case CRYPTO_AES_192_NIST_GMAC:
444 case CRYPTO_AES_256_NIST_GMAC:
450 if (en->auth_key_len != 0)
452 if ((en->tls_vminor == TLS_MINOR_VER_TWO &&
453 en->iv_len != TLS_AEAD_GCM_LEN) ||
454 (en->tls_vminor == TLS_MINOR_VER_THREE &&
455 en->iv_len != TLS_1_3_GCM_IV_LEN))
459 switch (en->auth_algorithm) {
460 case CRYPTO_SHA1_HMAC:
462 * TLS 1.0 requires an implicit IV. TLS 1.1+
463 * all use explicit IVs.
465 if (en->tls_vminor == TLS_MINOR_VER_ZERO) {
466 if (en->iv_len != TLS_CBC_IMPLICIT_IV_LEN)
472 case CRYPTO_SHA2_256_HMAC:
473 case CRYPTO_SHA2_384_HMAC:
474 /* Ignore any supplied IV. */
480 if (en->auth_key_len == 0)
487 tls = uma_zalloc(ktls_session_zone, M_WAITOK | M_ZERO);
489 counter_u64_add(ktls_offload_active, 1);
491 refcount_init(&tls->refcount, 1);
492 TASK_INIT(&tls->reset_tag_task, 0, ktls_reset_send_tag, tls);
494 tls->wq_index = ktls_get_cpu(so);
496 tls->params.cipher_algorithm = en->cipher_algorithm;
497 tls->params.auth_algorithm = en->auth_algorithm;
498 tls->params.tls_vmajor = en->tls_vmajor;
499 tls->params.tls_vminor = en->tls_vminor;
500 tls->params.flags = en->flags;
501 tls->params.max_frame_len = min(TLS_MAX_MSG_SIZE_V10_2, ktls_maxlen);
503 /* Set the header and trailer lengths. */
504 tls->params.tls_hlen = sizeof(struct tls_record_layer);
505 switch (en->cipher_algorithm) {
506 case CRYPTO_AES_NIST_GCM_16:
508 * TLS 1.2 uses a 4 byte implicit IV with an explicit 8 byte
509 * nonce. TLS 1.3 uses a 12 byte implicit IV.
511 if (en->tls_vminor < TLS_MINOR_VER_THREE)
512 tls->params.tls_hlen += sizeof(uint64_t);
513 tls->params.tls_tlen = AES_GMAC_HASH_LEN;
516 * TLS 1.3 includes optional padding which we
517 * do not support, and also puts the "real" record
518 * type at the end of the encrypted data.
520 if (en->tls_vminor == TLS_MINOR_VER_THREE)
521 tls->params.tls_tlen += sizeof(uint8_t);
523 tls->params.tls_bs = 1;
526 switch (en->auth_algorithm) {
527 case CRYPTO_SHA1_HMAC:
528 if (en->tls_vminor == TLS_MINOR_VER_ZERO) {
529 /* Implicit IV, no nonce. */
531 tls->params.tls_hlen += AES_BLOCK_LEN;
533 tls->params.tls_tlen = AES_BLOCK_LEN +
536 case CRYPTO_SHA2_256_HMAC:
537 tls->params.tls_hlen += AES_BLOCK_LEN;
538 tls->params.tls_tlen = AES_BLOCK_LEN +
541 case CRYPTO_SHA2_384_HMAC:
542 tls->params.tls_hlen += AES_BLOCK_LEN;
543 tls->params.tls_tlen = AES_BLOCK_LEN +
547 panic("invalid hmac");
549 tls->params.tls_bs = AES_BLOCK_LEN;
552 panic("invalid cipher");
555 KASSERT(tls->params.tls_hlen <= MBUF_PEXT_HDR_LEN,
556 ("TLS header length too long: %d", tls->params.tls_hlen));
557 KASSERT(tls->params.tls_tlen <= MBUF_PEXT_TRAIL_LEN,
558 ("TLS trailer length too long: %d", tls->params.tls_tlen));
560 if (en->auth_key_len != 0) {
561 tls->params.auth_key_len = en->auth_key_len;
562 tls->params.auth_key = malloc(en->auth_key_len, M_KTLS,
564 error = copyin(en->auth_key, tls->params.auth_key,
570 tls->params.cipher_key_len = en->cipher_key_len;
571 tls->params.cipher_key = malloc(en->cipher_key_len, M_KTLS, M_WAITOK);
572 error = copyin(en->cipher_key, tls->params.cipher_key,
578 * This holds the implicit portion of the nonce for GCM and
579 * the initial implicit IV for TLS 1.0. The explicit portions
580 * of the IV are generated in ktls_frame().
582 if (en->iv_len != 0) {
583 tls->params.iv_len = en->iv_len;
584 error = copyin(en->iv, tls->params.iv, en->iv_len);
589 * For TLS 1.2, generate an 8-byte nonce as a counter
590 * to generate unique explicit IVs.
592 * Store this counter in the last 8 bytes of the IV
593 * array so that it is 8-byte aligned.
595 if (en->cipher_algorithm == CRYPTO_AES_NIST_GCM_16 &&
596 en->tls_vminor == TLS_MINOR_VER_TWO)
597 arc4rand(tls->params.iv + 8, sizeof(uint64_t), 0);
608 static struct ktls_session *
609 ktls_clone_session(struct ktls_session *tls)
611 struct ktls_session *tls_new;
613 tls_new = uma_zalloc(ktls_session_zone, M_WAITOK | M_ZERO);
615 counter_u64_add(ktls_offload_active, 1);
617 refcount_init(&tls_new->refcount, 1);
619 /* Copy fields from existing session. */
620 tls_new->params = tls->params;
621 tls_new->wq_index = tls->wq_index;
623 /* Deep copy keys. */
624 if (tls_new->params.auth_key != NULL) {
625 tls_new->params.auth_key = malloc(tls->params.auth_key_len,
627 memcpy(tls_new->params.auth_key, tls->params.auth_key,
628 tls->params.auth_key_len);
631 tls_new->params.cipher_key = malloc(tls->params.cipher_key_len, M_KTLS,
633 memcpy(tls_new->params.cipher_key, tls->params.cipher_key,
634 tls->params.cipher_key_len);
641 ktls_cleanup(struct ktls_session *tls)
644 counter_u64_add(ktls_offload_active, -1);
646 case TCP_TLS_MODE_SW:
647 MPASS(tls->be != NULL);
648 switch (tls->params.cipher_algorithm) {
650 counter_u64_add(ktls_sw_cbc, -1);
652 case CRYPTO_AES_NIST_GCM_16:
653 counter_u64_add(ktls_sw_gcm, -1);
658 case TCP_TLS_MODE_IFNET:
659 switch (tls->params.cipher_algorithm) {
661 counter_u64_add(ktls_ifnet_cbc, -1);
663 case CRYPTO_AES_NIST_GCM_16:
664 counter_u64_add(ktls_ifnet_gcm, -1);
667 m_snd_tag_rele(tls->snd_tag);
670 case TCP_TLS_MODE_TOE:
671 switch (tls->params.cipher_algorithm) {
673 counter_u64_add(ktls_toe_cbc, -1);
675 case CRYPTO_AES_NIST_GCM_16:
676 counter_u64_add(ktls_toe_gcm, -1);
682 if (tls->params.auth_key != NULL) {
683 explicit_bzero(tls->params.auth_key, tls->params.auth_key_len);
684 free(tls->params.auth_key, M_KTLS);
685 tls->params.auth_key = NULL;
686 tls->params.auth_key_len = 0;
688 if (tls->params.cipher_key != NULL) {
689 explicit_bzero(tls->params.cipher_key,
690 tls->params.cipher_key_len);
691 free(tls->params.cipher_key, M_KTLS);
692 tls->params.cipher_key = NULL;
693 tls->params.cipher_key_len = 0;
695 explicit_bzero(tls->params.iv, sizeof(tls->params.iv));
698 #if defined(INET) || defined(INET6)
702 ktls_try_toe(struct socket *so, struct ktls_session *tls)
710 if (inp->inp_flags2 & INP_FREED) {
714 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
718 if (inp->inp_socket == NULL) {
723 if (tp->tod == NULL) {
728 error = tcp_offload_alloc_tls_session(tp, tls);
731 tls->mode = TCP_TLS_MODE_TOE;
732 switch (tls->params.cipher_algorithm) {
734 counter_u64_add(ktls_toe_cbc, 1);
736 case CRYPTO_AES_NIST_GCM_16:
737 counter_u64_add(ktls_toe_gcm, 1);
746 * Common code used when first enabling ifnet TLS on a connection or
747 * when allocating a new ifnet TLS session due to a routing change.
748 * This function allocates a new TLS send tag on whatever interface
749 * the connection is currently routed over.
752 ktls_alloc_snd_tag(struct inpcb *inp, struct ktls_session *tls, bool force,
753 struct m_snd_tag **mstp)
755 union if_snd_tag_alloc_params params;
762 if (inp->inp_flags2 & INP_FREED) {
766 if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
770 if (inp->inp_socket == NULL) {
777 * Check administrative controls on ifnet TLS to determine if
778 * ifnet TLS should be denied.
780 * - Always permit 'force' requests.
781 * - ktls_ifnet_permitted == 0: always deny.
783 if (!force && ktls_ifnet_permitted == 0) {
789 * XXX: Use the cached route in the inpcb to find the
790 * interface. This should perhaps instead use
791 * rtalloc1_fib(dst, 0, 0, fibnum). Since KTLS is only
792 * enabled after a connection has completed key negotiation in
793 * userland, the cached route will be present in practice.
795 rt = inp->inp_route.ro_rt;
796 if (rt == NULL || rt->rt_ifp == NULL) {
803 params.hdr.type = IF_SND_TAG_TYPE_TLS;
804 params.hdr.flowid = inp->inp_flowid;
805 params.hdr.flowtype = inp->inp_flowtype;
806 params.hdr.numa_domain = inp->inp_numa_domain;
807 params.tls.inp = inp;
808 params.tls.tls = tls;
811 if (ifp->if_snd_tag_alloc == NULL) {
815 if ((ifp->if_capenable & IFCAP_NOMAP) == 0) {
819 if (inp->inp_vflag & INP_IPV6) {
820 if ((ifp->if_capenable & IFCAP_TXTLS6) == 0) {
825 if ((ifp->if_capenable & IFCAP_TXTLS4) == 0) {
830 error = ifp->if_snd_tag_alloc(ifp, ¶ms, mstp);
837 ktls_try_ifnet(struct socket *so, struct ktls_session *tls, bool force)
839 struct m_snd_tag *mst;
842 error = ktls_alloc_snd_tag(so->so_pcb, tls, force, &mst);
844 tls->mode = TCP_TLS_MODE_IFNET;
846 switch (tls->params.cipher_algorithm) {
848 counter_u64_add(ktls_ifnet_cbc, 1);
850 case CRYPTO_AES_NIST_GCM_16:
851 counter_u64_add(ktls_ifnet_gcm, 1);
859 ktls_try_sw(struct socket *so, struct ktls_session *tls)
861 struct rm_priotracker prio;
862 struct ktls_crypto_backend *be;
865 * Choose the best software crypto backend. Backends are
866 * stored in sorted priority order (larget value == most
867 * important at the head of the list), so this just stops on
868 * the first backend that claims the session by returning
871 if (ktls_allow_unload)
872 rm_rlock(&ktls_backends_lock, &prio);
873 LIST_FOREACH(be, &ktls_backends, next) {
874 if (be->try(so, tls) == 0)
876 KASSERT(tls->cipher == NULL,
877 ("ktls backend leaked a cipher pointer"));
880 if (ktls_allow_unload)
884 if (ktls_allow_unload)
885 rm_runlock(&ktls_backends_lock, &prio);
888 tls->mode = TCP_TLS_MODE_SW;
889 switch (tls->params.cipher_algorithm) {
891 counter_u64_add(ktls_sw_cbc, 1);
893 case CRYPTO_AES_NIST_GCM_16:
894 counter_u64_add(ktls_sw_gcm, 1);
901 ktls_enable_tx(struct socket *so, struct tls_enable *en)
903 struct ktls_session *tls;
906 if (!ktls_offload_enable)
909 counter_u64_add(ktls_offload_enable_calls, 1);
912 * This should always be true since only the TCP socket option
913 * invokes this function.
915 if (so->so_proto->pr_protocol != IPPROTO_TCP)
919 * XXX: Don't overwrite existing sessions. We should permit
920 * this to support rekeying in the future.
922 if (so->so_snd.sb_tls_info != NULL)
925 if (en->cipher_algorithm == CRYPTO_AES_CBC && !ktls_cbc_enable)
928 /* TLS requires ext pgs */
929 if (mb_use_ext_pgs == 0)
932 error = ktls_create_session(so, en, &tls);
936 /* Prefer TOE -> ifnet TLS -> software TLS. */
938 error = ktls_try_toe(so, tls);
941 error = ktls_try_ifnet(so, tls, false);
943 error = ktls_try_sw(so, tls);
950 error = sblock(&so->so_snd, SBL_WAIT);
956 SOCKBUF_LOCK(&so->so_snd);
957 so->so_snd.sb_tls_info = tls;
958 if (tls->mode != TCP_TLS_MODE_SW)
959 so->so_snd.sb_flags |= SB_TLS_IFNET;
960 SOCKBUF_UNLOCK(&so->so_snd);
961 sbunlock(&so->so_snd);
963 counter_u64_add(ktls_offload_total, 1);
969 ktls_get_tx_mode(struct socket *so)
971 struct ktls_session *tls;
976 INP_WLOCK_ASSERT(inp);
977 SOCKBUF_LOCK(&so->so_snd);
978 tls = so->so_snd.sb_tls_info;
980 mode = TCP_TLS_MODE_NONE;
983 SOCKBUF_UNLOCK(&so->so_snd);
988 * Switch between SW and ifnet TLS sessions as requested.
991 ktls_set_tx_mode(struct socket *so, int mode)
993 struct ktls_session *tls, *tls_new;
998 case TCP_TLS_MODE_SW:
999 case TCP_TLS_MODE_IFNET:
1006 INP_WLOCK_ASSERT(inp);
1007 SOCKBUF_LOCK(&so->so_snd);
1008 tls = so->so_snd.sb_tls_info;
1010 SOCKBUF_UNLOCK(&so->so_snd);
1014 if (tls->mode == mode) {
1015 SOCKBUF_UNLOCK(&so->so_snd);
1019 tls = ktls_hold(tls);
1020 SOCKBUF_UNLOCK(&so->so_snd);
1023 tls_new = ktls_clone_session(tls);
1025 if (mode == TCP_TLS_MODE_IFNET)
1026 error = ktls_try_ifnet(so, tls_new, true);
1028 error = ktls_try_sw(so, tls_new);
1030 counter_u64_add(ktls_switch_failed, 1);
1037 error = sblock(&so->so_snd, SBL_WAIT);
1039 counter_u64_add(ktls_switch_failed, 1);
1047 * If we raced with another session change, keep the existing
1050 if (tls != so->so_snd.sb_tls_info) {
1051 counter_u64_add(ktls_switch_failed, 1);
1052 sbunlock(&so->so_snd);
1059 SOCKBUF_LOCK(&so->so_snd);
1060 so->so_snd.sb_tls_info = tls_new;
1061 if (tls_new->mode != TCP_TLS_MODE_SW)
1062 so->so_snd.sb_flags |= SB_TLS_IFNET;
1063 SOCKBUF_UNLOCK(&so->so_snd);
1064 sbunlock(&so->so_snd);
1067 * Drop two references on 'tls'. The first is for the
1068 * ktls_hold() above. The second drops the reference from the
1071 KASSERT(tls->refcount >= 2, ("too few references on old session"));
1075 if (mode == TCP_TLS_MODE_IFNET)
1076 counter_u64_add(ktls_switch_to_ifnet, 1);
1078 counter_u64_add(ktls_switch_to_sw, 1);
1085 * Try to allocate a new TLS send tag. This task is scheduled when
1086 * ip_output detects a route change while trying to transmit a packet
1087 * holding a TLS record. If a new tag is allocated, replace the tag
1088 * in the TLS session. Subsequent packets on the connection will use
1089 * the new tag. If a new tag cannot be allocated, drop the
1093 ktls_reset_send_tag(void *context, int pending)
1095 struct epoch_tracker et;
1096 struct ktls_session *tls;
1097 struct m_snd_tag *old, *new;
1102 MPASS(pending == 1);
1108 * Free the old tag first before allocating a new one.
1109 * ip[6]_output_send() will treat a NULL send tag the same as
1110 * an ifp mismatch and drop packets until a new tag is
1113 * Write-lock the INP when changing tls->snd_tag since
1114 * ip[6]_output_send() holds a read-lock when reading the
1119 tls->snd_tag = NULL;
1122 m_snd_tag_rele(old);
1124 error = ktls_alloc_snd_tag(inp, tls, true, &new);
1129 mtx_pool_lock(mtxpool_sleep, tls);
1130 tls->reset_pending = false;
1131 mtx_pool_unlock(mtxpool_sleep, tls);
1132 if (!in_pcbrele_wlocked(inp))
1135 counter_u64_add(ktls_ifnet_reset, 1);
1138 * XXX: Should we kick tcp_output explicitly now that
1139 * the send tag is fixed or just rely on timers?
1142 NET_EPOCH_ENTER(et);
1144 if (!in_pcbrele_wlocked(inp)) {
1145 if (!(inp->inp_flags & INP_TIMEWAIT) &&
1146 !(inp->inp_flags & INP_DROPPED)) {
1147 tp = intotcpcb(inp);
1148 CURVNET_SET(tp->t_vnet);
1149 tp = tcp_drop(tp, ECONNABORTED);
1153 counter_u64_add(ktls_ifnet_reset_dropped, 1);
1159 counter_u64_add(ktls_ifnet_reset_failed, 1);
1162 * Leave reset_pending true to avoid future tasks while
1163 * the socket goes away.
1171 ktls_output_eagain(struct inpcb *inp, struct ktls_session *tls)
1177 INP_LOCK_ASSERT(inp);
1180 * See if we should schedule a task to update the send tag for
1183 mtx_pool_lock(mtxpool_sleep, tls);
1184 if (!tls->reset_pending) {
1185 (void) ktls_hold(tls);
1188 tls->reset_pending = true;
1189 taskqueue_enqueue(taskqueue_thread, &tls->reset_tag_task);
1191 mtx_pool_unlock(mtxpool_sleep, tls);
1197 ktls_destroy(struct ktls_session *tls)
1199 struct rm_priotracker prio;
1202 if (tls->be != NULL && ktls_allow_unload) {
1203 rm_rlock(&ktls_backends_lock, &prio);
1204 tls->be->use_count--;
1205 rm_runlock(&ktls_backends_lock, &prio);
1207 uma_zfree(ktls_session_zone, tls);
1211 ktls_seq(struct sockbuf *sb, struct mbuf *m)
1213 struct mbuf_ext_pgs *pgs;
1215 for (; m != NULL; m = m->m_next) {
1216 KASSERT((m->m_flags & M_NOMAP) != 0,
1217 ("ktls_seq: mapped mbuf %p", m));
1219 pgs = m->m_ext.ext_pgs;
1220 pgs->seqno = sb->sb_tls_seqno;
1226 * Add TLS framing (headers and trailers) to a chain of mbufs. Each
1227 * mbuf in the chain must be an unmapped mbuf. The payload of the
1228 * mbuf must be populated with the payload of each TLS record.
1230 * The record_type argument specifies the TLS record type used when
1231 * populating the TLS header.
1233 * The enq_count argument on return is set to the number of pages of
1234 * payload data for this entire chain that need to be encrypted via SW
1235 * encryption. The returned value should be passed to ktls_enqueue
1236 * when scheduling encryption of this chain of mbufs.
1239 ktls_frame(struct mbuf *top, struct ktls_session *tls, int *enq_cnt,
1240 uint8_t record_type)
1242 struct tls_record_layer *tlshdr;
1244 struct mbuf_ext_pgs *pgs;
1249 maxlen = tls->params.max_frame_len;
1251 for (m = top; m != NULL; m = m->m_next) {
1253 * All mbufs in the chain should be non-empty TLS
1254 * records whose payload does not exceed the maximum
1257 KASSERT(m->m_len <= maxlen && m->m_len > 0,
1258 ("ktls_frame: m %p len %d\n", m, m->m_len));
1260 * TLS frames require unmapped mbufs to store session
1263 KASSERT((m->m_flags & M_NOMAP) != 0,
1264 ("ktls_frame: mapped mbuf %p (top = %p)\n", m, top));
1267 pgs = m->m_ext.ext_pgs;
1269 /* Save a reference to the session. */
1270 pgs->tls = ktls_hold(tls);
1272 pgs->hdr_len = tls->params.tls_hlen;
1273 pgs->trail_len = tls->params.tls_tlen;
1274 if (tls->params.cipher_algorithm == CRYPTO_AES_CBC) {
1278 * AES-CBC pads messages to a multiple of the
1279 * block size. Note that the padding is
1280 * applied after the digest and the encryption
1281 * is done on the "plaintext || mac || padding".
1282 * At least one byte of padding is always
1285 * Compute the final trailer length assuming
1286 * at most one block of padding.
1287 * tls->params.sb_tls_tlen is the maximum
1288 * possible trailer length (padding + digest).
1289 * delta holds the number of excess padding
1290 * bytes if the maximum were used. Those
1291 * extra bytes are removed.
1293 bs = tls->params.tls_bs;
1294 delta = (tls_len + tls->params.tls_tlen) & (bs - 1);
1295 pgs->trail_len -= delta;
1297 m->m_len += pgs->hdr_len + pgs->trail_len;
1299 /* Populate the TLS header. */
1300 tlshdr = (void *)pgs->hdr;
1301 tlshdr->tls_vmajor = tls->params.tls_vmajor;
1304 * TLS 1.3 masquarades as TLS 1.2 with a record type
1305 * of TLS_RLTYPE_APP.
1307 if (tls->params.tls_vminor == TLS_MINOR_VER_THREE &&
1308 tls->params.tls_vmajor == TLS_MAJOR_VER_ONE) {
1309 tlshdr->tls_vminor = TLS_MINOR_VER_TWO;
1310 tlshdr->tls_type = TLS_RLTYPE_APP;
1311 /* save the real record type for later */
1312 pgs->record_type = record_type;
1314 tlshdr->tls_vminor = tls->params.tls_vminor;
1315 tlshdr->tls_type = record_type;
1317 tlshdr->tls_length = htons(m->m_len - sizeof(*tlshdr));
1320 * Store nonces / explicit IVs after the end of the
1323 * For GCM with TLS 1.2, an 8 byte nonce is copied
1324 * from the end of the IV. The nonce is then
1325 * incremented for use by the next record.
1327 * For CBC, a random nonce is inserted for TLS 1.1+.
1329 if (tls->params.cipher_algorithm == CRYPTO_AES_NIST_GCM_16 &&
1330 tls->params.tls_vminor == TLS_MINOR_VER_TWO) {
1331 noncep = (uint64_t *)(tls->params.iv + 8);
1332 be64enc(tlshdr + 1, *noncep);
1334 } else if (tls->params.cipher_algorithm == CRYPTO_AES_CBC &&
1335 tls->params.tls_vminor >= TLS_MINOR_VER_ONE)
1336 arc4rand(tlshdr + 1, AES_BLOCK_LEN, 0);
1339 * When using SW encryption, mark the mbuf not ready.
1340 * It will be marked ready via sbready() after the
1341 * record has been encrypted.
1343 * When using ifnet TLS, unencrypted TLS records are
1344 * sent down the stack to the NIC.
1346 if (tls->mode == TCP_TLS_MODE_SW) {
1347 m->m_flags |= M_NOTREADY;
1348 pgs->nrdy = pgs->npgs;
1349 *enq_cnt += pgs->npgs;
1355 ktls_enqueue_to_free(struct mbuf_ext_pgs *pgs)
1360 /* Mark it for freeing. */
1362 wq = &ktls_wq[pgs->tls->wq_index];
1364 STAILQ_INSERT_TAIL(&wq->head, pgs, stailq);
1365 running = wq->running;
1366 mtx_unlock(&wq->mtx);
1372 ktls_enqueue(struct mbuf *m, struct socket *so, int page_count)
1374 struct mbuf_ext_pgs *pgs;
1378 KASSERT(((m->m_flags & (M_NOMAP | M_NOTREADY)) ==
1379 (M_NOMAP | M_NOTREADY)),
1380 ("ktls_enqueue: %p not unready & nomap mbuf\n", m));
1381 KASSERT(page_count != 0, ("enqueueing TLS mbuf with zero page count"));
1383 pgs = m->m_ext.ext_pgs;
1385 KASSERT(pgs->tls->mode == TCP_TLS_MODE_SW, ("!SW TLS mbuf"));
1387 pgs->enc_cnt = page_count;
1391 * Save a pointer to the socket. The caller is responsible
1392 * for taking an additional reference via soref().
1396 wq = &ktls_wq[pgs->tls->wq_index];
1398 STAILQ_INSERT_TAIL(&wq->head, pgs, stailq);
1399 running = wq->running;
1400 mtx_unlock(&wq->mtx);
1403 counter_u64_add(ktls_cnt_on, 1);
1406 static __noinline void
1407 ktls_encrypt(struct mbuf_ext_pgs *pgs)
1409 struct ktls_session *tls;
1411 struct mbuf *m, *top;
1412 vm_paddr_t parray[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1413 struct iovec src_iov[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1414 struct iovec dst_iov[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1416 int error, i, len, npages, off, total_pages;
1422 KASSERT(tls != NULL, ("tls = NULL, top = %p, pgs = %p\n", top, pgs));
1423 KASSERT(so != NULL, ("so = NULL, top = %p, pgs = %p\n", top, pgs));
1428 total_pages = pgs->enc_cnt;
1432 * Encrypt the TLS records in the chain of mbufs starting with
1433 * 'top'. 'total_pages' gives us a total count of pages and is
1434 * used to know when we have finished encrypting the TLS
1435 * records originally queued with 'top'.
1437 * NB: These mbufs are queued in the socket buffer and
1438 * 'm_next' is traversing the mbufs in the socket buffer. The
1439 * socket buffer lock is not held while traversing this chain.
1440 * Since the mbufs are all marked M_NOTREADY their 'm_next'
1441 * pointers should be stable. However, the 'm_next' of the
1442 * last mbuf encrypted is not necessarily NULL. It can point
1443 * to other mbufs appended while 'top' was on the TLS work
1446 * Each mbuf holds an entire TLS record.
1449 for (m = top; npages != total_pages; m = m->m_next) {
1450 pgs = m->m_ext.ext_pgs;
1452 KASSERT(pgs->tls == tls,
1453 ("different TLS sessions in a single mbuf chain: %p vs %p",
1455 KASSERT((m->m_flags & (M_NOMAP | M_NOTREADY)) ==
1456 (M_NOMAP | M_NOTREADY),
1457 ("%p not unready & nomap mbuf (top = %p)\n", m, top));
1458 KASSERT(npages + pgs->npgs <= total_pages,
1459 ("page count mismatch: top %p, total_pages %d, m %p", top,
1463 * Generate source and destination ivoecs to pass to
1464 * the SW encryption backend. For writable mbufs, the
1465 * destination iovec is a copy of the source and
1466 * encryption is done in place. For file-backed mbufs
1467 * (from sendfile), anonymous wired pages are
1468 * allocated and assigned to the destination iovec.
1470 is_anon = (pgs->flags & MBUF_PEXT_FLAG_ANON) != 0;
1472 off = pgs->first_pg_off;
1473 for (i = 0; i < pgs->npgs; i++, off = 0) {
1474 len = mbuf_ext_pg_len(pgs, i, off);
1475 src_iov[i].iov_len = len;
1476 src_iov[i].iov_base =
1477 (char *)(void *)PHYS_TO_DMAP(pgs->pa[i]) + off;
1480 dst_iov[i].iov_base = src_iov[i].iov_base;
1481 dst_iov[i].iov_len = src_iov[i].iov_len;
1485 pg = vm_page_alloc(NULL, 0, VM_ALLOC_NORMAL |
1486 VM_ALLOC_NOOBJ | VM_ALLOC_NODUMP | VM_ALLOC_WIRED);
1491 parray[i] = VM_PAGE_TO_PHYS(pg);
1492 dst_iov[i].iov_base =
1493 (char *)(void *)PHYS_TO_DMAP(parray[i]) + off;
1494 dst_iov[i].iov_len = len;
1499 error = (*tls->sw_encrypt)(tls,
1500 (const struct tls_record_layer *)pgs->hdr,
1501 pgs->trail, src_iov, dst_iov, i, pgs->seqno,
1504 counter_u64_add(ktls_offload_failed_crypto, 1);
1509 * For file-backed mbufs, release the file-backed
1510 * pages and replace them in the ext_pgs array with
1511 * the anonymous wired pages allocated above.
1514 /* Free the old pages. */
1515 m->m_ext.ext_free(m);
1517 /* Replace them with the new pages. */
1518 for (i = 0; i < pgs->npgs; i++)
1519 pgs->pa[i] = parray[i];
1521 /* Use the basic free routine. */
1522 m->m_ext.ext_free = mb_free_mext_pgs;
1524 /* Pages are now writable. */
1525 pgs->flags |= MBUF_PEXT_FLAG_ANON;
1529 * Drop a reference to the session now that it is no
1530 * longer needed. Existing code depends on encrypted
1531 * records having no associated session vs
1532 * yet-to-be-encrypted records having an associated
1539 CURVNET_SET(so->so_vnet);
1541 (void)(*so->so_proto->pr_usrreqs->pru_ready)(so, top, npages);
1543 so->so_proto->pr_usrreqs->pru_abort(so);
1545 mb_free_notready(top, total_pages);
1554 ktls_work_thread(void *ctx)
1556 struct ktls_wq *wq = ctx;
1557 struct mbuf_ext_pgs *p, *n;
1558 struct ktls_session *tls;
1559 STAILQ_HEAD(, mbuf_ext_pgs) local_head;
1561 #if defined(__aarch64__) || defined(__amd64__) || defined(__i386__)
1566 while (STAILQ_EMPTY(&wq->head)) {
1567 wq->running = false;
1568 mtx_sleep(wq, &wq->mtx, 0, "-", 0);
1572 STAILQ_INIT(&local_head);
1573 STAILQ_CONCAT(&local_head, &wq->head);
1574 mtx_unlock(&wq->mtx);
1576 STAILQ_FOREACH_SAFE(p, &local_head, stailq, n) {
1577 if (p->mbuf != NULL) {
1579 counter_u64_add(ktls_cnt_on, -1);
1583 uma_zfree(zone_extpgs, p);