UaClientSdk::ClientSecurityInfo Class Reference

The ClientSecurityInfo class contains the security related settings to create a secure channel. More...

#include <uaclientsdk.h>

Inherited by UaClientSdk::SessionSecurityInfo.

Public Member Functions
	ClientSecurityInfo ()
	Constructs a client security info object with initial values sSecurityPolicy = OpcUa_SecurityPolicy_None messageSecurityMode = OpcUa_MessageSecurityMode_None No PKI provider.
	~ClientSecurityInfo ()
	Destroys the client security info object.
UaStatusCode	initializePkiProviderOpenSSL (const UaString &sCertificateRevocationListLocation, const UaString &sCertificateTrustListLocation)
	Initialize the PKI provider to use the file based OpenSSL certificate store.
UaStatusCode	loadClientCertificateOpenSSL (const UaString &sClientCertificateFile, const UaString &sClientPrivateKeyFile)
	Load client certificate and client private key using the file based OpenSSL certificate store.
OpcUa_Void *	pkiCfg ()
	Internally used function to provide the PKI provider for the UA Stack.

Data Fields
UaString	sSecurityPolicy
	The name of the security policy used for the connection.
OpcUa_MessageSecurityMode	messageSecurityMode
	The message security mode used for the connection.
UaByteString	clientCertificate
	Client certificate (public key)
UaByteString	clientPrivateKey
	Client private key.

Detailed Description

The ClientSecurityInfo class contains the security related settings to create a secure channel.

Member Function Documentation

UaStatusCode UaClientSdk::ClientSecurityInfo::initializePkiProviderOpenSSL	(	const UaString &	sCertificateRevocationListLocation,
		const UaString &	sCertificateTrustListLocation
	)

Initialize the PKI provider to use the file based OpenSSL certificate store.

Returns

Status code

Parameters

[in]	sCertificateRevocationListLocation	Path of the revocation list location
[in]	sCertificateTrustListLocation	Path of the certificate trust list directory. All certificates in this directory will be trusted

UaStatusCode UaClientSdk::ClientSecurityInfo::loadClientCertificateOpenSSL	(	const UaString &	sClientCertificate,
		const UaString &	sClientPrivateKey
	)

Load client certificate and client private key using the file based OpenSSL certificate store.

Returns

Status code.

Parameters

[in]	sClientCertificate	Path and file name of the client certificate (public key)
[in]	sClientPrivateKey	Path and file name of the client private key

Field Documentation

OpcUa_MessageSecurityMode UaClientSdk::ClientSecurityInfo::messageSecurityMode

The message security mode used for the connection.

OpcUa_MessageSecurityMode_None OpcUa_MessageSecurityMode_Sign OpcUa_MessageSecurityMode_SignAndEncrypt

UaString UaClientSdk::ClientSecurityInfo::sSecurityPolicy

The name of the security policy used for the connection.

OpcUa_SecurityPolicy_None "http://opcfoundation.org/UA/SecurityPolicy#None" for security disabled OpcUa_SecurityPolicy_Basic128Rsa15 "http://opcfoundation.org/UA/SecurityPolicy#Basic128Rsa15" OpcUa_SecurityPolicy_Basic256 "http://opcfoundation.org/UA/SecurityPolicy#Basic256"

---

The documentation for this class was generated from the following files:

• /home/buildbot/work/uasdkcpp/src/uaclient/uaclientcpp/uaclientsdk.h
• /home/buildbot/work/uasdkcpp/src/uaclient/uaclientcpp/uaclientsdk.cpp