CMS_EnvelopedData_decrypt

Decrypt a CMS EnvelopedData structure and return a BIO of the plaintext.

Synopsis

Declared in <openssl/cms.h>

BIO*
CMS_EnvelopedData_decrypt(
    CMS_EnvelopedData* env,
    BIO* detached_data,
    EVP_PKEY* pkey,
    X509* cert,
    ASN1_OCTET_STRING* secret,
    unsigned int flags,
    OSSL_LIB_CTX* libctx,
    char const* propq);

Return Value

BIO containing the decrypted content, or NULL on error.

Parameters

NameDescription
envEnvelopedData to decrypt.
detached_dataDetached encrypted-content BIO when applicable; normally NULL.
pkeyRecipient private key when secret is NULL.
certRecipient certificate used to select the RecipientInfo; recommended when pkey is set.
secretPre-shared content-encryption key, or NULL to unwrap with pkey.
flagsOptional CMS decrypt flags (for example CMS_TEXT).
libctxLibrary context for algorithm fetches, or NULL for the default.
propqProperty query for provider selection, or NULL.