	RSA BSAFE Micro Edition Suite	Streamlined security for mobile and embedded devices

Functions

This section contains information on the MES library functions.

Functions
char*	MES_library_info (int type)
	Returns library information such as version, compile flags and the date the library was built. More...
int	MES_library_version ()
	The version number of the library. More...
char*	MES_library_info_type_to_string (int type)
	Returns a string corresponding to the type of library information. More...
int	MES_library_info_type_from_string (char *str)
	Returns the integer type to use as a parameter in MES_library_info() when querying the library for build or version information. More...
int	MES_library_new (R_RES_LIST r_list, int flag, R_LIB_CTX *lib_ctx)
	Creates a new library context. More...
int	MES_library_free (R_LIB_CTX *lib_ctx)
	Deallocates the library context structure lib_ctx and frees any associated state. More...
int	PRODUCT_LIBRARY_NEW (R_RES_LIST r_list, int flag, R_LIB_CTX *lib_ctx)
	Creates a new library context. More...
int	PRODUCT_LIBRARY_FREE (R_LIB_CTX *lib_ctx)
	Deallocates the library context structure lib_ctx and frees any associated state. More...
int	PRODUCT_LIBRARY_VERSION (void)
	The version number of the library. More...
char *	PRODUCT_LIBRARY_INFO (int type)
	Returns library information such as version, compile flags and the date the library was built. More...
int	PRODUCT_LIBRARY_INFO_TYPE_FROM_STRING (char *str)
	Returns the integer type to use as a parameter in MES_library_info() when querying the library for build or version information. More...
char *	PRODUCT_LIBRARY_INFO_TYPE_TO_STRING (int type)
	Returns a string corresponding to the type of library information. More...

Function Documentation

int MES_library_free ( R_LIB_CTX * lib_ctx ) ;

Deallocates the library context structure lib_ctx and frees any associated state.
Parameters:

lib_ctx [In] The R_LIB_CTX returned by the initialization function.

Returns:
R_ERROR_NONE indicates success.
Otherwise indicates error.
See also:
MES_library_new().

char* MES_library_info ( int type ) ;

Returns library information such as version, compile flags and the date the library was built.
Parameters:

type [In] The integer corresponding to the information requested by the user.
See Library Information Type Identifiers for valid values.

Returns:
A character pointer to a string corresponding to the information requested by the user.
NULL indicates corresponding information is unavailable.
See also:
MES_library_info_type_to_string() and MES_library_info_type_from_string().

int MES_library_info_type_from_string ( char * str ) ;

Returns the integer type to use as a parameter in MES_library_info() when querying the library for build or version information.
Parameters:

str [In] A character string describing the type of information to request from the library. One of:

String Description

VERSION The library version number.

DATE The build date for the library.

FLAGS The compile flags used when building the libary.

PLATFORM The platform for which the library was built.

TAG The source tag against which the library was built.

EVAL Indicates whether the build was intended for evaluation only

Returns:
An integer type to use when calling MES_library_info() to obtain information about str.
MES_INFO_UNKNOWN indicates that information is not available.
See also:
MES_library_info_type_to_string() and MES_library_info().

char* MES_library_info_type_to_string ( int type ) ;

Returns a string corresponding to the type of library information.
Parameters:

type [In] An integer corresponding to the library information.
See Library Information Type Identifiers for valid values.

Returns:
A character pointer to the string corresponding to the library information.
NULL indicates corresponding information is unavailable.
See also:
MES_library_info_type_from_string() and MES_library_info().

int MES_library_new ( R_RES_LIST * r_list,

int flag,

R_LIB_CTX ** lib_ctx

) ;

Creates a new library context.
Parameters:

r_list [In] The default resource list to be included in the library.
Must be a valid resource list. One of Functions.

flag [In] Reserved for future use.

lib_ctx [Out] A pointer reference to R_LIB_CTX.

Returns:
R_ERROR_NONE indicates success.
Otherwise indicates error.
See also:
MES_library_free()

int MES_library_version ( void ) ;

The version number of the library. MES_VERSION_NUMBER is set at compile time and can be used to check for compatible interfaces.

Returns:
An integer indicating the library version number.

int PRODUCT_LIBRARY_FREE ( R_LIB_CTX * lib_ctx ) ;

Deallocates the library context structure lib_ctx and frees any associated state.
Parameters:

lib_ctx [In] The R_LIB_CTX returned by the initialization function.

