ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
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().

20  {
21  $this->logger = ilLoggerFactory::getLogger('auth');
22  }
static getLogger($a_component_id)
Get component logger.
+ 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().

+ Here is the caller graph for this function:

◆ getProviderByAuthMode()

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

Get provider by auth mode.

Returns

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

References AUTH_APACHE, AUTH_CAS, AUTH_ECS, AUTH_LDAP, AUTH_LOCAL, AUTH_RADIUS, AUTH_SHIBBOLETH, and getLogger().

Referenced by getProviders().

69  {
70  switch((int) $a_authmode)
71  {
72  case AUTH_LDAP:
73  $ldap_info = explode('_', $a_authmode);
74  $this->getLogger()->debug('Using ldap authentication with credentials ');
75  include_once './Services/LDAP/classes/class.ilAuthProviderLDAP.php';
76  return new ilAuthProviderLDAP($credentials, $ldap_info[1]);
77 
78  case AUTH_LOCAL:
79  $this->getLogger()->debug('Using local database authentication');
80  include_once './Services/Authentication/classes/Provider/class.ilAuthProviderDatabase.php';
81  return new ilAuthProviderDatabase($credentials);
82 
83  case AUTH_APACHE:
84  $this->getLogger()->debug('Using apache authentication.');
85  include_once './Services/AuthApache/classes/class.ilAuthProviderApache.php';
86  return new ilAuthProviderApache($credentials);
87 
88  case AUTH_CAS:
89  $this->getLogger()->debug('Using CAS authentication');
90  include_once './Services/CAS/classes/class.ilAuthProviderCAS.php';
91  return new ilAuthProviderCAS($credentials);
92 
93  case AUTH_RADIUS:
94  $this->getLogger()->debug('Using radius authentication.');
95  include_once './Services/Radius/classes/class.ilAuthProviderRadius.php';
96  return new ilAuthProviderRadius($credentials);
97 
98  case AUTH_SHIBBOLETH:
99  $this->getLogger()->debug('Using shibboleth authentication.');
100  include_once './Services/AuthShibboleth/classes/class.ilAuthProviderShibboleth.php';
101  return new ilAuthProviderShibboleth($credentials);
102 
103  case AUTH_ECS:
104  $this->getLogger()->debug('Using ecs authentication.');
105  include_once './Services/WebServices/ECS/classes/class.ilAuthProviderECS.php';
106  return new ilAuthProviderECS($credentials);
107 
108  }
109  return null;
110  }
CAS authentication provider.
const AUTH_LDAP
Description of class class.
const AUTH_CAS
const AUTH_SHIBBOLETH
const AUTH_APACHE
Description of class class.
Description of class class.
Auth prvider for ecs auth.
const AUTH_ECS
const AUTH_LOCAL
Shibboleth authentication provider.
const AUTH_RADIUS
+ 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 League\OAuth2\Client\Provider\$provider, ilAuthModeDetermination\_getInstance(), array, ilAuthCredentials\getAuthMode(), getLogger(), getProviderByAuthMode(), and ilAuthCredentials\getUsername().

38  {
39  // Fixed provider selection;
40  if(strlen($credentials->getAuthMode()))
41  {
42  $this->getLogger()->debug('Returning fixed provider for auth mode: ' . $credentials->getAuthMode());
43  return array(
44  $this->getProviderByAuthMode($credentials, $credentials->getAuthMode())
45  );
46  }
47 
48  include_once './Services/Authentication/classes/class.ilAuthModeDetermination.php';
49  $auth_determination = ilAuthModeDetermination::_getInstance();
50  $sequence = $auth_determination->getAuthModeSequence($credentials->getUsername());
51 
52  $providers = array();
53  foreach((array) $sequence as $position => $authmode)
54  {
55  $provider = $this->getProviderByAuthMode($credentials, $authmode);
56  if($provider instanceof ilAuthProviderInterface)
57  {
58  $providers[] = $provider;
59  }
60  }
61  return $providers;
62  }
getUsername()
Get username.
Standard interface for auth provider implementations.
Create styles array
The data for the language used.
getAuthMode()
Get auth mode.
getProviderByAuthMode(ilAuthCredentials $credentials, $a_authmode)
Get provider by auth mode.
+ 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: