ilAuthProvider Class Reference

Base class for authentication providers (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...

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

Private Attributes
const	STATUS_UNDEFINED = 0
const	STATUS_AUTHENTICATION_SUCCESS = 1
const	STATUS_AUTHENTICATION_FAILED = 2
const	STATUS_MIGRATION = 3
ilLogger	$logger
ilAuthCredentials	$credentials
int	$status = self::STATUS_UNDEFINED
int	$user_id = 0

Detailed Description

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

Author

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

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

Constructor & Destructor Documentation

__construct()

ilAuthProvider::__construct

(

ilAuthCredentials

$credentials

)

Constructor.

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

References $credentials, $DIC, and ILIAS\Repository\logger().

    {
        global $DIC;
        $this->logger = $DIC->logger()->auth();
        $this->credentials = $credentials;
    }

Here is the call graph for this function:

Member Function Documentation

getCredentials()

ilAuthProvider::getCredentials

(

)

Returns

$credentials

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

References $credentials.

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

                                    : ilAuthCredentials
    {
        return $this->credentials;
    }

Here is the caller graph for this function:

getLogger()

ilAuthProvider::getLogger

(

)

Get logger.

Returns

$logger

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

References $logger.

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

                               : ilLogger
    {
        return $this->logger;
    }

Here is the caller graph for this function:

handleAuthenticationFail()

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

protected

Handle failed authentication.

Definition at line 71 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(), ilAuthProviderApache\doAuthentication(), ilAuthProviderLDAP\doAuthentication(), ilAuthProviderSaml\doAuthentication(), ilAuthProviderECS\doAuthentication(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderECS\handleLoginByAuthMode(), ilAuthProviderSaml\handleSamlAuth(), ilAuthProviderLDAP\migrateAccount(), and ilAuthProviderLDAP\updateAccount().

                                                                                       : bool
    {
        $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

ilAuthCredentials ilAuthProvider::$credentials

private

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

Referenced by __construct(), and getCredentials().

$logger

ilLogger ilAuthProvider::$logger

private

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

Referenced by getLogger().

$status

int ilAuthProvider::$status = self::STATUS_UNDEFINED

private

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

Referenced by ilAuthProviderLTI\findGlobalRole(), and ilAuthProviderOpenIdConnect\handleUpdate().

$user_id

int ilAuthProvider::$user_id = 0

private

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

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

STATUS_AUTHENTICATION_FAILED

const ilAuthProvider::STATUS_AUTHENTICATION_FAILED = 2

private

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

STATUS_AUTHENTICATION_SUCCESS

const ilAuthProvider::STATUS_AUTHENTICATION_SUCCESS = 1

private

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

STATUS_MIGRATION

const ilAuthProvider::STATUS_MIGRATION = 3

private

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

STATUS_UNDEFINED

const ilAuthProvider::STATUS_UNDEFINED = 0

private

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

---

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

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