aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libkeccak_state_wipe.3
blob: 9028dcce3c62653c2dd277ecc512afe091cf5b63 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.TH LIBKECCAK_STATE_WIPE 3 LIBKECCAK
.SH NAME
libkeccak_state_wipe - Securely erase sensitive data
.SH SYNOPSIS
.nf
#include <libkeccak.h>

void libkeccak_state_wipe(struct libkeccak_state *\fIstate\fP);
.fi
.PP
Link with
.IR -lkeccak .
.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)