smime_read_cms(3ssl) [debian man page]

SMIME_read_CMS(3SSL)						      OpenSSL						      SMIME_read_CMS(3SSL)

NAME

	SMIME_read_CMS - parse S/MIME message.

SYNOPSIS

	#include <openssl/cms.h>

	CMS_ContentInfo *SMIME_read_CMS(BIO *in, BIO **bcont);

DESCRIPTION

       SMIME_read_CMS() parses a message in S/MIME format.

       in is a BIO to read the message from.

       If cleartext signing is used then the content is saved in a memory bio which is written to *bcont, otherwise *bcont is set to NULL.

       The parsed CMS_ContentInfo structure is returned or NULL if an error occurred.

NOTES

       If *bcont is not NULL then the message is clear text signed. *bcont can then be passed to CMS_verify() with the CMS_DETACHED flag set.

       Otherwise the type of the returned structure can be determined using CMS_get0_type().

       To support future functionality if bcont is not NULL *bcont should be initialized to NULL. For example:

	BIO *cont = NULL;
	CMS_ContentInfo *cms;

	cms = SMIME_read_CMS(in, &cont);

BUGS

       The MIME parser used by SMIME_read_CMS() is somewhat primitive.	While it will handle most S/MIME messages more complex compound formats
       may not work.

       The parser assumes that the CMS_ContentInfo structure is always base64 encoded and will not handle the case where it is in binary format or
       uses quoted printable format.

       The use of a memory BIO to hold the signed content limits the size of message which can be processed due to memory restraints: a streaming
       single pass option should be available.

RETURN VALUES

       SMIME_read_CMS() returns a valid CMS_ContentInfo structure or NULL if an error occurred. The error can be obtained from ERR_get_error(3).

SEE ALSO

       ERR_get_error(3), CMS_type(3) SMIME_read_CMS(3), CMS_sign(3), CMS_verify(3), CMS_encrypt(3) CMS_decrypt(3)

HISTORY

       SMIME_read_CMS() was added to OpenSSL 0.9.8

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

SMIME_write_CMS(3SSL)						      OpenSSL						     SMIME_write_CMS(3SSL)

NAME

	SMIME_write_CMS - convert CMS structure to S/MIME format.

SYNOPSIS

	#include <openssl/cms.h>

	int SMIME_write_CMS(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags);

DESCRIPTION

       SMIME_write_CMS() adds the appropriate MIME headers to a CMS structure to produce an S/MIME message.

       out is the BIO to write the data to. cms is the appropriate CMS_ContentInfo 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 CMS_DETACHED is set then cleartext signing will be used, this option only makes sense for SignedData where CMS_DETACHED is also set when
       CMS_sign() is called.

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

       If the CMS_STREAM flag is set streaming is performed. This flag should only be set if CMS_STREAM was also set in the previous call to a
       CMS_ContentInfo creation function.

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

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

BUGS

       SMIME_write_CMS() always base64 encodes CMS structures, there should be an option to disable this.

RETURN VALUES

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

SEE ALSO

       ERR_get_error(3), CMS_sign(3), CMS_verify(3), CMS_encrypt(3) CMS_decrypt(3)

HISTORY

       SMIME_write_CMS() was added to OpenSSL 0.9.8

1.0.0e								    2008-04-10						     SMIME_write_CMS(3SSL)