DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

/usr/man/cat.3/CRYPTO_set_ex_data.3




CRYPTO_set_ex_data(3)        OpenSSL        CRYPTO_set_ex_data(3)


NAME

     CRYPTO_set_ex_data, CRYPTO_get_ex_data - internal
     application specific data functions


SYNOPSIS

      #include <openssl/crypto.h>

      int CRYPTO_set_ex_data(CRYPTO_EX_DATA *r, int idx, void *arg);

      void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *r, int idx);


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.

     These functions should only be used by applications to
     manipulate CRYPTO_EX_DATA structures passed to the
     nneeww_ffuunncc(()), ffrreeee_ffuunncc(()) and dduupp_ffuunncc(()) callbacks: as passed
     to RRSSAA_ggeett_eexx_nneeww_iinnddeexx(()) for example.

     CCRRYYPPTTOO_sseett_eexx_ddaattaa(()) is used to set application specific
     data, the data is supplied in the arg parameter and its
     precise meaning is up to the application.

     CCRRYYPPTTOO_ggeett_eexx_ddaattaa(()) is used to retrieve application
     specific data. The data is returned to the application, this
     will be the same value as supplied to a previous
     CCRRYYPPTTOO_sseett_eexx_ddaattaa(()) call.


RETURN VALUES

     CCRRYYPPTTOO_sseett_eexx_ddaattaa(()) returns 1 on success or 0 on failure.

     CCRRYYPPTTOO_ggeett_eexx_ddaattaa(()) returns the application data or 0 on
     failure. 0 may also be valid application data but currently
     it can only fail if given an invalid idx parameter.

     On failure an error code can be obtained from
     ERR_get_error(3).


SEE ALSO

     RSA_get_ex_new_index(3), DSA_get_ex_new_index(3),
     DH_get_ex_new_index(3)


HISTORY

     CRYPTO_set_ex_data() and CRYPTO_get_ex_data() have been
     available since SSLeay 0.9.0.

1.0.2t               Last change: 2019-09-10                    1

See also CRYPTO_get_ex_data(3)

Man(1) output converted with man2html