ilAuthModeDetermination Class Reference

Collaboration diagram for ilAuthModeDetermination:

Public Member Functions
	isManualSelection ()
	is manual selection More...
	getKind ()
	get kind More...
	setKind (int $a_kind)
	set kind of determination More...
	getAuthModeSequence (string $a_username='')
	get auth mode sequence More...
	getCountActiveAuthModes ()
	get number of auth modes More...
	setAuthModeSequence (array $a_pos)
	set auth mode sequence More...
	save ()
	Save settings. More...

Static Public Member Functions
static	_getInstance ()
	Get instance. More...

Data Fields
const	TYPE_MANUAL = 0
const	TYPE_AUTOMATIC = 1

Private Member Functions
	__construct ()
	Constructor (Singleton) More...
	read ()
	Read settings. More...

Private Attributes
ilLogger	$logger
ilSetting	$settings
ilSetting	$commonSettings
int	$kind = self::TYPE_MANUAL
array	$position = []

Static Private Attributes
static ilAuthModeDetermination	$instance = null

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilAuthModeDetermination::__construct ( )

private

Constructor (Singleton)

private

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

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

    {
        global $DIC;

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

        $this->commonSettings = $DIC->settings();

        $this->settings = new ilSetting("auth_mode_determination");
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilAuthModeDetermination::_getInstance ( )

static

Get instance.

Definition at line 61 of file class.ilAuthModeDetermination.php.

Referenced by ilObjAuthSettingsGUI\buildAuthModeDeterminationForm(), ilStartUpGUI\buildStandardLoginForm(), ilStartUpGUI\doStandardAuthentication(), ilAuthProviderFactory\getProviders(), ilAuthFrontend\handleLoginAttempts(), and ilObjAuthSettingsGUI\updateAuthModeDeterminationObject().

                                         : ilAuthModeDetermination
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilAuthModeDetermination();
    }

Here is the caller graph for this function:

getAuthModeSequence()

ilAuthModeDetermination::getAuthModeSequence

(

string

$a_username = ''

)

get auth mode sequence

Definition at line 100 of file class.ilAuthModeDetermination.php.

References $message, $server, ilLDAPServer\getInstanceByServerId(), ilLDAPServer\getServerIdByAuthMode(), ILIAS\Repository\logger(), and ilAuthUtils\REGEX_DELIMITERS.

                                                                : array
    {
        if ($a_username === '') {
            return $this->position ?: array();
        }
        $sorted = array();

        foreach ($this->position as $auth_key) {
            $sid = ilLDAPServer::getServerIdByAuthMode((string) $auth_key);
            if ($sid) {
                $server = ilLDAPServer::getInstanceByServerId($sid);
                $this->logger->debug('Validating username filter for ' . $server->getName());
                if ($server->getUsernameFilter() !== '') {
                    //#17731
                    $pattern = str_replace('*', '.*?', $server->getUsernameFilter());

                    foreach (ilAuthUtils::REGEX_DELIMITERS as $delimiter) {
                        $this->logger->debug('Trying pattern to match username:' . $pattern . ' => ' . $a_username);
                        set_error_handler(static function (int $severity, string $message, string $file, int $line): never {
                            throw new ErrorException($message, $severity, $severity, $file, $line);
                        });

                        try {
                            if (preg_match($delimiter . "^" . $pattern . '$' . $delimiter . 'i', $a_username) === 1) {
                                $this->logger->debug('Filter matches for ' . $a_username);
                                array_unshift($sorted, $auth_key);
                                continue 2;
                            }
                            break;
                        } catch (Exception $ex) {
                            $this->logger->warning('Error occurred in preg_match Ex.: ' . $ex->getMessage());
                        } finally {
                            restore_error_handler();
                        }
                    }

                    $this->logger->debug('Filter matches not for ' . $a_username . ' <-> ' . $server->getUsernameFilter());
                }
            }
            $sorted[] = $auth_key;
        }

        return $sorted;
    }

Here is the call graph for this function:

getCountActiveAuthModes()

ilAuthModeDetermination::getCountActiveAuthModes

(

)

get number of auth modes

Definition at line 148 of file class.ilAuthModeDetermination.php.

                                             : int
    {
        return count($this->position);
    }

getKind()

ilAuthModeDetermination::getKind

(

)

get kind

Definition at line 80 of file class.ilAuthModeDetermination.php.

References $kind.

Referenced by save().

                             : int
    {
        return $this->kind;
    }

Here is the caller graph for this function:

isManualSelection()

ilAuthModeDetermination::isManualSelection

(

)

is manual selection

Definition at line 72 of file class.ilAuthModeDetermination.php.

                                       : bool
    {
        return $this->kind === self::TYPE_MANUAL;
    }

read()

ilAuthModeDetermination::read ( )

private

Read settings.

Definition at line 183 of file class.ilAuthModeDetermination.php.

References $server, ilLDAPServer\_getActiveServerList(), ilAuthUtils\AUTH_APACHE, ilAuthUtils\AUTH_LDAP, ilAuthUtils\AUTH_LOCAL, ilAuthUtils\AUTH_SOAP, ilAuthUtils\getAuthPlugins(), ilLDAPServer\getInstanceByServerId(), ilLDAPServer\getServerIdByAuthMode(), ILIAS\Repository\int(), null, and ILIAS\Repository\settings().

