share/man/man4/crypto.4

   1 .\"     $OpenBSD: crypto.4,v 1.4 2002/09/12 07:15:03 deraadt Exp $
   2 .\"
   3 .\" Copyright (c) 2001 Theo de Raadt
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  21 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  23 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  25 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 .\" POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD: src/share/man/man4/crypto.4,v 1.9 2009/03/03 07:58:01 brueffer Exp $
  30 .\"
  31 .Dd August 21, 2010
  32 .Dt CRYPTO 4
  33 .Os
  34 .Sh NAME
  35 .Nm crypto ,
  36 .Nm cryptodev
  37 .Nd hardware crypto access driver
  38 .Sh SYNOPSIS
  39 .Cd device crypto
  40 .Cd device cryptodev
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides a device-independent framework to support
  45 cryptographic operations in the kernel.
  46 The
  47 .Nm cryptodev
  48 driver provides userland applications access to this support
  49 through the
  50 .Pa /dev/crypto
  51 device.
  52 This node primarily operates in an
  53 .Xr ioctl 2
  54 based model, permitting a variety of applications to query device capabilities,
  55 submit transactions, and get results.
  56 .Pp
  57 If
  58 .Ar count
  59 given in the specification, and is greater than 0, a maximum of one
  60 .Nm
  61 device is created.
  62 .Pp
  63 The following
  64 .Xr ioctl 2
  65 calls apply only to the
  66 .Nm
  67 devices:
  68 .Bl -tag -width ".Dv CIOCGSESSION"
  69 .It Dv CIOCGSESSION
  70 Setup a new crypto session for a new type of operation.
  71 .It Dv CIOCFSESSION
  72 Free a previously established session.
  73 .It Dv CIOCCRYPT
  74 Perform a crypto operation against a previously setup session.
  75 .El
  76 .Sh FEATURES
  77 Depending on hardware being present, the following symmetric and
  78 asymmetric cryptographic features are potentially available from
  79 .Pa /dev/crypto :
  80 .Pp
  81 .Bl -tag -width ".Dv CRYPTO_RIPEMD160_HMAC" -offset indent -compact
  82 .It Dv CRYPTO_DES_CBC
  83 .It Dv CRYPTO_3DES_CBC
  84 .It Dv CRYPTO_BLF_CBC
  85 .It Dv CRYPTO_CAMELLIA_CBC
  86 .It Dv CRYPTO_CAST_CBC
  87 .It Dv CRYPTO_SKIPJACK_CBC
  88 .It Dv CRYPTO_MD5_HMAC
  89 .It Dv CRYPTO_SHA1_HMAC
  90 .It Dv CRYPTO_RIPEMD160_HMAC
  91 .It Dv CRYPTO_MD5_KPDK
  92 .It Dv CRYPTO_SHA1_KPDK
  93 .It Dv CRYPTO_AES_CBC
  94 .It Dv CRYPTO_AES_XTS
  95 .It Dv CRYPTO_AES_CTR
  96 .It Dv CRYPTO_AES_GCM16
  97 .It Dv CRYPTO_AES_GMAC
  98 .It Dv CRYPTO_AES_128_GMAC
  99 .It Dv CRYPTO_AES_192_GMAC
 100 .It Dv CRYPTO_AES_256_GMAC
 101 .It Dv CRYPTO_TWOFISH_CBC
 102 .It Dv CRYPTO_SERPENT_CBC
 103 .It Dv CRYPTO_TWOFISH_XTS
 104 .It Dv CRYPTO_SERPENT_XTS
 105 .It Dv CRYPTO_ARC4
 106 .It Dv CRYPTO_MD5
 107 .It Dv CRYPTO_SHA1
 108 .It Dv CRK_MOD_EXP
 109 .It Dv CRK_MOD_EXP_CRT
 110 .It Dv CRK_DSA_SIGN
 111 .It Dv CRK_DSA_VERIFY
 112 .It Dv CRK_DH_COMPUTE_KEY
 113 .El
 114 .Sh FILES
 115 .Bl -tag -width ".Pa /dev/crypto" -compact
 116 .It Pa /dev/crypto
 117 crypto access device
 118 .El
 119 .Sh SEE ALSO
 120 .Xr aesni 4 ,
 121 .Xr glxsb 4 ,
 122 .Xr hifn 4 ,
 123 .Xr ipsec 4 ,
 124 .Xr padlock 4 ,
 125 .\".Xr safe 4 ,
 126 .Xr ubsec 4 ,
 127 .\".Xr geli 8 ,
 128 .Xr crypto 9
 129 .Sh HISTORY
 130 The
 131 .Nm
 132 driver first appeared in
 133 .Ox 3.0 .
 134 The
 135 .Nm
 136 driver was imported to
 137 .Fx 5.0 .