Click or drag to resize
ServiceSettingsEnableSecureConnection Method (String, String, ServiceSettingsSecurityProtocols)

Secures the connection between the server and the clients.

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2024.2.2.0 (10.16.2.0)
Syntax
public void EnableSecureConnection(
	string publicCertificateFilePath,
	string privateKeyFilePath,
	ServiceSettingsSecurityProtocols enabledSecurityProtocols
)

Parameters

publicCertificateFilePath
Type: SystemString

: Path to a file containing the public certificate used to authenticate the server to the clients. The certificate has to be a PEM ("Privacy Enhanced Mail") encoded certificate.

privateKeyFilePath
Type: SystemString

: Path to a file containing the private key used to sign the server key exchange between the client and the server. If the private key is protected by a passphrase, set the passphrase into the OIV.RemoteViz.Rendering.ServiceListener.OnRequestedPrivateKeyPassphrase() callback.

enabledSecurityProtocols
Type: OIV.RemoteViz.RenderingServiceSettingsSecurityProtocols

: Defines the security protocols used to secure the exchange between the client and the server. By default, TLSv1.1, TLSv1.2 and TLSv1.3 protocols are enabled. A bitmask of the security protocols is used. Many security protocols can be enabled by using the logical OR operator.

Remarks

RemoteViz uses the WebSocket protocol to enable communication between the client and the service. In a production environment, it is highly recommended to use secure WebSocket. Using a secure WebSocket connection improves confidentiality and reliability because the connection is encrypted with Transport Layer Security (TLS), which reduces the risk of a variety of attacks such as man-in-the-middle tampering with your data.

The URL scheme used by the clients to connect to the service must be wss://

See Also