doc/man3/CMS_encrypt.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 CMS_encrypt_with_libctx, CMS_encrypt - create a CMS envelopedData structure
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/cms.h>
  10
  11  CMS_ContentInfo *CMS_encrypt_with_libctx(STACK_OF(X509) *certs,
  12                                           BIO *in, const EVP_CIPHER *cipher,
  13                                           unsigned int flags,
  14                                           OPENSSL_CTX *libctx,
  15                                           const char *propq);
  16  CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in,
  17                               const EVP_CIPHER *cipher, unsigned int flags);
  18
  19 =head1 DESCRIPTION
  20
  21 CMS_encrypt_with_libctx() creates and returns a CMS EnvelopedData or
  22 AuthEnvelopedData structure. I<certs> is a list of recipient certificates.
  23 I<in> is the content to be encrypted. I<cipher> is the symmetric cipher to use.
  24 I<flags> is an optional set of flags. The library context I<libctx> and the
  25 property query I<propq> are used internally when retrieving algorithms from
  26 providers.
  27
  28 Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this
  29 function.
  30
  31 EVP_des_ede3_cbc() (triple DES) is the algorithm of choice for S/MIME use
  32 because most clients will support it.
  33
  34 The algorithm passed in the B<cipher> parameter must support ASN1 encoding of
  35 its parameters. If the cipher mode is GCM, then an AuthEnvelopedData structure
  36 containing MAC is used. Otherwise an EnvelopedData structure is used. Currently
  37 the AES variants with GCM mode are the only supported AEAD algorithms.
  38
  39 Many browsers implement a "sign and encrypt" option which is simply an S/MIME
  40 envelopedData containing an S/MIME signed message. This can be readily produced
  41 by storing the S/MIME signed message in a memory BIO and passing it to
  42 CMS_encrypt().
  43
  44 The following flags can be passed in the B<flags> parameter.
  45
  46 If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are
  47 prepended to the data.
  48
  49 Normally the supplied content is translated into MIME canonical format (as
  50 required by the S/MIME specifications) if B<CMS_BINARY> is set no translation
  51 occurs. This option should be used if the supplied data is in binary format
  52 otherwise the translation will corrupt it. If B<CMS_BINARY> is set then
  53 B<CMS_TEXT> is ignored.
  54
  55 OpenSSL will by default identify recipient certificates using issuer name
  56 and serial number. If B<CMS_USE_KEYID> is set it will use the subject key
  57 identifier value instead. An error occurs if all recipient certificates do not
  58 have a subject key identifier extension.
  59
  60 If the B<CMS_STREAM> flag is set a partial B<CMS_ContentInfo> structure is
  61 returned suitable for streaming I/O: no data is read from the BIO B<in>.
  62
  63 If the B<CMS_PARTIAL> flag is set a partial B<CMS_ContentInfo> structure is
  64 returned to which additional recipients and attributes can be added before
  65 finalization.
  66
  67 The data being encrypted is included in the CMS_ContentInfo structure, unless
  68 B<CMS_DETACHED> is set in which case it is omitted. This is rarely used in
  69 practice and is not supported by SMIME_write_CMS().
  70
  71 If the flag B<CMS_STREAM> is set the returned B<CMS_ContentInfo> structure is
  72 B<not> complete and outputting its contents via a function that does not
  73 properly finalize the B<CMS_ContentInfo> structure will give unpredictable
  74 results.
  75
  76 Several functions including SMIME_write_CMS(), i2d_CMS_bio_stream(),
  77 PEM_write_bio_CMS_stream() finalize the structure. Alternatively finalization
  78 can be performed by obtaining the streaming ASN1 B<BIO> directly using
  79 BIO_new_CMS().
  80
  81 The recipients specified in B<certs> use a CMS KeyTransRecipientInfo info
  82 structure. KEKRecipientInfo is also supported using the flag B<CMS_PARTIAL>
  83 and CMS_add0_recipient_key().
  84
  85 The parameter B<certs> may be NULL if B<CMS_PARTIAL> is set and recipients
  86 added later using CMS_add1_recipient_cert() or CMS_add0_recipient_key().
  87
  88 CMS_encrypt() is similar to CMS_encrypt_with_libctx() but uses default values
  89 of NULL for the library context I<libctx> and the property query I<propq>.
  90
  91 =head1 RETURN VALUES
  92
  93 CMS_encrypt_with_libctx() and CMS_encrypt() return either a CMS_ContentInfo
  94 structure or NULL if an error occurred. The error can be obtained from
  95 ERR_get_error(3).
  96
  97 =head1 SEE ALSO
  98
  99 L<ERR_get_error(3)>, L<CMS_decrypt(3)>
 100
 101 =head1 HISTORY
 102
 103 The function CMS_encrypt_with_libctx() was added in OpenSSL 3.0.
 104
 105 The B<CMS_STREAM> flag was first supported in OpenSSL 1.0.0.
 106
 107 =head1 COPYRIGHT
 108
 109 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
 110
 111 Licensed under the Apache License 2.0 (the "License").  You may not use
 112 this file except in compliance with the License.  You can obtain a copy
 113 in the file LICENSE in the source distribution or at
 114 L<https://www.openssl.org/source/license.html>.
 115
 116 =cut