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

Profile	$profile

Static Private Attributes
static self	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdConnectSettings::__construct ( )

private

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

    {
        global $DIC;
 
        $this->storage = new ilSetting(self::STORAGE_ID);
        $this->filesystem = $DIC->filesystem()->web();
        $this->lng = $DIC->language();
        $this->profile = $DIC['user']->getProfile();
        $this->load();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ allowSync()

ilOpenIdConnectSettings::allowSync ( bool $a_stat )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ clearProfileMaps()

ilOpenIdConnectSettings::clearProfileMaps ( )

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

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

◆ deleteImageFile()

ilOpenIdConnectSettings::deleteImageFile ( )

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

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

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

Here is the call graph for this function:

◆ getActive()

ilOpenIdConnectSettings::getActive ( )

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

                               : bool
    {
        return $this->active;
    }

References $active.

Referenced by save().

Here is the caller graph for this function:

◆ getAdditionalScopes()

ilOpenIdConnectSettings::getAdditionalScopes ( )

Returns: string[]

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

                                         : array
    {
        return $this->additional_scopes;
    }

References $additional_scopes.

Referenced by save().

Here is the caller graph for this function:

◆ getAllScopes()

ilOpenIdConnectSettings::getAllScopes ( )

Returns: list<string>

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

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

References $additional_scopes, and $scopes.

◆ getClientId()

ilOpenIdConnectSettings::getClientId ( )

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

                                 : string
    {
        return $this->client_id;
    }

References $client_id.

Referenced by save().

Here is the caller graph for this function:

◆ getCustomDiscoveryUrl()

ilOpenIdConnectSettings::getCustomDiscoveryUrl ( )

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

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

References $custom_discovery_url.

Referenced by save().

Here is the caller graph for this function:

◆ getImageFilePath()

ilOpenIdConnectSettings::getImageFilePath ( )

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

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

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

Here is the call graph for this function:

◆ getInstance()

static ilOpenIdConnectSettings::getInstance ( )

static

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

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

References $instance.

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

Here is the caller graph for this function:

◆ getLoginElemenText()

ilOpenIdConnectSettings::getLoginElemenText ( )

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

                                        : string
    {
        return $this->login_element_text;
    }

References $login_element_text.

Referenced by save().

Here is the caller graph for this function:

◆ getLoginElementImage()

ilOpenIdConnectSettings::getLoginElementImage ( )

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

                                          : string
    {
        return $this->login_element_img_name;
    }

References $login_element_img_name.

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

Here is the caller graph for this function:

◆ getLoginElementType()

ilOpenIdConnectSettings::getLoginElementType ( )

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

                                         : int
    {
        return $this->login_element_type;
    }

References $login_element_type.

Referenced by save().

Here is the caller graph for this function:

◆ getLoginPromptType()

ilOpenIdConnectSettings::getLoginPromptType ( )

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

                                        : int
    {
        return $this->login_prompt_type;
    }

References $login_prompt_type.

Referenced by save().

Here is the caller graph for this function:

◆ getLogoutScope()

ilOpenIdConnectSettings::getLogoutScope ( )

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

                                    : int
    {
        return $this->logout_scope;
    }

References $logout_scope.

Referenced by save().

Here is the caller graph for this function:

◆ getProfileMappingFields()

ilOpenIdConnectSettings::getProfileMappingFields ( )

Returns: array<string, string>

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

                                             : array
    {
        $mapping_fields = [];
 
        foreach ($this->profile->getFields() as $field) {
            if (in_array($field->getIdentifier(), self::IGNORED_USER_FIELDS, true)) {
                continue;
            }
            $mapping_fields[$field->getIdentifier()] = $this->lng->txt($field->getIdentifier());
        }
 
        return $mapping_fields;
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\profile().

Referenced by load(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProfileMappingFieldUpdate()

ilOpenIdConnectSettings::getProfileMappingFieldUpdate ( string $field )

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

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

Referenced by save().

Here is the caller graph for this function:

◆ getProfileMappingFieldValue()

ilOpenIdConnectSettings::getProfileMappingFieldValue ( string $field )

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

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

Referenced by save().

Here is the caller graph for this function:

◆ getProvider()

ilOpenIdConnectSettings::getProvider ( )

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

                                 : string
    {
        return $this->provider;
    }

References $provider.

Referenced by save().

Here is the caller graph for this function:

◆ getRole()

ilOpenIdConnectSettings::getRole ( )

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

                             : int
    {
        return $this->role;
    }

References $role.

Referenced by save().

Here is the caller graph for this function:

◆ getRoleMappings()

ilOpenIdConnectSettings::getRoleMappings ( )

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

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

                                     : array
    {
        return $this->role_mappings;
    }

References $role_mappings.

Referenced by save().

Here is the caller graph for this function:

◆ getRoleMappingUpdateForId()

ilOpenIdConnectSettings::getRoleMappingUpdateForId ( int $a_role_id )

Definition at line 332 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 323 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 150 of file class.ilOpenIdConnectSettings.php.

                               : string
    {
        return $this->secret;
    }

References $secret.

Referenced by save().

Here is the caller graph for this function:

◆ getSessionDuration()

ilOpenIdConnectSettings::getSessionDuration ( )

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

                                        : int
    {
        return $this->session_duration;
    }

References $session_duration.

Referenced by save().

Here is the caller graph for this function:

◆ getSupportedScopesFromUrl()

ilOpenIdConnectSettings::getSupportedScopesFromUrl ( string $discoveryURL )

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

                                                                   : 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;
    }

References $response, and setAdditionalScopes().

Here is the call graph for this function:

◆ getUidField()

ilOpenIdConnectSettings::getUidField ( )

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

                                 : string
    {
        return $this->uid;
    }

References $uid.

Referenced by save().

Here is the caller graph for this function:

◆ getValidateScopes()

ilOpenIdConnectSettings::getValidateScopes ( )

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

                                       : int
    {
        return $this->validate_scopes;
    }

References $validate_scopes.

Referenced by load(), and save().

Here is the caller graph for this function:

◆ hasImageFile()

ilOpenIdConnectSettings::hasImageFile ( )

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

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

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

Here is the call graph for this function:

◆ isCustomSession()

ilOpenIdConnectSettings::isCustomSession ( )

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

                                     : bool
    {
        return $this->custom_session;
    }

References $custom_session.

Referenced by save().

Here is the caller graph for this function:

◆ isSyncAllowed()

ilOpenIdConnectSettings::isSyncAllowed ( )

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

                                   : bool
    {
        return $this->allow_sync;
    }

References $allow_sync.

Referenced by save().

Here is the caller graph for this function:

◆ load()

ilOpenIdConnectSettings::load ( )

protected

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

                             : 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->profile->getAllUserDefinedFields() as $definition) {
            $field = 'udf_' . $definition->getIdentifier();
            $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'));
        }
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilOpenIdConnectSettings::save ( )

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

                          : 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->profile->getAllUserDefinedFields() as $definition) {
            $field = 'udf_' . $definition->getIdentifier();
            $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');
        }
    }

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

