secure/lib/libcrypto/man/BIO_f_base64.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_f_base64 3"
 132 .TH BIO_f_base64 3 "2018-08-14" "1.0.2p" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BIO_f_base64 \- base64 BIO filter
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 2
 142 \& #include <openssl/bio.h>
 143 \& #include <openssl/evp.h>
 144 \&
 145 \& BIO_METHOD *   BIO_f_base64(void);
 146 .Ve
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 \&\fIBIO_f_base64()\fR returns the base64 \s-1BIO\s0 method. This is a filter
 150 \&\s-1BIO\s0 that base64 encodes any data written through it and decodes
 151 any data read through it.
 152 .PP
 153 Base64 BIOs do not support \fIBIO_gets()\fR or \fIBIO_puts()\fR.
 154 .PP
 155 \&\fIBIO_flush()\fR on a base64 \s-1BIO\s0 that is being written through is
 156 used to signal that no more data is to be encoded: this is used
 157 to flush the final block through the \s-1BIO.\s0
 158 .PP
 159 The flag \s-1BIO_FLAGS_BASE64_NO_NL\s0 can be set with \fIBIO_set_flags()\fR
 160 to encode the data all on one line or expect the data to be all
 161 on one line.
 162 .SH "NOTES"
 163 .IX Header "NOTES"
 164 Because of the format of base64 encoding the end of the encoded
 165 block cannot always be reliably determined.
 166 .SH "RETURN VALUES"
 167 .IX Header "RETURN VALUES"
 168 \&\fIBIO_f_base64()\fR returns the base64 \s-1BIO\s0 method.
 169 .SH "EXAMPLES"
 170 .IX Header "EXAMPLES"
 171 Base64 encode the string \*(L"Hello World\en\*(R" and write the result
 172 to standard output:
 173 .PP
 174 .Vb 2
 175 \& BIO *bio, *b64;
 176 \& char message[] = "Hello World \en";
 177 \&
 178 \& b64 = BIO_new(BIO_f_base64());
 179 \& bio = BIO_new_fp(stdout, BIO_NOCLOSE);
 180 \& BIO_push(b64, bio);
 181 \& BIO_write(b64, message, strlen(message));
 182 \& BIO_flush(b64);
 183 \&
 184 \& BIO_free_all(b64);
 185 .Ve
 186 .PP
 187 Read Base64 encoded data from standard input and write the decoded
 188 data to standard output:
 189 .PP
 190 .Vb 3
 191 \& BIO *bio, *b64, *bio_out;
 192 \& char inbuf[512];
 193 \& int inlen;
 194 \&
 195 \& b64 = BIO_new(BIO_f_base64());
 196 \& bio = BIO_new_fp(stdin, BIO_NOCLOSE);
 197 \& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
 198 \& BIO_push(b64, bio);
 199 \& while((inlen = BIO_read(b64, inbuf, 512)) > 0)
 200 \&        BIO_write(bio_out, inbuf, inlen);
 201 \&
 202 \& BIO_flush(bio_out);
 203 \& BIO_free_all(b64);
 204 .Ve
 205 .SH "BUGS"
 206 .IX Header "BUGS"
 207 The ambiguity of \s-1EOF\s0 in base64 encoded data can cause additional
 208 data following the base64 encoded block to be misinterpreted.
 209 .PP
 210 There should be some way of specifying a test that the \s-1BIO\s0 can perform
 211 to reliably determine \s-1EOF\s0 (for example a \s-1MIME\s0 boundary).
 212 .SH "SEE ALSO"
 213 .IX Header "SEE ALSO"
 214 \&\s-1TBA\s0