xref: /freebsd/sys/opencrypto/ktls.h (revision 4d846d26)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2021 Netflix Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef __OPENCRYPTO_KTLS_H__
29 #define	__OPENCRYPTO_KTLS_H__
30 
31 #define	MAX_TLS_PAGES	(1 + btoc(TLS_MAX_MSG_SIZE_V10_2))
32 
33 struct ktls_ocf_encrypt_state {
34 	struct socket *so;
35 	struct mbuf *m;
36 	void *cbuf;
37 	struct iovec dst_iov[MAX_TLS_PAGES + 2];
38 	vm_paddr_t parray[MAX_TLS_PAGES + 1];
39 
40 	struct cryptop crp;
41 	struct uio uio;
42 	union {
43 		struct tls_mac_data mac;
44 		struct tls_aead_data aead;
45 		struct tls_aead_data_13 aead13;
46 	};
47 };
48 
49 void ktls_encrypt_cb(struct ktls_ocf_encrypt_state *state, int error);
50 void ktls_ocf_free(struct ktls_session *tls);
51 int ktls_ocf_try(struct socket *so, struct ktls_session *tls, int direction);
52 int ktls_ocf_encrypt(struct ktls_ocf_encrypt_state *state,
53     struct ktls_session *tls, struct mbuf *m, struct iovec *outiov,
54     int outiovcnt);
55 int ktls_ocf_decrypt(struct ktls_session *tls,
56     const struct tls_record_layer *hdr, struct mbuf *m, uint64_t seqno,
57     int *trailer_len);
58 int ktls_ocf_recrypt(struct ktls_session *tls,
59     const struct tls_record_layer *hdr, struct mbuf *m, uint64_t seqno);
60 bool ktls_ocf_recrypt_supported(struct ktls_session *tls);
61 
62 #endif	/* !__OPENCRYPTO_KTLS_H__ */
63