Debian Codegraph @

upstream/debian-unstable/man3/BIO_new_CMS.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_NEW_CMS 3SSL"
58 .TH BIO_NEW_CMS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_new_CMS \- CMS streaming filter BIO
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& BIO *BIO_new_CMS(BIO *out, CMS_ContentInfo *cms);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBBIO_new_CMS()\fR returns a streaming filter BIO chain based on \fBcms\fR. The output
75 of the filter is written to \fBout\fR. Any data written to the chain is
76 automatically translated to a BER format CMS structure of the appropriate type.
77 .SH NOTES
78 .IX Header "NOTES"
79 The chain returned by this function behaves like a standard filter BIO. It
80 supports non blocking I/O. Content is processed and streamed on the fly and not
81 all held in memory at once: so it is possible to encode very large structures.
82 After all content has been written through the chain \fBBIO_flush()\fR must be called
83 to finalise the structure.
84 .PP
85 The \fBCMS_STREAM\fR flag must be included in the corresponding \fBflags\fR
86 parameter of the \fBcms\fR creation function.
87 .PP
88 If an application wishes to write additional data to \fBout\fR BIOs should be
89 removed from the chain using \fBBIO_pop()\fR and freed with \fBBIO_free()\fR until \fBout\fR
90 is reached. If no additional data needs to be written \fBBIO_free_all()\fR can be
91 called to free up the whole chain.
92 .PP
93 Any content written through the filter is used verbatim: no canonical
94 translation is performed.
95 .PP
96 It is possible to chain multiple BIOs to, for example, create a triple wrapped
97 signed, enveloped, signed structure. In this case it is the applications
98 responsibility to set the inner content type of any outer CMS_ContentInfo
99 structures.
100 .PP
101 Large numbers of small writes through the chain should be avoided as this will
102 produce an output consisting of lots of OCTET STRING structures. Prepending
103 a \fBBIO_f_buffer()\fR buffering BIO will prevent this.
104 .SH BUGS
105 .IX Header "BUGS"
106 There is currently no corresponding inverse BIO: i.e. one which can decode
107 a CMS structure on the fly.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 \&\fBBIO_new_CMS()\fR returns a BIO chain when successful or NULL if an error
111 occurred. The error can be obtained from \fBERR_get_error\fR\|(3).
112 .SH "SEE ALSO"
113 .IX Header "SEE ALSO"
114 \&\fBERR_get_error\fR\|(3), \fBCMS_sign\fR\|(3),
115 \&\fBCMS_encrypt\fR\|(3)
116 .SH HISTORY
117 .IX Header "HISTORY"
118 The \fBBIO_new_CMS()\fR function was added in OpenSSL 1.0.0.
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
122 .PP
123 Licensed under the Apache License 2.0 (the "License"). You may not use
124 this file except in compliance with the License. You can obtain a copy
125 in the file LICENSE in the source distribution or at
126 <https://www.openssl.org/source/license.html>.