QOpcUaPkiConfiguration Class

QOpcUaPkiConfiguration defines the PKI configuration of the application. More...

Header: #include <QOpcUaPkiConfiguration>
CMake: find_package(Qt6 REQUIRED COMPONENTS OpcUa)
target_link_libraries(mytarget PRIVATE Qt6::OpcUa)
qmake: QT += opcua
Since: QtOpcUa 5.13

Public Functions

QOpcUaPkiConfiguration()
QOpcUaPkiConfiguration(const QOpcUaPkiConfiguration &other)
~QOpcUaPkiConfiguration()
QOpcUaApplicationIdentity applicationIdentity() const
QString clientCertificateFile() const
bool isKeyAndCertificateFileSet() const
bool isPkiValid() const
QString issuerListDirectory() const
QString issuerRevocationListDirectory() const
QString privateKeyFile() const
QString revocationListDirectory() const
void setClientCertificateFile(const QString &value)
void setIssuerListDirectory(const QString &value)
void setIssuerRevocationListDirectory(const QString &value)
void setPrivateKeyFile(const QString &value)
void setRevocationListDirectory(const QString &value)
void setTrustListDirectory(const QString &value)
QString trustListDirectory() const
QOpcUaPkiConfiguration &operator=(const QOpcUaPkiConfiguration &rhs)

Detailed Description

This info must be configured using QOpcUaClient::setPkiConfiguration. The used paths and files must be created beforehand.

QOpcUaPkiConfiguration pkiConfig;
const QString pkiDir = QCoreApplication::applicationDirPath() + "/pki";

pkiConfig.setClientCertificateFile(pkiDir + "/own/certs/application.der");
pkiConfig.setPrivateKeyFile(pkiDir + "/own/private/application.pem");
pkiConfig.setTrustListDirectory(pkiDir + "/trusted/certs");
pkiConfig.setRevocationListDirectory(pkiDir + "/trusted/crl");
pkiConfig.setIssuerListDirectory(pkiDir + "/issuers/certs");
pkiConfig.setIssuerRevocationListDirectory(pkiDir + "/issuers/crl");

client->setPkiConfiguration(pkiConfig);

Member Function Documentation

QOpcUaPkiConfiguration::QOpcUaPkiConfiguration()

Default-constructs an instance of QOpcUaPkiConfiguration.

QOpcUaPkiConfiguration::QOpcUaPkiConfiguration(const QOpcUaPkiConfiguration &other)

Constructs a QOpcUaPkiConfiguration from other.

QOpcUaPkiConfiguration::~QOpcUaPkiConfiguration()

Destroys the instance of QOpcUaPkiConfiguration.

QOpcUaApplicationIdentity QOpcUaPkiConfiguration::applicationIdentity() const

Returns an application identity based on the application's client certificate.

The application's identity has to match the used certificate. The returned application identity is prefilled by using information of the configured client certificate.

QString QOpcUaPkiConfiguration::clientCertificateFile() const

Returns the file path of the application's client certificate.

See also setClientCertificateFile().

bool QOpcUaPkiConfiguration::isKeyAndCertificateFileSet() const

Returns true if the private key file and client certificate file are set.

bool QOpcUaPkiConfiguration::isPkiValid() const

Return true if the public key information required to validate the server certificate is set.

QString QOpcUaPkiConfiguration::issuerListDirectory() const

Returns the path of the intermediate issuer list directory.

These issuers will not be trusted.

See also setIssuerListDirectory().

QString QOpcUaPkiConfiguration::issuerRevocationListDirectory() const

Returns the path of the intermediate issuer revocation list directory.

See also setIssuerRevocationListDirectory().

QString QOpcUaPkiConfiguration::privateKeyFile() const

Returns the file path of the application's private key.

See also setPrivateKeyFile().

QString QOpcUaPkiConfiguration::revocationListDirectory() const

Returns the path of the certificate revocation list directory.

See also setRevocationListDirectory().

void QOpcUaPkiConfiguration::setClientCertificateFile(const QString &value)

Sets the file path of the application's client certificate to value.

This file has to be in X509 DER format.

See also clientCertificateFile().

void QOpcUaPkiConfiguration::setIssuerListDirectory(const QString &value)

Sets the path of the intermediate issuer list directory to value.

See also issuerListDirectory().

void QOpcUaPkiConfiguration::setIssuerRevocationListDirectory(const QString &value)

Sets the path of the intermediate issuer revocation list directory to value.

See also issuerRevocationListDirectory().

void QOpcUaPkiConfiguration::setPrivateKeyFile(const QString &value)

Sets the file path of the application's private key to value.

This file has to be in X509 PEM format.

See also privateKeyFile().

void QOpcUaPkiConfiguration::setRevocationListDirectory(const QString &value)

Sets the path of the certificate revocation list directory to value.

See also revocationListDirectory().

void QOpcUaPkiConfiguration::setTrustListDirectory(const QString &value)

Sets the path of the certificate trust list directory to value.

All certificates in this directory will be trusted. Certificates have to be in X509 DER format.

See also trustListDirectory().

QString QOpcUaPkiConfiguration::trustListDirectory() const

Returns the folder of the certificate trust list.

See also setTrustListDirectory().

QOpcUaPkiConfiguration &QOpcUaPkiConfiguration::operator=(const QOpcUaPkiConfiguration &rhs)

Sets the values of rhs in this PKI configuration.

© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.