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