xref: /openbsd-src/lib/libcrypto/man/PEM_write_bio_CMS_stream.3 (revision 3f41d2fa12cdc33836ac204042f0fb5ab71c835e)

.\" $OpenBSD: PEM_write_bio_CMS_stream.3,v 1.6 2023/05/01 07:28:11 tb Exp $
.\" full merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100
.\"
.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
.\" Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: May 1 2023 $
.Dt PEM_WRITE_BIO_CMS_STREAM 3
.Os
.Sh NAME
.Nm PEM_write_bio_CMS_stream
.Nd output CMS_ContentInfo structure in PEM format
.Sh SYNOPSIS
.In openssl/cms.h
.Ft int
.Fo PEM_write_bio_CMS_stream
.Fa "BIO *out"
.Fa "CMS_ContentInfo *cms"
.Fa "BIO *data"
.Fa "int flags"
.Fc
.Sh DESCRIPTION
.Fn PEM_write_bio_CMS_stream
outputs a
.Vt CMS_ContentInfo
structure in PEM format.
.Pp
It is otherwise identical to the function
.Xr SMIME_write_CMS 3 .
.Pp
This function is effectively a version of
.Xr PEM_write_bio_CMS 3
supporting streaming.
.Sh RETURN VALUES
.Fn PEM_write_bio_CMS_stream
returns 1 for success or 0 for failure.
.Sh SEE ALSO
.Xr CMS_ContentInfo_new 3 ,
.Xr CMS_decrypt 3 ,
.Xr CMS_encrypt 3 ,
.Xr CMS_sign 3 ,
.Xr CMS_verify 3 ,
.Xr ERR_get_error 3 ,
.Xr i2d_CMS_bio_stream 3 ,
.Xr PEM_write 3 ,
.Xr SMIME_write_CMS 3
.Sh HISTORY
.Fn PEM_write_bio_CMS_stream
first appeared in OpenSSL 1.0.0
and has been available since
.Ox 6.7 .