SSL_get_ex_new_index - man pages section 3: Extended Library Functions, Volume 1

#include <openssl/ssl.h>

int SSL_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_set_ex_data(SSL *ssl, int idx, void *arg);

void *SSL_get_ex_data(const SSL *ssl, 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

OpenSSL                                         SSL_get_ex_new_index(3openssl)



NAME
       SSL_get_ex_new_index, SSL_set_ex_data, SSL_get_ex_data - internal
       application specific data functions

SYNOPSIS
        #include <openssl/ssl.h>

        int SSL_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_set_ex_data(SSL *ssl, int idx, void *arg);

        void *SSL_get_ex_data(const SSL *ssl, 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_get_ex_new_index() is used to register a new index for application
       specific data.

       SSL_set_ex_data() is used to store application data at arg for idx into
       the ssl object.

       SSL_get_ex_data() is used to retrieve the information for idx from ssl.

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

EXAMPLES
       An example on how to use the functionality is included in the example
       verify_callback() in SSL_CTX_set_verify(3).


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       ssl(3), RSA_get_ex_new_index(3), CRYPTO_set_ex_data(3),
       SSL_CTX_set_verify(3)



NOTES
       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/.



1.0.2ze                           2022-05-03
                                                SSL_get_ex_new_index(3openssl)