NAME

SSL_SESSION_get_ex_new_index, SSL_SESSION_set_ex_data, SSL_SESSION_get_ex_data − Unternal application specific data functions

SYNOPSIS

#include <openssl/ssl.h>
int SSL_SESSION_get_ex_new_index(
        long argl, void ∗argp, CRYPTO_EX_new ∗new_func,                  CRYPTO_EX_dup ∗dup_func, CRYPTO_EX_free ∗free_func ); int SSL_SESSION_set_ex_data(
        SSL_SESSION ∗session, int idx, void ∗arg ); void ∗SSL_SESSION_get_ex_data(
        SSL_SESSION ∗session, int idx ); typedef int new_func(
        void ∗parent, void ∗ptr, CRYPTO_EX_DATA ∗ad, int idx, long argl, void ∗argp ); typedef void free_func(
        oid ∗parent, void ∗ptr, CRYPTO_EX_DATA ∗ad, int idx, long argl, void ∗argp ); typedef int dup_func(
        CRYPTO_EX_DATA ∗to, CRYPTO_EX_DATA ∗from, void ∗from_d,                  int idx, long argl, void ∗argp );

DESCRIPTION

Several OpenSSL structures can have application specific data attached to them. These functions are used internally by OpenSSL to manipulate application specific data attached to a specific structure. 

The SSL_SESSION_get_ex_new_index() function is used to register a new index for application specific data. 

The SSL_SESSION_set_ex_data() function is used to store application data at arg for idx into the session object. 

The SSL_SESSION_get_ex_data() function is used to retrieve the information for idx from session. 

A detailed description for the ∗_get_ex_new_index() functionality can be found in RSA_get_ex_new_index(). The ∗_get_ex_data() and ∗_set_ex_data() functionality is described in CRYPTO_set_ex_data(). 

RESTRICTIONS

The application data is only maintained for sessions held in memory.  The application data is not included when dumping the session with the i2d_SSL_SESSION() function, as well as all functions indirectly calling the dump functions, such as the PEM_write_SSL_SESSION() and PEM_write_bio_SSL_SESSION()functions. It cannot  be restored. 

SEE ALSO

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