smime_write_pkcs7(3) [centos man page]

SMIME_write_PKCS7(3)						      OpenSSL						      SMIME_write_PKCS7(3)

NAME

       SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format.

SYNOPSIS

	#include <openssl/pkcs7.h>

	int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);

DESCRIPTION

       SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7 structure to produce an S/MIME message.

       out is the BIO to write the data to. p7 is the appropriate PKCS7 structure. If streaming is enabled then the content must be supplied in
       the data argument. flags is an optional set of flags.

NOTES

       The following flags can be passed in the flags parameter.

       If PKCS7_DETACHED is set then cleartext signing will be used, this option only makes sense for signedData where PKCS7_DETACHED is also set
       when PKCS7_sign() is also called.

       If the PKCS7_TEXT flag is set MIME headers for type text/plain are added to the content, this only makes sense if PKCS7_DETACHED is also
       set.

       If the PKCS7_STREAM flag is set streaming is performed. This flag should only be set if PKCS7_STREAM was also set in the previous call to
       PKCS7_sign() or PKCS7_encrypt().

       If cleartext signing is being used and PKCS7_STREAM not set then the data must be read twice: once to compute the signature in PKCS7_sign()
       and once to output the S/MIME message.

       If streaming is performed the content is output in BER format using indefinite length constructuted encoding except in the case of signed
       data with detached content where the content is absent and DER format is used.

BUGS

       SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there should be an option to disable this.

RETURN VALUES

       SMIME_write_PKCS7() returns 1 for success or 0 for failure.

SEE ALSO

       ERR_get_error(3), PKCS7_sign(3), PKCS7_verify(3), PKCS7_encrypt(3) PKCS7_decrypt(3)

HISTORY

       SMIME_write_PKCS7() was added to OpenSSL 0.9.5

1.0.1e								    2013-02-11						      SMIME_write_PKCS7(3)

PKCS7_encrypt(3SSL)						      OpenSSL						       PKCS7_encrypt(3SSL)

NAME

       PKCS7_encrypt - create a PKCS#7 envelopedData structure

SYNOPSIS

	#include <openssl/pkcs7.h>

	PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, int flags);

DESCRIPTION

       PKCS7_encrypt() creates and returns a PKCS#7 envelopedData structure. certs is a list of recipient certificates. in is the content to be
       encrypted.  cipher is the symmetric cipher to use. flags is an optional set of flags.

NOTES

       Only RSA keys are supported in PKCS#7 and envelopedData so the recipient certificates supplied to this function must all contain RSA public
       keys, though they do not have to be signed using the RSA algorithm.

       EVP_des_ede3_cbc() (triple DES) is the algorithm of choice for S/MIME use because most clients will support it.

       Some old "export grade" clients may only support weak encryption using 40 or 64 bit RC2. These can be used by passing EVP_rc2_40_cbc() and
       EVP_rc2_64_cbc() respectively.

       The algorithm passed in the cipher parameter must support ASN1 encoding of its parameters.

       Many browsers implement a "sign and encrypt" option which is simply an S/MIME envelopedData containing an S/MIME signed message. This can
       be readily produced by storing the S/MIME signed message in a memory BIO and passing it to PKCS7_encrypt().

       The following flags can be passed in the flags parameter.

       If the PKCS7_TEXT flag is set MIME headers for type text/plain are prepended to the data.

       Normally the supplied content is translated into MIME canonical format (as required by the S/MIME specifications) if PKCS7_BINARY is set no
       translation occurs. This option should be used if the supplied data is in binary format otherwise the translation will corrupt it. If
       PKCS7_BINARY is set then PKCS7_TEXT is ignored.

       If the PKCS7_STREAM flag is set a partial PKCS7 structure is output suitable for streaming I/O: no data is read from the BIO in.

NOTES

       If the flag PKCS7_STREAM is set the returned PKCS7 structure is not complete and outputting its contents via a function that does not
       properly finalize the PKCS7 structure will give unpredictable results.

       Several functions including SMIME_write_PKCS7(), i2d_PKCS7_bio_stream(), PEM_write_bio_PKCS7_stream() finalize the structure. Alternatively
       finalization can be performed by obtaining the streaming ASN1 BIO directly using BIO_new_PKCS7().

RETURN VALUES

       PKCS7_encrypt() returns either a PKCS7 structure or NULL if an error occurred.  The error can be obtained from ERR_get_error(3).

SEE ALSO

       ERR_get_error(3), PKCS7_decrypt(3)

HISTORY

       PKCS7_decrypt() was added to OpenSSL 0.9.5 The PKCS7_STREAM flag was first supported in OpenSSL 1.0.0.

1.0.1e								    2013-02-11						       PKCS7_encrypt(3SSL)