Skip to Content
Documentation07 · AdministrationCertificate management
On this page

Certificate Management

The center and edge workflow can deploy SyncBridge / Gateway MQTT data certificates automatically. This page stores plugin certificates; it does not enable HTTPS for Gateway Web. Studio and Watchdog maintain their management identities separately.

Open Development Configuration → Certificate Management. Upload an existing certificate, or generate a CA and then a server or client certificate for an internal test.

Upload a certificate for a connection

  1. Click Add → Upload Certificate and enter a recognizable name.
  2. Select the purpose: CA to trust a peer’s issuer, Server for an identity presented by a gateway server plugin, or Client for the gateway’s identity when an external service requires mutual authentication.
  3. Select the actual file format and upload the file. Enter the PFX password where required; for PEM with a separate private key, upload that key and enter its password.
  4. Save and check the certificate name, purpose, and validity in the list.
  5. Edit the device or forwarding target that requires TLS. Select the saved name in its CA, server-certificate, or client-certificate field, then save that connection.
  6. Check the connection result. Uploading a certificate does not assign it to a connection automatically.

Keep private keys and passwords out of screenshots and support requests. Establish the correct trust relationship instead of allowing untrusted certificates.

Choose and locate a certificate

First, look at the terminology

terminologyOn-site understanding
CA certificateA root or intermediate certificate used to verify an issuer. Issuing new certificates also requires the CA’s private key.
Server certificateIdentity presented by a server plugin, such as MQTT Server or OPC UA Server.
Client certificateIdentity presented by the gateway when an external system requires mutual TLS authentication.
TLS / SSLencrypted communication methods. Once enabled, both parties in the connection use certificates to confirm their identities and encrypt the transmitted content.
PFX / PEM / CER / DERcertificate file formats. PFX typically includes both the certificate and the private key; PEM is commonly found in Linux; CER/DER are mostly certificate public key files.
Private KeySensitive key corresponding to the certificate. After a private key is leaked, the other party may impersonate the gateway or client.
Subject / SANSubject is the name of the certificate subject; SAN is a list of domain names or IPs permitted by the certificate. When accessing services via IP, write the IP into the SAN.

Function Entry

After logging into TGateway Web, click the “Development Configuration → Certificate Management” menu on the left.

Certificate Management Page

Certificate List

ColumnsDescription
Certificate NameCertificate Identifier Name
PurposeCA Certificate/Server/Client
FormatPFX/PEM/CER/DER
SubjectCertificate Subject Name
IssuerCertificate Issuer
Validity PeriodCertificate Validity Period

Certificate Purpose

PurposeDescription
CA CertificateRoot certificate or intermediate certificate, Used for issuing server certificates and client certificates, and can also be used to verify peer certificates. Before generating server or client certificates, CA certificates should be created or uploaded first.
ServerIdentity presented by a server plugin, such as MQTT Server or OPC UA Server; connecting clients verify it.
Clientgateways are used when clients connect to external systems, such as MQTT Client bidirectional TLS or scenarios where external systems require client certificate authentication.

Certificate Filtering

The page supports filtering certificates by the following criteria:

Filter CriteriaDescription
Certificate NameSearch by Name Keywords
PurposeFilter by CA/Server/Client
FormatFilter by PFX/PEM/CER/DER

Operation Functions

FunctionsDescription
Upload certificatesUpload existing certificate files
Generate CA certificatesGenerate new CA root certificates
Generate server certificatesIssue server-side certificates based on existing CA certificates
Generate client certificatesIssue client certificates based on existing CA certificates
EditEdit certificate information
ExportExport certificate files
DeleteDelete certificates
Batch deleteBatch delete Select certificates
RefreshRefresh certificate list

Upload or generate certificates

Upload certificate

Click “Add → Upload certificate” to open the upload dialog box:

Upload certificate dialog box

Configuration Item

FieldDescription
Certificate NameCertificate Identifier Name
Certificate PurposeCA/Server/Client
Certificate FormatPFX/PEM/CER/DER. PFX: Binary format with private key (commonly used on Windows); PEM: Base64 text format (commonly used in Linux); CER/DER: Certificate format for public key only
Certificate filecertificate file
Private key filePrivate key file (PEM format)
certificate passwordPFX certificate password, or the password used to protect private keys when generating or exporting certificates.
Private Key PasswordEnter when the PEM private key file is protected by a password.

Generate CA Certificate

Click “Add → Generate CA Certificate” to open the Generation dialog box. CA certificates are used for subsequent issuance of server and client certificates. It is recommended to clearly use a name to indicate the certificate’s purpose and field scope.

Generate CA Certificate Dialog

Configuration Items

