diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_set_session.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_set_session.3 | 68 |
1 files changed, 0 insertions, 68 deletions
diff --git a/src/lib/libssl/doc/SSL_set_session.3 b/src/lib/libssl/doc/SSL_set_session.3 deleted file mode 100644 index 8b4b78b6e2..0000000000 --- a/src/lib/libssl/doc/SSL_set_session.3 +++ /dev/null | |||
@@ -1,68 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_set_session.3,v 1.3 2015/09/14 15:14:55 schwarze Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: September 14 2015 $ | ||
5 | .Dt SSL_SET_SESSION 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_set_session | ||
9 | .Nd set a TLS/SSL session to be used during TLS/SSL connect | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/ssl.h | ||
12 | .Ft int | ||
13 | .Fn SSL_set_session "SSL *ssl" "SSL_SESSION *session" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_set_session | ||
16 | sets | ||
17 | .Fa session | ||
18 | to be used when the TLS/SSL connection is to be established. | ||
19 | .Fn SSL_set_session | ||
20 | is only useful for TLS/SSL clients. | ||
21 | When the session is set, the reference count of | ||
22 | .Fa session | ||
23 | is incremented | ||
24 | by 1. | ||
25 | If the session is not reused, the reference count is decremented again during | ||
26 | .Fn SSL_connect . | ||
27 | Whether the session was reused can be queried with the | ||
28 | .Xr SSL_session_reused 3 | ||
29 | call. | ||
30 | .Pp | ||
31 | If there is already a session set inside | ||
32 | .Fa ssl | ||
33 | (because it was set with | ||
34 | .Fn SSL_set_session | ||
35 | before or because the same | ||
36 | .Fa ssl | ||
37 | was already used for a connection), | ||
38 | .Xr SSL_SESSION_free 3 | ||
39 | will be called for that session. | ||
40 | .Sh NOTES | ||
41 | .Vt SSL_SESSION | ||
42 | objects keep internal link information about the session cache list when being | ||
43 | inserted into one | ||
44 | .Vt SSL_CTX | ||
45 | object's session cache. | ||
46 | One | ||
47 | .Vt SSL_SESSION | ||
48 | object, regardless of its reference count, must therefore only be used with one | ||
49 | .Vt SSL_CTX | ||
50 | object (and the | ||
51 | .Vt SSL | ||
52 | objects created from this | ||
53 | .Vt SSL_CTX | ||
54 | object). | ||
55 | .Sh RETURN VALUES | ||
56 | The following return values can occur: | ||
57 | .Bl -tag -width Ds | ||
58 | .It 0 | ||
59 | The operation failed; check the error stack to find out the reason. | ||
60 | .It 1 | ||
61 | The operation succeeded. | ||
62 | .El | ||
63 | .Sh SEE ALSO | ||
64 | .Xr ssl 3 , | ||
65 | .Xr SSL_CTX_set_session_cache_mode 3 , | ||
66 | .Xr SSL_get_session 3 , | ||
67 | .Xr SSL_SESSION_free 3 , | ||
68 | .Xr SSL_session_reused 3 | ||