secure/lib/libcrypto/man/man7/bio.7

   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 7"
 136 .TH BIO 7 "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 \- Basic I/O abstraction
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bio.h>
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 A \s-1BIO\s0 is an I/O abstraction, it hides many of the underlying I/O
 151 details from an application. If an application uses a \s-1BIO\s0 for its
 152 I/O it can transparently handle \s-1SSL\s0 connections, unencrypted network
 153 connections and file I/O.
 154 .PP
 155 There are two type of \s-1BIO,\s0 a source/sink \s-1BIO\s0 and a filter \s-1BIO.\s0
 156 .PP
 157 As its name implies a source/sink \s-1BIO\s0 is a source and/or sink of data,
 158 examples include a socket \s-1BIO\s0 and a file \s-1BIO.\s0
 159 .PP
 160 A filter \s-1BIO\s0 takes data from one \s-1BIO\s0 and passes it through to
 161 another, or the application. The data may be left unmodified (for
 162 example a message digest \s-1BIO\s0) or translated (for example an
 163 encryption \s-1BIO\s0). The effect of a filter \s-1BIO\s0 may change according
 164 to the I/O operation it is performing: for example an encryption
 165 \&\s-1BIO\s0 will encrypt data if it is being written to and decrypt data
 166 if it is being read from.
 167 .PP
 168 BIOs can be joined together to form a chain (a single \s-1BIO\s0 is a chain
 169 with one component). A chain normally consist of one source/sink
 170 \&\s-1BIO\s0 and one or more filter BIOs. Data read from or written to the
 171 first \s-1BIO\s0 then traverses the chain to the end (normally a source/sink
 172 \&\s-1BIO\s0).
 173 .PP
 174 Some BIOs (such as memory BIOs) can be used immediately after calling
 175 \&\fBBIO_new()\fR. Others (such as file BIOs) need some additional initialization,
 176 and frequently a utility function exists to create and initialize such BIOs.
 177 .PP
 178 If \fBBIO_free()\fR is called on a \s-1BIO\s0 chain it will only free one \s-1BIO\s0 resulting
 179 in a memory leak.
 180 .PP
 181 Calling \fBBIO_free_all()\fR on a single \s-1BIO\s0 has the same effect as calling
 182 \&\fBBIO_free()\fR on it other than the discarded return value.
 183 .PP
 184 Normally the \fBtype\fR argument is supplied by a function which returns a
 185 pointer to a \s-1BIO_METHOD.\s0 There is a naming convention for such functions:
 186 a source/sink \s-1BIO\s0 is normally called BIO_s_*() and a filter \s-1BIO\s0
 187 BIO_f_*();
 188 .SH "EXAMPLES"
 189 .IX Header "EXAMPLES"
 190 Create a memory \s-1BIO:\s0
 191 .PP
 192 .Vb 1
 193 \& BIO *mem = BIO_new(BIO_s_mem());
 194 .Ve
 195 .SH "SEE ALSO"
 196 .IX Header "SEE ALSO"
 197 \&\fBBIO_ctrl\fR\|(3),
 198 \&\fBBIO_f_base64\fR\|(3), \fBBIO_f_buffer\fR\|(3),
 199 \&\fBBIO_f_cipher\fR\|(3), \fBBIO_f_md\fR\|(3),
 200 \&\fBBIO_f_null\fR\|(3), \fBBIO_f_ssl\fR\|(3),
 201 \&\fBBIO_find_type\fR\|(3), \fBBIO_new\fR\|(3),
 202 \&\fBBIO_new_bio_pair\fR\|(3),
 203 \&\fBBIO_push\fR\|(3), \fBBIO_read_ex\fR\|(3),
 204 \&\fBBIO_s_accept\fR\|(3), \fBBIO_s_bio\fR\|(3),
 205 \&\fBBIO_s_connect\fR\|(3), \fBBIO_s_fd\fR\|(3),
 206 \&\fBBIO_s_file\fR\|(3), \fBBIO_s_mem\fR\|(3),
 207 \&\fBBIO_s_null\fR\|(3), \fBBIO_s_socket\fR\|(3),
 208 \&\fBBIO_set_callback\fR\|(3),
 209 \&\fBBIO_should_retry\fR\|(3)
 210 .SH "COPYRIGHT"
 211 .IX Header "COPYRIGHT"
 212 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
 213 .PP
 214 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 215 this file except in compliance with the License.  You can obtain a copy
 216 in the file \s-1LICENSE\s0 in the source distribution or at
 217 <https://www.openssl.org/source/license.html>.