Here is the call graph for this function:

◆ setActive()

ilOpenIdConnectSettings::setActive ( bool $active )

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

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

References $active.

Referenced by load().

Here is the caller graph for this function:

◆ setAdditionalScopes()

ilOpenIdConnectSettings::setAdditionalScopes ( array $additional_scopes )

Parameters

list<string> $additional_scopes

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

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

References $additional_scopes.

Referenced by getSupportedScopesFromUrl(), and load().

Here is the caller graph for this function:

◆ setClientId()

ilOpenIdConnectSettings::setClientId ( string $client_id )

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

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

References $client_id.

Referenced by load().

Here is the caller graph for this function:

◆ setCustomDiscoveryUrl()

ilOpenIdConnectSettings::setCustomDiscoveryUrl ( ?string $discoveryUrl )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementImage()

ilOpenIdConnectSettings::setLoginElementImage ( string $a_img_name )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementText()

ilOpenIdConnectSettings::setLoginElementText ( string $text )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementType()

ilOpenIdConnectSettings::setLoginElementType ( int $type )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setLoginPromptType()

ilOpenIdConnectSettings::setLoginPromptType ( int $a_type )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setLogoutScope()

ilOpenIdConnectSettings::setLogoutScope ( int $a_scope )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setProfileMappingFieldUpdate()

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

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

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

◆ setProfileMappingFieldValue()

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

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

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

◆ setProvider()

ilOpenIdConnectSettings::setProvider ( string $url )

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

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

References $url.

Referenced by load().

Here is the caller graph for this function:

◆ setRole()

ilOpenIdConnectSettings::setRole ( int $role )

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

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

References $role.

Referenced by load().

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 310 of file class.ilOpenIdConnectSettings.php.

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

