secure/lib/libcrypto/man/BIO_s_bio.3

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