secure/lib/libcrypto/man/BIO_s_bio.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_S_BIO 3"
 132 .TH BIO_S_BIO 3 "2018-11-20" "1.1.1a" "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_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_shutdown_wr, BIO_set_write_buf_size, BIO_get_write_buf_size, BIO_new_bio_pair, BIO_get_write_guarantee, BIO_ctrl_get_write_guarantee, BIO_get_read_request, BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request \- BIO pair BIO
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& const BIO_METHOD *BIO_s_bio(void);
 145 \&
 146 \& int BIO_make_bio_pair(BIO *b1, BIO *b2);
 147 \& int BIO_destroy_bio_pair(BIO *b);
 148 \& int BIO_shutdown_wr(BIO *b);
 149 \&
 150 \& int BIO_set_write_buf_size(BIO *b, long size);
 151 \& size_t BIO_get_write_buf_size(BIO *b, long size);
 152 \&
 153 \& int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2);
 154 \&
 155 \& int BIO_get_write_guarantee(BIO *b);
 156 \& size_t BIO_ctrl_get_write_guarantee(BIO *b);
 157 \& int BIO_get_read_request(BIO *b);
 158 \& size_t BIO_ctrl_get_read_request(BIO *b);
 159 \& int BIO_ctrl_reset_read_request(BIO *b);
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 \&\fIBIO_s_bio()\fR returns the method for a \s-1BIO\s0 pair. A \s-1BIO\s0 pair is a pair of source/sink
 164 BIOs where data written to either half of the pair is buffered and can be read from
 165 the other half. Both halves must usually by handled by the same application thread
 166 since no locking is done on the internal data structures.
 167 .PP
 168 Since \s-1BIO\s0 chains typically end in a source/sink \s-1BIO\s0 it is possible to make this
 169 one half of a \s-1BIO\s0 pair and have all the data processed by the chain under application
 170 control.
 171 .PP
 172 One typical use of \s-1BIO\s0 pairs is to place \s-1TLS/SSL I/O\s0 under application control, this
 173 can be used when the application wishes to use a non standard transport for
 174 \&\s-1TLS/SSL\s0 or the normal socket routines are inappropriate.
 175 .PP
 176 Calls to \fIBIO_read_ex()\fR will read data from the buffer or request a retry if no
 177 data is available.
 178 .PP
 179 Calls to \fIBIO_write_ex()\fR will place data in the buffer or request a retry if the
 180 buffer is full.
 181 .PP
 182 The standard calls \fIBIO_ctrl_pending()\fR and \fIBIO_ctrl_wpending()\fR can be used to
 183 determine the amount of pending data in the read or write buffer.
 184 .PP
 185 \&\fIBIO_reset()\fR clears any data in the write buffer.
 186 .PP
 187 \&\fIBIO_make_bio_pair()\fR joins two separate BIOs into a connected pair.
 188 .PP
 189 \&\fIBIO_destroy_pair()\fR destroys the association between two connected BIOs. Freeing
 190 up any half of the pair will automatically destroy the association.
 191 .PP
 192 \&\fIBIO_shutdown_wr()\fR is used to close down a \s-1BIO\s0 \fBb\fR. After this call no further
 193 writes on \s-1BIO\s0 \fBb\fR are allowed (they will return an error). Reads on the other
 194 half of the pair will return any pending data or \s-1EOF\s0 when all pending data has
 195 been read.
 196 .PP
 197 \&\fIBIO_set_write_buf_size()\fR sets the write buffer size of \s-1BIO\s0 \fBb\fR to \fBsize\fR.
 198 If the size is not initialized a default value is used. This is currently
 199 17K, sufficient for a maximum size \s-1TLS\s0 record.
 200 .PP
 201 \&\fIBIO_get_write_buf_size()\fR returns the size of the write buffer.
 202 .PP
 203 \&\fIBIO_new_bio_pair()\fR combines the calls to \fIBIO_new()\fR, \fIBIO_make_bio_pair()\fR and
 204 \&\fIBIO_set_write_buf_size()\fR to create a connected pair of BIOs \fBbio1\fR, \fBbio2\fR
 205 with write buffer sizes \fBwritebuf1\fR and \fBwritebuf2\fR. If either size is
 206 zero then the default size is used.  \fIBIO_new_bio_pair()\fR does not check whether
 207 \&\fBbio1\fR or \fBbio2\fR do point to some other \s-1BIO,\s0 the values are overwritten,
 208 \&\fIBIO_free()\fR is not called.
 209 .PP
 210 \&\fIBIO_get_write_guarantee()\fR and \fIBIO_ctrl_get_write_guarantee()\fR return the maximum
 211 length of data that can be currently written to the \s-1BIO.\s0 Writes larger than this
 212 value will return a value from \fIBIO_write_ex()\fR less than the amount requested or
 213 if the buffer is full request a retry. \fIBIO_ctrl_get_write_guarantee()\fR is a
 214 function whereas \fIBIO_get_write_guarantee()\fR is a macro.
 215 .PP
 216 \&\fIBIO_get_read_request()\fR and \fIBIO_ctrl_get_read_request()\fR return the
 217 amount of data requested, or the buffer size if it is less, if the
 218 last read attempt at the other half of the \s-1BIO\s0 pair failed due to an
 219 empty buffer.  This can be used to determine how much data should be
 220 written to the \s-1BIO\s0 so the next read will succeed: this is most useful
 221 in \s-1TLS/SSL\s0 applications where the amount of data read is usually
 222 meaningful rather than just a buffer size. After a successful read
 223 this call will return zero.  It also will return zero once new data
 224 has been written satisfying the read request or part of it.
 225 Note that \fIBIO_get_read_request()\fR never returns an amount larger
 226 than that returned by \fIBIO_get_write_guarantee()\fR.
 227 .PP
 228 \&\fIBIO_ctrl_reset_read_request()\fR can also be used to reset the value returned by
 229 \&\fIBIO_get_read_request()\fR to zero.
 230 .SH "NOTES"
 231 .IX Header "NOTES"
 232 Both halves of a \s-1BIO\s0 pair should be freed. That is even if one half is implicit
 233 freed due to a \fIBIO_free_all()\fR or \fISSL_free()\fR call the other half needs to be freed.
 234 .PP
 235 When used in bidirectional applications (such as \s-1TLS/SSL\s0) care should be taken to
 236 flush any data in the write buffer. This can be done by calling \fIBIO_pending()\fR
 237 on the other half of the pair and, if any data is pending, reading it and sending
 238 it to the underlying transport. This must be done before any normal processing
 239 (such as calling \fIselect()\fR ) due to a request and \fIBIO_should_read()\fR being true.
 240 .PP
 241 To see why this is important consider a case where a request is sent using
 242 \&\fIBIO_write_ex()\fR and a response read with \fIBIO_read_ex()\fR, this can occur during an
 243 \&\s-1TLS/SSL\s0 handshake for example. \fIBIO_write_ex()\fR will succeed and place data in the
 244 write buffer. \fIBIO_read_ex()\fR will initially fail and \fIBIO_should_read()\fR will be
 245 true. If the application then waits for data to be available on the underlying
 246 transport before flushing the write buffer it will never succeed because the
 247 request was never sent!
 248 .PP
 249 \&\fIBIO_eof()\fR is true if no data is in the peer \s-1BIO\s0 and the peer \s-1BIO\s0 has been
 250 shutdown.
 251 .PP
 252 \&\fIBIO_make_bio_pair()\fR, \fIBIO_destroy_bio_pair()\fR, \fIBIO_shutdown_wr()\fR,
 253 \&\fIBIO_set_write_buf_size()\fR, \fIBIO_get_write_buf_size()\fR,
 254 \&\fIBIO_get_write_guarantee()\fR, and \fIBIO_get_read_request()\fR are implemented
 255 as macros.
 256 .SH "RETURN VALUES"
 257 .IX Header "RETURN VALUES"
 258 \&\fIBIO_new_bio_pair()\fR returns 1 on success, with the new BIOs available in
 259 \&\fBbio1\fR and \fBbio2\fR, or 0 on failure, with \s-1NULL\s0 pointers stored into the
 260 locations for \fBbio1\fR and \fBbio2\fR. Check the error stack for more information.
 261 .PP
 262 [\s-1XXXXX:\s0 More return values need to be added here]
 263 .SH "EXAMPLE"
 264 .IX Header "EXAMPLE"
 265 The \s-1BIO\s0 pair can be used to have full control over the network access of an
 266 application. The application can call \fIselect()\fR on the socket as required
 267 without having to go through the SSL-interface.
 268 .PP
 269 .Vb 1
 270 \& BIO *internal_bio, *network_bio;
 271 \&
 272 \& ...
 273 \& BIO_new_bio_pair(&internal_bio, 0, &network_bio, 0);
 274 \& SSL_set_bio(ssl, internal_bio, internal_bio);
 275 \& SSL_operations(); /* e.g SSL_read and SSL_write */
 276 \& ...
 277 \&
 278 \& application |   TLS\-engine
 279 \&    |        |
 280 \&    +\-\-\-\-\-\-\-\-\-\-> SSL_operations()
 281 \&             |     /\e    ||
 282 \&             |     ||    \e/
 283 \&             |   BIO\-pair (internal_bio)
 284 \&             |   BIO\-pair (network_bio)
 285 \&             |     ||     /\e
 286 \&             |     \e/     ||
 287 \&    +\-\-\-\-\-\-\-\-\-\-\-< BIO_operations()
 288 \&    |        |
 289 \&    |        |
 290 \&   socket
 291 \&
 292 \&  ...
 293 \&  SSL_free(ssl);                /* implicitly frees internal_bio */
 294 \&  BIO_free(network_bio);
 295 \&  ...
 296 .Ve
 297 .PP
 298 As the \s-1BIO\s0 pair will only buffer the data and never directly access the
 299 connection, it behaves non-blocking and will return as soon as the write
 300 buffer is full or the read buffer is drained. Then the application has to
 301 flush the write buffer and/or fill the read buffer.
 302 .PP
 303 Use the \fIBIO_ctrl_pending()\fR, to find out whether data is buffered in the \s-1BIO\s0
 304 and must be transferred to the network. Use \fIBIO_ctrl_get_read_request()\fR to
 305 find out, how many bytes must be written into the buffer before the
 306 \&\fISSL_operation()\fR can successfully be continued.
 307 .SH "WARNING"
 308 .IX Header "WARNING"
 309 As the data is buffered, \fISSL_operation()\fR may return with an \s-1ERROR_SSL_WANT_READ\s0
 310 condition, but there is still data in the write buffer. An application must
 311 not rely on the error value of \fISSL_operation()\fR but must assure that the
 312 write buffer is always flushed first. Otherwise a deadlock may occur as
 313 the peer might be waiting for the data before being able to continue.
 314 .SH "SEE ALSO"
 315 .IX Header "SEE ALSO"
 316 \&\fISSL_set_bio\fR\|(3), \fIssl\fR\|(7), \fIbio\fR\|(7),
 317 \&\fIBIO_should_retry\fR\|(3), \fIBIO_read_ex\fR\|(3)
 318 .SH "COPYRIGHT"
 319 .IX Header "COPYRIGHT"
 320 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 321 .PP
 322 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 323 this file except in compliance with the License.  You can obtain a copy
 324 in the file \s-1LICENSE\s0 in the source distribution or at
 325 <https://www.openssl.org/source/license.html>.