doc/man3/CMS_encrypt.pod

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