Inheritance diagram for ILIAS\AuthApache\AuthProviderApache:

Collaboration diagram for ILIAS\AuthApache\AuthProviderApache:

Public Member Functions
	__construct (ilAuthCredentials $credentials)

	doAuthentication (ilAuthStatus $status)

	migrateAccount (ilAuthStatus $status)
	Create new account. More...

	createNewAccount (ilAuthStatus $status)
	Create new ILIAS account for external_account. More...

	getExternalAccountName ()
	Get external account name. More...

	setExternalAccountName (string $name)

	getTriggerAuthMode ()
	Get auth mode which triggered the account migration 2_1 for ldap account migration with server id 1 11 for apache auth. More...

	getUserAuthModeName ()
	Get user auth mode name ldap_1 for ldap account migration with server id 1 apache for apache auth. More...

Public Member Functions inherited from ilAuthProvider
	__construct (ilAuthCredentials $credentials)

	getLogger ()

	getCredentials ()

	doAuthentication (ilAuthStatus $status)

	getTriggerAuthMode ()
	Get auth mode which triggered the account migration 2_1 for ldap account migration with server id 1 11 for apache auth. More...

	getUserAuthModeName ()
	Get user auth mode name ldap_1 for ldap account migration with server id 1 apache for apache auth. More...

	getExternalAccountName ()
	Get external account name. More...

	migrateAccount (ilAuthStatus $status)
	Create new account. More...

	createNewAccount (ilAuthStatus $status)
	Create new ILIAS account for external_account. More...

Data Fields
const int	APACHE_AUTH_TYPE_DIRECT_MAPPING = 1

const int	APACHE_AUTH_TYPE_EXTENDED_MAPPING = 2

const int	APACHE_AUTH_TYPE_BY_FUNCTION = 3

Private Member Functions
	handleLDAPDataSource (ilAuthStatus $status)

Private Attributes
const string	ENV_APACHE_AUTH_INDICATOR_NAME = 'apache_auth_indicator_name'

const string	ENV_APACHE_AUTH_INDICATOR_VALUE = 'apache_auth_indicator_value'

const string	ERR_WRONG_LOGIN = 'err_wrong_login'

const string	APACHE_ENABLE_LDAP = 'apache_enable_ldap'

const string	APACHE_LDAP_SID = 'apache_ldap_sid'

readonly ilSetting	$settings

string	$migration_account = ''

bool	$force_new_account = false

Additional Inherited Members
Protected Member Functions inherited from ilAuthProvider
	handleAuthenticationFail (ilAuthStatus $status, string $a_reason)

Detailed Description

Definition at line 37 of file AuthProviderApache.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\AuthApache\AuthProviderApache::__construct ( ilAuthCredentials $credentials )

Reimplemented from ilAuthProvider.

Definition at line 55 of file AuthProviderApache.php.

    {
        parent::__construct($credentials);
        $this->settings = new ilSetting('apache_auth');
    }

References ilAuthProvider\$credentials, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ createNewAccount()

ILIAS\AuthApache\AuthProviderApache::createNewAccount ( ilAuthStatus $status )

Create new ILIAS account for external_account.

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 135 of file AuthProviderApache.php.

                                                          : void
    {
        $this->force_new_account = true;
        if ($this->settings->get(self::APACHE_ENABLE_LDAP, '0')) {
            $this->handleLDAPDataSource($status);
        }
    }

