aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_digest.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/libkeccak_digest.3')
-rw-r--r--doc/man/libkeccak_digest.341
1 files changed, 40 insertions, 1 deletions
diff --git a/doc/man/libkeccak_digest.3 b/doc/man/libkeccak_digest.3
index a5cfb69..24e5fe7 100644
--- a/doc/man/libkeccak_digest.3
+++ b/doc/man/libkeccak_digest.3
@@ -7,7 +7,7 @@ libkeccak_digest - Complete the hashing of a message with erasure
#include <libkeccak.h>
.P
int libkeccak_digest(libkeccak_state_t *\fIstate\fP, const char *\fImsg\fP, size_t \fImsglen\fP,
- size_t \fIbits\fP, const char *\fIsuffix\fP, char *\fIhashsum\fP);
+ size_t \fIbits\fP, const char *\fIsuffix\fP, char *\fIhashsum\fP);
.fi
.P
Link with \fI-lkeccak\fP.
@@ -62,6 +62,45 @@ The
.BR libkeccak_digest ()
function may fail for any reason specified by the function
.BR malloc (3).
+.SH EXAMPLE
+This example calculates the Keccak[b = 1024, c = 576, n = 256]
+hash of the input from stdin, and prints the hash, in hexadecimal
+form, to stdout.
+.LP
+.nf
+libkeccak_state_t state;
+libkeccak_spec_t spec;
+char binhash[256 / 8];
+char hexhash[256 / 8 * 2 + 1];
+char chunk[4 << 10];
+ssize_t len;
+
+spec.bitrate = 1024;
+spec.capacity = 576;
+spec.output = 256;
+if (libkeccak_state_initialise(&state, &spec) < 0)
+ goto fail;
+
+for (;;) {
+ len = read(STDIN_FILENO, chunk, sizeof(chunk));
+
+ if ((len < 0) && (errno == EINTR))
+ continue;
+ if (len < 0)
+ goto fail;
+ if (len == 0)
+ break;
+
+ if (libkeccak_update(&state, chunk, (size_t)len) < 0)
+ goto fail;
+}
+if (libkeccak_digest(&state, NULL, 0, 0, "", binhash) < 0)
+ goto fail;
+
+libkeccak_behex_lower(hexhash, binhash, sizeof(binhash));
+printf("%s\\n", hexhash);
+libkeccak_state_destroy(&state);
+.fi
.SH SEE ALSO
.BR libkeccak_state_initialise (3),
.BR libkeccak_fast_update (3),