static utility functions used to manage authentication modes More...

Collaboration diagram for ilAuthUtils:

Static Public Member Functions
static	isAuthenticationForced ()
	Check if authentication is should be forced. More...

static	handleForcedAuthentication ()

static	_getAuthMode (?string $a_auth_mode)

static	_getAuthModeName ($a_auth_key)

static	_getActiveAuthModes ()

static	_getAllAuthModes ()

static	_generateLogin (string $a_login)
	generate free login by starting with a default string and adding postfix numbers More...

static	_hasMultipleAuthenticationMethods ()

static	_getMultipleAuthModeOptions (ilLanguage $lng)

static	_isExternalAccountEnabled ()
	Check if an external account name is required. More...

static	_allowPasswordModificationByAuthMode ($a_auth_mode)
	Allow password modification. More...

static	_needsExternalAccountByAuthMode ($a_auth_mode)
	Check if chosen auth mode needs an external account entry. More...

static	isLocalPasswordEnabledForAuthMode ($a_authmode)
	Check if local password validation is enabled for a specific auth_mode. More...

static	isPasswordModificationEnabled ($a_authmode)
	Check if password modification is enabled. More...

static	supportsLocalPasswordValidation ($a_authmode)
	Check if local password validation is supported. More...

static	getAuthPlugins ()
	Get active enabled auth plugins. More...

static	getAuthModeTranslation (string $a_auth_key, string $auth_name='')

Data Fields
const	LOCAL_PWV_FULL = 1

const	LOCAL_PWV_NO = 2

const	LOCAL_PWV_USER = 3

const	AUTH_LOCAL = 1

const	AUTH_LDAP = 2

const	AUTH_SCRIPT = 4

const	AUTH_SHIBBOLETH = 5

const	AUTH_CAS = 6

const	AUTH_SOAP = 7

const	AUTH_HTTP = 8

const	AUTH_ECS = 9

const	AUTH_APACHE = 11

const	AUTH_SAML = 12

const	AUTH_OPENID_CONNECT = 15

const	AUTH_PROVIDER_LTI = 22

const	REGEX_DELIMITERS = ['/', '~', '@', ';', '%', '`', '#']

Private Attributes
const	AUTH_INACTIVE = 18

const	AUTH_MULTIPLE = 20

const	AUTH_SESSION = 21

const	AUTH_SOAP_NO_ILIAS_USER = -100

const	AUTH_LDAP_NO_ILIAS_USER = -200

const	AUTH_APACHE_FAILED = -500

const	AUTH_SAML_FAILED = -501

const	AUTH_MODE_INACTIVE = -1000

const	AUTH_SOAP_NO_ILIAS_USER_BUT_EMAIL = -101

const	AUTH_CAS_NO_ILIAS_USER = -90

const	AUTH_USER_WRONG_IP = -600

const	AUTH_USER_INACTIVE = -601

const	AUTH_USER_TIME_LIMIT_EXCEEDED = -602

const	AUTH_USER_SIMULTANEOUS_LOGIN = -603

Detailed Description

static utility functions used to manage authentication modes

Author: Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

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

Member Function Documentation

◆ _allowPasswordModificationByAuthMode()

static ilAuthUtils::_allowPasswordModificationByAuthMode ( $a_auth_mode )

static

Allow password modification.

Parameters

int|string auth_mode

Definition at line 534 of file class.ilAuthUtils.php.

Referenced by ilPasswordInputGUI\checkInput(), and ilObjUserGUI\loadUserDefinedDataFromForm().

                                                                              : bool
     {
         switch ((int) $a_auth_mode) {
             case self::AUTH_LDAP:
             case self::AUTH_ECS:
             case self::AUTH_PROVIDER_LTI:
             case self::AUTH_OPENID_CONNECT:
                 return false;
             default:
                 return true;
         }
     }

Here is the caller graph for this function:

◆ _generateLogin()

static ilAuthUtils::_generateLogin ( string $a_login )

static

generate free login by starting with a default string and adding postfix numbers

Definition at line 373 of file class.ilAuthUtils.php.

References $DIC, $ilDB, and $r.

Referenced by ilCASAttributeToUser\create(), ilAuthProviderECS\createUser(), ilAuthProviderLTI\createUser(), ilAuthProviderSoap\handleSoapAuth(), ilAuthProviderSaml\importUser(), ilOpenIdConnectUserSync\transformToXml(), and ilLDAPAttributeToUser\usersToXML().

                                                           : string
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // Check if username already exists
         $found = false;
         $postfix = 0;
         $c_login = $a_login;
         while (!$found) {
             $r = $ilDB->query("SELECT login FROM usr_data WHERE login = " .
                 $ilDB->quote($c_login));
             if ($r->numRows() > 0) {
                 $postfix++;
                 $c_login = $a_login . $postfix;
             } else {
                 $found = true;
             }
         }
 
         return $c_login;
     }

