TML Messaging Suite  1.2.0(preview)
C API
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Typedefs | Enumerations | Functions
TML TLS API functions

TML TLS library functions. More...

Typedefs

typedef TML_BOOL(* TML_ON_ACCEPT_TLS_REQUEST_CB_FUNC )(SIDEX_VARIANT vServerName)
 Callback function to accept TLS requests. More...
 
typedef SIDEX_VARIANT(* TML_ON_CERTIFICATE_FILE_LOCATION_CB_FUNC )(SIDEX_VARIANT vServerName)
 Callback function to get TLS certificate file location. More...
 
typedef SIDEX_VARIANT(* TML_ON_CERTIFICATE_PRIVATE_KEY_LOCATION_CB_FUNC )(SIDEX_VARIANT vServerName)
 Callback function to get TLS private key file location. More...
 
typedef void(* TML_ON_TLS_ERROR_CB_FUNC )(TML_CONNECTION_HANDLE connection, SIDEX_VARIANT errorMessage, void *pErrorData)
 Callback function called when an error is found during TLS handshake. More...
 

Enumerations

enum  TmlTlsDigestMethod { TML_TLS_SHA1 = 1, TML_TLS_MD5 = 2, TML_DIGEST_NUM }
 Digest method provided. More...
 

Functions

TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Core_AcceptNegotiation (TML_CORE_HANDLE coreHandle, TML_ON_ACCEPT_TLS_REQUEST_CB_FUNC pAcceptCB, TML_ON_CERTIFICATE_FILE_LOCATION_CB_FUNC pCertReqCB, TML_ON_CERTIFICATE_PRIVATE_KEY_LOCATION_CB_FUNC pPrivateKeyReqCB, TML_BOOL *bAccept)
 Allows to configure if the provided tml core will accept TLS incoming connections. More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Connection_StartNegotiation (TML_CONNECTION_HANDLE connectionHandle, TML_BOOL bAllowTlsFailures, TML_BOOL *bEncrypted)
 Starts the TLS transport security negotiation on the given connection. More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Core_Set_AutoNegotiation (TML_CORE_HANDLE coreHandle, TML_BOOL bEnabled, TML_BOOL bAllowTlsFailures)
 Allows to activate TLS profile automatic negotiation for every connection created. More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Connection_VerifyCert (TML_CONNECTION_HANDLE connectionHandle, TML_BOOL *bVerifyOk)
 Allows to verify peer certificate after successfully establish TLS session. More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Connection_Encryption_Get_StatusMessage (TML_CONNECTION_HANDLE connectionHandle, TML_CTSTR **statusMsg)
 Get the encrption status message created during the start of the TLS transport security negotiation. More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Get_Digest (TML_CTSTR *string, TmlTlsDigestMethod method, TML_CTSTR **sDigest)
 Allows to create a digest from the provided string. More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Connection_Get_PeerSSLDigest (TML_CONNECTION_HANDLE connectionHandle, TmlTlsDigestMethod method, TML_CTSTR **sDigest)
 Allows to return the certificate digest from the remote peer given TLS session is activated (this is also called the certificate fingerprint). More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Connection_Get_SSLDigest (TML_CONNECTION_HANDLE connectionHandle, TmlTlsDigestMethod method, TML_CTSTR *sPathName, TML_CTSTR **sDigest)
 Allows to return the certificate digest from a local stored certificate file (this is also called the certificate fingerprint). More...
 
TLS_CORE_API TML_INT32
DLL_CALL_CONV 
tml_Tls_Core_Set_OnError (TML_CORE_HANDLE coreHandle, TML_ON_TLS_ERROR_CB_FUNC pErrorCB, void *pErrorData)
 Allows to configure an error handler that will be called when a failure is found at SSL level or during the handshake with the particular function failing. More...
 

Detailed Description

TML TLS library functions.