From 794e213c173da0c56f5e2c234c629b1eb27440ad Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 11 Oct 2015 13:21:56 +0200 Subject: add libkeccak_hmac_fast_destroy.3, libkeccak_hmac_destroy.3, libkeccak_hmac_fast_free.3, and libkeccak_hmac_free.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libkeccak_hmac_destroy.3 | 41 ++++++++++++++++++++++++++++ doc/man/libkeccak_hmac_fast_destroy.3 | 41 ++++++++++++++++++++++++++++ doc/man/libkeccak_hmac_fast_free.3 | 50 +++++++++++++++++++++++++++++++++++ doc/man/libkeccak_hmac_free.3 | 50 +++++++++++++++++++++++++++++++++++ doc/man/libkeccak_hmac_initialise.3 | 3 +++ 5 files changed, 185 insertions(+) create mode 100644 doc/man/libkeccak_hmac_destroy.3 create mode 100644 doc/man/libkeccak_hmac_fast_destroy.3 create mode 100644 doc/man/libkeccak_hmac_fast_free.3 create mode 100644 doc/man/libkeccak_hmac_free.3 (limited to 'doc') diff --git a/doc/man/libkeccak_hmac_destroy.3 b/doc/man/libkeccak_hmac_destroy.3 new file mode 100644 index 0000000..292b122 --- /dev/null +++ b/doc/man/libkeccak_hmac_destroy.3 @@ -0,0 +1,41 @@ +.TH LIBKECCAK_HMAC_DESTROY 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_destroy - Destroys an HMAC-hashing state with erasure +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_hmac_destroy(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_destroy () +function releases the allocations stored in \fI*state\fP, +without releasing the allocation of \fIstate\fP itself. +.PP +The +.BR libkeccak_hmac_destroy () +function securely erases sensitive data. +.SH RETURN VALUES +The +.BR libkeccak_hmac_destroy () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_hmac_destroy () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_hmac_free (3), +.BR libkeccak_hmac_fast_destroy (3), +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_reset (3), +.BR libkeccak_hmac_wipe (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_fast_destroy.3 b/doc/man/libkeccak_hmac_fast_destroy.3 new file mode 100644 index 0000000..e5fe7da --- /dev/null +++ b/doc/man/libkeccak_hmac_fast_destroy.3 @@ -0,0 +1,41 @@ +.TH LIBKECCAK_HMAC_FAST_DESTROY 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_fast_destroy - Destroys an HMAC-hashing state without erasure +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_hamc_fast_destroy(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_fast_destroy () +function releases the allocations stored in \fI*state\fP, +without releasing the allocation of \fIstate\fP itself. +.PP +The +.BR libkeccak_hmac_fast_destroy () +function does not securely erase sensitive data. +.SH RETURN VALUES +The +.BR libkeccak_hmac_fast_destroy () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_state_fast_destroy () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_hmac_fast_free (3), +.BR libkeccak_hmac_destroy (3), +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_reset (3), +.BR libkeccak_hmac_wipe (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_fast_free.3 b/doc/man/libkeccak_hmac_fast_free.3 new file mode 100644 index 0000000..3c0498f --- /dev/null +++ b/doc/man/libkeccak_hmac_fast_free.3 @@ -0,0 +1,50 @@ +.TH LIBKECCAK_STATE_FAST_FREE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_fast_free - Destroys and deallocates an HMAC-hashing state without erasure +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_hmac_fast_free(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_fast_free () +function releases the allocations stored in \fI*state\fP, +and also released the allocation of \fIstate\fP. +.PP +The +.BR libkeccak_hmac_fast_free () +function does not securely erase sensitive data. +.SH RETURN VALUES +The +.BR libkeccak_hmac_fast_free () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_hmac_fast_free () +function cannot fail. +.SH NOTES +A double call to +.BR libkeccak_hmac_fast_free () +will either result in a double free, +which is must likely to crash the process, +or free an allocation (that was created +between the calls) that was not intended +to be freed, resulting in undefined behaviour. +.SH SEE ALSO +.BR libkeccak_hmac_fast_destroy (3), +.BR libkeccak_hmac_free (3), +.BR libkeccak_hmac_create (3), +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_reset (3), +.BR libkeccak_hmac_wipe (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_free.3 b/doc/man/libkeccak_hmac_free.3 new file mode 100644 index 0000000..6395f22 --- /dev/null +++ b/doc/man/libkeccak_hmac_free.3 @@ -0,0 +1,50 @@ +.TH LIBKECCAK_HMAC_FREE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_free - Destroys and deallocates an HMAC-hashing state with erasure +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_hmac_free(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_free () +function releases the allocations stored in \fI*state\fP, +and also release the allocation of \fIstate\fP. +.PP +The +.BR libkeccak_hmac_free () +function securely erases sensitive data. +.SH RETURN VALUES +The +.BR libkeccak_hmac_free () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_hmac_free () +function cannot fail. +.SH NOTES +A double call to +.BR libkeccak_hmac_free () +will either result in a double free, +which is must likely to crash the process, +or free an allocation (that was created +between the calls) that was not intended +to be freed, resulting in undefined behaviour. +.SH SEE ALSO +.BR libkeccak_hmac_destroy (3), +.BR libkeccak_hmac_fast_free (3), +.BR libkeccak_hmac_create (3), +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_reset (3), +.BR libkeccak_hmac_wipe (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 5aad206..bb8d156 100644 --- a/doc/man/libkeccak_hmac_initialise.3 +++ b/doc/man/libkeccak_hmac_initialise.3 @@ -33,6 +33,9 @@ and .BR realloc (3). .SH SEE ALSO .BR libkeccak_hmac_create (3), +.BR libkeccak_hmac_destroy (3), +.BR libkeccak_hmac_fast_destroy (3), +.BR libkeccak_hmac_copy (3), .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_shake (3), .BR libkeccak_spec_rawshake (3), -- cgit v1.2.3-70-g09d2