Represents the result of the validation of a device identity. More...

#include <IdentityValidationResult.hpp>

Inheritance diagram for Arp::System::Commons::Services::Security::IdentityValidationResult:

Public Member Functions
	IdentityValidationResult (void)
	Constructs an IdentityValidationResult instance.

	IdentityValidationResult (IdentityValidationError error, const RscString< 512 > &subject, const RscString< 80 > &subjectCommonName, const RscString< 80 > &subjectSerialNumber)
	Constructs an IdentityValidationResult instance.

void	Serialize (RscWriter &writer) const
	Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...

void	Deserialize (RscReader &reader)
	Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...

Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
	RscSerializable (void)=default
	The default constructor.

Static Public Member Functions
static size_t	GetFieldCount (void)
	Returns the count of fields More...

Public Attributes
IdentityValidationError	Error = static_cast<IdentityValidationError>(0)
	The numeric indication about success or failure of the validation.

RscString< 512 >	Subject
	The subject field from the certificate of the identity represented as text conforming to RFC 2253. More...

RscString< 80 >	SubjectCommonName
	The CommonName component of the subject field from the certificate of the identity. More...

RscString< 80 >	SubjectSerialNumber
	The SerialNumbner component of the subject field from the certificate of the identity. More...

Detailed Description

Represents the result of the validation of a device identity.

Member Function Documentation

◆ Deserialize()

void Arp::System::Commons::Services::Security::IdentityValidationResult::Deserialize ( RscReader & reader )

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters

reader Reference to RscReader.

◆ GetFieldCount()

size_t Arp::System::Commons::Services::Security::IdentityValidationResult::GetFieldCount ( void )

static

Returns the count of fields

Returns: Count of fields.

The field count is used for serialization via Rsc

◆ Serialize()

void Arp::System::Commons::Services::Security::IdentityValidationResult::Serialize ( RscWriter & writer ) const

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters

writer Reference to RscWriter

Member Data Documentation

◆ Subject

RscString<512> Arp::System::Commons::Services::Security::IdentityValidationResult::Subject

The subject field from the certificate of the identity represented as text conforming to RFC 2253.

This is valid only if Arp.System.Commons.Services.Security.IdentityValidationResult.Error is Arp.System.Commons.Services.Security.IdentityValidationError.None.

◆ SubjectCommonName

RscString<80> Arp::System::Commons::Services::Security::IdentityValidationResult::SubjectCommonName

The CommonName component of the subject field from the certificate of the identity.

This is valid only if Arp.System.Commons.Services.Security.IdentityValidationResult.Error is Arp.System.Commons.Services.Security.IdentityValidationError.None. A certificate does not need to have the component. Then this string is empty. But by convention certificates usually have such a component.

◆ SubjectSerialNumber

RscString<80> Arp::System::Commons::Services::Security::IdentityValidationResult::SubjectSerialNumber

The SerialNumbner component of the subject field from the certificate of the identity.

This is valid only if Arp.System.Commons.Services.Security.IdentityValidationResult.Error is Arp.System.Commons.Services.Security.IdentityValidationError.None. A certificate does not need to have the component. Then this string is empty. Please note that this serial number is NOT the serial number of the certificate. But it is the serial number component from the subject of the certificate. Only very few certificates have this component in the subject. Some device vendors put the serial number of the device into the subject this way. PHOENIX CONTACT does so.

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

Arp/System/Commons/Services/Security/IdentityValidationResult.hpp
Arp/System/Commons/Services/Security/IdentityValidationResult.cpp

Public Member Functions

Static Public Member Functions

Public Attributes