lib/libssl/man/SSL_set_bio.3

   1 .\"     $OpenBSD: SSL_set_bio.3,v 1.5 2018/03/27 17:35:50 schwarze Exp $
   2 .\"     OpenSSL acb5b343 Sep 16 16:00:38 2000 +0000
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: March 27 2018 $
  52 .Dt SSL_SET_BIO 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_set_bio
  56 .Nd connect the SSL object with a BIO
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft void
  60 .Fn SSL_set_bio "SSL *ssl" "BIO *rbio" "BIO *wbio"
  61 .Sh DESCRIPTION
  62 .Fn SSL_set_bio
  63 connects the
  64 .Vt BIO Ns
  65 s
  66 .Fa rbio
  67 and
  68 .Fa wbio
  69 for the read and write operations of the TLS/SSL (encrypted) side of
  70 .Fa ssl .
  71 .Pp
  72 The SSL engine inherits the behaviour of
  73 .Fa rbio
  74 and
  75 .Fa wbio ,
  76 respectively.
  77 If a
  78 .Vt BIO
  79 is non-blocking, the
  80 .Fa ssl
  81 will also have non-blocking behaviour.
  82 .Pp
  83 If there was already a
  84 .Vt BIO
  85 connected to
  86 .Fa ssl ,
  87 .Xr BIO_free 3
  88 will be called (for both the reading and writing side, if different).
  89 .Sh RETURN VALUES
  90 .Fn SSL_set_bio
  91 cannot fail.
  92 .Sh SEE ALSO
  93 .Xr BIO_new 3 ,
  94 .Xr ssl 3 ,
  95 .Xr SSL_accept 3 ,
  96 .Xr SSL_connect 3 ,
  97 .Xr SSL_get_rbio 3 ,
  98 .Xr SSL_shutdown 3
  99 .Sh HISTORY
 100 .Fn SSL_set_bio
 101 first appeared in SSLeay 0.6.0 and has been available since
 102 .Ox 2.4 .