aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/man/libkeccak_generalised_sum_fd.32
-rw-r--r--doc/man/libkeccak_hmac_create.345
-rw-r--r--doc/man/libkeccak_hmac_initialise.33
-rw-r--r--doc/man/libkeccak_keccaksum_fd.32
-rw-r--r--doc/man/libkeccak_rawshakesum_fd.32
-rw-r--r--doc/man/libkeccak_sha3sum_fd.32
-rw-r--r--doc/man/libkeccak_shakesum_fd.32
-rw-r--r--doc/man/libkeccak_state_copy.32
-rw-r--r--doc/man/libkeccak_state_create.32
-rw-r--r--doc/man/libkeccak_state_duplicate.32
-rw-r--r--doc/man/libkeccak_state_initialise.32
11 files changed, 56 insertions, 10 deletions
diff --git a/doc/man/libkeccak_generalised_sum_fd.3 b/doc/man/libkeccak_generalised_sum_fd.3
index af8db9a..2f33a6d 100644
--- a/doc/man/libkeccak_generalised_sum_fd.3
+++ b/doc/man/libkeccak_generalised_sum_fd.3
@@ -32,7 +32,7 @@ memory leak if \fI*state\fP is already initialised.
.SH RETURN VALUES
The
.BR libkeccak_generalised_sum_fd ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
diff --git a/doc/man/libkeccak_hmac_create.3 b/doc/man/libkeccak_hmac_create.3
new file mode 100644
index 0000000..6bdf846
--- /dev/null
+++ b/doc/man/libkeccak_hmac_create.3
@@ -0,0 +1,45 @@
+.TH LIBKECCAK_HMAC_CREATE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_hmac_create - Allocate and initialise HMAC-hashing state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+libkeccak_hmac_state_t *libkeccak_hmac_create(const libkeccak_spec_t *\fIspec\fP,
+ const char *\fIkey\fP, size_t \fIkey_length\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_create ()
+function allocates a new \fIlibkeccak_hmac_state_t*\fP with one
+initialised element, and sets the algorithm tuning parameters to
+those specified by \fI*spec\fP, and the key to \fIkey\fP of
+length \fIkey_length\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_create ()
+function returns a newly allocated \fIlibkeccak_hmac_state_t*\fP
+(of one initialised element) upon successful completion.
+On error, \fINULL\fP is returned and \fIerrno\fP is set to
+describe the error.
+.SH ERRORS
+The
+.BR libkeccak_hmac_create ()
+function may fail for any specified for the functions
+.BR malloc (3)
+and
+.BR realloc (3).
+.SH SEE ALSO
+.BR libkeccak_hmac_initialise (3),
+.BR libkeccak_hmac_free (3),
+.BR libkeccak_hmac_fast_free (3),
+.BR libkeccak_hmac_duplicate (3)
+.SH AUTHORS
+Principal author, Mattias Andrée. See the LICENSE file for the full
+list of authors.
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@member.fsf.org
diff --git a/doc/man/libkeccak_hmac_initialise.3 b/doc/man/libkeccak_hmac_initialise.3
index d25ba40..5aad206 100644
--- a/doc/man/libkeccak_hmac_initialise.3
+++ b/doc/man/libkeccak_hmac_initialise.3
@@ -21,7 +21,7 @@ and the key to \fIkey\fP of length \fIkey_length\fP.
.SH RETURN VALUES
The
.BR libkeccak_hmac_initialise ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
@@ -32,6 +32,7 @@ function may fail for any specified for the functions
and
.BR realloc (3).
.SH SEE ALSO
+.BR libkeccak_hmac_create (3),
.BR libkeccak_spec_sha3 (3),
.BR libkeccak_spec_shake (3),
.BR libkeccak_spec_rawshake (3),
diff --git a/doc/man/libkeccak_keccaksum_fd.3 b/doc/man/libkeccak_keccaksum_fd.3
index 71d4f76..b21e25f 100644
--- a/doc/man/libkeccak_keccaksum_fd.3
+++ b/doc/man/libkeccak_keccaksum_fd.3
@@ -30,7 +30,7 @@ memory leak if \fI*state\fP is already initialised.
.SH RETURN VALUES
The
.BR libkeccak_keccaksum_fd ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
diff --git a/doc/man/libkeccak_rawshakesum_fd.3 b/doc/man/libkeccak_rawshakesum_fd.3
index efc8f6b..fb9101f 100644
--- a/doc/man/libkeccak_rawshakesum_fd.3
+++ b/doc/man/libkeccak_rawshakesum_fd.3
@@ -32,7 +32,7 @@ memory leak if \fI*state\fP is already initialised.
.SH RETURN VALUES
The
.BR libkeccak_rawshakesum_fd ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
diff --git a/doc/man/libkeccak_sha3sum_fd.3 b/doc/man/libkeccak_sha3sum_fd.3
index 6f5b573..cf8fe2c 100644
--- a/doc/man/libkeccak_sha3sum_fd.3
+++ b/doc/man/libkeccak_sha3sum_fd.3
@@ -30,7 +30,7 @@ memory leak if \fI*state\fP is already initialised.
.SH RETURN VALUES
The
.BR libkeccak_sha3sum_fd ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
diff --git a/doc/man/libkeccak_shakesum_fd.3 b/doc/man/libkeccak_shakesum_fd.3
index 4b9082c..b57ecd4 100644
--- a/doc/man/libkeccak_shakesum_fd.3
+++ b/doc/man/libkeccak_shakesum_fd.3
@@ -32,7 +32,7 @@ memory leak if \fI*state\fP is already initialised.
.SH RETURN VALUES
The
.BR libkeccak_shakesum_fd ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
diff --git a/doc/man/libkeccak_state_copy.3 b/doc/man/libkeccak_state_copy.3
index 42fdc64..544ccb5 100644
--- a/doc/man/libkeccak_state_copy.3
+++ b/doc/man/libkeccak_state_copy.3
@@ -20,7 +20,7 @@ message chunk buffer.
.SH RETURN VALUES
The
.BR libkeccak_state_copy ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3
index c7b33aa..a76422c 100644
--- a/doc/man/libkeccak_state_create.3
+++ b/doc/man/libkeccak_state_create.3
@@ -19,7 +19,7 @@ to those specified by \fI*spec\fP.
.SH RETURN VALUES
The
.BR libkeccak_state_create ()
-function return a new allocated \fIlibkeccak_state_t*\fP
+function returns a newly allocated \fIlibkeccak_state_t*\fP
(of one initialised element) upon successful completion.
On error, \fINULL\fP is returned and \fIerrno\fP is set to
describe the error.
diff --git a/doc/man/libkeccak_state_duplicate.3 b/doc/man/libkeccak_state_duplicate.3
index 546b296..4d659ac 100644
--- a/doc/man/libkeccak_state_duplicate.3
+++ b/doc/man/libkeccak_state_duplicate.3
@@ -20,7 +20,7 @@ chunk buffer.
.SH RETURN VALUES
The
.BR libkeccak_state_duplicate ()
-function return a newly allocated \fIlibkeccak_state_t*\fP
+function returns a newly allocated \fIlibkeccak_state_t*\fP
(of one initialised element) upon successful completion.
On error, \fINULL\fP is returned and \fIerrno\fP is set to
describe the error.
diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index 230338e..d52bc40 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -19,7 +19,7 @@ tuning parameters to those specified by \fI*spec\fP.
.SH RETURN VALUES
The
.BR libkeccak_state_initialise ()
-function return 0 upon successful completion.
+function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2024-11-05 13:54:04 +0000