Qorus Integration Engine®  4.0.3.p2_git
QorusRbacAuth::AbstractRbacProvider Class Referenceabstract

abstract base class for Qorus RBAC providers More...

Inheritance diagram for QorusRbacAuth::AbstractRbacProvider:
QorusRbacAuth::DbRbacProvider

Public Member Methods

bool external ()
 returns the opposite of intrinsic()
 
abstract hash addUser (string user, *list role_cmds, string pass, string name)
 creates a new user in the RBAC store
 
abstract *hash passwd (string user, *hash auth, softstring old_pwd, softstring new_pwd)
 changes the current users' password in the RBAC store
 
abstract *hash updateUser (string user, *list role_cmds, *list storage_cmds, *softstring pass, *string name)
 updates an existing user in the RBAC store
 
abstract hash deleteUser (string user)
 deletes an existing user in the RBAC store
 
abstract string getName ()
 returns the name of the provider class
 
abstract bool intrinsic ()
 returns True if Qorus is the master of the contained RBAC information (ie all updates are made through Qorus facilities, ex: Qorus DB RBAC info), False if not (ex: ldap)
 
abstract bool hasStorage ()
 returns True if the provider includes user storage, False if not
 
abstract *hash loadUser (string user, string pass)
 loads a user (only called when the provider is non-intrinsic)
 
abstract bool authenticateUser (string user, *hash auth, string pass, reference rh)
 returns a hash of roles in the output parameter
 
abstract *list listUsers ()
 returns a list of user information hashes
 
abstract *hash getUser (string user)
 returns a user information hash or NOTHING if the user cannot be found
 
nothing reload ()
 called when the rbac subsystem is reloaded More...
 
*hash getInfoImpl ()
 this should be overridden in concrete subclasses to return statistics and information about the RBAC provider More...
 
 updateClientPerms (*string user, hash< auto > roles_perms)
 Updates the users' clients' permissions so that they don't permit anything besides what is in roles_perms. More...
 

Detailed Description

abstract base class for Qorus RBAC providers

Member Function Documentation

◆ getInfoImpl()

*hash QorusRbacAuth::AbstractRbacProvider::getInfoImpl ( )

this should be overridden in concrete subclasses to return statistics and information about the RBAC provider

The default implementation returns NOTHING

◆ reload()

nothing QorusRbacAuth::AbstractRbacProvider::reload ( )

called when the rbac subsystem is reloaded

The default implementation is to do nothing

◆ updateClientPerms()

QorusRbacAuth::AbstractRbacProvider::updateClientPerms ( *string  user,
hash< auto >  roles_perms 
)

Updates the users' clients' permissions so that they don't permit anything besides what is in roles_perms.

The default implementation does nothing but all providers that use clients with permissions should override this function.


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