Collaboration diagram for ilOpenIdConnectSettings:

Public Member Functions
	setActive (bool $active)

	getActive ()

	setProvider (string $url)

	getProvider ()

	setClientId (string $client_id)

	getClientId ()

	setSecret (string $secret)

	getSecret ()

	setLoginElementType (int $type)

	getLoginElementType ()

	setLoginElementImage (string $a_img_name)

	getLoginElementImage ()

	setLoginElementText (string $text)

	getLoginElemenText ()

	setLoginPromptType (int $a_type)

	getLoginPromptType ()

	setLogoutScope (int $a_scope)

	getLogoutScope ()

	useCustomSession (bool $a_stat)

	isCustomSession ()

	setSessionDuration (int $a_duration)

	getSessionDuration ()

	isSyncAllowed ()

	allowSync (bool $a_stat)

	setRole (int $role)

	getRole ()

	setUidField (string $field)

	getUidField ()

	getAdditionalScopes ()

	setAdditionalScopes (array $additional_scopes)

	getAllScopes ()

	deleteImageFile ()

	hasImageFile ()

	getImageFilePath ()

	setRoleMappings (array $a_role_mappings)

	getRoleMappings ()

	getRoleMappingValueForId (int $a_role_id)

	getRoleMappingUpdateForId (int $a_role_id)

	validateScopes (string $discoveryURL, array $custom_scopes)

	getSupportedScopesFromUrl (string $discoveryURL)

	save ()

	getProfileMappingFieldValue (string $field)

	clearProfileMaps ()

	setProfileMappingFieldValue (string $field, string $value)

	getProfileMappingFieldUpdate (string $field)

	setProfileMappingFieldUpdate (string $field, bool $value)

	setValidateScopes (int $validation_mode)

	getValidateScopes ()

	setCustomDiscoveryUrl (?string $discoveryUrl)

	getCustomDiscoveryUrl ()

	getProfileMappingFields ()

Static Public Member Functions
static	getInstance ()

Data Fields
const	FILE_STORAGE = 'openidconnect/login_form_image'

const	DEFAULT_SCOPE = 'openid'

const	LOGIN_ELEMENT_TYPE_TXT = 0

const	LOGIN_ELEMENT_TYPE_IMG = 1

const	LOGIN_ENFORCE = 0

const	LOGIN_STANDARD = 1

const	LOGOUT_SCOPE_GLOBAL = 0

const	LOGOUT_SCOPE_LOCAL = 1

const	URL_VALIDATION_PROVIDER = 0

const	URL_VALIDATION_CUSTOM = 1

const	URL_VALIDATION_NONE = 2

const	VALIDATION_ISSUE_INVALID_SCOPE = 0

const	VALIDATION_ISSUE_DISCOVERY_ERROR = 1

Protected Member Functions
	load ()

Private Member Functions
	__construct ()

Private Attributes
const	STORAGE_ID = 'oidc'

const	IGNORED_USER_FIELDS

readonly ilSetting	$storage

readonly Filesystem	$filesystem

bool	$active = false

string	$provider = ''

string	$client_id = ''

string	$secret = ''

int	$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

string	$login_element_img_name = null

string	$login_element_text = null

int	$login_prompt_type = self::LOGIN_ENFORCE

int	$logout_scope = null

bool	$custom_session = false

int	$session_duration = 60

bool	$allow_sync = null

int	$role = null

string	$uid = ''

array	$profile_map = []

array	$profile_update_map = []

array	$role_mappings = []

array	$additional_scopes = []

int	$validate_scopes = self::URL_VALIDATION_PROVIDER

string	$custom_discovery_url = null

ilLanguage	$lng

ilUserDefinedFields	$udf

Static Private Attributes
static self	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdConnectSettings::__construct ( )

private

Definition at line 94 of file class.ilOpenIdConnectSettings.php.

References $DIC, ilUserDefinedFields\_getInstance(), ILIAS\Repository\filesystem(), ILIAS\Repository\lng(), and load().

     {
         global $DIC;
 
         $this->storage = new ilSetting(self::STORAGE_ID);
         $this->filesystem = $DIC->filesystem()->web();
         $this->lng = $DIC->language();
         $this->udf = ilUserDefinedFields::_getInstance();
         $this->load();
     }

