xref: /freebsd/sys/kern/uipc_ktls.c (revision 6685e259e31995e20fa2f9cd7e19a292fcdc6877)
1b2e60773SJohn Baldwin /*-
2b2e60773SJohn Baldwin  * SPDX-License-Identifier: BSD-2-Clause
3b2e60773SJohn Baldwin  *
4b2e60773SJohn Baldwin  * Copyright (c) 2014-2019 Netflix Inc.
5b2e60773SJohn Baldwin  *
6b2e60773SJohn Baldwin  * Redistribution and use in source and binary forms, with or without
7b2e60773SJohn Baldwin  * modification, are permitted provided that the following conditions
8b2e60773SJohn Baldwin  * are met:
9b2e60773SJohn Baldwin  * 1. Redistributions of source code must retain the above copyright
10b2e60773SJohn Baldwin  *    notice, this list of conditions and the following disclaimer.
11b2e60773SJohn Baldwin  * 2. Redistributions in binary form must reproduce the above copyright
12b2e60773SJohn Baldwin  *    notice, this list of conditions and the following disclaimer in the
13b2e60773SJohn Baldwin  *    documentation and/or other materials provided with the distribution.
14b2e60773SJohn Baldwin  *
15b2e60773SJohn Baldwin  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16b2e60773SJohn Baldwin  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17b2e60773SJohn Baldwin  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18b2e60773SJohn Baldwin  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19b2e60773SJohn Baldwin  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20b2e60773SJohn Baldwin  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21b2e60773SJohn Baldwin  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22b2e60773SJohn Baldwin  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23b2e60773SJohn Baldwin  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24b2e60773SJohn Baldwin  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25b2e60773SJohn Baldwin  * SUCH DAMAGE.
26b2e60773SJohn Baldwin  */
27b2e60773SJohn Baldwin 
28b2e60773SJohn Baldwin #include <sys/cdefs.h>
29b2e60773SJohn Baldwin __FBSDID("$FreeBSD$");
30b2e60773SJohn Baldwin 
31b2e60773SJohn Baldwin #include "opt_inet.h"
32b2e60773SJohn Baldwin #include "opt_inet6.h"
33b2e60773SJohn Baldwin #include "opt_rss.h"
34b2e60773SJohn Baldwin 
35b2e60773SJohn Baldwin #include <sys/param.h>
36b2e60773SJohn Baldwin #include <sys/kernel.h>
3702bc3865SAndrew Gallatin #include <sys/domainset.h>
38b2e60773SJohn Baldwin #include <sys/ktls.h>
39b2e60773SJohn Baldwin #include <sys/lock.h>
40b2e60773SJohn Baldwin #include <sys/mbuf.h>
41b2e60773SJohn Baldwin #include <sys/mutex.h>
42b2e60773SJohn Baldwin #include <sys/rmlock.h>
43b2e60773SJohn Baldwin #include <sys/proc.h>
44b2e60773SJohn Baldwin #include <sys/protosw.h>
45b2e60773SJohn Baldwin #include <sys/refcount.h>
46b2e60773SJohn Baldwin #include <sys/smp.h>
47b2e60773SJohn Baldwin #include <sys/socket.h>
48b2e60773SJohn Baldwin #include <sys/socketvar.h>
49b2e60773SJohn Baldwin #include <sys/sysctl.h>
50b2e60773SJohn Baldwin #include <sys/taskqueue.h>
51b2e60773SJohn Baldwin #include <sys/kthread.h>
52b2e60773SJohn Baldwin #include <sys/uio.h>
53b2e60773SJohn Baldwin #include <sys/vmmeter.h>
54b2e60773SJohn Baldwin #if defined(__aarch64__) || defined(__amd64__) || defined(__i386__)
55b2e60773SJohn Baldwin #include <machine/pcb.h>
56b2e60773SJohn Baldwin #endif
57b2e60773SJohn Baldwin #include <machine/vmparam.h>
5890746943SGleb Smirnoff #include <net/if.h>
5990746943SGleb Smirnoff #include <net/if_var.h>
60b2e60773SJohn Baldwin #ifdef RSS
61b2e60773SJohn Baldwin #include <net/netisr.h>
62b2e60773SJohn Baldwin #include <net/rss_config.h>
63b2e60773SJohn Baldwin #endif
64454d3896SAlexander V. Chernikov #include <net/route.h>
65454d3896SAlexander V. Chernikov #include <net/route/nhop.h>
66b2e60773SJohn Baldwin #if defined(INET) || defined(INET6)
67b2e60773SJohn Baldwin #include <netinet/in.h>
68b2e60773SJohn Baldwin #include <netinet/in_pcb.h>
69b2e60773SJohn Baldwin #endif
70b2e60773SJohn Baldwin #include <netinet/tcp_var.h>
719e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
729e14430dSJohn Baldwin #include <netinet/tcp_offload.h>
739e14430dSJohn Baldwin #endif
74b2e60773SJohn Baldwin #include <opencrypto/xform.h>
75b2e60773SJohn Baldwin #include <vm/uma_dbg.h>
76b2e60773SJohn Baldwin #include <vm/vm.h>
77b2e60773SJohn Baldwin #include <vm/vm_pageout.h>
78b2e60773SJohn Baldwin #include <vm/vm_page.h>
79b2e60773SJohn Baldwin 
80b2e60773SJohn Baldwin struct ktls_wq {
81b2e60773SJohn Baldwin 	struct mtx	mtx;
823c0e5685SJohn Baldwin 	STAILQ_HEAD(, mbuf) m_head;
833c0e5685SJohn Baldwin 	STAILQ_HEAD(, socket) so_head;
84b2e60773SJohn Baldwin 	bool		running;
85b2e60773SJohn Baldwin } __aligned(CACHE_LINE_SIZE);
86b2e60773SJohn Baldwin 
8702bc3865SAndrew Gallatin struct ktls_domain_info {
8802bc3865SAndrew Gallatin 	int count;
8902bc3865SAndrew Gallatin 	int cpu[MAXCPU];
9002bc3865SAndrew Gallatin };
9102bc3865SAndrew Gallatin 
9202bc3865SAndrew Gallatin struct ktls_domain_info ktls_domains[MAXMEMDOM];
93b2e60773SJohn Baldwin static struct ktls_wq *ktls_wq;
94b2e60773SJohn Baldwin static struct proc *ktls_proc;
95b2e60773SJohn Baldwin LIST_HEAD(, ktls_crypto_backend) ktls_backends;
96b2e60773SJohn Baldwin static struct rmlock ktls_backends_lock;
97b2e60773SJohn Baldwin static uma_zone_t ktls_session_zone;
98b2e60773SJohn Baldwin static uint16_t ktls_cpuid_lookup[MAXCPU];
99b2e60773SJohn Baldwin 
1007029da5cSPawel Biernacki SYSCTL_NODE(_kern_ipc, OID_AUTO, tls, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
101b2e60773SJohn Baldwin     "Kernel TLS offload");
1027029da5cSPawel Biernacki SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, stats, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
103b2e60773SJohn Baldwin     "Kernel TLS offload stats");
104b2e60773SJohn Baldwin 
105b2e60773SJohn Baldwin static int ktls_allow_unload;
106b2e60773SJohn Baldwin SYSCTL_INT(_kern_ipc_tls, OID_AUTO, allow_unload, CTLFLAG_RDTUN,
107b2e60773SJohn Baldwin     &ktls_allow_unload, 0, "Allow software crypto modules to unload");
108b2e60773SJohn Baldwin 
109b2e60773SJohn Baldwin #ifdef RSS
110b2e60773SJohn Baldwin static int ktls_bind_threads = 1;
111b2e60773SJohn Baldwin #else
112b2e60773SJohn Baldwin static int ktls_bind_threads;
113b2e60773SJohn Baldwin #endif
114b2e60773SJohn Baldwin SYSCTL_INT(_kern_ipc_tls, OID_AUTO, bind_threads, CTLFLAG_RDTUN,
115b2e60773SJohn Baldwin     &ktls_bind_threads, 0,
116b2e60773SJohn Baldwin     "Bind crypto threads to cores or domains at boot");
117b2e60773SJohn Baldwin 
118b2e60773SJohn Baldwin static u_int ktls_maxlen = 16384;
119b2e60773SJohn Baldwin SYSCTL_UINT(_kern_ipc_tls, OID_AUTO, maxlen, CTLFLAG_RWTUN,
120b2e60773SJohn Baldwin     &ktls_maxlen, 0, "Maximum TLS record size");
121b2e60773SJohn Baldwin 
122b2e60773SJohn Baldwin static int ktls_number_threads;
123b2e60773SJohn Baldwin SYSCTL_INT(_kern_ipc_tls_stats, OID_AUTO, threads, CTLFLAG_RD,
124b2e60773SJohn Baldwin     &ktls_number_threads, 0,
125b2e60773SJohn Baldwin     "Number of TLS threads in thread-pool");
126b2e60773SJohn Baldwin 
127b2e60773SJohn Baldwin static bool ktls_offload_enable;
128b2e60773SJohn Baldwin SYSCTL_BOOL(_kern_ipc_tls, OID_AUTO, enable, CTLFLAG_RW,
129b2e60773SJohn Baldwin     &ktls_offload_enable, 0,
130b2e60773SJohn Baldwin     "Enable support for kernel TLS offload");
131b2e60773SJohn Baldwin 
132b2e60773SJohn Baldwin static bool ktls_cbc_enable = true;
133b2e60773SJohn Baldwin SYSCTL_BOOL(_kern_ipc_tls, OID_AUTO, cbc_enable, CTLFLAG_RW,
134b2e60773SJohn Baldwin     &ktls_cbc_enable, 1,
135b2e60773SJohn Baldwin     "Enable Support of AES-CBC crypto for kernel TLS");
136b2e60773SJohn Baldwin 
137b2e60773SJohn Baldwin static counter_u64_t ktls_tasks_active;
138b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls, OID_AUTO, tasks_active, CTLFLAG_RD,
139b2e60773SJohn Baldwin     &ktls_tasks_active, "Number of active tasks");
140b2e60773SJohn Baldwin 
1413c0e5685SJohn Baldwin static counter_u64_t ktls_cnt_tx_queued;
1423c0e5685SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, sw_tx_inqueue, CTLFLAG_RD,
1433c0e5685SJohn Baldwin     &ktls_cnt_tx_queued,
1443c0e5685SJohn Baldwin     "Number of TLS records in queue to tasks for SW encryption");
1453c0e5685SJohn Baldwin 
1463c0e5685SJohn Baldwin static counter_u64_t ktls_cnt_rx_queued;
1473c0e5685SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, sw_rx_inqueue, CTLFLAG_RD,
1483c0e5685SJohn Baldwin     &ktls_cnt_rx_queued,
1493c0e5685SJohn Baldwin     "Number of TLS sockets in queue to tasks for SW decryption");
150b2e60773SJohn Baldwin 
151b2e60773SJohn Baldwin static counter_u64_t ktls_offload_total;
152b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, offload_total,
153b2e60773SJohn Baldwin     CTLFLAG_RD, &ktls_offload_total,
154b2e60773SJohn Baldwin     "Total successful TLS setups (parameters set)");
155b2e60773SJohn Baldwin 
156b2e60773SJohn Baldwin static counter_u64_t ktls_offload_enable_calls;
157b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, enable_calls,
158b2e60773SJohn Baldwin     CTLFLAG_RD, &ktls_offload_enable_calls,
159b2e60773SJohn Baldwin     "Total number of TLS enable calls made");
160b2e60773SJohn Baldwin 
161b2e60773SJohn Baldwin static counter_u64_t ktls_offload_active;
162b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, active, CTLFLAG_RD,
163b2e60773SJohn Baldwin     &ktls_offload_active, "Total Active TLS sessions");
164b2e60773SJohn Baldwin 
1653c0e5685SJohn Baldwin static counter_u64_t ktls_offload_corrupted_records;
1663c0e5685SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, corrupted_records, CTLFLAG_RD,
1673c0e5685SJohn Baldwin     &ktls_offload_corrupted_records, "Total corrupted TLS records received");
1683c0e5685SJohn Baldwin 
169b2e60773SJohn Baldwin static counter_u64_t ktls_offload_failed_crypto;
170b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, failed_crypto, CTLFLAG_RD,
171b2e60773SJohn Baldwin     &ktls_offload_failed_crypto, "Total TLS crypto failures");
172b2e60773SJohn Baldwin 
173b2e60773SJohn Baldwin static counter_u64_t ktls_switch_to_ifnet;
174b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_to_ifnet, CTLFLAG_RD,
175b2e60773SJohn Baldwin     &ktls_switch_to_ifnet, "TLS sessions switched from SW to ifnet");
176b2e60773SJohn Baldwin 
177b2e60773SJohn Baldwin static counter_u64_t ktls_switch_to_sw;
178b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_to_sw, CTLFLAG_RD,
179b2e60773SJohn Baldwin     &ktls_switch_to_sw, "TLS sessions switched from ifnet to SW");
180b2e60773SJohn Baldwin 
181b2e60773SJohn Baldwin static counter_u64_t ktls_switch_failed;
182b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_stats, OID_AUTO, switch_failed, CTLFLAG_RD,
183b2e60773SJohn Baldwin     &ktls_switch_failed, "TLS sessions unable to switch between SW and ifnet");
184b2e60773SJohn Baldwin 
1857029da5cSPawel Biernacki SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, sw, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
186b2e60773SJohn Baldwin     "Software TLS session stats");
1877029da5cSPawel Biernacki SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, ifnet, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
188b2e60773SJohn Baldwin     "Hardware (ifnet) TLS session stats");
1899e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
1907029da5cSPawel Biernacki SYSCTL_NODE(_kern_ipc_tls, OID_AUTO, toe, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
1919e14430dSJohn Baldwin     "TOE TLS session stats");
1929e14430dSJohn Baldwin #endif
193b2e60773SJohn Baldwin 
194b2e60773SJohn Baldwin static counter_u64_t ktls_sw_cbc;
195b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_sw, OID_AUTO, cbc, CTLFLAG_RD, &ktls_sw_cbc,
196b2e60773SJohn Baldwin     "Active number of software TLS sessions using AES-CBC");
197b2e60773SJohn Baldwin 
198b2e60773SJohn Baldwin static counter_u64_t ktls_sw_gcm;
199b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_sw, OID_AUTO, gcm, CTLFLAG_RD, &ktls_sw_gcm,
200b2e60773SJohn Baldwin     "Active number of software TLS sessions using AES-GCM");
201b2e60773SJohn Baldwin 
202b2e60773SJohn Baldwin static counter_u64_t ktls_ifnet_cbc;
203b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, cbc, CTLFLAG_RD,
204b2e60773SJohn Baldwin     &ktls_ifnet_cbc,
205b2e60773SJohn Baldwin     "Active number of ifnet TLS sessions using AES-CBC");
206b2e60773SJohn Baldwin 
207b2e60773SJohn Baldwin static counter_u64_t ktls_ifnet_gcm;
208b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, gcm, CTLFLAG_RD,
209b2e60773SJohn Baldwin     &ktls_ifnet_gcm,
210b2e60773SJohn Baldwin     "Active number of ifnet TLS sessions using AES-GCM");
211b2e60773SJohn Baldwin 
212b2e60773SJohn Baldwin static counter_u64_t ktls_ifnet_reset;
213b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset, CTLFLAG_RD,
214b2e60773SJohn Baldwin     &ktls_ifnet_reset, "TLS sessions updated to a new ifnet send tag");
215b2e60773SJohn Baldwin 
216b2e60773SJohn Baldwin static counter_u64_t ktls_ifnet_reset_dropped;
217b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset_dropped, CTLFLAG_RD,
218b2e60773SJohn Baldwin     &ktls_ifnet_reset_dropped,
219b2e60773SJohn Baldwin     "TLS sessions dropped after failing to update ifnet send tag");
220b2e60773SJohn Baldwin 
221b2e60773SJohn Baldwin static counter_u64_t ktls_ifnet_reset_failed;
222b2e60773SJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_ifnet, OID_AUTO, reset_failed, CTLFLAG_RD,
223b2e60773SJohn Baldwin     &ktls_ifnet_reset_failed,
224b2e60773SJohn Baldwin     "TLS sessions that failed to allocate a new ifnet send tag");
225b2e60773SJohn Baldwin 
226b2e60773SJohn Baldwin static int ktls_ifnet_permitted;
227b2e60773SJohn Baldwin SYSCTL_UINT(_kern_ipc_tls_ifnet, OID_AUTO, permitted, CTLFLAG_RWTUN,
228b2e60773SJohn Baldwin     &ktls_ifnet_permitted, 1,
229b2e60773SJohn Baldwin     "Whether to permit hardware (ifnet) TLS sessions");
230b2e60773SJohn Baldwin 
2319e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
2329e14430dSJohn Baldwin static counter_u64_t ktls_toe_cbc;
2339e14430dSJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_toe, OID_AUTO, cbc, CTLFLAG_RD,
2349e14430dSJohn Baldwin     &ktls_toe_cbc,
2359e14430dSJohn Baldwin     "Active number of TOE TLS sessions using AES-CBC");
2369e14430dSJohn Baldwin 
2379e14430dSJohn Baldwin static counter_u64_t ktls_toe_gcm;
2389e14430dSJohn Baldwin SYSCTL_COUNTER_U64(_kern_ipc_tls_toe, OID_AUTO, gcm, CTLFLAG_RD,
2399e14430dSJohn Baldwin     &ktls_toe_gcm,
2409e14430dSJohn Baldwin     "Active number of TOE TLS sessions using AES-GCM");
2419e14430dSJohn Baldwin #endif
2429e14430dSJohn Baldwin 
243b2e60773SJohn Baldwin static MALLOC_DEFINE(M_KTLS, "ktls", "Kernel TLS");
244b2e60773SJohn Baldwin 
245b2e60773SJohn Baldwin static void ktls_cleanup(struct ktls_session *tls);
246b2e60773SJohn Baldwin #if defined(INET) || defined(INET6)
247b2e60773SJohn Baldwin static void ktls_reset_send_tag(void *context, int pending);
248b2e60773SJohn Baldwin #endif
249b2e60773SJohn Baldwin static void ktls_work_thread(void *ctx);
250b2e60773SJohn Baldwin 
251b2e60773SJohn Baldwin int
252b2e60773SJohn Baldwin ktls_crypto_backend_register(struct ktls_crypto_backend *be)
253b2e60773SJohn Baldwin {
254b2e60773SJohn Baldwin 	struct ktls_crypto_backend *curr_be, *tmp;
255b2e60773SJohn Baldwin 
256b2e60773SJohn Baldwin 	if (be->api_version != KTLS_API_VERSION) {
257b2e60773SJohn Baldwin 		printf("KTLS: API version mismatch (%d vs %d) for %s\n",
258b2e60773SJohn Baldwin 		    be->api_version, KTLS_API_VERSION,
259b2e60773SJohn Baldwin 		    be->name);
260b2e60773SJohn Baldwin 		return (EINVAL);
261b2e60773SJohn Baldwin 	}
262b2e60773SJohn Baldwin 
263b2e60773SJohn Baldwin 	rm_wlock(&ktls_backends_lock);
264b2e60773SJohn Baldwin 	printf("KTLS: Registering crypto method %s with prio %d\n",
265b2e60773SJohn Baldwin 	       be->name, be->prio);
266b2e60773SJohn Baldwin 	if (LIST_EMPTY(&ktls_backends)) {
267b2e60773SJohn Baldwin 		LIST_INSERT_HEAD(&ktls_backends, be, next);
268b2e60773SJohn Baldwin 	} else {
269b2e60773SJohn Baldwin 		LIST_FOREACH_SAFE(curr_be, &ktls_backends, next, tmp) {
270b2e60773SJohn Baldwin 			if (curr_be->prio < be->prio) {
271b2e60773SJohn Baldwin 				LIST_INSERT_BEFORE(curr_be, be, next);
272b2e60773SJohn Baldwin 				break;
273b2e60773SJohn Baldwin 			}
274b2e60773SJohn Baldwin 			if (LIST_NEXT(curr_be, next) == NULL) {
275b2e60773SJohn Baldwin 				LIST_INSERT_AFTER(curr_be, be, next);
276b2e60773SJohn Baldwin 				break;
277b2e60773SJohn Baldwin 			}
278b2e60773SJohn Baldwin 		}
279b2e60773SJohn Baldwin 	}
280b2e60773SJohn Baldwin 	rm_wunlock(&ktls_backends_lock);
281b2e60773SJohn Baldwin 	return (0);
282b2e60773SJohn Baldwin }
283b2e60773SJohn Baldwin 
284b2e60773SJohn Baldwin int
285b2e60773SJohn Baldwin ktls_crypto_backend_deregister(struct ktls_crypto_backend *be)
286b2e60773SJohn Baldwin {
287b2e60773SJohn Baldwin 	struct ktls_crypto_backend *tmp;
288b2e60773SJohn Baldwin 
289b2e60773SJohn Baldwin 	/*
290b2e60773SJohn Baldwin 	 * Don't error if the backend isn't registered.  This permits
291b2e60773SJohn Baldwin 	 * MOD_UNLOAD handlers to use this function unconditionally.
292b2e60773SJohn Baldwin 	 */
293b2e60773SJohn Baldwin 	rm_wlock(&ktls_backends_lock);
294b2e60773SJohn Baldwin 	LIST_FOREACH(tmp, &ktls_backends, next) {
295b2e60773SJohn Baldwin 		if (tmp == be)
296b2e60773SJohn Baldwin 			break;
297b2e60773SJohn Baldwin 	}
298b2e60773SJohn Baldwin 	if (tmp == NULL) {
299b2e60773SJohn Baldwin 		rm_wunlock(&ktls_backends_lock);
300b2e60773SJohn Baldwin 		return (0);
301b2e60773SJohn Baldwin 	}
302b2e60773SJohn Baldwin 
303b2e60773SJohn Baldwin 	if (!ktls_allow_unload) {
304b2e60773SJohn Baldwin 		rm_wunlock(&ktls_backends_lock);
305b2e60773SJohn Baldwin 		printf(
306b2e60773SJohn Baldwin 		    "KTLS: Deregistering crypto method %s is not supported\n",
307b2e60773SJohn Baldwin 		    be->name);
308b2e60773SJohn Baldwin 		return (EBUSY);
309b2e60773SJohn Baldwin 	}
310b2e60773SJohn Baldwin 
311b2e60773SJohn Baldwin 	if (be->use_count) {
312b2e60773SJohn Baldwin 		rm_wunlock(&ktls_backends_lock);
313b2e60773SJohn Baldwin 		return (EBUSY);
314b2e60773SJohn Baldwin 	}
315b2e60773SJohn Baldwin 
316b2e60773SJohn Baldwin 	LIST_REMOVE(be, next);
317b2e60773SJohn Baldwin 	rm_wunlock(&ktls_backends_lock);
318b2e60773SJohn Baldwin 	return (0);
319b2e60773SJohn Baldwin }
320b2e60773SJohn Baldwin 
321b2e60773SJohn Baldwin #if defined(INET) || defined(INET6)
322a2fba2a7SBjoern A. Zeeb static u_int
323b2e60773SJohn Baldwin ktls_get_cpu(struct socket *so)
324b2e60773SJohn Baldwin {
325b2e60773SJohn Baldwin 	struct inpcb *inp;
32602bc3865SAndrew Gallatin #ifdef NUMA
32702bc3865SAndrew Gallatin 	struct ktls_domain_info *di;
32802bc3865SAndrew Gallatin #endif
329a2fba2a7SBjoern A. Zeeb 	u_int cpuid;
330b2e60773SJohn Baldwin 
331b2e60773SJohn Baldwin 	inp = sotoinpcb(so);
332b2e60773SJohn Baldwin #ifdef RSS
333b2e60773SJohn Baldwin 	cpuid = rss_hash2cpuid(inp->inp_flowid, inp->inp_flowtype);
334b2e60773SJohn Baldwin 	if (cpuid != NETISR_CPUID_NONE)
335b2e60773SJohn Baldwin 		return (cpuid);
336b2e60773SJohn Baldwin #endif
337b2e60773SJohn Baldwin 	/*
338b2e60773SJohn Baldwin 	 * Just use the flowid to shard connections in a repeatable
339b2e60773SJohn Baldwin 	 * fashion.  Note that some crypto backends rely on the
340b2e60773SJohn Baldwin 	 * serialization provided by having the same connection use
341b2e60773SJohn Baldwin 	 * the same queue.
342b2e60773SJohn Baldwin 	 */
34302bc3865SAndrew Gallatin #ifdef NUMA
34402bc3865SAndrew Gallatin 	if (ktls_bind_threads > 1 && inp->inp_numa_domain != M_NODOM) {
34502bc3865SAndrew Gallatin 		di = &ktls_domains[inp->inp_numa_domain];
34602bc3865SAndrew Gallatin 		cpuid = di->cpu[inp->inp_flowid % di->count];
34702bc3865SAndrew Gallatin 	} else
34802bc3865SAndrew Gallatin #endif
349b2e60773SJohn Baldwin 		cpuid = ktls_cpuid_lookup[inp->inp_flowid % ktls_number_threads];
350b2e60773SJohn Baldwin 	return (cpuid);
351b2e60773SJohn Baldwin }
352b2e60773SJohn Baldwin #endif
353b2e60773SJohn Baldwin 
354b2e60773SJohn Baldwin static void
355b2e60773SJohn Baldwin ktls_init(void *dummy __unused)
356b2e60773SJohn Baldwin {
357b2e60773SJohn Baldwin 	struct thread *td;
358b2e60773SJohn Baldwin 	struct pcpu *pc;
359b2e60773SJohn Baldwin 	cpuset_t mask;
36002bc3865SAndrew Gallatin 	int count, domain, error, i;
361b2e60773SJohn Baldwin 
362b2e60773SJohn Baldwin 	ktls_tasks_active = counter_u64_alloc(M_WAITOK);
3633c0e5685SJohn Baldwin 	ktls_cnt_tx_queued = counter_u64_alloc(M_WAITOK);
3643c0e5685SJohn Baldwin 	ktls_cnt_rx_queued = counter_u64_alloc(M_WAITOK);
365b2e60773SJohn Baldwin 	ktls_offload_total = counter_u64_alloc(M_WAITOK);
366b2e60773SJohn Baldwin 	ktls_offload_enable_calls = counter_u64_alloc(M_WAITOK);
367b2e60773SJohn Baldwin 	ktls_offload_active = counter_u64_alloc(M_WAITOK);
3683c0e5685SJohn Baldwin 	ktls_offload_corrupted_records = counter_u64_alloc(M_WAITOK);
369b2e60773SJohn Baldwin 	ktls_offload_failed_crypto = counter_u64_alloc(M_WAITOK);
370b2e60773SJohn Baldwin 	ktls_switch_to_ifnet = counter_u64_alloc(M_WAITOK);
371b2e60773SJohn Baldwin 	ktls_switch_to_sw = counter_u64_alloc(M_WAITOK);
372b2e60773SJohn Baldwin 	ktls_switch_failed = counter_u64_alloc(M_WAITOK);
373b2e60773SJohn Baldwin 	ktls_sw_cbc = counter_u64_alloc(M_WAITOK);
374b2e60773SJohn Baldwin 	ktls_sw_gcm = counter_u64_alloc(M_WAITOK);
375b2e60773SJohn Baldwin 	ktls_ifnet_cbc = counter_u64_alloc(M_WAITOK);
376b2e60773SJohn Baldwin 	ktls_ifnet_gcm = counter_u64_alloc(M_WAITOK);
377b2e60773SJohn Baldwin 	ktls_ifnet_reset = counter_u64_alloc(M_WAITOK);
378b2e60773SJohn Baldwin 	ktls_ifnet_reset_dropped = counter_u64_alloc(M_WAITOK);
379b2e60773SJohn Baldwin 	ktls_ifnet_reset_failed = counter_u64_alloc(M_WAITOK);
3809e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
3819e14430dSJohn Baldwin 	ktls_toe_cbc = counter_u64_alloc(M_WAITOK);
3829e14430dSJohn Baldwin 	ktls_toe_gcm = counter_u64_alloc(M_WAITOK);
3839e14430dSJohn Baldwin #endif
384b2e60773SJohn Baldwin 
385b2e60773SJohn Baldwin 	rm_init(&ktls_backends_lock, "ktls backends");
386b2e60773SJohn Baldwin 	LIST_INIT(&ktls_backends);
387b2e60773SJohn Baldwin 
388b2e60773SJohn Baldwin 	ktls_wq = malloc(sizeof(*ktls_wq) * (mp_maxid + 1), M_KTLS,
389b2e60773SJohn Baldwin 	    M_WAITOK | M_ZERO);
390b2e60773SJohn Baldwin 
391b2e60773SJohn Baldwin 	ktls_session_zone = uma_zcreate("ktls_session",
392b2e60773SJohn Baldwin 	    sizeof(struct ktls_session),
393b2e60773SJohn Baldwin 	    NULL, NULL, NULL, NULL,
394b2e60773SJohn Baldwin 	    UMA_ALIGN_CACHE, 0);
395b2e60773SJohn Baldwin 
396b2e60773SJohn Baldwin 	/*
397b2e60773SJohn Baldwin 	 * Initialize the workqueues to run the TLS work.  We create a
398b2e60773SJohn Baldwin 	 * work queue for each CPU.
399b2e60773SJohn Baldwin 	 */
400b2e60773SJohn Baldwin 	CPU_FOREACH(i) {
4013c0e5685SJohn Baldwin 		STAILQ_INIT(&ktls_wq[i].m_head);
4023c0e5685SJohn Baldwin 		STAILQ_INIT(&ktls_wq[i].so_head);
403b2e60773SJohn Baldwin 		mtx_init(&ktls_wq[i].mtx, "ktls work queue", NULL, MTX_DEF);
404b2e60773SJohn Baldwin 		error = kproc_kthread_add(ktls_work_thread, &ktls_wq[i],
40561b8a4afSAndrew Gallatin 		    &ktls_proc, &td, 0, 0, "KTLS", "thr_%d", i);
406b2e60773SJohn Baldwin 		if (error)
407b2e60773SJohn Baldwin 			panic("Can't add KTLS thread %d error %d", i, error);
408b2e60773SJohn Baldwin 
409b2e60773SJohn Baldwin 		/*
410b2e60773SJohn Baldwin 		 * Bind threads to cores.  If ktls_bind_threads is >
411b2e60773SJohn Baldwin 		 * 1, then we bind to the NUMA domain.
412b2e60773SJohn Baldwin 		 */
413b2e60773SJohn Baldwin 		if (ktls_bind_threads) {
414b2e60773SJohn Baldwin 			if (ktls_bind_threads > 1) {
415b2e60773SJohn Baldwin 				pc = pcpu_find(i);
41602bc3865SAndrew Gallatin 				domain = pc->pc_domain;
41702bc3865SAndrew Gallatin 				CPU_COPY(&cpuset_domain[domain], &mask);
41802bc3865SAndrew Gallatin 				count = ktls_domains[domain].count;
41902bc3865SAndrew Gallatin 				ktls_domains[domain].cpu[count] = i;
42002bc3865SAndrew Gallatin 				ktls_domains[domain].count++;
421b2e60773SJohn Baldwin 			} else {
422b2e60773SJohn Baldwin 				CPU_SETOF(i, &mask);
423b2e60773SJohn Baldwin 			}
424b2e60773SJohn Baldwin 			error = cpuset_setthread(td->td_tid, &mask);
425b2e60773SJohn Baldwin 			if (error)
426b2e60773SJohn Baldwin 				panic(
427b2e60773SJohn Baldwin 			    "Unable to bind KTLS thread for CPU %d error %d",
428b2e60773SJohn Baldwin 				     i, error);
429b2e60773SJohn Baldwin 		}
430b2e60773SJohn Baldwin 		ktls_cpuid_lookup[ktls_number_threads] = i;
431b2e60773SJohn Baldwin 		ktls_number_threads++;
432b2e60773SJohn Baldwin 	}
43302bc3865SAndrew Gallatin 
43402bc3865SAndrew Gallatin 	/*
43502bc3865SAndrew Gallatin 	 * If we somehow have an empty domain, fall back to choosing
43602bc3865SAndrew Gallatin 	 * among all KTLS threads.
43702bc3865SAndrew Gallatin 	 */
43802bc3865SAndrew Gallatin 	for (i = 0; i < vm_ndomains; i++) {
43902bc3865SAndrew Gallatin 		if (ktls_domains[i].count == 0) {
44002bc3865SAndrew Gallatin 			ktls_bind_threads = 0;
44102bc3865SAndrew Gallatin 			break;
44202bc3865SAndrew Gallatin 		}
44302bc3865SAndrew Gallatin 	}
44402bc3865SAndrew Gallatin 
445b2e60773SJohn Baldwin 	printf("KTLS: Initialized %d threads\n", ktls_number_threads);
446b2e60773SJohn Baldwin }
447b2e60773SJohn Baldwin SYSINIT(ktls, SI_SUB_SMP + 1, SI_ORDER_ANY, ktls_init, NULL);
448b2e60773SJohn Baldwin 
449b2e60773SJohn Baldwin #if defined(INET) || defined(INET6)
450b2e60773SJohn Baldwin static int
451b2e60773SJohn Baldwin ktls_create_session(struct socket *so, struct tls_enable *en,
452b2e60773SJohn Baldwin     struct ktls_session **tlsp)
453b2e60773SJohn Baldwin {
454b2e60773SJohn Baldwin 	struct ktls_session *tls;
455b2e60773SJohn Baldwin 	int error;
456b2e60773SJohn Baldwin 
4577d29eb9aSJohn Baldwin 	/* Only TLS 1.0 - 1.3 are supported. */
458b2e60773SJohn Baldwin 	if (en->tls_vmajor != TLS_MAJOR_VER_ONE)
459b2e60773SJohn Baldwin 		return (EINVAL);
460b2e60773SJohn Baldwin 	if (en->tls_vminor < TLS_MINOR_VER_ZERO ||
4616554362cSAndrew Gallatin 	    en->tls_vminor > TLS_MINOR_VER_THREE)
462b2e60773SJohn Baldwin 		return (EINVAL);
463b2e60773SJohn Baldwin 
464b2e60773SJohn Baldwin 	if (en->auth_key_len < 0 || en->auth_key_len > TLS_MAX_PARAM_SIZE)
465b2e60773SJohn Baldwin 		return (EINVAL);
466b2e60773SJohn Baldwin 	if (en->cipher_key_len < 0 || en->cipher_key_len > TLS_MAX_PARAM_SIZE)
467b2e60773SJohn Baldwin 		return (EINVAL);
4686554362cSAndrew Gallatin 	if (en->iv_len < 0 || en->iv_len > sizeof(tls->params.iv))
469b2e60773SJohn Baldwin 		return (EINVAL);
470b2e60773SJohn Baldwin 
471b2e60773SJohn Baldwin 	/* All supported algorithms require a cipher key. */
472b2e60773SJohn Baldwin 	if (en->cipher_key_len == 0)
473b2e60773SJohn Baldwin 		return (EINVAL);
474b2e60773SJohn Baldwin 
475b2e60773SJohn Baldwin 	/* No flags are currently supported. */
476b2e60773SJohn Baldwin 	if (en->flags != 0)
477b2e60773SJohn Baldwin 		return (EINVAL);
478b2e60773SJohn Baldwin 
479b2e60773SJohn Baldwin 	/* Common checks for supported algorithms. */
480b2e60773SJohn Baldwin 	switch (en->cipher_algorithm) {
481b2e60773SJohn Baldwin 	case CRYPTO_AES_NIST_GCM_16:
482b2e60773SJohn Baldwin 		/*
483b2e60773SJohn Baldwin 		 * auth_algorithm isn't used, but permit GMAC values
484b2e60773SJohn Baldwin 		 * for compatibility.
485b2e60773SJohn Baldwin 		 */
486b2e60773SJohn Baldwin 		switch (en->auth_algorithm) {
487b2e60773SJohn Baldwin 		case 0:
488c0341432SJohn Baldwin #ifdef COMPAT_FREEBSD12
489c0341432SJohn Baldwin 		/* XXX: Really 13.0-current COMPAT. */
490b2e60773SJohn Baldwin 		case CRYPTO_AES_128_NIST_GMAC:
491b2e60773SJohn Baldwin 		case CRYPTO_AES_192_NIST_GMAC:
492b2e60773SJohn Baldwin 		case CRYPTO_AES_256_NIST_GMAC:
493c0341432SJohn Baldwin #endif
494b2e60773SJohn Baldwin 			break;
495b2e60773SJohn Baldwin 		default:
496b2e60773SJohn Baldwin 			return (EINVAL);
497b2e60773SJohn Baldwin 		}
498b2e60773SJohn Baldwin 		if (en->auth_key_len != 0)
499b2e60773SJohn Baldwin 			return (EINVAL);
5006554362cSAndrew Gallatin 		if ((en->tls_vminor == TLS_MINOR_VER_TWO &&
5016554362cSAndrew Gallatin 			en->iv_len != TLS_AEAD_GCM_LEN) ||
5026554362cSAndrew Gallatin 		    (en->tls_vminor == TLS_MINOR_VER_THREE &&
5036554362cSAndrew Gallatin 			en->iv_len != TLS_1_3_GCM_IV_LEN))
504b2e60773SJohn Baldwin 			return (EINVAL);
505b2e60773SJohn Baldwin 		break;
506b2e60773SJohn Baldwin 	case CRYPTO_AES_CBC:
507b2e60773SJohn Baldwin 		switch (en->auth_algorithm) {
508b2e60773SJohn Baldwin 		case CRYPTO_SHA1_HMAC:
509b2e60773SJohn Baldwin 			/*
510b2e60773SJohn Baldwin 			 * TLS 1.0 requires an implicit IV.  TLS 1.1+
511b2e60773SJohn Baldwin 			 * all use explicit IVs.
512b2e60773SJohn Baldwin 			 */
513b2e60773SJohn Baldwin 			if (en->tls_vminor == TLS_MINOR_VER_ZERO) {
514b2e60773SJohn Baldwin 				if (en->iv_len != TLS_CBC_IMPLICIT_IV_LEN)
515b2e60773SJohn Baldwin 					return (EINVAL);
516b2e60773SJohn Baldwin 				break;
517b2e60773SJohn Baldwin 			}
518b2e60773SJohn Baldwin 
519b2e60773SJohn Baldwin 			/* FALLTHROUGH */
520b2e60773SJohn Baldwin 		case CRYPTO_SHA2_256_HMAC:
521b2e60773SJohn Baldwin 		case CRYPTO_SHA2_384_HMAC:
522b2e60773SJohn Baldwin 			/* Ignore any supplied IV. */
523b2e60773SJohn Baldwin 			en->iv_len = 0;
524b2e60773SJohn Baldwin 			break;
525b2e60773SJohn Baldwin 		default:
526b2e60773SJohn Baldwin 			return (EINVAL);
527b2e60773SJohn Baldwin 		}
528b2e60773SJohn Baldwin 		if (en->auth_key_len == 0)
529b2e60773SJohn Baldwin 			return (EINVAL);
530b2e60773SJohn Baldwin 		break;
531b2e60773SJohn Baldwin 	default:
532b2e60773SJohn Baldwin 		return (EINVAL);
533b2e60773SJohn Baldwin 	}
534b2e60773SJohn Baldwin 
535b2e60773SJohn Baldwin 	tls = uma_zalloc(ktls_session_zone, M_WAITOK | M_ZERO);
536b2e60773SJohn Baldwin 
537b2e60773SJohn Baldwin 	counter_u64_add(ktls_offload_active, 1);
538b2e60773SJohn Baldwin 
539b2e60773SJohn Baldwin 	refcount_init(&tls->refcount, 1);
540b2e60773SJohn Baldwin 	TASK_INIT(&tls->reset_tag_task, 0, ktls_reset_send_tag, tls);
541b2e60773SJohn Baldwin 
542b2e60773SJohn Baldwin 	tls->wq_index = ktls_get_cpu(so);
543b2e60773SJohn Baldwin 
544b2e60773SJohn Baldwin 	tls->params.cipher_algorithm = en->cipher_algorithm;
545b2e60773SJohn Baldwin 	tls->params.auth_algorithm = en->auth_algorithm;
546b2e60773SJohn Baldwin 	tls->params.tls_vmajor = en->tls_vmajor;
547b2e60773SJohn Baldwin 	tls->params.tls_vminor = en->tls_vminor;
548b2e60773SJohn Baldwin 	tls->params.flags = en->flags;
549b2e60773SJohn Baldwin 	tls->params.max_frame_len = min(TLS_MAX_MSG_SIZE_V10_2, ktls_maxlen);
550b2e60773SJohn Baldwin 
551b2e60773SJohn Baldwin 	/* Set the header and trailer lengths. */
552b2e60773SJohn Baldwin 	tls->params.tls_hlen = sizeof(struct tls_record_layer);
553b2e60773SJohn Baldwin 	switch (en->cipher_algorithm) {
554b2e60773SJohn Baldwin 	case CRYPTO_AES_NIST_GCM_16:
5556554362cSAndrew Gallatin 		/*
5566554362cSAndrew Gallatin 		 * TLS 1.2 uses a 4 byte implicit IV with an explicit 8 byte
5576554362cSAndrew Gallatin 		 * nonce.  TLS 1.3 uses a 12 byte implicit IV.
5586554362cSAndrew Gallatin 		 */
5596554362cSAndrew Gallatin 		if (en->tls_vminor < TLS_MINOR_VER_THREE)
5606554362cSAndrew Gallatin 			tls->params.tls_hlen += sizeof(uint64_t);
561b2e60773SJohn Baldwin 		tls->params.tls_tlen = AES_GMAC_HASH_LEN;
5626554362cSAndrew Gallatin 
5636554362cSAndrew Gallatin 		/*
5646554362cSAndrew Gallatin 		 * TLS 1.3 includes optional padding which we
5656554362cSAndrew Gallatin 		 * do not support, and also puts the "real" record
5666554362cSAndrew Gallatin 		 * type at the end of the encrypted data.
5676554362cSAndrew Gallatin 		 */
5686554362cSAndrew Gallatin 		if (en->tls_vminor == TLS_MINOR_VER_THREE)
5696554362cSAndrew Gallatin 			tls->params.tls_tlen += sizeof(uint8_t);
5706554362cSAndrew Gallatin 
571b2e60773SJohn Baldwin 		tls->params.tls_bs = 1;
572b2e60773SJohn Baldwin 		break;
573b2e60773SJohn Baldwin 	case CRYPTO_AES_CBC:
574b2e60773SJohn Baldwin 		switch (en->auth_algorithm) {
575b2e60773SJohn Baldwin 		case CRYPTO_SHA1_HMAC:
576b2e60773SJohn Baldwin 			if (en->tls_vminor == TLS_MINOR_VER_ZERO) {
577b2e60773SJohn Baldwin 				/* Implicit IV, no nonce. */
578b2e60773SJohn Baldwin 			} else {
579b2e60773SJohn Baldwin 				tls->params.tls_hlen += AES_BLOCK_LEN;
580b2e60773SJohn Baldwin 			}
581b2e60773SJohn Baldwin 			tls->params.tls_tlen = AES_BLOCK_LEN +
582b2e60773SJohn Baldwin 			    SHA1_HASH_LEN;
583b2e60773SJohn Baldwin 			break;
584b2e60773SJohn Baldwin 		case CRYPTO_SHA2_256_HMAC:
585b2e60773SJohn Baldwin 			tls->params.tls_hlen += AES_BLOCK_LEN;
586b2e60773SJohn Baldwin 			tls->params.tls_tlen = AES_BLOCK_LEN +
587b2e60773SJohn Baldwin 			    SHA2_256_HASH_LEN;
588b2e60773SJohn Baldwin 			break;
589b2e60773SJohn Baldwin 		case CRYPTO_SHA2_384_HMAC:
590b2e60773SJohn Baldwin 			tls->params.tls_hlen += AES_BLOCK_LEN;
591b2e60773SJohn Baldwin 			tls->params.tls_tlen = AES_BLOCK_LEN +
592b2e60773SJohn Baldwin 			    SHA2_384_HASH_LEN;
593b2e60773SJohn Baldwin 			break;
594b2e60773SJohn Baldwin 		default:
595b2e60773SJohn Baldwin 			panic("invalid hmac");
596b2e60773SJohn Baldwin 		}
597b2e60773SJohn Baldwin 		tls->params.tls_bs = AES_BLOCK_LEN;
598b2e60773SJohn Baldwin 		break;
599b2e60773SJohn Baldwin 	default:
600b2e60773SJohn Baldwin 		panic("invalid cipher");
601b2e60773SJohn Baldwin 	}
602b2e60773SJohn Baldwin 
603b2e60773SJohn Baldwin 	KASSERT(tls->params.tls_hlen <= MBUF_PEXT_HDR_LEN,
604b2e60773SJohn Baldwin 	    ("TLS header length too long: %d", tls->params.tls_hlen));
605b2e60773SJohn Baldwin 	KASSERT(tls->params.tls_tlen <= MBUF_PEXT_TRAIL_LEN,
606b2e60773SJohn Baldwin 	    ("TLS trailer length too long: %d", tls->params.tls_tlen));
607b2e60773SJohn Baldwin 
608b2e60773SJohn Baldwin 	if (en->auth_key_len != 0) {
609b2e60773SJohn Baldwin 		tls->params.auth_key_len = en->auth_key_len;
610b2e60773SJohn Baldwin 		tls->params.auth_key = malloc(en->auth_key_len, M_KTLS,
611b2e60773SJohn Baldwin 		    M_WAITOK);
612b2e60773SJohn Baldwin 		error = copyin(en->auth_key, tls->params.auth_key,
613b2e60773SJohn Baldwin 		    en->auth_key_len);
614b2e60773SJohn Baldwin 		if (error)
615b2e60773SJohn Baldwin 			goto out;
616b2e60773SJohn Baldwin 	}
617b2e60773SJohn Baldwin 
618b2e60773SJohn Baldwin 	tls->params.cipher_key_len = en->cipher_key_len;
619b2e60773SJohn Baldwin 	tls->params.cipher_key = malloc(en->cipher_key_len, M_KTLS, M_WAITOK);
620b2e60773SJohn Baldwin 	error = copyin(en->cipher_key, tls->params.cipher_key,
621b2e60773SJohn Baldwin 	    en->cipher_key_len);
622b2e60773SJohn Baldwin 	if (error)
623b2e60773SJohn Baldwin 		goto out;
624b2e60773SJohn Baldwin 
625b2e60773SJohn Baldwin 	/*
626b2e60773SJohn Baldwin 	 * This holds the implicit portion of the nonce for GCM and
627b2e60773SJohn Baldwin 	 * the initial implicit IV for TLS 1.0.  The explicit portions
6287d29eb9aSJohn Baldwin 	 * of the IV are generated in ktls_frame().
629b2e60773SJohn Baldwin 	 */
630b2e60773SJohn Baldwin 	if (en->iv_len != 0) {
631b2e60773SJohn Baldwin 		tls->params.iv_len = en->iv_len;
632b2e60773SJohn Baldwin 		error = copyin(en->iv, tls->params.iv, en->iv_len);
633b2e60773SJohn Baldwin 		if (error)
634b2e60773SJohn Baldwin 			goto out;
6357d29eb9aSJohn Baldwin 
6367d29eb9aSJohn Baldwin 		/*
6377d29eb9aSJohn Baldwin 		 * For TLS 1.2, generate an 8-byte nonce as a counter
6387d29eb9aSJohn Baldwin 		 * to generate unique explicit IVs.
6397d29eb9aSJohn Baldwin 		 *
6407d29eb9aSJohn Baldwin 		 * Store this counter in the last 8 bytes of the IV
6417d29eb9aSJohn Baldwin 		 * array so that it is 8-byte aligned.
6427d29eb9aSJohn Baldwin 		 */
6437d29eb9aSJohn Baldwin 		if (en->cipher_algorithm == CRYPTO_AES_NIST_GCM_16 &&
6447d29eb9aSJohn Baldwin 		    en->tls_vminor == TLS_MINOR_VER_TWO)
6457d29eb9aSJohn Baldwin 			arc4rand(tls->params.iv + 8, sizeof(uint64_t), 0);
646b2e60773SJohn Baldwin 	}
647b2e60773SJohn Baldwin 
648b2e60773SJohn Baldwin 	*tlsp = tls;
649b2e60773SJohn Baldwin 	return (0);
650b2e60773SJohn Baldwin 
651b2e60773SJohn Baldwin out:
652b2e60773SJohn Baldwin 	ktls_cleanup(tls);
653b2e60773SJohn Baldwin 	return (error);
654b2e60773SJohn Baldwin }
655b2e60773SJohn Baldwin 
656b2e60773SJohn Baldwin static struct ktls_session *
657b2e60773SJohn Baldwin ktls_clone_session(struct ktls_session *tls)
658b2e60773SJohn Baldwin {
659b2e60773SJohn Baldwin 	struct ktls_session *tls_new;
660b2e60773SJohn Baldwin 
661b2e60773SJohn Baldwin 	tls_new = uma_zalloc(ktls_session_zone, M_WAITOK | M_ZERO);
662b2e60773SJohn Baldwin 
663b2e60773SJohn Baldwin 	counter_u64_add(ktls_offload_active, 1);
664b2e60773SJohn Baldwin 
665b2e60773SJohn Baldwin 	refcount_init(&tls_new->refcount, 1);
666b2e60773SJohn Baldwin 
667b2e60773SJohn Baldwin 	/* Copy fields from existing session. */
668b2e60773SJohn Baldwin 	tls_new->params = tls->params;
669b2e60773SJohn Baldwin 	tls_new->wq_index = tls->wq_index;
670b2e60773SJohn Baldwin 
671b2e60773SJohn Baldwin 	/* Deep copy keys. */
672b2e60773SJohn Baldwin 	if (tls_new->params.auth_key != NULL) {
673b2e60773SJohn Baldwin 		tls_new->params.auth_key = malloc(tls->params.auth_key_len,
674b2e60773SJohn Baldwin 		    M_KTLS, M_WAITOK);
675b2e60773SJohn Baldwin 		memcpy(tls_new->params.auth_key, tls->params.auth_key,
676b2e60773SJohn Baldwin 		    tls->params.auth_key_len);
677b2e60773SJohn Baldwin 	}
678b2e60773SJohn Baldwin 
679b2e60773SJohn Baldwin 	tls_new->params.cipher_key = malloc(tls->params.cipher_key_len, M_KTLS,
680b2e60773SJohn Baldwin 	    M_WAITOK);
681b2e60773SJohn Baldwin 	memcpy(tls_new->params.cipher_key, tls->params.cipher_key,
682b2e60773SJohn Baldwin 	    tls->params.cipher_key_len);
683b2e60773SJohn Baldwin 
684b2e60773SJohn Baldwin 	return (tls_new);
685b2e60773SJohn Baldwin }
686b2e60773SJohn Baldwin #endif
687b2e60773SJohn Baldwin 
688b2e60773SJohn Baldwin static void
689b2e60773SJohn Baldwin ktls_cleanup(struct ktls_session *tls)
690b2e60773SJohn Baldwin {
691b2e60773SJohn Baldwin 
692b2e60773SJohn Baldwin 	counter_u64_add(ktls_offload_active, -1);
6939e14430dSJohn Baldwin 	switch (tls->mode) {
6949e14430dSJohn Baldwin 	case TCP_TLS_MODE_SW:
695b2e60773SJohn Baldwin 		MPASS(tls->be != NULL);
696b2e60773SJohn Baldwin 		switch (tls->params.cipher_algorithm) {
697b2e60773SJohn Baldwin 		case CRYPTO_AES_CBC:
698b2e60773SJohn Baldwin 			counter_u64_add(ktls_sw_cbc, -1);
699b2e60773SJohn Baldwin 			break;
700b2e60773SJohn Baldwin 		case CRYPTO_AES_NIST_GCM_16:
701b2e60773SJohn Baldwin 			counter_u64_add(ktls_sw_gcm, -1);
702b2e60773SJohn Baldwin 			break;
703b2e60773SJohn Baldwin 		}
704b2e60773SJohn Baldwin 		tls->free(tls);
7059e14430dSJohn Baldwin 		break;
7069e14430dSJohn Baldwin 	case TCP_TLS_MODE_IFNET:
707b2e60773SJohn Baldwin 		switch (tls->params.cipher_algorithm) {
708b2e60773SJohn Baldwin 		case CRYPTO_AES_CBC:
709b2e60773SJohn Baldwin 			counter_u64_add(ktls_ifnet_cbc, -1);
710b2e60773SJohn Baldwin 			break;
711b2e60773SJohn Baldwin 		case CRYPTO_AES_NIST_GCM_16:
712b2e60773SJohn Baldwin 			counter_u64_add(ktls_ifnet_gcm, -1);
713b2e60773SJohn Baldwin 			break;
714b2e60773SJohn Baldwin 		}
7159675d889SAndrew Gallatin 		if (tls->snd_tag != NULL)
716b2e60773SJohn Baldwin 			m_snd_tag_rele(tls->snd_tag);
7179e14430dSJohn Baldwin 		break;
7189e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
7199e14430dSJohn Baldwin 	case TCP_TLS_MODE_TOE:
7209e14430dSJohn Baldwin 		switch (tls->params.cipher_algorithm) {
7219e14430dSJohn Baldwin 		case CRYPTO_AES_CBC:
7229e14430dSJohn Baldwin 			counter_u64_add(ktls_toe_cbc, -1);
7239e14430dSJohn Baldwin 			break;
7249e14430dSJohn Baldwin 		case CRYPTO_AES_NIST_GCM_16:
7259e14430dSJohn Baldwin 			counter_u64_add(ktls_toe_gcm, -1);
7269e14430dSJohn Baldwin 			break;
7279e14430dSJohn Baldwin 		}
7289e14430dSJohn Baldwin 		break;
7299e14430dSJohn Baldwin #endif
730b2e60773SJohn Baldwin 	}
731b2e60773SJohn Baldwin 	if (tls->params.auth_key != NULL) {
7324a711b8dSJohn Baldwin 		zfree(tls->params.auth_key, M_KTLS);
733b2e60773SJohn Baldwin 		tls->params.auth_key = NULL;
734b2e60773SJohn Baldwin 		tls->params.auth_key_len = 0;
735b2e60773SJohn Baldwin 	}
736b2e60773SJohn Baldwin 	if (tls->params.cipher_key != NULL) {
7374a711b8dSJohn Baldwin 		zfree(tls->params.cipher_key, M_KTLS);
738b2e60773SJohn Baldwin 		tls->params.cipher_key = NULL;
739b2e60773SJohn Baldwin 		tls->params.cipher_key_len = 0;
740b2e60773SJohn Baldwin 	}
741b2e60773SJohn Baldwin 	explicit_bzero(tls->params.iv, sizeof(tls->params.iv));
742b2e60773SJohn Baldwin }
743b2e60773SJohn Baldwin 
744b2e60773SJohn Baldwin #if defined(INET) || defined(INET6)
7459e14430dSJohn Baldwin 
7469e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
7479e14430dSJohn Baldwin static int
748f1f93475SJohn Baldwin ktls_try_toe(struct socket *so, struct ktls_session *tls, int direction)
7499e14430dSJohn Baldwin {
7509e14430dSJohn Baldwin 	struct inpcb *inp;
7519e14430dSJohn Baldwin 	struct tcpcb *tp;
7529e14430dSJohn Baldwin 	int error;
7539e14430dSJohn Baldwin 
7549e14430dSJohn Baldwin 	inp = so->so_pcb;
7559e14430dSJohn Baldwin 	INP_WLOCK(inp);
7569e14430dSJohn Baldwin 	if (inp->inp_flags2 & INP_FREED) {
7579e14430dSJohn Baldwin 		INP_WUNLOCK(inp);
7589e14430dSJohn Baldwin 		return (ECONNRESET);
7599e14430dSJohn Baldwin 	}
7609e14430dSJohn Baldwin 	if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
7619e14430dSJohn Baldwin 		INP_WUNLOCK(inp);
7629e14430dSJohn Baldwin 		return (ECONNRESET);
7639e14430dSJohn Baldwin 	}
7649e14430dSJohn Baldwin 	if (inp->inp_socket == NULL) {
7659e14430dSJohn Baldwin 		INP_WUNLOCK(inp);
7669e14430dSJohn Baldwin 		return (ECONNRESET);
7679e14430dSJohn Baldwin 	}
7689e14430dSJohn Baldwin 	tp = intotcpcb(inp);
7696bcf3c46SJohn Baldwin 	if (!(tp->t_flags & TF_TOE)) {
7709e14430dSJohn Baldwin 		INP_WUNLOCK(inp);
7719e14430dSJohn Baldwin 		return (EOPNOTSUPP);
7729e14430dSJohn Baldwin 	}
7739e14430dSJohn Baldwin 
774f1f93475SJohn Baldwin 	error = tcp_offload_alloc_tls_session(tp, tls, direction);
7759e14430dSJohn Baldwin 	INP_WUNLOCK(inp);
7769e14430dSJohn Baldwin 	if (error == 0) {
7779e14430dSJohn Baldwin 		tls->mode = TCP_TLS_MODE_TOE;
7789e14430dSJohn Baldwin 		switch (tls->params.cipher_algorithm) {
7799e14430dSJohn Baldwin 		case CRYPTO_AES_CBC:
7809e14430dSJohn Baldwin 			counter_u64_add(ktls_toe_cbc, 1);
7819e14430dSJohn Baldwin 			break;
7829e14430dSJohn Baldwin 		case CRYPTO_AES_NIST_GCM_16:
7839e14430dSJohn Baldwin 			counter_u64_add(ktls_toe_gcm, 1);
7849e14430dSJohn Baldwin 			break;
7859e14430dSJohn Baldwin 		}
7869e14430dSJohn Baldwin 	}
7879e14430dSJohn Baldwin 	return (error);
7889e14430dSJohn Baldwin }
7899e14430dSJohn Baldwin #endif
7909e14430dSJohn Baldwin 
791b2e60773SJohn Baldwin /*
792b2e60773SJohn Baldwin  * Common code used when first enabling ifnet TLS on a connection or
793b2e60773SJohn Baldwin  * when allocating a new ifnet TLS session due to a routing change.
794b2e60773SJohn Baldwin  * This function allocates a new TLS send tag on whatever interface
795b2e60773SJohn Baldwin  * the connection is currently routed over.
796b2e60773SJohn Baldwin  */
797b2e60773SJohn Baldwin static int
798b2e60773SJohn Baldwin ktls_alloc_snd_tag(struct inpcb *inp, struct ktls_session *tls, bool force,
799b2e60773SJohn Baldwin     struct m_snd_tag **mstp)
800b2e60773SJohn Baldwin {
801b2e60773SJohn Baldwin 	union if_snd_tag_alloc_params params;
802b2e60773SJohn Baldwin 	struct ifnet *ifp;
803983066f0SAlexander V. Chernikov 	struct nhop_object *nh;
804b2e60773SJohn Baldwin 	struct tcpcb *tp;
805b2e60773SJohn Baldwin 	int error;
806b2e60773SJohn Baldwin 
807b2e60773SJohn Baldwin 	INP_RLOCK(inp);
808b2e60773SJohn Baldwin 	if (inp->inp_flags2 & INP_FREED) {
809b2e60773SJohn Baldwin 		INP_RUNLOCK(inp);
810b2e60773SJohn Baldwin 		return (ECONNRESET);
811b2e60773SJohn Baldwin 	}
812b2e60773SJohn Baldwin 	if (inp->inp_flags & (INP_TIMEWAIT | INP_DROPPED)) {
813b2e60773SJohn Baldwin 		INP_RUNLOCK(inp);
814b2e60773SJohn Baldwin 		return (ECONNRESET);
815b2e60773SJohn Baldwin 	}
816b2e60773SJohn Baldwin 	if (inp->inp_socket == NULL) {
817b2e60773SJohn Baldwin 		INP_RUNLOCK(inp);
818b2e60773SJohn Baldwin 		return (ECONNRESET);
819b2e60773SJohn Baldwin 	}
820b2e60773SJohn Baldwin 	tp = intotcpcb(inp);
821b2e60773SJohn Baldwin 
822b2e60773SJohn Baldwin 	/*
823b2e60773SJohn Baldwin 	 * Check administrative controls on ifnet TLS to determine if
824b2e60773SJohn Baldwin 	 * ifnet TLS should be denied.
825b2e60773SJohn Baldwin 	 *
826b2e60773SJohn Baldwin 	 * - Always permit 'force' requests.
827b2e60773SJohn Baldwin 	 * - ktls_ifnet_permitted == 0: always deny.
828b2e60773SJohn Baldwin 	 */
829b2e60773SJohn Baldwin 	if (!force && ktls_ifnet_permitted == 0) {
830b2e60773SJohn Baldwin 		INP_RUNLOCK(inp);
831b2e60773SJohn Baldwin 		return (ENXIO);
832b2e60773SJohn Baldwin 	}
833b2e60773SJohn Baldwin 
834b2e60773SJohn Baldwin 	/*
835b2e60773SJohn Baldwin 	 * XXX: Use the cached route in the inpcb to find the
836b2e60773SJohn Baldwin 	 * interface.  This should perhaps instead use
837b2e60773SJohn Baldwin 	 * rtalloc1_fib(dst, 0, 0, fibnum).  Since KTLS is only
838b2e60773SJohn Baldwin 	 * enabled after a connection has completed key negotiation in
839b2e60773SJohn Baldwin 	 * userland, the cached route will be present in practice.
840b2e60773SJohn Baldwin 	 */
841983066f0SAlexander V. Chernikov 	nh = inp->inp_route.ro_nh;
842983066f0SAlexander V. Chernikov 	if (nh == NULL) {
843b2e60773SJohn Baldwin 		INP_RUNLOCK(inp);
844b2e60773SJohn Baldwin 		return (ENXIO);
845b2e60773SJohn Baldwin 	}
846983066f0SAlexander V. Chernikov 	ifp = nh->nh_ifp;
847b2e60773SJohn Baldwin 	if_ref(ifp);
848b2e60773SJohn Baldwin 
849521eac97SJohn Baldwin 	/*
850521eac97SJohn Baldwin 	 * Allocate a TLS + ratelimit tag if the connection has an
851521eac97SJohn Baldwin 	 * existing pacing rate.
852521eac97SJohn Baldwin 	 */
853521eac97SJohn Baldwin 	if (tp->t_pacing_rate != -1 &&
854521eac97SJohn Baldwin 	    (ifp->if_capenable & IFCAP_TXTLS_RTLMT) != 0) {
855521eac97SJohn Baldwin 		params.hdr.type = IF_SND_TAG_TYPE_TLS_RATE_LIMIT;
856521eac97SJohn Baldwin 		params.tls_rate_limit.inp = inp;
857521eac97SJohn Baldwin 		params.tls_rate_limit.tls = tls;
858521eac97SJohn Baldwin 		params.tls_rate_limit.max_rate = tp->t_pacing_rate;
859521eac97SJohn Baldwin 	} else {
860b2e60773SJohn Baldwin 		params.hdr.type = IF_SND_TAG_TYPE_TLS;
861521eac97SJohn Baldwin 		params.tls.inp = inp;
862521eac97SJohn Baldwin 		params.tls.tls = tls;
863521eac97SJohn Baldwin 	}
864b2e60773SJohn Baldwin 	params.hdr.flowid = inp->inp_flowid;
865b2e60773SJohn Baldwin 	params.hdr.flowtype = inp->inp_flowtype;
86698085baeSAndrew Gallatin 	params.hdr.numa_domain = inp->inp_numa_domain;
867b2e60773SJohn Baldwin 	INP_RUNLOCK(inp);
868b2e60773SJohn Baldwin 
869b2e60773SJohn Baldwin 	if ((ifp->if_capenable & IFCAP_NOMAP) == 0) {
870b2e60773SJohn Baldwin 		error = EOPNOTSUPP;
871b2e60773SJohn Baldwin 		goto out;
872b2e60773SJohn Baldwin 	}
873b2e60773SJohn Baldwin 	if (inp->inp_vflag & INP_IPV6) {
874b2e60773SJohn Baldwin 		if ((ifp->if_capenable & IFCAP_TXTLS6) == 0) {
875b2e60773SJohn Baldwin 			error = EOPNOTSUPP;
876b2e60773SJohn Baldwin 			goto out;
877b2e60773SJohn Baldwin 		}
878b2e60773SJohn Baldwin 	} else {
879b2e60773SJohn Baldwin 		if ((ifp->if_capenable & IFCAP_TXTLS4) == 0) {
880b2e60773SJohn Baldwin 			error = EOPNOTSUPP;
881b2e60773SJohn Baldwin 			goto out;
882b2e60773SJohn Baldwin 		}
883b2e60773SJohn Baldwin 	}
88436e0a362SJohn Baldwin 	error = m_snd_tag_alloc(ifp, &params, mstp);
885b2e60773SJohn Baldwin out:
886b2e60773SJohn Baldwin 	if_rele(ifp);
887b2e60773SJohn Baldwin 	return (error);
888b2e60773SJohn Baldwin }
889b2e60773SJohn Baldwin 
890b2e60773SJohn Baldwin static int
891b2e60773SJohn Baldwin ktls_try_ifnet(struct socket *so, struct ktls_session *tls, bool force)
892b2e60773SJohn Baldwin {
893b2e60773SJohn Baldwin 	struct m_snd_tag *mst;
894b2e60773SJohn Baldwin 	int error;
895b2e60773SJohn Baldwin 
896b2e60773SJohn Baldwin 	error = ktls_alloc_snd_tag(so->so_pcb, tls, force, &mst);
897b2e60773SJohn Baldwin 	if (error == 0) {
8989e14430dSJohn Baldwin 		tls->mode = TCP_TLS_MODE_IFNET;
899b2e60773SJohn Baldwin 		tls->snd_tag = mst;
900b2e60773SJohn Baldwin 		switch (tls->params.cipher_algorithm) {
901b2e60773SJohn Baldwin 		case CRYPTO_AES_CBC:
902b2e60773SJohn Baldwin 			counter_u64_add(ktls_ifnet_cbc, 1);
903b2e60773SJohn Baldwin 			break;
904b2e60773SJohn Baldwin 		case CRYPTO_AES_NIST_GCM_16:
905b2e60773SJohn Baldwin 			counter_u64_add(ktls_ifnet_gcm, 1);
906b2e60773SJohn Baldwin 			break;
907b2e60773SJohn Baldwin 		}
908b2e60773SJohn Baldwin 	}
909b2e60773SJohn Baldwin 	return (error);
910b2e60773SJohn Baldwin }
911b2e60773SJohn Baldwin 
912b2e60773SJohn Baldwin static int
9133c0e5685SJohn Baldwin ktls_try_sw(struct socket *so, struct ktls_session *tls, int direction)
914b2e60773SJohn Baldwin {
915b2e60773SJohn Baldwin 	struct rm_priotracker prio;
916b2e60773SJohn Baldwin 	struct ktls_crypto_backend *be;
917b2e60773SJohn Baldwin 
918b2e60773SJohn Baldwin 	/*
919b2e60773SJohn Baldwin 	 * Choose the best software crypto backend.  Backends are
920b2e60773SJohn Baldwin 	 * stored in sorted priority order (larget value == most
921b2e60773SJohn Baldwin 	 * important at the head of the list), so this just stops on
922b2e60773SJohn Baldwin 	 * the first backend that claims the session by returning
923b2e60773SJohn Baldwin 	 * success.
924b2e60773SJohn Baldwin 	 */
925b2e60773SJohn Baldwin 	if (ktls_allow_unload)
926b2e60773SJohn Baldwin 		rm_rlock(&ktls_backends_lock, &prio);
927b2e60773SJohn Baldwin 	LIST_FOREACH(be, &ktls_backends, next) {
9283c0e5685SJohn Baldwin 		if (be->try(so, tls, direction) == 0)
929b2e60773SJohn Baldwin 			break;
930b2e60773SJohn Baldwin 		KASSERT(tls->cipher == NULL,
931b2e60773SJohn Baldwin 		    ("ktls backend leaked a cipher pointer"));
932b2e60773SJohn Baldwin 	}
933b2e60773SJohn Baldwin 	if (be != NULL) {
934b2e60773SJohn Baldwin 		if (ktls_allow_unload)
935b2e60773SJohn Baldwin 			be->use_count++;
936b2e60773SJohn Baldwin 		tls->be = be;
937b2e60773SJohn Baldwin 	}
938b2e60773SJohn Baldwin 	if (ktls_allow_unload)
939b2e60773SJohn Baldwin 		rm_runlock(&ktls_backends_lock, &prio);
940b2e60773SJohn Baldwin 	if (be == NULL)
941b2e60773SJohn Baldwin 		return (EOPNOTSUPP);
9429e14430dSJohn Baldwin 	tls->mode = TCP_TLS_MODE_SW;
943b2e60773SJohn Baldwin 	switch (tls->params.cipher_algorithm) {
944b2e60773SJohn Baldwin 	case CRYPTO_AES_CBC:
945b2e60773SJohn Baldwin 		counter_u64_add(ktls_sw_cbc, 1);
946b2e60773SJohn Baldwin 		break;
947b2e60773SJohn Baldwin 	case CRYPTO_AES_NIST_GCM_16:
948b2e60773SJohn Baldwin 		counter_u64_add(ktls_sw_gcm, 1);
949b2e60773SJohn Baldwin 		break;
950b2e60773SJohn Baldwin 	}
951b2e60773SJohn Baldwin 	return (0);
952b2e60773SJohn Baldwin }
953b2e60773SJohn Baldwin 
9543c0e5685SJohn Baldwin /*
9553c0e5685SJohn Baldwin  * KTLS RX stores data in the socket buffer as a list of TLS records,
9563c0e5685SJohn Baldwin  * where each record is stored as a control message containg the TLS
9573c0e5685SJohn Baldwin  * header followed by data mbufs containing the decrypted data.  This
9583c0e5685SJohn Baldwin  * is different from KTLS TX which always uses an mb_ext_pgs mbuf for
9593c0e5685SJohn Baldwin  * both encrypted and decrypted data.  TLS records decrypted by a NIC
9603c0e5685SJohn Baldwin  * should be queued to the socket buffer as records, but encrypted
9613c0e5685SJohn Baldwin  * data which needs to be decrypted by software arrives as a stream of
9623c0e5685SJohn Baldwin  * regular mbufs which need to be converted.  In addition, there may
9633c0e5685SJohn Baldwin  * already be pending encrypted data in the socket buffer when KTLS RX
9643c0e5685SJohn Baldwin  * is enabled.
9653c0e5685SJohn Baldwin  *
9663c0e5685SJohn Baldwin  * To manage not-yet-decrypted data for KTLS RX, the following scheme
9673c0e5685SJohn Baldwin  * is used:
9683c0e5685SJohn Baldwin  *
9693c0e5685SJohn Baldwin  * - A single chain of NOTREADY mbufs is hung off of sb_mtls.
9703c0e5685SJohn Baldwin  *
9713c0e5685SJohn Baldwin  * - ktls_check_rx checks this chain of mbufs reading the TLS header
9723c0e5685SJohn Baldwin  *   from the first mbuf.  Once all of the data for that TLS record is
9733c0e5685SJohn Baldwin  *   queued, the socket is queued to a worker thread.
9743c0e5685SJohn Baldwin  *
9753c0e5685SJohn Baldwin  * - The worker thread calls ktls_decrypt to decrypt TLS records in
9763c0e5685SJohn Baldwin  *   the TLS chain.  Each TLS record is detached from the TLS chain,
9773c0e5685SJohn Baldwin  *   decrypted, and inserted into the regular socket buffer chain as
9783c0e5685SJohn Baldwin  *   record starting with a control message holding the TLS header and
9793c0e5685SJohn Baldwin  *   a chain of mbufs holding the encrypted data.
9803c0e5685SJohn Baldwin  */
9813c0e5685SJohn Baldwin 
9823c0e5685SJohn Baldwin static void
9833c0e5685SJohn Baldwin sb_mark_notready(struct sockbuf *sb)
9843c0e5685SJohn Baldwin {
9853c0e5685SJohn Baldwin 	struct mbuf *m;
9863c0e5685SJohn Baldwin 
9873c0e5685SJohn Baldwin 	m = sb->sb_mb;
9883c0e5685SJohn Baldwin 	sb->sb_mtls = m;
9893c0e5685SJohn Baldwin 	sb->sb_mb = NULL;
9903c0e5685SJohn Baldwin 	sb->sb_mbtail = NULL;
9913c0e5685SJohn Baldwin 	sb->sb_lastrecord = NULL;
9923c0e5685SJohn Baldwin 	for (; m != NULL; m = m->m_next) {
9933c0e5685SJohn Baldwin 		KASSERT(m->m_nextpkt == NULL, ("%s: m_nextpkt != NULL",
9943c0e5685SJohn Baldwin 		    __func__));
9953c0e5685SJohn Baldwin 		KASSERT((m->m_flags & M_NOTAVAIL) == 0, ("%s: mbuf not avail",
9963c0e5685SJohn Baldwin 		    __func__));
9973c0e5685SJohn Baldwin 		KASSERT(sb->sb_acc >= m->m_len, ("%s: sb_acc < m->m_len",
9983c0e5685SJohn Baldwin 		    __func__));
9993c0e5685SJohn Baldwin 		m->m_flags |= M_NOTREADY;
10003c0e5685SJohn Baldwin 		sb->sb_acc -= m->m_len;
10013c0e5685SJohn Baldwin 		sb->sb_tlscc += m->m_len;
10023c0e5685SJohn Baldwin 		sb->sb_mtlstail = m;
10033c0e5685SJohn Baldwin 	}
10043c0e5685SJohn Baldwin 	KASSERT(sb->sb_acc == 0 && sb->sb_tlscc == sb->sb_ccc,
10053c0e5685SJohn Baldwin 	    ("%s: acc %u tlscc %u ccc %u", __func__, sb->sb_acc, sb->sb_tlscc,
10063c0e5685SJohn Baldwin 	    sb->sb_ccc));
10073c0e5685SJohn Baldwin }
10083c0e5685SJohn Baldwin 
1009b2e60773SJohn Baldwin int
1010f1f93475SJohn Baldwin ktls_enable_rx(struct socket *so, struct tls_enable *en)
1011f1f93475SJohn Baldwin {
1012f1f93475SJohn Baldwin 	struct ktls_session *tls;
1013f1f93475SJohn Baldwin 	int error;
1014f1f93475SJohn Baldwin 
1015f1f93475SJohn Baldwin 	if (!ktls_offload_enable)
1016f1f93475SJohn Baldwin 		return (ENOTSUP);
1017*6685e259SMichael Tuexen 	if (SOLISTENING(so))
1018*6685e259SMichael Tuexen 		return (EINVAL);
1019f1f93475SJohn Baldwin 
1020f1f93475SJohn Baldwin 	counter_u64_add(ktls_offload_enable_calls, 1);
1021f1f93475SJohn Baldwin 
1022f1f93475SJohn Baldwin 	/*
1023f1f93475SJohn Baldwin 	 * This should always be true since only the TCP socket option
1024f1f93475SJohn Baldwin 	 * invokes this function.
1025f1f93475SJohn Baldwin 	 */
1026f1f93475SJohn Baldwin 	if (so->so_proto->pr_protocol != IPPROTO_TCP)
1027f1f93475SJohn Baldwin 		return (EINVAL);
1028f1f93475SJohn Baldwin 
1029f1f93475SJohn Baldwin 	/*
1030f1f93475SJohn Baldwin 	 * XXX: Don't overwrite existing sessions.  We should permit
1031f1f93475SJohn Baldwin 	 * this to support rekeying in the future.
1032f1f93475SJohn Baldwin 	 */
1033f1f93475SJohn Baldwin 	if (so->so_rcv.sb_tls_info != NULL)
1034f1f93475SJohn Baldwin 		return (EALREADY);
1035f1f93475SJohn Baldwin 
1036f1f93475SJohn Baldwin 	if (en->cipher_algorithm == CRYPTO_AES_CBC && !ktls_cbc_enable)
1037f1f93475SJohn Baldwin 		return (ENOTSUP);
1038f1f93475SJohn Baldwin 
10393c0e5685SJohn Baldwin 	/* TLS 1.3 is not yet supported. */
10403c0e5685SJohn Baldwin 	if (en->tls_vmajor == TLS_MAJOR_VER_ONE &&
10413c0e5685SJohn Baldwin 	    en->tls_vminor == TLS_MINOR_VER_THREE)
10423c0e5685SJohn Baldwin 		return (ENOTSUP);
10433c0e5685SJohn Baldwin 
1044f1f93475SJohn Baldwin 	error = ktls_create_session(so, en, &tls);
1045f1f93475SJohn Baldwin 	if (error)
1046f1f93475SJohn Baldwin 		return (error);
1047f1f93475SJohn Baldwin 
1048f1f93475SJohn Baldwin #ifdef TCP_OFFLOAD
1049f1f93475SJohn Baldwin 	error = ktls_try_toe(so, tls, KTLS_RX);
10503c0e5685SJohn Baldwin 	if (error)
1051f1f93475SJohn Baldwin #endif
10523c0e5685SJohn Baldwin 		error = ktls_try_sw(so, tls, KTLS_RX);
1053f1f93475SJohn Baldwin 
1054f1f93475SJohn Baldwin 	if (error) {
1055f1f93475SJohn Baldwin 		ktls_cleanup(tls);
1056f1f93475SJohn Baldwin 		return (error);
1057f1f93475SJohn Baldwin 	}
1058f1f93475SJohn Baldwin 
1059f1f93475SJohn Baldwin 	/* Mark the socket as using TLS offload. */
1060f1f93475SJohn Baldwin 	SOCKBUF_LOCK(&so->so_rcv);
10613c0e5685SJohn Baldwin 	so->so_rcv.sb_tls_seqno = be64dec(en->rec_seq);
1062f1f93475SJohn Baldwin 	so->so_rcv.sb_tls_info = tls;
10633c0e5685SJohn Baldwin 	so->so_rcv.sb_flags |= SB_TLS_RX;
10643c0e5685SJohn Baldwin 
10653c0e5685SJohn Baldwin 	/* Mark existing data as not ready until it can be decrypted. */
10663c0e5685SJohn Baldwin 	sb_mark_notready(&so->so_rcv);
10673c0e5685SJohn Baldwin 	ktls_check_rx(&so->so_rcv);
1068f1f93475SJohn Baldwin 	SOCKBUF_UNLOCK(&so->so_rcv);
1069f1f93475SJohn Baldwin 
1070f1f93475SJohn Baldwin 	counter_u64_add(ktls_offload_total, 1);
1071f1f93475SJohn Baldwin 
1072f1f93475SJohn Baldwin 	return (0);
1073f1f93475SJohn Baldwin }
1074f1f93475SJohn Baldwin 
1075f1f93475SJohn Baldwin int
1076b2e60773SJohn Baldwin ktls_enable_tx(struct socket *so, struct tls_enable *en)
1077b2e60773SJohn Baldwin {
1078b2e60773SJohn Baldwin 	struct ktls_session *tls;
1079521eac97SJohn Baldwin 	struct inpcb *inp;
1080b2e60773SJohn Baldwin 	int error;
1081b2e60773SJohn Baldwin 
1082b2e60773SJohn Baldwin 	if (!ktls_offload_enable)
1083b2e60773SJohn Baldwin 		return (ENOTSUP);
1084*6685e259SMichael Tuexen 	if (SOLISTENING(so))
1085*6685e259SMichael Tuexen 		return (EINVAL);
1086b2e60773SJohn Baldwin 
1087b2e60773SJohn Baldwin 	counter_u64_add(ktls_offload_enable_calls, 1);
1088b2e60773SJohn Baldwin 
1089b2e60773SJohn Baldwin 	/*
1090b2e60773SJohn Baldwin 	 * This should always be true since only the TCP socket option
1091b2e60773SJohn Baldwin 	 * invokes this function.
1092b2e60773SJohn Baldwin 	 */
1093b2e60773SJohn Baldwin 	if (so->so_proto->pr_protocol != IPPROTO_TCP)
1094b2e60773SJohn Baldwin 		return (EINVAL);
1095b2e60773SJohn Baldwin 
1096b2e60773SJohn Baldwin 	/*
1097b2e60773SJohn Baldwin 	 * XXX: Don't overwrite existing sessions.  We should permit
1098b2e60773SJohn Baldwin 	 * this to support rekeying in the future.
1099b2e60773SJohn Baldwin 	 */
1100b2e60773SJohn Baldwin 	if (so->so_snd.sb_tls_info != NULL)
1101b2e60773SJohn Baldwin 		return (EALREADY);
1102b2e60773SJohn Baldwin 
1103b2e60773SJohn Baldwin 	if (en->cipher_algorithm == CRYPTO_AES_CBC && !ktls_cbc_enable)
1104b2e60773SJohn Baldwin 		return (ENOTSUP);
1105b2e60773SJohn Baldwin 
1106b2e60773SJohn Baldwin 	/* TLS requires ext pgs */
1107b2e60773SJohn Baldwin 	if (mb_use_ext_pgs == 0)
1108b2e60773SJohn Baldwin 		return (ENXIO);
1109b2e60773SJohn Baldwin 
1110b2e60773SJohn Baldwin 	error = ktls_create_session(so, en, &tls);
1111b2e60773SJohn Baldwin 	if (error)
1112b2e60773SJohn Baldwin 		return (error);
1113b2e60773SJohn Baldwin 
11149e14430dSJohn Baldwin 	/* Prefer TOE -> ifnet TLS -> software TLS. */
11159e14430dSJohn Baldwin #ifdef TCP_OFFLOAD
1116f1f93475SJohn Baldwin 	error = ktls_try_toe(so, tls, KTLS_TX);
11179e14430dSJohn Baldwin 	if (error)
11189e14430dSJohn Baldwin #endif
1119b2e60773SJohn Baldwin 		error = ktls_try_ifnet(so, tls, false);
1120b2e60773SJohn Baldwin 	if (error)
11213c0e5685SJohn Baldwin 		error = ktls_try_sw(so, tls, KTLS_TX);
1122b2e60773SJohn Baldwin 
1123b2e60773SJohn Baldwin 	if (error) {
1124b2e60773SJohn Baldwin 		ktls_cleanup(tls);
1125b2e60773SJohn Baldwin 		return (error);
1126b2e60773SJohn Baldwin 	}
1127b2e60773SJohn Baldwin 
1128b2e60773SJohn Baldwin 	error = sblock(&so->so_snd, SBL_WAIT);
1129b2e60773SJohn Baldwin 	if (error) {
1130b2e60773SJohn Baldwin 		ktls_cleanup(tls);
1131b2e60773SJohn Baldwin 		return (error);
1132b2e60773SJohn Baldwin 	}
1133b2e60773SJohn Baldwin 
1134521eac97SJohn Baldwin 	/*
1135521eac97SJohn Baldwin 	 * Write lock the INP when setting sb_tls_info so that
1136521eac97SJohn Baldwin 	 * routines in tcp_ratelimit.c can read sb_tls_info while
1137521eac97SJohn Baldwin 	 * holding the INP lock.
1138521eac97SJohn Baldwin 	 */
1139521eac97SJohn Baldwin 	inp = so->so_pcb;
1140521eac97SJohn Baldwin 	INP_WLOCK(inp);
1141b2e60773SJohn Baldwin 	SOCKBUF_LOCK(&so->so_snd);
1142ec1db6e1SJohn Baldwin 	so->so_snd.sb_tls_seqno = be64dec(en->rec_seq);
1143b2e60773SJohn Baldwin 	so->so_snd.sb_tls_info = tls;
11449e14430dSJohn Baldwin 	if (tls->mode != TCP_TLS_MODE_SW)
1145b2e60773SJohn Baldwin 		so->so_snd.sb_flags |= SB_TLS_IFNET;
1146b2e60773SJohn Baldwin 	SOCKBUF_UNLOCK(&so->so_snd);
1147521eac97SJohn Baldwin 	INP_WUNLOCK(inp);
1148b2e60773SJohn Baldwin 	sbunlock(&so->so_snd);
1149b2e60773SJohn Baldwin 
1150b2e60773SJohn Baldwin 	counter_u64_add(ktls_offload_total, 1);
1151b2e60773SJohn Baldwin 
1152b2e60773SJohn Baldwin 	return (0);
1153b2e60773SJohn Baldwin }
1154b2e60773SJohn Baldwin 
1155b2e60773SJohn Baldwin int
1156f1f93475SJohn Baldwin ktls_get_rx_mode(struct socket *so)
1157f1f93475SJohn Baldwin {
1158f1f93475SJohn Baldwin 	struct ktls_session *tls;
1159f1f93475SJohn Baldwin 	struct inpcb *inp;
1160f1f93475SJohn Baldwin 	int mode;
1161f1f93475SJohn Baldwin 
1162*6685e259SMichael Tuexen 	if (SOLISTENING(so))
1163*6685e259SMichael Tuexen 		return (EINVAL);
1164f1f93475SJohn Baldwin 	inp = so->so_pcb;
1165f1f93475SJohn Baldwin 	INP_WLOCK_ASSERT(inp);
1166f1f93475SJohn Baldwin 	SOCKBUF_LOCK(&so->so_rcv);
1167f1f93475SJohn Baldwin 	tls = so->so_rcv.sb_tls_info;
1168f1f93475SJohn Baldwin 	if (tls == NULL)
1169f1f93475SJohn Baldwin 		mode = TCP_TLS_MODE_NONE;
1170f1f93475SJohn Baldwin 	else
1171f1f93475SJohn Baldwin 		mode = tls->mode;
1172f1f93475SJohn Baldwin 	SOCKBUF_UNLOCK(&so->so_rcv);
1173f1f93475SJohn Baldwin 	return (mode);
1174f1f93475SJohn Baldwin }
1175f1f93475SJohn Baldwin 
1176f1f93475SJohn Baldwin int
1177b2e60773SJohn Baldwin ktls_get_tx_mode(struct socket *so)
1178b2e60773SJohn Baldwin {
1179b2e60773SJohn Baldwin 	struct ktls_session *tls;
1180b2e60773SJohn Baldwin 	struct inpcb *inp;
1181b2e60773SJohn Baldwin 	int mode;
1182b2e60773SJohn Baldwin 
1183*6685e259SMichael Tuexen 	if (SOLISTENING(so))
1184*6685e259SMichael Tuexen 		return (EINVAL);
1185b2e60773SJohn Baldwin 	inp = so->so_pcb;
1186b2e60773SJohn Baldwin 	INP_WLOCK_ASSERT(inp);
1187b2e60773SJohn Baldwin 	SOCKBUF_LOCK(&so->so_snd);
1188b2e60773SJohn Baldwin 	tls = so->so_snd.sb_tls_info;
1189b2e60773SJohn Baldwin 	if (tls == NULL)
1190b2e60773SJohn Baldwin 		mode = TCP_TLS_MODE_NONE;
1191b2e60773SJohn Baldwin 	else
11929e14430dSJohn Baldwin 		mode = tls->mode;
1193b2e60773SJohn Baldwin 	SOCKBUF_UNLOCK(&so->so_snd);
1194b2e60773SJohn Baldwin 	return (mode);
1195b2e60773SJohn Baldwin }
1196b2e60773SJohn Baldwin 
1197b2e60773SJohn Baldwin /*
1198b2e60773SJohn Baldwin  * Switch between SW and ifnet TLS sessions as requested.
1199b2e60773SJohn Baldwin  */
1200b2e60773SJohn Baldwin int
1201b2e60773SJohn Baldwin ktls_set_tx_mode(struct socket *so, int mode)
1202b2e60773SJohn Baldwin {
1203b2e60773SJohn Baldwin 	struct ktls_session *tls, *tls_new;
1204b2e60773SJohn Baldwin 	struct inpcb *inp;
1205b2e60773SJohn Baldwin 	int error;
1206b2e60773SJohn Baldwin 
1207*6685e259SMichael Tuexen 	if (SOLISTENING(so))
1208*6685e259SMichael Tuexen 		return (EINVAL);
12099e14430dSJohn Baldwin 	switch (mode) {
12109e14430dSJohn Baldwin 	case TCP_TLS_MODE_SW:
12119e14430dSJohn Baldwin 	case TCP_TLS_MODE_IFNET:
12129e14430dSJohn Baldwin 		break;
12139e14430dSJohn Baldwin 	default:
12149e14430dSJohn Baldwin 		return (EINVAL);
12159e14430dSJohn Baldwin 	}
1216b2e60773SJohn Baldwin 
1217b2e60773SJohn Baldwin 	inp = so->so_pcb;
1218b2e60773SJohn Baldwin 	INP_WLOCK_ASSERT(inp);
1219b2e60773SJohn Baldwin 	SOCKBUF_LOCK(&so->so_snd);
1220b2e60773SJohn Baldwin 	tls = so->so_snd.sb_tls_info;
1221b2e60773SJohn Baldwin 	if (tls == NULL) {
1222b2e60773SJohn Baldwin 		SOCKBUF_UNLOCK(&so->so_snd);
1223b2e60773SJohn Baldwin 		return (0);
1224b2e60773SJohn Baldwin 	}
1225b2e60773SJohn Baldwin 
12269e14430dSJohn Baldwin 	if (tls->mode == mode) {
1227b2e60773SJohn Baldwin 		SOCKBUF_UNLOCK(&so->so_snd);
1228b2e60773SJohn Baldwin 		return (0);
1229b2e60773SJohn Baldwin 	}
1230b2e60773SJohn Baldwin 
1231b2e60773SJohn Baldwin 	tls = ktls_hold(tls);
1232b2e60773SJohn Baldwin 	SOCKBUF_UNLOCK(&so->so_snd);
1233b2e60773SJohn Baldwin 	INP_WUNLOCK(inp);
1234b2e60773SJohn Baldwin 
1235b2e60773SJohn Baldwin 	tls_new = ktls_clone_session(tls);
1236b2e60773SJohn Baldwin 
1237b2e60773SJohn Baldwin 	if (mode == TCP_TLS_MODE_IFNET)
1238b2e60773SJohn Baldwin 		error = ktls_try_ifnet(so, tls_new, true);
1239b2e60773SJohn Baldwin 	else
12403c0e5685SJohn Baldwin 		error = ktls_try_sw(so, tls_new, KTLS_TX);
1241b2e60773SJohn Baldwin 	if (error) {
1242b2e60773SJohn Baldwin 		counter_u64_add(ktls_switch_failed, 1);
1243b2e60773SJohn Baldwin 		ktls_free(tls_new);
1244b2e60773SJohn Baldwin 		ktls_free(tls);
1245b2e60773SJohn Baldwin 		INP_WLOCK(inp);
1246b2e60773SJohn Baldwin 		return (error);
1247b2e60773SJohn Baldwin 	}
1248b2e60773SJohn Baldwin 
1249b2e60773SJohn Baldwin 	error = sblock(&so->so_snd, SBL_WAIT);
1250b2e60773SJohn Baldwin 	if (error) {
1251b2e60773SJohn Baldwin 		counter_u64_add(ktls_switch_failed, 1);
1252b2e60773SJohn Baldwin 		ktls_free(tls_new);
1253b2e60773SJohn Baldwin 		ktls_free(tls);
1254b2e60773SJohn Baldwin 		INP_WLOCK(inp);
1255b2e60773SJohn Baldwin 		return (error);
1256b2e60773SJohn Baldwin 	}
1257b2e60773SJohn Baldwin 
1258b2e60773SJohn Baldwin 	/*
1259b2e60773SJohn Baldwin 	 * If we raced with another session change, keep the existing
1260b2e60773SJohn Baldwin 	 * session.
1261b2e60773SJohn Baldwin 	 */
1262b2e60773SJohn Baldwin 	if (tls != so->so_snd.sb_tls_info) {
1263b2e60773SJohn Baldwin 		counter_u64_add(ktls_switch_failed, 1);
1264b2e60773SJohn Baldwin 		sbunlock(&so->so_snd);
1265b2e60773SJohn Baldwin 		ktls_free(tls_new);
1266b2e60773SJohn Baldwin 		ktls_free(tls);
1267b2e60773SJohn Baldwin 		INP_WLOCK(inp);
1268b2e60773SJohn Baldwin 		return (EBUSY);
1269b2e60773SJohn Baldwin 	}
1270b2e60773SJohn Baldwin 
1271b2e60773SJohn Baldwin 	SOCKBUF_LOCK(&so->so_snd);
1272b2e60773SJohn Baldwin 	so->so_snd.sb_tls_info = tls_new;
12739e14430dSJohn Baldwin 	if (tls_new->mode != TCP_TLS_MODE_SW)
1274b2e60773SJohn Baldwin 		so->so_snd.sb_flags |= SB_TLS_IFNET;
1275b2e60773SJohn Baldwin 	SOCKBUF_UNLOCK(&so->so_snd);
1276b2e60773SJohn Baldwin 	sbunlock(&so->so_snd);
1277b2e60773SJohn Baldwin 
1278b2e60773SJohn Baldwin 	/*
1279b2e60773SJohn Baldwin 	 * Drop two references on 'tls'.  The first is for the
1280b2e60773SJohn Baldwin 	 * ktls_hold() above.  The second drops the reference from the
1281b2e60773SJohn Baldwin 	 * socket buffer.
1282b2e60773SJohn Baldwin 	 */
1283b2e60773SJohn Baldwin 	KASSERT(tls->refcount >= 2, ("too few references on old session"));
1284b2e60773SJohn Baldwin 	ktls_free(tls);
1285b2e60773SJohn Baldwin 	ktls_free(tls);
1286b2e60773SJohn Baldwin 
1287b2e60773SJohn Baldwin 	if (mode == TCP_TLS_MODE_IFNET)
1288b2e60773SJohn Baldwin 		counter_u64_add(ktls_switch_to_ifnet, 1);
1289b2e60773SJohn Baldwin 	else
1290b2e60773SJohn Baldwin 		counter_u64_add(ktls_switch_to_sw, 1);
1291b2e60773SJohn Baldwin 
1292b2e60773SJohn Baldwin 	INP_WLOCK(inp);
1293b2e60773SJohn Baldwin 	return (0);
1294b2e60773SJohn Baldwin }
1295b2e60773SJohn Baldwin 
1296b2e60773SJohn Baldwin /*
1297b2e60773SJohn Baldwin  * Try to allocate a new TLS send tag.  This task is scheduled when
1298b2e60773SJohn Baldwin  * ip_output detects a route change while trying to transmit a packet
1299b2e60773SJohn Baldwin  * holding a TLS record.  If a new tag is allocated, replace the tag
1300b2e60773SJohn Baldwin  * in the TLS session.  Subsequent packets on the connection will use
1301b2e60773SJohn Baldwin  * the new tag.  If a new tag cannot be allocated, drop the
1302b2e60773SJohn Baldwin  * connection.
1303b2e60773SJohn Baldwin  */
1304b2e60773SJohn Baldwin static void
1305b2e60773SJohn Baldwin ktls_reset_send_tag(void *context, int pending)
1306b2e60773SJohn Baldwin {
1307b2e60773SJohn Baldwin 	struct epoch_tracker et;
1308b2e60773SJohn Baldwin 	struct ktls_session *tls;
1309b2e60773SJohn Baldwin 	struct m_snd_tag *old, *new;
1310b2e60773SJohn Baldwin 	struct inpcb *inp;
1311b2e60773SJohn Baldwin 	struct tcpcb *tp;
1312b2e60773SJohn Baldwin 	int error;
1313b2e60773SJohn Baldwin 
1314b2e60773SJohn Baldwin 	MPASS(pending == 1);
1315b2e60773SJohn Baldwin 
1316b2e60773SJohn Baldwin 	tls = context;
1317b2e60773SJohn Baldwin 	inp = tls->inp;
1318b2e60773SJohn Baldwin 
1319b2e60773SJohn Baldwin 	/*
1320b2e60773SJohn Baldwin 	 * Free the old tag first before allocating a new one.
1321b2e60773SJohn Baldwin 	 * ip[6]_output_send() will treat a NULL send tag the same as
1322b2e60773SJohn Baldwin 	 * an ifp mismatch and drop packets until a new tag is
1323b2e60773SJohn Baldwin 	 * allocated.
1324b2e60773SJohn Baldwin 	 *
1325b2e60773SJohn Baldwin 	 * Write-lock the INP when changing tls->snd_tag since
1326b2e60773SJohn Baldwin 	 * ip[6]_output_send() holds a read-lock when reading the
1327b2e60773SJohn Baldwin 	 * pointer.
1328b2e60773SJohn Baldwin 	 */
1329b2e60773SJohn Baldwin 	INP_WLOCK(inp);
1330b2e60773SJohn Baldwin 	old = tls->snd_tag;
1331b2e60773SJohn Baldwin 	tls->snd_tag = NULL;
1332b2e60773SJohn Baldwin 	INP_WUNLOCK(inp);
1333b2e60773SJohn Baldwin 	if (old != NULL)
1334b2e60773SJohn Baldwin 		m_snd_tag_rele(old);
1335b2e60773SJohn Baldwin 
1336b2e60773SJohn Baldwin 	error = ktls_alloc_snd_tag(inp, tls, true, &new);
1337b2e60773SJohn Baldwin 
1338b2e60773SJohn Baldwin 	if (error == 0) {
1339b2e60773SJohn Baldwin 		INP_WLOCK(inp);
1340b2e60773SJohn Baldwin 		tls->snd_tag = new;
1341b2e60773SJohn Baldwin 		mtx_pool_lock(mtxpool_sleep, tls);
1342b2e60773SJohn Baldwin 		tls->reset_pending = false;
1343b2e60773SJohn Baldwin 		mtx_pool_unlock(mtxpool_sleep, tls);
1344b2e60773SJohn Baldwin 		if (!in_pcbrele_wlocked(inp))
1345b2e60773SJohn Baldwin 			INP_WUNLOCK(inp);
1346b2e60773SJohn Baldwin 
1347b2e60773SJohn Baldwin 		counter_u64_add(ktls_ifnet_reset, 1);
1348b2e60773SJohn Baldwin 
1349b2e60773SJohn Baldwin 		/*
1350b2e60773SJohn Baldwin 		 * XXX: Should we kick tcp_output explicitly now that
1351b2e60773SJohn Baldwin 		 * the send tag is fixed or just rely on timers?
1352b2e60773SJohn Baldwin 		 */
1353b2e60773SJohn Baldwin 	} else {
13541a496125SGleb Smirnoff 		NET_EPOCH_ENTER(et);
1355b2e60773SJohn Baldwin 		INP_WLOCK(inp);
1356b2e60773SJohn Baldwin 		if (!in_pcbrele_wlocked(inp)) {
1357b2e60773SJohn Baldwin 			if (!(inp->inp_flags & INP_TIMEWAIT) &&
1358b2e60773SJohn Baldwin 			    !(inp->inp_flags & INP_DROPPED)) {
1359b2e60773SJohn Baldwin 				tp = intotcpcb(inp);
13601f69a509SHans Petter Selasky 				CURVNET_SET(tp->t_vnet);
1361b2e60773SJohn Baldwin 				tp = tcp_drop(tp, ECONNABORTED);
13621f69a509SHans Petter Selasky 				CURVNET_RESTORE();
1363b2e60773SJohn Baldwin 				if (tp != NULL)
1364b2e60773SJohn Baldwin 					INP_WUNLOCK(inp);
1365b2e60773SJohn Baldwin 				counter_u64_add(ktls_ifnet_reset_dropped, 1);
1366b2e60773SJohn Baldwin 			} else
1367b2e60773SJohn Baldwin 				INP_WUNLOCK(inp);
1368b2e60773SJohn Baldwin 		}
13691a496125SGleb Smirnoff 		NET_EPOCH_EXIT(et);
1370b2e60773SJohn Baldwin 
1371b2e60773SJohn Baldwin 		counter_u64_add(ktls_ifnet_reset_failed, 1);
1372b2e60773SJohn Baldwin 
1373b2e60773SJohn Baldwin 		/*
1374b2e60773SJohn Baldwin 		 * Leave reset_pending true to avoid future tasks while
1375b2e60773SJohn Baldwin 		 * the socket goes away.
1376b2e60773SJohn Baldwin 		 */
1377b2e60773SJohn Baldwin 	}
1378b2e60773SJohn Baldwin 
1379b2e60773SJohn Baldwin 	ktls_free(tls);
1380b2e60773SJohn Baldwin }
1381b2e60773SJohn Baldwin 
1382b2e60773SJohn Baldwin int
1383b2e60773SJohn Baldwin ktls_output_eagain(struct inpcb *inp, struct ktls_session *tls)
1384b2e60773SJohn Baldwin {
1385b2e60773SJohn Baldwin 
1386b2e60773SJohn Baldwin 	if (inp == NULL)
1387b2e60773SJohn Baldwin 		return (ENOBUFS);
1388b2e60773SJohn Baldwin 
1389b2e60773SJohn Baldwin 	INP_LOCK_ASSERT(inp);
1390b2e60773SJohn Baldwin 
1391b2e60773SJohn Baldwin 	/*
1392b2e60773SJohn Baldwin 	 * See if we should schedule a task to update the send tag for
1393b2e60773SJohn Baldwin 	 * this session.
1394b2e60773SJohn Baldwin 	 */
1395b2e60773SJohn Baldwin 	mtx_pool_lock(mtxpool_sleep, tls);
1396b2e60773SJohn Baldwin 	if (!tls->reset_pending) {
1397b2e60773SJohn Baldwin 		(void) ktls_hold(tls);
1398b2e60773SJohn Baldwin 		in_pcbref(inp);
1399b2e60773SJohn Baldwin 		tls->inp = inp;
1400b2e60773SJohn Baldwin 		tls->reset_pending = true;
1401b2e60773SJohn Baldwin 		taskqueue_enqueue(taskqueue_thread, &tls->reset_tag_task);
1402b2e60773SJohn Baldwin 	}
1403b2e60773SJohn Baldwin 	mtx_pool_unlock(mtxpool_sleep, tls);
1404b2e60773SJohn Baldwin 	return (ENOBUFS);
1405b2e60773SJohn Baldwin }
1406521eac97SJohn Baldwin 
1407521eac97SJohn Baldwin #ifdef RATELIMIT
1408521eac97SJohn Baldwin int
1409521eac97SJohn Baldwin ktls_modify_txrtlmt(struct ktls_session *tls, uint64_t max_pacing_rate)
1410521eac97SJohn Baldwin {
1411521eac97SJohn Baldwin 	union if_snd_tag_modify_params params = {
1412521eac97SJohn Baldwin 		.rate_limit.max_rate = max_pacing_rate,
1413521eac97SJohn Baldwin 		.rate_limit.flags = M_NOWAIT,
1414521eac97SJohn Baldwin 	};
1415521eac97SJohn Baldwin 	struct m_snd_tag *mst;
1416521eac97SJohn Baldwin 	struct ifnet *ifp;
1417521eac97SJohn Baldwin 	int error;
1418521eac97SJohn Baldwin 
1419521eac97SJohn Baldwin 	/* Can't get to the inp, but it should be locked. */
1420521eac97SJohn Baldwin 	/* INP_LOCK_ASSERT(inp); */
1421521eac97SJohn Baldwin 
1422521eac97SJohn Baldwin 	MPASS(tls->mode == TCP_TLS_MODE_IFNET);
1423521eac97SJohn Baldwin 
1424521eac97SJohn Baldwin 	if (tls->snd_tag == NULL) {
1425521eac97SJohn Baldwin 		/*
1426521eac97SJohn Baldwin 		 * Resetting send tag, ignore this change.  The
1427521eac97SJohn Baldwin 		 * pending reset may or may not see this updated rate
1428521eac97SJohn Baldwin 		 * in the tcpcb.  If it doesn't, we will just lose
1429521eac97SJohn Baldwin 		 * this rate change.
1430521eac97SJohn Baldwin 		 */
1431521eac97SJohn Baldwin 		return (0);
1432521eac97SJohn Baldwin 	}
1433521eac97SJohn Baldwin 
1434521eac97SJohn Baldwin 	MPASS(tls->snd_tag != NULL);
1435521eac97SJohn Baldwin 	MPASS(tls->snd_tag->type == IF_SND_TAG_TYPE_TLS_RATE_LIMIT);
1436521eac97SJohn Baldwin 
1437521eac97SJohn Baldwin 	mst = tls->snd_tag;
1438521eac97SJohn Baldwin 	ifp = mst->ifp;
1439521eac97SJohn Baldwin 	return (ifp->if_snd_tag_modify(mst, &params));
1440521eac97SJohn Baldwin }
1441521eac97SJohn Baldwin #endif
1442b2e60773SJohn Baldwin #endif
1443b2e60773SJohn Baldwin 
1444b2e60773SJohn Baldwin void
1445b2e60773SJohn Baldwin ktls_destroy(struct ktls_session *tls)
1446b2e60773SJohn Baldwin {
1447b2e60773SJohn Baldwin 	struct rm_priotracker prio;
1448b2e60773SJohn Baldwin 
1449b2e60773SJohn Baldwin 	ktls_cleanup(tls);
1450b2e60773SJohn Baldwin 	if (tls->be != NULL && ktls_allow_unload) {
1451b2e60773SJohn Baldwin 		rm_rlock(&ktls_backends_lock, &prio);
1452b2e60773SJohn Baldwin 		tls->be->use_count--;
1453b2e60773SJohn Baldwin 		rm_runlock(&ktls_backends_lock, &prio);
1454b2e60773SJohn Baldwin 	}
1455b2e60773SJohn Baldwin 	uma_zfree(ktls_session_zone, tls);
1456b2e60773SJohn Baldwin }
1457b2e60773SJohn Baldwin 
1458b2e60773SJohn Baldwin void
1459b2e60773SJohn Baldwin ktls_seq(struct sockbuf *sb, struct mbuf *m)
1460b2e60773SJohn Baldwin {
1461b2e60773SJohn Baldwin 
1462b2e60773SJohn Baldwin 	for (; m != NULL; m = m->m_next) {
14636edfd179SGleb Smirnoff 		KASSERT((m->m_flags & M_EXTPG) != 0,
1464b2e60773SJohn Baldwin 		    ("ktls_seq: mapped mbuf %p", m));
1465b2e60773SJohn Baldwin 
14667b6c99d0SGleb Smirnoff 		m->m_epg_seqno = sb->sb_tls_seqno;
1467b2e60773SJohn Baldwin 		sb->sb_tls_seqno++;
1468b2e60773SJohn Baldwin 	}
1469b2e60773SJohn Baldwin }
1470b2e60773SJohn Baldwin 
1471b2e60773SJohn Baldwin /*
1472b2e60773SJohn Baldwin  * Add TLS framing (headers and trailers) to a chain of mbufs.  Each
1473b2e60773SJohn Baldwin  * mbuf in the chain must be an unmapped mbuf.  The payload of the
1474b2e60773SJohn Baldwin  * mbuf must be populated with the payload of each TLS record.
1475b2e60773SJohn Baldwin  *
1476b2e60773SJohn Baldwin  * The record_type argument specifies the TLS record type used when
1477b2e60773SJohn Baldwin  * populating the TLS header.
1478b2e60773SJohn Baldwin  *
1479b2e60773SJohn Baldwin  * The enq_count argument on return is set to the number of pages of
1480b2e60773SJohn Baldwin  * payload data for this entire chain that need to be encrypted via SW
1481b2e60773SJohn Baldwin  * encryption.  The returned value should be passed to ktls_enqueue
1482c2a8fd6fSJohn Baldwin  * when scheduling encryption of this chain of mbufs.  To handle the
1483c2a8fd6fSJohn Baldwin  * special case of empty fragments for TLS 1.0 sessions, an empty
1484c2a8fd6fSJohn Baldwin  * fragment counts as one page.
1485b2e60773SJohn Baldwin  */
1486f85e1a80SGleb Smirnoff void
1487b2e60773SJohn Baldwin ktls_frame(struct mbuf *top, struct ktls_session *tls, int *enq_cnt,
1488b2e60773SJohn Baldwin     uint8_t record_type)
1489b2e60773SJohn Baldwin {
1490b2e60773SJohn Baldwin 	struct tls_record_layer *tlshdr;
1491b2e60773SJohn Baldwin 	struct mbuf *m;
14927d29eb9aSJohn Baldwin 	uint64_t *noncep;
1493b2e60773SJohn Baldwin 	uint16_t tls_len;
1494b2e60773SJohn Baldwin 	int maxlen;
1495b2e60773SJohn Baldwin 
1496b2e60773SJohn Baldwin 	maxlen = tls->params.max_frame_len;
1497b2e60773SJohn Baldwin 	*enq_cnt = 0;
1498b2e60773SJohn Baldwin 	for (m = top; m != NULL; m = m->m_next) {
1499b2e60773SJohn Baldwin 		/*
1500c2a8fd6fSJohn Baldwin 		 * All mbufs in the chain should be TLS records whose
1501c2a8fd6fSJohn Baldwin 		 * payload does not exceed the maximum frame length.
1502c2a8fd6fSJohn Baldwin 		 *
1503c2a8fd6fSJohn Baldwin 		 * Empty TLS records are permitted when using CBC.
1504b2e60773SJohn Baldwin 		 */
1505c2a8fd6fSJohn Baldwin 		KASSERT(m->m_len <= maxlen &&
1506c2a8fd6fSJohn Baldwin 		    (tls->params.cipher_algorithm == CRYPTO_AES_CBC ?
1507c2a8fd6fSJohn Baldwin 		    m->m_len >= 0 : m->m_len > 0),
1508f85e1a80SGleb Smirnoff 		    ("ktls_frame: m %p len %d\n", m, m->m_len));
1509c2a8fd6fSJohn Baldwin 
1510b2e60773SJohn Baldwin 		/*
1511b2e60773SJohn Baldwin 		 * TLS frames require unmapped mbufs to store session
1512b2e60773SJohn Baldwin 		 * info.
1513b2e60773SJohn Baldwin 		 */
15146edfd179SGleb Smirnoff 		KASSERT((m->m_flags & M_EXTPG) != 0,
1515b2e60773SJohn Baldwin 		    ("ktls_frame: mapped mbuf %p (top = %p)\n", m, top));
1516b2e60773SJohn Baldwin 
1517f85e1a80SGleb Smirnoff 		tls_len = m->m_len;
1518b2e60773SJohn Baldwin 
1519b2e60773SJohn Baldwin 		/* Save a reference to the session. */
15207b6c99d0SGleb Smirnoff 		m->m_epg_tls = ktls_hold(tls);
1521b2e60773SJohn Baldwin 
15227b6c99d0SGleb Smirnoff 		m->m_epg_hdrlen = tls->params.tls_hlen;
15237b6c99d0SGleb Smirnoff 		m->m_epg_trllen = tls->params.tls_tlen;
1524b2e60773SJohn Baldwin 		if (tls->params.cipher_algorithm == CRYPTO_AES_CBC) {
1525b2e60773SJohn Baldwin 			int bs, delta;
1526b2e60773SJohn Baldwin 
1527b2e60773SJohn Baldwin 			/*
1528b2e60773SJohn Baldwin 			 * AES-CBC pads messages to a multiple of the
1529b2e60773SJohn Baldwin 			 * block size.  Note that the padding is
1530b2e60773SJohn Baldwin 			 * applied after the digest and the encryption
1531b2e60773SJohn Baldwin 			 * is done on the "plaintext || mac || padding".
1532b2e60773SJohn Baldwin 			 * At least one byte of padding is always
1533b2e60773SJohn Baldwin 			 * present.
1534b2e60773SJohn Baldwin 			 *
1535b2e60773SJohn Baldwin 			 * Compute the final trailer length assuming
1536b2e60773SJohn Baldwin 			 * at most one block of padding.
1537b2e60773SJohn Baldwin 			 * tls->params.sb_tls_tlen is the maximum
1538b2e60773SJohn Baldwin 			 * possible trailer length (padding + digest).
1539b2e60773SJohn Baldwin 			 * delta holds the number of excess padding
1540b2e60773SJohn Baldwin 			 * bytes if the maximum were used.  Those
1541b2e60773SJohn Baldwin 			 * extra bytes are removed.
1542b2e60773SJohn Baldwin 			 */
1543b2e60773SJohn Baldwin 			bs = tls->params.tls_bs;
1544b2e60773SJohn Baldwin 			delta = (tls_len + tls->params.tls_tlen) & (bs - 1);
15457b6c99d0SGleb Smirnoff 			m->m_epg_trllen -= delta;
1546b2e60773SJohn Baldwin 		}
15477b6c99d0SGleb Smirnoff 		m->m_len += m->m_epg_hdrlen + m->m_epg_trllen;
1548b2e60773SJohn Baldwin 
1549b2e60773SJohn Baldwin 		/* Populate the TLS header. */
15500c103266SGleb Smirnoff 		tlshdr = (void *)m->m_epg_hdr;
1551b2e60773SJohn Baldwin 		tlshdr->tls_vmajor = tls->params.tls_vmajor;
15526554362cSAndrew Gallatin 
15536554362cSAndrew Gallatin 		/*
15546554362cSAndrew Gallatin 		 * TLS 1.3 masquarades as TLS 1.2 with a record type
15556554362cSAndrew Gallatin 		 * of TLS_RLTYPE_APP.
15566554362cSAndrew Gallatin 		 */
15576554362cSAndrew Gallatin 		if (tls->params.tls_vminor == TLS_MINOR_VER_THREE &&
15586554362cSAndrew Gallatin 		    tls->params.tls_vmajor == TLS_MAJOR_VER_ONE) {
15596554362cSAndrew Gallatin 			tlshdr->tls_vminor = TLS_MINOR_VER_TWO;
15606554362cSAndrew Gallatin 			tlshdr->tls_type = TLS_RLTYPE_APP;
15616554362cSAndrew Gallatin 			/* save the real record type for later */
15627b6c99d0SGleb Smirnoff 			m->m_epg_record_type = record_type;
15630c103266SGleb Smirnoff 			m->m_epg_trail[0] = record_type;
15646554362cSAndrew Gallatin 		} else {
1565b2e60773SJohn Baldwin 			tlshdr->tls_vminor = tls->params.tls_vminor;
1566b2e60773SJohn Baldwin 			tlshdr->tls_type = record_type;
15676554362cSAndrew Gallatin 		}
1568b2e60773SJohn Baldwin 		tlshdr->tls_length = htons(m->m_len - sizeof(*tlshdr));
1569b2e60773SJohn Baldwin 
1570b2e60773SJohn Baldwin 		/*
15717d29eb9aSJohn Baldwin 		 * Store nonces / explicit IVs after the end of the
15727d29eb9aSJohn Baldwin 		 * TLS header.
15737d29eb9aSJohn Baldwin 		 *
15747d29eb9aSJohn Baldwin 		 * For GCM with TLS 1.2, an 8 byte nonce is copied
15757d29eb9aSJohn Baldwin 		 * from the end of the IV.  The nonce is then
15767d29eb9aSJohn Baldwin 		 * incremented for use by the next record.
15777d29eb9aSJohn Baldwin 		 *
15787d29eb9aSJohn Baldwin 		 * For CBC, a random nonce is inserted for TLS 1.1+.
1579b2e60773SJohn Baldwin 		 */
15807d29eb9aSJohn Baldwin 		if (tls->params.cipher_algorithm == CRYPTO_AES_NIST_GCM_16 &&
15817d29eb9aSJohn Baldwin 		    tls->params.tls_vminor == TLS_MINOR_VER_TWO) {
15827d29eb9aSJohn Baldwin 			noncep = (uint64_t *)(tls->params.iv + 8);
15837d29eb9aSJohn Baldwin 			be64enc(tlshdr + 1, *noncep);
15847d29eb9aSJohn Baldwin 			(*noncep)++;
15857d29eb9aSJohn Baldwin 		} else if (tls->params.cipher_algorithm == CRYPTO_AES_CBC &&
1586b2e60773SJohn Baldwin 		    tls->params.tls_vminor >= TLS_MINOR_VER_ONE)
1587b2e60773SJohn Baldwin 			arc4rand(tlshdr + 1, AES_BLOCK_LEN, 0);
1588b2e60773SJohn Baldwin 
1589b2e60773SJohn Baldwin 		/*
1590b2e60773SJohn Baldwin 		 * When using SW encryption, mark the mbuf not ready.
1591b2e60773SJohn Baldwin 		 * It will be marked ready via sbready() after the
1592b2e60773SJohn Baldwin 		 * record has been encrypted.
1593b2e60773SJohn Baldwin 		 *
1594b2e60773SJohn Baldwin 		 * When using ifnet TLS, unencrypted TLS records are
1595b2e60773SJohn Baldwin 		 * sent down the stack to the NIC.
1596b2e60773SJohn Baldwin 		 */
15979e14430dSJohn Baldwin 		if (tls->mode == TCP_TLS_MODE_SW) {
1598b2e60773SJohn Baldwin 			m->m_flags |= M_NOTREADY;
15997b6c99d0SGleb Smirnoff 			m->m_epg_nrdy = m->m_epg_npgs;
1600c2a8fd6fSJohn Baldwin 			if (__predict_false(tls_len == 0)) {
1601c2a8fd6fSJohn Baldwin 				/* TLS 1.0 empty fragment. */
1602c2a8fd6fSJohn Baldwin 				*enq_cnt += 1;
1603c2a8fd6fSJohn Baldwin 			} else
16047b6c99d0SGleb Smirnoff 				*enq_cnt += m->m_epg_npgs;
1605b2e60773SJohn Baldwin 		}
1606b2e60773SJohn Baldwin 	}
1607b2e60773SJohn Baldwin }
1608b2e60773SJohn Baldwin 
1609b2e60773SJohn Baldwin void
16103c0e5685SJohn Baldwin ktls_check_rx(struct sockbuf *sb)
16113c0e5685SJohn Baldwin {
16123c0e5685SJohn Baldwin 	struct tls_record_layer hdr;
16133c0e5685SJohn Baldwin 	struct ktls_wq *wq;
16143c0e5685SJohn Baldwin 	struct socket *so;
16153c0e5685SJohn Baldwin 	bool running;
16163c0e5685SJohn Baldwin 
16173c0e5685SJohn Baldwin 	SOCKBUF_LOCK_ASSERT(sb);
16183c0e5685SJohn Baldwin 	KASSERT(sb->sb_flags & SB_TLS_RX, ("%s: sockbuf %p isn't TLS RX",
16193c0e5685SJohn Baldwin 	    __func__, sb));
16203c0e5685SJohn Baldwin 	so = __containerof(sb, struct socket, so_rcv);
16213c0e5685SJohn Baldwin 
16223c0e5685SJohn Baldwin 	if (sb->sb_flags & SB_TLS_RX_RUNNING)
16233c0e5685SJohn Baldwin 		return;
16243c0e5685SJohn Baldwin 
16253c0e5685SJohn Baldwin 	/* Is there enough queued for a TLS header? */
16263c0e5685SJohn Baldwin 	if (sb->sb_tlscc < sizeof(hdr)) {
16273c0e5685SJohn Baldwin 		if ((sb->sb_state & SBS_CANTRCVMORE) != 0 && sb->sb_tlscc != 0)
16283c0e5685SJohn Baldwin 			so->so_error = EMSGSIZE;
16293c0e5685SJohn Baldwin 		return;
16303c0e5685SJohn Baldwin 	}
16313c0e5685SJohn Baldwin 
16323c0e5685SJohn Baldwin 	m_copydata(sb->sb_mtls, 0, sizeof(hdr), (void *)&hdr);
16333c0e5685SJohn Baldwin 
16343c0e5685SJohn Baldwin 	/* Is the entire record queued? */
16353c0e5685SJohn Baldwin 	if (sb->sb_tlscc < sizeof(hdr) + ntohs(hdr.tls_length)) {
16363c0e5685SJohn Baldwin 		if ((sb->sb_state & SBS_CANTRCVMORE) != 0)
16373c0e5685SJohn Baldwin 			so->so_error = EMSGSIZE;
16383c0e5685SJohn Baldwin 		return;
16393c0e5685SJohn Baldwin 	}
16403c0e5685SJohn Baldwin 
16413c0e5685SJohn Baldwin 	sb->sb_flags |= SB_TLS_RX_RUNNING;
16423c0e5685SJohn Baldwin 
16433c0e5685SJohn Baldwin 	soref(so);
16443c0e5685SJohn Baldwin 	wq = &ktls_wq[so->so_rcv.sb_tls_info->wq_index];
16453c0e5685SJohn Baldwin 	mtx_lock(&wq->mtx);
16463c0e5685SJohn Baldwin 	STAILQ_INSERT_TAIL(&wq->so_head, so, so_ktls_rx_list);
16473c0e5685SJohn Baldwin 	running = wq->running;
16483c0e5685SJohn Baldwin 	mtx_unlock(&wq->mtx);
16493c0e5685SJohn Baldwin 	if (!running)
16503c0e5685SJohn Baldwin 		wakeup(wq);
16513c0e5685SJohn Baldwin 	counter_u64_add(ktls_cnt_rx_queued, 1);
16523c0e5685SJohn Baldwin }
16533c0e5685SJohn Baldwin 
16543c0e5685SJohn Baldwin static struct mbuf *
16553c0e5685SJohn Baldwin ktls_detach_record(struct sockbuf *sb, int len)
16563c0e5685SJohn Baldwin {
16573c0e5685SJohn Baldwin 	struct mbuf *m, *n, *top;
16583c0e5685SJohn Baldwin 	int remain;
16593c0e5685SJohn Baldwin 
16603c0e5685SJohn Baldwin 	SOCKBUF_LOCK_ASSERT(sb);
16613c0e5685SJohn Baldwin 	MPASS(len <= sb->sb_tlscc);
16623c0e5685SJohn Baldwin 
16633c0e5685SJohn Baldwin 	/*
16643c0e5685SJohn Baldwin 	 * If TLS chain is the exact size of the record,
16653c0e5685SJohn Baldwin 	 * just grab the whole record.
16663c0e5685SJohn Baldwin 	 */
16673c0e5685SJohn Baldwin 	top = sb->sb_mtls;
16683c0e5685SJohn Baldwin 	if (sb->sb_tlscc == len) {
16693c0e5685SJohn Baldwin 		sb->sb_mtls = NULL;
16703c0e5685SJohn Baldwin 		sb->sb_mtlstail = NULL;
16713c0e5685SJohn Baldwin 		goto out;
16723c0e5685SJohn Baldwin 	}
16733c0e5685SJohn Baldwin 
16743c0e5685SJohn Baldwin 	/*
16753c0e5685SJohn Baldwin 	 * While it would be nice to use m_split() here, we need
16763c0e5685SJohn Baldwin 	 * to know exactly what m_split() allocates to update the
16773c0e5685SJohn Baldwin 	 * accounting, so do it inline instead.
16783c0e5685SJohn Baldwin 	 */
16793c0e5685SJohn Baldwin 	remain = len;
16803c0e5685SJohn Baldwin 	for (m = top; remain > m->m_len; m = m->m_next)
16813c0e5685SJohn Baldwin 		remain -= m->m_len;
16823c0e5685SJohn Baldwin 
16833c0e5685SJohn Baldwin 	/* Easy case: don't have to split 'm'. */
16843c0e5685SJohn Baldwin 	if (remain == m->m_len) {
16853c0e5685SJohn Baldwin 		sb->sb_mtls = m->m_next;
16863c0e5685SJohn Baldwin 		if (sb->sb_mtls == NULL)
16873c0e5685SJohn Baldwin 			sb->sb_mtlstail = NULL;
16883c0e5685SJohn Baldwin 		m->m_next = NULL;
16893c0e5685SJohn Baldwin 		goto out;
16903c0e5685SJohn Baldwin 	}
16913c0e5685SJohn Baldwin 
16923c0e5685SJohn Baldwin 	/*
16933c0e5685SJohn Baldwin 	 * Need to allocate an mbuf to hold the remainder of 'm'.  Try
16943c0e5685SJohn Baldwin 	 * with M_NOWAIT first.
16953c0e5685SJohn Baldwin 	 */
16963c0e5685SJohn Baldwin 	n = m_get(M_NOWAIT, MT_DATA);
16973c0e5685SJohn Baldwin 	if (n == NULL) {
16983c0e5685SJohn Baldwin 		/*
16993c0e5685SJohn Baldwin 		 * Use M_WAITOK with socket buffer unlocked.  If
17003c0e5685SJohn Baldwin 		 * 'sb_mtls' changes while the lock is dropped, return
17013c0e5685SJohn Baldwin 		 * NULL to force the caller to retry.
17023c0e5685SJohn Baldwin 		 */
17033c0e5685SJohn Baldwin 		SOCKBUF_UNLOCK(sb);
17043c0e5685SJohn Baldwin 
17053c0e5685SJohn Baldwin 		n = m_get(M_WAITOK, MT_DATA);
17063c0e5685SJohn Baldwin 
17073c0e5685SJohn Baldwin 		SOCKBUF_LOCK(sb);
17083c0e5685SJohn Baldwin 		if (sb->sb_mtls != top) {
17093c0e5685SJohn Baldwin 			m_free(n);
17103c0e5685SJohn Baldwin 			return (NULL);
17113c0e5685SJohn Baldwin 		}
17123c0e5685SJohn Baldwin 	}
17133c0e5685SJohn Baldwin 	n->m_flags |= M_NOTREADY;
17143c0e5685SJohn Baldwin 
17153c0e5685SJohn Baldwin 	/* Store remainder in 'n'. */
17163c0e5685SJohn Baldwin 	n->m_len = m->m_len - remain;
17173c0e5685SJohn Baldwin 	if (m->m_flags & M_EXT) {
17183c0e5685SJohn Baldwin 		n->m_data = m->m_data + remain;
17193c0e5685SJohn Baldwin 		mb_dupcl(n, m);
17203c0e5685SJohn Baldwin 	} else {
17213c0e5685SJohn Baldwin 		bcopy(mtod(m, caddr_t) + remain, mtod(n, caddr_t), n->m_len);
17223c0e5685SJohn Baldwin 	}
17233c0e5685SJohn Baldwin 
17243c0e5685SJohn Baldwin 	/* Trim 'm' and update accounting. */
17253c0e5685SJohn Baldwin 	m->m_len -= n->m_len;
17263c0e5685SJohn Baldwin 	sb->sb_tlscc -= n->m_len;
17273c0e5685SJohn Baldwin 	sb->sb_ccc -= n->m_len;
17283c0e5685SJohn Baldwin 
17293c0e5685SJohn Baldwin 	/* Account for 'n'. */
17303c0e5685SJohn Baldwin 	sballoc_ktls_rx(sb, n);
17313c0e5685SJohn Baldwin 
17323c0e5685SJohn Baldwin 	/* Insert 'n' into the TLS chain. */
17333c0e5685SJohn Baldwin 	sb->sb_mtls = n;
17343c0e5685SJohn Baldwin 	n->m_next = m->m_next;
17353c0e5685SJohn Baldwin 	if (sb->sb_mtlstail == m)
17363c0e5685SJohn Baldwin 		sb->sb_mtlstail = n;
17373c0e5685SJohn Baldwin 
17383c0e5685SJohn Baldwin 	/* Detach the record from the TLS chain. */
17393c0e5685SJohn Baldwin 	m->m_next = NULL;
17403c0e5685SJohn Baldwin 
17413c0e5685SJohn Baldwin out:
17423c0e5685SJohn Baldwin 	MPASS(m_length(top, NULL) == len);
17433c0e5685SJohn Baldwin 	for (m = top; m != NULL; m = m->m_next)
17443c0e5685SJohn Baldwin 		sbfree_ktls_rx(sb, m);
17453c0e5685SJohn Baldwin 	sb->sb_tlsdcc = len;
17463c0e5685SJohn Baldwin 	sb->sb_ccc += len;
17473c0e5685SJohn Baldwin 	SBCHECK(sb);
17483c0e5685SJohn Baldwin 	return (top);
17493c0e5685SJohn Baldwin }
17503c0e5685SJohn Baldwin 
17513c0e5685SJohn Baldwin static void
17523c0e5685SJohn Baldwin ktls_decrypt(struct socket *so)
17533c0e5685SJohn Baldwin {
17543c0e5685SJohn Baldwin 	char tls_header[MBUF_PEXT_HDR_LEN];
17553c0e5685SJohn Baldwin 	struct ktls_session *tls;
17563c0e5685SJohn Baldwin 	struct sockbuf *sb;
17573c0e5685SJohn Baldwin 	struct tls_record_layer *hdr;
17583c0e5685SJohn Baldwin 	struct tls_get_record tgr;
17593c0e5685SJohn Baldwin 	struct mbuf *control, *data, *m;
17603c0e5685SJohn Baldwin 	uint64_t seqno;
17613c0e5685SJohn Baldwin 	int error, remain, tls_len, trail_len;
17623c0e5685SJohn Baldwin 
17633c0e5685SJohn Baldwin 	hdr = (struct tls_record_layer *)tls_header;
17643c0e5685SJohn Baldwin 	sb = &so->so_rcv;
17653c0e5685SJohn Baldwin 	SOCKBUF_LOCK(sb);
17663c0e5685SJohn Baldwin 	KASSERT(sb->sb_flags & SB_TLS_RX_RUNNING,
17673c0e5685SJohn Baldwin 	    ("%s: socket %p not running", __func__, so));
17683c0e5685SJohn Baldwin 
17693c0e5685SJohn Baldwin 	tls = sb->sb_tls_info;
17703c0e5685SJohn Baldwin 	MPASS(tls != NULL);
17713c0e5685SJohn Baldwin 
17723c0e5685SJohn Baldwin 	for (;;) {
17733c0e5685SJohn Baldwin 		/* Is there enough queued for a TLS header? */
17743c0e5685SJohn Baldwin 		if (sb->sb_tlscc < tls->params.tls_hlen)
17753c0e5685SJohn Baldwin 			break;
17763c0e5685SJohn Baldwin 
17773c0e5685SJohn Baldwin 		m_copydata(sb->sb_mtls, 0, tls->params.tls_hlen, tls_header);
17783c0e5685SJohn Baldwin 		tls_len = sizeof(*hdr) + ntohs(hdr->tls_length);
17793c0e5685SJohn Baldwin 
17803c0e5685SJohn Baldwin 		if (hdr->tls_vmajor != tls->params.tls_vmajor ||
17813c0e5685SJohn Baldwin 		    hdr->tls_vminor != tls->params.tls_vminor)
17823c0e5685SJohn Baldwin 			error = EINVAL;
17833c0e5685SJohn Baldwin 		else if (tls_len < tls->params.tls_hlen || tls_len >
17843c0e5685SJohn Baldwin 		    tls->params.tls_hlen + TLS_MAX_MSG_SIZE_V10_2 +
17853c0e5685SJohn Baldwin 		    tls->params.tls_tlen)
17863c0e5685SJohn Baldwin 			error = EMSGSIZE;
17873c0e5685SJohn Baldwin 		else
17883c0e5685SJohn Baldwin 			error = 0;
17893c0e5685SJohn Baldwin 		if (__predict_false(error != 0)) {
17903c0e5685SJohn Baldwin 			/*
17913c0e5685SJohn Baldwin 			 * We have a corrupted record and are likely
17923c0e5685SJohn Baldwin 			 * out of sync.  The connection isn't
17933c0e5685SJohn Baldwin 			 * recoverable at this point, so abort it.
17943c0e5685SJohn Baldwin 			 */
17953c0e5685SJohn Baldwin 			SOCKBUF_UNLOCK(sb);
17963c0e5685SJohn Baldwin 			counter_u64_add(ktls_offload_corrupted_records, 1);
17973c0e5685SJohn Baldwin 
17983c0e5685SJohn Baldwin 			CURVNET_SET(so->so_vnet);
17993c0e5685SJohn Baldwin 			so->so_proto->pr_usrreqs->pru_abort(so);
18003c0e5685SJohn Baldwin 			so->so_error = error;
18013c0e5685SJohn Baldwin 			CURVNET_RESTORE();
18023c0e5685SJohn Baldwin 			goto deref;
18033c0e5685SJohn Baldwin 		}
18043c0e5685SJohn Baldwin 
18053c0e5685SJohn Baldwin 		/* Is the entire record queued? */
18063c0e5685SJohn Baldwin 		if (sb->sb_tlscc < tls_len)
18073c0e5685SJohn Baldwin 			break;
18083c0e5685SJohn Baldwin 
18093c0e5685SJohn Baldwin 		/*
18103c0e5685SJohn Baldwin 		 * Split out the portion of the mbuf chain containing
18113c0e5685SJohn Baldwin 		 * this TLS record.
18123c0e5685SJohn Baldwin 		 */
18133c0e5685SJohn Baldwin 		data = ktls_detach_record(sb, tls_len);
18143c0e5685SJohn Baldwin 		if (data == NULL)
18153c0e5685SJohn Baldwin 			continue;
18163c0e5685SJohn Baldwin 		MPASS(sb->sb_tlsdcc == tls_len);
18173c0e5685SJohn Baldwin 
18183c0e5685SJohn Baldwin 		seqno = sb->sb_tls_seqno;
18193c0e5685SJohn Baldwin 		sb->sb_tls_seqno++;
18203c0e5685SJohn Baldwin 		SBCHECK(sb);
18213c0e5685SJohn Baldwin 		SOCKBUF_UNLOCK(sb);
18223c0e5685SJohn Baldwin 
18233c0e5685SJohn Baldwin 		error = tls->sw_decrypt(tls, hdr, data, seqno, &trail_len);
18243c0e5685SJohn Baldwin 		if (error) {
18253c0e5685SJohn Baldwin 			counter_u64_add(ktls_offload_failed_crypto, 1);
18263c0e5685SJohn Baldwin 
18273c0e5685SJohn Baldwin 			SOCKBUF_LOCK(sb);
18283c0e5685SJohn Baldwin 			if (sb->sb_tlsdcc == 0) {
18293c0e5685SJohn Baldwin 				/*
18303c0e5685SJohn Baldwin 				 * sbcut/drop/flush discarded these
18313c0e5685SJohn Baldwin 				 * mbufs.
18323c0e5685SJohn Baldwin 				 */
18333c0e5685SJohn Baldwin 				m_freem(data);
18343c0e5685SJohn Baldwin 				break;
18353c0e5685SJohn Baldwin 			}
18363c0e5685SJohn Baldwin 
18373c0e5685SJohn Baldwin 			/*
18383c0e5685SJohn Baldwin 			 * Drop this TLS record's data, but keep
18393c0e5685SJohn Baldwin 			 * decrypting subsequent records.
18403c0e5685SJohn Baldwin 			 */
18413c0e5685SJohn Baldwin 			sb->sb_ccc -= tls_len;
18423c0e5685SJohn Baldwin 			sb->sb_tlsdcc = 0;
18433c0e5685SJohn Baldwin 
18443c0e5685SJohn Baldwin 			CURVNET_SET(so->so_vnet);
18453c0e5685SJohn Baldwin 			so->so_error = EBADMSG;
18463c0e5685SJohn Baldwin 			sorwakeup_locked(so);
18473c0e5685SJohn Baldwin 			CURVNET_RESTORE();
18483c0e5685SJohn Baldwin 
18493c0e5685SJohn Baldwin 			m_freem(data);
18503c0e5685SJohn Baldwin 
18513c0e5685SJohn Baldwin 			SOCKBUF_LOCK(sb);
18523c0e5685SJohn Baldwin 			continue;
18533c0e5685SJohn Baldwin 		}
18543c0e5685SJohn Baldwin 
18553c0e5685SJohn Baldwin 		/* Allocate the control mbuf. */
18563c0e5685SJohn Baldwin 		tgr.tls_type = hdr->tls_type;
18573c0e5685SJohn Baldwin 		tgr.tls_vmajor = hdr->tls_vmajor;
18583c0e5685SJohn Baldwin 		tgr.tls_vminor = hdr->tls_vminor;
18593c0e5685SJohn Baldwin 		tgr.tls_length = htobe16(tls_len - tls->params.tls_hlen -
18603c0e5685SJohn Baldwin 		    trail_len);
18613c0e5685SJohn Baldwin 		control = sbcreatecontrol_how(&tgr, sizeof(tgr),
18623c0e5685SJohn Baldwin 		    TLS_GET_RECORD, IPPROTO_TCP, M_WAITOK);
18633c0e5685SJohn Baldwin 
18643c0e5685SJohn Baldwin 		SOCKBUF_LOCK(sb);
18653c0e5685SJohn Baldwin 		if (sb->sb_tlsdcc == 0) {
18663c0e5685SJohn Baldwin 			/* sbcut/drop/flush discarded these mbufs. */
18673c0e5685SJohn Baldwin 			MPASS(sb->sb_tlscc == 0);
18683c0e5685SJohn Baldwin 			m_freem(data);
18693c0e5685SJohn Baldwin 			m_freem(control);
18703c0e5685SJohn Baldwin 			break;
18713c0e5685SJohn Baldwin 		}
18723c0e5685SJohn Baldwin 
18733c0e5685SJohn Baldwin 		/*
18743c0e5685SJohn Baldwin 		 * Clear the 'dcc' accounting in preparation for
18753c0e5685SJohn Baldwin 		 * adding the decrypted record.
18763c0e5685SJohn Baldwin 		 */
18773c0e5685SJohn Baldwin 		sb->sb_ccc -= tls_len;
18783c0e5685SJohn Baldwin 		sb->sb_tlsdcc = 0;
18793c0e5685SJohn Baldwin 		SBCHECK(sb);
18803c0e5685SJohn Baldwin 
18813c0e5685SJohn Baldwin 		/* If there is no payload, drop all of the data. */
18823c0e5685SJohn Baldwin 		if (tgr.tls_length == htobe16(0)) {
18833c0e5685SJohn Baldwin 			m_freem(data);
18843c0e5685SJohn Baldwin 			data = NULL;
18853c0e5685SJohn Baldwin 		} else {
18863c0e5685SJohn Baldwin 			/* Trim header. */
18873c0e5685SJohn Baldwin 			remain = tls->params.tls_hlen;
18883c0e5685SJohn Baldwin 			while (remain > 0) {
18893c0e5685SJohn Baldwin 				if (data->m_len > remain) {
18903c0e5685SJohn Baldwin 					data->m_data += remain;
18913c0e5685SJohn Baldwin 					data->m_len -= remain;
18923c0e5685SJohn Baldwin 					break;
18933c0e5685SJohn Baldwin 				}
18943c0e5685SJohn Baldwin 				remain -= data->m_len;
18953c0e5685SJohn Baldwin 				data = m_free(data);
18963c0e5685SJohn Baldwin 			}
18973c0e5685SJohn Baldwin 
18983c0e5685SJohn Baldwin 			/* Trim trailer and clear M_NOTREADY. */
18993c0e5685SJohn Baldwin 			remain = be16toh(tgr.tls_length);
19003c0e5685SJohn Baldwin 			m = data;
19013c0e5685SJohn Baldwin 			for (m = data; remain > m->m_len; m = m->m_next) {
19023c0e5685SJohn Baldwin 				m->m_flags &= ~M_NOTREADY;
19033c0e5685SJohn Baldwin 				remain -= m->m_len;
19043c0e5685SJohn Baldwin 			}
19053c0e5685SJohn Baldwin 			m->m_len = remain;
19063c0e5685SJohn Baldwin 			m_freem(m->m_next);
19073c0e5685SJohn Baldwin 			m->m_next = NULL;
19083c0e5685SJohn Baldwin 			m->m_flags &= ~M_NOTREADY;
19093c0e5685SJohn Baldwin 
19103c0e5685SJohn Baldwin 			/* Set EOR on the final mbuf. */
19113c0e5685SJohn Baldwin 			m->m_flags |= M_EOR;
19123c0e5685SJohn Baldwin 		}
19133c0e5685SJohn Baldwin 
19143c0e5685SJohn Baldwin 		sbappendcontrol_locked(sb, data, control, 0);
19153c0e5685SJohn Baldwin 	}
19163c0e5685SJohn Baldwin 
19173c0e5685SJohn Baldwin 	sb->sb_flags &= ~SB_TLS_RX_RUNNING;
19183c0e5685SJohn Baldwin 
19193c0e5685SJohn Baldwin 	if ((sb->sb_state & SBS_CANTRCVMORE) != 0 && sb->sb_tlscc > 0)
19203c0e5685SJohn Baldwin 		so->so_error = EMSGSIZE;
19213c0e5685SJohn Baldwin 
19223c0e5685SJohn Baldwin 	sorwakeup_locked(so);
19233c0e5685SJohn Baldwin 
19243c0e5685SJohn Baldwin deref:
19253c0e5685SJohn Baldwin 	SOCKBUF_UNLOCK_ASSERT(sb);
19263c0e5685SJohn Baldwin 
19273c0e5685SJohn Baldwin 	CURVNET_SET(so->so_vnet);
19283c0e5685SJohn Baldwin 	SOCK_LOCK(so);
19293c0e5685SJohn Baldwin 	sorele(so);
19303c0e5685SJohn Baldwin 	CURVNET_RESTORE();
19313c0e5685SJohn Baldwin }
19323c0e5685SJohn Baldwin 
19333c0e5685SJohn Baldwin void
1934d90fe9d0SGleb Smirnoff ktls_enqueue_to_free(struct mbuf *m)
1935b2e60773SJohn Baldwin {
1936b2e60773SJohn Baldwin 	struct ktls_wq *wq;
1937b2e60773SJohn Baldwin 	bool running;
1938b2e60773SJohn Baldwin 
1939b2e60773SJohn Baldwin 	/* Mark it for freeing. */
19407b6c99d0SGleb Smirnoff 	m->m_epg_flags |= EPG_FLAG_2FREE;
19417b6c99d0SGleb Smirnoff 	wq = &ktls_wq[m->m_epg_tls->wq_index];
1942b2e60773SJohn Baldwin 	mtx_lock(&wq->mtx);
19433c0e5685SJohn Baldwin 	STAILQ_INSERT_TAIL(&wq->m_head, m, m_epg_stailq);
1944b2e60773SJohn Baldwin 	running = wq->running;
1945b2e60773SJohn Baldwin 	mtx_unlock(&wq->mtx);
1946b2e60773SJohn Baldwin 	if (!running)
1947b2e60773SJohn Baldwin 		wakeup(wq);
1948b2e60773SJohn Baldwin }
1949b2e60773SJohn Baldwin 
1950b2e60773SJohn Baldwin void
1951b2e60773SJohn Baldwin ktls_enqueue(struct mbuf *m, struct socket *so, int page_count)
1952b2e60773SJohn Baldwin {
1953b2e60773SJohn Baldwin 	struct ktls_wq *wq;
1954b2e60773SJohn Baldwin 	bool running;
1955b2e60773SJohn Baldwin 
19566edfd179SGleb Smirnoff 	KASSERT(((m->m_flags & (M_EXTPG | M_NOTREADY)) ==
19576edfd179SGleb Smirnoff 	    (M_EXTPG | M_NOTREADY)),
1958b2e60773SJohn Baldwin 	    ("ktls_enqueue: %p not unready & nomap mbuf\n", m));
1959b2e60773SJohn Baldwin 	KASSERT(page_count != 0, ("enqueueing TLS mbuf with zero page count"));
1960b2e60773SJohn Baldwin 
19617b6c99d0SGleb Smirnoff 	KASSERT(m->m_epg_tls->mode == TCP_TLS_MODE_SW, ("!SW TLS mbuf"));
1962b2e60773SJohn Baldwin 
19637b6c99d0SGleb Smirnoff 	m->m_epg_enc_cnt = page_count;
1964b2e60773SJohn Baldwin 
1965b2e60773SJohn Baldwin 	/*
1966b2e60773SJohn Baldwin 	 * Save a pointer to the socket.  The caller is responsible
1967b2e60773SJohn Baldwin 	 * for taking an additional reference via soref().
1968b2e60773SJohn Baldwin 	 */
19697b6c99d0SGleb Smirnoff 	m->m_epg_so = so;
1970b2e60773SJohn Baldwin 
19717b6c99d0SGleb Smirnoff 	wq = &ktls_wq[m->m_epg_tls->wq_index];
1972b2e60773SJohn Baldwin 	mtx_lock(&wq->mtx);
19733c0e5685SJohn Baldwin 	STAILQ_INSERT_TAIL(&wq->m_head, m, m_epg_stailq);
1974b2e60773SJohn Baldwin 	running = wq->running;
1975b2e60773SJohn Baldwin 	mtx_unlock(&wq->mtx);
1976b2e60773SJohn Baldwin 	if (!running)
1977b2e60773SJohn Baldwin 		wakeup(wq);
19783c0e5685SJohn Baldwin 	counter_u64_add(ktls_cnt_tx_queued, 1);
1979b2e60773SJohn Baldwin }
1980b2e60773SJohn Baldwin 
1981b2e60773SJohn Baldwin static __noinline void
1982d90fe9d0SGleb Smirnoff ktls_encrypt(struct mbuf *top)
1983b2e60773SJohn Baldwin {
1984b2e60773SJohn Baldwin 	struct ktls_session *tls;
1985b2e60773SJohn Baldwin 	struct socket *so;
1986d90fe9d0SGleb Smirnoff 	struct mbuf *m;
1987b2e60773SJohn Baldwin 	vm_paddr_t parray[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1988b2e60773SJohn Baldwin 	struct iovec src_iov[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1989b2e60773SJohn Baldwin 	struct iovec dst_iov[1 + btoc(TLS_MAX_MSG_SIZE_V10_2)];
1990b2e60773SJohn Baldwin 	vm_page_t pg;
1991b2e60773SJohn Baldwin 	int error, i, len, npages, off, total_pages;
1992b2e60773SJohn Baldwin 	bool is_anon;
1993b2e60773SJohn Baldwin 
19947b6c99d0SGleb Smirnoff 	so = top->m_epg_so;
19957b6c99d0SGleb Smirnoff 	tls = top->m_epg_tls;
1996d90fe9d0SGleb Smirnoff 	KASSERT(tls != NULL, ("tls = NULL, top = %p\n", top));
1997d90fe9d0SGleb Smirnoff 	KASSERT(so != NULL, ("so = NULL, top = %p\n", top));
1998b2e60773SJohn Baldwin #ifdef INVARIANTS
19997b6c99d0SGleb Smirnoff 	top->m_epg_so = NULL;
2000b2e60773SJohn Baldwin #endif
20017b6c99d0SGleb Smirnoff 	total_pages = top->m_epg_enc_cnt;
2002b2e60773SJohn Baldwin 	npages = 0;
2003b2e60773SJohn Baldwin 
2004b2e60773SJohn Baldwin 	/*
2005b2e60773SJohn Baldwin 	 * Encrypt the TLS records in the chain of mbufs starting with
2006b2e60773SJohn Baldwin 	 * 'top'.  'total_pages' gives us a total count of pages and is
2007b2e60773SJohn Baldwin 	 * used to know when we have finished encrypting the TLS
2008b2e60773SJohn Baldwin 	 * records originally queued with 'top'.
2009b2e60773SJohn Baldwin 	 *
2010b2e60773SJohn Baldwin 	 * NB: These mbufs are queued in the socket buffer and
2011b2e60773SJohn Baldwin 	 * 'm_next' is traversing the mbufs in the socket buffer.  The
2012b2e60773SJohn Baldwin 	 * socket buffer lock is not held while traversing this chain.
2013b2e60773SJohn Baldwin 	 * Since the mbufs are all marked M_NOTREADY their 'm_next'
2014b2e60773SJohn Baldwin 	 * pointers should be stable.  However, the 'm_next' of the
2015b2e60773SJohn Baldwin 	 * last mbuf encrypted is not necessarily NULL.  It can point
2016b2e60773SJohn Baldwin 	 * to other mbufs appended while 'top' was on the TLS work
2017b2e60773SJohn Baldwin 	 * queue.
2018b2e60773SJohn Baldwin 	 *
2019b2e60773SJohn Baldwin 	 * Each mbuf holds an entire TLS record.
2020b2e60773SJohn Baldwin 	 */
2021b2e60773SJohn Baldwin 	error = 0;
2022b2e60773SJohn Baldwin 	for (m = top; npages != total_pages; m = m->m_next) {
20237b6c99d0SGleb Smirnoff 		KASSERT(m->m_epg_tls == tls,
2024b2e60773SJohn Baldwin 		    ("different TLS sessions in a single mbuf chain: %p vs %p",
20257b6c99d0SGleb Smirnoff 		    tls, m->m_epg_tls));
20266edfd179SGleb Smirnoff 		KASSERT((m->m_flags & (M_EXTPG | M_NOTREADY)) ==
20276edfd179SGleb Smirnoff 		    (M_EXTPG | M_NOTREADY),
2028b2e60773SJohn Baldwin 		    ("%p not unready & nomap mbuf (top = %p)\n", m, top));
20297b6c99d0SGleb Smirnoff 		KASSERT(npages + m->m_epg_npgs <= total_pages,
2030b2e60773SJohn Baldwin 		    ("page count mismatch: top %p, total_pages %d, m %p", top,
2031b2e60773SJohn Baldwin 		    total_pages, m));
2032b2e60773SJohn Baldwin 
2033b2e60773SJohn Baldwin 		/*
2034b2e60773SJohn Baldwin 		 * Generate source and destination ivoecs to pass to
2035b2e60773SJohn Baldwin 		 * the SW encryption backend.  For writable mbufs, the
2036b2e60773SJohn Baldwin 		 * destination iovec is a copy of the source and
2037b2e60773SJohn Baldwin 		 * encryption is done in place.  For file-backed mbufs
2038b2e60773SJohn Baldwin 		 * (from sendfile), anonymous wired pages are
2039b2e60773SJohn Baldwin 		 * allocated and assigned to the destination iovec.
2040b2e60773SJohn Baldwin 		 */
20417b6c99d0SGleb Smirnoff 		is_anon = (m->m_epg_flags & EPG_FLAG_ANON) != 0;
2042b2e60773SJohn Baldwin 
20437b6c99d0SGleb Smirnoff 		off = m->m_epg_1st_off;
20447b6c99d0SGleb Smirnoff 		for (i = 0; i < m->m_epg_npgs; i++, off = 0) {
2045c4ee38f8SGleb Smirnoff 			len = m_epg_pagelen(m, i, off);
2046b2e60773SJohn Baldwin 			src_iov[i].iov_len = len;
2047b2e60773SJohn Baldwin 			src_iov[i].iov_base =
20480c103266SGleb Smirnoff 			    (char *)(void *)PHYS_TO_DMAP(m->m_epg_pa[i]) +
204923feb563SAndrew Gallatin 				off;
2050b2e60773SJohn Baldwin 
2051b2e60773SJohn Baldwin 			if (is_anon) {
2052b2e60773SJohn Baldwin 				dst_iov[i].iov_base = src_iov[i].iov_base;
2053b2e60773SJohn Baldwin 				dst_iov[i].iov_len = src_iov[i].iov_len;
2054b2e60773SJohn Baldwin 				continue;
2055b2e60773SJohn Baldwin 			}
2056b2e60773SJohn Baldwin retry_page:
2057b2e60773SJohn Baldwin 			pg = vm_page_alloc(NULL, 0, VM_ALLOC_NORMAL |
2058b2e60773SJohn Baldwin 			    VM_ALLOC_NOOBJ | VM_ALLOC_NODUMP | VM_ALLOC_WIRED);
2059b2e60773SJohn Baldwin 			if (pg == NULL) {
2060b2e60773SJohn Baldwin 				vm_wait(NULL);
2061b2e60773SJohn Baldwin 				goto retry_page;
2062b2e60773SJohn Baldwin 			}
2063b2e60773SJohn Baldwin 			parray[i] = VM_PAGE_TO_PHYS(pg);
2064b2e60773SJohn Baldwin 			dst_iov[i].iov_base =
2065b2e60773SJohn Baldwin 			    (char *)(void *)PHYS_TO_DMAP(parray[i]) + off;
2066b2e60773SJohn Baldwin 			dst_iov[i].iov_len = len;
2067b2e60773SJohn Baldwin 		}
2068b2e60773SJohn Baldwin 
2069c2a8fd6fSJohn Baldwin 		if (__predict_false(m->m_epg_npgs == 0)) {
2070c2a8fd6fSJohn Baldwin 			/* TLS 1.0 empty fragment. */
2071c2a8fd6fSJohn Baldwin 			npages++;
2072c2a8fd6fSJohn Baldwin 		} else
2073b2e60773SJohn Baldwin 			npages += i;
2074b2e60773SJohn Baldwin 
2075b2e60773SJohn Baldwin 		error = (*tls->sw_encrypt)(tls,
20760c103266SGleb Smirnoff 		    (const struct tls_record_layer *)m->m_epg_hdr,
20777b6c99d0SGleb Smirnoff 		    m->m_epg_trail, src_iov, dst_iov, i, m->m_epg_seqno,
20787b6c99d0SGleb Smirnoff 		    m->m_epg_record_type);
2079b2e60773SJohn Baldwin 		if (error) {
2080b2e60773SJohn Baldwin 			counter_u64_add(ktls_offload_failed_crypto, 1);
2081b2e60773SJohn Baldwin 			break;
2082b2e60773SJohn Baldwin 		}
2083b2e60773SJohn Baldwin 
2084b2e60773SJohn Baldwin 		/*
2085b2e60773SJohn Baldwin 		 * For file-backed mbufs, release the file-backed
2086b2e60773SJohn Baldwin 		 * pages and replace them in the ext_pgs array with
2087b2e60773SJohn Baldwin 		 * the anonymous wired pages allocated above.
2088b2e60773SJohn Baldwin 		 */
2089b2e60773SJohn Baldwin 		if (!is_anon) {
2090b2e60773SJohn Baldwin 			/* Free the old pages. */
2091b2e60773SJohn Baldwin 			m->m_ext.ext_free(m);
2092b2e60773SJohn Baldwin 
2093b2e60773SJohn Baldwin 			/* Replace them with the new pages. */
20947b6c99d0SGleb Smirnoff 			for (i = 0; i < m->m_epg_npgs; i++)
20950c103266SGleb Smirnoff 				m->m_epg_pa[i] = parray[i];
2096b2e60773SJohn Baldwin 
2097b2e60773SJohn Baldwin 			/* Use the basic free routine. */
2098b2e60773SJohn Baldwin 			m->m_ext.ext_free = mb_free_mext_pgs;
2099b2dba663SAndrew Gallatin 
2100b2dba663SAndrew Gallatin 			/* Pages are now writable. */
21017b6c99d0SGleb Smirnoff 			m->m_epg_flags |= EPG_FLAG_ANON;
2102b2e60773SJohn Baldwin 		}
2103b2e60773SJohn Baldwin 
2104b2e60773SJohn Baldwin 		/*
2105b2e60773SJohn Baldwin 		 * Drop a reference to the session now that it is no
2106b2e60773SJohn Baldwin 		 * longer needed.  Existing code depends on encrypted
2107b2e60773SJohn Baldwin 		 * records having no associated session vs
2108b2e60773SJohn Baldwin 		 * yet-to-be-encrypted records having an associated
2109b2e60773SJohn Baldwin 		 * session.
2110b2e60773SJohn Baldwin 		 */
21117b6c99d0SGleb Smirnoff 		m->m_epg_tls = NULL;
2112b2e60773SJohn Baldwin 		ktls_free(tls);
2113b2e60773SJohn Baldwin 	}
2114b2e60773SJohn Baldwin 
2115b2e60773SJohn Baldwin 	CURVNET_SET(so->so_vnet);
2116b2e60773SJohn Baldwin 	if (error == 0) {
2117b2e60773SJohn Baldwin 		(void)(*so->so_proto->pr_usrreqs->pru_ready)(so, top, npages);
2118b2e60773SJohn Baldwin 	} else {
2119b2e60773SJohn Baldwin 		so->so_proto->pr_usrreqs->pru_abort(so);
2120b2e60773SJohn Baldwin 		so->so_error = EIO;
2121b2e60773SJohn Baldwin 		mb_free_notready(top, total_pages);
2122b2e60773SJohn Baldwin 	}
2123b2e60773SJohn Baldwin 
2124b2e60773SJohn Baldwin 	SOCK_LOCK(so);
2125b2e60773SJohn Baldwin 	sorele(so);
2126b2e60773SJohn Baldwin 	CURVNET_RESTORE();
2127b2e60773SJohn Baldwin }
2128b2e60773SJohn Baldwin 
2129b2e60773SJohn Baldwin static void
2130b2e60773SJohn Baldwin ktls_work_thread(void *ctx)
2131b2e60773SJohn Baldwin {
2132b2e60773SJohn Baldwin 	struct ktls_wq *wq = ctx;
2133d90fe9d0SGleb Smirnoff 	struct mbuf *m, *n;
21343c0e5685SJohn Baldwin 	struct socket *so, *son;
21353c0e5685SJohn Baldwin 	STAILQ_HEAD(, mbuf) local_m_head;
21363c0e5685SJohn Baldwin 	STAILQ_HEAD(, socket) local_so_head;
2137b2e60773SJohn Baldwin 
213802bc3865SAndrew Gallatin 	if (ktls_bind_threads > 1) {
213902bc3865SAndrew Gallatin 		curthread->td_domain.dr_policy =
214002bc3865SAndrew Gallatin 			DOMAINSET_PREF(PCPU_GET(domain));
214102bc3865SAndrew Gallatin 	}
2142b2e60773SJohn Baldwin #if defined(__aarch64__) || defined(__amd64__) || defined(__i386__)
2143b2e60773SJohn Baldwin 	fpu_kern_thread(0);
2144b2e60773SJohn Baldwin #endif
2145b2e60773SJohn Baldwin 	for (;;) {
2146b2e60773SJohn Baldwin 		mtx_lock(&wq->mtx);
21473c0e5685SJohn Baldwin 		while (STAILQ_EMPTY(&wq->m_head) &&
21483c0e5685SJohn Baldwin 		    STAILQ_EMPTY(&wq->so_head)) {
2149b2e60773SJohn Baldwin 			wq->running = false;
2150b2e60773SJohn Baldwin 			mtx_sleep(wq, &wq->mtx, 0, "-", 0);
2151b2e60773SJohn Baldwin 			wq->running = true;
2152b2e60773SJohn Baldwin 		}
2153b2e60773SJohn Baldwin 
21543c0e5685SJohn Baldwin 		STAILQ_INIT(&local_m_head);
21553c0e5685SJohn Baldwin 		STAILQ_CONCAT(&local_m_head, &wq->m_head);
21563c0e5685SJohn Baldwin 		STAILQ_INIT(&local_so_head);
21573c0e5685SJohn Baldwin 		STAILQ_CONCAT(&local_so_head, &wq->so_head);
2158b2e60773SJohn Baldwin 		mtx_unlock(&wq->mtx);
2159b2e60773SJohn Baldwin 
21603c0e5685SJohn Baldwin 		STAILQ_FOREACH_SAFE(m, &local_m_head, m_epg_stailq, n) {
21617b6c99d0SGleb Smirnoff 			if (m->m_epg_flags & EPG_FLAG_2FREE) {
21627b6c99d0SGleb Smirnoff 				ktls_free(m->m_epg_tls);
216323feb563SAndrew Gallatin 				uma_zfree(zone_mbuf, m);
2164eeec8348SGleb Smirnoff 			} else {
2165d90fe9d0SGleb Smirnoff 				ktls_encrypt(m);
21663c0e5685SJohn Baldwin 				counter_u64_add(ktls_cnt_tx_queued, -1);
2167b2e60773SJohn Baldwin 			}
2168b2e60773SJohn Baldwin 		}
21693c0e5685SJohn Baldwin 
21703c0e5685SJohn Baldwin 		STAILQ_FOREACH_SAFE(so, &local_so_head, so_ktls_rx_list, son) {
21713c0e5685SJohn Baldwin 			ktls_decrypt(so);
21723c0e5685SJohn Baldwin 			counter_u64_add(ktls_cnt_rx_queued, -1);
21733c0e5685SJohn Baldwin 		}
2174b2e60773SJohn Baldwin 	}
2175b2e60773SJohn Baldwin }
2176