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/man7/provider-cipher.pod | |
| 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/man7/provider-cipher.pod')
| -rw-r--r-- | doc/man7/provider-cipher.pod | 16 |
1 files changed, 8 insertions, 8 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 |