Here is the call graph for this function:

Member Function Documentation

◆ allowSync()

ilOpenIdConnectSettings::allowSync ( bool $a_stat )

Definition at line 229 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                            : void
     {
         $this->allow_sync = $a_stat;
     }

Here is the caller graph for this function:

◆ clearProfileMaps()

ilOpenIdConnectSettings::clearProfileMaps ( )

Definition at line 501 of file class.ilOpenIdConnectSettings.php.

                                       : void
     {
         $this->profile_map = [];
         $this->profile_update_map = [];
     }

◆ deleteImageFile()

ilOpenIdConnectSettings::deleteImageFile ( )

Definition at line 281 of file class.ilOpenIdConnectSettings.php.

References ILIAS\Repository\filesystem(), and getLoginElementImage().

                                      : void
     {
         if ($this->filesystem->has(self::FILE_STORAGE . '/' . $this->getLoginElementImage())) {
             $this->filesystem->delete(self::FILE_STORAGE . '/' . $this->getLoginElementImage());
         }
     }

Here is the call graph for this function:

◆ getActive()

ilOpenIdConnectSettings::getActive ( )

Definition at line 119 of file class.ilOpenIdConnectSettings.php.

References $active.

Referenced by save().

                                : bool
     {
         return $this->active;
     }

Here is the caller graph for this function:

◆ getAdditionalScopes()

ilOpenIdConnectSettings::getAdditionalScopes ( )

Returns: string[]

Definition at line 257 of file class.ilOpenIdConnectSettings.php.

References $additional_scopes.

Referenced by save().

                                          : array
     {
         return $this->additional_scopes;
     }

Here is the caller graph for this function:

◆ getAllScopes()

ilOpenIdConnectSettings::getAllScopes ( )

Returns: list<string>

Definition at line 273 of file class.ilOpenIdConnectSettings.php.

References $additional_scopes, and $scopes.

                                   : array
     {
         $scopes = $this->additional_scopes;
         array_unshift($scopes, self::DEFAULT_SCOPE);
 
         return $scopes;
     }

◆ getClientId()

ilOpenIdConnectSettings::getClientId ( )

Definition at line 139 of file class.ilOpenIdConnectSettings.php.

References $client_id.

Referenced by save().

                                  : string
     {
         return $this->client_id;
     }

Here is the caller graph for this function:

◆ getCustomDiscoveryUrl()

ilOpenIdConnectSettings::getCustomDiscoveryUrl ( )

Definition at line 537 of file class.ilOpenIdConnectSettings.php.

References $custom_discovery_url.

Referenced by save().

                                            : ?string
     {
         return $this->custom_discovery_url;
     }

Here is the caller graph for this function:

◆ getImageFilePath()

ilOpenIdConnectSettings::getImageFilePath ( )

Definition at line 295 of file class.ilOpenIdConnectSettings.php.

References getLoginElementImage(), and ilFileUtils\getWebspaceDir().

                                       : string
     {
         return implode(
             '/',
             [
                 ilFileUtils::getWebspaceDir(),
                 self::FILE_STORAGE . '/' . $this->getLoginElementImage()
             ]
         );
     }

Here is the call graph for this function:

◆ getInstance()

static ilOpenIdConnectSettings::getInstance ( )

static

Definition at line 105 of file class.ilOpenIdConnectSettings.php.

References null.

Referenced by ilAuthFrontendCredentialsOpenIdConnect\__construct(), ilAuthProviderOpenIdConnect\__construct(), ilOpenIdConnectSettingsGUI\__construct(), ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_isExternalAccountEnabled(), ilObjAuthSettingsGUI\authSettingsObject(), and ilStartUpGUI\showOpenIdConnectLoginForm().

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

Here is the caller graph for this function:

◆ getLoginElemenText()

ilOpenIdConnectSettings::getLoginElemenText ( )

Definition at line 179 of file class.ilOpenIdConnectSettings.php.

References $login_element_text.

Referenced by save().

                                         : string
     {
         return $this->login_element_text;
     }

Here is the caller graph for this function:

◆ getLoginElementImage()

ilOpenIdConnectSettings::getLoginElementImage ( )

