secure/lib/libcrypto/man/BIO_new_bio_pair.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Tue Jul 30 09:21:06 2002
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "BIO_new_bio_pair 3"
 141 .TH BIO_new_bio_pair 3 "0.9.6e" "2000-11-12" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 BIO_new_bio_pair \- create a new \s-1BIO\s0 pair
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 1
 148 \& #include <openssl/bio.h>
 149 .Ve
 150 .Vb 1
 151 \& int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 \&\fIBIO_new_bio_pair()\fR creates a buffering \s-1BIO\s0 pair. It has two endpoints between
 156 data can be buffered. Its typical use is to connect one endpoint as underlying
 157 input/output \s-1BIO\s0 to an \s-1SSL\s0 and access the other one controlled by the program
 158 instead of accessing the network connection directly.
 159 .PP
 160 The two new BIOs \fBbio1\fR and \fBbio2\fR are symmetric with respect to their
 161 functionality. The size of their buffers is determined by \fBwritebuf1\fR and
 162 \&\fBwritebuf2\fR. If the size give is 0, the default size is used.
 163 .PP
 164 \&\fIBIO_new_bio_pair()\fR does not check whether \fBbio1\fR or \fBbio2\fR do point to
 165 some other \s-1BIO\s0, the values are overwritten, \fIBIO_free()\fR is not called.
 166 .PP
 167 The two BIOs, even though forming a \s-1BIO\s0 pair and must be \fIBIO_free()\fR'ed
 168 separately. This can be of importance, as some SSL-functions like \fISSL_set_bio()\fR
 169 or \fISSL_free()\fR call \fIBIO_free()\fR implicitly, so that the peer-BIO is left
 170 untouched and must also be \fIBIO_free()\fR'ed.
 171 .SH "EXAMPLE"
 172 .IX Header "EXAMPLE"
 173 The \s-1BIO\s0 pair can be used to have full control over the network access of an
 174 application. The application can call \fIselect()\fR on the socket as required
 175 without having to go through the SSL-interface.
 176 .PP
 177 .Vb 6
 178 \& BIO *internal_bio, *network_bio;
 179 \& ...
 180 \& BIO_new_bio_pair(internal_bio, 0, network_bio, 0);
 181 \& SSL_set_bio(ssl, internal_bio);
 182 \& SSL_operations();
 183 \& ...
 184 .Ve
 185 .Vb 9
 186 \& application |   TLS-engine
 187 \&    |        |
 188 \&    +----------> SSL_operations()
 189 \&             |     /\e    ||
 190 \&             |     ||    \e/
 191 \&             |   BIO-pair (internal_bio)
 192 \&    +----------< BIO-pair (network_bio)
 193 \&    |        |
 194 \&  socket     |
 195 .Ve
 196 .Vb 4
 197 \&  ...
 198 \&  SSL_free(ssl);                /* implicitly frees internal_bio */
 199 \&  BIO_free(network_bio);
 200 \&  ...
 201 .Ve
 202 As the \s-1BIO\s0 pair will only buffer the data and never directly access the
 203 connection, it behaves non-blocking and will return as soon as the write
 204 buffer is full or the read buffer is drained. Then the application has to
 205 flush the write buffer and/or fill the read buffer.
 206 .PP
 207 Use the \fIBIO_ctrl_pending()\fR, to find out whether data is buffered in the \s-1BIO\s0
 208 and must be transfered to the network. Use \fIBIO_ctrl_get_read_request()\fR to
 209 find out, how many bytes must be written into the buffer before the
 210 \&\fISSL_operation()\fR can successfully be continued.
 211 .SH "IMPORTANT"
 212 .IX Header "IMPORTANT"
 213 As the data is buffered, \fISSL_operation()\fR may return with a \s-1ERROR_SSL_WANT_READ\s0
 214 condition, but there is still data in the write buffer. An application must
 215 not rely on the error value of \fISSL_operation()\fR but must assure that the
 216 write buffer is always flushed first. Otherwise a deadlock may occur as
 217 the peer might be waiting for the data before being able to continue.
 218 .SH "RETURN VALUES"
 219 .IX Header "RETURN VALUES"
 220 The following return values can occur:
 221 .Ip "1" 4
 222 .IX Item "1"
 223 The \s-1BIO\s0 pair was created successfully. The new BIOs are available in
 224 \&\fBbio1\fR and \fBbio2\fR.
 225 .Ip "0" 4
 226 The operation failed. The \s-1NULL\s0 pointer is stored into the locations for
 227 \&\fBbio1\fR and \fBbio2\fR. Check the error stack for more information.
 228 .SH "SEE ALSO"
 229 .IX Header "SEE ALSO"
 230 SSL_set_bio(3), ssl(3), bio(3),
 231 BIO_ctrl_pending(3),
 232 BIO_ctrl_get_read_request(3)