CRYPTO_set_ex_data 3 2008-05-09 0.9.9-dev OpenSSL

NAME

CRYPTO_set_ex_data, CRYPTO_get_ex_data - internal application specific data functions

LIBRARY

libcrypto, -lcrypto

SYNOPSIS


 #include 


 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 CCRRYYPPTTOO__EEXX__DDAATTAA structures passed to the _nn_ee_ww____ff_uu_nn_cc_((_)), _ff_rr_ee_ee____ff_uu_nn_cc_((_)) and _dd_uu_pp____ff_uu_nn_cc_((_)) callbacks: as passed to _RR_SS_AA____gg_ee_tt____ee_xx____nn_ee_ww____ii_nn_dd_ee_xx_((_)) for example.

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

_CC_RR_YY_PP_TT_OO____gg_ee_tt____ee_xx____dd_aa_tt_aa_((_)) 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 _CC_RR_YY_PP_TT_OO____ss_ee_tt____ee_xx____dd_aa_tt_aa_((_)) call.

RETURN VALUES

_CC_RR_YY_PP_TT_OO____ss_ee_tt____ee_xx____dd_aa_tt_aa_((_)) returns 1 on success or 0 on failure.

_CC_RR_YY_PP_TT_OO____gg_ee_tt____ee_xx____dd_aa_tt_aa_((_)) 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 iiddxx parameter.

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

SEE ALSO

_R_S_A___g_e_t___e_x___n_e_w___i_n_d_e_x(3), _D_S_A___g_e_t___e_x___n_e_w___i_n_d_e_x(3), _D_H___g_e_t___e_x___n_e_w___i_n_d_e_x(3)

HISTORY

_C_R_Y_P_T_O___s_e_t___e_x___d_a_t_a_(_) and _C_R_Y_P_T_O___g_e_t___e_x___d_a_t_a_(_) have been available since SSLeay 0.9.0.