diff options
Diffstat (limited to 'src/lib/libcrypto/doc/EVP_DigestInit.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/EVP_DigestInit.pod | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/src/lib/libcrypto/doc/EVP_DigestInit.pod b/src/lib/libcrypto/doc/EVP_DigestInit.pod index 6d4e156ae3..fefc858f7e 100644 --- a/src/lib/libcrypto/doc/EVP_DigestInit.pod +++ b/src/lib/libcrypto/doc/EVP_DigestInit.pod | |||
| @@ -2,7 +2,12 @@ | |||
| 2 | 2 | ||
| 3 | =head1 NAME | 3 | =head1 NAME |
| 4 | 4 | ||
| 5 | EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal - EVP digest routines | 5 | EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal, EVP_MAX_MD_SIZE, |
| 6 | EVP_MD_CTX_copy, EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size, EVP_MD_block_size, | ||
| 7 | EVP_MD_CTX_md, EVP_MD_CTX_size, EVP_MD_CTX_block_size, EVP_MD_CTX_type, | ||
| 8 | EVP_md_null, EVP_md2, EVP_md5, EVP_sha, EVP_sha1, EVP_dss, EVP_dss1, EVP_mdc2, | ||
| 9 | EVP_ripemd160, EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj - | ||
| 10 | EVP digest routines | ||
| 6 | 11 | ||
| 7 | =head1 SYNOPSIS | 12 | =head1 SYNOPSIS |
| 8 | 13 | ||
| @@ -45,12 +50,12 @@ EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal - EVP digest routines | |||
| 45 | 50 | ||
| 46 | The EVP digest routines are a high level interface to message digests. | 51 | The EVP digest routines are a high level interface to message digests. |
| 47 | 52 | ||
| 48 | EVP_DigestInit() initialises a digest context B<ctx> to use a digest | 53 | EVP_DigestInit() initializes a digest context B<ctx> to use a digest |
| 49 | B<type>: this will typically be supplied by a function such as | 54 | B<type>: this will typically be supplied by a function such as |
| 50 | EVP_sha1(). | 55 | EVP_sha1(). |
| 51 | 56 | ||
| 52 | EVP_DigestUpdate() hashes B<cnt> bytes of data at B<d> into the | 57 | EVP_DigestUpdate() hashes B<cnt> bytes of data at B<d> into the |
| 53 | digest context B<ctx>. This funtion can be called several times on the | 58 | digest context B<ctx>. This function can be called several times on the |
| 54 | same B<ctx> to hash additional data. | 59 | same B<ctx> to hash additional data. |
| 55 | 60 | ||
| 56 | EVP_DigestFinal() retrieves the digest value from B<ctx> and places | 61 | EVP_DigestFinal() retrieves the digest value from B<ctx> and places |
| @@ -58,7 +63,7 @@ it in B<md>. If the B<s> parameter is not NULL then the number of | |||
| 58 | bytes of data written (i.e. the length of the digest) will be written | 63 | bytes of data written (i.e. the length of the digest) will be written |
| 59 | to the integer at B<s>, at most B<EVP_MAX_MD_SIZE> bytes will be written. | 64 | to the integer at B<s>, at most B<EVP_MAX_MD_SIZE> bytes will be written. |
| 60 | After calling EVP_DigestFinal() no additional calls to EVP_DigestUpdate() | 65 | After calling EVP_DigestFinal() no additional calls to EVP_DigestUpdate() |
| 61 | can be made, but EVP_DigestInit() can be called to initialiase a new | 66 | can be made, but EVP_DigestInit() can be called to initialize a new |
| 62 | digest operation. | 67 | digest operation. |
| 63 | 68 | ||
| 64 | EVP_MD_CTX_copy() can be used to copy the message digest state from | 69 | EVP_MD_CTX_copy() can be used to copy the message digest state from |
| @@ -97,7 +102,7 @@ returns is of zero length. | |||
| 97 | 102 | ||
| 98 | EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj() | 103 | EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj() |
| 99 | return an B<EVP_MD> structure when passed a digest name, a digest NID or | 104 | return an B<EVP_MD> structure when passed a digest name, a digest NID or |
| 100 | an ASN1_OBJECT structure respectively. The digest table must be initialised | 105 | an ASN1_OBJECT structure respectively. The digest table must be initialized |
| 101 | using, for example, OpenSSL_add_all_digests() for these functions to work. | 106 | using, for example, OpenSSL_add_all_digests() for these functions to work. |
| 102 | 107 | ||
| 103 | =head1 RETURN VALUES | 108 | =head1 RETURN VALUES |
