diff options
author | bentley <> | 2014-10-12 09:33:04 +0000 |
---|---|---|
committer | bentley <> | 2014-10-12 09:33:04 +0000 |
commit | 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch) | |
tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_set_connect_state.3 | |
parent | 0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff) | |
download | openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2 openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_set_connect_state.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_set_connect_state.3 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_set_connect_state.3 b/src/lib/libssl/doc/SSL_set_connect_state.3 new file mode 100644 index 0000000000..37e52788a4 --- /dev/null +++ b/src/lib/libssl/doc/SSL_set_connect_state.3 | |||
@@ -0,0 +1,68 @@ | |||
1 | .Dd $Mdocdate: October 12 2014 $ | ||
2 | .Dt SSL_SET_CONNECT_STATE 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm SSL_set_connect_state , | ||
6 | .Nm SSL_get_accept_state | ||
7 | .Nd prepare SSL object to work in client or server mode | ||
8 | .Sh SYNOPSIS | ||
9 | .In openssl/ssl.h | ||
10 | .Ft void | ||
11 | .Fn SSL_set_connect_state "SSL *ssl" | ||
12 | .Ft void | ||
13 | .Fn SSL_set_accept_state "SSL *ssl" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_set_connect_state | ||
16 | sets | ||
17 | .Fa ssl | ||
18 | to work in client mode. | ||
19 | .Pp | ||
20 | .Fn SSL_set_accept_state | ||
21 | sets | ||
22 | .Fa ssl | ||
23 | to work in server mode. | ||
24 | .Sh NOTES | ||
25 | When the | ||
26 | .Vt SSL_CTX | ||
27 | object was created with | ||
28 | .Xr SSL_CTX_new 3 , | ||
29 | it was either assigned a dedicated client method, a dedicated server method, or | ||
30 | a generic method, that can be used for both client and server connections. | ||
31 | (The method might have been changed with | ||
32 | .Xr SSL_CTX_set_ssl_version 3 | ||
33 | or | ||
34 | .Xr SSL_set_ssl_method 3 . ) | ||
35 | .Pp | ||
36 | When beginning a new handshake, the SSL engine must know whether it must call | ||
37 | the connect (client) or accept (server) routines. | ||
38 | Even though it may be clear from the method chosen whether client or server | ||
39 | mode was requested, the handshake routines must be explicitly set. | ||
40 | .Pp | ||
41 | When using the | ||
42 | .Xr SSL_connect 3 | ||
43 | or | ||
44 | .Xr SSL_accept 3 | ||
45 | routines, the correct handshake routines are automatically set. | ||
46 | When performing a transparent negotiation using | ||
47 | .Xr SSL_write 3 | ||
48 | or | ||
49 | .Xr SSL_read 3 , | ||
50 | the handshake routines must be explicitly set in advance using either | ||
51 | .Fn SSL_set_connect_state | ||
52 | or | ||
53 | .Fn SSL_set_accept_state . | ||
54 | .Sh RETURN VALUES | ||
55 | .Fn SSL_set_connect_state | ||
56 | and | ||
57 | .Fn SSL_set_accept_state | ||
58 | do not return diagnostic information. | ||
59 | .Sh SEE ALSO | ||
60 | .Xr ssl 3 , | ||
61 | .Xr SSL_accept 3 , | ||
62 | .Xr SSL_connect 3 , | ||
63 | .Xr SSL_CTX_new 3 , | ||
64 | .Xr SSL_CTX_set_ssl_version 3 , | ||
65 | .Xr SSL_do_handshake 3 , | ||
66 | .Xr SSL_new 3 , | ||
67 | .Xr SSL_read 3 , | ||
68 | .Xr SSL_write 3 | ||