258f189b9fbe06365a5ef6220b5cdfdbfbbd163c
[openssl.git] / doc / crypto / SHA1_Init.pod
1 =pod
2
3 =head1 NAME
4
5 SHA1_Init, SHA1_Update_SHA1_Final - Compute SHA1 hash
6
7 =head1 SYNOPSIS
8
9  #include <openssl/sha.h>
10
11  void SHA1_Init(SHA_CTX *c);
12  void SHA1_Update(SHA_CTX *c, const unsigned char *data,
13                   unsigned long len);
14  void SHA1_Final(unsigned char *md, SHA_CTX *c);
15
16 =head1 DESCRIPTION
17
18 SHA1_Init() initializes a B<SHA_CTX> structure.
19
20 SHA1_Update() can be called repeatedly with chunks of the message to
21 be hashed (B<len> bytes at B<data>).
22
23 SHA1_Final() places the message digest in B<md>, which must have space
24 for SHA_DIGEST_LENGTH == 20 bytes of output, and erases the B<SHA_CTX>.
25
26 When the entire message is available at one time, L<SHA1(3)|SHA(1)>
27 can be used.
28
29 =head1 RETURN VALUES
30
31 SHA1_Init(), SHA1_Update() and SHA1_Final() do not return values.
32
33 =head1 HISTORY
34
35 SHA1_Init(), SHA1_Update() and SHA1_Final()are available in all
36 versions of SSLeay and OpenSSL.
37
38 =head1 SEE ALSO
39
40 sha(3), ripemd(3), SHA1(3)
41
42 =cut