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