lib/libssl/man/SSL_CTX_ctrl.3

   1 .\"     $OpenBSD: SSL_CTX_ctrl.3,v 1.6 2018/03/22 16:07:53 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 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 22 2018 $
  52 .Dt SSL_CTX_CTRL 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_ctrl ,
  56 .Nm SSL_CTX_callback_ctrl ,
  57 .Nm SSL_ctrl ,
  58 .Nm SSL_callback_ctrl
  59 .Nd internal handling functions for SSL_CTX and SSL objects
  60 .Sh SYNOPSIS
  61 .In openssl/ssl.h
  62 .Ft long
  63 .Fn SSL_CTX_ctrl "SSL_CTX *ctx" "int cmd" "long larg" "void *parg"
  64 .Ft long
  65 .Fn SSL_CTX_callback_ctrl "SSL_CTX *" "int cmd" "void (*fp)()"
  66 .Ft long
  67 .Fn SSL_ctrl "SSL *ssl" "int cmd" "long larg" "void *parg"
  68 .Ft long
  69 .Fn SSL_callback_ctrl "SSL *" "int cmd" "void (*fp)()"
  70 .Sh DESCRIPTION
  71 The
  72 .Fn SSL_*_ctrl
  73 family of functions is used to manipulate settings of
  74 the
  75 .Vt SSL_CTX
  76 and
  77 .Vt SSL
  78 objects.
  79 Depending on the command
  80 .Fa cmd
  81 the arguments
  82 .Fa larg ,
  83 .Fa parg ,
  84 or
  85 .Fa fp
  86 are evaluated.
  87 These functions should never be called directly.
  88 All functionalities needed are made available via other functions or macros.
  89 .Sh RETURN VALUES
  90 The return values of the
  91 .Fn SSL*_ctrl
  92 functions depend on the command supplied via the
  93 .Fn cmd
  94 parameter.
  95 .Sh SEE ALSO
  96 .Xr ssl 3 ,
  97 .Xr SSL_CTX_add_extra_chain_cert 3 ,
  98 .Xr SSL_CTX_sess_number 3 ,
  99 .Xr SSL_CTX_sess_set_cache_size 3 ,
 100 .Xr SSL_CTX_set_max_cert_list 3 ,
 101 .Xr SSL_CTX_set_mode 3 ,
 102 .Xr SSL_CTX_set_options 3 ,
 103 .Xr SSL_CTX_set_session_cache_mode 3 ,
 104 .Xr SSL_CTX_set_tlsext_servername_callback 3 ,
 105 .Xr SSL_CTX_set_tlsext_status_cb 3 ,
 106 .Xr SSL_CTX_set_tlsext_ticket_key_cb 3 ,
 107 .Xr SSL_get_server_tmp_key 3 ,
 108 .Xr SSL_num_renegotiations 3 ,
 109 .Xr SSL_session_reused 3 ,
 110 .Xr SSL_set_max_send_fragment 3
 111 .Sh HISTORY
 112 .Fn SSL_CTX_ctrl
 113 and
 114 .Fn SSL_ctrl
 115 appeared before SSLeay 0.8 and have been available since
 116 .Ox 2.4 .
 117 .Pp
 118 .Fn SSL_CTX_callback_ctrl
 119 and
 120 .Fn SSL_callback_ctrl
 121 first appeared in OpenSSL 0.9.5 and have been available since
 122 .Ox 2.7 .