lib/libssl/man/SSL_get_default_timeout.3

   1 .\"     $OpenBSD: SSL_get_default_timeout.3,v 1.3 2018/03/21 05:07:04 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2001, 2005 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: March 21 2018 $
  52 .Dt SSL_GET_DEFAULT_TIMEOUT 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_get_default_timeout
  56 .Nd get default session timeout value
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft long
  60 .Fn SSL_get_default_timeout "const SSL *ssl"
  61 .Sh DESCRIPTION
  62 .Fn SSL_get_default_timeout
  63 returns the default timeout value assigned to
  64 .Vt SSL_SESSION
  65 objects negotiated for the protocol valid for
  66 .Fa ssl .
  67 .Pp
  68 Whenever a new session is negotiated, it is assigned a timeout value,
  69 after which it will not be accepted for session reuse.
  70 If the timeout value was not explicitly set using
  71 .Xr SSL_CTX_set_timeout 3 ,
  72 the hardcoded default timeout for the protocol will be used.
  73 .Pp
  74 .Fn SSL_get_default_timeout
  75 return this hardcoded value, which is 300 seconds for all currently supported
  76 protocols (SSLv2, SSLv3, and TLSv1).
  77 .Sh SEE ALSO
  78 .Xr ssl 3 ,
  79 .Xr SSL_CTX_flush_sessions 3 ,
  80 .Xr SSL_CTX_set_session_cache_mode 3 ,
  81 .Xr SSL_SESSION_get_time 3
  82 .Sh HISTORY
  83 .Fn SSL_get_default_timeout
  84 appeared before SSLeay 0.8 and has been available since
  85 .Ox 2.4 .