Definition at line 169 of file class.ilOpenIdConnectSettings.php.

References $login_element_img_name.

Referenced by deleteImageFile(), getImageFilePath(), hasImageFile(), and save().

                                           : string
     {
         return $this->login_element_img_name;
     }

Here is the caller graph for this function:

◆ getLoginElementType()

ilOpenIdConnectSettings::getLoginElementType ( )

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

References $login_element_type.

Referenced by save().

                                          : int
     {
         return $this->login_element_type;
     }

Here is the caller graph for this function:

◆ getLoginPromptType()

ilOpenIdConnectSettings::getLoginPromptType ( )

Definition at line 189 of file class.ilOpenIdConnectSettings.php.

References $login_prompt_type.

Referenced by save().

                                         : int
     {
         return $this->login_prompt_type;
     }

Here is the caller graph for this function:

◆ getLogoutScope()

ilOpenIdConnectSettings::getLogoutScope ( )

Definition at line 199 of file class.ilOpenIdConnectSettings.php.

References $logout_scope.

Referenced by save().

                                     : int
     {
         return $this->logout_scope;
     }

Here is the caller graph for this function:

◆ getProfileMappingFields()

ilOpenIdConnectSettings::getProfileMappingFields ( )

Returns: array<string, string>

Definition at line 545 of file class.ilOpenIdConnectSettings.php.

References $id, and ILIAS\Repository\lng().

