diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-02-10 17:54:09 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-02-10 17:54:09 +0100 |
| commit | 6e3af681aa5927d2ab2861e94c0cfea6fa42c0ab (patch) | |
| tree | dc14cf6beeab03da867e7946bd6ab3601a66d370 /libsha2_hmac_unmarshal.3 | |
| parent | libsha2.h.0: securely erasing the state (diff) | |
| download | libsha2-6e3af681aa5927d2ab2861e94c0cfea6fa42c0ab.tar.gz libsha2-6e3af681aa5927d2ab2861e94c0cfea6fa42c0ab.tar.bz2 libsha2-6e3af681aa5927d2ab2861e94c0cfea6fa42c0ab.tar.xz | |
Minor improvement and man pages for HMAC
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libsha2_hmac_unmarshal.3')
| -rw-r--r-- | libsha2_hmac_unmarshal.3 | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/libsha2_hmac_unmarshal.3 b/libsha2_hmac_unmarshal.3 new file mode 100644 index 0000000..e856146 --- /dev/null +++ b/libsha2_hmac_unmarshal.3 @@ -0,0 +1,54 @@ +.TH LIBSHA2_HMAC_UNMARSHAL 3 2019-02-10 libjson +.SH NAME +libsha2_hmac_unmarshal \- Unmarshal an HMAC-SHA 2 hashing state +.SH SYNOPSIS +.nf +#include <libsha2.h> + +size_t libsha2_hmac_unmarshal(struct libsha2_hmac_state *restrict \fIstate\fP, const void *restrict \fIbuf\fP, size_t \fIbufsize\fP); +.fi +.PP +Link with +.IR \-lsha2 . +.SH DESCRIPTION +The +.BR libsha2_hmac_unmarshal () +function unmarshal +.I state +from the buffer +.IR buf . +.I bufsize +shall be the maximum number of bytes the +function may read from +.IR buf . +.SH RETURN VALUE +The +.BR libsha2_hmac_unmarshal () +function returns the number of unmarshalled +bytes (this number is always positive) upon +successful completion, otherwise 0 is returned. +.SH ERRORS +The +.BR libsha2_hmac_unmarshal () +function will fail if: +.TP +.B EINVAL +.I bufsize +is too small or the contents of +.I buf +is invalid or created with an incompatible +version of the library. +.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_hmac_marshal (3) |