ilAuthProviderFactory Class Reference

Auth provider factory. More...

Collaboration diagram for ilAuthProviderFactory:

Public Member Functions
	__construct ()
	Constructor. More...
	getLogger ()
	Get current logger. More...
	getProviders (ilAuthCredentials $credentials)
	Get provider. More...
	getProviderByAuthMode (ilAuthCredentials $credentials, $a_authmode)
	Get provider by auth mode. More...

Private Attributes
	$logger = null

Detailed Description

Auth provider factory.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilAuthProviderFactory::__construct

(

)

Constructor.

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

References ilLoggerFactory\getLogger().

    {
        $this->logger = ilLoggerFactory::getLogger('auth');
    }

Here is the call graph for this function:

Member Function Documentation

getLogger()

ilAuthProviderFactory::getLogger

(

)

Get current logger.

Returns

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

References $logger.

Referenced by getProviderByAuthMode(), and getProviders().

    {
        return $this->logger;
    }

Here is the caller graph for this function:

getProviderByAuthMode()

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

Get provider by auth mode.

Returns

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

References PHPMailer\PHPMailer\$provider, AUTH_APACHE, AUTH_CAS, AUTH_ECS, AUTH_LDAP, AUTH_LOCAL, AUTH_OPENID_CONNECT, AUTH_PROVIDER_LTI, AUTH_RADIUS, AUTH_SAML, AUTH_SHIBBOLETH, AUTH_SOAP, ilAuthUtils\getAuthPlugins(), ilSamlIdp\getIdpIdByAuthMode(), and getLogger().

Referenced by getProviders().

    {
        switch ((int) $a_authmode) {
            case AUTH_LDAP:
                $ldap_info = explode('_', $a_authmode);
                $this->getLogger()->debug('Using ldap authentication with credentials ');
                include_once './Services/LDAP/classes/class.ilAuthProviderLDAP.php';
                return new ilAuthProviderLDAP($credentials, $ldap_info[1]);
            
            case AUTH_LOCAL:
                $this->getLogger()->debug('Using local database authentication');
                include_once './Services/Authentication/classes/Provider/class.ilAuthProviderDatabase.php';
                return new ilAuthProviderDatabase($credentials);
                
            case AUTH_SOAP:
                $this->getLogger()->debug('Using SOAP authentication.');
                include_once './Services/SOAPAuth/classes/class.ilAuthProviderSoap.php';
                return new ilAuthProviderSoap($credentials);
                
            case AUTH_APACHE:
                $this->getLogger()->debug('Using apache authentication.');
                include_once './Services/AuthApache/classes/class.ilAuthProviderApache.php';
                return new ilAuthProviderApache($credentials);

            case AUTH_CAS:
                $this->getLogger()->debug('Using CAS authentication');
                include_once './Services/CAS/classes/class.ilAuthProviderCAS.php';
                return new ilAuthProviderCAS($credentials);

            case AUTH_RADIUS:
                $this->getLogger()->debug('Using radius authentication.');
                include_once './Services/Radius/classes/class.ilAuthProviderRadius.php';
                return new ilAuthProviderRadius($credentials);
                
            case AUTH_SHIBBOLETH:
                $this->getLogger()->debug('Using shibboleth authentication.');
                include_once './Services/AuthShibboleth/classes/class.ilAuthProviderShibboleth.php';
                return new ilAuthProviderShibboleth($credentials);
                
            case AUTH_PROVIDER_LTI:
                $this->getLogger()->debug('Using lti provider authentication.');
                include_once './Services/LTI/classes/InternalProvider/class.ilAuthProviderLTI.php';
                return new ilAuthProviderLTI($credentials);

            case AUTH_ECS:
                $this->getLogger()->debug('Using ecs authentication.');
                include_once './Services/WebServices/ECS/classes/class.ilAuthProviderECS.php';
                return new ilAuthProviderECS($credentials);

            case AUTH_SAML:
                $this->getLogger()->debug('Using apache authentication.');
                require_once 'Services/Saml/classes/class.ilAuthProviderSaml.php';
                require_once 'Services/Saml/classes/class.ilSamlIdp.php';
                return new ilAuthProviderSaml($credentials, ilSamlIdp::getIdpIdByAuthMode($a_authmode));

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

            default:
                $this->getLogger('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

)

Get provider.

Parameters

\ilAuthCredentials

$credentials

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

References PHPMailer\PHPMailer\$provider, ilAuthModeDetermination\_getInstance(), ilAuthCredentials\getAuthMode(), getLogger(), getProviderByAuthMode(), and ilAuthCredentials\getUsername().

    {
        // Fixed provider selection;
        if (strlen($credentials->getAuthMode())) {
            $this->getLogger()->debug('Returning fixed provider for auth mode: ' . $credentials->getAuthMode());
            return array(
                $this->getProviderByAuthMode($credentials, $credentials->getAuthMode())
            );
        }
        
        include_once './Services/Authentication/classes/class.ilAuthModeDetermination.php';
        $auth_determination = ilAuthModeDetermination::_getInstance();
        $sequence = $auth_determination->getAuthModeSequence($credentials->getUsername());
        
        $providers = array();
        foreach ((array) $sequence as $position => $authmode) {
            $provider = $this->getProviderByAuthMode($credentials, $authmode);
            if ($provider instanceof ilAuthProviderInterface) {
                $providers[] = $provider;
            }
        }
        return $providers;
    }

Here is the call graph for this function:

Field Documentation

$logger

ilAuthProviderFactory::$logger = null

private

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

Referenced by getLogger().

---

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

• Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php