1.\" $OpenBSD: SSL_set_fd.3,v 1.5 2018/03/27 17:35:50 schwarze Exp $ 2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 3.\" 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. 5.\" Copyright (c) 2000, 2013 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_FD 3 53.Os 54.Sh NAME 55.Nm SSL_set_fd , 56.Nm SSL_set_rfd , 57.Nm SSL_set_wfd 58.Nd connect the SSL object with a file descriptor 59.Sh SYNOPSIS 60.In openssl/ssl.h 61.Ft int 62.Fn SSL_set_fd "SSL *ssl" "int fd" 63.Ft int 64.Fn SSL_set_rfd "SSL *ssl" "int fd" 65.Ft int 66.Fn SSL_set_wfd "SSL *ssl" "int fd" 67.Sh DESCRIPTION 68.Fn SSL_set_fd 69sets the file descriptor 70.Fa fd 71as the input/output facility for the TLS/SSL (encrypted) side of 72.Fa ssl . 73.Fa fd 74will typically be the socket file descriptor of a network connection. 75.Pp 76When performing the operation, a socket 77.Vt BIO 78is automatically created to interface between the 79.Fa ssl 80and 81.Fa fd . 82The 83.Vt BIO 84and hence the SSL engine inherit the behaviour of 85.Fa fd . 86If 87.Fa fd 88is non-blocking, the 89.Fa ssl 90will also have non-blocking behaviour. 91.Pp 92If there was already a 93.Vt BIO 94connected to 95.Fa ssl , 96.Xr BIO_free 3 97will be called (for both the reading and writing side, if different). 98.Pp 99.Fn SSL_set_rfd 100and 101.Fn SSL_set_wfd 102perform the respective action, but only for the read channel or the write 103channel, which can be set independently. 104.Sh RETURN VALUES 105The following return values can occur: 106.Bl -tag -width Ds 107.It 0 108The operation failed. 109Check the error stack to find out why. 110.It 1 111The operation succeeded. 112.El 113.Sh SEE ALSO 114.Xr BIO_new 3 , 115.Xr ssl 3 , 116.Xr SSL_accept 3 , 117.Xr SSL_connect 3 , 118.Xr SSL_get_fd 3 , 119.Xr SSL_set_bio 3 , 120.Xr SSL_shutdown 3 121.Sh HISTORY 122.Fn SSL_set_fd 123appeared in SSLeay 0.4 or earlier. 124.Fn SSL_set_rfd 125and 126.Fn SSL_set_wfd 127first appeared in SSLeay 0.6.0. 128These functions have been available since 129.Ox 2.4 . 130