From 8ea34a6efa0cfe61abc413525be5b8aaee5f603f Mon Sep 17 00:00:00 2001 From: Pauli Date: Tue, 2 Mar 2021 22:41:58 +1000 Subject: [PATCH] doc: document param argument to cipher init calls Reviewed-by: Shane Lontis (Merged from https://github.com/openssl/openssl/pull/14383) --- doc/man3/EVP_PKEY_decrypt.pod | 15 +++++++++++---- doc/man3/EVP_PKEY_encrypt.pod | 16 ++++++++++++---- 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/doc/man3/EVP_PKEY_decrypt.pod b/doc/man3/EVP_PKEY_decrypt.pod index f516489df4e..0528663d679 100644 --- a/doc/man3/EVP_PKEY_decrypt.pod +++ b/doc/man3/EVP_PKEY_decrypt.pod @@ -10,6 +10,7 @@ EVP_PKEY_decrypt - decrypt using a public key algorithm #include int EVP_PKEY_decrypt_init(EVP_PKEY_CTX *ctx); + int EVP_PKEY_decrypt_init_ex(EVP_PKEY_CTX *ctx, const OSSL_PARAM params[]); int EVP_PKEY_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char *in, size_t inlen); @@ -19,6 +20,10 @@ EVP_PKEY_decrypt - decrypt using a public key algorithm The EVP_PKEY_decrypt_init() function initializes a public key algorithm context using key B for a decryption operation. +The EVP_PKEY_decrypt_init_ex() function initializes a public key algorithm +context using key B for a decryption operation and sets the +algorithm specific B. + The EVP_PKEY_decrypt() function performs a public key decryption operation using B. The data to be decrypted is specified using the B and B parameters. If B is B then the maximum size of the output @@ -31,16 +36,18 @@ B and the amount of data written to B. After the call to EVP_PKEY_decrypt_init() algorithm specific control operations can be performed to set any appropriate parameters for the -operation. +operation. These operations can be included in the EVP_PKEY_decrypt_init_ex() +call. The function EVP_PKEY_decrypt() can be called more than once on the same context if several operations are performed using the same parameters. =head1 RETURN VALUES -EVP_PKEY_decrypt_init() and EVP_PKEY_decrypt() return 1 for success and 0 -or a negative value for failure. In particular a return value of -2 -indicates the operation is not supported by the public key algorithm. +EVP_PKEY_decrypt_init(), EVP_PKEY_decrypt_init_ex() and EVP_PKEY_decrypt() +return 1 for success and 0 or a negative value for failure. In particular a +return value of -2 indicates the operation is not supported by the public key +algorithm. =head1 EXAMPLES diff --git a/doc/man3/EVP_PKEY_encrypt.pod b/doc/man3/EVP_PKEY_encrypt.pod index 73ca8bae3e3..5a8fe0ece79 100644 --- a/doc/man3/EVP_PKEY_encrypt.pod +++ b/doc/man3/EVP_PKEY_encrypt.pod @@ -2,6 +2,7 @@ =head1 NAME +EVP_PKEY_encrypt_init_ex, EVP_PKEY_encrypt_init, EVP_PKEY_encrypt - encrypt using a public key algorithm =head1 SYNOPSIS @@ -9,6 +10,7 @@ EVP_PKEY_encrypt_init, EVP_PKEY_encrypt - encrypt using a public key algorithm #include int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx); + int EVP_PKEY_encrypt_init_ex(EVP_PKEY_CTX *ctx, const OSSL_PARAM params[]); int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char *in, size_t inlen); @@ -18,6 +20,10 @@ EVP_PKEY_encrypt_init, EVP_PKEY_encrypt - encrypt using a public key algorithm The EVP_PKEY_encrypt_init() function initializes a public key algorithm context using key B for an encryption operation. +The EVP_PKEY_encrypt_init_ex() function initializes a public key algorithm +context using key B for an encryption operation and sets the +algorithm specific B. + The EVP_PKEY_encrypt() function performs a public key encryption operation using B. The data to be encrypted is specified using the B and B parameters. If B is B then the maximum size of the output @@ -30,16 +36,18 @@ B and the amount of data written to B. After the call to EVP_PKEY_encrypt_init() algorithm specific control operations can be performed to set any appropriate parameters for the -operation. +operation. These operations can be included in the EVP_PKEY_encrypt_init_ex() +call. The function EVP_PKEY_encrypt() can be called more than once on the same context if several operations are performed using the same parameters. =head1 RETURN VALUES -EVP_PKEY_encrypt_init() and EVP_PKEY_encrypt() return 1 for success and 0 -or a negative value for failure. In particular a return value of -2 -indicates the operation is not supported by the public key algorithm. +EVP_PKEY_encrypt_init(), EVP_PKEY_encrypt_init_ex() and EVP_PKEY_encrypt() +return 1 for success and 0 or a negative value for failure. In particular a +return value of -2 indicates the operation is not supported by the public key +algorithm. =head1 EXAMPLES -- 2.47.3