Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/safexcel.4
- This file was added.
| .\"- | |||||
| .\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate) | |||||
| .\" | |||||
| .\" Redistribution and use in source and binary forms, with or without | |||||
| .\" modification, are permitted provided that the following conditions | |||||
| .\" are met: | |||||
| .\" 1. Redistributions of source code must retain the above copyright | |||||
| .\" notice, this list of conditions and the following disclaimer. | |||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | |||||
| .\" notice, this list of conditions and the following disclaimer in the | |||||
| .\" documentation and/or other materials provided with the distribution. | |||||
| .\" | |||||
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
| .\" SUCH DAMAGE. | |||||
| .\" | |||||
| .\" $FreeBSD$ | |||||
| .\" | |||||
| .Dd June 23, 2020 | |||||
| .Dt SAFEXCEL 4 | |||||
| .Os | |||||
| .Sh NAME | |||||
| .Nm safexcel | |||||
| .Nd Inside Secure SafeXcel-IP-97 security packet engine | |||||
| .Sh SYNOPSIS | |||||
| To compile this driver into the kernel, | |||||
| place the following lines in your | |||||
| kernel configuration file: | |||||
| .Bd -ragged -offset indent | |||||
| .Cd "device crypto" | |||||
| .Cd "device cryptodev" | |||||
| .Cd "device safexcel" | |||||
| .Ed | |||||
| .Pp | |||||
| Alternatively, to load the driver as a | |||||
| module at boot time, place the following line in | |||||
| .Xr loader.conf 5 : | |||||
| .Bd -literal -offset indent | |||||
| safexcel_load="YES" | |||||
| .Ed | |||||
| .Sh DESCRIPTION | |||||
| The | |||||
| .Nm | |||||
| driver implements | |||||
| .Xr crypto 4 | |||||
| support for the cryptographic acceleration functions of the EIP-97 device | |||||
| found on some Marvell systems-on-chip. | |||||
| The driver can accelerate the following AES modes: | |||||
| .Pp | |||||
| .Bl -bullet -compact | |||||
| .It | |||||
| AES-CBC | |||||
| .It | |||||
| AES-CTR | |||||
| .It | |||||
| AES-XTS | |||||
| .It | |||||
| AES-GCM | |||||
| .It | |||||
| AES-CCM | |||||
| .El | |||||
| .Pp | |||||
| .Nm | |||||
| also implements SHA1 and SHA2 transforms, and can combine AES-CBC and AES-CTR | |||||
| with SHA1-HMAC and SHA2-HMAC for encrypt-then-authenticate operations. | |||||
| .Sh SEE ALSO | |||||
| .Xr crypto 4 , | |||||
| .Xr ipsec 4 , | |||||
| .Xr random 4 , | |||||
| .Xr geli 8 , | |||||
| .Xr crypto 9 | |||||
| .Sh HISTORY | |||||
| The | |||||
| .Nm | |||||
| driver first appeared in | |||||
| .Fx 13.0 . | |||||