summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_SESSION_get_time.3
diff options
context:
space:
mode:
authorschwarze <>2016-11-05 15:32:20 +0000
committerschwarze <>2016-11-05 15:32:20 +0000
commit5af30545c000c195ca6e44f207da004e5780ddb5 (patch)
tree1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_SESSION_get_time.3
parentba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff)
downloadopenbsd-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_SESSION_get_time.3')
-rw-r--r--src/lib/libssl/doc/SSL_SESSION_get_time.398
1 files changed, 0 insertions, 98 deletions
diff --git a/src/lib/libssl/doc/SSL_SESSION_get_time.3 b/src/lib/libssl/doc/SSL_SESSION_get_time.3
deleted file mode 100644
index e906b5ad67..0000000000
--- a/src/lib/libssl/doc/SSL_SESSION_get_time.3
+++ /dev/null
@@ -1,98 +0,0 @@
1.\"
2.\" $OpenBSD: SSL_SESSION_get_time.3,v 1.3 2015/11/11 22:14:40 jmc Exp $
3.\"
4.Dd $Mdocdate: November 11 2015 $
5.Dt SSL_SESSION_GET_TIME 3
6.Os
7.Sh NAME
8.Nm SSL_SESSION_get_time ,
9.Nm SSL_SESSION_set_time ,
10.Nm SSL_SESSION_get_timeout ,
11.Nm SSL_SESSION_set_timeout ,
12.Nm SSL_get_time ,
13.Nm SSL_set_time ,
14.Nm SSL_get_timeout ,
15.Nm SSL_set_timeout
16.Nd retrieve and manipulate session time and timeout settings
17.Sh SYNOPSIS
18.In openssl/ssl.h
19.Ft long
20.Fn SSL_SESSION_get_time "const SSL_SESSION *s"
21.Ft long
22.Fn SSL_SESSION_set_time "SSL_SESSION *s" "long tm"
23.Ft long
24.Fn SSL_SESSION_get_timeout "const SSL_SESSION *s"
25.Ft long
26.Fn SSL_SESSION_set_timeout "SSL_SESSION *s" "long tm"
27.Ft long
28.Fn SSL_get_time "const SSL_SESSION *s"
29.Ft long
30.Fn SSL_set_time "SSL_SESSION *s" "long tm"
31.Ft long
32.Fn SSL_get_timeout "const SSL_SESSION *s"
33.Ft long
34.Fn SSL_set_timeout "SSL_SESSION *s" "long tm"
35.Sh DESCRIPTION
36.Fn SSL_SESSION_get_time
37returns the time at which the session
38.Fa s
39was established.
40The time is given in seconds since the Epoch and therefore compatible to the
41time delivered by the
42.Xr time 3
43call.
44.Pp
45.Fn SSL_SESSION_set_time
46replaces the creation time of the session
47.Fa s
48with
49the chosen value
50.Fa tm .
51.Pp
52.Fn SSL_SESSION_get_timeout
53returns the timeout value set for session
54.Fa s
55in seconds.
56.Pp
57.Fn SSL_SESSION_set_timeout
58sets the timeout value for session
59.Fa s
60in seconds to
61.Fa tm .
62.Pp
63The
64.Fn SSL_get_time ,
65.Fn SSL_set_time ,
66.Fn SSL_get_timeout ,
67and
68.Fn SSL_set_timeout
69functions are synonyms for the
70.Fn SSL_SESSION_*
71counterparts.
72.Sh NOTES
73Sessions are expired by examining the creation time and the timeout value.
74Both are set at creation time of the session to the actual time and the default
75timeout value at creation, respectively, as set by
76.Xr SSL_CTX_set_timeout 3 .
77Using these functions it is possible to extend or shorten the lifetime of the
78session.
79.Sh RETURN VALUES
80.Fn SSL_SESSION_get_time
81and
82.Fn SSL_SESSION_get_timeout
83return the currently valid values.
84.Pp
85.Fn SSL_SESSION_set_time
86and
87.Fn SSL_SESSION_set_timeout
88return 1 on success.
89.Pp
90If any of the function is passed the
91.Dv NULL
92pointer for the session
93.Fa s ,
940 is returned.
95.Sh SEE ALSO
96.Xr ssl 3 ,
97.Xr SSL_CTX_set_timeout 3 ,
98.Xr SSL_get_default_timeout 3