TeamTalk 5 C-API DLL  Version 5.14A
EncryptionContext Struct Reference

Configure peer verification for encrypted connection. More...

#include <TeamTalk.h>

Public Attributes

TTCHAR szCertificateFile [TT_STRLEN]
 Path to SSL certificate in PEM format. More...
 
TTCHAR szPrivateKeyFile [TT_STRLEN]
 Path to certificate's private key. More...
 
TTCHAR szCAFile [TT_STRLEN]
 Path to Certificate Authority (CA) Certificate in PEM format. More...
 
TTCHAR szCADir [TT_STRLEN]
 Path to directory containing Certificate Authority (CA) Certificates in PEM format. More...
 
TTBOOL bVerifyPeer
 Verify that peer (client or server) uses a certificate that has been generated by the Certificate Authority contained in szCAFile or szCAdir. More...
 
TTBOOL bVerifyClientOnce
 Whether to only verify client's certificate once during initial connection. More...
 
INT32 nVerifyDepth
 Set limit to depth in the certificate chain during the verification procedure. More...
 

Detailed Description

Configure peer verification for encrypted connection.

Client and server can verify that the remote end is using a valid cerficate that has been issued by the same certification authority.

Call TT_SetEncryptionContext() to set up peer verification.

Definition at line 2655 of file TeamTalk.h.

Member Data Documentation

◆ szCertificateFile

TTCHAR EncryptionContext::szCertificateFile[TT_STRLEN]

Path to SSL certificate in PEM format.

If server has enabled bVerifyPeer then the client (TTInstance) must have specified its certificate and private key.

Definition at line 2662 of file TeamTalk.h.

◆ szPrivateKeyFile

TTCHAR EncryptionContext::szPrivateKeyFile[TT_STRLEN]

Path to certificate's private key.

Definition at line 2664 of file TeamTalk.h.

◆ szCAFile

TTCHAR EncryptionContext::szCAFile[TT_STRLEN]

Path to Certificate Authority (CA) Certificate in PEM format.

If there's multiple CA certificates use szCADir.

Definition at line 2669 of file TeamTalk.h.

◆ szCADir

TTCHAR EncryptionContext::szCADir[TT_STRLEN]

Path to directory containing Certificate Authority (CA) Certificates in PEM format.

Definition at line 2672 of file TeamTalk.h.

◆ bVerifyPeer

TTBOOL EncryptionContext::bVerifyPeer

Verify that peer (client or server) uses a certificate that has been generated by the Certificate Authority contained in szCAFile or szCAdir.

For additional information checkout OpenSSL's SSL_CTX_set_verify() with property SSL_VERIFY_PEER

Definition at line 2679 of file TeamTalk.h.

◆ bVerifyClientOnce

TTBOOL EncryptionContext::bVerifyClientOnce

Whether to only verify client's certificate once during initial connection.

Default value is TRUE.

Only valid for server.

For additional information checkout OpenSSL's SSL_CTX_set_verify() with property SSL_VERIFY_CLIENT_ONCE.

Definition at line 2690 of file TeamTalk.h.

◆ nVerifyDepth

INT32 EncryptionContext::nVerifyDepth

Set limit to depth in the certificate chain during the verification procedure.

Default value is 0.

Set to -1 to not perform certificate check. -1 cannot be used if bVerifyPeer or bVerifyClientOnce are true.

For additional information checkout OpenSSL's SSL_CTX_set_verify_depth()

Definition at line 2701 of file TeamTalk.h.