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

#include <uaclientsdk.h>

Inheritance diagram for UaClientSdk::SessionSecurityInfo:

Collaboration diagram for UaClientSdk::SessionSecurityInfo:

List of all members.

Public Member Functions
	SessionSecurityInfo ()
	~SessionSecurityInfo ()
	SessionSecurityInfo (const SessionSecurityInfo &)
SessionSecurityInfo &	operator= (const SessionSecurityInfo &)
UaStatusCode	loadServerCertificateOpenSSL (const UaString &sServerCertificateFile)
UaStatusCode	saveServerCertificate (UaString &sCertificateName)
UaStatus	verifyServerCertificate ()
void	setAnonymousUserIdentity ()
void	setUserPasswordUserIdentity (const UaString &userName, const UaString &password)
const UaUserIdentityToken *	pUserIdentityToken () const
Public Attributes
UaByteString	serverCertificate
OpcUa_Boolean	doServerCertificateVerify

---

Detailed Description

The SessionSecurityInfo class contains the securit related session settings for connect.

---

Constructor & Destructor Documentation

UaClientSdk::SessionSecurityInfo::SessionSecurityInfo

(

)

Constructs a session security info object with initial values for this class and the base class ClientSecurityInfo. The user identity token type is set to Anonymous

UaClientSdk::SessionSecurityInfo::~SessionSecurityInfo

(

)

Destroys the session security info object

UaClientSdk::SessionSecurityInfo::SessionSecurityInfo

(

const SessionSecurityInfo &

other )

Constructs a copy of the passed session security info object

---

Member Function Documentation

UaStatusCode UaClientSdk::SessionSecurityInfo::loadServerCertificateOpenSSL

(

const UaString &

sServerCertificate )

Load server certificate using the file based OpenSSL certificate store.

Returns:

Status code.

Parameters:

[in]

sServerCertificate

Path and file name of the server certificate (public key)

SessionSecurityInfo & UaClientSdk::SessionSecurityInfo::operator=

(

const SessionSecurityInfo &

other )

Assigns a copy of the passed session security info to this object and returns a reference to this object.

const UaUserIdentityToken * UaClientSdk::SessionSecurityInfo::pUserIdentityToken

(

)

const

Returns the user identity token configured for this setting object. The returned object can be an instance UaUserIdentityTokenAnonymous for the token type Anonymous and UaUserIdentityTokenUserPassword for the token type UserPassword.

UaStatusCode UaClientSdk::SessionSecurityInfo::saveServerCertificate

(

UaString &

sCertificateName )

Save certificate in store

Returns:

Status code.

Parameters:

[out]

sCertificateName

Name of the certificate that can be used to load the certificate from the same store.

void UaClientSdk::SessionSecurityInfo::setAnonymousUserIdentity

(

)

This fuction is setting the user identity type used for connection establishment to Anonymous.

void UaClientSdk::SessionSecurityInfo::setUserPasswordUserIdentity	(	const UaString &	userName,
		const UaString &	password
	)

This fuction is setting the user identity type used for connection establishment to UserPassword.

Parameters:

[in]	userName	User name for the user password user identity type
[in]	password	Password for the user password user identity type

UaStatus UaClientSdk::SessionSecurityInfo::verifyServerCertificate

(

)

This fuction verifies if the server certificate is trusted by the client.

---

Member Data Documentation

OpcUa_Boolean UaClientSdk::SessionSecurityInfo::doServerCertificateVerify

Indicates if the client SDK must verify the server certificate or if this was done already by the application. The default value is True to force the client SDK to verify the server certificate before establishing the connection.

UaByteString UaClientSdk::SessionSecurityInfo::serverCertificate

Server certificate (public key).

---

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