diff options
| author | Pauli <ppzgs1@gmail.com> | 2021-02-23 11:49:20 +1000 |
|---|---|---|
| committer | Pauli <ppzgs1@gmail.com> | 2021-02-26 18:08:41 +1000 |
| commit | fe20a66ed4f911f641af4123f931319677b1e8b7 (patch) | |
| tree | f7ca704d1288ee52021b46f9d8a3c1bc87982a6f /doc/man3/EVP_EncryptInit.pod | |
| parent | 292b4184d6fda8e0c5c62c22170e8ad464a1a3a7 (diff) | |
| download | openssl-fe20a66ed4f911f641af4123f931319677b1e8b7.tar.gz | |
changes to match the updated context gettable/settable calls for ciphers
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14240)
Diffstat (limited to 'doc/man3/EVP_EncryptInit.pod')
| -rw-r--r-- | doc/man3/EVP_EncryptInit.pod | 39 |
1 files changed, 31 insertions, 8 deletions
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod index 7cc9cebb51..63b416289b 100644 --- a/doc/man3/EVP_EncryptInit.pod +++ b/doc/man3/EVP_EncryptInit.pod @@ -48,8 +48,10 @@ EVP_CIPHER_CTX_name, EVP_CIPHER_CTX_nid, EVP_CIPHER_CTX_get_params, EVP_CIPHER_gettable_ctx_params, +EVP_CIPHER_CTX_gettable_params, EVP_CIPHER_CTX_set_params, EVP_CIPHER_settable_ctx_params, +EVP_CIPHER_CTX_settable_params, EVP_CIPHER_CTX_block_size, EVP_CIPHER_CTX_key_length, EVP_CIPHER_CTX_iv_length, @@ -147,6 +149,8 @@ EVP_CIPHER_do_all_provided const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher); const OSSL_PARAM *EVP_CIPHER_settable_ctx_params(const EVP_CIPHER *cipher); const OSSL_PARAM *EVP_CIPHER_gettable_ctx_params(const EVP_CIPHER *cipher); + const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(EVP_CIPHER_CTX *ctx); + const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(EVP_CIPHER_CTX *ctx); int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx); int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx); int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx); @@ -302,12 +306,28 @@ context B<ctx>. EVP_CIPHER_CTX_get_params() retrieves the requested list of operation B<params> from CIPHER context B<ctx>. -EVP_CIPHER_gettable_params(), EVP_CIPHER_gettable_ctx_params(), and -EVP_CIPHER_settable_ctx_params() get a constant B<OSSL_PARAM> array -that describes the retrievable and settable parameters, i.e. parameters -that can be used with EVP_CIPHER_get_params(), EVP_CIPHER_CTX_get_params() -and EVP_CIPHER_CTX_set_params(), respectively. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor. +EVP_CIPHER_gettable_params() returns an B<OSSL_PARAM> array that describes +the retrievable and settable parameters. EVP_CIPHER_gettable_params() +returns parameters that can be used with EVP_CIPHER_get_params(). See +L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. + +EVP_CIPHER_gettable_ctx_params() and EVP_CIPHER_CTX_gettable_params() +return constant B<OSSL_PARAM> arrays that describe the retrievable +parameters that can be used with EVP_CIPHER_CTX_get_params(). +EVP_CIPHER_gettable_ctx_params() returns the parameters that can be +retrieved from the algorithm, whereas EVP_CIPHER_CTX_gettable_params() +returns the parameters that can be retrieved in the context's current +state. See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter +descriptor. + +EVP_CIPHER_settable_ctx_params() and EVP_CIPHER_CTX_settable_params() +return constant B<OSSL_PARAM> arrays that describe the settable +parameters that can be used with EVP_CIPHER_CTX_set_params(). +EVP_CIPHER_settable_ctx_params() returns the parameters that can be +retrieved from the algorithm, whereas EVP_CIPHER_CTX_settable_params() +returns the parameters that can be retrieved in the context's current +state. See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter +descriptor. EVP_CIPHER_key_length() and EVP_CIPHER_CTX_key_length() return the key length of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX> @@ -884,8 +904,11 @@ disappeared. EVP_CIPHER_CTX_init() remains as an alias for EVP_CIPHER_CTX_reset(). The EVP_CIPHER_fetch(), EVP_CIPHER_free(), EVP_CIPHER_up_ref(), -EVP_CIPHER_CTX_set_params() and EVP_CIPHER_CTX_get_params() functions -were added in 3.0. +EVP_CIPHER_get_params(), EVP_CIPHER_CTX_set_params(), +EVP_CIPHER_CTX_get_params(), EVP_CIPHER_gettable_params(), +EVP_CIPHER_settable_ctx_params(), EVP_CIPHER_gettable_ctx_params(), +EVP_CIPHER_CTX_settable_params() and EVP_CIPHER_CTX_gettable_params() +functions were added in 3.0. =head1 COPYRIGHT |