Returns:
R_ERROR_NONE indicates success.
Otherwise indicates error.
See also:
PRODUCT_LIBRARY_NEW().
Samples:
bio_client.c, bio_server.c, cache_server.c, cert.c, cm.c, cm_adv.c, cm_dgst.c, cm_env.c, cm_env_sm.c, cm_env_strm.c, cm_env_strm_membio.c, cm_open.c, cm_open_strm.c, cm_open_strm_cb.c, cm_open_strm_membio.c, cm_sign.c, cm_sign_dgst.c, cm_sign_sm.c, cm_sign_strm.c, cm_smpl.c, cm_strm.c, cm_type.c, cm_vfy_strm_cb.c, evpkey2rpkey.c, ext.c, frombuf.c, nbio_client.c, nbio_server.c, ocsp_req_create.c, ocsp_req_print.c, ocsp_resp_ext.c, ocsp_resp_find_key.c, ocsp_resp_print.c, ocsp_resp_vfy.c, p7ssl_client.c, p7ssl_server.c, pkey.c, r_asym.c, r_asym_buf.c, r_asym_items.c, r_ciph.c, r_dgst.c, r_gnrt.c, r_hmac.c, r_random.c, r_sign.c, r_version.c, rcert2sslcert.c, reslist_set.c, s_crl_check.c, s_crl_verify.c, simple.c, sock_client.c, sock_server.c, ssl_client.c, ssl_server.c, sslcert2rcert.c, store.c, thread.c, verify.c, vfy_adv.c, vfy_bc.c, and vfy_smpl.c.

char * PRODUCT_LIBRARY_INFO ( int type ) ;

Returns library information such as version, compile flags and the date the library was built.
Parameters:

type [In] The integer corresponding to the information requested by the user.
See Library Information Type Identifiers for valid values.

Returns:
A character pointer to a string corresponding to the information requested by the user.
NULL indicates corresponding information is unavailable.
See also:
PRODUCT_LIBRARY_INFO_TYPE_TO_STRING() and PRODUCT_LIBRARY_INFO_TYPE_FROM_STRING().
Samples:
r_version.c.

int PRODUCT_LIBRARY_INFO_TYPE_FROM_STRING ( char * str ) ;

Returns the integer type to use as a parameter in MES_library_info() when querying the library for build or version information.
Parameters:

str [In] A character string describing the type of information to request from the library. One of:

String Description

VERSION The library version number.

DATE The build date for the library.

FLAGS The compile flags used when building the libary.

PLATFORM The platform for which the library was built.

TAG The source tag against which the library was built.

EVAL Indicates whether the build was intended for evaluation only

Returns:
An integer type to use when calling MES_library_info() to obtain information about str.
MES_INFO_UNKNOWN indicates that information is not available.
See also:
PRODUCT_LIBRARY_INFO_TYPE_TO_STRING() and PRODUCT_LIBRARY_INFO().
Samples:
r_version.c.

char * PRODUCT_LIBRARY_INFO_TYPE_TO_STRING ( int type ) ;

Returns a string corresponding to the type of library information.
Parameters:

type [In] An integer corresponding to the library information.
See Library Information Type Identifiers for valid values.

Returns:
A character pointer to the string corresponding to the library information.
NULL indicates corresponding information is unavailable.
See also:
PRODUCT_LIBRARY_INFO_TYPE_FROM_STRING() and PRODUCT_LIBRARY_INFO().

int PRODUCT_LIBRARY_NEW ( R_RES_LIST * r_list,

int flag,

R_LIB_CTX ** lib_ctx

) ;

Creates a new library context.
Parameters:

r_list [In] The default resource list to be included in the library.
Must be a valid resource list. One of Functions.

flag [In] Reserved for future use.

lib_ctx [Out] A pointer reference to R_LIB_CTX.

Returns:
R_ERROR_NONE indicates success.
Otherwise indicates error.
See also:
PRODUCT_LIBRARY_FREE().
Samples:
bio_client.c, bio_server.c, cache_server.c, cert.c, cert_smpl.c, cm.c, cm_adv.c, cm_dgst.c, cm_env.c, cm_env_sm.c, cm_env_strm.c, cm_env_strm_membio.c, cm_open.c, cm_open_strm.c, cm_open_strm_cb.c, cm_open_strm_membio.c, cm_sign.c, cm_sign_dgst.c, cm_sign_sm.c, cm_sign_strm.c, cm_smpl.c, cm_strm.c, cm_type.c, cm_vfy_strm_cb.c, evpkey2rpkey.c, ext.c, frombuf.c, nbio_client.c, nbio_server.c, ocsp_req_create.c, ocsp_req_print.c, ocsp_resp_ext.c, ocsp_resp_find_key.c, ocsp_resp_print.c, ocsp_resp_vfy.c, p7ssl_client.c, p7ssl_server.c, pkey.c, r_asym.c, r_asym_buf.c, r_asym_items.c, r_ciph.c, r_dgst.c, r_gnrt.c, r_hmac.c, r_random.c, r_sign.c, r_version.c, rcert2sslcert.c, req.c, req_smpl.c, reqgen.c, reslist_set.c, s_crl_check.c, s_crl_verify.c, simple.c, sock_client.c, sock_server.c, ssl_client.c, ssl_server.c, sslcert2rcert.c, store.c, thread.c, vfy_adv.c, vfy_bc.c, and vfy_smpl.c.

int PRODUCT_LIBRARY_VERSION ( void ) ;

The version number of the library. MES_VERSION_NUMBER is set at compile time and can be used to check for compatible interfaces.

Returns:
An integer indicating the library version number.
Samples:
r_version.c.