Referenced by __construct().

                           : void
    {
        $this->kind = (int) $this->settings->get('kind', (string) self::TYPE_MANUAL);

        $soap_active = (bool) $this->commonSettings->get('soap_auth_active', "");

        // apache settings
        $apache_settings = new ilSetting('apache_auth');
        $apache_active = $apache_settings->get('apache_enable_auth');

        // Check if active
        $i = 0;
        while (true) {
            $auth_mode = $this->settings->get((string) $i++, null);
            if ($auth_mode === null) {
                break;
            }
            if ($auth_mode) {
                switch ((int) $auth_mode) {
                    case ilAuthUtils::AUTH_LOCAL:
                        $this->position[] = (int) $auth_mode;
                        break;
                    case ilAuthUtils::AUTH_LDAP:
                        $auth_id = ilLDAPServer::getServerIdByAuthMode($auth_mode);
                        if ($auth_id === null) {
                            break;
                        }
                        $server = ilLDAPServer::getInstanceByServerId($auth_id);

                        if ($server->isActive()) {
                            $this->position[] = $auth_mode;
                        }
                        break;

                    case ilAuthUtils::AUTH_SOAP:
                        if ($soap_active) {
                            $this->position[] = (int) $auth_mode;
                        }
                        break;

                    case ilAuthUtils::AUTH_APACHE:
                        if ($apache_active) {
                            $this->position[] = (int) $auth_mode;
                        }
                        break;

                    default:
                        foreach (ilAuthUtils::getAuthPlugins() as $pl) {
                            if ($pl->isAuthActive((int) $auth_mode)) {
                                $this->position[] = $auth_mode;
                            }
                        }
                        break;
                }
            }
        }

        // Append missing active auth modes
        if (!in_array(ilAuthUtils::AUTH_LOCAL, $this->position, true)) {
            $this->position[] = ilAuthUtils::AUTH_LOCAL;
        }
        // begin-patch ldap_multiple
        foreach (ilLDAPServer::_getActiveServerList() as $sid) {
            $server = ilLDAPServer::getInstanceByServerId($sid);
            if ($server->isActive() && !in_array(ilAuthUtils::AUTH_LDAP . '_' . $sid, $this->position, true)) {
                $this->position[] = (ilAuthUtils::AUTH_LDAP . '_' . $sid);
            }
        }
        // end-patch ldap_multiple
        if ($soap_active && !in_array(ilAuthUtils::AUTH_SOAP, $this->position, true)) {
            $this->position[] = ilAuthUtils::AUTH_SOAP;
        }
        if ($apache_active && !in_array(ilAuthUtils::AUTH_APACHE, $this->position, true)) {
            $this->position[] = ilAuthUtils::AUTH_APACHE;
        }
        // begin-patch auth_plugin
        foreach (ilAuthUtils::getAuthPlugins() as $pl) {
            foreach ($pl->getAuthIds() as $auth_id) {
                if ($pl->isAuthActive($auth_id) && !in_array($auth_id, $this->position, true)) {
                    $this->position[] = $auth_id;
                }
            }
        }
        // end-patch auth_plugin
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilAuthModeDetermination::save

(

)

Save settings.

Definition at line 167 of file class.ilAuthModeDetermination.php.

References getKind(), and ILIAS\Repository\settings().

                          : void
    {
        $this->settings->deleteAll();

        $this->settings->set('kind', (string) $this->getKind());

        $counter = 0;
        foreach ($this->position as $auth_mode) {
            $this->settings->set((string) $counter++, (string) $auth_mode);
        }
    }

Here is the call graph for this function:

setAuthModeSequence()

ilAuthModeDetermination::setAuthModeSequence

(

array

$a_pos

)

set auth mode sequence

Parameters

array

position => AUTH_MODE

Definition at line 159 of file class.ilAuthModeDetermination.php.

                                                     : void
    {
        $this->position = $a_pos;
    }

setKind()

ilAuthModeDetermination::setKind

(

int

$a_kind

)

set kind of determination

Parameters

int	TYPE_MANUAL or TYPE_DETERMINATION

Definition at line 91 of file class.ilAuthModeDetermination.php.

                                        : void
    {
        // TODO check value range
        $this->kind = $a_kind;
    }

Field Documentation

$commonSettings

ilSetting ilAuthModeDetermination::$commonSettings

private

Definition at line 34 of file class.ilAuthModeDetermination.php.

$instance

ilAuthModeDetermination ilAuthModeDetermination::$instance = null

staticprivate

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

$kind

int ilAuthModeDetermination::$kind = self::TYPE_MANUAL

private

Definition at line 36 of file class.ilAuthModeDetermination.php.

Referenced by getKind().

$logger

ilLogger ilAuthModeDetermination::$logger

private

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

$position

array ilAuthModeDetermination::$position = []

private

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

$settings

ilSetting ilAuthModeDetermination::$settings

private

Definition at line 33 of file class.ilAuthModeDetermination.php.

TYPE_AUTOMATIC

const ilAuthModeDetermination::TYPE_AUTOMATIC = 1

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

Referenced by ilObjAuthSettingsGUI\buildAuthModeDeterminationForm(), and ilObjAuthSettingsGUI\updateAuthModeDeterminationObject().

TYPE_MANUAL

const ilAuthModeDetermination::TYPE_MANUAL = 0

Definition at line 26 of file class.ilAuthModeDetermination.php.

Referenced by ilObjAuthSettingsGUI\buildAuthModeDeterminationForm().

---

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

• components/ILIAS/Authentication/classes/class.ilAuthModeDetermination.php