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, int flags, 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 optionally a previously
28 created I<cms> CMS_ContentInfo object can be supplied as well as some I<flags>.
29 To create a I<cms> object use L<CMS_ContentInfo_new_ex(3)>.
30 If the I<flags> argument contains B<CMS_BINARY> then the input is assumed to be
31 in binary format and is not translated to canonical form.
32 If in addition B<SMIME_ASCIICRLF> is set then the binary input is assumed
33 to be followed by B<CR> and B<LF> characters, else only by an B<LF> character.
34 If I<flags> is 0 and I<cms> is NULL then it is identical to SMIME_read_CMS().
38 If B<*bcont> is not NULL then the message is clear text signed. B<*bcont> can
39 then be passed to CMS_verify() with the B<CMS_DETACHED> flag set.
41 Otherwise the type of the returned structure can be determined
42 using CMS_get0_type().
44 To support future functionality if B<bcont> is not NULL B<*bcont> should be
45 initialized to NULL. For example:
50 cms = SMIME_read_CMS(in, &cont);
54 The MIME parser used by SMIME_read_CMS() is somewhat primitive. While it will
55 handle most S/MIME messages more complex compound formats may not work.
57 The parser assumes that the CMS_ContentInfo structure is always base64 encoded
58 and will not handle the case where it is in binary format or uses quoted
61 The use of a memory BIO to hold the signed content limits the size of message
62 which can be processed due to memory restraints: a streaming single pass option
67 SMIME_read_CMS_ex() and SMIME_read_CMS() return a valid B<CMS_ContentInfo>
68 structure or B<NULL> if an error occurred. The error can be obtained from
81 The function SMIME_read_CMS_ex() was added in OpenSSL 3.0.
85 Copyright 2008-2021 The OpenSSL Project Authors. All Rights Reserved.
87 Licensed under the Apache License 2.0 (the "License"). You may not use
88 this file except in compliance with the License. You can obtain a copy
89 in the file LICENSE in the source distribution or at
90 L<https://www.openssl.org/source/license.html>.