From 29c6c15d4442bcb0d7a053c43d33694e3784af82 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 6 Oct 2015 18:23:39 +0200 Subject: add libkeccak_state_wipe.3, libkeccak_state_wipe_sponge.3, and libkeccak_state_wipe_message.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_state_destroy.3 | 3 ++- doc/man/libkeccak_state_fast_destroy.3 | 3 ++- doc/man/libkeccak_state_reset.3 | 3 ++- doc/man/libkeccak_state_wipe.3 | 38 ++++++++++++++++++++++++++++++++++ doc/man/libkeccak_state_wipe_message.3 | 36 ++++++++++++++++++++++++++++++++ doc/man/libkeccak_state_wipe_sponge.3 | 36 ++++++++++++++++++++++++++++++++ 6 files changed, 116 insertions(+), 3 deletions(-) create mode 100644 doc/man/libkeccak_state_wipe.3 create mode 100644 doc/man/libkeccak_state_wipe_message.3 create mode 100644 doc/man/libkeccak_state_wipe_sponge.3 (limited to 'doc/man') diff --git a/doc/man/libkeccak_state_destroy.3 b/doc/man/libkeccak_state_destroy.3 index 9ea81fa..d3ec35f 100644 --- a/doc/man/libkeccak_state_destroy.3 +++ b/doc/man/libkeccak_state_destroy.3 @@ -30,7 +30,8 @@ function cannot fail. .SH SEE ALSO .BR libkeccak_state_fast_destroy (3), .BR libkeccak_state_initialise (3), -.BR libkeccak_state_reset (3) +.BR libkeccak_state_reset (3), +.BR libkeccak_state_wipe (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_state_fast_destroy.3 b/doc/man/libkeccak_state_fast_destroy.3 index 230e703..3f7964e 100644 --- a/doc/man/libkeccak_state_fast_destroy.3 +++ b/doc/man/libkeccak_state_fast_destroy.3 @@ -30,7 +30,8 @@ function cannot fail. .SH SEE ALSO .BR libkeccak_state_destroy (3), .BR libkeccak_state_initialise (3), -.BR libkeccak_state_reset (3) +.BR libkeccak_state_reset (3), +.BR libkeccak_state_wipe (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_state_reset.3 b/doc/man/libkeccak_state_reset.3 index 1bcf8b3..51c4a13 100644 --- a/doc/man/libkeccak_state_reset.3 +++ b/doc/man/libkeccak_state_reset.3 @@ -26,7 +26,8 @@ function cannot fail. .SH SEE ALSO .BR libkeccak_state_initialise (3), .BR libkeccak_state_destroy (3), -.BR libkeccak_state_fast_destroy (3) +.BR libkeccak_state_fast_destroy (3), +.BR libkeccak_state_wipe (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_state_wipe.3 b/doc/man/libkeccak_state_wipe.3 new file mode 100644 index 0000000..aca7fdb --- /dev/null +++ b/doc/man/libkeccak_state_wipe.3 @@ -0,0 +1,38 @@ +.TH LIBKECCAK_STATE_WIPE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_state_wipe - Securely erase sensitive data +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_state_wipe(libkeccak_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_state_wipe () +function securely erases data that may be +sensitive: the state of the Keccak sponge, +and the message chunk buffer. +.SH RETURN VALUES +The +.BR libkeccak_state_wipe () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_state_wipe () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_state_wipe_message (3), +.BR libkeccak_state_wipe_sponge (3), +.BR libkeccak_state_fast_destroy (3), +.BR libkeccak_state_destroy (3), +.BR libkeccak_state_reset (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_state_wipe_message.3 b/doc/man/libkeccak_state_wipe_message.3 new file mode 100644 index 0000000..98429f0 --- /dev/null +++ b/doc/man/libkeccak_state_wipe_message.3 @@ -0,0 +1,36 @@ +.TH LIBKECCAK_STATE_WIPE_MESSAGE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_state_wipe_message - Securely erase the message chunk buffer +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_state_wipe_message(libkeccak_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_state_wipe_message () +function securely erases the message chunk buffer. +.SH RETURN VALUES +The +.BR libkeccak_state_wipe_message () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_state_wipe_message () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_state_wipe_sponge (3), +.BR libkeccak_state_wipe (3), +.BR libkeccak_state_fast_destroy (3), +.BR libkeccak_state_destroy (3), +.BR libkeccak_state_reset (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_state_wipe_sponge.3 b/doc/man/libkeccak_state_wipe_sponge.3 new file mode 100644 index 0000000..d8b8d09 --- /dev/null +++ b/doc/man/libkeccak_state_wipe_sponge.3 @@ -0,0 +1,36 @@ +.TH LIBKECCAK_STATE_WIPE_SPONGE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_state_wipe_sponge - Securely erase the Keccak sponge state +.SH SYNOPSIS +.LP +.nf +#include +.P +void libkeccak_state_wipe_sponge(libkeccak_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_state_wipe_sponge () +function securely erases the state of the Keccak sponge. +.SH RETURN VALUES +The +.BR libkeccak_state_wipe_sponge () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_state_wipe_sponge () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_state_wipe_message (3), +.BR libkeccak_state_wipe (3), +.BR libkeccak_state_fast_destroy (3), +.BR libkeccak_state_destroy (3), +.BR libkeccak_state_reset (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 -- cgit v1.2.3-70-g09d2