Referenced by load().

Here is the caller graph for this function:

◆ setSecret()

ilOpenIdConnectSettings::setSecret ( string $secret )

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

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

References $secret.

Referenced by load().

Here is the caller graph for this function:

◆ setSessionDuration()

ilOpenIdConnectSettings::setSessionDuration ( int $a_duration )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setUidField()

ilOpenIdConnectSettings::setUidField ( string $field )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ setValidateScopes()

ilOpenIdConnectSettings::setValidateScopes ( int $validation_mode )

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

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

Referenced by load().

Here is the caller graph for this function:

◆ useCustomSession()

ilOpenIdConnectSettings::useCustomSession ( bool $a_stat )

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

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

Referenced by load().

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 345 of file class.ilOpenIdConnectSettings.php.

                                                                              : 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;
    }

References $response, VALIDATION_ISSUE_DISCOVERY_ERROR, and VALIDATION_ISSUE_INVALID_SCOPE.

Field Documentation

◆ $active

bool ilOpenIdConnectSettings::$active = false

private

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

Referenced by getActive(), and setActive().

◆ $additional_scopes

array ilOpenIdConnectSettings::$additional_scopes = []

private

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

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

◆ $allow_sync

bool ilOpenIdConnectSettings::$allow_sync = null

private

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

Referenced by isSyncAllowed().

◆ $client_id

string ilOpenIdConnectSettings::$client_id = ''

private

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

Referenced by getClientId(), and setClientId().

◆ $custom_discovery_url

string ilOpenIdConnectSettings::$custom_discovery_url = null

private

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

Referenced by getCustomDiscoveryUrl().

◆ $custom_session

bool ilOpenIdConnectSettings::$custom_session = false

private

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

Referenced by isCustomSession().

◆ $filesystem

readonly Filesystem ilOpenIdConnectSettings::$filesystem

private

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

◆ $instance

self ilOpenIdConnectSettings::$instance = null

staticprivate

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

Referenced by getInstance().

◆ $lng

ilLanguage ilOpenIdConnectSettings::$lng

private

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

◆ $login_element_img_name

string ilOpenIdConnectSettings::$login_element_img_name = null

private

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

Referenced by getLoginElementImage().

◆ $login_element_text

string ilOpenIdConnectSettings::$login_element_text = null

private

Definition at line 74 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 72 of file class.ilOpenIdConnectSettings.php.

Referenced by getLoginElementType().

◆ $login_prompt_type

int ilOpenIdConnectSettings::$login_prompt_type = self::LOGIN_ENFORCE

private

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

Referenced by getLoginPromptType().

◆ $logout_scope

int ilOpenIdConnectSettings::$logout_scope = null

private

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

Referenced by getLogoutScope().

◆ $profile

Profile ilOpenIdConnectSettings::$profile

private

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

◆ $profile_map

array ilOpenIdConnectSettings::$profile_map = []

private

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

◆ $profile_update_map

array ilOpenIdConnectSettings::$profile_update_map = []

private

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

◆ $provider

string ilOpenIdConnectSettings::$provider = ''

private

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

Referenced by getProvider().

◆ $role

int ilOpenIdConnectSettings::$role = null

private

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

Referenced by getRole(), and setRole().

◆ $role_mappings

array ilOpenIdConnectSettings::$role_mappings = []

private

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

Referenced by getRoleMappings().

◆ $secret

string ilOpenIdConnectSettings::$secret = ''

private

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

Referenced by getSecret(), and setSecret().

◆ $session_duration

int ilOpenIdConnectSettings::$session_duration = 60

private

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

Referenced by getSessionDuration().

◆ $storage

readonly ilSetting ilOpenIdConnectSettings::$storage

private

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

◆ $uid

string ilOpenIdConnectSettings::$uid = ''

private

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

Referenced by getUidField().

◆ $validate_scopes

int ilOpenIdConnectSettings::$validate_scopes = self::URL_VALIDATION_PROVIDER

private

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

Referenced by getValidateScopes().

◆ DEFAULT_SCOPE

const ilOpenIdConnectSettings::DEFAULT_SCOPE = 'openid'

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

Referenced by ilOpenIdConnectSettingsGUI\buildScopeSelection().

◆ FILE_STORAGE

const ilOpenIdConnectSettings::FILE_STORAGE = 'openidconnect/login_form_image'

Definition at line 28 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',
    ]