Drop trailing white space in preparation for more changes.
This commit is contained in:
parent
8a1597d78b
commit
a7f8dce68e
|
@ -1,4 +1,4 @@
|
|||
.\" $NetBSD: crypto.4,v 1.2 2004/04/27 23:42:59 jonathan Exp $
|
||||
.\" $NetBSD: crypto.4,v 1.3 2004/04/28 15:19:20 wiz Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2004
|
||||
.\" Jonathan Stone <jonathan@dsg.stanford.edu>. All rights reserved.
|
||||
|
@ -43,17 +43,17 @@
|
|||
The
|
||||
.Nm
|
||||
driver gives user-mode applications access to hardware-accelerated
|
||||
cryptographic transforms, as implemented by the
|
||||
cryptographic transforms, as implemented by the
|
||||
.Xr opencrypto 9
|
||||
in-kernel interface.
|
||||
The
|
||||
.Pa /dev/crypto
|
||||
special device provides an
|
||||
special device provides an
|
||||
.Xr ioctl 2
|
||||
based interface. User-mode applications should open the special device,
|
||||
then issue
|
||||
.Xr ioctl 2
|
||||
calls on the descriptor. The
|
||||
then issue
|
||||
.Xr ioctl 2
|
||||
calls on the descriptor. The
|
||||
.Nm
|
||||
device provides two distinct modes of operation: one mode for
|
||||
symmetric-keyed cryptographic requests, and a second mode for
|
||||
|
@ -71,7 +71,7 @@ encrypt/HMAC-generate operation, or a fused HMAC-verify/decrypt operation.
|
|||
.Pp
|
||||
To use symmetric mode, you must first create a session specifying
|
||||
the algorithm(s) and key(s) to use; then issue encrypt or decrypt
|
||||
requests against the session.
|
||||
requests against the session.
|
||||
.Ss Symmetric-key privacy algorithms
|
||||
Contingent upon device drivers for installed cryptographic hardware
|
||||
registering with
|
||||
|
@ -101,7 +101,7 @@ keyed one-way hash algorithms may be available:
|
|||
.It CRYPTO_MD5
|
||||
.It CRYPTO_SHA1
|
||||
.El
|
||||
The
|
||||
The
|
||||
.Em CRYPTO_MD5
|
||||
and
|
||||
.Em CRYPTO_SHA1
|
||||
|
@ -112,27 +112,27 @@ as symmetric-key hash algorithms with a zero-length key.
|
|||
.Bl -tag -width CIOCFKEY
|
||||
.\"
|
||||
.It Dv CRIOCGET Fa int *fd
|
||||
Clone the fd argument to
|
||||
Clone the fd argument to
|
||||
.Xr ioctl 4 ,
|
||||
yielding a new file descriptor which can be used to create
|
||||
crypto sessions and request crypto operations.
|
||||
.\"
|
||||
.It Dv CRIOCGSESSION Fa struct session_op *sessp
|
||||
Persistently bind a file descriptor returned by a previous
|
||||
.Dv CRIOCGET
|
||||
Persistently bind a file descriptor returned by a previous
|
||||
.Dv CRIOCGET
|
||||
to a session: that is, to the chosen privacy algorithm, integrity
|
||||
algorithm, and keys specified in
|
||||
algorithm, and keys specified in
|
||||
.Fa sessp .
|
||||
The special value 0 for either privacy or integrity
|
||||
is reserved to indicate that the indicated operation (privacy or integrity)
|
||||
is not desired for this session.
|
||||
The special value 0 for either privacy or integrity
|
||||
is reserved to indicate that the indicated operation (privacy or integrity)
|
||||
is not desired for this session.
|
||||
.Pp
|
||||
For non-zero symmetric-key privacy algorithms, the privacy algorithm
|
||||
For non-zero symmetric-key privacy algorithms, the privacy algorithm
|
||||
must be specified in
|
||||
.Fa sess->cipher ,
|
||||
the key length in
|
||||
.Fa sessp->keylen ,
|
||||
and the key value in the octets addressed by
|
||||
and the key value in the octets addressed by
|
||||
.Fa sessp->key .
|
||||
.Pp
|
||||
For keyed one-way hash algorithms, the one-way hash must be specified
|
||||
|
@ -140,19 +140,19 @@ in
|
|||
.Fa sessp->mac ,
|
||||
the key length in
|
||||
.Fa sessp->mackey ,
|
||||
and the key value in the octets addressed by
|
||||
and the key value in the octets addressed by
|
||||
.Fa sessp->mackeylen .
|
||||
.\"
|
||||
.Pp
|
||||
Support for a specific combination of fused privacy and
|
||||
integrity-check algorithms depends on whether the underlying
|
||||
hardware supports that combination. Not all combinations are supported
|
||||
by all hardware, even if the hardware supports each operation as a
|
||||
by all hardware, even if the hardware supports each operation as a
|
||||
stand-alone non-fused operation.
|
||||
.It Dv CIOCCRYPT Fa struct crpyto_op *cr_op
|
||||
Request a symmetric-key (or unkeyed hash) operation.
|
||||
Request a symmetric-key (or unkeyed hash) operation.
|
||||
The file descriptor argument to
|
||||
.Xr ioctl 4
|
||||
.Xr ioctl 4
|
||||
must have been bound to a valid session.
|
||||
To encrypt, set
|
||||
.Fa cr_op->op
|
||||
|
@ -160,13 +160,13 @@ to COP_ENCRYPT. To decrypt, set
|
|||
.Fa cr_op->op
|
||||
to COP_DECRYPT.
|
||||
The field
|
||||
.Fa cr_op->len
|
||||
.Fa cr_op->len
|
||||
supplies the length of the input buffer; the fields
|
||||
.Fa cr_op->src ,
|
||||
.Fa cr_op->dst ,
|
||||
.Fa cr_op->mac ,
|
||||
.Fa cr_op->iv
|
||||
supply the addresses of the input buffer, output buffer,
|
||||
.Fa cr_op->iv
|
||||
supply the addresses of the input buffer, output buffer,
|
||||
one-way hash, and initialization vector, respectively.
|
||||
.It Dv CIOCFSESSION Fa void
|
||||
Destroys the /dev/crypto session associated with the file-descriptor
|
||||
|
@ -200,19 +200,19 @@ Returns a bitmask of supported asymmetric-key operations.
|
|||
Each of the above-listed asymmetric operations is present
|
||||
if and only the bit position numbered by the code for that operation
|
||||
is set.
|
||||
For example,
|
||||
For example,
|
||||
.Dv CRK_MOD_EXP
|
||||
is available if and only if the bit
|
||||
.Dv (1 << CRK_MOD_EX)
|
||||
is set.
|
||||
.It Dv CIOCFKEY Fa struct crypt_kop *kop
|
||||
Performs an asymmetric-key operation from the list above.
|
||||
The specific operation is supplied in
|
||||
The specific operation is supplied in
|
||||
.Fa kop->crk_op ;
|
||||
final status for the operation is returned in
|
||||
.Fa kop->crk_status .
|
||||
The number of input arguments and the number of output arguments
|
||||
is specified in
|
||||
is specified in
|
||||
.Fa kop->crk_iparams
|
||||
and
|
||||
.Fa kop->crk_iparams ,
|
||||
|
@ -229,7 +229,7 @@ The semantics of these arguments is currently undocumented.
|
|||
.\"
|
||||
.Sh SEE ALSO
|
||||
.Xr hifn 4 ,
|
||||
.Xr ubsec 4 ,
|
||||
.Xr ubsec 4 ,
|
||||
.Xr opencrypto 9 .
|
||||
.Sh BUGS
|
||||
.Pp
|
||||
|
@ -238,7 +238,7 @@ symmetric-key key sizes to
|
|||
.Dv CRIOCGSESSION ,
|
||||
must exactly match the values expected by
|
||||
.XR opencrypto 9 .
|
||||
The output buffer and MAC buffers supplied to
|
||||
The output buffer and MAC buffers supplied to
|
||||
.Dv CRIOCRYPT
|
||||
must follow whether privacy or integrity algorithms were specified for
|
||||
session: if you request a non-NULL algorithm, you must supply a suitably-sized
|
||||
|
|
Loading…
Reference in New Issue