1 .\" Copyright (c) 2014 The FreeBSD Foundation
2 .\" All rights reserved.
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
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.
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
35 .Nd OpenCrypto algorithms
37 In the kernel configuration file:
40 Or load the crypto.ko module.
42 The following cryptographic algorithms that are part of the OpenCrypto
43 framework have the following requirements.
46 .Bl -tag -width ".Dv CRYPTO_AES_CBC"
48 .Bl -tag -width "Block size :" -compact -offset indent
57 This algorithm implements Cipher-block chaining.
58 .It Dv CRYPTO_AES_NIST_GCM_16
59 .Bl -tag -width "Block size :" -compact -offset indent
70 This algorithm implements Galois/Counter Mode.
72 .Pq Authenticated Encryption with Associated Data
75 The authentication tag will be read/written from/to the offset
77 specified in the request.
79 Note: You must provide an IV on every call.
81 .Bl -tag -width "Block size :" -compact -offset indent
85 1 (aesni), 16 (software)
90 This algorithm implements Integer Counter Mode.
91 This is similar to what most people call counter mode, but instead of the
92 counter being split into a nonce and a counter part, then entire nonce is
93 used as the initial counter.
94 This does mean that if a counter is required that rolls over at 32 bits,
95 the transaction need to be split into two parts where the counter rolls over.
96 The counter incremented as a 128-bit big endian number.
98 Note: You must provide an IV on every call.
100 .Bl -tag -width "Block size :" -compact -offset indent
109 This algorithm implements XEX Tweakable Block Cipher with Ciphertext Stealing
110 as defined in NIST SP 800-38E.
112 NOTE: The ciphertext stealing part is not implemented which is why this cipher
113 is listed as having a block size of 16 instead of 1.
119 Not all the implemented algorithms are listed.