skip book previous and next navigation links
go up to top of book: HP Open Source Security for OpenVMS Volume 2:... HP Open Source Security for OpenVMS Volume 2:...
go to beginning of reference: SSL Application Programming Interface (API) Reference SSL Application Programming Interface (API) Reference
go to previous page: SSL_get_error SSL_get_error
go to next page: SSL_get_ex_new_indexSSL_get_ex_new_index
end of book navigation links


SSL_get_ex_data_X509_STORE_CTX_idx
Description
Return Values
See Also
 Notes
Examples

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);


return to top 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.


return to top 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.


return to top RETURN VALUES  


return to top 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) ,


return to top SEE ALSO  

ssl(3) , SSL_CTX_set_verify(3) , CRYPTO_set_ex_data(3)
go to previous page: SSL_get_error SSL_get_error
go to next page: SSL_get_ex_new_indexSSL_get_ex_new_index