diff options
author | schwarze <> | 2016-11-05 15:32:20 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
commit | 5af30545c000c195ca6e44f207da004e5780ddb5 (patch) | |
tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_do_handshake.3 | |
parent | ba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff) | |
download | openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.gz openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.bz2 openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/doc/SSL_do_handshake.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_do_handshake.3 | 101 |
1 files changed, 0 insertions, 101 deletions
diff --git a/src/lib/libssl/doc/SSL_do_handshake.3 b/src/lib/libssl/doc/SSL_do_handshake.3 deleted file mode 100644 index 78a37b08c9..0000000000 --- a/src/lib/libssl/doc/SSL_do_handshake.3 +++ /dev/null | |||
@@ -1,101 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_do_handshake.3,v 1.3 2015/06/18 22:51:05 doug Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: June 18 2015 $ | ||
5 | .Dt SSL_DO_HANDSHAKE 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_do_handshake | ||
9 | .Nd perform a TLS/SSL handshake | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/ssl.h | ||
12 | .Ft int | ||
13 | .Fn SSL_do_handshake "SSL *ssl" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_do_handshake | ||
16 | will wait for a SSL/TLS handshake to take place. | ||
17 | If the connection is in client mode, the handshake will be started. | ||
18 | The handshake routines may have to be explicitly set in advance using either | ||
19 | .Xr SSL_set_connect_state 3 | ||
20 | or | ||
21 | .Xr SSL_set_accept_state 3 . | ||
22 | .Sh NOTES | ||
23 | The behaviour of | ||
24 | .Fn SSL_do_handshake | ||
25 | depends on the underlying | ||
26 | .Vt BIO . | ||
27 | .Pp | ||
28 | If the underlying | ||
29 | .Vt BIO | ||
30 | is | ||
31 | .Em blocking , | ||
32 | .Fn SSL_do_handshake | ||
33 | will only return once the handshake has been finished or an error occurred. | ||
34 | .Pp | ||
35 | If the underlying | ||
36 | .Vt BIO | ||
37 | is | ||
38 | .Em non-blocking , | ||
39 | .Fn SSL_do_handshake | ||
40 | will also return when the underlying | ||
41 | .Vt BIO | ||
42 | could not satisfy the needs of | ||
43 | .Fn SSL_do_handshake | ||
44 | to continue the handshake. | ||
45 | In this case a call to | ||
46 | .Xr SSL_get_error 3 | ||
47 | with the return value of | ||
48 | .Fn SSL_do_handshake | ||
49 | will yield | ||
50 | .Dv SSL_ERROR_WANT_READ | ||
51 | or | ||
52 | .Dv SSL_ERROR_WANT_WRITE . | ||
53 | The calling process then must repeat the call after taking appropriate action | ||
54 | to satisfy the needs of | ||
55 | .Fn SSL_do_handshake . | ||
56 | The action depends on the underlying | ||
57 | .Vt BIO . | ||
58 | When using a non-blocking socket, nothing is to be done, but | ||
59 | .Xr select 2 | ||
60 | can be used to check for the required condition. | ||
61 | When using a buffering | ||
62 | .Vt BIO , | ||
63 | like a | ||
64 | .Vt BIO | ||
65 | pair, data must be written into or retrieved out of the | ||
66 | .Vt BIO | ||
67 | before being able to continue. | ||
68 | .Sh RETURN VALUES | ||
69 | The following return values can occur: | ||
70 | .Bl -tag -width Ds | ||
71 | .It 0 | ||
72 | The TLS/SSL handshake was not successful but was shut down controlled and | ||
73 | by the specifications of the TLS/SSL protocol. | ||
74 | Call | ||
75 | .Xr SSL_get_error 3 | ||
76 | with the return value | ||
77 | .Fa ret | ||
78 | to find out the reason. | ||
79 | .It 1 | ||
80 | The TLS/SSL handshake was successfully completed, | ||
81 | and a TLS/SSL connection has been established. | ||
82 | .It <0 | ||
83 | The TLS/SSL handshake was not successful because either a fatal error occurred | ||
84 | at the protocol level or a connection failure occurred. | ||
85 | The shutdown was not clean. | ||
86 | It can also occur if action is needed to continue the operation for | ||
87 | non-blocking | ||
88 | .Vt BIO Ns s. | ||
89 | Call | ||
90 | .Xr SSL_get_error 3 | ||
91 | with the return value | ||
92 | .Fa ret | ||
93 | to find out the reason. | ||
94 | .El | ||
95 | .Sh SEE ALSO | ||
96 | .Xr bio 3 , | ||
97 | .Xr ssl 3 , | ||
98 | .Xr SSL_accept 3 , | ||
99 | .Xr SSL_connect 3 , | ||
100 | .Xr SSL_get_error 3 , | ||
101 | .Xr SSL_set_connect_state 3 | ||