lib/libcrypto/man/BIO_get_ex_new_index.3

   1 .\"     $OpenBSD: BIO_get_ex_new_index.3,v 1.3 2017/01/06 20:35:23 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Rich Salz <rsalz@akamai.com>.
   5 .\" Copyright (c) 2015, 2016 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: January 6 2017 $
  52 .Dt BIO_GET_EX_NEW_INDEX 3
  53 .Os
  54 .Sh NAME
  55 .Nm BIO_get_ex_new_index ,
  56 .Nm BIO_set_ex_data ,
  57 .Nm BIO_get_ex_data ,
  58 .Nm ENGINE_get_ex_new_index ,
  59 .Nm ENGINE_set_ex_data ,
  60 .Nm ENGINE_get_ex_data ,
  61 .Nm UI_get_ex_new_index ,
  62 .Nm UI_set_ex_data ,
  63 .Nm UI_get_ex_data ,
  64 .Nm X509_get_ex_new_index ,
  65 .Nm X509_set_ex_data ,
  66 .Nm X509_get_ex_data ,
  67 .Nm ECDH_get_ex_new_index ,
  68 .Nm ECDH_set_ex_data ,
  69 .Nm ECDH_get_ex_data ,
  70 .Nm ECDSA_get_ex_new_index ,
  71 .Nm ECDSA_set_ex_data ,
  72 .Nm ECDSA_get_ex_data
  73 .Nd application-specific data
  74 .Sh SYNOPSIS
  75 .In openssl/x509.h
  76 .Ft int
  77 .Fo TYPE_get_ex_new_index
  78 .Fa "long argl"
  79 .Fa "void *argp"
  80 .Fa "CRYPTO_EX_new *new_func"
  81 .Fa "CRYPTO_EX_dup *dup_func"
  82 .Fa "CRYPTO_EX_free *free_func"
  83 .Fc
  84 .Ft int
  85 .Fo TYPE_set_ex_data
  86 .Fa "TYPE *d"
  87 .Fa "int idx"
  88 .Fa "void *arg"
  89 .Fc
  90 .Ft void *
  91 .Fo TYPE_get_ex_data
  92 .Fa "TYPE *d"
  93 .Fa "int idx"
  94 .Fc
  95 .Sh DESCRIPTION
  96 In the description here,
  97 .Vt TYPE
  98 is used a placeholder for any of the OpenSSL datatypes listed in
  99 .Xr CRYPTO_get_ex_new_index 3 .
 100 .Pp
 101 These functions handle application-specific data for OpenSSL data
 102 structures.
 103 .Pp
 104 .Fn TYPE_get_ex_new_index
 105 is a macro that calls
 106 .Xr CRYPTO_get_ex_new_index 3
 107 with the correct index value.
 108 .Pp
 109 .Fn TYPE_set_ex_data
 110 is a function that calls
 111 .Xr CRYPTO_set_ex_data 3
 112 with an offset into the opaque exdata part of the
 113 .Vt TYPE
 114 object.
 115 .Pp
 116 .Fn TYPE_get_ex_data
 117 is a function that calls
 118 .Xr CRYPTO_get_ex_data 3
 119 with an offset into the opaque exdata part of the
 120 .Vt TYPE
 121 object.
 122 .Sh SEE ALSO
 123 .Xr CRYPTO_get_ex_new_index 3 ,
 124 .Xr RSA_get_ex_new_index 3