summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/SSL_SESSION_get_time.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/SSL_SESSION_get_time.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/SSL_SESSION_get_time.3')
-rw-r--r--static/netbsd/man3/SSL_SESSION_get_time.3160
1 files changed, 160 insertions, 0 deletions
diff --git a/static/netbsd/man3/SSL_SESSION_get_time.3 b/static/netbsd/man3/SSL_SESSION_get_time.3
new file mode 100644
index 00000000..728a0326
--- /dev/null
+++ b/static/netbsd/man3/SSL_SESSION_get_time.3
@@ -0,0 +1,160 @@
+.\" $NetBSD: SSL_SESSION_get_time.3,v 1.5 2026/04/08 17:06:48 christos Exp $
+.\"
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
+.\" ========================================================================
+.\"
+.IX Title "SSL_SESSION_get_time 3"
+.TH SSL_SESSION_get_time 3 2026-04-07 3.5.6 OpenSSL
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout,
+SSL_SESSION_set_timeout, SSL_SESSION_get_time_ex, SSL_SESSION_set_time_ex,
+SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout
+\&\- retrieve and manipulate session time and timeout settings
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& #include <openssl/ssl.h>
+\&
+\& long SSL_SESSION_get_timeout(const SSL_SESSION *s);
+\& long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm);
+\&
+\& long SSL_get_timeout(const SSL_SESSION *s);
+\& long SSL_set_timeout(SSL_SESSION *s, long tm);
+\&
+\& time_t SSL_SESSION_get_time_ex(const SSL_SESSION *s);
+\& time_t SSL_SESSION_set_time_ex(SSL_SESSION *s, time_t tm);
+.Ve
+.PP
+The following functions have been deprecated since OpenSSL 3.4, and can be
+hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
+see \fBopenssl_user_macros\fR\|(7):
+.PP
+.Vb 4
+\& long SSL_SESSION_get_time(const SSL_SESSION *s);
+\& long SSL_SESSION_set_time(SSL_SESSION *s, long tm);
+\& long SSL_get_time(const SSL_SESSION *s);
+\& long SSL_set_time(SSL_SESSION *s, long tm);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\fBSSL_SESSION_get_time_ex()\fR returns the time at which the session \fBs\fR was
+established. The time is given in seconds since the Epoch and therefore
+compatible to the time delivered by the \fBtime()\fR call.
+.PP
+\&\fBSSL_SESSION_set_time_ex()\fR replaces the creation time of the session \fBs\fR with
+the chosen value \fBtm\fR.
+.PP
+\&\fBSSL_SESSION_get_timeout()\fR returns the timeout value set for session \fBs\fR
+in seconds.
+.PP
+\&\fBSSL_SESSION_set_timeout()\fR sets the timeout value for session \fBs\fR in seconds
+to \fBtm\fR.
+.PP
+\&\fBSSL_SESSION_get_time()\fR and \fBSSL_SESSION_set_time()\fR functions use
+the long datatype instead of time_t and are therefore deprecated due to not
+being Y2038\-safe on 32 bit systems. Note that such systems still need
+to be configured to use 64 bit time_t to be able to avoid overflow in system time.
+.PP
+The \fBSSL_get_time()\fR, \fBSSL_set_time()\fR, \fBSSL_get_timeout()\fR, and \fBSSL_set_timeout()\fR
+functions are synonyms for the SSL_SESSION_*() counterparts.
+.SH NOTES
+.IX Header "NOTES"
+Sessions are expired by examining the creation time and the timeout value.
+Both are set at creation time of the session to the actual time and the
+default timeout value at creation, respectively, as set by
+\&\fBSSL_CTX_set_timeout\fR\|(3).
+Using these functions it is possible to extend or shorten the lifetime
+of the session.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+\&\fBSSL_SESSION_get_time_ex()\fR and \fBSSL_SESSION_get_timeout()\fR return the currently
+valid values.
+.PP
+\&\fBSSL_SESSION_set_time_ex()\fR returns time on success.
+.PP
+\&\fBSSL_SESSION_set_timeout()\fR returns 1 on success.
+.PP
+If any of the function is passed the NULL pointer for the session \fBs\fR,
+0 is returned.
+.SH BUGS
+.IX Header "BUGS"
+The data type long is typically 32 bits on many systems, hence the old
+functions \fBSSL_SESSION_get_time()\fR and \fBSSL_SESSION_set_time()\fR are not always
+Y2038 safe.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBssl\fR\|(7),
+\&\fBSSL_CTX_set_timeout\fR\|(3),
+\&\fBSSL_get_default_timeout\fR\|(3)
+.SH HISTORY
+.IX Header "HISTORY"
+The functions \fBSSL_SESSION_get_time_ex()\fR and \fBSSL_SESSION_set_time_ex()\fR were
+added in OpenSSL 3.3.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2001\-2024 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the Apache License 2.0 (the "License"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file LICENSE in the source distribution or at
+<https://www.openssl.org/source/license.html>.