diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-02-09 20:02:16 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-02-09 20:02:16 +0100 |
| commit | 9475c19921162986119ee69eba8bfa2a9832d551 (patch) | |
| tree | 285c9cbd0a824d2bfb480431b33099e2a80e35bf /libsha2_init.3 | |
| parent | Add HMAC to TODO (diff) | |
| download | libsha2-9475c19921162986119ee69eba8bfa2a9832d551.tar.gz libsha2-9475c19921162986119ee69eba8bfa2a9832d551.tar.bz2 libsha2-9475c19921162986119ee69eba8bfa2a9832d551.tar.xz | |
Minor changes, add man pages, rename libsha2_state_initialise to libsha2_init
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
| -rw-r--r-- | libsha2_init.3 | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/libsha2_init.3 b/libsha2_init.3 new file mode 100644 index 0000000..2a11f89 --- /dev/null +++ b/libsha2_init.3 @@ -0,0 +1,64 @@ +.TH LIBSHA2_INIT 3 2019-02-09 libjson +.SH NAME +libsha2_init \- Initialises hashing with a SHA 2 algorithm +.SH SYNOPSIS +.nf +#include <libsha2.h> + +enum libsha2_algorithm { + LIBSHA2_224, /* SHA-224 */ + LIBSHA2_256, /* SHA-256 */ + LIBSHA2_384, /* SHA-384 */ + LIBSHA2_512, /* SHA-512 */ + LIBSHA2_512_224, /* SHA-512/224 */ + LIBSHA2_512_256 /* SHA-512/256 */ +}; + +int libsha2_init(struct libsha2_state *restrict \fIstate\fP, enum libsha2_algorithm \fIalgorithm\fP); +.fi +.PP +Link with +.IR \-lsha2 . +.SH DESCRIPTION +The +.BR libsha2_init () +function stores the selected +.I algorithm +in +.I state +and initialises +.I state +accordingly with the initial hashing state. +.SH RETURN VALUE +The +.BR libsha2_init () +function returns 0 upon successful completion, +otherwise -1 is returned and +.I errno +is set appropriately. +.SH ERRORS +The +.BR libsha2_init () +function will fail if: +.TP +.B EINVAL +.I algorithm +is not a valid +.B enum libsha2_algorithm +value. +.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_digest (3), +.BR libsha2_sum_fd (3), +.BR libsha2_update (3) |