aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_hmac_set_key.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_hmac_set_key.341
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_set_key.3 b/doc/man/libkeccak_hmac_set_key.3
new file mode 100644
index 0000000..2f4682d
--- /dev/null
+++ b/doc/man/libkeccak_hmac_set_key.3
@@ -0,0 +1,41 @@
+.TH LIBKECCAK_HMAC_SET_KEY 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_set_key - Changes key for a the HMAC-hashing state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+int
+libkeccak_hmac_set_key(libkeccak_hmac_state_t *\fIstate\fP, const char *\fIkey\fP,
+ size_t \fIkey_length\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_set_key ()
+function sets the key for a HMAC-hashing state without reseting
+the state of the underlaying hashing-algorithm.
+.I key_length
+is the length of the key in bits.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_set_key ()
+function returns 0 successful completion.
+On error -1 is returned and
+.I errno
+is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_hmac_set_key ()
+function may fail for any specified for the function
+.BR realloc (3).
+.SH SEE ALSO
+.BR libkeccak_hmac_create (3),
+.BR libkeccak_hmac_initialise (3),
+.BR libkeccak_hmac_reset (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se