Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

smime_read_pkcs7(3) [osx man page]

SMIME_read_PKCS7(3)						      OpenSSL						       SMIME_read_PKCS7(3)

NAME
SMIME_read_PKCS7 - parse S/MIME message. SYNOPSIS
#include <openssl/pkcs7.h> PKCS7 *SMIME_read_PKCS7(BIO *in, BIO **bcont); DESCRIPTION
SMIME_read_PKCS7() 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 PKCS#7 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 PKCS7_verify() with the PKCS7_DETACHED flag set. Otherwise the type of the returned structure can be determined using PKCS7_type(). To support future functionality if bcont is not NULL *bcont should be initialized to NULL. For example: BIO *cont = NULL; PKCS7 *p7; p7 = SMIME_read_PKCS7(in, &cont); BUGS
The MIME parser used by SMIME_read_PKCS7() is somewhat primitive. While it will handle most S/MIME messages more complex compound formats may not work. The parser assumes that the PKCS7 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_PKCS7() returns a valid PKCS7 structure or NULL is an error occurred. The error can be obtained from ERR_get_error(3). SEE ALSO
ERR_get_error(3), PKCS7_type(3) SMIME_read_PKCS7(3), PKCS7_sign(3), PKCS7_verify(3), PKCS7_encrypt(3) PKCS7_decrypt(3) HISTORY
SMIME_read_PKCS7() was added to OpenSSL 0.9.5 50 2013-03-05 SMIME_read_PKCS7(3)

Check Out this Related Man Page

SMIME_write_PKCS7(3SSL) 					      OpenSSL						   SMIME_write_PKCS7(3SSL)

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.0e 2007-04-13 SMIME_write_PKCS7(3SSL)
Man Page