v0.61.3
ReferenceHardwareOPC UAConnect to a server

Connect an OPC UA server

Connect an OPC UA server to Synnax, with its login and security settings.

An OPC UA server makes the values of a PLC or a SCADA system available as nodes. In Synnax, an OPC UA server is one endpoint with its login and security settings. The read task and the write task add the nodes.

Prerequisites

Supported
WindowsmacOSLinuxNI Linux RTDocker
  • A running Driver that can reach the server on the network. Synnax Desktop runs one for you.

Connect a server

  1. In the devices toolbar, click (Connect device), then select OPC UA server. You can also run the “Connect OPC UA server” command.
  2. Enter a name for the server.
  3. In Endpoint, enter the address of the server, for example opc.tcp://192.168.1.50:4840.
  4. In Connect from, select the Driver that connects to the server. If only one running Driver has OPC UA enabled, the Console selects it for you.
  5. If the server needs a login, enter the Username and the Password.
  6. Set the security.
  7. Click Connect.

The Console asks the Driver to connect to the server before it saves the server. If the test fails, or takes longer than two times the Request timeout plus 2 seconds (12 seconds at the default), the dialog shows the error and keeps your entries.

Security

In the Security section, the Mode and the Policy protect the connection between the Driver and the server. Set them to values that the server accepts.

  • Mode -> None, Sign, or Sign and encrypt.
  • Policy -> the algorithms. When you change the mode from None, the Console selects Basic 256-bit with SHA-256. Select a deprecated policy only when the server supports nothing newer.

To see the settings that the server accepts, click Find endpoints next to Mode. The Driver asks the server for its endpoints, and the Console lists each mode and policy, most secure first, with the logins that each one accepts. Select one to set the Mode and the Policy. A policy that the Driver does not support shows as “not supported” and you cannot select it.

The other security fields show when the mode is not None. In Python and TypeScript, set a policy other than "None" when the mode is not "None". With the policy at "None", the Driver does not load the certificates, even when the mode is "Sign".

Client certificate

The Driver sends a certificate to the server. Select one of these:

  • Driver certificate -> the default. Each Driver makes its own certificate, and all the servers that the Driver connects to get the same one. The dialog shows its thumbprint. Click (Manage) to see its expiry date.
  • Files on the Driver computer -> the paths of a certificate and a private key on the computer that runs the Driver. Use this when your site issues its own certificates. The key must not have a password, and the certificate must hold the application URI of the Driver.

Most servers reject a certificate that they do not know, and keep it in a list of rejected certificates. To make the server trust the Driver certificate:

  1. Click Connect. The test fails with “Server rejected the Driver certificate”. With Files on the Driver computer, the message is “Server rejected the client certificate”.
  2. On the server, find the Driver certificate in the rejected list. Make sure that its thumbprint is the same as the one in the dialog, then trust it.
  3. Click Connect again.

If the server has no rejected list, click (Download as DER) to save the certificate as a DER file, then add the file to the trust list of the server. For a server that needs PEM, convert the file that you downloaded, here driver.der:

openssl x509 -inform der -in driver.der -out driver.pem

The Driver certificate is valid for 3 years. 60 days before it expires, the Driver makes the next certificate and keeps using the current one. Once a day, the Driver connects to each secured server with the next certificate, so a server that does not trust it yet adds it to its rejected list. Trust it there, or click (Manage) in the dialog and download it under Renewal. The Driver uses the next certificate when all the servers accept it, or when the current one expires.

Regenerate replaces the certificate of the Driver with a new one. Use it only when the private key is no longer safe. All the servers must then trust the new certificate.

Server certificate

Each server has a certificate, and a device trusts one server certificate. The Driver connects only to a server that sends the trusted certificate.

  • In the dialog, the first Connect fails with “Server certificate not trusted”. The dialog shows the certificate that the server sent, with its subject, thumbprint, and expiry date. Make sure that the thumbprint is the same as the one the server shows, then click Trust and connect. The dialog saves the certificate and connects again.
  • A device made in Python or TypeScript without a server certificate trusts the certificate that the server sends on the first connection. The Driver saves that certificate to the device.
  • When the server gets a new certificate, the device shows “Server certificate not trusted”. Right-click the device in the devices toolbar, select Edit connection, and click Connect. Compare the new thumbprint, then click Trust and connect.

Validate server certificate

Validate server certificate is on by default. Turn it off only to troubleshoot a connection. When it is off, the Driver accepts any server certificate, and the device shows the warning “Connected without certificate validation”. Turn it on again when you finish.

Login

The Driver logs in to the server as an anonymous user, or with the Username and Password when you enter one of them. It cannot log in with a user certificate.

Connection options

Console label Python field Default Notes
Connect from rack The key of the rack that runs the Driver.
Endpoint endpoint opc.tcp://localhost:4840 Required in Python.
Username username Empty Empty for an anonymous login.
Password password Empty
Mode security_mode None "None", "Sign", or "SignAndEncrypt".
Policy security_policy None "None" goes only with the mode "None". See security policies.
Certificate file client_cert Empty A path on the Driver computer. Empty, with an empty key, uses the Driver certificate.
Private key file client_private_key Empty A path on the Driver computer. No password.
Server certificate server_cert Empty The trusted certificate as PEM. Empty trusts the certificate of the first connection.
Validate server certificate certificate_validation_disabled False The switch shows the opposite value.
Request timeout client_timeout_ms 5,000 ms The wait for a reply to each request and connection attempt.
Session timeout session_timeout_ms 1,200,000 ms (20 minutes) How long the server keeps a session that gets no requests.
Channel lifetime secure_channel_lifetime_ms 600,000 ms (10 minutes) How long the keys of the connection last before the Driver renews them.

The timeouts are in the Advanced section of the dialog. In TypeScript, the fields are in properties.connection in camel case, such as securityMode, clientCertificate, serverCertificate, certificateValidationDisabled, and clientTimeoutMs.

Security policies

Console label Value
Basic 256-bit with SHA-256 "Basic256Sha256"
AES 128-bit with SHA-256 "Aes128_Sha256_RsaOaep"
AES 256-bit with SHA-256 "Aes256_Sha256_RsaPss"
Basic 256-bit (deprecated) "Basic256"
Basic 128-bit RSA (deprecated) "Basic128Rsa15"

Troubleshooting

For other problems, see Troubleshoot hardware.