Here is the caller graph for this function:

◆ _getActiveAuthModes()

static ilAuthUtils::_getActiveAuthModes ( )

static

Returns: array<string, int|string>

Definition at line 261 of file class.ilAuthUtils.php.

References $DIC, $ilSetting, ilLDAPServer\_getActiveServerList(), ilSamlIdp\getActiveIdpList(), ilAuthProviderLTI\getAuthModes(), ilECSServerSettings\getInstance(), and ilOpenIdConnectSettings\getInstance().

Referenced by ilObjAuthSettingsGUI\buildRegistrationRoleMappingForm(), ilECSMappingUtils\getAuthModeSelection(), ilUserTableGUI\initFilter(), and ilObjUserGUI\initForm().

                                                 : array
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         $modes = [
             'default' => $ilSetting->get("auth_mode"),
             'local' => self::AUTH_LOCAL
         ];
 
         foreach (ilLDAPServer::_getActiveServerList() as $sid) {
             $modes['ldap_' . $sid] = (self::AUTH_LDAP . '_' . $sid);
         }
 
         foreach (ilAuthProviderLTI::getAuthModes() as $sid) {
             $modes['lti_' . $sid] = (self::AUTH_PROVIDER_LTI . '_' . $sid);
         }
 
         if (ilOpenIdConnectSettings::getInstance()->getActive()) {
             $modes['oidc'] = self::AUTH_OPENID_CONNECT;
         }
 
         if ($ilSetting->get("shib_active")) {
             $modes['shibboleth'] = self::AUTH_SHIBBOLETH;
         }
         if ($ilSetting->get("script_active")) {
             $modes['script'] = self::AUTH_SCRIPT;
         }
         if ($ilSetting->get("cas_active")) {
             $modes['cas'] = self::AUTH_CAS;
         }
         if ($ilSetting->get("soap_auth_active")) {
             $modes['soap'] = self::AUTH_SOAP;
         }
         if ($ilSetting->get("apache_active")) {
             $modes['apache'] = self::AUTH_APACHE;
         }
 
         if (ilECSServerSettings::getInstance()->activeServerExists()) {
             $modes['ecs'] = self::AUTH_ECS;
         }
 
         foreach (ilSamlIdp::getActiveIdpList() as $idp) {
             $idpId = $idp->getIdpId();
             $modes['saml_' . $idpId] = self::AUTH_SAML . '_' . $idpId;
         }
 
         // begin-path auth_plugin
         foreach (self::getAuthPlugins() as $pl) {
             foreach ($pl->getAuthIds() as $auth_id) {
                 if ($pl->isAuthActive($auth_id)) {
                     $modes[$pl->getAuthName($auth_id)] = $auth_id;
                 }
             }
         }
         // end-path auth_plugin
         return $modes;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAllAuthModes()

static ilAuthUtils::_getAllAuthModes ( )

static

Returns: array<int|string, string>

Definition at line 324 of file class.ilAuthUtils.php.

References $id, ilLDAPServer\_getServerList(), ilSamlIdp\getAllIdps(), and ilAuthProviderLTI\getAuthModes().

