Debian Codegraph @

upstream/debian-unstable/man3/SSL_set_fd.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_SET_FD 3SSL"
58 .TH SSL_SET_FD 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_set_fd, SSL_set_rfd, SSL_set_wfd \- connect the SSL object with a file descriptor
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_set_fd(SSL *ssl, int fd);
71 \& int SSL_set_rfd(SSL *ssl, int fd);
72 \& int SSL_set_wfd(SSL *ssl, int fd);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBSSL_set_fd()\fR sets the file descriptor \fBfd\fR as the input/output facility
77 for the TLS/SSL (encrypted) side of \fBssl\fR. \fBfd\fR will typically be the
78 socket file descriptor of a network connection.
79 .PP
80 When performing the operation, a \fBsocket BIO\fR is automatically created to
81 interface between the \fBssl\fR and \fBfd\fR. The BIO and hence the SSL engine
82 inherit the behaviour of \fBfd\fR. If \fBfd\fR is nonblocking, the \fBssl\fR will
83 also have nonblocking behaviour.
84 .PP
85 When used on a QUIC connection SSL object, a \fBdatagram BIO\fR is automatically
86 created instead of a \fBsocket BIO\fR. These functions fail if called
87 on a QUIC stream SSL object.
88 .PP
89 If there was already a BIO connected to \fBssl\fR, \fBBIO_free()\fR will be called
90 (for both the reading and writing side, if different).
91 .PP
92 \&\fBSSL_set_rfd()\fR and \fBSSL_set_wfd()\fR perform the respective action, but only
93 for the read channel or the write channel, which can be set independently.
94 .SH "RETURN VALUES"
95 .IX Header "RETURN VALUES"
96 The following return values can occur:
97 .IP 0 4
98 The operation failed. Check the error stack to find out why.
99 .IP 1 4
100 .IX Item "1"
101 The operation succeeded.
102 .SH NOTES
103 .IX Header "NOTES"
104 On Windows, a socket handle is a 64\-bit data type (UINT_PTR), which leads to a
105 compiler warning (conversion from 'SOCKET' to 'int', possible loss of data) when
106 passing the socket handle to SSL_set_*\fBfd()\fR. For the time being, this warning can
107 safely be ignored, because although the Microsoft documentation claims that the
108 upper limit is INVALID_SOCKET\-1 (2^64 \- 2), in practice the current \fBsocket()\fR
109 implementation returns an index into the kernel handle table, the size of which
110 is limited to 2^24.
111 .SH "SEE ALSO"
112 .IX Header "SEE ALSO"
113 \&\fBSSL_get_fd\fR\|(3), \fBSSL_set_bio\fR\|(3),
114 \&\fBSSL_connect\fR\|(3), \fBSSL_accept\fR\|(3),
115 \&\fBSSL_shutdown\fR\|(3), \fBssl\fR\|(7) , \fBbio\fR\|(7)
116 .SH COPYRIGHT
117 .IX Header "COPYRIGHT"
118 Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved.
119 .PP
120 Licensed under the Apache License 2.0 (the "License"). You may not use
121 this file except in compliance with the License. You can obtain a copy
122 in the file LICENSE in the source distribution or at
123 <https://www.openssl.org/source/license.html>.