doc: document param argument to cipher init calls

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14383)

diff --git a/doc/man3/EVP_PKEY_decrypt.pod b/doc/man3/EVP_PKEY_decrypt.pod
index f516489df4eef7123e485d02a9348fc0d84a78c8..0528663d67927c2065a10492f0e83db7c6ab8b33 100644 (file)
--- 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 <openssl/evp.h>
 
  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<pkey> for a decryption operation.
 
+The EVP_PKEY_decrypt_init_ex() function initializes a public key algorithm
+context using key B<pkey> for a decryption operation and sets the
+algorithm specific B<params>.
+
 The EVP_PKEY_decrypt() function performs a public key decryption operation
 using B<ctx>. The data to be decrypted is specified using the B<in> and
 B<inlen> parameters. If B<out> is B<NULL> then the maximum size of the output
@@ -31,16 +36,18 @@ B<out> and the amount of data written to B<outlen>.
 
 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 73ca8bae3e3c8063b96506f6864e9a90640e4d6d..5a8fe0ece798b1e12099398e2db44484cd55d185 100644 (file)
--- 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 <openssl/evp.h>
 
  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<pkey> for an encryption operation.
 
+The EVP_PKEY_encrypt_init_ex() function initializes a public key algorithm
+context using key B<pkey> for an encryption operation and sets the
+algorithm specific B<params>.
+
 The EVP_PKEY_encrypt() function performs a public key encryption operation
 using B<ctx>. The data to be encrypted is specified using the B<in> and
 B<inlen> parameters. If B<out> is B<NULL> then the maximum size of the output
@@ -30,16 +36,18 @@ B<out> and the amount of data written to B<outlen>.
 
 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