Public Member Functions | Public Attributes

UaClientSdk::ClientSecurityInfo Class Reference
[UA Client context and helper classes]

#include <uaclientsdk.h>

Inheritance diagram for UaClientSdk::ClientSecurityInfo:
Inheritance graph
[legend]
Collaboration diagram for UaClientSdk::ClientSecurityInfo:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ClientSecurityInfo ()
 ~ClientSecurityInfo ()
UaStatusCode initializePkiProviderOpenSSL (const UaString &sCertificateRevocationListLocation, const UaString &sCertificateTrustListLocation)
UaStatusCode loadClientCertificateOpenSSL (const UaString &sClientCertificateFile, const UaString &sClientPrivateKeyFile)
OpcUa_Void * pkiCfg ()

Public Attributes

UaString sSecurityPolicy
OpcUa_MessageSecurityMode messageSecurityMode
UaByteString clientCertificate
UaByteString clientPrivateKey

Detailed Description

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

Constructor & Destructor Documentation

UaClientSdk::ClientSecurityInfo::ClientSecurityInfo (  )

Constructs a client security info object with initial values
sSecurityPolicy = OpcUa_SecurityPolicy_None
messageSecurityMode = OpcUa_MessageSecurityMode_None
No PKI provider

UaClientSdk::ClientSecurityInfo::~ClientSecurityInfo (  )

Destroys the client security info object

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]sCertificateRevocationListLocationPath of the revocation list location
[in]sCertificateTrustListLocationPath 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]sClientCertificatePath and file name of the client certificate (public key)
[in]sClientPrivateKeyPath and file name of the client private key
OpcUa_Void * UaClientSdk::ClientSecurityInfo::pkiCfg (  )

Internally used funciton to provide the PKI provider for the UA Stack

Member Data Documentation

UaByteString UaClientSdk::ClientSecurityInfo::clientCertificate

Client certificate (public key)

UaByteString UaClientSdk::ClientSecurityInfo::clientPrivateKey

Client private key

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