Cpl::TShell::Security Class Reference

This abstract defines the interface for validating a 'user login' for TShell. More...

Detailed Description

This abstract defines the interface for validating a 'user login' for TShell.

NOTE: This class does NOT define any thread safety semantics - it is the responsibility of the Application to provide thread safety if it is needed.

#include <Security.h>

Inheritance diagram for Cpl::TShell::Security:

Public Types
enum	Permission_T { ePUBLIC = 0 , eUSER = 1 , eSYSTEM = 2 , eADMIN = 3 }
	Permissions levels. More...

Public Member Functions
virtual Permission_T	validateCredentials (const char *username, const char *password) noexcept=0
	This method returns the Permission level for the specified user/password.
virtual	~Security ()
	Virtual destructor.

Member Enumeration Documentation

Permission_T

enum Cpl::TShell::Security::Permission_T

Permissions levels.

Enumerator
ePUBLIC	No permissions, i.e. the 'users' has no privilege and/or the command requires NO permission to be executed
eUSER	Lowest permission setting, i.e. a 'user' can only executes commands that have eUSER or ePUBLIC permission levels
eSYSTEM	Higher permission setting, i.e. a 'user' can only executes commands that have eSYSTEM, eUSER or ePUBLIC permission levels
eADMIN	Highest permission setting, i.e. a 'user' can executes any/all commands

Constructor & Destructor Documentation

~Security()

virtual Cpl::TShell::Security::~Security ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

validateCredentials()

virtual Permission_T Cpl::TShell::Security::validateCredentials ( const char *  username, const char *  password  )

pure virtualnoexcept

This method returns the Permission level for the specified user/password.

If the user-name or password are not valid - then ePUBLIC is returned.

Implemented in Ajax::Main::TShellSecurity, and Cpl::TShell::SecurityNull.

---

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

• Cpl/TShell/Security.h