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