aboutsummaryrefslogtreecommitdiffstats
path: root/libhashsum_init_shake512_hasher.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-09-05 19:26:08 +0200
committerMattias Andrée <maandree@kth.se>2024-09-05 19:26:08 +0200
commit9789d16eb67f8cdcba8095530b460974d4645324 (patch)
treebe8797ee9d5541cdb0d1b5866d4fd1cc58e4d2f7 /libhashsum_init_shake512_hasher.3
parentSet standard_partial_byte_output_encoding to LIBHASHSUM_UNSUPPORTED for Keccal-{224,256,384,512} (diff)
downloadlibhashsum-9789d16eb67f8cdcba8095530b460974d4645324.tar.gz
libhashsum-9789d16eb67f8cdcba8095530b460974d4645324.tar.bz2
libhashsum-9789d16eb67f8cdcba8095530b460974d4645324.tar.xz
Document standard_partial_byte_{in,out}put_encoding in man pages1.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libhashsum_init_shake512_hasher.3')
-rw-r--r--libhashsum_init_shake512_hasher.332
1 files changed, 32 insertions, 0 deletions
diff --git a/libhashsum_init_shake512_hasher.3 b/libhashsum_init_shake512_hasher.3
index 22630e2..547da3c 100644
--- a/libhashsum_init_shake512_hasher.3
+++ b/libhashsum_init_shake512_hasher.3
@@ -13,6 +13,8 @@ libhashsum_init_shake512_hasher - initialise state for SHAKE512 hashing
size_t \fIhash_size\fP;
unsigned char *\fIhash_output\fP;
unsigned char \fIsupports_non_whole_bytes\fP;
+ unsigned char \fIstandard_partial_byte_input_encoding\fP;
+ unsigned char \fIstandard_partial_byte_output_encoding\fP;
size_t (*\fIprocess\fP)(struct libhashsum_hasher *\fPthis\fP, const void *\fPdata\fP, size_t \fPbytes\fP);
int (*\fIfinalise_const\fP)(struct libhashsum_hasher *\fPthis\fP, const void *\fPdata\fP, size_t \fPbytes\fP, unsigned \fPextra_bits\fP);
int (*\fIfinalise\fP)(struct libhashsum_hasher *\fPthis\fP, void *\fPdata\fP, size_t \fPbytes\fP, unsigned \fPextra_bits\fP, size_t \fPsize\fP);
@@ -269,6 +271,36 @@ Insufficient memory available.
.I hashbits
is too large.
+.SH EXTENDED DESCRIPTION
+libhashsum has normalises the all implemented hash
+functions to always use the least significant bits
+in non-whole octets, however each hash function has
+its unstandarded. To make it easier to create an
+application the use the same encoding of partial
+octets as other application using any particular
+hash function,
+.B struct libhashsum_hasher
+contains two fields:
+.I standard_partial_byte_input_encoding
+and
+.IR standard_partial_byte_output_encoding ;
+which are merely informtional. They are not set to
+specify how libhashsum expects and encodes non-whole
+octets, but rather specify how partial bytes are
+encoded in the reference implementation or
+specification of a hash function.
+.PP
+SHAKE512 supports non-whole octet both in its
+input and its output, and in its standard uses
+the least significant bits of non-whole octets
+both in the input and in the output, thus
+.I this->standard_partial_byte_input_encoding
+and
+.I this->standard_partial_byte_output_encoding
+will both be set to
+.IR LIBHASHSUM_LEAST_SIGNIFICANT ,
+which the same behaviour as libhashsum implements.
+
.SH HISTORY
libhashsum 1.0.