aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-10-07 02:37:04 +0200
committerMattias Andrée <maandree@operamail.com>2015-10-07 02:37:04 +0200
commit4722e1f0a440c223efb269c7dbdeb6bc56a5932d (patch)
tree9c3a275892bc320e55e51ef81d5efe4b4f27a0c9 /doc/man
parentfile hashers do not automatically destroy the state (diff)
downloadlibkeccak-4722e1f0a440c223efb269c7dbdeb6bc56a5932d.tar.gz
libkeccak-4722e1f0a440c223efb269c7dbdeb6bc56a5932d.tar.bz2
libkeccak-4722e1f0a440c223efb269c7dbdeb6bc56a5932d.tar.xz
stylo + example in libkeccak_digest.3, libkeccak_fast_digest.3, libkeccak_fast_update.3, and libkeccak_update.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_digest.341
-rw-r--r--doc/man/libkeccak_fast_digest.339
-rw-r--r--doc/man/libkeccak_fast_update.341
-rw-r--r--doc/man/libkeccak_update.341
4 files changed, 159 insertions, 3 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),
diff --git a/doc/man/libkeccak_fast_digest.3 b/doc/man/libkeccak_fast_digest.3
index 27903e3..7b647f5 100644
--- a/doc/man/libkeccak_fast_digest.3
+++ b/doc/man/libkeccak_fast_digest.3
@@ -63,6 +63,45 @@ The
.BR libkeccak_fast_digest ()
function may fail for any reason specified by the function
.BR realloc (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_fast_update(&state, chunk, (size_t)len) < 0)
+ goto fail;
+}
+if (libkeccak_fast_digest(&state, NULL, 0, 0, "", binhash) < 0)
+ goto fail;
+
+libkeccak_behex_lower(hexhash, binhash, sizeof(binhash));
+printf("%s\\n", hexhash);
+libkeccak_state_fast_destroy(&state);
+.fi
.SH SEE ALSO
.BR libkeccak_state_initialise (3),
.BR libkeccak_fast_update (3),
diff --git a/doc/man/libkeccak_fast_update.3 b/doc/man/libkeccak_fast_update.3
index fb52f45..7f9ee07 100644
--- a/doc/man/libkeccak_fast_update.3
+++ b/doc/man/libkeccak_fast_update.3
@@ -35,8 +35,47 @@ The
.BR libkeccak_fast_update ()
function may fail for any reason specified by the function
.BR realloc (3).
-.SH Notes
+.SH NOTES
Neither parameter by be \fINULL\fP or 0.
+.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_fast_update(&state, chunk, (size_t)len) < 0)
+ goto fail;
+}
+if (libkeccak_fast_digest(&state, NULL, 0, 0, "", binhash) < 0)
+ goto fail;
+
+libkeccak_behex_lower(hexhash, binhash, sizeof(binhash));
+printf("%s\\n", hexhash);
+libkeccak_state_fast_destroy(&state);
+.fi
.SH SEE ALSO
.BR libkeccak_state_initialise (3),
.BR libkeccak_update (3),
diff --git a/doc/man/libkeccak_update.3 b/doc/man/libkeccak_update.3
index dee71ce..52950c2 100644
--- a/doc/man/libkeccak_update.3
+++ b/doc/man/libkeccak_update.3
@@ -34,8 +34,47 @@ The
.BR libkeccak_update ()
function may fail for any reason specified by the function
.BR malloc (3).
-.SH Notes
+.SH NOTES
Neither parameter by be \fINULL\fP or 0.
+.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),