Switch from OpenSSL 0.9.7a to OpenSSL 0.9.7d.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_f_base64.3
1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:42:43 2003
3 .\"
4 .\" Standard preamble:
5 .\" ======================================================================
6 .de Sh \" Subsection heading
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp \" Vertical space (when we can't use .PP)
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip \" List item
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb \" Begin verbatim text
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve \" End verbatim text
30 .ft R
31
32 .fi
33 ..
34 .\" Set up some character translations and predefined strings.  \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote.  | will give a
37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
40 .tr \(*W-|\(bv\*(Tr
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
42 .ie n \{\
43 .    ds -- \(*W-
44 .    ds PI pi
45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
47 .    ds L" ""
48 .    ds R" ""
49 .    ds C` ""
50 .    ds C' ""
51 'br\}
52 .el\{\
53 .    ds -- \|\(em\|
54 .    ds PI \(*p
55 .    ds L" ``
56 .    ds R" ''
57 'br\}
58 .\"
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
63 .if \nF \{\
64 .    de IX
65 .    tm Index:\\$1\t\\n%\t"\\$2"
66 ..
67 .    nr % 0
68 .    rr F
69 .\}
70 .\"
71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
73 .hy 0
74 .if n .na
75 .\"
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
78 .bd B 3
79 .    \" fudge factors for nroff and troff
80 .if n \{\
81 .    ds #H 0
82 .    ds #V .8m
83 .    ds #F .3m
84 .    ds #[ \f1
85 .    ds #] \fP
86 .\}
87 .if t \{\
88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 .    ds #V .6m
90 .    ds #F 0
91 .    ds #[ \&
92 .    ds #] \&
93 .\}
94 .    \" simple accents for nroff and troff
95 .if n \{\
96 .    ds ' \&
97 .    ds ` \&
98 .    ds ^ \&
99 .    ds , \&
100 .    ds ~ ~
101 .    ds /
102 .\}
103 .if t \{\
104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
110 .\}
111 .    \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 .    \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 .    \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
126 \{\
127 .    ds : e
128 .    ds 8 ss
129 .    ds o a
130 .    ds d- d\h'-1'\(ga
131 .    ds D- D\h'-1'\(hy
132 .    ds th \o'bp'
133 .    ds Th \o'LP'
134 .    ds ae ae
135 .    ds Ae AE
136 .\}
137 .rm #[ #] #H #V #F C
138 .\" ======================================================================
139 .\"
140 .IX Title "BIO_f_base64 3"
141 .TH BIO_f_base64 3 "0.9.7a" "2003-02-19" "OpenSSL"
142 .UC
143 .SH "NAME"
144 BIO_f_base64 \- base64 \s-1BIO\s0 filter
145 .SH "SYNOPSIS"
146 .IX Header "SYNOPSIS"
147 .Vb 2
148 \& #include <openssl/bio.h>
149 \& #include <openssl/evp.h>
150 .Ve
151 .Vb 1
152 \& BIO_METHOD *   BIO_f_base64(void);
153 .Ve
154 .SH "DESCRIPTION"
155 .IX Header "DESCRIPTION"
156 \&\fIBIO_f_base64()\fR returns the base64 \s-1BIO\s0 method. This is a filter
157 \&\s-1BIO\s0 that base64 encodes any data written through it and decodes
158 any data read through it.
159 .PP
160 Base64 BIOs do not support \fIBIO_gets()\fR or \fIBIO_puts()\fR. 
161 .PP
162 \&\fIBIO_flush()\fR on a base64 \s-1BIO\s0 that is being written through is
163 used to signal that no more data is to be encoded: this is used
164 to flush the final block through the \s-1BIO\s0.
165 .PP
166 The flag \s-1BIO_FLAGS_BASE64_NO_NL\s0 can be set with \fIBIO_set_flags()\fR
167 to encode the data all on one line or expect the data to be all
168 on one line.
169 .SH "NOTES"
170 .IX Header "NOTES"
171 Because of the format of base64 encoding the end of the encoded
172 block cannot always be reliably determined.
173 .SH "RETURN VALUES"
174 .IX Header "RETURN VALUES"
175 \&\fIBIO_f_base64()\fR returns the base64 \s-1BIO\s0 method.
176 .SH "EXAMPLES"
177 .IX Header "EXAMPLES"
178 Base64 encode the string \*(L"Hello World\en\*(R" and write the result
179 to standard output:
180 .PP
181 .Vb 2
182 \& BIO *bio, *b64;
183 \& char message[] = "Hello World \en";
184 .Ve
185 .Vb 5
186 \& b64 = BIO_new(BIO_f_base64());
187 \& bio = BIO_new_fp(stdout, BIO_NOCLOSE);
188 \& bio = BIO_push(b64, bio);
189 \& BIO_write(bio, message, strlen(message));
190 \& BIO_flush(bio);
191 .Ve
192 .Vb 1
193 \& BIO_free_all(bio);
194 .Ve
195 Read Base64 encoded data from standard input and write the decoded
196 data to standard output:
197 .PP
198 .Vb 4
199 \& BIO *bio, *b64, bio_out;
200 \& char inbuf[512];
201 \& int inlen;
202 \& char message[] = "Hello World \en";
203 .Ve
204 .Vb 6
205 \& b64 = BIO_new(BIO_f_base64());
206 \& bio = BIO_new_fp(stdin, BIO_NOCLOSE);
207 \& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
208 \& bio = BIO_push(b64, bio);
209 \& while((inlen = BIO_read(bio, inbuf, strlen(message))) > 0) 
210 \&        BIO_write(bio_out, inbuf, inlen);
211 .Ve
212 .Vb 1
213 \& BIO_free_all(bio);
214 .Ve
215 .SH "BUGS"
216 .IX Header "BUGS"
217 The ambiguity of \s-1EOF\s0 in base64 encoded data can cause additional
218 data following the base64 encoded block to be misinterpreted.
219 .PP
220 There should be some way of specifying a test that the \s-1BIO\s0 can perform
221 to reliably determine \s-1EOF\s0 (for example a \s-1MIME\s0 boundary).
222 .SH "SEE ALSO"
223 .IX Header "SEE ALSO"
224 \&\s-1TBA\s0