lib/libssl/man/SSL_SESSION_free.3

   1 .\"     $OpenBSD: SSL_SESSION_free.3,v 1.2 2016/12/06 18:53:55 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) 2000, 2001, 2009 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: December 6 2016 $
  52 .Dt SSL_SESSION_FREE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_SESSION_free
  56 .Nd free an allocated SSL_SESSION structure
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft void
  60 .Fn SSL_SESSION_free "SSL_SESSION *session"
  61 .Sh DESCRIPTION
  62 .Fn SSL_SESSION_free
  63 decrements the reference count of
  64 .Fa session
  65 and removes the
  66 .Vt SSL_SESSION
  67 structure pointed to by
  68 .Fa session
  69 and frees up the allocated memory, if the reference count has reached 0.
  70 If
  71 .Fa session
  72 is a
  73 .Dv NULL
  74 pointer, no action occurs.
  75 .Pp
  76 .Vt SSL_SESSION
  77 objects are allocated when a TLS/SSL handshake operation is successfully
  78 completed.
  79 Depending on the settings, see
  80 .Xr SSL_CTX_set_session_cache_mode 3 ,
  81 the
  82 .Vt SSL_SESSION
  83 objects are internally referenced by the
  84 .Vt SSL_CTX
  85 and linked into its session cache.
  86 .Vt SSL
  87 objects may be using the
  88 .Vt SSL_SESSION
  89 object; as a session may be reused, several
  90 .Vt SSL
  91 objects may be using one
  92 .Vt SSL_SESSION
  93 object at the same time.
  94 It is therefore crucial to keep the reference count (usage information) correct
  95 and not delete a
  96 .Vt SSL_SESSION
  97 object that is still used, as this may lead to program failures due to dangling
  98 pointers.
  99 These failures may also appear delayed, e.g., when an
 100 .Vt SSL_SESSION
 101 object is completely freed as the reference count incorrectly becomes 0, but it
 102 is still referenced in the internal session cache and the cache list is
 103 processed during a
 104 .Xr SSL_CTX_flush_sessions 3
 105 operation.
 106 .Pp
 107 .Fn SSL_SESSION_free
 108 must only be called for
 109 .Vt SSL_SESSION
 110 objects, for which the reference count was explicitly incremented (e.g., by
 111 calling
 112 .Xr SSL_get1_session 3 ;
 113 see
 114 .Xr SSL_get_session 3 )
 115 or when the
 116 .Vt SSL_SESSION
 117 object was generated outside a TLS handshake operation, e.g., by using
 118 .Xr d2i_SSL_SESSION 3 .
 119 It must not be called on other
 120 .Vt SSL_SESSION
 121 objects, as this would cause incorrect reference counts and therefore program
 122 failures.
 123 .Sh SEE ALSO
 124 .Xr d2i_SSL_SESSION 3 ,
 125 .Xr SSL_CTX_flush_sessions 3 ,
 126 .Xr SSL_CTX_set_session_cache_mode 3 ,
 127 .Xr SSL_get_session 3 ,
 128 .Xr SSL_SESSION_new 3