ilAuthFrontendHTTP Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilAuthFrontendHTTP:

Collaboration diagram for ilAuthFrontendHTTP:

Public Member Functions
	__construct (ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
	authenticate ()
	Try authentication. More...
Public Member Functions inherited from ilAuthFrontend
	__construct (ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
	getAuthSession ()
	Get auth session. More...
	getCredentials ()
	Get auth credentials. More...
	getProviders ()
	Get providers. More...
	getStatus ()
	resetStatus ()
	Reset status. More...
	migrateAccount (ilAuthSession $session)
	Migrate Account to existing user account. More...
	migrateAccountNew ()
	Create new user account. More...
	authenticate ()
	Try to authenticate user. More...

Protected Member Functions
	handleAuthenticationFail ()
	Draw basic auth. More...
Protected Member Functions inherited from ilAuthFrontend
	handleAccountMigration (ilAuthProviderAccountMigrationInterface $provider)
	Handle account migration. More...
	handleAuthenticationSuccess (ilAuthProviderInterface $provider)
	Handle successful authentication. More...
	checkActivation (ilObjUser $user)
	Check activation. More...
	checkExceededLoginAttempts (ilObjUser $user)
	checkTimeLimit (ilObjUser $user)
	Check time limit. More...
	checkIp (ilObjUser $user)
	Check ip. More...
	checkSimultaneousLogins (ilObjUser $user)
	Check simultaneous logins. More...
	handleAuthenticationFail ()
	Handle failed authenication. More...
	handleLoginAttempts ()

Private Attributes
ilLogger	$logger

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__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

(

)

Try authentication.

Implements ilAuthFrontendInterface.

Definition at line 36 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

Draw basic auth.

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

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

Referenced by authenticate().

                                                 : bool
    {
        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 26 of file class.ilAuthFrontendHTTP.php.

---

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

• Services/Authentication/classes/Frontend/class.ilAuthFrontendHTTP.php