freebsd-nq/share/man/man4/crypto.4

.\"	$OpenBSD: crypto.4,v 1.4 2002/09/12 07:15:03 deraadt Exp $
.\"
.\" Copyright (c) 2001 Theo de Raadt
.\" All rights reserved.
.\"
.\" 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.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 September 7, 2010
.Dt CRYPTO 4
.Os
.Sh NAME
.Nm crypto ,
.Nm cryptodev
.Nd hardware crypto access driver
.Sh SYNOPSIS
.Cd device crypto
.Cd device cryptodev
.Sh DESCRIPTION
The
.Nm
driver provides a device-independent framework to support
cryptographic operations in the kernel.
The
.Nm cryptodev
driver provides userland applications access to this support
through the
.Pa /dev/crypto
device.
This node primarily operates in an
.Xr ioctl 2
based model, permitting a variety of applications to query device capabilities,
submit transactions, and get results.
.Pp
If
.Ar count
given in the specification, and is greater than 0, a maximum of one
.Nm
device is created.
.Pp
The following
.Xr ioctl 2
calls apply only to the
.Nm
devices:
.Bl -tag -width ".Dv CIOCGSESSION"
.It Dv CIOCGSESSION
Setup a new crypto session for a new type of operation.
.It Dv CIOCFSESSION
Free a previously established session.
.It Dv CIOCCRYPT
Perform a crypto operation against a previously setup session.
.El
.Sh FEATURES
Depending on hardware being present, the following symmetric and
asymmetric cryptographic features are potentially available from
.Pa /dev/crypto :
.Pp
.Bl -tag -width ".Dv CRYPTO_RIPEMD160_HMAC" -offset indent -compact
.It Dv CRYPTO_DES_CBC
.It Dv CRYPTO_3DES_CBC
.It Dv CRYPTO_BLF_CBC
.It Dv CRYPTO_CAMELLIA_CBC
.It Dv CRYPTO_CAST_CBC
.It Dv CRYPTO_SKIPJACK_CBC
.It Dv CRYPTO_MD5_HMAC
.It Dv CRYPTO_SHA1_HMAC
.It Dv CRYPTO_RIPEMD160_HMAC
.It Dv CRYPTO_MD5_KPDK
.It Dv CRYPTO_SHA1_KPDK
.It Dv CRYPTO_AES_CBC
.It Dv CRYPTO_ARC4
.It Dv CRYPTO_MD5
.It Dv CRYPTO_SHA1
.It Dv CRK_MOD_EXP
.It Dv CRK_MOD_EXP_CRT
.It Dv CRK_DSA_SIGN
.It Dv CRK_DSA_VERIFY
.It Dv CRK_DH_COMPUTE_KEY
.El
.Sh FILES
.Bl -tag -width ".Pa /dev/crypto" -compact
.It Pa /dev/crypto
crypto access device
.El
.Sh SEE ALSO
.Xr aesni 4 ,
.Xr glxsb 4 ,
.Xr hifn 4 ,
.Xr ipsec 4 ,
.Xr padlock 4 ,
.Xr safe 4 ,
.Xr ubsec 4 ,
.Xr geli 8 ,
.Xr crypto 9
.Sh HISTORY
The
.Nm
driver first appeared in
.Ox 3.0 .
The
.Nm
driver was imported to
.Fx 5.0 .
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.\" $OpenBSD: crypto.4,v 1.4 2002/09/12 07:15:03 deraadt Exp $`
			`.\"`
			`.\" Copyright (c) 2001 Theo de Raadt`
			`.\" All rights reserved.`
			`.\"`
			`.\" 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.`
			`.\" 3. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.`
			`.\"`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.\" $FreeBSD$`
			`.\"`
Xref aesni(4). 2010-09-09 21:39:06 +00:00			`.Dd September 7, 2010`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Dt CRYPTO 4`
			`.Os`
			`.Sh NAME`
Splice in cryptodev (this man page originated on openbsd where there is no cryptodev module.) Should probably create a separate cryptodev man page (or a link to this one) but for now add enough so folks understand the relationship between the two. Prodded by: phk 2004-01-16 17:21:02 +00:00			`.Nm crypto ,`
			`.Nm cryptodev`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Nd hardware crypto access driver`
			`.Sh SYNOPSIS`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Cd device crypto`
Splice in cryptodev (this man page originated on openbsd where there is no cryptodev module.) Should probably create a separate cryptodev man page (or a link to this one) but for now add enough so folks understand the relationship between the two. Prodded by: phk 2004-01-16 17:21:02 +00:00			`.Cd device cryptodev`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Splice in cryptodev (this man page originated on openbsd where there is no cryptodev module.) Should probably create a separate cryptodev man page (or a link to this one) but for now add enough so folks understand the relationship between the two. Prodded by: phk 2004-01-16 17:21:02 +00:00			`driver provides a device-independent framework to support`
			`cryptographic operations in the kernel.`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`The`
Splice in cryptodev (this man page originated on openbsd where there is no cryptodev module.) Should probably create a separate cryptodev man page (or a link to this one) but for now add enough so folks understand the relationship between the two. Prodded by: phk 2004-01-16 17:21:02 +00:00			`.Nm cryptodev`
			`driver provides userland applications access to this support`
			`through the`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Pa /dev/crypto`
