Dialogic Global Call IP Benutzerhandbuch
562
Dialogic
®
Global Call API Library Reference — November 2007
Dialogic Corporation
SIP_TLS_ENGINE — TLS engine configuration information
SIP_TLS_ENGINE
TLS engine configuration information
typedef struct
{
unsigned long version; /* system use only */
unsigned short sip_tls_port;
EnumSIP_TLS_METHOD E_sip_tls_method;
char * local_rsa_private_key_filename;
char * local_rsa_private_key_password;
char * local_rsa_cert_filename;
char * local_dss_private_key_filename;
char * local_dss_private_key_password;
char * local_dss_cert_filename;
unsigned int ca_cert_number;
char ** ca_cert_filename;
unsigned int chain_cert_number;
char ** chain_cert_filename;
unsigned int crl_number;
char ** crl_filename;
char * local_cipher_suite;
char * dh_param_512_filename;
char * dh_param_1024_filename;
char * session_id;
EnumSIP_Enabled E_client_cert_required;
EnumSIP_Enabled E_block_udp_port;
EnumSIP_Enabled E_block_tcp_port;
} SIP_TLS_ENGINE;
{
unsigned long version; /* system use only */
unsigned short sip_tls_port;
EnumSIP_TLS_METHOD E_sip_tls_method;
char * local_rsa_private_key_filename;
char * local_rsa_private_key_password;
char * local_rsa_cert_filename;
char * local_dss_private_key_filename;
char * local_dss_private_key_password;
char * local_dss_cert_filename;
unsigned int ca_cert_number;
char ** ca_cert_filename;
unsigned int chain_cert_number;
char ** chain_cert_filename;
unsigned int crl_number;
char ** crl_filename;
char * local_cipher_suite;
char * dh_param_512_filename;
char * dh_param_1024_filename;
char * session_id;
EnumSIP_Enabled E_client_cert_required;
EnumSIP_Enabled E_block_udp_port;
EnumSIP_Enabled E_block_tcp_port;
} SIP_TLS_ENGINE;
Description
The SIP_TLS_ENGINE data structure is used to specify a set of parameters that are used for SIP
Transport Layer Security (TLS). To enable the SIP TLS feature, an application configures an
Transport Layer Security (TLS). To enable the SIP TLS feature, an application configures an
structure to reference a SIP_TLS_ENGINE structure before calling gc_Start( ).
If TLS is not required, the sip_tls_engine field in IP_VIRTBOARD should be NULL.
Applications should use the INIT_SIP_TLS_ENGINE( ) function to initialize a
SIP_TLS_ENGINE structure with the correct version number and initial field values. The
application must then configure the structure to specify the certificates required for TLS server
and/or TLS client operation before calling gc_Start( ). Failure to configure the minimum
certificate requirements for either server or client operation will prevent the Dialogic
SIP_TLS_ENGINE structure with the correct version number and initial field values. The
application must then configure the structure to specify the certificates required for TLS server
and/or TLS client operation before calling gc_Start( ). Failure to configure the minimum
certificate requirements for either server or client operation will prevent the Dialogic
®
Global Call
API library from starting; the gc_Start( ) call will fail with error
IPERR_INVALID_TLS_PARAM.
IPERR_INVALID_TLS_PARAM.
Field Descriptions
The fields of the SIP_TLS_ENGINE data structure are described as follows:
version
the version number of the data structure; the correct value is set by the
INIT_SIP_TLS_ENGINE( ) initialization function and should not be overridden by
applications
INIT_SIP_TLS_ENGINE( ) initialization function and should not be overridden by
applications
sip_tls_port
port number of TLS port Global Call will listen to. Default port number is 5061.
sip_tls_method
indicates the version of SSL to use. Defined enumerations are: