I_SocketTlsSettingsClass

Objects that implement this interface are used to configure the TLS (Transport Layer Security) communication layer.

Namespace: Tc3_Sockets
Library: Tc3_Sockets (Tc3_Sockets.compiled-library)

Inheritance hierarchy

I_SocketTlsSettingsClass -> __System.IQueryInterface

INTERFACE I_SocketTlsSettingsClass EXTENDS __System.IQueryInterface

I_SocketTlsSettingsClass 1: Methods

Name

Description

AddCa

Saves the file path of the CA certificate in the TLS configuration settings.

AddCert

Saves the file path of the client or server certificate in the TLS configuration settings.

AddCrl

Saves the file path of the Certificate Revocation List (CRL) in the TLS configuration settings.

AddPsk

Saves the PSK key and PSK identity string in the TLS configuration settings.

Reset

Resets all TLS configuration settings.

SetConnectFlags

Saves additional, optional TLS configuration settings of the client.

SetListenFlags

Saves additional, optional TLS configuration settings of the server.

I_SocketTlsSettingsClass 2: Properties

Name

Type

Access

Description

nSecurePort

UDINT

Get

Secure ISO TP0 (IANA) port number for TLS communication.

connectFlags

ST_TlsConnectFlags

Get

Additional TLS configuration settings of the client.

listenFlags

ST_TlsListenFlags

Get

Additional TLS configuration settings of the server.

pskKey

PVOID

Get

Points to the first byte of the PSK key.

pskKeyLen

UDINT(0..TCPADS_TLS_MAX_PSK_KEY_SIZE)

Get

Byte length of the PSK key.

sCaPath

STRING(TCPADS_TLS_CERTIFICATE_PATH_SIZE)

Get

File path of the CA certificate.

sCertPath

STRING(TCPADS_TLS_CERTIFICATE_PATH_SIZE)

Get

File path of the client or server certificate.

sCrlPath

STRING(TCPADS_TLS_CERTIFICATE_PATH_SIZE)

Get

File path from the certificate revocation list (CRL).

sIdentity

STRING(TCPADS_TLS_PSK_IDENTITY_SIZE)

Get

Identity string of the PSK key.

sKeyPath

STRING(TCPADS_TLS_CERTIFICATE_PATH_SIZE)

Get

File path of the private key.

sKeyPwd

STRING(TCPADS_TLS_KEY_PASSWORD_SIZE)

Get

Password string of the certificate.