Referenced by load(), and save().

                                              : array
     {
         $mapping_fields = [];
         $usr_profile = new ilUserProfile();
 
         foreach ($usr_profile->getStandardFields() as $id => $definition) {
             if (in_array($id, self::IGNORED_USER_FIELDS, true)) {
                 continue;
             }
             $mapping_fields[$id] = $this->lng->txt($id);
         }
 
         return $mapping_fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProfileMappingFieldUpdate()

ilOpenIdConnectSettings::getProfileMappingFieldUpdate ( string $field )

Definition at line 512 of file class.ilOpenIdConnectSettings.php.

Referenced by save().

                                                                : bool
     {
         return (bool) ($this->profile_update_map[$field] ?? false);
     }

Here is the caller graph for this function:

◆ getProfileMappingFieldValue()

ilOpenIdConnectSettings::getProfileMappingFieldValue ( string $field )

Definition at line 496 of file class.ilOpenIdConnectSettings.php.

Referenced by save().

                                                               : string
     {
         return (string) ($this->profile_map[$field] ?? '');
     }

Here is the caller graph for this function:

◆ getProvider()

ilOpenIdConnectSettings::getProvider ( )

Definition at line 129 of file class.ilOpenIdConnectSettings.php.

References $provider.

Referenced by save().

                                  : string
     {
         return $this->provider;
     }

Here is the caller graph for this function:

◆ getRole()

ilOpenIdConnectSettings::getRole ( )

Definition at line 239 of file class.ilOpenIdConnectSettings.php.

References $role.

Referenced by save().

                              : int
     {
         return $this->role;
     }

Here is the caller graph for this function:

◆ getRoleMappings()

ilOpenIdConnectSettings::getRoleMappings ( )

Returns: array<int, array{value: string, update: bool}>

Definition at line 317 of file class.ilOpenIdConnectSettings.php.

References $role_mappings.

Referenced by save().

                                      : array
     {
         return $this->role_mappings;
     }

Here is the caller graph for this function:

◆ getRoleMappingUpdateForId()

ilOpenIdConnectSettings::getRoleMappingUpdateForId ( int $a_role_id )

Definition at line 331 of file class.ilOpenIdConnectSettings.php.

                                                              : bool
     {
         if (isset($this->role_mappings[$a_role_id]['update'])) {
             return (bool) $this->role_mappings[$a_role_id]['update'];
         }
 
         return false;
     }

◆ getRoleMappingValueForId()

ilOpenIdConnectSettings::getRoleMappingValueForId ( int $a_role_id )

Definition at line 322 of file class.ilOpenIdConnectSettings.php.

                                                             : string
     {
         if (isset($this->role_mappings[$a_role_id]['value'])) {
             return (string) $this->role_mappings[$a_role_id]['value'];
         }
 
         return '';
     }

◆ getSecret()

ilOpenIdConnectSettings::getSecret ( )

Definition at line 149 of file class.ilOpenIdConnectSettings.php.

References $secret.

Referenced by save().

                                : string
     {
         return $this->secret;
     }

Here is the caller graph for this function:

◆ getSessionDuration()

ilOpenIdConnectSettings::getSessionDuration ( )

Definition at line 219 of file class.ilOpenIdConnectSettings.php.

References $session_duration.

Referenced by save().

                                         : int
     {
         return $this->session_duration;
     }

Here is the caller graph for this function:

◆ getSupportedScopesFromUrl()

ilOpenIdConnectSettings::getSupportedScopesFromUrl ( string $discoveryURL )

Definition at line 382 of file class.ilOpenIdConnectSettings.php.

References $response, and setAdditionalScopes().

                                                                    : bool
     {
         try {
             $curl = new ilCurlConnection($discoveryURL);
             $curl->init();
 
             $curl->setOpt(CURLOPT_HEADER, 0);
             $curl->setOpt(CURLOPT_RETURNTRANSFER, true);
             $curl->setOpt(CURLOPT_TIMEOUT, 4);
 
             $response = $curl->exec();
 
             if ($curl->getInfo(CURLINFO_RESPONSE_CODE) === 200) {
                 $decoded_response = json_decode($response, false, 512, JSON_THROW_ON_ERROR);
 
                 if (isset($decoded_response->scopes_supported) &&
                     is_array($decoded_response->scopes_supported) &&
                     $decoded_response->scopes_supported !== []) {
                     $available_scopes = $decoded_response->scopes_supported;
                     $this->setAdditionalScopes($available_scopes);
 
                     return true;
                 }
             }
         } finally {
             if (isset($curl)) {
                 $curl->close();
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ getUidField()

ilOpenIdConnectSettings::getUidField ( )

Definition at line 249 of file class.ilOpenIdConnectSettings.php.

References $uid.

Referenced by save().

                                  : string
     {
         return $this->uid;
     }

Here is the caller graph for this function:

◆ getValidateScopes()

ilOpenIdConnectSettings::getValidateScopes ( )

Definition at line 527 of file class.ilOpenIdConnectSettings.php.

References $validate_scopes.

Referenced by load(), and save().

                                        : int
     {
         return $this->validate_scopes;
     }

Here is the caller graph for this function:

◆ hasImageFile()

ilOpenIdConnectSettings::hasImageFile ( )

Definition at line 288 of file class.ilOpenIdConnectSettings.php.

References ILIAS\Repository\filesystem(), and getLoginElementImage().

                                   : bool
     {
         return
             $this->getLoginElementImage() !== '' &&
             $this->filesystem->has(self::FILE_STORAGE . '/' . $this->getLoginElementImage());
     }

Here is the call graph for this function:

◆ isCustomSession()

ilOpenIdConnectSettings::isCustomSession ( )

Definition at line 209 of file class.ilOpenIdConnectSettings.php.

References $custom_session.

Referenced by save().

                                      : bool
     {
         return $this->custom_session;
     }

Here is the caller graph for this function:

◆ isSyncAllowed()

ilOpenIdConnectSettings::isSyncAllowed ( )

Definition at line 224 of file class.ilOpenIdConnectSettings.php.

References $allow_sync.

Referenced by save().

                                    : bool
     {
         return $this->allow_sync;
     }

Here is the caller graph for this function:

◆ load()

ilOpenIdConnectSettings::load ( )

protected

Definition at line 452 of file class.ilOpenIdConnectSettings.php.

References allowSync(), getProfileMappingFields(), getValidateScopes(), setActive(), setAdditionalScopes(), setClientId(), setCustomDiscoveryUrl(), setLoginElementImage(), setLoginElementText(), setLoginElementType(), setLoginPromptType(), setLogoutScope(), setProvider(), setRole(), setRoleMappings(), setSecret(), setSessionDuration(), setUidField(), setValidateScopes(), and useCustomSession().

Referenced by __construct().

                              : void
     {
         foreach ($this->getProfileMappingFields() as $field => $lang_key) {
             $this->profile_map[$field] = (string) $this->storage->get('pmap_' . $field, '');
             $this->profile_update_map[$field] = (bool) $this->storage->get('pumap_' . $field, '0');
         }
         foreach ($this->udf->getDefinitions() as $definition) {
             $field = 'udf_' . $definition['field_id'];
             $this->profile_map[$field] = (string) $this->storage->get('pmap_' . $field, '');
             $this->profile_update_map[$field] = (bool) $this->storage->get('pumap_' . $field, '0');
         }
 
         $this->setActive((bool) $this->storage->get('active', '0'));
         $this->setProvider($this->storage->get('provider', ''));
         $this->setClientId($this->storage->get('client_id', ''));
         $this->setSecret($this->storage->get('secret', ''));
         $this->setAdditionalScopes(
             (array) unserialize(
                 $this->storage->get('scopes', serialize([])),
                 ['allowed_classes' => false]
             )
         );
         $this->setLoginElementImage($this->storage->get('le_img', ''));
         $this->setLoginElementText((string) $this->storage->get('le_text'));
         $this->setLoginElementType((int) $this->storage->get('le_type'));
         $this->setLoginPromptType((int) $this->storage->get('prompt_type', (string) self::LOGIN_ENFORCE));
         $this->setLogoutScope((int) $this->storage->get('logout_scope', (string) self::LOGOUT_SCOPE_GLOBAL));
         $this->useCustomSession((bool) $this->storage->get('custom_session', '0'));
         $this->setSessionDuration((int) $this->storage->get('session_duration', '60'));
         $this->allowSync((bool) $this->storage->get('allow_sync', '0'));
         $this->setRole((int) $this->storage->get('role', '0'));
         $this->setUidField((string) $this->storage->get('uid', ''));
         $this->setRoleMappings(
             (array) unserialize(
                 $this->storage->get('role_mappings', serialize([])),
                 ['allowed_classes' => false]
             )
         );
         $this->setValidateScopes((int) $this->storage->get('validate_scopes', (string) self::URL_VALIDATION_PROVIDER));
         if (self::URL_VALIDATION_CUSTOM === $this->getValidateScopes()) {
             $this->setCustomDiscoveryUrl($this->storage->get('custom_discovery_url'));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilOpenIdConnectSettings::save ( )

Definition at line 415 of file class.ilOpenIdConnectSettings.php.

References getActive(), getAdditionalScopes(), getClientId(), getCustomDiscoveryUrl(), getLoginElemenText(), getLoginElementImage(), getLoginElementType(), getLoginPromptType(), getLogoutScope(), getProfileMappingFields(), getProfileMappingFieldUpdate(), getProfileMappingFieldValue(), getProvider(), getRole(), getRoleMappings(), getSecret(), getSessionDuration(), getUidField(), getValidateScopes(), isCustomSession(), and isSyncAllowed().

                           : void
     {
         $this->storage->set('active', (string) ((int) $this->getActive()));
         $this->storage->set('provider', $this->getProvider());
         $this->storage->set('client_id', $this->getClientId());
         $this->storage->set('secret', $this->getSecret());
         $this->storage->set('scopes', serialize($this->getAdditionalScopes()));
         $this->storage->set('le_img', $this->getLoginElementImage());
         $this->storage->set('le_text', $this->getLoginElemenText());
         $this->storage->set('le_type', (string) $this->getLoginElementType());
         $this->storage->set('prompt_type', (string) $this->getLoginPromptType());
         $this->storage->set('logout_scope', (string) $this->getLogoutScope());
         $this->storage->set('custom_session', (string) ((int) $this->isCustomSession()));
         $this->storage->set('session_duration', (string) $this->getSessionDuration());
         $this->storage->set('allow_sync', (string) ((int) $this->isSyncAllowed()));
         $this->storage->set('role', (string) $this->getRole());
         $this->storage->set('uid', $this->getUidField());
 
         foreach ($this->getProfileMappingFields() as $field => $lng_key) {
             $this->storage->set('pmap_' . $field, $this->getProfileMappingFieldValue($field));
             $this->storage->set('pumap_' . $field, (string) ((int) $this->getProfileMappingFieldUpdate($field)));
         }
 
         foreach ($this->udf->getDefinitions() as $definition) {
             $field = 'udf_' . $definition['field_id'];
             $this->storage->set('pmap_' . $field, $this->getProfileMappingFieldValue($field));
             $this->storage->set('pumap_' . $field, (string) ((int) $this->getProfileMappingFieldUpdate($field)));
         }
         $this->storage->set('role_mappings', serialize($this->getRoleMappings()));
         $this->storage->set('validate_scopes', (string) $this->getValidateScopes());
         if (self::URL_VALIDATION_CUSTOM === $this->getValidateScopes()) {
             $this->storage->set('custom_discovery_url', $this->getCustomDiscoveryUrl());
         } else {
             $this->storage->delete('custom_discovery_url');
         }
     }

Here is the call graph for this function:

◆ setActive()

ilOpenIdConnectSettings::setActive ( bool $active )

Definition at line 114 of file class.ilOpenIdConnectSettings.php.

References $active.

Referenced by load().

                                            : void
     {
         $this->active = $active;
     }

Here is the caller graph for this function:

◆ setAdditionalScopes()

ilOpenIdConnectSettings::setAdditionalScopes ( array $additional_scopes )

Parameters

list<string> $additional_scopes

Definition at line 265 of file class.ilOpenIdConnectSettings.php.

References $additional_scopes.

Referenced by getSupportedScopesFromUrl(), and load().

                                                                  : void
     {
         $this->additional_scopes = $additional_scopes;
     }

Here is the caller graph for this function:

◆ setClientId()

ilOpenIdConnectSettings::setClientId ( string $client_id )

Definition at line 134 of file class.ilOpenIdConnectSettings.php.

References $client_id.

Referenced by load().

                                                   : void
     {
         $this->client_id = $client_id;
     }

Here is the caller graph for this function:

◆ setCustomDiscoveryUrl()

ilOpenIdConnectSettings::setCustomDiscoveryUrl ( ?string $discoveryUrl )

Definition at line 532 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                                 : void
     {
         $this->custom_discovery_url = $discoveryUrl;
     }

Here is the caller graph for this function:

◆ setLoginElementImage()

ilOpenIdConnectSettings::setLoginElementImage ( string $a_img_name )

Definition at line 164 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                             : void
     {
         $this->login_element_img_name = $a_img_name;
     }

Here is the caller graph for this function:

◆ setLoginElementText()

ilOpenIdConnectSettings::setLoginElementText ( string $text )

Definition at line 174 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                      : void
     {
         $this->login_element_text = $text;
     }

Here is the caller graph for this function:

◆ setLoginElementType()

ilOpenIdConnectSettings::setLoginElementType ( int $type )

Definition at line 154 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                   : void
     {
         $this->login_element_type = $type;
     }

Here is the caller graph for this function:

◆ setLoginPromptType()

ilOpenIdConnectSettings::setLoginPromptType ( int $a_type )

Definition at line 184 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                    : void
     {
         $this->login_prompt_type = $a_type;
     }

Here is the caller graph for this function:

◆ setLogoutScope()

ilOpenIdConnectSettings::setLogoutScope ( int $a_scope )

Definition at line 194 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                 : void
     {
         $this->logout_scope = $a_scope;
     }

Here is the caller graph for this function:

◆ setProfileMappingFieldUpdate()

ilOpenIdConnectSettings::setProfileMappingFieldUpdate	(	string	$field,
		bool	$value
	)

Definition at line 517 of file class.ilOpenIdConnectSettings.php.

                                                                             : void
     {
         $this->profile_update_map[$field] = $value;
     }

◆ setProfileMappingFieldValue()

ilOpenIdConnectSettings::setProfileMappingFieldValue	(	string	$field,
		string	$value
	)

Definition at line 507 of file class.ilOpenIdConnectSettings.php.

                                                                              : void
     {
         $this->profile_map[$field] = $value;
     }

◆ setProvider()

ilOpenIdConnectSettings::setProvider ( string $url )

Definition at line 124 of file class.ilOpenIdConnectSettings.php.

References $url.

Referenced by load().

                                             : void
     {
         $this->provider = $url;
     }

Here is the caller graph for this function:

◆ setRole()

ilOpenIdConnectSettings::setRole ( int $role )

Definition at line 234 of file class.ilOpenIdConnectSettings.php.

References $role.

Referenced by load().

                                       : void
     {
         $this->role = $role;
     }

Here is the caller graph for this function:

◆ setRoleMappings()

ilOpenIdConnectSettings::setRoleMappings ( array $a_role_mappings )

Parameters

array<int,array{value string, update: bool}> $a_role_mappings

Definition at line 309 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                            : void
     {
         $this->role_mappings = $a_role_mappings;
     }

Here is the caller graph for this function:

◆ setSecret()

ilOpenIdConnectSettings::setSecret ( string $secret )

Definition at line 144 of file class.ilOpenIdConnectSettings.php.

References $secret.

Referenced by load().

                                              : void
     {
         $this->secret = $secret;
     }

Here is the caller graph for this function:

◆ setSessionDuration()

ilOpenIdConnectSettings::setSessionDuration ( int $a_duration )

Definition at line 214 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                        : void
     {
         $this->session_duration = $a_duration;
     }

Here is the caller graph for this function:

◆ setUidField()

ilOpenIdConnectSettings::setUidField ( string $field )

Definition at line 244 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                               : void
     {
         $this->uid = $field;
     }

Here is the caller graph for this function:

◆ setValidateScopes()

ilOpenIdConnectSettings::setValidateScopes ( int $validation_mode )

Definition at line 522 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                            : void
     {
         $this->validate_scopes = $validation_mode;
     }

Here is the caller graph for this function:

◆ useCustomSession()

ilOpenIdConnectSettings::useCustomSession ( bool $a_stat )

Definition at line 204 of file class.ilOpenIdConnectSettings.php.

Referenced by load().

                                                   : void
     {
         $this->custom_session = $a_stat;
     }

Here is the caller graph for this function:

◆ validateScopes()

ilOpenIdConnectSettings::validateScopes	(	string	$discoveryURL,
		array	$custom_scopes
	)

Parameters

list<string> $custom_scopes

Returns: array{}|array{0: int, 1: list<string>}|array{0: int, 1: string}

Definition at line 344 of file class.ilOpenIdConnectSettings.php.

References $response.

                                                                               : array
     {
         $result = [];
         try {
             $curl = new ilCurlConnection($discoveryURL);
             $curl->init();
 
             $curl->setOpt(CURLOPT_HEADER, 0);
             $curl->setOpt(CURLOPT_RETURNTRANSFER, true);
             $curl->setOpt(CURLOPT_TIMEOUT, 4);
 
             $response = $curl->exec();
 
             if ($curl->getInfo(CURLINFO_RESPONSE_CODE) === 200) {
                 $decoded_response = json_decode($response, false, 512, JSON_THROW_ON_ERROR);
                 $available_scopes = $decoded_response->scopes_supported;
                 array_unshift($custom_scopes, self::DEFAULT_SCOPE);
                 if (!empty(array_diff($custom_scopes, $available_scopes))) {
                     $result = [
                         self::VALIDATION_ISSUE_INVALID_SCOPE,
                         array_diff($custom_scopes, $available_scopes)
                     ];
                 }
             } else {
                 $result = [
                     self::VALIDATION_ISSUE_DISCOVERY_ERROR,
                     is_string($response) ? $response : var_export($response, true)
                 ];
             }
         } finally {
             if (isset($curl)) {
                 $curl->close();
             }
         }
 
         return $result;
     }

Field Documentation

◆ $active

bool ilOpenIdConnectSettings::$active = false

private

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

Referenced by getActive(), and setActive().

◆ $additional_scopes

array ilOpenIdConnectSettings::$additional_scopes = []

private

Definition at line 88 of file class.ilOpenIdConnectSettings.php.

Referenced by getAdditionalScopes(), getAllScopes(), and setAdditionalScopes().

◆ $allow_sync

bool ilOpenIdConnectSettings::$allow_sync = null

private

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

Referenced by isSyncAllowed().

◆ $client_id

string ilOpenIdConnectSettings::$client_id = ''

private

Definition at line 69 of file class.ilOpenIdConnectSettings.php.

Referenced by getClientId(), and setClientId().

◆ $custom_discovery_url

string ilOpenIdConnectSettings::$custom_discovery_url = null

private

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

Referenced by getCustomDiscoveryUrl().

◆ $custom_session

bool ilOpenIdConnectSettings::$custom_session = false

private

Definition at line 76 of file class.ilOpenIdConnectSettings.php.

Referenced by isCustomSession().

◆ $filesystem

readonly Filesystem ilOpenIdConnectSettings::$filesystem

private

Definition at line 66 of file class.ilOpenIdConnectSettings.php.

◆ $instance

self ilOpenIdConnectSettings::$instance = null

staticprivate

Definition at line 63 of file class.ilOpenIdConnectSettings.php.

◆ $lng

ilLanguage ilOpenIdConnectSettings::$lng

private

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

◆ $login_element_img_name

string ilOpenIdConnectSettings::$login_element_img_name = null

private

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

Referenced by getLoginElementImage().

◆ $login_element_text

string ilOpenIdConnectSettings::$login_element_text = null

private

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

Referenced by getLoginElemenText().

◆ $login_element_type

int ilOpenIdConnectSettings::$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

private

Definition at line 71 of file class.ilOpenIdConnectSettings.php.

Referenced by getLoginElementType().

◆ $login_prompt_type

int ilOpenIdConnectSettings::$login_prompt_type = self::LOGIN_ENFORCE

private

Definition at line 74 of file class.ilOpenIdConnectSettings.php.

Referenced by getLoginPromptType().

◆ $logout_scope

int ilOpenIdConnectSettings::$logout_scope = null

private

Definition at line 75 of file class.ilOpenIdConnectSettings.php.

Referenced by getLogoutScope().

◆ $profile_map

array ilOpenIdConnectSettings::$profile_map = []

private

Definition at line 82 of file class.ilOpenIdConnectSettings.php.

◆ $profile_update_map

array ilOpenIdConnectSettings::$profile_update_map = []

private

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

◆ $provider

string ilOpenIdConnectSettings::$provider = ''

private

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

Referenced by getProvider().

◆ $role

int ilOpenIdConnectSettings::$role = null

private

Definition at line 79 of file class.ilOpenIdConnectSettings.php.

Referenced by getRole(), and setRole().

◆ $role_mappings

array ilOpenIdConnectSettings::$role_mappings = []

private

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

Referenced by getRoleMappings().

◆ $secret

string ilOpenIdConnectSettings::$secret = ''

private

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

Referenced by getSecret(), and setSecret().

◆ $session_duration

int ilOpenIdConnectSettings::$session_duration = 60

private

Definition at line 77 of file class.ilOpenIdConnectSettings.php.

Referenced by getSessionDuration().

◆ $storage

readonly ilSetting ilOpenIdConnectSettings::$storage

private

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

◆ $udf

ilUserDefinedFields ilOpenIdConnectSettings::$udf

private

Definition at line 92 of file class.ilOpenIdConnectSettings.php.

◆ $uid

string ilOpenIdConnectSettings::$uid = ''

private

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

Referenced by getUidField().

◆ $validate_scopes

int ilOpenIdConnectSettings::$validate_scopes = self::URL_VALIDATION_PROVIDER

private

Definition at line 89 of file class.ilOpenIdConnectSettings.php.

Referenced by getValidateScopes().

◆ DEFAULT_SCOPE

const ilOpenIdConnectSettings::DEFAULT_SCOPE = 'openid'

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

Referenced by ilOpenIdConnectSettingsGUI\buildScopeSelection().

◆ FILE_STORAGE

const ilOpenIdConnectSettings::FILE_STORAGE = 'openidconnect/login_form_image'

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

Referenced by ilOpenIdConnectSettingsGUI\saveImageFromHttpRequest().

◆ IGNORED_USER_FIELDS

const ilOpenIdConnectSettings::IGNORED_USER_FIELDS

private

Initial value:

= [
        'mail_incoming_mail',
        'preferences',
        'hide_own_online_status',
        'show_users_online',
        'roles',
        'upload',
        'password',
        'username',
        'language',
        'skin_style',
        'interests_general',
        'interests_help_offered',
        'interests_help_looking',
        'bs_allow_to_contact_me',
        'chat_osc_accept_msg',
        'chat_broadcast_typing',
    ]