svn commit: r212262 - head/share/man/man4

[Konstantin Belousov]

Author: kib
Date: Mon Sep  6 20:35:48 2010
New Revision: 212262
URL: http://svn.freebsd.org/changeset/base/212262

Log:
  Add aesni(4) manpage.

Added:
  head/share/man/man4/aesni.4   (contents, props changed)
Modified:
  head/share/man/man4/Makefile

Modified: head/share/man/man4/Makefile
==============================================================================
--- head/share/man/man4/Makefile	Mon Sep  6 20:16:10 2010	(r212261)
+++ head/share/man/man4/Makefile	Mon Sep  6 20:35:48 2010	(r212262)
@@ -18,6 +18,7 @@ MAN=	aac.4 \
 	adv.4 \
 	adw.4 \
 	ae.4 \
+	${_aesni.4} \
 	age.4 \
 	agp.4 \
 	aha.4 \
@@ -638,6 +639,7 @@ _acpi_panasonic.4=acpi_panasonic.4
 _acpi_sony.4=	acpi_sony.4
 _acpi_toshiba.4=acpi_toshiba.4
 _acpi_wmi.4=	acpi_wmi.4
+_aesni.4=	aesni.4
 _aibs.4=	aibs.4
 _amdsbwd.4=	amdsbwd.4
 _amdsmb.4=	amdsmb.4

Added: head/share/man/man4/aesni.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man4/aesni.4	Mon Sep  6 20:35:48 2010	(r212262)
@@ -0,0 +1,91 @@
+.\" Copyright (c) 2010 Konstantin Belousov <kib at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd September 6, 2010
+.Dt AESNI 4
+.Os
+.Sh NAME
+.Nm aesni
+.Nd "driver for the AES accelerator on Intel CPUs"
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device crypto"
+.Cd "device aesni"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+aesni_load="YES"
+.Ed
+.Sh DESCRIPTION
+Starting with some models of Core i5/i7, Intel processors implement
+new set of instructions called AESNI.
+The set of six instructions accelerates the calculation of the key
+schedule for key lengths of 128, 192, and 256 of the Advanced
+Encryption Standard (AES) symmetric cipher, and provides the hardware
+implementation of the regular and the last encryption and decryption
+rounds.
+.Pp
+The processor capability is reported as AESNI in the Features2 line
+at the boot. Driver does not attach on the system that lacks the
+required CPU capability.
+.Pp
+The
+.Nm
+driver registers itself to accelerate AES operations for
+.Xr crypto 4 .
+Besides speed, advantage of using the driver is that the AESNI operation
+is data-independend, thus eliminating some attack vectors based on the
+measuring cache use and timings, typically present in the table-driven
+implementations.
+.Sh SEE ALSO
+.Xr crypt 3 ,
+.Xr crypto 4 ,
+.Xr intro 4 ,
+.Xr ipsec 4 ,
+.Xr padlock 4 ,
+.Xr random 4 ,
+.Xr crypto 9
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Fx 9.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Konstantin Belousov Aq kib at FreeBSD.org .
+The key schedule calculation code was adopted from the sample provided
+by Intel and used in the analogous
+.Ox
+driver.