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