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 May 30, 2002 29.Dt SAFE 4 30.Os 31.Sh NAME 32.Nm safe 33.Nd SafeNet crypto accelerator 34.Sh SYNOPSIS 35.Cd "device safe" 36.Pp 37.Nm sysctl Va hw.safe.debug 38.Nm sysctl Va hw.safe.dump 39.Nm sysctl Va hw.safe.rnginterval 40.Nm sysctl Va hw.safe.rngbufsize 41.Nm sysctl Va hw.safe.rngmaxalarm 42.Sh DESCRIPTION 43The 44.Nm 45driver supports cards containing any of the following chips: 46.Bl -tag -width "SafeNet 1141" -offset indent 47.It SafeNet 1141 48The original chipset. 49Supports DES, Triple-DES, AES, MD5, and SHA-1 50symmetric crypto operations, RNG, public key operations, and full IPsec 51packet processing. 52.It SafeNet 1741 53A faster version of the 1141. 54.El 55.Pp 56The 57.Nm 58driver registers itself to accelerate DES, Triple-DES, AES, MD5-HMAC, 59SHA1-HMAC, and NULL operations for 60.Xr ipsec 4 61and 62.Xr crypto 4 . 63.Pp 64On all models, the driver registers itself to provide random data to the 65.Xr random 4 66subsystem. 67Periodically the driver will poll the hardware RNG and retrieve 68data for use by the system. 69If the driver detects that the hardware RNG is resonating with any local 70signal, it will reset the oscillators that generate random data. 71Three 72.Xr sysctl 8 73settings control this procedure: 74.Va hw.safe.rnginterval 75specifies the time, in seconds, between polling operations, 76.Va hw.safe.rngbufsize 77specifies the number of 32-bit words to retrieve on each poll, 78and 79.Va hw.safe.rngmaxalarm 80specifies the threshold for resetting the oscillators. 81.Pp 82When the driver is compiled with 83.Dv SAFE_DEBUG 84defined, two 85.Xr sysctl 8 86variables are provided for debugging purposes: 87.Va hw.safe.debug 88can be set to a non-zero value to enable debugging messages to be sent 89to the console for each cryptographic operation, 90.Va hw.safe.dump 91is a write-only variable that can be used to force driver state to be sent 92to the console. 93Set this variable to 94.Dq Li ring 95to dump the current state of the descriptor ring, 96to 97.Dq Li dma 98to dump the hardware DMA registers, 99or 100to 101.Dq Li int 102to dump the hardware interrupt registers. 103.Sh SEE ALSO 104.Xr crypt 3 , 105.Xr crypto 4 , 106.Xr intro 4 , 107.Xr ipsec 4 , 108.Xr random 4 , 109.Xr crypto 9 110.Sh BUGS 111Public key support is not implemented. 112