]> git.ipfire.org Git - thirdparty/openssl.git/blobdiff - doc/man3/EVP_PKEY_decrypt.pod
Update copyright year
[thirdparty/openssl.git] / doc / man3 / EVP_PKEY_decrypt.pod
index a2363af206626959f9de466375dc4f5c8a02b1ab..e85541ba81f3901685d6097400504d0691259c88 100644 (file)
@@ -2,13 +2,15 @@
 
 =head1 NAME
 
-EVP_PKEY_decrypt_init, EVP_PKEY_decrypt - decrypt using a public key algorithm
+EVP_PKEY_decrypt_init, EVP_PKEY_decrypt_init_ex,
+EVP_PKEY_decrypt - decrypt using a public key algorithm
 
 =head1 SYNOPSIS
 
  #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);
@@ -18,6 +20,10 @@ EVP_PKEY_decrypt_init, 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
@@ -30,18 +36,20 @@ 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 EXAMPLE
+=head1 EXAMPLES
 
 Decrypt data using OAEP (for RSA keys):
 
@@ -95,7 +103,7 @@ These functions were added in OpenSSL 1.0.0.
 
 =head1 COPYRIGHT
 
-Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy