xref: /freebsd/share/man/man4/ossl.4 (revision 2f9966ff63d65bd474478888c9088eeae3f9c669)
1.\" Copyright (c) 2020 Netflix, Inc
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer,
8.\"    without modification.
9.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
10.\"    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
11.\"    redistribution must be conditioned upon including a substantially
12.\"    similar Disclaimer requirement for further binary redistribution.
13.\"
14.\" NO WARRANTY
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17.\" LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
18.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
19.\" THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
20.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
23.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
25.\" THE POSSIBILITY OF SUCH DAMAGES.
26.\"
27.Dd May 4, 2023
28.Dt OSSL 4
29.Os
30.Sh NAME
31.Nm ossl
32.Nd "driver using OpenSSL assembly routines"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device crypto"
39.Cd "device cryptodev"
40.Cd "device ossl"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47ossl_load="YES"
48.Ed
49.Sh DESCRIPTION
50The OpenSSL distribution includes architecture-specific
51implementations for some commonly used cryptographic algorithms.
52This driver adds a wrapper around these routines permitting them to be
53used by in-kernel cryptography consumers such as kernel TLS and IPsec.
54.Pp
55The
56.Nm
57driver includes architecture-specific implementations for the following
58architectures:
59.Pp
60.Bl -bullet -compact
61.It
62arm64
63.It
64amd64
65.It
66i386
67.El
68.Pp
69The
70.Nm
71driver includes support for the following algorithms:
72.Pp
73.Bl -bullet -compact
74.It
75AES-CBC
76.It
77AES-GCM (amd64 only)
78.It
79ChaCha20
80.It
81ChaCha20-Poly1305 (RFC 8439)
82.It
83Poly1305
84.It
85SHA1
86.It
87SHA1-HMAC
88.It
89SHA2-224
90.It
91SHA2-224-HMAC
92.It
93SHA2-256
94.It
95SHA2-256-HMAC
96.It
97SHA2-384
98.It
99SHA2-384-HMAC
100.It
101SHA2-512
102.It
103SHA2-512-HMAC
104.El
105.Sh SEE ALSO
106.Xr crypto 4 ,
107.Xr intro 4 ,
108.Xr ipsec 4 ,
109.Xr crypto 7 ,
110.Xr crypto 9
111.Sh HISTORY
112The
113.Nm
114driver first appeared in
115.Fx 13.0 .
116