Debian Codegraph @

upstream/debian-unstable/man3/SSL_connect.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_CONNECT 3SSL"
58 .TH SSL_CONNECT 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_connect \- initiate the TLS/SSL handshake with an TLS/SSL server
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_connect(SSL *ssl);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_connect()\fR initiates the TLS/SSL handshake with a server. The communication
75 channel must already have been set and assigned to the \fBssl\fR by setting an
76 underlying \fBBIO\fR. \fBssl\fR \fBMUST NOT\fR be NULL.
77 .SH NOTES
78 .IX Header "NOTES"
79 The behaviour of \fBSSL_connect()\fR depends on the underlying BIO.
80 .PP
81 If the underlying BIO is \fBblocking\fR, \fBSSL_connect()\fR will only return once the
82 handshake has been finished or an error occurred.
83 .PP
84 If the underlying BIO is \fBnonblocking\fR, \fBSSL_connect()\fR will also return
85 when the underlying BIO could not satisfy the needs of \fBSSL_connect()\fR
86 to continue the handshake, indicating the problem by the return value \-1.
87 In this case a call to \fBSSL_get_error()\fR with the
88 return value of \fBSSL_connect()\fR will yield \fBSSL_ERROR_WANT_READ\fR or
89 \&\fBSSL_ERROR_WANT_WRITE\fR. The calling process then must repeat the call after
90 taking appropriate action to satisfy the needs of \fBSSL_connect()\fR.
91 The action depends on the underlying BIO. When using a nonblocking socket,
92 nothing is to be done, but \fBselect()\fR can be used to check for the required
93 condition. When using a buffering BIO, like a BIO pair, data must be written
94 into or retrieved out of the BIO before being able to continue.
95 .PP
96 Many systems implement Nagle's algorithm by default which means that it will
97 buffer outgoing TCP data if a TCP packet has already been sent for which no
98 corresponding ACK has been received yet from the peer. This can have performance
99 impacts after a successful TLSv1.3 handshake or a successful TLSv1.2 (or below)
100 resumption handshake, because the last peer to communicate in the handshake is
101 the client. If the client is also the first to send application data (as is
102 typical for many protocols) then this data could be buffered until an ACK has
103 been received for the final handshake message.
104 .PP
105 The \fBTCP_NODELAY\fR socket option is often available to disable Nagle's
106 algorithm. If an application opts to disable Nagle's algorithm consideration
107 should be given to turning it back on again later if appropriate. The helper
108 function \fBBIO_set_tcp_ndelay()\fR can be used to turn on or off the \fBTCP_NODELAY\fR
109 option.
110 .SH "RETURN VALUES"
111 .IX Header "RETURN VALUES"
112 The following return values can occur:
113 .IP 0 4
114 The TLS/SSL handshake was not successful but was shut down controlled and
115 by the specifications of the TLS/SSL protocol. Call \fBSSL_get_error()\fR with the
116 return value \fBret\fR to find out the reason.
117 .IP 1 4
118 .IX Item "1"
119 The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
120 established.
121 .IP <0 4
122 .IX Item "<0"
123 The TLS/SSL handshake was not successful, because a fatal error occurred either
124 at the protocol level or a connection failure occurred. The shutdown was
125 not clean. It can also occur if action is needed to continue the operation
126 for nonblocking BIOs. Call \fBSSL_get_error()\fR with the return value \fBret\fR
127 to find out the reason.
128 .SH "SEE ALSO"
129 .IX Header "SEE ALSO"
130 \&\fBSSL_get_error\fR\|(3), \fBSSL_accept\fR\|(3),
131 \&\fBSSL_shutdown\fR\|(3), \fBssl\fR\|(7), \fBbio\fR\|(7),
132 \&\fBSSL_set_connect_state\fR\|(3),
133 \&\fBSSL_do_handshake\fR\|(3),
134 \&\fBSSL_CTX_new\fR\|(3)
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
138 .PP
139 Licensed under the Apache License 2.0 (the "License"). You may not use
140 this file except in compliance with the License. You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 <https://www.openssl.org/source/license.html>.