PLCnext API Documentation 25.0.2.69
Classes | Enumerations | Functions
Arp::System::Commons::Security Namespace Reference

Namespace for classes dealing with certificates More...

Classes

class  Asn1Time
 Helper class to handle ASN1Time objects in x.509 Certificates More...
 
class  Certificate
 Class to handle x.509 certificates More...
 
class  IdentityStore
 Class with represents a Identity (Certificate with Chain and private Key) and is able to initialize an OpenSSL SSL Context This is an internal class used by TlsSocket More...
 
class  ItemInfo
 
class  KeyPair
 class which represents a asymmetric key pair More...
 

Enumerations

enum class  KeyPairType : uint8 {
  RSA_2048 = 0 , RSA_4096 = 1 , RSA_TPM_2048 = 2 , ECDSA_TPM_SECP256R1 = 3 ,
  Unknown = 255
}
 
enum class  SecurityConfigurationError : uint8 {
  None = 0 , StoreNotFound = 1 , ItemNotFound = 2 , IOError = 3 ,
  ListTypeNotSupported = 4 , DecodeError = 5 , NotImplemented = 6 , KeyTypeNotSupported = 7 ,
  ReadOnly = 8 , UnknownError = 9 , StoreExists = 10
}
 Enumeration of possible error codes when interacting with classes in the Security namespace More...
 
enum class  SecurityListType : uint8 { TrustList = 0 , IssuerList = 1 , TrustCrlList = 2 , IssuerCrlList = 3 }
 

Functions

String ParseHandlefile (const String &filepath)
 
bool IsValidHandle (const String &handle)
 
ARP_CXX_SYMBOL_EXPORT std::ostream & operator<< (std::ostream &os, KeyPairType value)
 
ARP_CXX_SYMBOL_EXPORT std::istream & operator>> (std::istream &is, KeyPairType &value)
 
ARP_CXX_SYMBOL_EXPORT std::ostream & operator<< (std::ostream &os, SecurityConfigurationError value)
 
ARP_CXX_SYMBOL_EXPORT std::istream & operator>> (std::istream &is, SecurityConfigurationError &value)
 
ARP_CXX_SYMBOL_EXPORT std::ostream & operator<< (std::ostream &os, SecurityListType value)
 
ARP_CXX_SYMBOL_EXPORT std::istream & operator>> (std::istream &is, SecurityListType &value)
 

Detailed Description

Namespace for classes dealing with certificates

Enumeration Type Documentation

◆ SecurityConfigurationError

Enumeration of possible error codes when interacting with classes in the Security namespace

Enumerator
None 

Successful Operation

StoreNotFound 

The named store was not found

ItemNotFound 

The named item was not found. E.g. a certificate was not found

IOError 

An error while writing to disk occured

ListTypeNotSupported 

The passed ListType is not supported by the implementation of this function

DecodeError 

Failed to decoded input as expected. e.g. input is not PEM formatted

NotImplemented 

The functionality is not yet implemented

KeyTypeNotSupported 

The implementation or function does not support the given keytype

ReadOnly 

The store is read only and may not be modified

UnknownError 

Unknown error

StoreExists 

A store with the name already exists. This can occur when trying to rename a store