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_sum_fd.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 'libsha2_sum_fd.3')
| -rw-r--r-- | libsha2_sum_fd.3 | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/libsha2_sum_fd.3 b/libsha2_sum_fd.3 new file mode 100644 index 0000000..18e9291 --- /dev/null +++ b/libsha2_sum_fd.3 @@ -0,0 +1,77 @@ +.TH LIBSHA2_SUM_FD 3 2019-02-09 libjson +.SH NAME +libsha2_sum_fd \- Hash a file 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_sum_fd(int \fIfd\fP, enum libsha2_algorithm \fIalgorithm\fP, char *restrict \fIhashsum\fP); +.fi +.PP +Link with +.IR \-lsha2 . +.SH DESCRIPTION +The +.BR libsha2_sum_fd () +function hashes the file with the +file descriptor +.I fd +with the selected +.IR algorithm . +The resulting hash is stored in binary +format in +.I hashsum . +The user must make sure that +.I hashsum +is sufficiently large, which means at +least the return value of the +.BR libsha2_algorithm_output_size (3) +function. +.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 +The +.BR libsha2_sum_fd () +function returns 0 upon successful completion, +otherwise -1 is returned and +.I errno +is set appropriately. +.SH ERRORS +The +.BR libsha2_sum_fd () +function may fail for any reason specified for the +.BR read (3) +and +.BR libsha2_init (3) +functions. +.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_algorithm_output_size (3), +.BR libsha2_behex_lower (3), +.BR libsha2_behex_upper (3), +.BR libsha2_init (3) |