projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| bbda8ce9 RT |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | EVP_sha224, | |
| 6 | EVP_sha256, | |
| 4bed94f0 P |
7 | EVP_sha512_224, |
| 8 | EVP_sha512_256, | |
| bbda8ce9 RT |
9 | EVP_sha384, |
| 10 | EVP_sha512 | |
| 11 | - SHA-2 For EVP | |
| 12 | ||
| 13 | =head1 SYNOPSIS | |
| 14 | ||
| 15 | #include <openssl/evp.h> | |
| 16 | ||
| 17 | const EVP_MD *EVP_sha224(void); | |
| 18 | const EVP_MD *EVP_sha256(void); | |
| 4bed94f0 P |
19 | const EVP_MD *EVP_sha512_224(void); |
| 20 | const EVP_MD *EVP_sha512_256(void); | |
| bbda8ce9 RT |
21 | const EVP_MD *EVP_sha384(void); |
| 22 | const EVP_MD *EVP_sha512(void); | |
| 23 | ||
| 24 | =head1 DESCRIPTION | |
| 25 | ||
| 26 | SHA-2 (Secure Hash Algorithm 2) is a family of cryptographic hash functions | |
| 27 | standardized in NIST FIPS 180-4, first published in 2001. | |
| 28 | ||
| 29 | =over 4 | |
| 30 | ||
| 31 | =item EVP_sha224(), | |
| 32 | EVP_sha256(), | |
| 4bed94f0 P |
33 | EVP_sha512_224, |
| 34 | EVP_sha512_256, | |
| bbda8ce9 RT |
35 | EVP_sha384(), |
| 36 | EVP_sha512() | |
| 37 | ||
| 4bed94f0 P |
38 | The SHA-2 SHA-224, SHA-256, SHA-512/224, SHA512/256, SHA-384 and SHA-512 |
| 39 | algorithms, which generate 224, 256, 224, 256, 384 and 512 bits | |
| 40 | respectively of output from a given input. | |
| 41 | ||
| 42 | The two algorithms: SHA-512/224 and SHA512/256 are truncated forms of the | |
| 43 | SHA-512 algorithm. They are distinct from SHA-224 and SHA-256 even though | |
| 44 | their outputs are of the same size. | |
| bbda8ce9 RT |
45 | |
| 46 | =back | |
| 47 | ||
| e798248c | 48 | =head1 NOTES |
| 49 | ||
| 50 | Developers should be aware of the negative performance implications of | |
| 51 | calling these functions multiple times and should consider using | |
| 52 | L<EVP_MD_fetch(3)> instead. | |
| 53 | See L<crypto(7)/Performance> for further information. | |
| bbda8ce9 RT |
54 | |
| 55 | =head1 RETURN VALUES | |
| 56 | ||
| 57 | These functions return a B<EVP_MD> structure that contains the | |
| ae2efd63 | 58 | implementation of the message digest. See L<EVP_MD_meth_new(3)> for |
| bbda8ce9 RT |
59 | details of the B<EVP_MD> structure. |
| 60 | ||
| 61 | =head1 CONFORMING TO | |
| 62 | ||
| 63 | NIST FIPS 180-4. | |
| 64 | ||
| 65 | =head1 SEE ALSO | |
| 66 | ||
| 67 | L<evp(7)>, | |
| 68 | L<EVP_DigestInit(3)> | |
| 69 | ||
| 70 | =head1 COPYRIGHT | |
| 71 | ||
| da1c088f | 72 | Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved. |
| bbda8ce9 | 73 | |
| 4746f25a | 74 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| bbda8ce9 RT |
75 | this file except in compliance with the License. You can obtain a copy |
| 76 | in the file LICENSE in the source distribution or at | |
| 77 | L<https://www.openssl.org/source/license.html>. | |
| 78 | ||
| 79 | =cut | |
| 80 |