Referenced by ilObjAuthSettingsGUI\authSettingsObject().

                                              : array
     {
         $modes = array(
             self::AUTH_LOCAL,
             self::AUTH_LDAP,
             self::AUTH_SHIBBOLETH,
             self::AUTH_SAML,
             self::AUTH_CAS,
             self::AUTH_SOAP,
             self::AUTH_ECS,
             self::AUTH_PROVIDER_LTI,
             self::AUTH_OPENID_CONNECT,
             self::AUTH_APACHE
         );
         $ret = array();
         foreach ($modes as $mode) {
             if ($mode === self::AUTH_PROVIDER_LTI) {
                 foreach (ilAuthProviderLTI::getAuthModes() as $sid) {
                     $id = self::AUTH_PROVIDER_LTI . '_' . $sid;
                     $ret[$id] = self::_getAuthModeName($id);
                 }
                 continue;
             }
 
             // multi ldap implementation
             if ($mode === self::AUTH_LDAP) {
                 foreach (ilLDAPServer::_getServerList() as $ldap_id) {
                     $id = self::AUTH_LDAP . '_' . $ldap_id;
                     $ret[$id] = self::_getAuthModeName($id);
                 }
                 continue;
             }
 
             if ($mode === self::AUTH_SAML) {
                 foreach (ilSamlIdp::getAllIdps() as $idp) {
                     $id = self::AUTH_SAML . '_' . $idp->getIdpId();
                     $ret[$id] = self::_getAuthModeName($id);
                 }
                 continue;
             }
             $ret[$mode] = self::_getAuthModeName($mode);
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAuthMode()

static ilAuthUtils::_getAuthMode ( ?string $a_auth_mode )

static

Returns: string|int|null

Definition at line 143 of file class.ilAuthUtils.php.

References $DIC, $ilSetting, ilAuthProviderLTI\getKeyByAuthMode(), ilSamlIdp\getKeyByAuthMode(), ilLDAPServer\getKeyByAuthMode(), and null.

Referenced by ilPasswordInputGUI\checkInput(), ilUserTableGUI\fillRow(), ilObjUser\getAuthMode(), and ilObjUserGUI\loadUserDefinedDataFromForm().

     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         if (null === $a_auth_mode) {
             return $ilSetting->get("auth_mode");
         }
 
         if (strpos($a_auth_mode, '_') !== false) {
             $auth_arr = explode('_', $a_auth_mode);
             $auth_switch = $auth_arr[0];
         } else {
             $auth_switch = $a_auth_mode;
         }
         switch ($auth_switch) {
             case "local":
                 return self::AUTH_LOCAL;
                 break;
 
             case "ldap":
                 return ilLDAPServer::getKeyByAuthMode($a_auth_mode);
 
             case 'lti':
                 return ilAuthProviderLTI::getKeyByAuthMode($a_auth_mode);
 
             case "script":
                 return self::AUTH_SCRIPT;
                 break;
 
             case "shibboleth":
                 return self::AUTH_SHIBBOLETH;
                 break;
 
             case 'oidc':
                 return self::AUTH_OPENID_CONNECT;
                 break;
 
             case 'saml':
                 return ilSamlIdp::getKeyByAuthMode($a_auth_mode);
 
             case "cas":
                 return self::AUTH_CAS;
                 break;
 
             case "soap":
                 return self::AUTH_SOAP;
                 break;
 
             case 'ecs':
                 return self::AUTH_ECS;
 
             case 'apache':
                 return self::AUTH_APACHE;
 
             default:
                 return $ilSetting->get("auth_mode");
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAuthModeName()

static ilAuthUtils::_getAuthModeName ( $a_auth_key )

static

Parameters

$a_auth_key int|string

Definition at line 208 of file class.ilAuthUtils.php.

References ilAuthProviderLTI\getAuthModeByKey(), ilSamlIdp\getAuthModeByKey(), and ilLDAPServer\getAuthModeByKey().

Referenced by ilObjUser\_checkExternalAuthAccount(), ilObjUser\_getExternalAccountsByAuthMode(), ilObjAuthSettingsGUI\buildRegistrationRoleMappingForm(), ilECSCmsCourseMemberCommandQueueHandler\createMember(), ilLDAPServer\getAuthenticationMappingKey(), ilAuthFrontend\handleLoginAttempts(), ilUserImportParser\importEndTag(), ilUserTableGUI\initFilter(), ilObjUserGUI\initForm(), and ilUserImportParser\verifyEndTag().

                                                         : string
     {
         switch ((int) $a_auth_key) {
             case self::AUTH_LOCAL:
                 return "local";
                 break;
 
             case self::AUTH_LDAP:
                 // begin-patch ldap_multiple
                 return ilLDAPServer::getAuthModeByKey($a_auth_key);
                 // end-patch ldap_multiple
 
             case self::AUTH_PROVIDER_LTI:
                 return ilAuthProviderLTI::getAuthModeByKey($a_auth_key);
 
             case self::AUTH_CAS:
                 return "cas";
                 break;
 
             case self::AUTH_SCRIPT:
                 return "script";
                 break;
 
             case self::AUTH_SHIBBOLETH:
                 return "shibboleth";
                 break;
 
             case self::AUTH_SAML:
                 return ilSamlIdp::getAuthModeByKey($a_auth_key);
 
             case self::AUTH_SOAP:
                 return "soap";
                 break;
 
             case self::AUTH_ECS:
                 return 'ecs';
 
             case self::AUTH_APACHE:
                 return 'apache';
 
             case self::AUTH_OPENID_CONNECT:
                 return 'oidc';
                 break;
 
             default:
                 return "default";
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMultipleAuthModeOptions()

static ilAuthUtils::_getMultipleAuthModeOptions ( ilLanguage $lng )

static

Parameters

ilLanguage $lng

Returns: array<int|string, array{"txt": string, "checked"?: bool, "hide_in_ui"?: bool}>

Definition at line 429 of file class.ilAuthUtils.php.

References $DIC, $ilSetting, $server, ilLDAPServer\_getActiveServerList(), ilLDAPServer\getInstanceByServerId(), and ilLanguage\txt().

Referenced by ilStartUpGUI\buildStandardLoginForm().

                                                                        : array
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
         $options = [];
         // in the moment only ldap is activated as additional authentication method
 
         $options[self::AUTH_LOCAL]['txt'] = $lng->txt('authenticate_ilias');
 
 
         foreach (ilLDAPServer::_getActiveServerList() as $sid) {
             $server = ilLDAPServer::getInstanceByServerId($sid);
             $options[self::AUTH_LDAP . '_' . $sid]['txt'] = $server->getName();
         }
 
         if ($ilSetting->get('apache_active')) {
             global $DIC;
 
             $lng = $DIC['lng'];
             $apache_settings = new ilSetting('apache_auth');
             $options[self::AUTH_APACHE]['txt'] = $apache_settings->get('name', $lng->txt('apache_auth'));
             $options[self::AUTH_APACHE]['hide_in_ui'] = true;
         }
 
         if ($ilSetting->get('auth_mode', (string) self::AUTH_LOCAL) === (string) self::AUTH_LDAP) {
             $default = self::AUTH_LDAP;
         } else {
             $default = self::AUTH_LOCAL;
         }
 
         $default = $ilSetting->get('default_auth_mode', (string) $default);
 
         // begin-patch auth_plugin
         $pls = self::getAuthPlugins();
         foreach ($pls as $pl) {
             $auths = $pl->getAuthIds();
             foreach ($auths as $auth_id) {
                 $pl_auth_option = $pl->getMultipleAuthModeOptions($auth_id);
                 if ($pl_auth_option) {
                     $options += $pl_auth_option;
                 }
             }
         }
         // end-patch auth_plugins
 
         if (array_key_exists($default, $options)) {
             $options[$default]['checked'] = true;
         }
 
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _hasMultipleAuthenticationMethods()

static ilAuthUtils::_hasMultipleAuthenticationMethods ( )

static

Definition at line 397 of file class.ilAuthUtils.php.

References $DIC, $ilSetting, and ilLDAPServer\_getActiveServerList().

Referenced by ilStartUpGUI\buildStandardLoginForm(), and ilStartUpGUI\doStandardAuthentication().

                                                               : bool
     {
         if (count(ilLDAPServer::_getActiveServerList())) {
             return true;
         }
 
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         if ($ilSetting->get('apache_active')) {
             return true;
         }
 
         // begin-patch auth_plugin
         foreach (self::getAuthPlugins() as $pl) {
             foreach ($pl->getAuthIds() as $auth_id) {
                 if ($pl->getMultipleAuthModeOptions($auth_id)) {
                     return true;
                 }
             }
         }
         // end-patch auth_plugin
 
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isExternalAccountEnabled()

static ilAuthUtils::_isExternalAccountEnabled ( )

static

Check if an external account name is required.

That's the case if LDAP, CAS or SOAP is active

Definition at line 486 of file class.ilAuthUtils.php.

References $DIC, $ilSetting, ilLDAPServer\_getActiveServerList(), ilAuthProviderLTI\getActiveAuthModes(), ilSamlIdp\getActiveIdpList(), and ilOpenIdConnectSettings\getInstance().

Referenced by ilObjUserGUI\initForm(), and ilObjUserGUI\saveObject().

                                                       : bool
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         if ($ilSetting->get("cas_active")) {
             return true;
         }
         if ($ilSetting->get("soap_auth_active")) {
             return true;
         }
         if ($ilSetting->get("shib_active")) {
             return true;
         }
         if (count(ilLDAPServer::_getActiveServerList())) {
             return true;
         }
 
         if (count(ilAuthProviderLTI::getActiveAuthModes())) {
             return true;
         }
 
         if (count(ilSamlIdp::getActiveIdpList()) > 0) {
             return true;
         }
 
         if (ilOpenIdConnectSettings::getInstance()->getActive()) {
             return true;
         }
 
         // begin-path auth_plugin
         foreach (self::getAuthPlugins() as $pl) {
             foreach ($pl->getAuthIds() as $auth_id) {
                 if ($pl->isAuthActive($auth_id) && $pl->isExternalAccountNameRequired($auth_id)) {
                     return true;
                 }
             }
         }
         // end-path auth_plugin
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _needsExternalAccountByAuthMode()

static ilAuthUtils::_needsExternalAccountByAuthMode ( $a_auth_mode )

static

Check if chosen auth mode needs an external account entry.

Parameters

null | string | int $a_auth_mode auth_mode

Definition at line 552 of file class.ilAuthUtils.php.

References $DIC, and $ilSetting.

Referenced by ilObjUser\isPasswordChangeDemanded(), and ilObjUser\isPasswordExpired().

                                                                         : bool
     {
         switch ($a_auth_mode) {
             case self::AUTH_LOCAL:
             case self::AUTH_APACHE:
                 return false;
             default:
                 return true;
         }
     }

Here is the caller graph for this function:

◆ getAuthModeTranslation()

static ilAuthUtils::getAuthModeTranslation	(	string	$a_auth_key,
		string	$auth_name = `''`
	)

static

Definition at line 669 of file class.ilAuthUtils.php.

References $DIC, $lng, ilSamlIdp\getIdpIdByAuthMode(), ilSamlIdp\getInstanceByIdpId(), ilLDAPServer\getInstanceByServerId(), ilAuthProviderLTI\getServerIdByAuthMode(), ilLDAPServer\getServerIdByAuthMode(), and ilAuthProviderLTI\lookupConsumer().

Referenced by ilUserTableGUI\fillRow(), ilECSMappingUtils\getAuthModeSelection(), ilUserTableGUI\initFilter(), and ilObjUserGUI\initForm().

                                                                                              : ?string
     {
         global $DIC;
 
         $lng = $DIC['lng'];
 
         //TODO fix casting strings like 2_1 (auth_key for first ldap server) to int to get it to 2
         switch ((int) $a_auth_key) {
             case self::AUTH_LDAP:
                 $sid = ilLDAPServer::getServerIdByAuthMode($a_auth_key);
                 return ilLDAPServer::getInstanceByServerId($sid)->getName();
 
             case self::AUTH_PROVIDER_LTI:
                 $sid = ilAuthProviderLTI::getServerIdByAuthMode($a_auth_key);
                 return ilAuthProviderLTI::lookupConsumer($sid);
 
 
             case self::AUTH_SAML:
                 $idp_id = ilSamlIdp::getIdpIdByAuthMode($a_auth_key);
                 return ilSamlIdp::getInstanceByIdpId($idp_id)->getEntityId();
 
             default:
                 $lng->loadLanguageModule('auth');
                 if (!empty($auth_name)) {
                     return $lng->txt('auth_' . $auth_name);
                 }
 
                 return $lng->txt('auth_' . self::_getAuthModeName($a_auth_key));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAuthPlugins()

static ilAuthUtils::getAuthPlugins ( )

static

Get active enabled auth plugins.

Definition at line 664 of file class.ilAuthUtils.php.

References $GLOBALS.

Referenced by ilObjAuthSettingsGUI\buildAuthModeDeterminationForm(), ilAuthProviderFactory\getProviderByAuthMode(), and ilAuthModeDetermination\read().

                                            : \Iterator
     {
         return $GLOBALS['DIC']['component.factory']->getActivePluginsInSlot('authhk');
     }

Here is the caller graph for this function:

◆ handleForcedAuthentication()

static ilAuthUtils::handleForcedAuthentication ( )

static

Definition at line 103 of file class.ilAuthUtils.php.

References $DIC, $GLOBALS, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), ilInitialisation\goToPublicSection(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

Referenced by ilInitialisation\resumeUserSession().

                                                        : void
     {
         global $DIC;
         $query_wrapper = $DIC->http()->wrapper()->query();
         $string_refinery = $DIC->refinery()->kindlyTo()->string();
         if ($query_wrapper->has('ecs_hash') || $query_wrapper->has('ecs_hash_url')) {
             $credentials = new ilAuthFrontendCredentials();
             $credentials->setUsername($query_wrapper->retrieve('ecs_login', $string_refinery));
             $credentials->setAuthMode((string) self::AUTH_ECS);
 
             $provider_factory = new ilAuthProviderFactory();
             $providers = $provider_factory->getProviders($credentials);
 
             $status = ilAuthStatus::getInstance();
 
             $frontend_factory = new ilAuthFrontendFactory();
             $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
             $frontend = $frontend_factory->getFrontend(
                 $GLOBALS['DIC']['ilAuthSession'],
                 $status,
                 $credentials,
                 $providers
             );
 
             $frontend->authenticate();
 
             switch ($status->getStatus()) {
                 case ilAuthStatus::STATUS_AUTHENTICATED:
                     return;
 
                 case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                     ilInitialisation::goToPublicSection();
                     return;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAuthenticationForced()

static ilAuthUtils::isAuthenticationForced ( )

static

Check if authentication is should be forced.

Definition at line 95 of file class.ilAuthUtils.php.

References $DIC.

Referenced by ilInitialisation\resumeUserSession().

                                                    : bool
     {
         //TODO rework forced authentication concept
         global $DIC;
         $query_wrapper = $DIC->http()->wrapper()->query();
         return $query_wrapper->has('ecs_hash') || $query_wrapper->has('ecs_hash_url');
     }

Here is the caller graph for this function:

◆ isLocalPasswordEnabledForAuthMode()

static ilAuthUtils::isLocalPasswordEnabledForAuthMode ( $a_authmode )

static

Check if local password validation is enabled for a specific auth_mode.

Parameters

int | string $a_authmode

Returns: bool

Definition at line 581 of file class.ilAuthUtils.php.

References $DIC, $ilSetting, ilSamlIdp\getIdpIdByAuthMode(), and ilSamlIdp\getInstanceByIdpId().

Referenced by ilPasswordAssistanceGUI\submitAssistanceForm(), and ilAuthProviderDatabase\withoutPasswordVerification().

                                                                          : bool
     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         switch ((int) $a_authmode) {
             // always enabled
             case self::AUTH_LOCAL:
             case self::AUTH_APACHE:
                 return true;
 
                 // No local passwords for these auth modes
             case self::AUTH_LDAP:
             case self::AUTH_ECS:
             case self::AUTH_SCRIPT:
             case self::AUTH_PROVIDER_LTI:
             case self::AUTH_OPENID_CONNECT:
                 return false;
 
             case self::AUTH_SAML:
                 $idp = ilSamlIdp::getInstanceByIdpId(ilSamlIdp::getIdpIdByAuthMode((string) $a_authmode));
                 return $idp->isActive() && $idp->allowLocalAuthentication();
 
             case self::AUTH_SHIBBOLETH:
                 return (bool) $ilSetting->get("shib_auth_allow_local", '0');
             case self::AUTH_SOAP:
                 return (bool) $ilSetting->get("soap_auth_allow_local", '0');
             case self::AUTH_CAS:
                 return (bool) $ilSetting->get("cas_allow_local", '0');
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPasswordModificationEnabled()

static ilAuthUtils::isPasswordModificationEnabled ( $a_authmode )

static

Check if password modification is enabled.

Parameters

int | string $a_authmode

Returns: bool

Definition at line 621 of file class.ilAuthUtils.php.

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\allowPasswordChange().

                                                                      : bool
     {
         if (self::isPasswordModificationHidden()) {
             return false;
         }
 
         return self::isLocalPasswordEnabledForAuthMode($a_authmode);
     }

Here is the caller graph for this function:

◆ supportsLocalPasswordValidation()

static ilAuthUtils::supportsLocalPasswordValidation ( $a_authmode )

static

Check if local password validation is supported.

Parameters

null | string | int $a_authmode

Returns

Definition at line 635 of file class.ilAuthUtils.php.

Referenced by ilObjWebDAV\retrieveWebDAVCommandArrayForActionMenu().

                                                                        : int
     {
         switch ((int) $a_authmode) {
             case self::AUTH_LDAP:
             case self::AUTH_LOCAL:
                 return self::LOCAL_PWV_FULL;
 
             case self::AUTH_SHIBBOLETH:
             case self::AUTH_OPENID_CONNECT:
             case self::AUTH_SAML:
             case self::AUTH_SOAP:
             case self::AUTH_CAS:
                 if (!self::isPasswordModificationEnabled($a_authmode)) {
                     return self::LOCAL_PWV_NO;
                 }
                 return self::LOCAL_PWV_USER;
 
             case self::AUTH_PROVIDER_LTI:
             case self::AUTH_ECS:
             case self::AUTH_SCRIPT:
             case self::AUTH_APACHE:
             default:
                 return self::LOCAL_PWV_USER;
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ AUTH_APACHE

const ilAuthUtils::AUTH_APACHE = 11

Definition at line 42 of file class.ilAuthUtils.php.

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilObjAuthSettingsGUI\buildAuthModeDeterminationForm(), ilStartUpGUI\doApacheAuthentication(), ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), ilObjAuthSettingsGUI\getAuthModeTitle(), ilAuthProviderFactory\getProviderByAuthMode(), ilAuthProviderApache\getTriggerAuthMode(), ilAuthModeDetermination\read(), and ilObjAuthSettingsGUI\saveApacheSettingsObject().

◆ AUTH_APACHE_FAILED

const ilAuthUtils::AUTH_APACHE_FAILED = -500

private

Definition at line 67 of file class.ilAuthUtils.php.

◆ AUTH_CAS

const ilAuthUtils::AUTH_CAS = 6

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

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilAuthProviderCAS\doAuthentication(), ilStartUpGUI\doCasAuthentication(), ilLocalUserPasswordSettingsGUI\getPasswordForm(), ilAuthProviderFactory\getProviderByAuthMode(), ilAuthProviderCAS\handleLDAPDataSource(), ilCASSettingsGUI\initFormSettings(), and ilCASSettingsGUI\save().

◆ AUTH_CAS_NO_ILIAS_USER

const ilAuthUtils::AUTH_CAS_NO_ILIAS_USER = -90

private

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

◆ AUTH_ECS

const ilAuthUtils::AUTH_ECS = 9

Definition at line 40 of file class.ilAuthUtils.php.

Referenced by ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\externalAuthModes(), ilAuthProviderFactory\getProviderByAuthMode(), and ILIAS\LegalDocuments\ConsumerToolbox\User\isExternalAccount().

◆ AUTH_HTTP

const ilAuthUtils::AUTH_HTTP = 8

Definition at line 39 of file class.ilAuthUtils.php.

◆ AUTH_INACTIVE

const ilAuthUtils::AUTH_INACTIVE = 18

private

Definition at line 48 of file class.ilAuthUtils.php.

◆ AUTH_LDAP

const ilAuthUtils::AUTH_LDAP = 2

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

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\externalAuthModes(), ilObjAuthSettingsGUI\getAuthModeTitle(), ilLDAPServer\getKeyByAuthMode(), ilAuthProviderFactory\getProviderByAuthMode(), ilAuthProviderLDAP\getTriggerAuthMode(), ilLDAPServer\isAuthModeLDAP(), ILIAS\LegalDocuments\ConsumerToolbox\User\isLDAPUser(), ilAuthModeDetermination\read(), and ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\testIsLDAPUser().

◆ AUTH_LDAP_NO_ILIAS_USER

const ilAuthUtils::AUTH_LDAP_NO_ILIAS_USER = -200

private

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

◆ AUTH_LOCAL

const ilAuthUtils::AUTH_LOCAL = 1

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

Referenced by ilObjUser\_getExternalAccountsByAuthMode(), ilObjAuthSettingsGUI\authSettingsObject(), ilObjAuthSettingsGUI\buildAuthModeDeterminationForm(), ilObjAuthSettingsGUI\buildRegistrationRoleMappingForm(), ilAccountRegistrationGUI\createUser(), ilStartUpGUI\doMigration(), ilObjAuthSettingsGUI\getAuthModeTitle(), ilLocalUserPasswordSettingsGUI\getPasswordForm(), ilAuthProviderFactory\getProviderByAuthMode(), ilAuthProviderCliFactory\getProviders(), ilAuthFrontend\handleLoginAttempts(), ilAuthProviderSaml\handleSamlAuth(), ilLTIViewGUI\logout(), ilAuthModeDetermination\read(), ILIAS\Data\Password\LocalUserPasswordManager\resetLastPasswordChangeForLocalUsers(), ilObjAuthSettingsGUI\saveApacheSettingsObject(), and ilPasswordAssistanceGUI\submitAssistanceForm().

◆ AUTH_MODE_INACTIVE

const ilAuthUtils::AUTH_MODE_INACTIVE = -1000

private

Definition at line 73 of file class.ilAuthUtils.php.

◆ AUTH_MULTIPLE

const ilAuthUtils::AUTH_MULTIPLE = 20

private

Definition at line 51 of file class.ilAuthUtils.php.

◆ AUTH_OPENID_CONNECT

const ilAuthUtils::AUTH_OPENID_CONNECT = 15

Definition at line 45 of file class.ilAuthUtils.php.

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilStartUpGUI\doOpenIdConnectAuthentication(), ilAuthProviderFactory\getProviderByAuthMode(), and ilAuthProviderOpenIdConnect\handleUpdate().

◆ AUTH_PROVIDER_LTI

const ilAuthUtils::AUTH_PROVIDER_LTI = 22

Definition at line 56 of file class.ilAuthUtils.php.

Referenced by ilStartUpGUI\doLTIAuthentication(), ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\externalAuthModes(), ilAuthProviderLTI\getKeyByAuthMode(), ilAuthProviderFactory\getProviderByAuthMode(), ilAuthProviderLTI\isAuthModeLTI(), and ILIAS\LegalDocuments\ConsumerToolbox\User\isExternalAccount().

◆ AUTH_SAML

const ilAuthUtils::AUTH_SAML = 12

Definition at line 43 of file class.ilAuthUtils.php.

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilSamlIdp\delete(), ilStartUpGUI\doSamlAuthentication(), ilObjAuthSettingsGUI\getAuthModeTitle(), ilSamlIdp\getKeyByAuthMode(), ilAuthProviderFactory\getProviderByAuthMode(), ilAuthProviderSaml\getTriggerAuthMode(), ilSamlAppEventListener\handleEvent(), ilSamlIdp\isAuthModeSaml(), ilObjAuthSettingsGUI\setAuthModeObject(), ilStartUpGUI\showLogout(), and ilPasswordAssistanceGUI\submitAssistanceForm().

◆ AUTH_SAML_FAILED

const ilAuthUtils::AUTH_SAML_FAILED = -501

private

Definition at line 70 of file class.ilAuthUtils.php.

◆ AUTH_SCRIPT

const ilAuthUtils::AUTH_SCRIPT = 4

Definition at line 35 of file class.ilAuthUtils.php.

Referenced by ilObjAuthSettingsGUI\getAuthModeTitle(), ilObjAuthSettingsGUI\saveScriptObject(), and ilObjAuthSettingsGUI\setAuthModeObject().

◆ AUTH_SESSION

const ilAuthUtils::AUTH_SESSION = 21

private

Definition at line 54 of file class.ilAuthUtils.php.

◆ AUTH_SHIBBOLETH

const ilAuthUtils::AUTH_SHIBBOLETH = 5

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

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilECSCmsCourseMemberCommandQueueHandler\createMember(), ilStartUpGUI\doShibbolethAuthentication(), ilObjAuthSettingsGUI\getAuthModeTitle(), ilLocalUserPasswordSettingsGUI\getPasswordForm(), ilAuthProviderFactory\getProviderByAuthMode(), and ilObjAuthSettingsGUI\setAuthModeObject().

◆ AUTH_SOAP

const ilAuthUtils::AUTH_SOAP = 7

Definition at line 38 of file class.ilAuthUtils.php.

Referenced by ilObjAuthSettingsGUI\buildAuthModeDeterminationForm(), ilAuthProviderSoap\doAuthentication(), ilAuthProviderFactory\getProviderByAuthMode(), and ilAuthModeDetermination\read().

◆ AUTH_SOAP_NO_ILIAS_USER

const ilAuthUtils::AUTH_SOAP_NO_ILIAS_USER = -100

private

Definition at line 59 of file class.ilAuthUtils.php.

◆ AUTH_SOAP_NO_ILIAS_USER_BUT_EMAIL

const ilAuthUtils::AUTH_SOAP_NO_ILIAS_USER_BUT_EMAIL = -101

private

Definition at line 78 of file class.ilAuthUtils.php.

◆ AUTH_USER_INACTIVE

const ilAuthUtils::AUTH_USER_INACTIVE = -601

private

Definition at line 85 of file class.ilAuthUtils.php.

◆ AUTH_USER_SIMULTANEOUS_LOGIN

const ilAuthUtils::AUTH_USER_SIMULTANEOUS_LOGIN = -603

private

Definition at line 87 of file class.ilAuthUtils.php.

◆ AUTH_USER_TIME_LIMIT_EXCEEDED

const ilAuthUtils::AUTH_USER_TIME_LIMIT_EXCEEDED = -602

private

Definition at line 86 of file class.ilAuthUtils.php.

◆ AUTH_USER_WRONG_IP

const ilAuthUtils::AUTH_USER_WRONG_IP = -600

private

Definition at line 84 of file class.ilAuthUtils.php.

◆ LOCAL_PWV_FULL

const ilAuthUtils::LOCAL_PWV_FULL = 1

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

◆ LOCAL_PWV_NO

const ilAuthUtils::LOCAL_PWV_NO = 2

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

◆ LOCAL_PWV_USER

const ilAuthUtils::LOCAL_PWV_USER = 3

Definition at line 30 of file class.ilAuthUtils.php.

Referenced by ilObjWebDAV\retrieveWebDAVCommandArrayForActionMenu().

◆ REGEX_DELIMITERS

const ilAuthUtils::REGEX_DELIMITERS = ['/', '~', '@', ';', '%', '`', '#']

Definition at line 90 of file class.ilAuthUtils.php.

Referenced by ilAuthModeDetermination\getAuthModeSequence(), and ilLDAPRoleAssignmentRule\wildcardCompare().

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

components/ILIAS/Authentication/classes/class.ilAuthUtils.php

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Member Function Documentation

◆ _allowPasswordModificationByAuthMode()

◆ _generateLogin()

◆ _getActiveAuthModes()

◆ _getAllAuthModes()

◆ _getAuthMode()

◆ _getAuthModeName()

◆ _getMultipleAuthModeOptions()

◆ _hasMultipleAuthenticationMethods()

◆ _isExternalAccountEnabled()

◆ _needsExternalAccountByAuthMode()

◆ getAuthModeTranslation()

◆ getAuthPlugins()

◆ handleForcedAuthentication()

◆ isAuthenticationForced()

◆ isLocalPasswordEnabledForAuthMode()

◆ isPasswordModificationEnabled()

◆ supportsLocalPasswordValidation()

Field Documentation

◆ AUTH_APACHE

◆ AUTH_APACHE_FAILED

◆ AUTH_CAS

◆ AUTH_CAS_NO_ILIAS_USER

◆ AUTH_ECS

◆ AUTH_HTTP

◆ AUTH_INACTIVE

◆ AUTH_LDAP

◆ AUTH_LDAP_NO_ILIAS_USER

◆ AUTH_LOCAL

◆ AUTH_MODE_INACTIVE

◆ AUTH_MULTIPLE

◆ AUTH_OPENID_CONNECT

◆ AUTH_PROVIDER_LTI

◆ AUTH_SAML

◆ AUTH_SAML_FAILED

◆ AUTH_SCRIPT

◆ AUTH_SESSION

◆ AUTH_SHIBBOLETH

◆ AUTH_SOAP

◆ AUTH_SOAP_NO_ILIAS_USER

◆ AUTH_SOAP_NO_ILIAS_USER_BUT_EMAIL

◆ AUTH_USER_INACTIVE

◆ AUTH_USER_SIMULTANEOUS_LOGIN

◆ AUTH_USER_TIME_LIMIT_EXCEEDED

◆ AUTH_USER_WRONG_IP

◆ LOCAL_PWV_FULL

◆ LOCAL_PWV_NO

◆ LOCAL_PWV_USER

◆ REGEX_DELIMITERS