libsha2_digest.3


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

.TH LIBSHA2_DIGEST 3 2019-02-09 libsha2
.SH NAME
libsha2_digest \- Get the result of a SHA-2 hashing
.SH SYNOPSIS
.nf
#include <libsha2.h>

void libsha2_digest(struct libsha2_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_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_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_init (3),
.BR libsha2_state_output_size (3),
.BR libsha2_sum_fd (3),
.BR libsha2_update (3)