secure/lib/libcrypto/man/man3/BIO_f_base64.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  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-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  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' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BIO_F_BASE64 3"
 136 .TH BIO_F_BASE64 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BIO_f_base64 \- base64 BIO filter
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 2
 146 \& #include <openssl/bio.h>
 147 \& #include <openssl/evp.h>
 148 \&
 149 \& const BIO_METHOD *BIO_f_base64(void);
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 \&\fBBIO_f_base64()\fR returns the base64 \s-1BIO\s0 method. This is a filter
 154 \&\s-1BIO\s0 that base64 encodes any data written through it and decodes
 155 any data read through it.
 156 .PP
 157 Base64 BIOs do not support \fBBIO_gets()\fR or \fBBIO_puts()\fR.
 158 .PP
 159 For writing, output is by default divided to lines of length 64
 160 characters and there is always a newline at the end of output.
 161 .PP
 162 For reading, first line should be at most 1024
 163 characters long. If it is longer then it is ignored completely.
 164 Other input lines can be of any length. There must be a newline
 165 at the end of input.
 166 .PP
 167 This behavior can be changed with \s-1BIO_FLAGS_BASE64_NO_NL\s0 flag.
 168 .PP
 169 \&\fBBIO_flush()\fR on a base64 \s-1BIO\s0 that is being written through is
 170 used to signal that no more data is to be encoded: this is used
 171 to flush the final block through the \s-1BIO.\s0
 172 .PP
 173 The flag \s-1BIO_FLAGS_BASE64_NO_NL\s0 can be set with \fBBIO_set_flags()\fR.
 174 For writing, it causes all data to be written on one line without
 175 newline at the end.
 176 For reading, it forces the decoder to process the data regardless
 177 of newlines. All newlines are ignored and the input does not need
 178 to contain any newline at all.
 179 .SH "NOTES"
 180 .IX Header "NOTES"
 181 Because of the format of base64 encoding the end of the encoded
 182 block cannot always be reliably determined.
 183 .SH "RETURN VALUES"
 184 .IX Header "RETURN VALUES"
 185 \&\fBBIO_f_base64()\fR returns the base64 \s-1BIO\s0 method.
 186 .SH "EXAMPLES"
 187 .IX Header "EXAMPLES"
 188 Base64 encode the string \*(L"Hello World\en\*(R" and write the result
 189 to standard output:
 190 .PP
 191 .Vb 2
 192 \& BIO *bio, *b64;
 193 \& char message[] = "Hello World \en";
 194 \&
 195 \& b64 = BIO_new(BIO_f_base64());
 196 \& bio = BIO_new_fp(stdout, BIO_NOCLOSE);
 197 \& BIO_push(b64, bio);
 198 \& BIO_write(b64, message, strlen(message));
 199 \& BIO_flush(b64);
 200 \&
 201 \& BIO_free_all(b64);
 202 .Ve
 203 .PP
 204 Read Base64 encoded data from standard input and write the decoded
 205 data to standard output:
 206 .PP
 207 .Vb 3
 208 \& BIO *bio, *b64, *bio_out;
 209 \& char inbuf[512];
 210 \& int inlen;
 211 \&
 212 \& b64 = BIO_new(BIO_f_base64());
 213 \& bio = BIO_new_fp(stdin, BIO_NOCLOSE);
 214 \& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
 215 \& BIO_push(b64, bio);
 216 \& while ((inlen = BIO_read(b64, inbuf, 512)) > 0)
 217 \&     BIO_write(bio_out, inbuf, inlen);
 218 \&
 219 \& BIO_flush(bio_out);
 220 \& BIO_free_all(b64);
 221 .Ve
 222 .SH "BUGS"
 223 .IX Header "BUGS"
 224 The ambiguity of \s-1EOF\s0 in base64 encoded data can cause additional
 225 data following the base64 encoded block to be misinterpreted.
 226 .PP
 227 There should be some way of specifying a test that the \s-1BIO\s0 can perform
 228 to reliably determine \s-1EOF\s0 (for example a \s-1MIME\s0 boundary).
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.