Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

EVP_OpenInit (3openssl)

Name

EVP_OpenInit - EVP envelope decryption

Synopsis

#include <openssl/evp.h>

int EVP_OpenInit(EVP_CIPHER_CTX *ctx,EVP_CIPHER *type,unsigned char *ek,
int ekl,unsigned char *iv,EVP_PKEY *priv);
int EVP_OpenUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
int *outl, unsigned char *in, int inl);
int EVP_OpenFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
int *outl);

Description

EVP_OpenInit(3openssl)              OpenSSL             EVP_OpenInit(3openssl)



NAME
       EVP_OpenInit, EVP_OpenUpdate, EVP_OpenFinal - EVP envelope decryption

SYNOPSIS
        #include <openssl/evp.h>

        int EVP_OpenInit(EVP_CIPHER_CTX *ctx,EVP_CIPHER *type,unsigned char *ek,
                       int ekl,unsigned char *iv,EVP_PKEY *priv);
        int EVP_OpenUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
                int *outl, unsigned char *in, int inl);
        int EVP_OpenFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
                int *outl);

DESCRIPTION
       The EVP envelope routines are a high level interface to envelope
       decryption. They decrypt a public key encrypted symmetric key and then
       decrypt data using it.

       EVP_OpenInit() initializes a cipher context ctx for decryption with
       cipher type. It decrypts the encrypted symmetric key of length ekl
       bytes passed in the ek parameter using the private key priv.  The IV is
       supplied in the iv parameter.

       EVP_OpenUpdate() and EVP_OpenFinal() have exactly the same properties
       as the EVP_DecryptUpdate() and EVP_DecryptFinal() routines, as
       documented on the EVP_EncryptInit(3) manual page.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

NOTES
       It is possible to call EVP_OpenInit() twice in the same way as
       EVP_DecryptInit(). The first call should have priv set to NULL and
       (after setting any cipher parameters) it should be called again with
       type set to NULL.

       If the cipher passed in the type parameter is a variable length cipher
       then the key length will be set to the value of the recovered key
       length. If the cipher is a fixed length cipher then the recovered key
       length must match the fixed cipher length.

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.

RETURN VALUES
       EVP_OpenInit() returns 0 on error or a non zero integer (actually the
       recovered secret key size) if successful.

       EVP_OpenUpdate() returns 1 for success or 0 for failure.

       EVP_OpenFinal() returns 0 if the decrypt failed or 1 for success.

SEE ALSO
       evp(3), rand(3), EVP_EncryptInit(3), EVP_SealInit(3)

HISTORY
1.0.2ze                           2022-05-03            EVP_OpenInit(3openssl)