SSL_SESSION_GET_EX_NEW_INDEX(3) | Library Functions Manual | SSL_SESSION_GET_EX_NEW_INDEX(3)

# NAME

`SSL_SESSION_get_ex_new_index`, `SSL_SESSION_set_ex_data`, `SSL_SESSION_get_ex_data` — internal application specific data functions

# SYNOPSIS

library “libssl” libcrypto
`#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`(const 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(void *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.

`SSL_SESSION_get_ex_new_index`() is used to register a new index for application-specific data.

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

`SSL_SESSION_get_ex_data`() 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(3). The `*_get_ex_data`() and `*_set_ex_data`() functionality is described in CRYPTO_set_ex_data(3).

# WARNINGS

The application data is only maintained for sessions held in memory. The application data is not included when dumping the session with i2d_SSL_SESSION(3) (and all functions indirectly calling the dump functions like PEM_write_SSL_SESSION(3) and PEM_write_bio_SSL_SESSION(3)) and can therefore not be restored.

# SEE ALSO

CRYPTO_set_ex_data(3), RSA_get_ex_new_index(3), ssl(3)

# HISTORY

`SSL_SESSION_get_ex_new_index`(), `SSL_SESSION_set_ex_data`(), and `SSL_SESSION_get_ex_data`() first appeared in SSLeay 0.9.0 and have been available since OpenBSD 2.4.

June 8, 2025 | Debian