Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_set_fd (3openssl)

Name

SSL_set_fd - connect the SSL object with a file descriptor

Synopsis

#include <openssl/ssl.h>

int SSL_set_fd(SSL *ssl, int fd);
int SSL_set_rfd(SSL *ssl, int fd);
int SSL_set_wfd(SSL *ssl, int fd);

Description

SSL_set_fd(3openssl)                OpenSSL               SSL_set_fd(3openssl)



NAME
       SSL_set_fd - connect the SSL object with a file descriptor

SYNOPSIS
        #include <openssl/ssl.h>

        int SSL_set_fd(SSL *ssl, int fd);
        int SSL_set_rfd(SSL *ssl, int fd);
        int SSL_set_wfd(SSL *ssl, int fd);

DESCRIPTION
       SSL_set_fd() sets the file descriptor fd as the input/output facility
       for the TLS/SSL (encrypted) side of ssl. fd will typically be the
       socket file descriptor of a network connection.

       When performing the operation, a socket BIO is automatically created to
       interface between the ssl and fd. The BIO and hence the SSL engine
       inherit the behaviour of fd. If fd is non-blocking, the ssl will also
       have non-blocking behaviour.

       If there was already a BIO connected to ssl, BIO_free() will be called
       (for both the reading and writing side, if different).

       SSL_set_rfd() and SSL_set_wfd() perform the respective action, but only
       for the read channel or the write channel, which can be set
       independently.

RETURN VALUES
       The following return values can occur:

       0   The operation failed. Check the error stack to find out why.

       1   The operation succeeded.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       SSL_get_fd(3), SSL_set_bio(3), SSL_connect(3), SSL_accept(3),
       SSL_shutdown(3), ssl(3) , bio(3)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.



1.0.2ze                           2022-05-03              SSL_set_fd(3openssl)