freebsd-skq/share/man/man4/padlock.4

.\" Copyright (c) 2005 Christian Brueffer
.\" 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 July 29, 2020
.Dt PADLOCK 4
.Os
.Sh NAME
.Nm padlock
.Nd "driver for the cryptographic functions and RNG in VIA C3, C7 and Eden processors"
.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 padlock"
.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
padlock_load="YES"
.Ed
.Sh DESCRIPTION
The C3 and Eden processor series from VIA include hardware acceleration for
AES.
The C7 series includes hardware acceleration for AES, SHA1, SHA256 and RSA.
All of the above processor series include a hardware random number generator.
.Pp
The
.Nm
driver registers itself to accelerate AES operations and, if available, HMAC/SHA1
and HMAC/SHA256 for
.Xr crypto 4 .
It also registers itself to accelerate other HMAC algorithms, although
there is no hardware acceleration for those algorithms.
This is only needed so
.Nm
can work with
.Xr ipsec 4 .
.Pp
The hardware random number generator supplies data for the kernel
.Xr random 4
subsystem.
.Sh SEE ALSO
.Xr crypt 3 ,
.Xr crypto 4 ,
.Xr intro 4 ,
.Xr ipsec 4 ,
.Xr random 4 ,
.Xr crypto 7 ,
.Xr crypto 9
.Sh HISTORY
The
.Nm
driver first appeared in
.Ox .
The first
.Fx
release to include it was
.Fx 6.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver with AES encryption support was written by
.An Jason Wright Aq Mt jason@OpenBSD.org .
It was ported to
.Fx
and then extended to support SHA1 and SHA256
by
.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org .
This manual page was written by
.An Christian Brueffer Aq Mt brueffer@FreeBSD.org .
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.\" Copyright (c) 2005 Christian Brueffer`
			`.\" 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$`
			`.\"`
add link to crypto(7) page, and drop a link to unrelated crypt(3) page.. 2020-07-29 21:15:06 +00:00			`.Dd July 29, 2020`
Install the padlock(4) man page on amd64 as well as i386, to match the platforms where the driver itself is compiled and installed. PR: docs/130895 Reported by: George Hartzell <hartzell alerce.com> MFC after: 1 week 2010-02-08 21:24:12 +00:00			`.Dt PADLOCK 4`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Os`
			`.Sh NAME`
			`.Nm padlock`
Reflect the additional support of C7 CPU's in padlock(4). Submitted by: brueffer MFC after: 1 day 2006-07-19 16:31:09 +00:00			`.Nd "driver for the cryptographic functions and RNG in VIA C3, C7 and Eden processors"`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Sh SYNOPSIS`
Mention the module in the synopsis. 2006-04-01 09:55:37 +00:00			`To compile this driver into the kernel,`
			`place the following lines in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Cd "device crypto"`
			`.Cd "device padlock"`
Mention the module in the synopsis. 2006-04-01 09:55:37 +00:00			`.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`
			`padlock_load="YES"`
			`.Ed`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Sh DESCRIPTION`
			`The C3 and Eden processor series from VIA include hardware acceleration for`
Reflect the additional support of C7 CPU's in padlock(4). Submitted by: brueffer MFC after: 1 day 2006-07-19 16:31:09 +00:00			`AES.`
Update manual page. 2006-07-28 13:56:17 +00:00			`The C7 series includes hardware acceleration for AES, SHA1, SHA256 and RSA.`
Reflect the additional support of C7 CPU's in padlock(4). Submitted by: brueffer MFC after: 1 day 2006-07-19 16:31:09 +00:00			`All of the above processor series include a hardware random number generator.`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Pp`
			`The`
			`.Nm`
Revise markup. 2006-09-30 15:14:49 +00:00			`driver registers itself to accelerate AES operations and, if available, HMAC/SHA1`
Update manual page. 2006-07-28 13:56:17 +00:00			`and HMAC/SHA256 for`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Xr crypto 4 .`
Update manual page. 2006-07-28 13:56:17 +00:00			`It also registers itself to accelerate other HMAC algorithms, although`
			`there is no hardware acceleration for those algorithms.`
Revise markup. 2006-09-30 15:14:49 +00:00			`This is only needed so`
- Document that padlock(4) pretends to accelerate HMAC algorithms. - Remove "device cryptodev" as it is not needed for compiling padlock(4) into the kernel. Actually it is not advisable, because padlock instructions can be used directly from userland, so passing the work through the kernel is a bad idea. 2006-06-05 16:24:31 +00:00			`.Nm`
			`can work with`
Remove the last entries to fast_ipsec. Merge in parts of the old fast_ipsec.4 man page to ipsec.4 and start updating ipsec.4 man page. Reviewed by: brueffer, sam (slightly earlier versions), bmah Approved by: re (bmah) 2007-08-02 08:04:48 +00:00			`.Xr ipsec 4 .`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Pp`
			`The hardware random number generator supplies data for the kernel`
			`.Xr random 4`
			`subsystem.`
Revise markup. 2006-09-30 15:14:49 +00:00			`.Sh SEE ALSO`
			`.Xr crypt 3 ,`
			`.Xr crypto 4 ,`
			`.Xr intro 4 ,`
Remove the last entries to fast_ipsec. Merge in parts of the old fast_ipsec.4 man page to ipsec.4 and start updating ipsec.4 man page. Reviewed by: brueffer, sam (slightly earlier versions), bmah Approved by: re (bmah) 2007-08-02 08:04:48 +00:00			`.Xr ipsec 4 ,`
Revise markup. 2006-09-30 15:14:49 +00:00			`.Xr random 4 ,`
add link to crypto(7) page, and drop a link to unrelated crypt(3) page.. 2020-07-29 21:15:06 +00:00			`.Xr crypto 7 ,`
Revise markup. 2006-09-30 15:14:49 +00:00			`.Xr crypto 9`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`driver first appeared in`
			`.Ox .`
			`The first`
			`.Fx`
			`release to include it was`
			`.Fx 6.0 .`
			`.Sh AUTHORS`
			`.An -nosplit`
			`The`
			`.Nm`
Spelling fix. 2006-12-14 16:57:35 +00:00			`driver with AES encryption support was written by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Jason Wright Aq Mt jason@OpenBSD.org .`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`It was ported to`
			`.Fx`
Update manual page. 2006-07-28 13:56:17 +00:00			`and then extended to support SHA1 and SHA256`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org .`
Manpage for the padlock driver (VIA C3/Eden AES support and RNG). MFC after: 3 days 2005-12-10 10:44:44 +00:00			`This manual page was written by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Christian Brueffer Aq Mt brueffer@FreeBSD.org .`