5 SMIME_read_CMS_ex, SMIME_read_CMS - parse S/MIME message
9 #include <openssl/cms.h>
11 CMS_ContentInfo *SMIME_read_CMS_ex(BIO *bio, BIO **bcont,
12 CMS_ContentInfo **cms);
13 CMS_ContentInfo *SMIME_read_CMS(BIO *in, BIO **bcont);
17 SMIME_read_CMS() parses a message in S/MIME format.
19 B<in> is a BIO to read the message from.
21 If cleartext signing is used then the content is saved in a memory bio which is
22 written to B<*bcont>, otherwise B<*bcont> is set to NULL.
24 The parsed CMS_ContentInfo structure is returned or NULL if an
27 SMIME_read_CMS_ex() is similar to SMIME_read_CMS() but can optionally supply a
28 previously created I<cms> CMS_ContentInfo object. If I<cms> is NULL then it is
29 identical to SMIME_read_CMS().
30 To create a I<cms> object use L<CMS_ContentInfo_new_with_libctx(3)>.
34 If B<*bcont> is not NULL then the message is clear text signed. B<*bcont> can
35 then be passed to CMS_verify() with the B<CMS_DETACHED> flag set.
37 Otherwise the type of the returned structure can be determined
38 using CMS_get0_type().
40 To support future functionality if B<bcont> is not NULL B<*bcont> should be
41 initialized to NULL. For example:
46 cms = SMIME_read_CMS(in, &cont);
50 The MIME parser used by SMIME_read_CMS() is somewhat primitive. While it will
51 handle most S/MIME messages more complex compound formats may not work.
53 The parser assumes that the CMS_ContentInfo structure is always base64 encoded
54 and will not handle the case where it is in binary format or uses quoted
57 The use of a memory BIO to hold the signed content limits the size of message
58 which can be processed due to memory restraints: a streaming single pass option
63 SMIME_read_CMS_ex() and SMIME_read_CMS() return a valid B<CMS_ContentInfo>
64 structure or B<NULL> if an error occurred. The error can be obtained from
77 The function SMIME_read_CMS_ex() was added in OpenSSL 3.0.
81 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
83 Licensed under the Apache License 2.0 (the "License"). You may not use
84 this file except in compliance with the License. You can obtain a copy
85 in the file LICENSE in the source distribution or at
86 L<https://www.openssl.org/source/license.html>.