xref: /freebsd/share/man/man4/ossl.4 (revision e2eeea75eb8b6dd50c1298067a0655880d186734)
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.\" $FreeBSD$
28.\"
29.Dd October 19, 2020
30.Dt OSSL 4
31.Os
32.Sh NAME
33.Nm ossl
34.Nd "driver using OpenSSL assembly routines on x86 CPUs"
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device crypto"
41.Cd "device cryptodev"
42.Cd "device ossl"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49ossl_load="YES"
50.Ed
51.Sh DESCRIPTION
52The OpenSSL distribution includes architecture-specific
53implementations for some commonly used cryptographic algorithms.
54This driver adds a wrapper around these routines permitting them to be
55used by in-kernel cryptography consumers such as kernel TLS and IPsec.
56.Pp
57The
58.Nm
59driver includes architecture-specific implementations for the following
60architectures:
61.Pp
62.Bl -bullet -compact
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
75SHA1
76.It
77SHA1-HMAC
78.It
79SHA2-224
80.It
81SHA2-224-HMAC
82.It
83SHA2-256
84.It
85SHA2-256-HMAC
86.It
87SHA2-384
88.It
89SHA2-384-HMAC
90.It
91SHA2-512
92.It
93SHA2-512-HMAC
94.El
95.Sh SEE ALSO
96.Xr crypto 4 ,
97.Xr intro 4 ,
98.Xr ipsec 4 ,
99.Xr crypto 7 ,
100.Xr crypto 9
101.Sh HISTORY
102The
103.Nm
104driver first appeared in
105.Fx 13.0 .
106