$NetBSD: CMS_decrypt.3,v 1.5 2026/04/08 17:06:41 christos Exp $ -*- mode: troff; coding: utf-8 -*- Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) Standard preamble: ========================================================================..
..
..
\*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Required to disable full justification in groff 1.23.0. ======================================================================== Title "CMS_decrypt 3" CMS_decrypt 3 2026-04-07 3.5.6 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
NAME
CMS_decrypt, CMS_decrypt_set1_pkey_and_peer,
CMS_decrypt_set1_pkey, CMS_decrypt_set1_password
\- decrypt content from a CMS envelopedData structure
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <
openssl/
cms.h>
\&
int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert,
BIO *dcont, BIO *out, unsigned int flags);
int CMS_decrypt_set1_pkey_and_peer(CMS_ContentInfo *cms,
EVP_PKEY *pk, X509 *cert, X509 *peer);
int CMS_decrypt_set1_pkey(CMS_ContentInfo *cms, EVP_PKEY *pk, X509 *cert);
int CMS_decrypt_set1_password(CMS_ContentInfo *cms,
unsigned char *pass, ossl_ssize_t passlen);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBCMS_decrypt() extracts the decrypted content from a CMS EnvelopedData
or AuthEnvelopedData structure.
It uses
CMS_decrypt_set1_pkey() to decrypt the content
with the recipient private key
pkey if
pkey is not NULL.
In this case, the associated certificate is recommended to provide in
cert -
see the NOTES below.
\fIout is a BIO to write the content to and
\fIflags is an optional set of flags.
If
pkey is NULL the function assumes that decryption was already done
(e.g., using
CMS_decrypt_set1_pkey() or
CMS_decrypt_set1_password()) and just
provides the content unless
cert,
dcont, and
out are NULL as well.
The
dcont parameter is used in the rare case where the encrypted content
is detached. It will normally be set to NULL.
\fBCMS_decrypt_set1_pkey_and_peer() decrypts the CMS_ContentInfo structure cms
using the private key pkey, the corresponding certificate cert, which is
recommended but may be NULL, and the (optional) originator certificate peer.
On success, it also records in cms the decryption key pkey, and then
should be followed by \*(C`CMS_decrypt(cms, NULL, NULL, dcont, out, flags)\*(C'.
This call deallocates any decryption key stored in cms.
\fBCMS_decrypt_set1_pkey() is the same as
\fBCMS_decrypt_set1_pkey_and_peer() with peer being NULL.
\fBCMS_decrypt_set1_password() decrypts the CMS_ContentInfo structure cms
using the secret pass of length passlen.
On success, it also records in cms the decryption key used, and then
should be followed by \*(C`CMS_decrypt(cms, NULL, NULL, dcont, out, flags)\*(C'.
This call deallocates any decryption key stored in cms.
NOTES
Header "NOTES" Although the recipients certificate is not needed to decrypt the data it is
needed to locate the appropriate (of possible several) recipients in the CMS
structure.
If cert is set to NULL all possible recipients are tried. This case however
is problematic. To thwart the MMA attack (Bleichenbacher\*(Aqs attack on
PKCS #1 v1.5 RSA padding) all recipients are tried whether they succeed or
not. If no recipient succeeds then a random symmetric key is used to decrypt
the content: this will typically output garbage and may (but is not guaranteed
to) ultimately return a padding error only. If CMS_decrypt() just returned an
error when all recipient encrypted keys failed to decrypt an attacker could
use this in a timing attack. If the special flag CMS_DEBUG_DECRYPT is set
then the above behaviour is modified and an error is returned if no
recipient encrypted key can be decrypted without generating a random
content encryption key. Applications should use this flag with
\fBextreme caution especially in automated gateways as it can leave them
open to attack.
It is possible to determine the correct recipient key by other means (for
example looking them up in a database) and setting them in the CMS structure
in advance using the CMS utility functions such as CMS_set1_pkey(),
or use CMS_decrypt_set1_password() if the recipient has a symmetric key.
In these cases both cert and pkey should be set to NULL.
To process KEKRecipientInfo types CMS_set1_key() or CMS_RecipientInfo_set0_key()
and CMS_RecipientInfo_decrypt() should be called before CMS_decrypt() and
\fIcert and pkey set to NULL.
The following flags can be passed in the flags parameter.
If the CMS_TEXT flag is set MIME headers for type \*(C`text/plain\*(C' are deleted
from the content. If the content is not of type \*(C`text/plain\*(C' then an error is
returned.
"RETURN VALUES"
Header "RETURN VALUES" \fBCMS_decrypt(),
CMS_decrypt_set1_pkey_and_peer(),
\fBCMS_decrypt_set1_pkey(), and
CMS_decrypt_set1_password()
return either 1 for success or 0 for failure.
The error can be obtained from
ERR_get_error\|(3).
BUGS
Header "BUGS" The
set1_ part of these function names is misleading
and should better read:
with_.
The lack of single pass processing and the need to hold all data in memory as
mentioned in CMS_verify() also applies to CMS_decrypt().
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3),
CMS_encrypt\|(3)
HISTORY
Header "HISTORY" \fBCMS_decrypt_set1_pkey_and_peer() and
CMS_decrypt_set1_password()
were added in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2008-2020 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
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.