share/man/man7/crypto.7

   1 .\" Copyright (c) 2014 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This documentation was written by John-Mark Gurney under
   5 .\" the sponsorship of the FreeBSD Foundation and
   6 .\" Rubicon Communications, LLC (Netgate).
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1.  Redistributions of source code must retain the above copyright
  11 .\"     notice, this list of conditions and the following disclaimer.
  12 .\" 2.  Redistributions in binary form must reproduce the above copyright
  13 .\"     notice, this list of conditions and the following disclaimer in the
  14 .\"     documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd June 04, 2020
  31 .Dt CRYPTO 7
  32 .Os
  33 .Sh NAME
  34 .Nm crypto
  35 .Nd OpenCrypto algorithms
  36 .Sh SYNOPSIS
  37 In the kernel configuration file:
  38 .Cd "device crypto"
  39 .Pp
  40 Or load the crypto.ko module.
  41 .Sh DESCRIPTION
  42 The following cryptographic algorithms that are part of the OpenCrypto
  43 framework have the following requirements.
  44 .Pp
  45 Cipher algorithms:
  46 .Bl -tag -width "CRYPTO_AES_NIST_GCM_16"
  47 .It Dv CRYPTO_AES_CBC
  48 .Bl -tag -width "Block size :" -compact -offset indent
  49 .It IV size :
  50 16
  51 .It Block size :
  52 16
  53 .It Key size :
  54 16, 24 or 32
  55 .El
  56 .Pp
  57 This algorithm implements Cipher Block Chaining.
  58 .It Dv CRYPTO_AES_CCM_16
  59 .Bl -tag -width "Block size :" -compact -offset indent
  60 .It IV size :
  61 12
  62 .It Block size :
  63 16
  64 .It Key size :
  65 16, 24 or 32
  66 .It Digest size :
  67 16
  68 .El
  69 .Pp
  70 This algorithm implements Counter with CBC-MAC Mode.
  71 This cipher uses AEAD
  72 .Pq Authenticated Encryption with Associated Data
  73 mode.
  74 .Pp
  75 The authentication tag will be read from or written to the offset
  76 .Va crp_digest_start
  77 specified in the request.
  78 .Pp
  79 Note: The nonce for each request must be provided in
  80 .Fa crp_iv
  81 via the
  82 .Dv CRYPTO_F_IV_SEPARATE
  83 flag.
  84 .It Dv CRYPTO_AES_NIST_GCM_16
  85 .Bl -tag -width "Block size :" -compact -offset indent
  86 .It IV size :
  87 12
  88 .It Block size :
  89 1
  90 .It Key size :
  91 16, 24 or 32
  92 .It Digest size :
  93 16
  94 .El
  95 .Pp
  96 This algorithm implements Galois/Counter Mode.
  97 This cipher uses AEAD
  98 .Pq Authenticated Encryption with Associated Data
  99 mode.
 100 .Pp
 101 The authentication tag will be read from or written to the offset
 102 .Va crp_digest_start
 103 specified in the request.
 104 .Pp
 105 Note: The nonce for each request must be provided in
 106 .Fa crp_iv
 107 via the
 108 .Dv CRYPTO_F_IV_SEPARATE
 109 flag.
 110 .It Dv CRYPTO_AES_ICM
 111 .Bl -tag -width "Block size :" -compact -offset indent
 112 .It IV size :
 113 16
 114 .It Block size :
 115 1
 116 .It Key size :
 117 16, 24 or 32
 118 .El
 119 .Pp
 120 This algorithm implements Integer Counter Mode.
 121 This is similar to what most people call counter mode, but instead of the
 122 counter being split into a nonce and a counter part, then entire nonce is
 123 used as the initial counter.
 124 This does mean that if a counter is required that rolls over at 32 bits,
 125 the transaction need to be split into two parts where the counter rolls over.
 126 The counter incremented as a 128-bit big endian number.
 127 .Pp
 128 Note: The counter for each request must be provided in
 129 .Fa crp_iv
 130 via the
 131 .Dv CRYPTO_F_IV_SEPARATE
 132 flag.
 133 .It Dv CRYPTO_AES_XTS
 134 .Bl -tag -width "Block size :" -compact -offset indent
 135 .It IV size :
 136 8
 137 .It Block size :
 138 16
 139 .It Key size :
 140 32 or 64
 141 .El
 142 .Pp
 143 This algorithm implements XEX Tweakable Block Cipher with Ciphertext Stealing
 144 as defined in NIST SP 800-38E.
 145 .Pp
 146 NOTE: The ciphertext stealing part is not implemented which is why this cipher
 147 is listed as having a block size of 16 instead of 1.
 148 .It Dv CRYPTO_CAMELLIA_CBC
 149 .Bl -tag -width "Block size :" -compact -offset indent
 150 .It IV size :
 151 16
 152 .It Block size :
 153 16
 154 .It Key size :
 155 16, 24 or 32
 156 .El
 157 .Pp
 158 This algorithm implements Cipher Block Chaining.
 159 .It Dv CRYPTO_CHACHA20
 160 .Bl -tag -width "Block size :" -compact -offset indent
 161 .It IV size :
 162 16
 163 .It Block size :
 164 1
 165 .It Key size :
 166 16 or 32
 167 .El
 168 .El
 169 .Sh HISTORY
 170 The
 171 .Nm
 172 manpage first appeared in
 173 .Fx 10.1 .
 174 .Sh SEE ALSO
 175 .Xr crypto 4 ,
 176 .Xr crypto 9
 177 .Sh BUGS
 178 Not all the implemented algorithms are listed.