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