PLCnext API Documentation  22.3.0.20
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Commons::Services::Security::IDeviceIdentityValidatorService Class Referenceabstract

This service allows to validate device identities. More...

#include <IDeviceIdentityValidatorService.hpp>

Inheritance diagram for Arp::System::Commons::Services::Security::IDeviceIdentityValidatorService:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IDeviceIdentityValidatorService >
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IDeviceIdentityValidatorService (void)=default
 Constructs an IDeviceIdentityValidatorService instance. More...
 
virtual IdentityValidationResult Validate (const RscString< 16384 > &pemTrustedCertificates, const RscString< 80 > &identityName)=0
 Performs the validation of a particular device identity. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

static IRscServiceProxyFactory & GetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory & GetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of the service More...
 

Detailed Description

This service allows to validate device identities.

Constructor & Destructor Documentation

◆ IDeviceIdentityValidatorService()

Arp::System::Commons::Services::Security::IDeviceIdentityValidatorService::IDeviceIdentityValidatorService ( void  )
default

Constructs an IDeviceIdentityValidatorService instance.

Member Function Documentation

◆ Validate()

virtual IdentityValidationResult Arp::System::Commons::Services::Security::IDeviceIdentityValidatorService::Validate ( const RscString< 16384 > &  pemTrustedCertificates,
const RscString< 80 > &  identityName 
)
pure virtual

Performs the validation of a particular device identity.

Parameters
pemTrustedCertificatesList of PEM formatted certificates which are considered as trusted by the application.
identityNameName of the PLCnext IdentityStore containing the identity to verify.
Returns
The result of the validation.

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