Debian Codegraph @

upstream/debian-unstable/man3/SSL_do_handshake.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_DO_HANDSHAKE 3SSL"
58 .TH SSL_DO_HANDSHAKE 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_do_handshake \- perform a TLS/SSL handshake
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_do_handshake(SSL *ssl);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_do_handshake()\fR will wait for an SSL/TLS handshake to take place. If the
75 connection is in client mode, the handshake will be started. The handshake
76 routines may have to be explicitly set in advance using either
77 \&\fBSSL_set_connect_state\fR\|(3) or
78 \&\fBSSL_set_accept_state\fR\|(3).
79 .SH NOTES
80 .IX Header "NOTES"
81 The behaviour of \fBSSL_do_handshake()\fR depends on the underlying BIO.
82 .PP
83 If the underlying BIO is \fBblocking\fR, \fBSSL_do_handshake()\fR will only return
84 once the handshake has been finished or an error occurred.
85 .PP
86 If the underlying BIO is \fBnonblocking\fR, \fBSSL_do_handshake()\fR will also return
87 when the underlying BIO could not satisfy the needs of \fBSSL_do_handshake()\fR
88 to continue the handshake. In this case a call to \fBSSL_get_error()\fR with the
89 return value of \fBSSL_do_handshake()\fR will yield \fBSSL_ERROR_WANT_READ\fR or
90 \&\fBSSL_ERROR_WANT_WRITE\fR. The calling process then must repeat the call after
91 taking appropriate action to satisfy the needs of \fBSSL_do_handshake()\fR.
92 The action depends on the underlying BIO. When using a nonblocking socket,
93 nothing is to be done, but \fBselect()\fR can be used to check for the required
94 condition. When using a buffering BIO, like a BIO pair, data must be written
95 into or retrieved out of the BIO before being able to continue.
96 .SH "RETURN VALUES"
97 .IX Header "RETURN VALUES"
98 The following return values can occur:
99 .IP 0 4
100 The TLS/SSL handshake was not successful but was shut down controlled and
101 by the specifications of the TLS/SSL protocol. Call \fBSSL_get_error()\fR with the
102 return value \fBret\fR to find out the reason.
103 .IP 1 4
104 .IX Item "1"
105 The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
106 established.
107 .IP <0 4
108 .IX Item "<0"
109 The TLS/SSL handshake was not successful because a fatal error occurred either
110 at the protocol level or a connection failure occurred. The shutdown was
111 not clean. It can also occur if action is needed to continue the operation
112 for nonblocking BIOs. Call \fBSSL_get_error()\fR with the return value \fBret\fR
113 to find out the reason.
114 .SH "SEE ALSO"
115 .IX Header "SEE ALSO"
116 \&\fBSSL_get_error\fR\|(3), \fBSSL_connect\fR\|(3),
117 \&\fBSSL_accept\fR\|(3), \fBssl\fR\|(7), \fBbio\fR\|(7),
118 \&\fBSSL_set_connect_state\fR\|(3)
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright 2002\-2020 The OpenSSL Project Authors. All Rights Reserved.
122 .PP
123 Licensed under the Apache License 2.0 (the "License"). You may not use
124 this file except in compliance with the License. You can obtain a copy
125 in the file LICENSE in the source distribution or at
126 <https://www.openssl.org/source/license.html>.