safe(4) [debian man page]

SAFE(4) 						   BSD Kernel Interfaces Manual 						   SAFE(4)

NAME

     safe -- SafeNet crypto accelerator

SYNOPSIS

     To compile this driver into the kernel, place the following lines in your kernel configuration file:

	   device crypto
	   device cryptodev
	   device safe

     Alternatively, to load the driver as a module at boot time, place the following line in loader.conf(5):

	   safe_load="YES"

     sysctl hw.safe.debug
     sysctl hw.safe.dump
     sysctl hw.safe.rnginterval
     sysctl hw.safe.rngbufsize
     sysctl hw.safe.rngmaxalarm

DESCRIPTION

     The safe driver supports cards containing SafeNet crypto accelerator chips.

     The safe driver registers itself to accelerate DES, Triple-DES, AES, MD5-HMAC, SHA1-HMAC, and NULL operations for ipsec(4) and crypto(4).

     On all models, the driver registers itself to provide random data to the random(4) subsystem.  Periodically the driver will poll the hardware
     RNG and retrieve data for use by the system.  If the driver detects that the hardware RNG is resonating with any local signal, it will reset
     the oscillators that generate random data.  Three sysctl(8) settings control this procedure: hw.safe.rnginterval specifies the time, in sec-
     onds, between polling operations, hw.safe.rngbufsize specifies the number of 32-bit words to retrieve on each poll, and hw.safe.rngmaxalarm
     specifies the threshold for resetting the oscillators.

     When the driver is compiled with SAFE_DEBUG defined, two sysctl(8) variables are provided for debugging purposes: hw.safe.debug can be set to
     a non-zero value to enable debugging messages to be sent to the console for each cryptographic operation, hw.safe.dump is a write-only vari-
     able that can be used to force driver state to be sent to the console.  Set this variable to ``ring'' to dump the current state of the
     descriptor ring, to ``dma'' to dump the hardware DMA registers, or to ``int'' to dump the hardware interrupt registers.

HARDWARE

     The safe driver supports cards containing any of the following chips:

	   SafeNet 1141  The original chipset.	Supports DES, Triple-DES, AES, MD5, and SHA-1 symmetric crypto operations, RNG, public key opera-
			 tions, and full IPsec packet processing.

	   SafeNet 1741  A faster version of the 1141.

SEE ALSO

     crypt(3), crypto(4), intro(4), ipsec(4), random(4), crypto(9)

BUGS

     Public key support is not implemented.

BSD
								   April 1, 2006							       BSD

HIFN(4) 						   BSD Kernel Interfaces Manual 						   HIFN(4)

NAME

     hifn -- Hifn 7751/7951/7811/7955/7956 crypto accelerator

SYNOPSIS

     To compile this driver into the kernel, place the following lines in your kernel configuration file:

	   device crypto
	   device cryptodev
	   device hifn

     Alternatively, to load the driver as a module at boot time, place the following line in loader.conf(5):

	   hifn_load="YES"

DESCRIPTION

     The hifn driver supports various cards containing the Hifn 7751, 7951, 7811, 7955, and 7956 chipsets.

     The hifn driver registers itself to accelerate DES, Triple-DES, AES (7955 and 7956 only), ARC4, MD5, MD5-HMAC, SHA1, and SHA1-HMAC operations
     for ipsec(4) and crypto(4).

     The Hifn 7951, 7811, 7955, and 7956 will also supply data to the kernel random(4) subsystem.

HARDWARE

     The hifn driver supports various cards containing the Hifn 7751, 7951, 7811, 7955, and 7956 chipsets, such as:

	   Invertex AEON   No longer being made.  Came as 128KB SRAM model, or 2MB DRAM model.

	   Hifn 7751	   Reference board with 512KB SRAM.

	   PowerCrypt	   Comes with 512KB SRAM.

	   XL-Crypt	   Only board based on 7811 (which is faster than 7751 and has a random number generator).

	   NetSec 7751	   Supports the most IPsec sessions, with 1MB SRAM.

	   Soekris Engineering vpn1201 and vpn1211
			   See http://www.soekris.com/.  Contains a 7951 and supports symmetric and random number operations.

	   Soekris Engineering vpn1401 and vpn1411
			   See http://www.soekris.com/.  Contains a 7955 and supports symmetric and random number operations.

SEE ALSO

     crypt(3), crypto(4), intro(4), ipsec(4), random(4), crypto(9)

HISTORY

     The hifn device driver appeared in OpenBSD 2.7.  The hifn device driver was imported to FreeBSD 5.0.

CAVEATS

     The Hifn 9751 shares the same PCI ID.  This chip is basically a 7751, but with the cryptographic functions missing.  Instead, the 9751 is
     only capable of doing compression.  Since we do not currently attempt to use any of these chips to do compression, the 9751-based cards are
     not useful.

     Support for the 7955 and 7956 is incomplete; the asymmetric crypto facilities are to be added and the performance is suboptimal.

BUGS

     The 7751 chip starts out at initialization by only supporting compression.  A proprietary algorithm, which has been reverse engineered, is
     required to unlock the cryptographic functionality of the chip.  It is possible for vendors to make boards which have a lock ID not known to
     the driver, but all vendors currently just use the obvious ID which is 13 bytes of 0.

BSD
								 October 19, 2009							       BSD