diff options
author | Mattias Andrée <maandree@kth.se> | 2019-02-10 17:55:25 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2019-02-10 17:55:25 +0100 |
commit | 09e282b3cbd465a808dccc8223c0e0805faf4642 (patch) | |
tree | 1ac72deae9eeeb7665ef060840c308d350de390f /libsha2_hmac_digest.3 | |
parent | Minor improvement and man pages for HMAC (diff) | |
download | libsha2-09e282b3cbd465a808dccc8223c0e0805faf4642.tar.gz libsha2-09e282b3cbd465a808dccc8223c0e0805faf4642.tar.bz2 libsha2-09e282b3cbd465a808dccc8223c0e0805faf4642.tar.xz |
...
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r-- | libsha2_hmac_digest.3 | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/libsha2_hmac_digest.3 b/libsha2_hmac_digest.3 new file mode 100644 index 0000000..7df9e1e --- /dev/null +++ b/libsha2_hmac_digest.3 @@ -0,0 +1,70 @@ +.TH LIBSHA2_HMAC_DIGEST 3 2019-02-10 libjson +.SH NAME +libsha2_hmac_digest \- Get the result of a HMAC-SHA 2 hashing +.SH SYNOPSIS +.nf +#include <libsha2.h> + +void libsha2_hmac_digest(struct libsha2_hmac_state *restrict \fIstate\fP, const void *\fImessage\fP, size_t \fImsglen\fP, void *\fIoutput\fP); +.fi +.PP +Link with +.IR \-lsha2 . +.SH DESCRIPTION +The +.BR libsha2_hmac_digest () +function feeds the first +.I msglen +.B bits +of +.I message +into the hashing state of the +.I state +parameter, and finalises the hashing. +The resulting hash is stored in binary +format in +.IR output . +The user must make sure that +.I output +is sufficiently large, which means at +least the return value of the +.BR libsha2_hmac_state_output_size (3) +function. +.PP +If +.I msglen +is not a multiple of 8, the lowest +.I msglen%8 +bits from the last by in +.I message +is used as the complete byte. +.PP +The +.BR libsha2_behex_lower (3) +and +.BR libsha2_behex_upper (3) +functions can be used to convert the +result to hexadecimal format. +.SH RETURN VALUE +None. +.SH ERRORS +None. +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR libsha2_behex_lower (3), +.BR libsha2_behex_upper (3), +.BR libsha2_hmac_init (3), +.BR libsha2_hmac_state_output_size (3), +.BR libsha2_hmac_sum_fd (3), +.BR libsha2_hmac_update (3) |