diff options
author | Richard Levitte <levitte@openssl.org> | 2017-11-24 15:14:42 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2017-11-24 15:40:21 +0100 |
commit | 6a3d2ded004f3bb9a70df0de96a2439c2793ed72 (patch) | |
tree | dc5ade6cfe37324af5dc7e63b330adf7cf375975 /doc | |
parent | 0ec3b53cdbda0dea32a970fe36893c0c84cfa8f5 (diff) |
Correct EVP_CIPHER_meth_new.pod and EVP_MD_meth_new.pod
One had some lines copied from the other, and both were missing a
proper RETURN VALUES section.
Fixes #4781
Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4787)
(cherry picked from commit 51e47d5f6a7944c3e3ddc5f6d376fc1320639277)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/crypto/EVP_CIPHER_meth_new.pod | 31 | ||||
-rw-r--r-- | doc/crypto/EVP_MD_meth_new.pod | 13 |
2 files changed, 34 insertions, 10 deletions
diff --git a/doc/crypto/EVP_CIPHER_meth_new.pod b/doc/crypto/EVP_CIPHER_meth_new.pod index 917fb3edd4..08e8290bef 100644 --- a/doc/crypto/EVP_CIPHER_meth_new.pod +++ b/doc/crypto/EVP_CIPHER_meth_new.pod @@ -204,17 +204,32 @@ EVP_CIPHER_CTX_get_cipher_data(). This cleanup function is called by EVP_CIPHER_CTX_reset() and EVP_CIPHER_CTX_free(). +EVP_CIPHER_meth_set_set_asn1_params() sets the function for B<cipher> +to set the AlgorithmIdentifier "parameter" based on the passed cipher. +This function is called by EVP_CIPHER_param_to_asn1(). +EVP_CIPHER_meth_set_get_asn1_params() sets the function for B<cipher> +that sets the cipher parameters based on an ASN.1 AlgorithmIdentifier +"parameter". +Both these functions are needed when there is a need for custom data +(more or other than the cipher IV). +They are called by EVP_CIPHER_param_to_asn1() and +EVP_CIPHER_asn1_to_param() respectively if defined. + EVP_CIPHER_meth_set_ctrl() sets the control function for B<cipher>. +EVP_CIPHER_meth_get_init(), EVP_CIPHER_meth_get_do_cipher(), +EVP_CIPHER_meth_get_cleanup(), EVP_CIPHER_meth_get_set_asn1_params(), +EVP_CIPHER_meth_get_get_asn1_params() and EVP_CIPHER_meth_get_ctrl() +are all used to retrieve the method data given with the +EVP_CIPHER_meth_set_*() functions above. + =head1 RETURN VALUES -EVP_CIPHER_meth_get_input_blocksize(), EVP_CIPHER_meth_get_result_size(), -EVP_CIPHER_meth_get_app_datasize(), EVP_CIPHER_meth_get_flags(), -EVP_CIPHER_meth_get_init(), EVP_CIPHER_meth_get_update(), -EVP_CIPHER_meth_get_final(), EVP_CIPHER_meth_get_copy(), -EVP_CIPHER_meth_get_cleanup() and EVP_CIPHER_meth_get_ctrl() are all used -to retrieve the method data given with the EVP_CIPHER_meth_set_*() -functions above. +EVP_CIPHER_meth_new() and EVP_CIPHER_meth_dup() return a pointer to a +newly created B<EVP_CIPHER>, or NULL on failure. +All EVP_CIPHER_meth_set_*() functions return 1. +All EVP_CIPHER_meth_get_*() functions return pointers to their +respective B<cipher> function. =head1 SEE ALSO @@ -228,7 +243,7 @@ The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT -Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy diff --git a/doc/crypto/EVP_MD_meth_new.pod b/doc/crypto/EVP_MD_meth_new.pod index e0c36cb008..be36732f7c 100644 --- a/doc/crypto/EVP_MD_meth_new.pod +++ b/doc/crypto/EVP_MD_meth_new.pod @@ -34,7 +34,6 @@ EVP_MD_meth_get_ctrl, EVP_MD_CTX_md_data unsigned char *md)); int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to, const EVP_MD_CTX *from)); - void *EVP_MD_CTX_md_data(const EVP_MD_CTX *ctx); int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx)); int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd, int p1, void *p2)); @@ -140,7 +139,6 @@ EVP_MD_CTX_free(). EVP_MD_meth_set_ctrl() sets the control function for B<md>. - EVP_MD_meth_get_input_blocksize(), EVP_MD_meth_get_result_size(), EVP_MD_meth_get_app_datasize(), EVP_MD_meth_get_flags(), EVP_MD_meth_get_init(), EVP_MD_meth_get_update(), @@ -149,6 +147,17 @@ EVP_MD_meth_get_cleanup() and EVP_MD_meth_get_ctrl() are all used to retrieve the method data given with the EVP_MD_meth_set_*() functions above. +=head1 RETURN VALUES + +EVP_MD_meth_new() and EVP_MD_meth_dup() return a pointer to a newly +created B<EVP_MD>, or NULL on failure. +All EVP_MD_meth_set_*() functions return 1. +EVP_MD_get_input_blocksize(), EVP_MD_meth_get_result_size(), +EVP_MD_meth_get_app_datasize() and EVP_MD_meth_get_flags() return the +indicated sizes or flags. +All other EVP_CIPHER_meth_get_*() functions return pointers to their +respective B<md> function. + =head1 SEE ALSO L<EVP_DigestInit(3)>, L<EVP_SignInit(3)>, L<EVP_VerifyInit(3)> |