summaryrefslogtreecommitdiff
path: root/src/lib/libssl/man/SSL_connect.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libssl/man/SSL_connect.3154
1 files changed, 0 insertions, 154 deletions
diff --git a/src/lib/libssl/man/SSL_connect.3 b/src/lib/libssl/man/SSL_connect.3
deleted file mode 100644
index d5b962a480..0000000000
--- a/src/lib/libssl/man/SSL_connect.3
+++ /dev/null
@@ -1,154 +0,0 @@
1.\" $OpenBSD: SSL_connect.3,v 1.6 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, 2001, 2002, 2003 The OpenSSL Project.
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\"
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\"
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in
17.\" the documentation and/or other materials provided with the
18.\" distribution.
19.\"
20.\" 3. All advertising materials mentioning features or use of this
21.\" software must display the following acknowledgment:
22.\" "This product includes software developed by the OpenSSL Project
23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24.\"
25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26.\" endorse or promote products derived from this software without
27.\" prior written permission. For written permission, please contact
28.\" openssl-core@openssl.org.
29.\"
30.\" 5. Products derived from this software may not be called "OpenSSL"
31.\" nor may "OpenSSL" appear in their names without prior written
32.\" permission of the OpenSSL Project.
33.\"
34.\" 6. Redistributions of any form whatsoever must retain the following
35.\" acknowledgment:
36.\" "This product includes software developed by the OpenSSL Project
37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38.\"
39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\"
52.Dd $Mdocdate: March 27 2018 $
53.Dt SSL_CONNECT 3
54.Os
55.Sh NAME
56.Nm SSL_connect
57.Nd initiate the TLS/SSL handshake with a TLS/SSL server
58.Sh SYNOPSIS
59.In openssl/ssl.h
60.Ft int
61.Fn SSL_connect "SSL *ssl"
62.Sh DESCRIPTION
63.Fn SSL_connect
64initiates the TLS/SSL handshake with a server.
65The communication channel must already have been set and assigned to the
66.Fa ssl
67by setting an underlying
68.Vt BIO .
69.Pp
70The behaviour of
71.Fn SSL_connect
72depends on the underlying
73.Vt BIO .
74.Pp
75If the underlying
76.Vt BIO
77is
78.Em blocking ,
79.Fn SSL_connect
80will only return once the handshake has been finished or an error occurred.
81.Pp
82If the underlying
83.Vt BIO
84is
85.Em non-blocking ,
86.Fn SSL_connect
87will also return when the underlying
88.Vt BIO
89could not satisfy the needs of
90.Fn SSL_connect
91to continue the handshake, indicating the problem with the return value \(mi1.
92In this case a call to
93.Xr SSL_get_error 3
94with the return value of
95.Fn SSL_connect
96will yield
97.Dv SSL_ERROR_WANT_READ
98or
99.Dv SSL_ERROR_WANT_WRITE .
100The calling process then must repeat the call after taking appropriate action
101to satisfy the needs of
102.Fn SSL_connect .
103The action depends on the underlying
104.Vt BIO .
105When using a non-blocking socket, nothing is to be done, but
106.Xr select 2
107can be used to check for the required condition.
108When using a buffering
109.Vt BIO ,
110like a
111.Vt BIO
112pair, data must be written into or retrieved out of the
113.Vt BIO
114before being able to continue.
115.Sh RETURN VALUES
116The following return values can occur:
117.Bl -tag -width Ds
118.It 0
119The TLS/SSL handshake was not successful but was shut down controlled and
120by the specifications of the TLS/SSL protocol.
121Call
122.Xr SSL_get_error 3
123with the return value
124.Fa ret
125to find out the reason.
126.It 1
127The TLS/SSL handshake was successfully completed,
128and a TLS/SSL connection has been established.
129.It <0
130The TLS/SSL handshake was not successful, because either a fatal error occurred
131at the protocol level or a connection failure occurred.
132The shutdown was not clean.
133It can also occur if action is needed to continue the operation for
134non-blocking
135.Vt BIO Ns s .
136Call
137.Xr SSL_get_error 3
138with the return value
139.Fa ret
140to find out the reason.
141.El
142.Sh SEE ALSO
143.Xr BIO_new 3 ,
144.Xr ssl 3 ,
145.Xr SSL_accept 3 ,
146.Xr SSL_CTX_new 3 ,
147.Xr SSL_do_handshake 3 ,
148.Xr SSL_get_error 3 ,
149.Xr SSL_set_connect_state 3 ,
150.Xr SSL_shutdown 3
151.Sh HISTORY
152.Fn SSL_connect
153appeared in SSLeay 0.4 or earlier and has been available since
154.Ox 2.4 .
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-04-28 22:39:37 +0000