lib/libcrypto/man/i2d_PKCS7_bio_stream.3

   1 .\"     $OpenBSD: i2d_PKCS7_bio_stream.3,v 1.6 2016/12/13 15:00:22 schwarze Exp $
   2 .\"     OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
   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: December 13 2016 $
  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
  69 outputs a
  70 .Vt PKCS7
  71 structure in BER format.
  72 It is otherwise identical to the function
  73 .Xr SMIME_write_PKCS7 3 .
  74 This function is effectively a version of
  75 .Xr d2i_PKCS7_bio 3
  76 supporting streaming.
  77 .Sh RETURN VALUES
  78 .Fn i2d_PKCS7_bio_stream
  79 returns 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_new 3 ,
  86 .Xr SMIME_write_PKCS7 3
  87 .Sh HISTORY
  88 .Fn i2d_PKCS7_bio_stream
  89 was added to OpenSSL 1.0.0.
  90 .Sh BUGS
  91 The prefix "i2d" is arguably wrong because the function outputs BER
  92 format.