ilAuthFrontendHTTP Class Reference

Inheritance diagram for ilAuthFrontendHTTP:

Collaboration diagram for ilAuthFrontendHTTP:

Public Member Functions
	__construct (ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
	authenticate ()
Public Member Functions inherited from ilAuthFrontend
	__construct (ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
	getAuthSession ()
	getCredentials ()
	getProviders ()
	getStatus ()
	resetStatus ()
	migrateAccount (ilAuthSession $session)
	migrateAccountNew ()
	authenticate ()

Protected Member Functions
	handleAuthenticationFail ()
Protected Member Functions inherited from ilAuthFrontend
	handleAccountMigration (ilAuthProviderAccountMigrationInterface $provider)
	handleAuthenticationSuccess (ilAuthProviderInterface $provider)
	checkActivation (ilObjUser $user)
	checkExceededLoginAttempts (ilObjUser $user)
	checkTimeLimit (ilObjUser $user)
	checkIp (ilObjUser $user)
	checkSimultaneousLogins (ilObjUser $user)
	handleAuthenticationFail ()
	handleLoginAttempts ()

Private Attributes
ilLogger	$logger

Additional Inherited Members
Data Fields inherited from ilAuthFrontend
const string	MIG_EXTERNAL_ACCOUNT = 'mig_ext_account'
const string	MIG_TRIGGER_AUTHMODE = 'mig_trigger_auth_mode'
const string	MIG_DESIRED_AUTHMODE = 'mig_desired_auth_mode'

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAuthFrontendHTTP::__construct	(	ilAuthSession	$session,
		ilAuthStatus	$status,
		ilAuthCredentials	$credentials,
		array	$providers
	)

Parameters

list<ilAuthProviderInterface>

$providers

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\logger().

      {
        parent::__construct($session, $status, $credentials, $providers);

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

Here is the call graph for this function:

Member Function Documentation

authenticate()

ilAuthFrontendHTTP::authenticate

(

)

Implements ilAuthFrontendInterface.

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

References $provider, ilAuthFrontend\getProviders(), ilAuthFrontend\getStatus(), handleAuthenticationFail(), ilAuthFrontend\handleAuthenticationSuccess(), ILIAS\Repository\logger(), ilAuthFrontend\resetStatus(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                  : bool
    {
        foreach ($this->getProviders() as $provider) {
            $this->resetStatus();

            $this->logger->debug('Trying authentication against: ' . get_class($provider));

            $provider->doAuthentication($this->getStatus());

            $this->logger->debug('Authentication user id: ' . $this->getStatus()
                ->getAuthenticatedUserId());

            switch ($this->getStatus()->getStatus()) {
                case ilAuthStatus::STATUS_AUTHENTICATED:
                    return $this->handleAuthenticationSuccess($provider);

                case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                    $this->logger->notice('Account migration required.');
                    break;

                case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                default:
                    $this->logger->debug('Authentication failed against: ' . get_class($provider));
                    break;
            }
        }
        return $this->handleAuthenticationFail();
    }

Here is the call graph for this function:

handleAuthenticationFail()

ilAuthFrontendHTTP::handleAuthenticationFail ( )

protected

Definition at line 69 of file class.ilAuthFrontendHTTP.php.

References CLIENT_ID, and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Referenced by authenticate().

                                                 : bool
    {
        parent::handleAuthenticationFail();

        header('WWW-Authenticate: Basic realm="' . CLIENT_ID . '"');
        header('HTTP/1.0 401 Unauthorized');
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$logger

ilLogger ilAuthFrontendHTTP::$logger

private

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

---

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

• components/ILIAS/Authentication/classes/Frontend/class.ilAuthFrontendHTTP.php