1.\" $OpenBSD: PEM_write_bio_CMS_stream.3,v 1.4 2019/11/02 15:39:46 schwarze Exp $
2.\" full merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in
16.\"    the documentation and/or other materials provided with the
17.\"    distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\"    software must display the following acknowledgment:
21.\"    "This product includes software developed by the OpenSSL Project
22.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\"    endorse or promote products derived from this software without
26.\"    prior written permission. For written permission, please contact
27.\"    openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\"    nor may "OpenSSL" appear in their names without prior written
31.\"    permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\"    acknowledgment:
35.\"    "This product includes software developed by the OpenSSL Project
36.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: November 2 2019 $
52.Dt PEM_WRITE_BIO_CMS_STREAM 3
53.Os
54.Sh NAME
55.Nm PEM_write_bio_CMS_stream
56.Nd output CMS_ContentInfo structure in PEM format
57.Sh SYNOPSIS
58.In openssl/cms.h
59.Ft int
60.Fo PEM_write_bio_CMS_stream
61.Fa "BIO *out"
62.Fa "CMS_ContentInfo *cms"
63.Fa "BIO *data"
64.Fa "int flags"
65.Fc
66.Sh DESCRIPTION
67.Fn PEM_write_bio_CMS_stream
68outputs a
69.Vt CMS_ContentInfo
70structure in PEM format.
71.Pp
72It is otherwise identical to the function
73.Xr SMIME_write_CMS 3 .
74.Pp
75This function is effectively a version of
76.Xr PEM_write_bio_CMS 3
77supporting streaming.
78.Sh RETURN VALUES
79.Fn PEM_write_bio_CMS_stream
80returns 1 for success or 0 for failure.
81.Sh SEE ALSO
82.Xr CMS_ContentInfo_new 3 ,
83.Xr CMS_decrypt 3 ,
84.Xr CMS_encrypt 3 ,
85.Xr CMS_sign 3 ,
86.Xr CMS_verify 3 ,
87.Xr ERR_get_error 3 ,
88.Xr i2d_CMS_bio_stream 3 ,
89.Xr PEM_write 3 ,
90.Xr SMIME_write_CMS 3
91.Sh HISTORY
92.Fn PEM_write_bio_CMS_stream
93first appeared in OpenSSL 1.0.0
94and has been available since
95.Ox 6.7 .
96