summaryrefslogtreecommitdiffstats
path: root/doc/man7/provider-cipher.pod
diff options
context:
space:
mode:
authorPauli <ppzgs1@gmail.com>2021-03-03 11:26:51 +1000
committerPauli <ppzgs1@gmail.com>2021-03-12 08:27:21 +1000
commitf187d4f9f8d69a9d6d9e35e41284bff28649ea13 (patch)
treef387095e71e0357b2a3b3bb6c7edbcf5f11409eb /doc/man7/provider-cipher.pod
parent12ddfa6b3461698543381a6087bd3f5d3a38d3f0 (diff)
doc: document the additional params argument to the various init() calls
Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/14383)
Diffstat (limited to 'doc/man7/provider-cipher.pod')
-rw-r--r--doc/man7/provider-cipher.pod6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod
index 133ee07d67..13ec95568c 100644
--- a/doc/man7/provider-cipher.pod
+++ b/doc/man7/provider-cipher.pod
@@ -25,10 +25,10 @@ provider-cipher - The cipher library E<lt>-E<gt> provider functions
/* Encryption/decryption */
int OSSL_FUNC_cipher_encrypt_init(void *cctx, const unsigned char *key,
size_t keylen, const unsigned char *iv,
- size_t ivlen);
+ size_t ivlen, const OSSL_PARAM params[]);
int OSSL_FUNC_cipher_decrypt_init(void *cctx, const unsigned char *key,
size_t keylen, const unsigned char *iv,
- size_t ivlen);
+ size_t ivlen, const OSSL_PARAM params[]);
int OSSL_FUNC_cipher_update(void *cctx, unsigned char *out, size_t *outl,
size_t outsize, const unsigned char *in, size_t inl);
int OSSL_FUNC_cipher_final(void *cctx, unsigned char *out, size_t *outl,
@@ -129,6 +129,8 @@ OSSL_FUNC_cipher_encrypt_init() initialises a cipher operation for encryption gi
newly created provider side cipher context in the I<cctx> parameter.
The key to be used is given in I<key> which is I<keylen> bytes long.
The IV to be used is given in I<iv> which is I<ivlen> bytes long.
+The I<params>, if not NULL, should be set on the context in a manner similar to
+using OSSL_FUNC_cipher_set_ctx_params().
OSSL_FUNC_cipher_decrypt_init() is the same as OSSL_FUNC_cipher_encrypt_init() except that it
initialises the context for a decryption operation.