lib/libssl/man/SSL_CTX_free.3

   1 .\"     $OpenBSD: SSL_CTX_free.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) 2000, 2001, 2003 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_CTX_FREE 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_free
  56 .Nd free an allocated SSL_CTX object
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft void
  60 .Fn SSL_CTX_free "SSL_CTX *ctx"
  61 .Sh DESCRIPTION
  62 .Fn SSL_CTX_free
  63 decrements the reference count of
  64 .Fa ctx ,
  65 and removes the
  66 .Vt SSL_CTX
  67 object pointed to by
  68 .Fa ctx
  69 and frees up the allocated memory if the reference count has reached 0.
  70 If
  71 .Fa ctx
  72 is a
  73 .Dv NULL
  74 pointer, no action occurs.
  75 .Pp
  76 It also calls the
  77 .Xr free 3 Ns ing
  78 procedures for indirectly affected items, if applicable:
  79 the session cache, the list of ciphers, the list of Client CAs,
  80 the certificates and keys.
  81 .Sh WARNINGS
  82 If a session-remove callback is set
  83 .Pq Xr SSL_CTX_sess_set_remove_cb 3 ,
  84 this callback will be called for each session being freed from
  85 .Fa ctx Ns 's
  86 session cache.
  87 This implies that all corresponding sessions from an external session cache are
  88 removed as well.
  89 If this is not desired, the user should explicitly unset the callback by
  90 calling
  91 .Fn SSL_CTX_sess_set_remove_cb ctx NULL
  92 prior to calling
  93 .Fn SSL_CTX_free .
  94 .Sh SEE ALSO
  95 .Xr ssl 3 ,
  96 .Xr SSL_CTX_new 3 ,
  97 .Xr SSL_CTX_sess_set_get_cb 3
  98 .Sh HISTORY
  99 .Fn SSL_CTX_free
 100 appeared before SSLeay 0.8 and has been available since
 101 .Ox 2.4 .