ilAuthProvider Class Reference

Base class for authentication providers (radius, ldap, apache, ...) More...

Inheritance diagram for ilAuthProvider:

Collaboration diagram for ilAuthProvider:

Public Member Functions
	__construct (ilAuthCredentials $credentials)
	Constructor. More...
	getLogger ()
	Get logger. More...
	getCredentials ()
Public Member Functions inherited from ilAuthProviderInterface
	doAuthentication (\ilAuthStatus $status)
	Do authentication. More...

Data Fields
const	STATUS_UNDEFINED = 0
const	STATUS_AUTHENTICATION_SUCCESS = 1
const	STATUS_AUTHENTICATION_FAILED = 2
const	STATUS_MIGRATION = 3

Protected Member Functions
	handleAuthenticationFail (ilAuthStatus $status, $a_reason)
	Handle failed authentication. More...

Private Attributes
	$logger = null
	$credentials = null
	$status = self::STATUS_UNDEFINED
	$user_id = 0

Detailed Description

Base class for authentication providers (radius, ldap, apache, ...)

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 11 of file class.ilAuthProvider.php.

Constructor & Destructor Documentation

__construct()

ilAuthProvider::__construct

(

ilAuthCredentials

$credentials

)

Constructor.

Definition at line 28 of file class.ilAuthProvider.php.

References $credentials, and ilLoggerFactory\getLogger().

    {
        $this->logger = ilLoggerFactory::getLogger('auth');
        $this->credentials = $credentials;
    }

Here is the call graph for this function:

Member Function Documentation

getCredentials()

ilAuthProvider::getCredentials

(

)

Returns

$credentials

Definition at line 46 of file class.ilAuthProvider.php.

References $credentials.

Referenced by ilAuthProviderLDAP\createNewAccount(), ilAuthProviderSaml\createNewAccount(), ilAuthProviderLTI\createUser(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderLDAP\doAuthentication(), ilAuthProviderRadius\doAuthentication(), ilAuthProviderApache\doAuthentication(), ilAuthProviderOpenIdConnect\doAuthentication(), ilAuthProviderSoap\doAuthentication(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderSoap\handleSoapAuth(), ilAuthProviderOpenIdConnect\handleUpdate(), ilAuthProviderLDAP\migrateAccount(), and ilAuthProviderLDAP\updateAccount().

    {
        return $this->credentials;
    }

Here is the caller graph for this function:

getLogger()

ilAuthProvider::getLogger

(

)

Get logger.

Returns

$logger

Definition at line 38 of file class.ilAuthProvider.php.

References $logger.

Referenced by ilAuthProviderLDAP\createNewAccount(), ilAuthProviderSaml\createNewAccount(), ilAuthProviderLTI\createUser(), ilAuthProviderECS\createUser(), ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderLDAP\doAuthentication(), ilAuthProviderRadius\doAuthentication(), ilAuthProviderApache\doAuthentication(), ilAuthProviderOpenIdConnect\doAuthentication(), ilAuthProviderSoap\doAuthentication(), ilAuthProviderSaml\doAuthentication(), ilAuthProviderECS\doAuthentication(), ilAuthProviderLTI\findAuthKeyId(), ilAuthProviderLTI\findAuthPrefix(), ilAuthProviderLTI\findGlobalRole(), ilAuthProviderLTI\findUserId(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderLTI\handleLocalRoleAssignments(), ilAuthProviderECS\handleLogin(), ilAuthProviderOpenIdConnect\handleLogout(), ilAuthProviderOpenIdConnect\handleUpdate(), ilAuthProviderSaml\importUser(), ilAuthProviderLDAP\migrateAccount(), ilAuthProviderLDAP\updateAccount(), ilAuthProviderLTI\updateUser(), ilAuthProviderECS\updateUser(), and ilAuthProviderECS\validateHash().

    {
        return $this->logger;
    }

Here is the caller graph for this function:

handleAuthenticationFail()

ilAuthProvider::handleAuthenticationFail ( ilAuthStatus  $status,   $a_reason  )

protected

Handle failed authentication.

Parameters

string

$a_reason

Definition at line 55 of file class.ilAuthProvider.php.

References ilAuthStatus\setReason(), ilAuthStatus\setStatus(), and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

Referenced by ilAuthProviderLDAP\createNewAccount(), ilAuthProviderSaml\createNewAccount(), ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderLDAP\doAuthentication(), ilAuthProviderRadius\doAuthentication(), ilAuthProviderApache\doAuthentication(), ilAuthProviderSaml\doAuthentication(), ilAuthProviderECS\doAuthentication(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderSaml\handleSamlAuth(), ilAuthProviderLDAP\migrateAccount(), and ilAuthProviderLDAP\updateAccount().

    {
        $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
        $status->setReason($a_reason);
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$credentials

ilAuthProvider::$credentials = null

private

Definition at line 21 of file class.ilAuthProvider.php.

Referenced by __construct(), and getCredentials().

$logger

ilAuthProvider::$logger = null

private

Definition at line 19 of file class.ilAuthProvider.php.

Referenced by getLogger().

$status

ilAuthProvider::$status = self::STATUS_UNDEFINED

private

Definition at line 23 of file class.ilAuthProvider.php.

Referenced by ilAuthProviderOpenIdConnect\handleUpdate().

$user_id

ilAuthProvider::$user_id = 0

private

Definition at line 24 of file class.ilAuthProvider.php.

Referenced by ilAuthProviderLTI\findUserId(), ilAuthProviderLTI\handleLocalRoleAssignments(), and ilAuthProviderOpenIdConnect\handleUpdate().

STATUS_AUTHENTICATION_FAILED

const ilAuthProvider::STATUS_AUTHENTICATION_FAILED = 2

Definition at line 15 of file class.ilAuthProvider.php.

STATUS_AUTHENTICATION_SUCCESS

const ilAuthProvider::STATUS_AUTHENTICATION_SUCCESS = 1

Definition at line 14 of file class.ilAuthProvider.php.

STATUS_MIGRATION

const ilAuthProvider::STATUS_MIGRATION = 3

Definition at line 16 of file class.ilAuthProvider.php.

STATUS_UNDEFINED

const ilAuthProvider::STATUS_UNDEFINED = 0

Definition at line 13 of file class.ilAuthProvider.php.

---

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

• Services/Authentication/classes/Provider/class.ilAuthProvider.php