References ILIAS\AuthApache\AuthProviderApache\handleLDAPDataSource(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ doAuthentication()

ILIAS\AuthApache\AuthProviderApache::doAuthentication ( ilAuthStatus $status )

Implements ilAuthProviderInterface.

Definition at line 61 of file AuthProviderApache.php.

                                                          : bool
    {
        if (!$this->settings->get('apache_enable_auth', '0')) {
            $this->getLogger()->info('Apache auth disabled.');
            $this->handleAuthenticationFail($status, 'apache_auth_err_disabled');
            return false;
        }
 
        if (!$this->settings->get(self::ENV_APACHE_AUTH_INDICATOR_NAME, '') ||
            !$this->settings->get(self::ENV_APACHE_AUTH_INDICATOR_VALUE, '')) {
            $this->getLogger()->warning('Apache auth indicator match failure.');
            $this->handleAuthenticationFail($status, 'apache_auth_err_indicator_match_failure');
            return false;
        }
 
        $validIndicatorValues = array_filter(
            array_map(
                'trim',
                str_getcsv($this->settings->get(self::ENV_APACHE_AUTH_INDICATOR_VALUE, ''), ',', '"', '\\')
            )
        );
 
        //TODO PHP8-REVIEW: $DIC->http()->request()->getServerParams()['apache_auth_indicator_name']
        if (!isset($_SERVER[$this->settings->get(self::ENV_APACHE_AUTH_INDICATOR_NAME, '')]) ||
            !\in_array(
                $_SERVER[$this->settings->get(self::ENV_APACHE_AUTH_INDICATOR_NAME, '')],
                $validIndicatorValues,
                true
            )) {
            $this->getLogger()->warning('Apache authentication failed (indicator name <-> value');
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
            return false;
        }
 
        if (!ilUtil::isLogin($this->getCredentials()->getUsername())) {
            $this->getLogger()->warning('Invalid login name given: ' . $this->getCredentials()->getUsername());
            $this->handleAuthenticationFail($status, 'apache_auth_err_invalid_login');
            return false;
        }
 
        if ($this->getCredentials()->getUsername() === '') {
            $this->getLogger()->info('No username given');
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
            return false;
        }
 
        // Apache with ldap as data source
        if ($this->settings->get(self::APACHE_ENABLE_LDAP, '0')) {
            return $this->handleLDAPDataSource($status);
        }
 
        $login = ilObjUser::_checkExternalAuthAccount('apache', $this->getCredentials()->getUsername());
        $usr_id = ilObjUser::_lookupId($login);
        if (!$usr_id) {
            $this->getLogger()->info(
                'Cannot find user id for external account: ' . $this->getCredentials()->getUsername()
            );
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
            return false;
        }
 
        $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
        $status->setAuthenticatedUserId($usr_id);
        return true;
    }

References $_SERVER, ilObjUser\_checkExternalAuthAccount(), ilObjUser\_lookupId(), ilAuthProvider\getCredentials(), ilAuthProvider\getLogger(), ilAuthProvider\handleAuthenticationFail(), ILIAS\AuthApache\AuthProviderApache\handleLDAPDataSource(), ilUtil\isLogin(), ilAuthStatus\setAuthenticatedUserId(), ilAuthStatus\setStatus(), ILIAS\Repository\settings(), and ilAuthStatus\STATUS_AUTHENTICATED.

Here is the call graph for this function:

◆ getExternalAccountName()

ILIAS\AuthApache\AuthProviderApache::getExternalAccountName ( )

Get external account name.

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 143 of file AuthProviderApache.php.

                                            : string
    {
        return $this->migration_account;
    }

References ILIAS\AuthApache\AuthProviderApache\$migration_account.

◆ getTriggerAuthMode()

ILIAS\AuthApache\AuthProviderApache::getTriggerAuthMode ( )

Get auth mode which triggered the account migration 2_1 for ldap account migration with server id 1 11 for apache auth.

See also: ilAuthUtils

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 153 of file AuthProviderApache.php.

                                        : string
    {
        return (string) ilAuthUtils::AUTH_APACHE;
    }

References ilAuthUtils\AUTH_APACHE.

◆ getUserAuthModeName()

ILIAS\AuthApache\AuthProviderApache::getUserAuthModeName ( )

Get user auth mode name ldap_1 for ldap account migration with server id 1 apache for apache auth.

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 158 of file AuthProviderApache.php.

                                         : string
    {
        if ($this->settings->get(self::APACHE_LDAP_SID, '0')) {
            return 'ldap_' . $this->settings->get(self::APACHE_LDAP_SID, '');
        }
 
        return 'apache';
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ handleLDAPDataSource()

ILIAS\AuthApache\AuthProviderApache::handleLDAPDataSource ( ilAuthStatus $status )

private

Definition at line 167 of file AuthProviderApache.php.

                                                               : bool
    {
        $server = ilLDAPServer::getInstanceByServerId(
            (int) $this->settings->get(self::APACHE_LDAP_SID, '0')
        );
 
        $this->getLogger()->debug('Using ldap data source with server configuration: ' . $server->getName());
 
        $sync = new ilLDAPUserSynchronisation('ldap_' . $server->getServerId(), $server->getServerId());
        $sync->setExternalAccount($this->getCredentials()->getUsername());
        $sync->setUserData([]);
        $sync->forceCreation($this->force_new_account);
        $sync->forceReadLdapData(true);
 
        try {
            $internal_account = $sync->sync();
            $this->getLogger()->debug('Internal account: ' . $internal_account);
        } catch (\UnexpectedValueException $e) {
            $this->getLogger()->info('Login failed with message: ' . $e->getMessage());
            $this->handleAuthenticationFail($status, self::ERR_WRONG_LOGIN);
            return false;
        } catch (ilLDAPSynchronisationFailedException) {
            $this->handleAuthenticationFail($status, 'err_auth_ldap_failed');
            return false;
        } catch (ilLDAPSynchronisationForbiddenException $e) {
            $this->getLogger()->info('Login failed with message: ' . $e->getMessage());
            $this->handleAuthenticationFail($status, 'err_auth_ldap_no_ilias_user');
            return false;
        } catch (ilLDAPAccountMigrationRequiredException) {
            $this->setExternalAccountName($this->getCredentials()->getUsername());
            $this->getLogger()->info(\sprintf(
                'Authentication failed: account migration required for external account: %s',
                $this->getCredentials()->getUsername()
            ));
            $status->setStatus(ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED);
            return false;
        }
 
        $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
        $status->setAuthenticatedUserId(ilObjUser::_lookupId($internal_account));
        return true;
    }

References Vendor\Package\$e, $server, ilObjUser\_lookupId(), ilAuthProvider\getCredentials(), ilLDAPServer\getInstanceByServerId(), ilAuthProvider\getLogger(), ilAuthProvider\handleAuthenticationFail(), ilAuthStatus\setAuthenticatedUserId(), ILIAS\AuthApache\AuthProviderApache\setExternalAccountName(), ilAuthStatus\setStatus(), ILIAS\Repository\settings(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, and ilAuthStatus\STATUS_AUTHENTICATED.

Referenced by ILIAS\AuthApache\AuthProviderApache\createNewAccount(), ILIAS\AuthApache\AuthProviderApache\doAuthentication(), and ILIAS\AuthApache\AuthProviderApache\migrateAccount().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ migrateAccount()

ILIAS\AuthApache\AuthProviderApache::migrateAccount ( ilAuthStatus $status )

Create new account.

Implements ilAuthProviderAccountMigrationInterface.

Definition at line 127 of file AuthProviderApache.php.

                                                        : void
    {
        $this->force_new_account = true;
        if ($this->settings->get(self::APACHE_ENABLE_LDAP, '0')) {
            $this->handleLDAPDataSource($status);
        }
    }

References ILIAS\AuthApache\AuthProviderApache\handleLDAPDataSource(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ setExternalAccountName()

ILIAS\AuthApache\AuthProviderApache::setExternalAccountName ( string $name )

Definition at line 148 of file AuthProviderApache.php.

                                                        : void
    {
        $this->migration_account = $name;
    }

Referenced by ILIAS\AuthApache\AuthProviderApache\handleLDAPDataSource().

Here is the caller graph for this function:

Field Documentation

◆ $force_new_account

bool ILIAS\AuthApache\AuthProviderApache::$force_new_account = false

private

Definition at line 53 of file AuthProviderApache.php.

◆ $migration_account

string ILIAS\AuthApache\AuthProviderApache::$migration_account = ''

private

Definition at line 52 of file AuthProviderApache.php.

Referenced by ILIAS\AuthApache\AuthProviderApache\getExternalAccountName().

◆ $settings

readonly ilSetting ILIAS\AuthApache\AuthProviderApache::$settings

private

Definition at line 51 of file AuthProviderApache.php.

◆ APACHE_AUTH_TYPE_BY_FUNCTION

const int ILIAS\AuthApache\AuthProviderApache::APACHE_AUTH_TYPE_BY_FUNCTION = 3

Definition at line 41 of file AuthProviderApache.php.

Referenced by ILIAS\AuthApache\AuthFrontendCredentialsApache\initFromRequest().

◆ APACHE_AUTH_TYPE_DIRECT_MAPPING

const int ILIAS\AuthApache\AuthProviderApache::APACHE_AUTH_TYPE_DIRECT_MAPPING = 1

Definition at line 39 of file AuthProviderApache.php.

Referenced by ILIAS\AuthApache\AuthFrontendCredentialsApache\initFromRequest().

◆ APACHE_AUTH_TYPE_EXTENDED_MAPPING

const int ILIAS\AuthApache\AuthProviderApache::APACHE_AUTH_TYPE_EXTENDED_MAPPING = 2

Definition at line 40 of file AuthProviderApache.php.

◆ APACHE_ENABLE_LDAP

const string ILIAS\AuthApache\AuthProviderApache::APACHE_ENABLE_LDAP = 'apache_enable_ldap'

private

Definition at line 48 of file AuthProviderApache.php.

◆ APACHE_LDAP_SID

const string ILIAS\AuthApache\AuthProviderApache::APACHE_LDAP_SID = 'apache_ldap_sid'

private

Definition at line 49 of file AuthProviderApache.php.

◆ ENV_APACHE_AUTH_INDICATOR_NAME

const string ILIAS\AuthApache\AuthProviderApache::ENV_APACHE_AUTH_INDICATOR_NAME = 'apache_auth_indicator_name'

private

Definition at line 43 of file AuthProviderApache.php.

◆ ENV_APACHE_AUTH_INDICATOR_VALUE

const string ILIAS\AuthApache\AuthProviderApache::ENV_APACHE_AUTH_INDICATOR_VALUE = 'apache_auth_indicator_value'

private

Definition at line 44 of file AuthProviderApache.php.

◆ ERR_WRONG_LOGIN

const string ILIAS\AuthApache\AuthProviderApache::ERR_WRONG_LOGIN = 'err_wrong_login'

private

Definition at line 46 of file AuthProviderApache.php.

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

components/ILIAS/AuthApache/src/AuthProviderApache.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNewAccount()

◆ doAuthentication()

◆ getExternalAccountName()

◆ getTriggerAuthMode()

◆ getUserAuthModeName()

◆ handleLDAPDataSource()

◆ migrateAccount()

◆ setExternalAccountName()

Field Documentation

◆ $force_new_account

◆ $migration_account

◆ $settings

◆ APACHE_AUTH_TYPE_BY_FUNCTION

◆ APACHE_AUTH_TYPE_DIRECT_MAPPING

◆ APACHE_AUTH_TYPE_EXTENDED_MAPPING

◆ APACHE_ENABLE_LDAP

◆ APACHE_LDAP_SID

◆ ENV_APACHE_AUTH_INDICATOR_NAME

◆ ENV_APACHE_AUTH_INDICATOR_VALUE

◆ ERR_WRONG_LOGIN