doc/man3/PKCS7_encrypt.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 PKCS7_encrypt - create a PKCS#7 envelopedData structure
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/pkcs7.h>
  10
  11  PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher,
  12                       int flags);
  13
  14 =head1 DESCRIPTION
  15
  16 PKCS7_encrypt() creates and returns a PKCS#7 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 Only RSA keys are supported in PKCS#7 and envelopedData so the recipient
  21 certificates supplied to this function must all contain RSA public keys, though
  22 they do not have to be signed using the RSA algorithm.
  23
  24 EVP_des_ede3_cbc() (triple DES) is the algorithm of choice for S/MIME use
  25 because most clients will support it.
  26
  27 Some old "export grade" clients may only support weak encryption using 40 or 64
  28 bit RC2. These can be used by passing EVP_rc2_40_cbc() and EVP_rc2_64_cbc()
  29 respectively.
  30
  31 The algorithm passed in the B<cipher> parameter must support ASN1 encoding of
  32 its parameters.
  33
  34 Many browsers implement a "sign and encrypt" option which is simply an S/MIME
  35 envelopedData containing an S/MIME signed message. This can be readily produced
  36 by storing the S/MIME signed message in a memory BIO and passing it to
  37 PKCS7_encrypt().
  38
  39 The following flags can be passed in the B<flags> parameter.
  40
  41 If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> are
  42 prepended to the data.
  43
  44 Normally the supplied content is translated into MIME canonical format (as
  45 required by the S/MIME specifications) if B<PKCS7_BINARY> is set no translation
  46 occurs. This option should be used if the supplied data is in binary format
  47 otherwise the translation will corrupt it. If B<PKCS7_BINARY> is set then
  48 B<PKCS7_TEXT> is ignored.
  49
  50 If the B<PKCS7_STREAM> flag is set a partial B<PKCS7> structure is output
  51 suitable for streaming I/O: no data is read from the BIO B<in>.
  52
  53 If the flag B<PKCS7_STREAM> is set the returned B<PKCS7> structure is B<not>
  54 complete and outputting its contents via a function that does not
  55 properly finalize the B<PKCS7> structure will give unpredictable
  56 results.
  57
  58 Several functions including SMIME_write_PKCS7(), i2d_PKCS7_bio_stream(),
  59 PEM_write_bio_PKCS7_stream() finalize the structure. Alternatively finalization
  60 can be performed by obtaining the streaming ASN1 B<BIO> directly using
  61 BIO_new_PKCS7().
  62
  63 =head1 RETURN VALUES
  64
  65 PKCS7_encrypt() returns either a PKCS7 structure or NULL if an error occurred.
  66 The error can be obtained from ERR_get_error(3).
  67
  68 =head1 SEE ALSO
  69
  70 L<ERR_get_error(3)>, L<PKCS7_decrypt(3)>
  71
  72 =head1 HISTORY
  73
  74 The B<PKCS7_STREAM> flag was added in OpenSSL 1.0.0.
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
  79
  80 Licensed under the Apache License 2.0 (the "License").  You may not use
  81 this file except in compliance with the License.  You can obtain a copy
  82 in the file LICENSE in the source distribution or at
  83 L<https://www.openssl.org/source/license.html>.
  84
  85 =cut