SSL_get_ex_data_X509_STORE_CTX_idx - get ex_data index to access SSL structure from X509_STORE_CTX
#include <openssl/ssl.h> int SSL_get_ex_data_X509_STORE_CTX_idx(void);
OpenSSL SSL_get_ex_data_X509_STORE_CTX_idx(3openssl)
NAME
SSL_get_ex_data_X509_STORE_CTX_idx - get ex_data index to access SSL
structure from X509_STORE_CTX
SYNOPSIS
#include <openssl/ssl.h>
int SSL_get_ex_data_X509_STORE_CTX_idx(void);
DESCRIPTION
SSL_get_ex_data_X509_STORE_CTX_idx() returns the index number under
which the pointer to the SSL object is stored into the X509_STORE_CTX
object.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | library/security/openssl |
+---------------+--------------------------+
|Stability | Pass-through uncommitted |
+---------------+--------------------------+
NOTES
Whenever a X509_STORE_CTX object is created for the verification of the
peers certificate during a handshake, a pointer to the SSL object is
stored into the X509_STORE_CTX object to identify the connection
affected. To retrieve this pointer the X509_STORE_CTX_get_ex_data()
function can be used with the correct index. This index is globally the
same for all X509_STORE_CTX objects and can be retrieved using
SSL_get_ex_data_X509_STORE_CTX_idx(). The index value is set when
SSL_get_ex_data_X509_STORE_CTX_idx() is first called either by the
application program directly or indirectly during other SSL setup
functions or during the handshake.
The value depends on other index values defined for X509_STORE_CTX
objects before the SSL index is created.
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.
Further information about this software can be found on the open source
community website at https://www.openssl.org/.
RETURN VALUES
>=0 The index value to access the pointer.
<0 An error occurred, check the error stack for a detailed error
message.
EXAMPLES
The index returned from SSL_get_ex_data_X509_STORE_CTX_idx() allows to
access the SSL object for the connection to be accessed during the
verify_callback() when checking the peers certificate. Please check the
example in SSL_CTX_set_verify(3),
SEE ALSO
ssl(3), SSL_CTX_set_verify(3), CRYPTO_set_ex_data(3)
1.0.2ze 2022-05-03
SSL_get_ex_data_X509_STORE_CTX_idx(3openssl)