30fc6c9ec1ba24e1c16de6b8dbed1bf1cc72da31
[openssl.git] / doc / crypto / SHA1.pod
1 =pod
2
3 =head1 NAME
4
5 SHA1 - Compute SHA1 hash
6
7 =head1 SYNOPSIS
8
9  #include <openssl/sha.h>
10
11  unsigned char *SHA1(const unsigned char *d, unsigned long n,
12                      unsigned char *md);
13
14 =head1 DESCRIPTION
15
16 SHA1() computes the SHA-1 message digest of the B<n> bytes at B<d> and
17 places it in B<md> (which must have space for SHA_DIGEST_LENGTH == 20
18 bytes of output). If B<md> is NULL, the digest is placed in a static
19 array.
20
21 L<SHA1_Init(3)|SHA1_Init(3)> may be used if the message is not completely
22 stored in memory.
23
24 =head1 RETURN VALUE
25
26 SHA1() returns a pointer to the hash value. 
27
28 =head1 HISTORY
29
30 SHA1() is available in all versions of SSLeay and OpenSSL.
31
32 =head1 SEE ALSO
33
34 sha(3), ripemd(3), SHA1_Init(3)
35
36 =cut