| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "BIO_GET_EX_NEW_INDEX 3SSL" |
| 58 |
.TH BIO_GET_EX_NEW_INDEX 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
BIO_get_ex_new_index, BIO_set_ex_data, BIO_get_ex_data, |
| 65 |
BIO_set_app_data, BIO_get_app_data, |
| 66 |
DH_get_ex_new_index, DH_set_ex_data, DH_get_ex_data, |
| 67 |
DSA_get_ex_new_index, DSA_set_ex_data, DSA_get_ex_data, |
| 68 |
EC_KEY_get_ex_new_index, EC_KEY_set_ex_data, EC_KEY_get_ex_data, |
| 69 |
ENGINE_get_ex_new_index, ENGINE_set_ex_data, ENGINE_get_ex_data, |
| 70 |
EVP_PKEY_get_ex_new_index, EVP_PKEY_set_ex_data, EVP_PKEY_get_ex_data, |
| 71 |
RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data, |
| 72 |
RSA_set_app_data, RSA_get_app_data, |
| 73 |
SSL_get_ex_new_index, SSL_set_ex_data, SSL_get_ex_data, |
| 74 |
SSL_set_app_data, SSL_get_app_data, |
| 75 |
SSL_CTX_get_ex_new_index, SSL_CTX_set_ex_data, SSL_CTX_get_ex_data, |
| 76 |
SSL_CTX_set_app_data, SSL_CTX_get_app_data, |
| 77 |
SSL_SESSION_get_ex_new_index, SSL_SESSION_set_ex_data, SSL_SESSION_get_ex_data, |
| 78 |
SSL_SESSION_set_app_data, SSL_SESSION_get_app_data, |
| 79 |
UI_get_ex_new_index, UI_set_ex_data, UI_get_ex_data, |
| 80 |
UI_set_app_data, UI_get_app_data, |
| 81 |
X509_STORE_CTX_get_ex_new_index, X509_STORE_CTX_set_ex_data, X509_STORE_CTX_get_ex_data, |
| 82 |
X509_STORE_CTX_set_app_data, X509_STORE_CTX_get_app_data, |
| 83 |
X509_STORE_get_ex_new_index, X509_STORE_set_ex_data, X509_STORE_get_ex_data, |
| 84 |
X509_get_ex_new_index, X509_set_ex_data, X509_get_ex_data |
| 85 |
\&\- application\-specific data |
| 86 |
.SH SYNOPSIS |
| 87 |
.IX Header "SYNOPSIS" |
| 88 |
.Vb 1 |
| 89 |
\& #include <openssl/x509.h> |
| 90 |
\& |
| 91 |
\& int TYPE_get_ex_new_index(long argl, void *argp, |
| 92 |
\& CRYPTO_EX_new *new_func, |
| 93 |
\& CRYPTO_EX_dup *dup_func, |
| 94 |
\& CRYPTO_EX_free *free_func); |
| 95 |
\& |
| 96 |
\& int TYPE_set_ex_data(TYPE *d, int idx, void *arg); |
| 97 |
\& |
| 98 |
\& void *TYPE_get_ex_data(const TYPE *d, int idx); |
| 99 |
\& |
| 100 |
\& #define TYPE_set_app_data(TYPE *d, void *arg) |
| 101 |
\& #define TYPE_get_app_data(TYPE *d) |
| 102 |
.Ve |
| 103 |
.PP |
| 104 |
The following functions have been deprecated since OpenSSL 3.0, and can be |
| 105 |
hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, |
| 106 |
see \fBopenssl_user_macros\fR\|(7): |
| 107 |
.PP |
| 108 |
.Vb 10 |
| 109 |
\& int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
| 110 |
\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); |
| 111 |
\& int DH_set_ex_data(DH *type, int idx, void *arg); |
| 112 |
\& void *DH_get_ex_data(DH *type, int idx); |
| 113 |
\& int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
| 114 |
\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); |
| 115 |
\& int DSA_set_ex_data(DSA *type, int idx, void *arg); |
| 116 |
\& void *DSA_get_ex_data(DSA *type, int idx); |
| 117 |
\& int EC_KEY_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
| 118 |
\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); |
| 119 |
\& int EC_KEY_set_ex_data(EC_KEY *type, int idx, void *arg); |
| 120 |
\& void *EC_KEY_get_ex_data(EC_KEY *type, int idx); |
| 121 |
\& int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
| 122 |
\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); |
| 123 |
\& int RSA_set_ex_data(RSA *type, int idx, void *arg); |
| 124 |
\& void *RSA_get_ex_data(RSA *type, int idx); |
| 125 |
\& int RSA_set_app_data(RSA *type, void *arg); |
| 126 |
\& void *RSA_get_app_data(RSA *type); |
| 127 |
\& int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
| 128 |
\& CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); |
| 129 |
\& int ENGINE_set_ex_data(ENGINE *type, int idx, void *arg); |
| 130 |
\& void *ENGINE_get_ex_data(ENGINE *type, int idx); |
| 131 |
.Ve |
| 132 |
.SH DESCRIPTION |
| 133 |
.IX Header "DESCRIPTION" |
| 134 |
In the description here, \fITYPE\fR is used a placeholder |
| 135 |
for any of the OpenSSL datatypes listed in \fBCRYPTO_get_ex_new_index\fR\|(3). |
| 136 |
.PP |
| 137 |
All functions with a \fITYPE\fR of \fBDH\fR, \fBDSA\fR, \fBRSA\fR and \fBEC_KEY\fR are deprecated. |
| 138 |
Applications should instead use \fBEVP_PKEY_set_ex_data()\fR, |
| 139 |
\&\fBEVP_PKEY_get_ex_data()\fR and \fBEVP_PKEY_get_ex_new_index()\fR. |
| 140 |
.PP |
| 141 |
All functions with a \fITYPE\fR of \fBENGINE\fR are deprecated. |
| 142 |
Applications using engines should be replaced by providers. |
| 143 |
.PP |
| 144 |
These functions handle application-specific data for OpenSSL data |
| 145 |
structures. |
| 146 |
.PP |
| 147 |
\&\fBTYPE_get_ex_new_index()\fR is a macro that calls \fBCRYPTO_get_ex_new_index()\fR |
| 148 |
with the correct \fBindex\fR value. |
| 149 |
.PP |
| 150 |
\&\fBTYPE_set_ex_data()\fR is a function that calls \fBCRYPTO_set_ex_data()\fR with |
| 151 |
an offset into the opaque exdata part of the TYPE object. \fId\fR \fBMUST NOT\fR be NULL. |
| 152 |
.PP |
| 153 |
\&\fBTYPE_get_ex_data()\fR is a function that calls \fBCRYPTO_get_ex_data()\fR with |
| 154 |
an offset into the opaque exdata part of the TYPE object. \fId\fR \fBMUST NOT\fR be NULL. |
| 155 |
.PP |
| 156 |
For compatibility with previous releases, the exdata index of zero is |
| 157 |
reserved for "application data." There are two convenience functions for |
| 158 |
this. |
| 159 |
\&\fBTYPE_set_app_data()\fR is a macro that invokes \fBTYPE_set_ex_data()\fR with |
| 160 |
\&\fBidx\fR set to zero. |
| 161 |
\&\fBTYPE_get_app_data()\fR is a macro that invokes \fBTYPE_get_ex_data()\fR with |
| 162 |
\&\fBidx\fR set to zero. |
| 163 |
.SH "RETURN VALUES" |
| 164 |
.IX Header "RETURN VALUES" |
| 165 |
\&\fBTYPE_get_ex_new_index()\fR returns a new index on success or \-1 on error. |
| 166 |
.PP |
| 167 |
\&\fBTYPE_set_ex_data()\fR returns 1 on success or 0 on error. |
| 168 |
.PP |
| 169 |
\&\fBTYPE_get_ex_data()\fR returns the application data or NULL if an error occurred. |
| 170 |
.SH "SEE ALSO" |
| 171 |
.IX Header "SEE ALSO" |
| 172 |
\&\fBCRYPTO_get_ex_new_index\fR\|(3). |
| 173 |
.SH HISTORY |
| 174 |
.IX Header "HISTORY" |
| 175 |
The functions \fBDH_get_ex_new_index()\fR, \fBDH_set_ex_data()\fR, \fBDH_get_ex_data()\fR, |
| 176 |
\&\fBDSA_get_ex_new_index()\fR, \fBDSA_set_ex_data()\fR, \fBDSA_get_ex_data()\fR, |
| 177 |
\&\fBEC_KEY_get_ex_new_index()\fR, \fBEC_KEY_set_ex_data()\fR, \fBEC_KEY_get_ex_data()\fR, |
| 178 |
\&\fBENGINE_get_ex_new_index()\fR, \fBENGINE_set_ex_data()\fR, \fBENGINE_get_ex_data()\fR, |
| 179 |
\&\fBRSA_get_ex_new_index()\fR, \fBRSA_set_ex_data()\fR, \fBRSA_get_ex_data()\fR, |
| 180 |
\&\fBRSA_set_app_data()\fR and \fBRSA_get_app_data()\fR were deprecated in OpenSSL 3.0. |
| 181 |
.SH COPYRIGHT |
| 182 |
.IX Header "COPYRIGHT" |
| 183 |
Copyright 2015\-2021 The OpenSSL Project Authors. All Rights Reserved. |
| 184 |
.PP |
| 185 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 186 |
this file except in compliance with the License. You can obtain a copy |
| 187 |
in the file LICENSE in the source distribution or at |
| 188 |
<https://www.openssl.org/source/license.html>. |