FieldsDescriptions
Certificate NameThe unique name of the certificate in the system; select this name when configuring the CA certificate later.
SubjectCertificate Subject, usually filled in CA name, organization name, or field root certificate name.
Validity PeriodCertificate validity period, unit: years, interface limit 1 to 50.
Key lengthselectable between 2048 bits or 4096 bits; CA certificates are recommended to use 4096 bits.
Certificate and passwordoptional. After filling it out, it is recommended to protect the private key used to generate the certificate; it is recommended to set up and properly store it in the production environment.

Generate Server Certificate

Click “Add → Generate Server Certificate” to open the Generation Dialog:

The server certificate must be issued by an existing CA certificate. If the CA certificate list is empty, first execute “Generate CA Certificate” or “Upload Certificate,” then reopen the server certificate generation popup.

Configuration Items

FieldsDescription
Certificate NameUnique name referenced by server plugins such as OPC UA Server and MQTT Server.
Subject NameCertificate Subject, usually filled in as the service domain name, device name, or site name.
CA CertificateThe CA certificate used to issue the server certificate. The dropdown option comes from certificates listed for CA purposes.
SAN domain nameList of subject alternate domain names. After entering the domain name, press Enter to add; multiple domains are supported.
SAN IP addresssubject alternate name IP address list. When accessing services via IP, you must provide the corresponding IP.
Validity PeriodCertificate validity period, unit: years, interface limited to 1 to 10.
Key lengthcan be selected between 2048 bits or 4096 bits.
Certificate passwordoptional. It is used to protect the private key or export file that generates the certificate.

SAN Configuration Description

SAN (Subject Alternative Name) is an extension field of the certificate, used to specify the valid domain name and IP address of the certificate. After configuring the SAN, the certificate can support access to multiple domain names and IP addresses.

Usage Scenario:

  • The server has multiple domain names that need access.
  • The server has multiple IP addresses that need access.
  • Internal network environment uses IP addresses to access

Operation Method:

  • Enter the domain name or IP in the input box After the address, press Enter to add.
  • The same certificate can be configured for multiple SAN domains and multiple SAN IP addresses simultaneously.
  • If the client accesses the service via an IP address, entering only the subject name is usually insufficient; the SAN IP address should also be provided.

Generate Client Certificate

Click “Add → Generate Client Certificate” to open the Generation Dialog Box:

Client Certificate is used for two-way authentication scenarios, For example, OPC UA client certificates, MQTT client certificates, or other external systems that require mTLS. You also need to prepare a CA certificate before generation.

Configuration Items

FieldsDescription
Certificate NameThe unique name of the client certificate within the system.
Subject NameClient Identity Name, which can be filled in the client application name, device name, or external system identifier.
CA CertificateThe CA certificate used to issue the client certificate.
Validity PeriodCertificate validity period, unit: years, interface limit 1 to 10.
Key lengthselectable between 2048 or 4096 bits.
Certificate PasswordOptional. Used to protect the client certificate private key.

Export Certificate

Click the “Export” button in the certificate list to open the export dialog:

Export Configuration

FieldsDescription
Export FormatsPEM/PFX/CER/DER
Includes private keyDisplayed only in PEM format. After opening, the exported content contains the private key, making it suitable for migrating to other gateways or clients.
Export passwordoptional. Fill in when exporting PFX or when you need to protect your private key.

Export Format Instructions

FormatInstructions
PEMBase64 encoded text format, commonly used in Linux systems
PFXbinary format, containing certificates and private keys, commonly used in Windows systems
CERbinary format, containing only certificates
DERbinary format, containing only certificates

Export results

After successful export, certificate details and export content will be displayed:

ContentDescription
Certificate (PEM)PEM format certificate content, supports copying and downloading
Private Key (PEM)PEM format private key content, supports copying and downloading
PFX filesBinary file download in PFX format
CER contentcertificate content in CER format
DER fileBinary file download in DER format

Export Note

PEM or PFX files containing private keys should be managed as sensitive files. After exporting, do not send via regular chat tools, public cloud drives, or unencrypted emails; The certificate password should be stored separately from the certificate file.

Save and verify

  1. Refresh the certificate list and check the name, purpose, issuer, and validity.
  2. Select the certificate in the consuming plugin or service and save its configuration.
  3. Start that connection and complete a TLS handshake. Check both the server and client result.
  4. For a private CA, confirm the expected issuer is trusted. If revocation checking is enabled, the runtime must be able to complete it.

A saved certificate is not proof of a successful handshake. The certificate must be valid, match its purpose, and have an accessible private key where the connection requires one.

Troubleshooting

SymptomAction
Uploaded certificate is missingClear filters and refresh. Check the unique name, file format, and password.
TLS handshake failsCheck purpose, validity, target hostname, the complete chain, and both system clocks.
Client certificate is rejectedCheck the server’s trusted CA, the client certificate issuer, and any fingerprint restrictions.
Exported file cannot be usedCheck format, private-key inclusion, and export password. A public-only CER/DER file cannot replace a client identity’s private key.