diff options
author | Richard Levitte <levitte@openssl.org> | 2019-08-16 09:04:29 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-08-16 09:04:29 +0200 |
commit | 92d9d0ae2b10b12e42d33047b60e64ebfc296596 (patch) | |
tree | 36268ad8d147f30bb179cb089449beb39271b8d3 /doc | |
parent | 356461fbbb8f4070f57ac4d13b34e0e0bbfee92b (diff) |
Rename ctx_{get,set}_params to {get,set}_ctx_params
Recently, we added dispatched functions to get parameter descriptions,
and those for operation context parameters ended up being called
something_gettable_ctx_params and something_settable_ctx_params.
The corresponding dispatched functions to actually perform parameter
transfers were previously called something_ctx_get_params and
something_ctx_set_params, which doesn't quite match, so we rename them
to something_get_ctx_params and something_set_ctx_params.
An argument in favor of this name change is English, where you'd
rather say something like "set the context parameters".
This only change the libcrypto <-> provider interface.
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9612)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man7/provider-cipher.pod | 16 | ||||
-rw-r--r-- | doc/man7/provider-digest.pod | 18 | ||||
-rw-r--r-- | doc/man7/provider-mac.pod | 20 |
3 files changed, 27 insertions, 27 deletions
diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod index 33e0a4f004..87ab3d844d 100644 --- a/doc/man7/provider-cipher.pod +++ b/doc/man7/provider-cipher.pod @@ -47,8 +47,8 @@ provider-cipher - The cipher library E<lt>-E<gt> provider functions int OP_cipher_get_params(OSSL_PARAM params[]); /* Cipher operation parameters */ - int OP_cipher_ctx_get_params(void *cctx, OSSL_PARAM params[]); - int OP_cipher_ctx_set_params(void *cctx, const OSSL_PARAM params[]); + int OP_cipher_get_ctx_params(void *cctx, OSSL_PARAM params[]); + int OP_cipher_set_ctx_params(void *cctx, const OSSL_PARAM params[]); =head1 DESCRIPTION @@ -90,8 +90,8 @@ macros in L<openssl-core_numbers.h(7)>, as follows: OP_cipher_cipher OSSL_FUNC_CIPHER_CIPHER OP_cipher_get_params OSSL_FUNC_CIPHER_GET_PARAMS - OP_cipher_ctx_get_params OSSL_FUNC_CIPHER_CTX_GET_PARAMS - OP_cipher_ctx_set_params OSSL_FUNC_CIPHER_CTX_SET_PARAMS + OP_cipher_get_ctx_params OSSL_FUNC_CIPHER_GET_CTX_PARAMS + OP_cipher_set_ctx_params OSSL_FUNC_CIPHER_SET_CTX_PARAMS OP_cipher_gettable_params OSSL_FUNC_CIPHER_GETTABLE_PARAMS OP_cipher_gettable_ctx_params OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS @@ -179,17 +179,17 @@ these functions. OP_cipher_get_params() gets details of the algorithm implementation and stores them in B<params>. -OP_cipher_ctx_set_params() sets cipher operation parameters for the +OP_cipher_set_ctx_params() sets cipher operation parameters for the provider side cipher context B<cctx> to B<params>. Any parameter settings are additional to any that were previously set. -OP_cipher_ctx_get_params() gets cipher operation details details from +OP_cipher_get_ctx_params() gets cipher operation details details from the given provider side cipher context B<cctx> and stores them in B<params>. OP_cipher_gettable_params(), OP_cipher_gettable_ctx_params(), and OP_cipher_settable_ctx_params() all return constant B<OSSL_PARAM> arrays as descriptors of the parameters that OP_cipher_get_params(), -OP_cipher_ctx_get_params(), and OP_cipher_ctx_set_params() can handle, +OP_cipher_get_ctx_params(), and OP_cipher_set_ctx_params() can handle, respectively. Parameters currently recognised by built-in ciphers are as follows. Not all @@ -311,7 +311,7 @@ provider side cipher context, or NULL on failure. OP_cipher_encrypt_init(), OP_cipher_decrypt_init(), OP_cipher_update(), OP_cipher_final(), OP_cipher_cipher(), OP_cipher_get_params(), -OP_cipher_ctx_get_params() and OP_cipher_ctx_set_params() should return 1 for +OP_cipher_get_ctx_params() and OP_cipher_set_ctx_params() should return 1 for success or 0 on error. =head1 SEE ALSO diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod index 1b71cc19f9..a00e9833b8 100644 --- a/doc/man7/provider-digest.pod +++ b/doc/man7/provider-digest.pod @@ -41,8 +41,8 @@ provider-digest - The digest library E<lt>-E<gt> provider functions int OP_digest_get_params(OSSL_PARAM params[]); /* Digest operation parameters */ - int OP_digest_ctx_set_params(void *dctx, const OSSL_PARAM params[]); - int OP_digest_ctx_get_params(void *dctx, OSSL_PARAM params[]); + int OP_digest_set_ctx_params(void *dctx, const OSSL_PARAM params[]); + int OP_digest_get_ctx_params(void *dctx, OSSL_PARAM params[]); =head1 DESCRIPTION @@ -82,8 +82,8 @@ macros in L<openssl-core_numbers.h(7)>, as follows: OP_digest_digest OSSL_FUNC_DIGEST_DIGEST OP_digest_get_params OSSL_FUNC_DIGEST_GET_PARAMS - OP_digest_ctx_get_params OSSL_FUNC_DIGEST_CTX_GET_PARAMS - OP_digest_ctx_set_params OSSL_FUNC_DIGEST_CTX_SET_PARAMS + OP_digest_get_ctx_params OSSL_FUNC_DIGEST_GET_CTX_PARAMS + OP_digest_set_ctx_params OSSL_FUNC_DIGEST_SET_CTX_PARAMS OP_digest_gettable_params OSSL_FUNC_DIGEST_GETTABLE_PARAMS OP_digest_gettable_ctx_params OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS @@ -146,17 +146,17 @@ these functions. OP_digest_get_params() gets details of the algorithm implementation and stores them in B<params>. -OP_digest_ctx_set_params() sets digest operation parameters for the +OP_digest_set_ctx_params() sets digest operation parameters for the provider side digest context B<dctx> to B<params>. Any parameter settings are additional to any that were previously set. -OP_digest_ctx_get_params() gets digest operation details details from +OP_digest_get_ctx_params() gets digest operation details details from the given provider side digest context B<dctx> and stores them in B<params>. OP_digest_gettable_params(), OP_digest_gettable_ctx_params(), and OP_digest_settable_ctx_params() all return constant B<OSSL_PARAM> arrays as descriptors of the parameters that OP_digest_get_params(), -OP_digest_ctx_get_params(), and OP_digest_ctx_set_params() can handle, +OP_digest_get_ctx_params(), and OP_digest_set_ctx_params() can handle, respectively. Parameters currently recognised by built-in digests with this function @@ -213,12 +213,12 @@ Currently unused. =head2 Digest Context Parameters -OP_digest_ctx_set_params() sets digest parameters associated with the +OP_digest_set_ctx_params() sets digest parameters associated with the given provider side digest context B<dctx> to B<params>. Any parameter settings are additional to any that were previously set. See L<OSSL_PARAM(3)> for further details on the parameters structure. -OP_digest_ctx_get_params() gets details of currently set parameters +OP_digest_get_ctx_params() gets details of currently set parameters values associated with the give provider side digest context B<dctx> and stores them in B<params>. See L<OSSL_PARAM(3)> for further details on the parameters structure. diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod index 65aa0124e5..455231172f 100644 --- a/doc/man7/provider-mac.pod +++ b/doc/man7/provider-mac.pod @@ -29,13 +29,13 @@ provider-mac - The mac library E<lt>-E<gt> provider functions /* MAC parameter descriptors */ const OSSL_PARAM *OP_mac_get_params(void); - const OSSL_PARAM *OP_mac_ctx_get_params(void); - const OSSL_PARAM *OP_mac_ctx_set_params(void); + const OSSL_PARAM *OP_mac_get_ctx_params(void); + const OSSL_PARAM *OP_mac_set_ctx_params(void); /* MAC parameters */ int OP_mac_get_params(OSSL_PARAM params[]); - int OP_mac_ctx_get_params(void *mctx, OSSL_PARAM params[]); - int OP_mac_ctx_set_params(void *mctx, const OSSL_PARAM params[]); + int OP_mac_get_ctx_params(void *mctx, OSSL_PARAM params[]); + int OP_mac_set_ctx_params(void *mctx, const OSSL_PARAM params[]); =head1 DESCRIPTION @@ -74,8 +74,8 @@ macros in L<openssl-core_numbers.h(7)>, as follows: OP_mac_final OSSL_FUNC_MAC_FINAL OP_mac_get_params OSSL_FUNC_MAC_GET_PARAMS - OP_mac_ctx_get_params OSSL_FUNC_MAC_CTX_GET_PARAMS - OP_mac_ctx_set_params OSSL_FUNC_MAC_CTX_SET_PARAMS + OP_mac_get_ctx_params OSSL_FUNC_MAC_GET_CTX_PARAMS + OP_mac_set_ctx_params OSSL_FUNC_MAC_SET_CTX_PARAMS OP_mac_gettable_params OSSL_FUNC_MAC_GETTABLE_PARAMS OP_mac_gettable_ctx_params OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS @@ -132,18 +132,18 @@ these functions. OP_mac_get_params() gets details of parameter values associated with the provider algorithm and stores them in I<params>. -OP_mac_ctx_set_params() sets mac parameters associated with the given +OP_mac_set_ctx_params() sets mac parameters associated with the given provider side mac context I<mctx> to I<params>. Any parameter settings are additional to any that were previously set. -OP_mac_ctx_get_params() gets details of currently set parameter values +OP_mac_get_ctx_params() gets details of currently set parameter values associated with the given provider side mac context I<mctx> and stores them in I<params>. OP_mac_gettable_params(), OP_mac_gettable_ctx_params(), and OP_mac_settable_ctx_params() all return constant B<OSSL_PARAM> arrays as descriptors of the parameters that OP_mac_get_params(), -OP_mac_ctx_get_params(), and OP_mac_ctx_set_params() can handle, +OP_mac_get_ctx_params(), and OP_mac_set_ctx_params() can handle, respectively. Parameters currently recognised by built-in macs are as follows. Not all @@ -228,7 +228,7 @@ OP_mac_newctx() and OP_mac_dupctx() should return the newly created provider side mac context, or NULL on failure. OP_mac_init(), OP_mac_update(), OP_mac_final(), OP_mac_get_params(), -OP_mac_ctx_get_params() and OP_mac_ctx_set_params() should return 1 for +OP_mac_get_ctx_params() and OP_mac_set_ctx_params() should return 1 for success or 0 on error. OP_mac_gettable_params(), OP_mac_gettable_ctx_params() and |