wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openssl/doc/man3/SSL_set_bio.pod

109 lines
3.6 KiB
Text
Raw Normal View History

Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
=pod
=head1 NAME
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
SSL_set_bio, SSL_set0_rbio, SSL_set0_wbio - connect the SSL object with a BIO
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
void SSL_set0_rbio(SSL *s, BIO *rbio);
void SSL_set0_wbio(SSL *s, BIO *wbio);
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
=head1 DESCRIPTION
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
SSL_set0_rbio() connects the BIO B<rbio> for the read operations of the B<ssl>
object. The SSL engine inherits the behaviour of B<rbio>. If the BIO is
non-blocking then the B<ssl> object will also have non-blocking behaviour. This
function transfers ownership of B<rbio> to B<ssl>. It will be automatically
freed using L<BIO_free_all(3)> when the B<ssl> is freed. On calling this
function, any existing B<rbio> that was previously set will also be freed via a
call to L<BIO_free_all(3)> (this includes the case where the B<rbio> is set to
the same value as previously).
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
SSL_set0_wbio() works in the same as SSL_set0_rbio() except that it connects
the BIO B<wbio> for the write operations of the B<ssl> object. Note that if the
rbio and wbio are the same then SSL_set0_rbio() and SSL_set0_wbio() each take
ownership of one reference. Therefore it may be necessary to increment the
number of references available using L<BIO_up_ref(3)> before calling the set0
functions.
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
SSL_set_bio() does a similar job as SSL_set0_rbio() and SSL_set0_wbio() except
that it connects both the B<rbio> and the B<wbio> at the same time. This
function transfers the ownership of B<rbio> and B<wbio> to B<ssl> except that
the rules for this are much more complex. For this reason this function is
considered a legacy function and SSL_set0_rbio() and SSL_set0_wbio() should be
used in preference. The ownership rules are as follows:
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
=over 4
=item
If neither the rbio or wbio have changed from their previous values then nothing
is done.
=item
If the rbio and wbio parameters are different and both are different to their
previously set values then one reference is consumed for the rbio and one
reference is consumed for the wbio.
=item
If the rbio and wbio parameters are the same and the rbio is not the same as the
previously set value then one reference is consumed.
=item
If the rbio and wbio parameters are the same and the rbio is the same as the
previously set value, then no additional references are consumed.
=item
If the rbio and wbio parameters are different and the rbio is the same as the
previously set value then one reference is consumbed for the wbio and no
references are consumed for the rbio.
=item
If the rbio and wbio parameters are different and the wbio is the same as the
previously set value and the old rbio and wbio values were the same as each
other then one reference is consumed for the rbio and no references are consumed
for the wbio.
=item
If the rbio and wbio parameters are different and the wbio is the same as the
previously set value and the old rbio and wbio values were different to each
other then one reference is consumed for the rbio and one reference is consumed
for the wbio.
=back
Apache Traffic Server has a need to set the rbio without touching the wbio. There is no mechanism to do that at the moment - SSL_set_bio makes changes to the wbio even if you pass in SSL_get_wbio(). This commit introduces two new API functions SSL_set_rbio() and SSL_set_wbio(). These do the same job as SSL_set_bio() except they enable you to manage the rbio and wbio individually. Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-02-07 00:08:59 +00:00
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
=head1 RETURN VALUES
Apache Traffic Server has a need to set the rbio without touching the wbio. There is no mechanism to do that at the moment - SSL_set_bio makes changes to the wbio even if you pass in SSL_get_wbio(). This commit introduces two new API functions SSL_set_rbio() and SSL_set_wbio(). These do the same job as SSL_set_bio() except they enable you to manage the rbio and wbio individually. Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-02-07 00:08:59 +00:00
SSL_set_bio(), SSL_set_rbio() and SSL_set_wbio() cannot fail.
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
=head1 SEE ALSO
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
L<SSL_get_rbio(3)>,
L<SSL_connect(3)>, L<SSL_accept(3)>,
L<SSL_shutdown(3)>, L<ssl(3)>, L<bio(3)>
Add a number of documentation files, mostly for SSL routines, but also for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
2000-09-14 13:11:56 +00:00
Apache Traffic Server has a need to set the rbio without touching the wbio. There is no mechanism to do that at the moment - SSL_set_bio makes changes to the wbio even if you pass in SSL_get_wbio(). This commit introduces two new API functions SSL_set_rbio() and SSL_set_wbio(). These do the same job as SSL_set_bio() except they enable you to manage the rbio and wbio individually. Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-02-07 00:08:59 +00:00
=head1 HISTORY
Update the SSL_set_bio()/SSL_set0_rbio()/SSL_set0_wbio() docs Update the documentation for the newly renamed and modified SSL_set0_rbio() and SSL_set0_wbio() functions. State that they should be preferred over SSL_set_bio(). Attempt to document the ownership rules for SSL_set_bio(). Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-07-22 10:55:10 +00:00
SSL_set0_rbio() and SSL_set0_wbio() were added in OpenSSL 1.1.0.
Apache Traffic Server has a need to set the rbio without touching the wbio. There is no mechanism to do that at the moment - SSL_set_bio makes changes to the wbio even if you pass in SSL_get_wbio(). This commit introduces two new API functions SSL_set_rbio() and SSL_set_wbio(). These do the same job as SSL_set_bio() except they enable you to manage the rbio and wbio individually. Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-02-07 00:08:59 +00:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 15:44:05 +00:00
=head1 COPYRIGHT
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut
Reference in a new issue Copy permalink