ilAuthProviderFactory Class Reference

Inheritance diagram for ilAuthProviderFactory:

Collaboration diagram for ilAuthProviderFactory:

Public Member Functions
	__construct ()
	getProviders (ilAuthCredentials $credentials)
	getProviderByAuthMode (ilAuthCredentials $credentials, $a_authmode)

Private Attributes
ilLogger	$logger

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAuthProviderFactory::__construct

(

)

Definition at line 25 of file class.ilAuthProviderFactory.php.

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

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

Here is the call graph for this function:

Member Function Documentation

getProviderByAuthMode()

ilAuthProviderFactory::getProviderByAuthMode	(	ilAuthCredentials	$credentials,
			$a_authmode
	)

Parameters

string | int

$a_authmode

Definition at line 60 of file class.ilAuthProviderFactory.php.

References $provider, ilAuthUtils\AUTH_APACHE, ilAuthUtils\AUTH_CAS, ilAuthUtils\AUTH_ECS, ilAuthUtils\AUTH_LDAP, ilAuthUtils\AUTH_LOCAL, ilAuthUtils\AUTH_OPENID_CONNECT, ilAuthUtils\AUTH_PROVIDER_LTI, ilAuthUtils\AUTH_SAML, ilAuthUtils\AUTH_SHIBBOLETH, ilAuthUtils\AUTH_SOAP, ilAuthUtils\getAuthPlugins(), ilSamlIdp\getIdpIdByAuthMode(), ILIAS\Repository\logger(), and null.

Referenced by ilAuthProviderCliFactory\getProviders(), and getProviders().

                                                                                      : ?ilAuthProviderInterface
    {
        switch ((int) $a_authmode) {
            case ilAuthUtils::AUTH_LDAP:
                $ldap_info = explode('_', $a_authmode);
                $this->logger->debug('Using ldap authentication with credentials ');
                return new ilAuthProviderLDAP($credentials, (int) $ldap_info[1]);

            case ilAuthUtils::AUTH_LOCAL:
                $this->logger->debug('Using local database authentication');
                return new ilAuthProviderDatabase($credentials);

            case ilAuthUtils::AUTH_SOAP:
                $this->logger->debug('Using SOAP authentication.');
                return new ilAuthProviderSoap($credentials);

            case ilAuthUtils::AUTH_APACHE:
                $this->logger->debug('Using apache authentication.');
                return new ilAuthProviderApache($credentials);

            case ilAuthUtils::AUTH_CAS:
                $this->logger->debug('Using CAS authentication');
                return new ilAuthProviderCAS($credentials);

            case ilAuthUtils::AUTH_SHIBBOLETH:
                $this->logger->debug('Using shibboleth authentication.');
                return new ilAuthProviderShibboleth($credentials);

            case ilAuthUtils::AUTH_PROVIDER_LTI:
                $this->logger->debug('Using lti provider authentication.');
                return new ilAuthProviderLTI($credentials);

            case ilAuthUtils::AUTH_ECS:
                $this->logger->debug('Using ecs authentication.');
                return new ilAuthProviderECS($credentials);

            case ilAuthUtils::AUTH_SAML:
                $this->logger->debug('Using apache authentication.');
                return new ilAuthProviderSaml($credentials, ilSamlIdp::getIdpIdByAuthMode($a_authmode));

            case ilAuthUtils::AUTH_OPENID_CONNECT:
                $this->logger->debug('Using openid connect authentication.');
                return new ilAuthProviderOpenIdConnect($credentials);

            default:
                $this->logger->debug('Plugin authentication: ' . $a_authmode);
                foreach (ilAuthUtils::getAuthPlugins() as $pl) {
                    $provider = $pl->getProvider($credentials, $a_authmode);
                    if ($provider instanceof ilAuthProviderInterface) {
                        return $provider;
                    }
                }
                break;
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProviders()

ilAuthProviderFactory::getProviders

(

ilAuthCredentials

$credentials

)

Returns

list<ilAuthProviderInterface>

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

References $provider, ilAuthModeDetermination\_getInstance(), ilAuthCredentials\getAuthMode(), getProviderByAuthMode(), ilAuthCredentials\getUsername(), and ILIAS\Repository\logger().

                                                                : array
    {
        // Fixed provider selection;
        if ($credentials->getAuthMode() !== '') {
            $this->logger->debug('Returning fixed provider for auth mode: ' . $credentials->getAuthMode());
            return [
                $this->getProviderByAuthMode($credentials, $credentials->getAuthMode())
            ];
        }

        $auth_determination = ilAuthModeDetermination::_getInstance();
        $sequence = $auth_determination->getAuthModeSequence($credentials->getUsername());

        $providers = [];
        foreach ($sequence as $position => $authmode) {
            $provider = $this->getProviderByAuthMode($credentials, (string) $authmode);
            if ($provider instanceof ilAuthProviderInterface) {
                $providers[] = $provider;
            }
        }
        return $providers;
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilAuthProviderFactory::$logger

private

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

---

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

• components/ILIAS/Authentication/classes/Provider/class.ilAuthProviderFactory.php