1 |
.\" $MidnightBSD$ |
2 |
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) |
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 |
.\" Set up some character translations and predefined strings. \*(-- will |
20 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
21 |
.\" double quote, and \*(R" will give a right double quote. \*(C+ will |
22 |
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
23 |
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
24 |
.\" nothing in troff, for use with C<>. |
25 |
.tr \(*W- |
26 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
27 |
.ie n \{\ |
28 |
. ds -- \(*W- |
29 |
. ds PI pi |
30 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
31 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
32 |
. ds L" "" |
33 |
. ds R" "" |
34 |
. ds C` "" |
35 |
. ds C' "" |
36 |
'br\} |
37 |
.el\{\ |
38 |
. ds -- \|\(em\| |
39 |
. ds PI \(*p |
40 |
. ds L" `` |
41 |
. ds R" '' |
42 |
. ds C` |
43 |
. ds C' |
44 |
'br\} |
45 |
.\" |
46 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
47 |
.ie \n(.g .ds Aq \(aq |
48 |
.el .ds Aq ' |
49 |
.\" |
50 |
.\" If the F register is turned on, we'll generate index entries on stderr for |
51 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
52 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
53 |
.\" output yourself in some meaningful fashion. |
54 |
.\" |
55 |
.\" Avoid warning from groff about undefined register 'F'. |
56 |
.de IX |
57 |
.. |
58 |
.nr rF 0 |
59 |
.if \n(.g .if rF .nr rF 1 |
60 |
.if (\n(rF:(\n(.g==0)) \{ |
61 |
. if \nF \{ |
62 |
. de IX |
63 |
. tm Index:\\$1\t\\n%\t"\\$2" |
64 |
.. |
65 |
. if !\nF==2 \{ |
66 |
. nr % 0 |
67 |
. nr F 2 |
68 |
. \} |
69 |
. \} |
70 |
.\} |
71 |
.rr rF |
72 |
.\" |
73 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
74 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
75 |
. \" fudge factors for nroff and troff |
76 |
.if n \{\ |
77 |
. ds #H 0 |
78 |
. ds #V .8m |
79 |
. ds #F .3m |
80 |
. ds #[ \f1 |
81 |
. ds #] \fP |
82 |
.\} |
83 |
.if t \{\ |
84 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
85 |
. ds #V .6m |
86 |
. ds #F 0 |
87 |
. ds #[ \& |
88 |
. ds #] \& |
89 |
.\} |
90 |
. \" simple accents for nroff and troff |
91 |
.if n \{\ |
92 |
. ds ' \& |
93 |
. ds ` \& |
94 |
. ds ^ \& |
95 |
. ds , \& |
96 |
. ds ~ ~ |
97 |
. ds / |
98 |
.\} |
99 |
.if t \{\ |
100 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
101 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
102 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
103 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
104 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
105 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
106 |
.\} |
107 |
. \" troff and (daisy-wheel) nroff accents |
108 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
109 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
110 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
111 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
112 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
113 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
114 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
115 |
.ds ae a\h'-(\w'a'u*4/10)'e |
116 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
117 |
. \" corrections for vroff |
118 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
119 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
120 |
. \" for low resolution devices (crt and lpr) |
121 |
.if \n(.H>23 .if \n(.V>19 \ |
122 |
\{\ |
123 |
. ds : e |
124 |
. ds 8 ss |
125 |
. ds o a |
126 |
. ds d- d\h'-1'\(ga |
127 |
. ds D- D\h'-1'\(hy |
128 |
. ds th \o'bp' |
129 |
. ds Th \o'LP' |
130 |
. ds ae ae |
131 |
. ds Ae AE |
132 |
.\} |
133 |
.rm #[ #] #H #V #F C |
134 |
.\" ======================================================================== |
135 |
.\" |
136 |
.IX Title "BIO_new_CMS 3" |
137 |
.TH BIO_new_CMS 3 "2016-09-22" "1.0.1u" "OpenSSL" |
138 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
139 |
.\" way too many mistakes in technical documents. |
140 |
.if n .ad l |
141 |
.nh |
142 |
.SH "NAME" |
143 |
.Vb 1 |
144 |
\& BIO_new_CMS \- CMS streaming filter BIO |
145 |
.Ve |
146 |
.SH "SYNOPSIS" |
147 |
.IX Header "SYNOPSIS" |
148 |
.Vb 1 |
149 |
\& #include <openssl/cms.h> |
150 |
\& |
151 |
\& BIO *BIO_new_CMS(BIO *out, CMS_ContentInfo *cms); |
152 |
.Ve |
153 |
.SH "DESCRIPTION" |
154 |
.IX Header "DESCRIPTION" |
155 |
\&\fIBIO_new_CMS()\fR returns a streaming filter \s-1BIO\s0 chain based on \fBcms\fR. The output |
156 |
of the filter is written to \fBout\fR. Any data written to the chain is |
157 |
automatically translated to a \s-1BER\s0 format \s-1CMS\s0 structure of the appropriate type. |
158 |
.SH "NOTES" |
159 |
.IX Header "NOTES" |
160 |
The chain returned by this function behaves like a standard filter \s-1BIO.\s0 It |
161 |
supports non blocking I/O. Content is processed and streamed on the fly and not |
162 |
all held in memory at once: so it is possible to encode very large structures. |
163 |
After all content has been written through the chain \fIBIO_flush()\fR must be called |
164 |
to finalise the structure. |
165 |
.PP |
166 |
The \fB\s-1CMS_STREAM\s0\fR flag must be included in the corresponding \fBflags\fR |
167 |
parameter of the \fBcms\fR creation function. |
168 |
.PP |
169 |
If an application wishes to write additional data to \fBout\fR BIOs should be |
170 |
removed from the chain using \fIBIO_pop()\fR and freed with \fIBIO_free()\fR until \fBout\fR |
171 |
is reached. If no additional data needs to be written \fIBIO_free_all()\fR can be |
172 |
called to free up the whole chain. |
173 |
.PP |
174 |
Any content written through the filter is used verbatim: no canonical |
175 |
translation is performed. |
176 |
.PP |
177 |
It is possible to chain multiple BIOs to, for example, create a triple wrapped |
178 |
signed, enveloped, signed structure. In this case it is the applications |
179 |
responsibility to set the inner content type of any outer CMS_ContentInfo |
180 |
structures. |
181 |
.PP |
182 |
Large numbers of small writes through the chain should be avoided as this will |
183 |
produce an output consisting of lots of \s-1OCTET STRING\s0 structures. Prepending |
184 |
a \fIBIO_f_buffer()\fR buffering \s-1BIO\s0 will prevent this. |
185 |
.SH "BUGS" |
186 |
.IX Header "BUGS" |
187 |
There is currently no corresponding inverse \s-1BIO:\s0 i.e. one which can decode |
188 |
a \s-1CMS\s0 structure on the fly. |
189 |
.SH "RETURN VALUES" |
190 |
.IX Header "RETURN VALUES" |
191 |
\&\fIBIO_new_CMS()\fR returns a \s-1BIO\s0 chain when successful or \s-1NULL\s0 if an error |
192 |
occurred. The error can be obtained from \fIERR_get_error\fR\|(3). |
193 |
.SH "SEE ALSO" |
194 |
.IX Header "SEE ALSO" |
195 |
\&\fIERR_get_error\fR\|(3), \fICMS_sign\fR\|(3), |
196 |
\&\fICMS_encrypt\fR\|(3) |
197 |
.SH "HISTORY" |
198 |
.IX Header "HISTORY" |
199 |
\&\fIBIO_new_CMS()\fR was added to OpenSSL 1.0.0 |