Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_get_fd (3openssl)

Name

SSL_get_fd - get file descriptor linked to an SSL object

Synopsis

#include <openssl/ssl.h>

int SSL_get_fd(const SSL *ssl);
int SSL_get_rfd(const SSL *ssl);
int SSL_get_wfd(const SSL *ssl);

Description

SSL_get_fd(3openssl)                OpenSSL               SSL_get_fd(3openssl)



NAME
       SSL_get_fd - get file descriptor linked to an SSL object

SYNOPSIS
        #include <openssl/ssl.h>

        int SSL_get_fd(const SSL *ssl);
        int SSL_get_rfd(const SSL *ssl);
        int SSL_get_wfd(const SSL *ssl);

DESCRIPTION
       SSL_get_fd() returns the file descriptor which is linked to ssl.
       SSL_get_rfd() and SSL_get_wfd() return the file descriptors for the
       read or the write channel, which can be different. If the read and the
       write channel are different, SSL_get_fd() will return the file
       descriptor of the read channel.

RETURN VALUES
       The following return values can occur:

       -1  The operation failed, because the underlying BIO is not of the
           correct type (suitable for file descriptors).

       >=0 The file descriptor linked to ssl.


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_set_fd(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_get_fd(3openssl)