]>
Commit | Line | Data |
---|---|---|
38e33cef UM |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
f7812493 MC |
5 | SHA1, SHA1_Init, SHA1_Update, SHA1_Final, SHA224, SHA224_Init, SHA224_Update, |
6 | SHA224_Final, SHA256, SHA256_Init, SHA256_Update, SHA256_Final, SHA384, | |
7 | SHA384_Init, SHA384_Update, SHA384_Final, SHA512, SHA512_Init, SHA512_Update, | |
8 | SHA512_Final - Secure Hash Algorithm | |
38e33cef UM |
9 | |
10 | =head1 SYNOPSIS | |
11 | ||
12 | #include <openssl/sha.h> | |
13 | ||
7b2bde50 PH |
14 | unsigned char *SHA1(const unsigned char *data, size_t count, unsigned char *md_buf); |
15 | unsigned char *SHA224(const unsigned char *data, size_t count, unsigned char *md_buf); | |
16 | unsigned char *SHA256(const unsigned char *data, size_t count, unsigned char *md_buf); | |
17 | unsigned char *SHA384(const unsigned char *data, size_t count, unsigned char *md_buf); | |
18 | unsigned char *SHA512(const unsigned char *data, size_t count, unsigned char *md_buf); | |
4d49b685 | 19 | |
3dbf8243 MC |
20 | The following functions have been deprecated since OpenSSL 3.0, and can be |
21 | hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, | |
22 | see L<openssl_user_macros(7)>: | |
85d843c8 | 23 | |
8a4af56f | 24 | int SHA1_Init(SHA_CTX *c); |
f7812493 | 25 | int SHA1_Update(SHA_CTX *c, const void *data, size_t len); |
8a4af56f | 26 | int SHA1_Final(unsigned char *md, SHA_CTX *c); |
f7812493 MC |
27 | |
28 | int SHA224_Init(SHA256_CTX *c); | |
29 | int SHA224_Update(SHA256_CTX *c, const void *data, size_t len); | |
30 | int SHA224_Final(unsigned char *md, SHA256_CTX *c); | |
f7812493 MC |
31 | |
32 | int SHA256_Init(SHA256_CTX *c); | |
33 | int SHA256_Update(SHA256_CTX *c, const void *data, size_t len); | |
34 | int SHA256_Final(unsigned char *md, SHA256_CTX *c); | |
f7812493 MC |
35 | |
36 | int SHA384_Init(SHA512_CTX *c); | |
37 | int SHA384_Update(SHA512_CTX *c, const void *data, size_t len); | |
38 | int SHA384_Final(unsigned char *md, SHA512_CTX *c); | |
f7812493 MC |
39 | |
40 | int SHA512_Init(SHA512_CTX *c); | |
41 | int SHA512_Update(SHA512_CTX *c, const void *data, size_t len); | |
42 | int SHA512_Final(unsigned char *md, SHA512_CTX *c); | |
38e33cef UM |
43 | |
44 | =head1 DESCRIPTION | |
45 | ||
4d49b685 DDO |
46 | All of the functions described on this page |
47 | except for SHA1(), SHA224(), SHA256(), SHA384() and SHA512() are deprecated. | |
85d843c8 | 48 | Applications should instead use L<EVP_DigestInit_ex(3)>, L<EVP_DigestUpdate(3)> |
4d49b685 DDO |
49 | and L<EVP_DigestFinal_ex(3)>, or the quick one-shot function L<EVP_Q_digest(3)>. |
50 | SHA1(), SHA224(), SHA256(), SHA384(), and SHA256() | |
51 | can continue to be used. They can also be replaced by, e.g., | |
52 | ||
53 | (EVP_Q_digest(d, n, md, NULL, NULL, "SHA256", NULL) ? md : NULL) | |
f7812493 | 54 | |
38e33cef UM |
55 | SHA-1 (Secure Hash Algorithm) is a cryptographic hash function with a |
56 | 160 bit output. | |
57 | ||
74235cc9 UM |
58 | SHA1() computes the SHA-1 message digest of the B<n> |
59 | bytes at B<d> and places it in B<md> (which must have space for | |
60 | SHA_DIGEST_LENGTH == 20 bytes of output). If B<md> is NULL, the digest | |
f7812493 | 61 | is placed in a static array. Note: setting B<md> to NULL is B<not thread safe>. |
74235cc9 UM |
62 | |
63 | The following functions may be used if the message is not completely | |
64 | stored in memory: | |
65 | ||
66 | SHA1_Init() initializes a B<SHA_CTX> structure. | |
67 | ||
68 | SHA1_Update() can be called repeatedly with chunks of the message to | |
69 | be hashed (B<len> bytes at B<data>). | |
70 | ||
71 | SHA1_Final() places the message digest in B<md>, which must have space | |
72 | for SHA_DIGEST_LENGTH == 20 bytes of output, and erases the B<SHA_CTX>. | |
73 | ||
f7812493 MC |
74 | The SHA224, SHA256, SHA384 and SHA512 families of functions operate in the |
75 | same way as for the SHA1 functions. Note that SHA224 and SHA256 use a | |
76 | B<SHA256_CTX> object instead of B<SHA_CTX>. SHA384 and SHA512 use B<SHA512_CTX>. | |
77 | The buffer B<md> must have space for the output from the SHA variant being used | |
78 | (defined by SHA224_DIGEST_LENGTH, SHA256_DIGEST_LENGTH, SHA384_DIGEST_LENGTH and | |
79 | SHA512_DIGEST_LENGTH). Also note that, as for the SHA1() function above, the | |
80 | SHA224(), SHA256(), SHA384() and SHA512() functions are not thread safe if | |
81 | B<md> is NULL. | |
4facdbb5 | 82 | |
74235cc9 UM |
83 | =head1 RETURN VALUES |
84 | ||
f7812493 | 85 | SHA1(), SHA224(), SHA256(), SHA384() and SHA512() return a pointer to the hash |
1bc74519 | 86 | value. |
74235cc9 | 87 | |
f7812493 MC |
88 | SHA1_Init(), SHA1_Update() and SHA1_Final() and equivalent SHA224, SHA256, |
89 | SHA384 and SHA512 functions return 1 for success, 0 otherwise. | |
74235cc9 | 90 | |
38e33cef UM |
91 | =head1 CONFORMING TO |
92 | ||
f7812493 | 93 | US Federal Information Processing Standard FIPS PUB 180-4 (Secure Hash |
6671fe16 BM |
94 | Standard), |
95 | ANSI X9.30 | |
38e33cef UM |
96 | |
97 | =head1 SEE ALSO | |
98 | ||
4d49b685 | 99 | L<EVP_Q_digest(3)>, |
9b86974e | 100 | L<EVP_DigestInit(3)> |
38e33cef | 101 | |
85d843c8 P |
102 | =head1 HISTORY |
103 | ||
4d49b685 | 104 | All of these functions except SHA*() were deprecated in OpenSSL 3.0. |
85d843c8 | 105 | |
e2f92610 RS |
106 | =head1 COPYRIGHT |
107 | ||
0789c7d8 | 108 | Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 109 | |
4746f25a | 110 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
111 | this file except in compliance with the License. You can obtain a copy |
112 | in the file LICENSE in the source distribution or at | |
113 | L<https://www.openssl.org/source/license.html>. | |
114 | ||
115 | =cut |