secure/lib/libcrypto/man/SSL_set_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 "SSL_SET_BIO 3"
 132 .TH SSL_SET_BIO 3 "2018-09-11" "1.1.1" "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 SSL_set_bio, SSL_set0_rbio, SSL_set0_wbio \- connect the SSL object with a BIO
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
 145 \& void SSL_set0_rbio(SSL *s, BIO *rbio);
 146 \& void SSL_set0_wbio(SSL *s, BIO *wbio);
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 \&\fISSL_set0_rbio()\fR connects the \s-1BIO\s0 \fBrbio\fR for the read operations of the \fBssl\fR
 151 object. The \s-1SSL\s0 engine inherits the behaviour of \fBrbio\fR. If the \s-1BIO\s0 is
 152 non-blocking then the \fBssl\fR object will also have non-blocking behaviour. This
 153 function transfers ownership of \fBrbio\fR to \fBssl\fR. It will be automatically
 154 freed using \fIBIO_free_all\fR\|(3) when the \fBssl\fR is freed. On calling this
 155 function, any existing \fBrbio\fR that was previously set will also be freed via a
 156 call to \fIBIO_free_all\fR\|(3) (this includes the case where the \fBrbio\fR is set to
 157 the same value as previously).
 158 .PP
 159 \&\fISSL_set0_wbio()\fR works in the same as \fISSL_set0_rbio()\fR except that it connects
 160 the \s-1BIO\s0 \fBwbio\fR for the write operations of the \fBssl\fR object. Note that if the
 161 rbio and wbio are the same then \fISSL_set0_rbio()\fR and \fISSL_set0_wbio()\fR each take
 162 ownership of one reference. Therefore it may be necessary to increment the
 163 number of references available using \fIBIO_up_ref\fR\|(3) before calling the set0
 164 functions.
 165 .PP
 166 \&\fISSL_set_bio()\fR is similar to \fISSL_set0_rbio()\fR and \fISSL_set0_wbio()\fR except
 167 that it connects both the \fBrbio\fR and the \fBwbio\fR at the same time, and
 168 transfers the ownership of \fBrbio\fR and \fBwbio\fR to \fBssl\fR according to
 169 the following set of rules:
 170 .IP "\(bu" 2
 171 If neither the \fBrbio\fR or \fBwbio\fR have changed from their previous values
 172 then nothing is done.
 173 .IP "\(bu" 2
 174 If the \fBrbio\fR and \fBwbio\fR parameters are different and both are different
 175 to their
 176 previously set values then one reference is consumed for the rbio and one
 177 reference is consumed for the wbio.
 178 .IP "\(bu" 2
 179 If the \fBrbio\fR and \fBwbio\fR parameters are the same and the \fBrbio\fR is not
 180 the same as the previously set value then one reference is consumed.
 181 .IP "\(bu" 2
 182 If the \fBrbio\fR and \fBwbio\fR parameters are the same and the \fBrbio\fR is the
 183 same as the previously set value, then no additional references are consumed.
 184 .IP "\(bu" 2
 185 If the \fBrbio\fR and \fBwbio\fR parameters are different and the \fBrbio\fR is the
 186 same as the
 187 previously set value then one reference is consumed for the \fBwbio\fR and no
 188 references are consumed for the \fBrbio\fR.
 189 .IP "\(bu" 2
 190 If the \fBrbio\fR and \fBwbio\fR parameters are different and the \fBwbio\fR is the
 191 same as the previously set value and the old \fBrbio\fR and \fBwbio\fR values
 192 were the same as each other then one reference is consumed for the \fBrbio\fR
 193 and no references are consumed for the \fBwbio\fR.
 194 .IP "\(bu" 2
 195 If the \fBrbio\fR and \fBwbio\fR parameters are different and the \fBwbio\fR
 196 is the same as the
 197 previously set value and the old \fBrbio\fR and \fBwbio\fR values were different
 198 to each
 199 other then one reference is consumed for the \fBrbio\fR and one reference
 200 is consumed
 201 for the \fBwbio\fR.
 202 .PP
 203 Because of this complexity, this function should be avoided;
 204 use \fISSL_set0_rbio()\fR and \fISSL_set0_wbio()\fR instead.
 205 .SH "RETURN VALUES"
 206 .IX Header "RETURN VALUES"
 207 \&\fISSL_set_bio()\fR, \fISSL_set_rbio()\fR and \fISSL_set_wbio()\fR cannot fail.
 208 .SH "SEE ALSO"
 209 .IX Header "SEE ALSO"
 210 \&\fISSL_get_rbio\fR\|(3),
 211 \&\fISSL_connect\fR\|(3), \fISSL_accept\fR\|(3),
 212 \&\fISSL_shutdown\fR\|(3), \fIssl\fR\|(7), \fIbio\fR\|(7)
 213 .SH "HISTORY"
 214 .IX Header "HISTORY"
 215 \&\fISSL_set0_rbio()\fR and \fISSL_set0_wbio()\fR were added in OpenSSL 1.1.0.
 216 .SH "COPYRIGHT"
 217 .IX Header "COPYRIGHT"
 218 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
 219 .PP
 220 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 221 this file except in compliance with the License.  You can obtain a copy
 222 in the file \s-1LICENSE\s0 in the source distribution or at
 223 <https://www.openssl.org/source/license.html>.