share/man/man4/ossl.4

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