xref: /freebsd/crypto/openssl/doc/man3/SSL_SESSION_get_time.pod (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1=pod
2
3=head1 NAME
4
5SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout,
6SSL_SESSION_set_timeout,
7SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout
8- retrieve and manipulate session time and timeout settings
9
10=head1 SYNOPSIS
11
12 #include <openssl/ssl.h>
13
14 long SSL_SESSION_get_time(const SSL_SESSION *s);
15 long SSL_SESSION_set_time(SSL_SESSION *s, long tm);
16 long SSL_SESSION_get_timeout(const SSL_SESSION *s);
17 long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm);
18
19 long SSL_get_time(const SSL_SESSION *s);
20 long SSL_set_time(SSL_SESSION *s, long tm);
21 long SSL_get_timeout(const SSL_SESSION *s);
22 long SSL_set_timeout(SSL_SESSION *s, long tm);
23
24=head1 DESCRIPTION
25
26SSL_SESSION_get_time() returns the time at which the session B<s> was
27established. The time is given in seconds since the Epoch and therefore
28compatible to the time delivered by the time() call.
29
30SSL_SESSION_set_time() replaces the creation time of the session B<s> with
31the chosen value B<tm>.
32
33SSL_SESSION_get_timeout() returns the timeout value set for session B<s>
34in seconds.
35
36SSL_SESSION_set_timeout() sets the timeout value for session B<s> in seconds
37to B<tm>.
38
39The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout()
40functions are synonyms for the SSL_SESSION_*() counterparts.
41
42=head1 NOTES
43
44Sessions are expired by examining the creation time and the timeout value.
45Both are set at creation time of the session to the actual time and the
46default timeout value at creation, respectively, as set by
47L<SSL_CTX_set_timeout(3)>.
48Using these functions it is possible to extend or shorten the lifetime
49of the session.
50
51=head1 RETURN VALUES
52
53SSL_SESSION_get_time() and SSL_SESSION_get_timeout() return the currently
54valid values.
55
56SSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success.
57
58If any of the function is passed the NULL pointer for the session B<s>,
590 is returned.
60
61=head1 SEE ALSO
62
63L<ssl(7)>,
64L<SSL_CTX_set_timeout(3)>,
65L<SSL_get_default_timeout(3)>
66
67=head1 COPYRIGHT
68
69Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
70
71Licensed under the Apache License 2.0 (the "License").  You may not use
72this file except in compliance with the License.  You can obtain a copy
73in the file LICENSE in the source distribution or at
74L<https://www.openssl.org/source/license.html>.
75
76=cut
77