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

The SSL_get_ex_data_X509_STORE_CTX_idx() function returns the index number under which the pointer to the SSL object is stored into the X509_STORE_CTX object. 

NOTES

Whenever an 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 the SSL_get_ex_data_X509_STORE_CTX_idx() function. The index value is set when the SSL_get_ex_data_X509_STORE_CTX_idx() function 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. 

RETURN VALUES

>=0The index value to access the pointer. 

<0An error occurred; check the error stack for a detailed error message. 

EXAMPLES

The index returned from the SSL_get_ex_data_X509_STORE_CTX_idx() function allows you to access the SSL object for the connection to be accessed during the verify_callback() function when checking the peers certificate. Check the example in SSL_CTX_set_verify(3). 

SEE ALSO

Functions: ssl(3), SSL_CTX_set_verify(3), CRYPTO_set_ex_data(3)