Splice in cryptodev (this man page originated on openbsd where there is no cryptodev module.) Should probably create a separate cryptodev man page (or a link to this one) but for now add enough so folks understand the relationship between the two. Prodded by: phk 2004-01-16 17:21:02 +00:00			`device.`
			`This node primarily operates in an`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Xr ioctl 2`
			`based model, permitting a variety of applications to query device capabilities,`
			`submit transactions, and get results.`
			`.Pp`
			`If`
			`.Ar count`
			`given in the specification, and is greater than 0, a maximum of one`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Nm`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`device is created.`
			`.Pp`
			`The following`
			`.Xr ioctl 2`
			`calls apply only to the`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Nm`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`devices:`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Bl -tag -width ".Dv CIOCGSESSION"`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.It Dv CIOCGSESSION`
			`Setup a new crypto session for a new type of operation.`
			`.It Dv CIOCFSESSION`
			`Free a previously established session.`
			`.It Dv CIOCCRYPT`
			`Perform a crypto operation against a previously setup session.`
			`.El`
			`.Sh FEATURES`
			`Depending on hardware being present, the following symmetric and`
english(4) police. 2002-12-27 12:15:40 +00:00			`asymmetric cryptographic features are potentially available from`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Pa /dev/crypto :`
			`.Pp`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Bl -tag -width ".Dv CRYPTO_RIPEMD160_HMAC" -offset indent -compact`
			`.It Dv CRYPTO_DES_CBC`
			`.It Dv CRYPTO_3DES_CBC`
			`.It Dv CRYPTO_BLF_CBC`
Update to include the Camellia algorithm which is in the code but which was accidentally left undocumented in the manual page. 2008-06-16 14:33:54 +00:00			`.It Dv CRYPTO_CAMELLIA_CBC`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.It Dv CRYPTO_CAST_CBC`
			`.It Dv CRYPTO_SKIPJACK_CBC`
			`.It Dv CRYPTO_MD5_HMAC`
			`.It Dv CRYPTO_SHA1_HMAC`
			`.It Dv CRYPTO_RIPEMD160_HMAC`
			`.It Dv CRYPTO_MD5_KPDK`
			`.It Dv CRYPTO_SHA1_KPDK`
			`.It Dv CRYPTO_AES_CBC`
			`.It Dv CRYPTO_ARC4`
			`.It Dv CRYPTO_MD5`
			`.It Dv CRYPTO_SHA1`
			`.It Dv CRK_MOD_EXP`
			`.It Dv CRK_MOD_EXP_CRT`
			`.It Dv CRK_DSA_SIGN`
			`.It Dv CRK_DSA_VERIFY`
			`.It Dv CRK_DH_COMPUTE_KEY`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.El`
			`.Sh FILES`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Bl -tag -width ".Pa /dev/crypto" -compact`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.It Pa /dev/crypto`
			`crypto access device`
			`.El`
			`.Sh SEE ALSO`
Xref aesni(4). 2010-09-09 21:39:06 +00:00			`.Xr aesni 4 ,`
Xref glxsb(4). MFC after: 3 days 2009-03-03 07:58:01 +00:00			`.Xr glxsb 4 ,`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Xr hifn 4 ,`
Remove the last entries to fast_ipsec. Merge in parts of the old fast_ipsec.4 man page to ipsec.4 and start updating ipsec.4 man page. Reviewed by: brueffer, sam (slightly earlier versions), bmah Approved by: re (bmah) 2007-08-02 08:04:48 +00:00			`.Xr ipsec 4 ,`
Xref padlock(4), also fast_ipsec(4) and geli(8) as consumers of this device. MFC after: 3 days 2005-12-10 10:51:55 +00:00			`.Xr padlock 4 ,`
Add reference to safe.4 MFC after: 5 days 2003-12-27 15:00:07 +00:00			`.Xr safe 4 ,`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Xr ubsec 4 ,`
Xref padlock(4), also fast_ipsec(4) and geli(8) as consumers of this device. MFC after: 3 days 2005-12-10 10:51:55 +00:00			`.Xr geli 8 ,`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`.Xr crypto 9`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`driver first appeared in`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`.Ox 3.0 .`
manual pages for the new kernel crypto support (need work) Obtained from: openbsd 2002-10-04 20:43:30 +00:00			`The`
			`.Nm`
mdoc(7) police: overhaul. Approved by: re 2002-12-10 14:21:55 +00:00			`driver was imported to`
			`.Fx 5.0 .`