OpenSSL-Related Configuration

OpenSSL-Related Configuration. More...

Data Structures
struct	NDDS_Transport_TLS_Verification
	Set of TLS properties for certificate authorities (CAs) and verification. More...
struct	NDDS_Transport_TLS_Identity
	Set of TLS properties for identity. More...
struct	NDDS_Transport_TLS_DHParamFile
	Name of a Diffie-Helman (DH) key file and the length of the contained key in bits. More...
struct	NDDS_Transport_TLS_Ciphers
	Set of TLS properties for cipher configuration. More...
struct	NDDS_Transport_TLS_OpenSSL_Configuration
	Full set of TLS properties. More...

Macros
#define	NDDS_TRANSPORT_TLS_VERIFY_DEFAULT
	Use this to initialize a NDDS_Transport_TLS_Verfication structure.
#define	NDDS_TRANSPORT_TLS_IDENTITY_DEFAULT
	Use this to initialize a NDDS_Transport_TLS_Identity structure.
#define	NDDS_TRANSPORT_TLS_CIPHER_DEFAULT
	Use this to initialize a NDDS_Transport_TLS_Chiphers structure.
#define	NDDS_TRANSPORT_TLS_OPENSSL_CONFIGURATION_DEFAULT
	Use this to initialize a NDDS_Transport_TLS_OpenSSL_Configuration structure.

Typedefs
typedef int(*	NDDS_Transport_TLS_Verify_Callback )(int preverify_ok, X509_STORE_CTX *x509_ctx)
	Callback used to verify peer certificates.

Functions
NDDS_Transport_TLS_DllExport void	NDDS_Transport_TLS_thread_exit ()
	clean up OpenSSL resources for current thread (call before exit)
int	NDDS_Transport_TLS_default_verify_callback (int ok, X509_STORE_CTX *store)
	Default verify callback: log errors when verification fails.
int	NDDS_Transport_TLS_verbose_verify_callback (int ok, X509_STORE_CTX *store)
	Verbose verify callback: log information about successful verification as well as errors when verification fails.

Detailed Description

OpenSSL-Related Configuration.

The DTLS security components are implemented by the OpenSSL library. Proper DTLS support requires at least version 0.9.8f of OpenSSL.

Macro Definition Documentation

#define NDDS_TRANSPORT_TLS_VERIFY_DEFAULT

Value:

{ \
    NULL, NULL, NULL,/* ca_file, ca_path, ca */ \
    -1, /* verify_depth (no depth limit) */ \
    0, /* verify_peer (NOT mutual) */ \
    NULL /* callback (use default verify callback) */ }

Use this to initialize a NDDS_Transport_TLS_Verfication structure.

#define NDDS_TRANSPORT_TLS_IDENTITY_DEFAULT

Value:

{ \
    NULL, /* certificate_chain_file */ \
    NULL, /* certificate_chain */ \
    NULL, /* private_key_password */ \
    NULL, /* private_key_file */ \
    NULL, /* private_key */ \
    NULL /* rsa_private_key_file */ }

Use this to initialize a NDDS_Transport_TLS_Identity structure.

#define NDDS_TRANSPORT_TLS_CIPHER_DEFAULT

Value:

{ \
    NULL, /* cipher_list (default cipher list) */ \
    0, NULL, /* dh_param_files_length, dh_param_files (no DH params) */ \
    NULL, /* engine_id (no engine) */ \
    0, NULL, NULL, /* engine_pre_cmd_length, engine_pre_cmd_names, engine_pre_cmd_parameters */ \
    0, NULL, NULL /* engine_post_cmd_length, engine_post_cmd_names, engeine_post_cmd_parameters */ }

Use this to initialize a NDDS_Transport_TLS_Chiphers structure.

#define NDDS_TRANSPORT_TLS_OPENSSL_CONFIGURATION_DEFAULT

Value:

{ \
    NDDS_TRANSPORT_TLS_VERIFY_DEFAULT, /* verify */ \
    NDDS_TRANSPORT_TLS_IDENTITY_DEFAULT, /* identity */ \
    NDDS_TRANSPORT_TLS_CIPHER_DEFAULT, /* cipher */ \
    NDDS_TRANSPORT_TLS_RENEGOTIATE_DEFAULT /* renegotiate */ }

Use this to initialize a NDDS_Transport_TLS_OpenSSL_Configuration structure.

Typedef Documentation

typedef int(* NDDS_Transport_TLS_Verify_Callback)(int preverify_ok, X509_STORE_CTX *x509_ctx)

Callback used to verify peer certificates.

See the OpenSSL manual page for SSL_CTX_set_verify for more information.

Function Documentation

NDDS_Transport_TLS_DllExport void NDDS_Transport_TLS_thread_exit

(

)

clean up OpenSSL resources for current thread (call before exit)

int NDDS_Transport_TLS_default_verify_callback	(	int	ok,
		X509_STORE_CTX *	store
	)

Default verify callback: log errors when verification fails.

See the OpenSSL manual page for SSL_CTX_set_verify for more information.

int NDDS_Transport_TLS_verbose_verify_callback	(	int	ok,
		X509_STORE_CTX *	store
	)

Verbose verify callback: log information about successful verification as well as errors when verification fails.

See the OpenSSL manual page for SSL_CTX_set_verify for more information.