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