Add an aesni(4) manual page (taken from FreeBSD).
[dragonfly.git] / share / man / man4 / aesni.4
1 .\" Copyright (c) 2010 Konstantin Belousov <kib@FreeBSD.org>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man4/aesni.4,v 1.3 2010/09/09 21:37:05 brueffer Exp $
26 .\"
27 .Dd October 12, 2010
28 .Dt AESNI 4
29 .Os
30 .Sh NAME
31 .Nm aesni
32 .Nd "driver for the AES accelerator on Intel CPUs"
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device crypto"
39 .Cd "device aesni"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 aesni_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 Starting with some models of Core i5/i7, Intel processors implement
50 a new set of instructions called AESNI.
51 The set of six instructions accelerates the calculation of the key
52 schedule for key lengths of 128, 192, and 256 of the Advanced
53 Encryption Standard (AES) symmetric cipher, and provides a hardware
54 implementation of the regular and the last encryption and decryption
55 rounds.
56 .Pp
57 The processor capability is reported as AESNI in the Features2 line at boot.
58 The
59 .Nm
60 driver does not attach on systems that lack the required CPU capability.
61 .Pp
62 The
63 .Nm
64 driver registers itself to accelerate AES operations for
65 .Xr crypto 4 .
66 Besides speed, the advantage of using the
67 .Nm
68 driver is that the AESNI operation
69 is data-independent, thus eliminating some attack vectors based on
70 measuring cache use and timings typically present in table-driven
71 implementations.
72 .Sh SEE ALSO
73 .Xr crypt 3 ,
74 .Xr crypto 4 ,
75 .Xr intro 4 ,
76 .Xr ipsec 4 ,
77 .Xr padlock 4 ,
78 .Xr random 4 ,
79 .Xr crypto 9
80 .Sh HISTORY
81 The
82 .Nm
83 driver first appeared in
84 .Fx 9.0 .
85 It was ported to
86 .Dx
87 by
88 .An Alex Hornung .
89 .Sh AUTHORS
90 .An -nosplit
91 The
92 .Nm
93 driver was written by
94 .An Konstantin Belousov Aq kib@FreeBSD.org .
95 The key schedule calculation code was adopted from the sample provided
96 by Intel and used in the analogous
97 .Ox
98 driver.