Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs
[openssl.git] / doc / ssl / SSL_set_bio.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_set_bio, SSL_set0_rbio, SSL_set0_wbio - connect the SSL object with a BIO
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
12  void SSL_set0_rbio(SSL *s, BIO *rbio);
13  void SSL_set0_wbio(SSL *s, BIO *wbio);
14
15 =head1 DESCRIPTION
16
17 SSL_set0_rbio() connects the BIO B<rbio> for the read operations of the B<ssl>
18 object. The SSL engine inherits the behaviour of B<rbio>. If the BIO is
19 non-blocking then the B<ssl> object will also have non-blocking behaviour. This
20 function transfers ownership of B<rbio> to B<ssl>. It will be automatically
21 freed using L<BIO_free_all(3)> when the B<ssl> is freed. On calling this
22 function, any existing B<rbio> that was previously set will also be freed via a
23 call to L<BIO_free_all(3)> (this includes the case where the B<rbio> is set to
24 the same value as previously).
25
26 SSL_set0_wbio() works in the same as SSL_set0_rbio() except that it connects
27 the BIO B<wbio> for the write operations of the B<ssl> object. Note that if the
28 rbio and wbio are the same then SSL_set0_rbio() and SSL_set0_wbio() each take
29 ownership of one reference. Therefore it may be necessary to increment the
30 number of references available using L<BIO_up_ref(3)> before calling the set0
31 functions.
32
33 SSL_set_bio() does a similar job as SSL_set0_rbio() and SSL_set0_wbio() except
34 that it connects both the B<rbio> and the B<wbio> at the same time. This
35 function transfers the ownership of B<rbio> and B<wbio> to B<ssl> except that
36 the rules for this are much more complex. For this reason this function is
37 considered a legacy function and SSL_set0_rbio() and SSL_set0_wbio() should be
38 used in preference. The ownership rules are as follows:
39
40 =over 4
41
42 =item
43
44 If neither the rbio or wbio have changed from their previous values then nothing
45 is done.
46
47 =item
48
49 If the rbio and wbio parameters are different and both are different to their
50 previously set values then one reference is consumed for the rbio and one
51 reference is consumed for the wbio.
52
53 =item
54
55 If the rbio and wbio parameters are the same and the rbio is not the same as the
56 previously set value then one reference is consumed.
57
58 =item
59
60 If the rbio and wbio parameters are the same and the rbio is the same as the
61 previously set value, then no additional references are consumed.
62
63 =item
64
65 If the rbio and wbio parameters are different and the rbio is the same as the
66 previously set value then one reference is consumbed for the wbio and no
67 references are consumed for the rbio.
68
69 =item
70
71 If the rbio and wbio parameters are different and the wbio is the same as the
72 previously set value and the old rbio and wbio values were the same as each
73 other then one reference is consumed for the rbio and no references are consumed
74 for the wbio.
75
76 =item
77
78 If the rbio and wbio parameters are different and the wbio is the same as the
79 previously set value and the old rbio and wbio values were different to each
80 other then one reference is consumed for the rbio and one reference is consumed
81 for the wbio.
82
83 =back
84
85 =head1 RETURN VALUES
86
87 SSL_set_bio(), SSL_set_rbio() and SSL_set_wbio() cannot fail.
88
89 =head1 SEE ALSO
90
91 L<SSL_get_rbio(3)>,
92 L<SSL_connect(3)>, L<SSL_accept(3)>,
93 L<SSL_shutdown(3)>, L<ssl(3)>, L<bio(3)>
94
95 =head1 HISTORY
96
97 SSL_set0_rbio() and SSL_set0_wbio() were added in OpenSSL 1.1.0.
98
99 =head1 COPYRIGHT
100
101 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
102
103 Licensed under the OpenSSL license (the "License").  You may not use
104 this file except in compliance with the License.  You can obtain a copy
105 in the file LICENSE in the source distribution or at
106 L<https://www.openssl.org/source/license.html>.
107
108 =cut