aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_generalised_sum_fd.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-09-15 00:47:51 +0200
committerMattias Andrée <maandree@kth.se>2024-09-15 00:47:51 +0200
commitf14ba70de62cbd47e074756b1f1aec1f3b77a02d (patch)
tree4b4c27260816f553b7a1fe54153c06b122160ffc /libkeccak_generalised_sum_fd.3
parentSplit libkeccak.h and fix support for architectures that do not allow misaligned memory (diff)
downloadlibkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.gz
libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.bz2
libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.xz
Move man pages into man3/ and man7/
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libkeccak_generalised_sum_fd.3')
-rw-r--r--libkeccak_generalised_sum_fd.3137
1 files changed, 0 insertions, 137 deletions
diff --git a/libkeccak_generalised_sum_fd.3 b/libkeccak_generalised_sum_fd.3
deleted file mode 100644
index 9f5341a..0000000
--- a/libkeccak_generalised_sum_fd.3
+++ /dev/null
@@ -1,137 +0,0 @@
-.TH LIBKECCAK_GENERALISED_SUM_FD 3 LIBKECCAK
-.SH NAME
-libkeccak_generalised_sum_fd - Calculate the hash of a file
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-int libkeccak_generalised_sum_fd(int \fIfd\fP, struct libkeccak_state *\fIstate\fP, const struct libkeccak_spec *\fIspec\fP,
- const char *\fIsuffix\fP, void *\fIhashsum\fP);
-.fi
-.PP
-Link with
-.IR -lkeccak .
-.SH DESCRIPTION
-The
-.BR libkeccak_generalised_sum_fd ()
-function calculates the hash of a file, whose file desriptor is
-specified by
-.I fd
-(and should be at the beginning of the file.) The hash algorithm
-is specified by
-.I *spec
-and
-.IR suffix ,
-where
-.I *spec
-is the tuning of the algorithm and
-.I suffix
-is the bits append to the message (or
-.I NULL
-if none.)
-.PP
-The hash is stored in binary form to
-.IR hashsum .
-.I hashsum
-should have an allocation size of at least
-.RI ((( spec->output
-+ 7) / 8) * sizeof(char)).
-.PP
-.I *state
-should not be initialised unless
-.I spec
-is
-.IR NULL .
-.BR libkeccak_generalised_sum_fd ()
-initialises
-.I *state
-itself unless
-.I spec
-is
-.IR NULL .
-Therefore there would be a memory leak if
-.I *state
-is already initialised and
-.I spec
-is
-.RI non- NULL .
-.SH RETURN VALUES
-The
-.BR libkeccak_generalised_sum_fd ()
-function returns 0 upon successful completion.
-On error, -1 is returned and
-.I errno
-is set to describe the error.
-.SH ERRORS
-The
-.BR libkeccak_generalised_sum_fd ()
-function may fail for any reason, except those resulting
-in
-.I errno
-being set to
-.BR EINTR ,
-specified for the functions
-.BR read (2),
-.BR malloc (3),
-and
-.BR realloc (3).
-.SH NOTES
-Be aware,
-.BR libkeccak_generalised_sum_fd ()
-hashes the file until the end has been reached. For pipes
-and sockets and this means until the file has been closed.
-But for character devices, this usually means never.
-Attempting to hash files in /dev is therefore usually a
-bad idea.
-.BR libkeccak_generalised_sum_fd ()
-does not check for the file length or file type before
-hashing as this could limit what you can do, and make
-the library more complex.
-.PP
-.BR libkeccak_generalised_sum_fd ()
-does not stop if interrupted
-.RB ( read (2)
-returns
-.BR EINTR .)
-.PP
-.BR libkeccak_generalised_sum_fd ()
-assumes all information is non-sensitive, and will
-therefore not perform any secure erasure of information.
-.PP
-.BR libkeccak_generalised_sum_fd ()
-does not validate the tuning of the algorithm.
-.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.
-.PP
-.nf
-struct libkeccak_state state;
-struct libkeccak_spec spec;
-char binhash[256 / 8];
-char hexhash[256 / 8 * 2 + 1];
-
-spec.bitrate = 1024;
-spec.capacity = 576;
-spec.output = 256;
-
-if (libkeccak_generalised_sum_fd(STDIN_FILENO, &state, &spec, NULL, binhash) < 0)
- goto fail;
-libkeccak_behex_lower(hexhash, binhash, sizeof(binhash));
-printf(\(dq%s\en\(dq, hexhash);
-libkeccak_state_destroy(&state);
-.fi
-.SH SEE ALSO
-.BR libkeccak_behex_lower (3),
-.BR libkeccak_behex_upper (3),
-.BR libkeccak_keccaksum_fd (3),
-.BR libkeccak_sha3sum_fd (3),
-.BR libkeccak_rawshakesum_fd (3),
-.BR libkeccak_shakesum_fd (3),
-.BR libkeccak_spec_cshake (3),
-.BR libkeccak_spec_sha3 (3),
-.BR libkeccak_spec_shake (3),
-.BR libkeccak_spec_rawshake (3),
-.BR libkeccak_spec_check (3),
-.BR libkeccak_generalised_spec_initialise (3),
-.BR libkeccak_state_initialise (3)