d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
95a74ab4fb
freebsd-dev/share/man/man9/rijndael.9

136 lines
3.3 KiB
Groff
Raw Normal View History

Document entropy device bits.
2002-02-06 21:38:20 +00:00
.\"
.\" Copyright (c) 2002
.\" Mark R V Murray. All rights reserved.
.\"
.\" 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 DEVELOPERS ``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 DEVELOPERS 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 February 6, 2002
.Dt RIJNDAEL 9
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Sh NAME
.Nm rijndael_makeKey ,
.Nm rijndael_cipherInit ,
.Nm rijndael_blockEncrypt ,
.Nm rijndael_padEncrypt ,
.Nm rijndael_blockDecrypt ,
.Nm rijndael_padDecrypt
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Nd AES encryption
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Sh SYNOPSIS
Add sys/types.h to the list of required includes.
2002-04-12 05:23:16 +00:00
.In sys/types.h
Fix the include path of rijndael.h. PR: docs/58437 Submitted by: Joachim Strombergson
2003-10-22 10:00:09 +00:00
.In crypto/rijndael.h
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Ft int
.Fo rijndael_makeKey
.Fa "keyInstance *key"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t direction"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fa "int keyLen"
.Fa "char *keyMaterial"
.Fc
.Ft int
.Fo rijndael_cipherInit
.Fa "cipherInstance *cipher"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t mode"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fa "char *IV"
.Fc
.Ft int
.Fo rijndael_blockEncrypt
.Fa "cipherInstance *cipher"
.Fa "keyInstance *key"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *input"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fa "int inputLen"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *outBuffer"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fc
.Ft int
.Fo rijndael_padEncrypt
.Fa "cipherInstance *cipher"
.Fa "keyInstance *key"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *input"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fa "int inputOctets"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *outBuffer"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fc
.Ft int
.Fo rijndael_blockDecrypt
.Fa "cipherInstance *cipher"
.Fa "keyInstance *key"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *input"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fa "int inputLen"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *outBuffer"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fc
.Ft int
.Fo rijndael_padDecrypt
.Fa "cipherInstance *cipher"
.Fa "keyInstance *key"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *input"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fa "int inputOctets"
Globally replace u_int*_t from (non-contributed) man pages. The reasoning behind this, is that if we are consistent in our documentation about the uint*_t stuff, people will be less tempted to write new code that uses the non-standard types. I am not going to bump the man page dates, as these changes can be considered style nits. The meaning of the man pages is unaffected. MFC after: 1 month
2012-02-12 18:29:56 +00:00
.Fa "uint8_t *outBuffer"
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Fc
.Sh DESCRIPTION
The
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fn rijndael_makeKey
Document entropy device bits.
2002-02-06 21:38:20 +00:00
function is used to set up the key schedule in
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fa key .
Document entropy device bits.
2002-02-06 21:38:20 +00:00
The
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fa direction
Document entropy device bits.
2002-02-06 21:38:20 +00:00
(which may be
.Dv DIR_ENCRYPT
or
.Dv DIR_DECRYPT )
specifies the intended use of the key.
The length of the key (in bits) is given in
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fa keyLen ,
Document entropy device bits.
2002-02-06 21:38:20 +00:00
and must be 128, 192 or 256.
The actual key is supplied in the buffer pointed to by
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fa keyMaterial .
Document entropy device bits.
2002-02-06 21:38:20 +00:00
This material may be raw binary data,
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
or an ASCII string containing a hexadecimal rendition
Document entropy device bits.
2002-02-06 21:38:20 +00:00
of the raw binary data,
Typo: s/dependant/dependent/ MFC after: 3 days
2002-03-16 18:12:49 +00:00
dependent on a compile-time option in the
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Nm
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
sources,
Document entropy device bits.
2002-02-06 21:38:20 +00:00
.Dv BINARY_KEY_MATERIAL .
.Sh RETURN VALUES
The
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fn rijndael_makeKey
Document entropy device bits.
2002-02-06 21:38:20 +00:00
function will return
.Dv BAD_KEY_INSTANCE
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
if a
.Dv NULL
.Fa key
Document entropy device bits.
2002-02-06 21:38:20 +00:00
is passed,
.Dv BAD_KEY_DIR
if
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Fa direction
Document entropy device bits.
2002-02-06 21:38:20 +00:00
is not
.Dv DIR_ENCRYPT
or
.Dv DIR_DECRYPT ,
.Dv BAD_KEY_MAT
if the key materials are not a hexadecimal string
(and binary keys are not set),
and
.Dv TRUE
otherwise.
mdoc(7) police: tidy up.
2002-03-18 16:52:32 +00:00
.Sh AUTHORS
.An Mark R V Murray
Reference in New Issue Copy Permalink