doc/man3/CMS_decrypt.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 CMS_decrypt, CMS_decrypt_set1_pkey_and_peer,
   6 CMS_decrypt_set1_pkey, CMS_decrypt_set1_password
   7 - decrypt content from a CMS envelopedData structure
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/cms.h>
  12
  13  int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert,
  14                  BIO *dcont, BIO *out, unsigned int flags);
  15  int CMS_decrypt_set1_pkey_and_peer(CMS_ContentInfo *cms,
  16                  EVP_PKEY *pk, X509 *cert, X509 *peer);
  17  int CMS_decrypt_set1_pkey(CMS_ContentInfo *cms, EVP_PKEY *pk, X509 *cert);
  18  int CMS_decrypt_set1_password(CMS_ContentInfo *cms,
  19                                unsigned char *pass, ossl_ssize_t passlen);
  20
  21 =head1 DESCRIPTION
  22
  23 CMS_decrypt() extracts and decrypts the content from a CMS EnvelopedData
  24 or AuthEnvelopedData structure. I<pkey> is the private key of the recipient,
  25 I<cert> is the recipient's certificate, I<out> is a BIO to write the content to
  26 and I<flags> is an optional set of flags.
  27
  28 The I<dcont> parameter is used in the rare case where the encrypted content
  29 is detached. It will normally be set to NULL.
  30
  31 CMS_decrypt_set1_pkey_and_peer() associates the private key I<pkey>, the
  32 corresponding certificate I<cert> and the originator certificate I<peer> with
  33 the CMS_ContentInfo structure I<cms>.
  34
  35 CMS_decrypt_set1_pkey() associates the private key I<pkey> and the corresponding
  36 certificate I<cert> with the CMS_ContentInfo structure I<cms>.
  37
  38 CMS_decrypt_set1_password() associates the secret I<pass> of length I<passlen>
  39 with the CMS_ContentInfo structure I<cms>.
  40
  41 =head1 NOTES
  42
  43 Although the recipients certificate is not needed to decrypt the data it is
  44 needed to locate the appropriate (of possible several) recipients in the CMS
  45 structure.
  46
  47 If I<cert> is set to NULL all possible recipients are tried. This case however
  48 is problematic. To thwart the MMA attack (Bleichenbacher's attack on
  49 PKCS #1 v1.5 RSA padding) all recipients are tried whether they succeed or
  50 not. If no recipient succeeds then a random symmetric key is used to decrypt
  51 the content: this will typically output garbage and may (but is not guaranteed
  52 to) ultimately return a padding error only. If CMS_decrypt() just returned an
  53 error when all recipient encrypted keys failed to decrypt an attacker could
  54 use this in a timing attack. If the special flag B<CMS_DEBUG_DECRYPT> is set
  55 then the above behaviour is modified and an error B<is> returned if no
  56 recipient encrypted key can be decrypted B<without> generating a random
  57 content encryption key. Applications should use this flag with
  58 B<extreme caution> especially in automated gateways as it can leave them
  59 open to attack.
  60
  61 It is possible to determine the correct recipient key by other means (for
  62 example looking them up in a database) and setting them in the CMS structure
  63 in advance using the CMS utility functions such as CMS_set1_pkey(). In this
  64 case both I<cert> and I<pkey> should be set to NULL.
  65
  66 To process KEKRecipientInfo types CMS_set1_key() or CMS_RecipientInfo_set0_key()
  67 and CMS_RecipientInfo_decrypt() should be called before CMS_decrypt() and
  68 I<cert> and I<pkey> set to NULL.
  69
  70 The following flags can be passed in the I<flags> parameter.
  71
  72 If the B<CMS_TEXT> flag is set MIME headers for type C<text/plain> are deleted
  73 from the content. If the content is not of type C<text/plain> then an error is
  74 returned.
  75
  76 =head1 RETURN VALUES
  77
  78 CMS_decrypt(), CMS_decrypt_set1_pkey_and_peer(),
  79 CMS_decrypt_set1_pkey(), and CMS_decrypt_set1_password()
  80 return either 1 for success or 0 for failure.
  81 The error can be obtained from ERR_get_error(3).
  82
  83 =head1 BUGS
  84
  85 The lack of single pass processing and the need to hold all data in memory as
  86 mentioned in CMS_verify() also applies to CMS_decrypt().
  87
  88 =head1 SEE ALSO
  89
  90 L<ERR_get_error(3)>, L<CMS_encrypt(3)>
  91
  92 =head1 HISTORY
  93
  94 CMS_decrypt_set1_pkey_and_peer() and CMS_decrypt_set1_password()
  95 were added in OpenSSL 3.0.
  96
  97 =head1 COPYRIGHT
  98
  99 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
 100
 101 Licensed under the Apache License 2.0 (the "License").  You may not use
 102 this file except in compliance with the License.  You can obtain a copy
 103 in the file LICENSE in the source distribution or at
 104 L<https://www.openssl.org/source/license.html>.
 105
 106 =cut