1.\"- 2.\" Copyright (c) 2003 Sam Leffler, Errno Consulting 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\"/ 28.Dd July 29, 2020 29.Dt SAFE 4 30.Os 31.Sh NAME 32.Nm safe 33.Nd SafeNet crypto accelerator 34.Sh SYNOPSIS 35To compile this driver into the kernel, 36place the following lines in your 37kernel configuration file: 38.Bd -ragged -offset indent 39.Cd "device crypto" 40.Cd "device cryptodev" 41.Cd "device safe" 42.Ed 43.Pp 44Alternatively, to load the driver as a 45module at boot time, place the following line in 46.Xr loader.conf 5 : 47.Bd -literal -offset indent 48safe_load="YES" 49.Ed 50.Pp 51.Nm sysctl Va hw.safe.debug 52.Nm sysctl Va hw.safe.dump 53.Nm sysctl Va hw.safe.rnginterval 54.Nm sysctl Va hw.safe.rngbufsize 55.Nm sysctl Va hw.safe.rngmaxalarm 56.Sh DESCRIPTION 57The 58.Nm 59driver supports cards containing SafeNet crypto accelerator chips. 60.Pp 61The 62.Nm 63driver registers itself to accelerate AES, 64SHA1-HMAC, and NULL operations for 65.Xr ipsec 4 66and 67.Xr crypto 4 . 68.Pp 69On all models, the driver registers itself to provide random data to the 70.Xr random 4 71subsystem. 72Periodically the driver will poll the hardware RNG and retrieve 73data for use by the system. 74If the driver detects that the hardware RNG is resonating with any local 75signal, it will reset the oscillators that generate random data. 76Three 77.Xr sysctl 8 78settings control this procedure: 79.Va hw.safe.rnginterval 80specifies the time, in seconds, between polling operations, 81.Va hw.safe.rngbufsize 82specifies the number of 32-bit words to retrieve on each poll, 83and 84.Va hw.safe.rngmaxalarm 85specifies the threshold for resetting the oscillators. 86.Pp 87When the driver is compiled with 88.Dv SAFE_DEBUG 89defined, two 90.Xr sysctl 8 91variables are provided for debugging purposes: 92.Va hw.safe.debug 93can be set to a non-zero value to enable debugging messages to be sent 94to the console for each cryptographic operation, 95.Va hw.safe.dump 96is a write-only variable that can be used to force driver state to be sent 97to the console. 98Set this variable to 99.Dq Li ring 100to dump the current state of the descriptor ring, 101to 102.Dq Li dma 103to dump the hardware DMA registers, 104or 105to 106.Dq Li int 107to dump the hardware interrupt registers. 108.Sh HARDWARE 109The 110.Nm 111driver supports cards containing any of the following chips: 112.Bl -tag -width "SafeNet 1141" -offset indent 113.It SafeNet 1141 114The original chipset. 115Supports DES, Triple-DES, AES, MD5, and SHA-1 116symmetric crypto operations, RNG, public key operations, and full IPsec 117packet processing. 118.It SafeNet 1741 119A faster version of the 1141. 120.El 121.Sh SEE ALSO 122.Xr crypt 3 , 123.Xr crypto 4 , 124.Xr intro 4 , 125.Xr ipsec 4 , 126.Xr random 4 , 127.Xr crypto 7 , 128.Xr crypto 9 129.Sh BUGS 130Public key support is not implemented. 131