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 March 27, 2020 31.Dt CRYPTO 7 32.Os 33.Sh NAME 34.Nm crypto 35.Nd OpenCrypto algorithms 36.Sh SYNOPSIS 37In the kernel configuration file: 38.Cd "device crypto" 39.Pp 40Or load the crypto.ko module. 41.Sh DESCRIPTION 42The following cryptographic algorithms that are part of the OpenCrypto 43framework have the following requirements. 44.Pp 45Cipher algorithms: 46.Bl -tag -width ".Dv CRYPTO_AES_CBC" 47.It Dv CRYPTO_AES_CBC 48.Bl -tag -width "Block size :" -compact -offset indent 49.It IV size : 5016 51.It Block size : 5216 53.It Key size : 5416, 24 or 32 55.El 56.Pp 57This algorithm implements Cipher-block chaining. 58.It Dv CRYPTO_AES_NIST_GCM_16 59.Bl -tag -width "Block size :" -compact -offset indent 60.It IV size : 6112 62.It Block size : 631 64.It Key size : 6516, 24 or 32 66.It Digest size : 6716 68.El 69.Pp 70This algorithm implements Galois/Counter Mode. 71This cipher uses AEAD 72.Pq Authenticated Encryption with Associated Data 73mode. 74.Pp 75The authentication tag will be read/written from/to the offset 76.Va crp_digest_start 77specified in the request. 78.Pp 79Note: You must provide an IV on every call. 80.It Dv CRYPTO_AES_ICM 81.Bl -tag -width "Block size :" -compact -offset indent 82.It IV size : 8316 84.It Block size : 851 (aesni), 16 (software) 86.It Key size : 8716, 24 or 32 88.El 89.Pp 90This algorithm implements Integer Counter Mode. 91This is similar to what most people call counter mode, but instead of the 92counter being split into a nonce and a counter part, then entire nonce is 93used as the initial counter. 94This does mean that if a counter is required that rolls over at 32 bits, 95the transaction need to be split into two parts where the counter rolls over. 96The counter incremented as a 128-bit big endian number. 97.Pp 98Note: You must provide an IV on every call. 99.It Dv CRYPTO_AES_XTS 100.Bl -tag -width "Block size :" -compact -offset indent 101.It IV size : 1028 103.It Block size : 10416 105.It Key size : 10632 or 64 107.El 108.Pp 109This algorithm implements XEX Tweakable Block Cipher with Ciphertext Stealing 110as defined in NIST SP 800-38E. 111.Pp 112NOTE: The ciphertext stealing part is not implemented which is why this cipher 113is listed as having a block size of 16 instead of 1. 114.El 115.Sh SEE ALSO 116.Xr crypto 4 , 117.Xr crypto 9 118.Sh BUGS 119Not all the implemented algorithms are listed. 120