lib/libssl/man/SSL_free.3

   1 .\"     $OpenBSD: SSL_free.3,v 1.2 2016/12/01 22:46:21 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 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 1 2016 $
  52 .Dt SSL_FREE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_free
  56 .Nd free an allocated SSL structure
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft void
  60 .Fn SSL_free "SSL *ssl"
  61 .Sh DESCRIPTION
  62 .Fn SSL_free
  63 decrements the reference count of
  64 .Fa ssl ,
  65 and removes the
  66 .Vt SSL
  67 structure pointed to by
  68 .Fa ssl
  69 and frees up the allocated memory if the reference count has reached 0.
  70 If
  71 .Fa ssl
  72 is a
  73 .Dv NULL
  74 pointer, no action occurs.
  75 .Pp
  76 .Fn SSL_free
  77 also calls the
  78 .Xr free 3 Ns
  79 ing procedures for indirectly affected items, if applicable: the buffering
  80 .Vt BIO ,
  81 the read and write
  82 .Vt BIOs ,
  83 cipher lists specially created for this
  84 .Fa ssl ,
  85 the
  86 .Sy SSL_SESSION .
  87 Do not explicitly free these indirectly freed up items before or after calling
  88 .Fn SSL_free ,
  89 as trying to free things twice may lead to program failure.
  90 .Pp
  91 The
  92 .Fa ssl
  93 session has reference counts from two users: the
  94 .Vt SSL
  95 object, for which the reference count is removed by
  96 .Fn SSL_free
  97 and the internal session cache.
  98 If the session is considered bad, because
  99 .Xr SSL_shutdown 3
 100 was not called for the connection and
 101 .Xr SSL_set_shutdown 3
 102 was not used to set the
 103 .Vt SSL_SENT_SHUTDOWN
 104 state, the session will also be removed from the session cache as required by
 105 RFC2246.
 106 .Sh RETURN VALUES
 107 .Fn SSL_free
 108 does not provide diagnostic information.
 109 .Sh SEE ALSO
 110 .Xr ssl 3 ,
 111 .Xr SSL_clear 3 ,
 112 .Xr SSL_new 3 ,
 113 .Xr SSL_set_shutdown 3 ,
 114 .Xr SSL_shutdown 3