PLCnext API Documentation  22.6.0.43
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Enumerations | Functions
Arp::System::Security::Services Namespace Reference

Namepsace for services used in the RSC security implementation More...

Classes

class  IPasswordAuthenticationService
 This service allows a Remoting client to authenticate a user to the gateway (device) and by this start a security session on behalf of her or him. More...
 
class  PasswordAuthenticationServiceProxyFactory
 Proxy factory class of service IPasswordAuthenticationService More...
 

Enumerations

enum class  AuthenticationError : int32 {
  None = 0 , InvalidCredentials = -1 , PenaltyDelayActive = -2 , DuplicateSession = -3 ,
  SessionLimitReached = -4 , TryAgainLater = -5 , PasswordMustBeChanged = -6
}
 Defines values indicating success or failure of an attempt to create a security session. More...
 

Functions

ARP_CXX_SYMBOL_EXPORT std::ostream & operator<< (std::ostream &os, AuthenticationError value)
 
ARP_CXX_SYMBOL_EXPORT std::istream & operator>> (std::istream &is, AuthenticationError &value)
 

Detailed Description

Namepsace for services used in the RSC security implementation

Enumeration Type Documentation

◆ AuthenticationError

Defines values indicating success or failure of an attempt to create a security session.

See also
Arp.System.Security.Services.IPasswordAuthenticationService
Enumerator
None 

A new security session has been established successfully.

InvalidCredentials 

Authentication failed because name and / or password is not correct.

PenaltyDelayActive 

Authentication failed because a penalty delay is currently active. The combination of name and password has not been checked.

DuplicateSession 

For this combination of user and channel there already exists a session.

SessionLimitReached 

The remote side's capacity does no allow to open more security sessions within this channel.

Different session limits may be the cause. Close other sessions first to release ressources for a new security session.

Some session limits are specific to channels, i.e. no more than N session can be opened within the same channel. Other session limits may apply for particular groups of users, i.e. even if there is reserved and free capacity for sessions of administrative users the pool of sessions for "normal" users may be exhausted and thus an authenitcation may fail with this error.

TryAgainLater 

The system is temporarily unable to answer authentication requests.

With this error the caller shall try again at a later point in time - no earlier than two seconds later. This error can happen if the system is still initializing itself during startup or reinitializing itself after a reconfiguration or if the user's password is verified by a central system which is currently unreachable.

PasswordMustBeChanged 

The password is correct but it must be changed before a session is created.

With this error it is indicated that the credentials have been correct and normally a session would have been created. But this either is an initial password which must be changed BEFORE the first session or the lifetime of the password has expired and must be changed NOW before a session is created.