Class ilOpenIdConnectSettingsGUI. More...

Collaboration diagram for ilOpenIdConnectSettings:

Public Member Functions
	setActive (bool $active)

	getActive ()

	setProvider (string $url)

	getProvider ()

	setClientId (string $client_id)

	getClientId ()

	setSecret (string $secret)

	getSecret ()
	Get secret. More...

	setLoginElementType (int $type)
	Set login element type. More...

	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 ()
	Delete image file. More...

	hasImageFile ()

	getImageFilePath ()

	setRoleMappings (array $a_role_mappings)

	getRoleMappings ()
	Get role mappings. More...

	getRoleMappingValueForId ($a_role_id)

	getRoleMappingUpdateForId ($a_role_id)

	setValidateScopes (int $validation_mode)

	getValidateScopes ()

	setCustomDiscoveryUrl (?string $discoveryUrl)

	getCustomDiscoveryUrl ()

	validateScopes (string $discoveryURL, array $custom_scopes)

	save ()
	Save in settings. More...

	getProfileMappingFieldValue (string $field)

	setProfileMappingFieldValue (string $field, string $value)

	getProfileMappingFieldUpdate (string $field)

	setProfileMappingFieldUpdate (string $field, bool $value)

	getProfileMappingFields ()

Static Public Member Functions
static	getInstance ()
	Get singleton instance. More...

Data Fields
const	FILE_STORAGE = 'openidconnect/login_form_image'

const	STORAGE_ID = 'oidc'

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 ()
	Load from settings. More...

Private Member Functions
	__construct ()
	ilOpenIdConnectSettings constructor. More...

Private Attributes
	$storage = null

	$filesystem = null

	$active = false

	$provider = ''

	$client_id = ''

	$secret = ''

	$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

	$login_element_img_name

	$login_element_text

	$login_prompt_type = self::LOGIN_ENFORCE

	$logout_scope

	$custom_session = false

	$session_duration = 60

	$allow_sync

	$role

	$uid = ''

	$profile_map = []

	$profile_update_map = []

	$role_mappings = []

	$additional_scopes = []

	$validate_scopes = self::URL_VALIDATION_PROVIDER

	$custom_discovery_url = null

Static Private Attributes
static	$instance = null

Detailed Description

Class ilOpenIdConnectSettingsGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdConnectSettings::__construct ( )

private

ilOpenIdConnectSettings constructor.

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

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

References $DIC, and load().

Here is the call graph for this function:

Member Function Documentation

◆ allowSync()

ilOpenIdConnectSettings::allowSync ( bool $a_stat )

Parameters

bool $a_stat

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

    {
        $this->allow_sync = $a_stat;
    }

Referenced by load().

Here is the caller graph for this function:

◆ deleteImageFile()

ilOpenIdConnectSettings::deleteImageFile ( )

Delete image file.

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

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

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

References getLoginElementImage().

Here is the call graph for this function:

◆ getActive()

ilOpenIdConnectSettings::getActive ( )

Returns: bool

Definition at line 182 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: array

Definition at line 393 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: array

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

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

References $additional_scopes.

◆ getClientId()

ilOpenIdConnectSettings::getClientId ( )

Returns: string

Definition at line 214 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 514 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 ( )

Returns: string

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

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

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

Here is the call graph for this function:

◆ getInstance()

static ilOpenIdConnectSettings::getInstance ( )

static

Get singleton instance.

Returns: \ilOpenIdConnectSettings

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

                                         : \ilOpenIdConnectSettings
    {
        if (!self::$instance) {
            self::$instance = new self();
        }
        return new self::$instance;
    }

References $instance.

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

Here is the caller graph for this function:

◆ getLoginElemenText()

ilOpenIdConnectSettings::getLoginElemenText ( )

Definition at line 273 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 ( )

Returns: string

Definition at line 262 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 ( )

Returns: int

Definition at line 246 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 ( )

Returns: int

Definition at line 289 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 ( )

Returns: int

Definition at line 305 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

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

                                              : array
    {
        return [
            'firstname' => 'firstname',
            'lastname' => 'lastname',
            'email' => 'email',
            'birthday' => 'birthday'
        ];
    }

Referenced by load(), and save().

Here is the caller graph for this function:

◆ getProfileMappingFieldUpdate()

ilOpenIdConnectSettings::getProfileMappingFieldUpdate ( string $field )

Parameters

string $value

Returns: bool

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

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

Referenced by save().

Here is the caller graph for this function:

◆ getProfileMappingFieldValue()

ilOpenIdConnectSettings::getProfileMappingFieldValue ( string $field )

Parameters

string $field

Definition at line 623 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 ( )

Returns: string

Definition at line 198 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 ( )

Returns: int

Definition at line 369 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 ( )

Get role mappings.

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

                                      : array
    {
        return (array) $this->role_mappings;
    }

References $role_mappings.

Referenced by save().

Here is the caller graph for this function:

◆ getRoleMappingUpdateForId()

ilOpenIdConnectSettings::getRoleMappingUpdateForId ( $a_role_id )

Parameters

$a_role_id

Returns: string

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

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

◆ getRoleMappingValueForId()

ilOpenIdConnectSettings::getRoleMappingValueForId ( $a_role_id )

Parameters

$a_role_id

Returns: string

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

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

◆ getSecret()

ilOpenIdConnectSettings::getSecret ( )

Get secret.

Definition at line 230 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 ( )

Returns: int

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

                                         : int
    {
        return $this->session_duration;
    }

References $session_duration.

Referenced by save().

Here is the caller graph for this function:

◆ getUidField()

ilOpenIdConnectSettings::getUidField ( )

Returns: string

Definition at line 385 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 504 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 ( )

Returns: bool

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

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

References getLoginElementImage().

Here is the call graph for this function:

◆ isCustomSession()

ilOpenIdConnectSettings::isCustomSession ( )

Returns: bool

Definition at line 321 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 ( )

Returns: bool

Definition at line 345 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

Load from settings.

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

    {
        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, '');
        }
 
        $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([]))));
        $this->setLoginElementImage($this->storage->get('le_img', ''));
        $this->setLoginElementText($this->storage->get('le_text'));
        $this->setLoginElementType($this->storage->get('le_type'));
        $this->setLoginPromptType((int) $this->storage->get('prompt_type', self::LOGIN_ENFORCE));
        $this->setLogoutScope((int) $this->storage->get('logout_scope', self::LOGOUT_SCOPE_GLOBAL));
        $this->useCustomSession((bool) $this->storage->get('custom_session'), false);
        $this->setSessionDuration((int) $this->storage->get('session_duration', 60));
        $this->allowSync((bool) $this->storage->get('allow_sync'), false);
        $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([]))));
        $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(), 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 ( )

Save in settings.

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

    {
        $this->storage->set('active', (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', (string) serialize($this->getAdditionalScopes()));
        $this->storage->set('le_img', $this->getLoginElementImage());
        $this->storage->set('le_text', $this->getLoginElemenText());
        $this->storage->set('le_type', $this->getLoginElementType());
        $this->storage->set('prompt_type', $this->getLoginPromptType());
        $this->storage->set('logout_scope', $this->getLogoutScope());
        $this->storage->set('custom_session', (int) $this->isCustomSession());
        $this->storage->set('session_duration', (int) $this->getSessionDuration());
        $this->storage->set('allow_sync', (int) $this->isSyncAllowed());
        $this->storage->set('role', (int) $this->getRole());
        $this->storage->set('uid', (string) $this->getUidField());
 
        foreach ($this->getProfileMappingFields() as $field => $lang_key) {
            $this->storage->set('pmap_' . $field, $this->getProfileMappingFieldValue($field));
            $this->storage->set('pumap_' . $field, $this->getProfileMappingFieldUpdate($field));
        }
        $this->storage->set('role_mappings', (string) 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(), and isSyncAllowed().

Here is the call graph for this function:

◆ setActive()

ilOpenIdConnectSettings::setActive ( bool $active )

Parameters

bool $active

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

    {
        $this->active = $active;
    }

References $active.

Referenced by load().

Here is the caller graph for this function:

◆ setAdditionalScopes()

ilOpenIdConnectSettings::setAdditionalScopes ( array $additional_scopes )

Parameters

array $additional_scopes

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

    {
        $this->additional_scopes = $additional_scopes;
    }

References $additional_scopes.

Referenced by load().

Here is the caller graph for this function:

◆ setClientId()

ilOpenIdConnectSettings::setClientId ( string $client_id )

Parameters

string $client_id

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

    {
        $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 509 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 )

Parameters

string $a_img_name

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

    {
        $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 267 of file class.ilOpenIdConnectSettings.php.

    {
        $this->login_element_text = $text;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementType()

ilOpenIdConnectSettings::setLoginElementType ( int $type )

Set login element type.

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

    {
        $this->login_element_type = $type;
    }

References $type.

Referenced by load().

Here is the caller graph for this function:

◆ setLoginPromptType()

ilOpenIdConnectSettings::setLoginPromptType ( int $a_type )

Parameters

int $a_type

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

    {
        $this->login_prompt_type = $a_type;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setLogoutScope()

ilOpenIdConnectSettings::setLogoutScope ( int $a_scope )

Parameters

int $a_scope

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

    {
        $this->logout_scope = $a_scope;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setProfileMappingFieldUpdate()

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

Parameters

string	$field
bool	$value

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

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

◆ setProfileMappingFieldValue()

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

Parameters

string	$field
string	$value

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

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

◆ setProvider()

ilOpenIdConnectSettings::setProvider ( string $url )

Parameters

string $url

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

    {
        $this->provider = $url;
    }

References $url.

Referenced by load().

Here is the caller graph for this function:

◆ setRole()

ilOpenIdConnectSettings::setRole ( int $role )

Parameters

int $role

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

    {
        $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 $a_role_mappings

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

    {
        $this->role_mappings = $a_role_mappings;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setSecret()

ilOpenIdConnectSettings::setSecret ( string $secret )

Parameters

string $secret

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

    {
        $this->secret = $secret;
    }

References $secret.

Referenced by load().

Here is the caller graph for this function:

◆ setSessionDuration()

ilOpenIdConnectSettings::setSessionDuration ( int $a_duration )

Parameters

int $a_duration

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

    {
        $this->session_duration = $a_duration;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setUidField()

ilOpenIdConnectSettings::setUidField ( string $field )

Parameters

string $field

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

    {
        $this->uid = $field;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setValidateScopes()

ilOpenIdConnectSettings::setValidateScopes ( int $validation_mode )

Definition at line 499 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 )

Parameters

bool $a_stat

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

    {
        $this->custom_session = $a_stat;
    }

Referenced by load().

Here is the caller graph for this function:

◆ validateScopes()

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

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

    {
        $result = array();
        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) {
                $available_scopes = $response->scopes_supported;
                $decoded_response = json_decode($response, false, 512, JSON_THROW_ON_ERROR);
                $available_scopes = $decoded_response->scopes_supported;
                array_unshift($custom_scopes, self::DEFAULT_SCOPE);
 
                $result = array_diff($custom_scopes, $available_scopes);
                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, $response];
            }
        } catch (ilCurlConnectionException $e) {
            throw $e;
        } finally {
            $curl->close();
        }
        return $result;
    }

References Vendor\Package\$e, $response, $result, VALIDATION_ISSUE_DISCOVERY_ERROR, and VALIDATION_ISSUE_INVALID_SCOPE.

Field Documentation

◆ $active

ilOpenIdConnectSettings::$active = false

private

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

Referenced by getActive(), and setActive().

◆ $additional_scopes

ilOpenIdConnectSettings::$additional_scopes = []

private

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

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

◆ $allow_sync

ilOpenIdConnectSettings::$allow_sync

private

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

Referenced by isSyncAllowed().

◆ $client_id

ilOpenIdConnectSettings::$client_id = ''

private

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

Referenced by getClientId(), and setClientId().

◆ $custom_discovery_url

ilOpenIdConnectSettings::$custom_discovery_url = null

private

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

Referenced by getCustomDiscoveryUrl().

◆ $custom_session

ilOpenIdConnectSettings::$custom_session = false

private

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

Referenced by isCustomSession().

◆ $filesystem

ilOpenIdConnectSettings::$filesystem = null

private

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

◆ $instance

ilOpenIdConnectSettings::$instance = null

staticprivate

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

Referenced by getInstance().

◆ $login_element_img_name

ilOpenIdConnectSettings::$login_element_img_name

private

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

Referenced by getLoginElementImage().

◆ $login_element_text

ilOpenIdConnectSettings::$login_element_text

private

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

Referenced by getLoginElemenText().

◆ $login_element_type

ilOpenIdConnectSettings::$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

private

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

Referenced by getLoginElementType().

◆ $login_prompt_type

ilOpenIdConnectSettings::$login_prompt_type = self::LOGIN_ENFORCE

private

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

Referenced by getLoginPromptType().

◆ $logout_scope

ilOpenIdConnectSettings::$logout_scope

private

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

Referenced by getLogoutScope().

◆ $profile_map

ilOpenIdConnectSettings::$profile_map = []

private

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

◆ $profile_update_map

ilOpenIdConnectSettings::$profile_update_map = []

private

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

◆ $provider

ilOpenIdConnectSettings::$provider = ''

private

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

Referenced by getProvider().

◆ $role

ilOpenIdConnectSettings::$role

private

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

Referenced by getRole(), and setRole().

◆ $role_mappings

ilOpenIdConnectSettings::$role_mappings = []

private

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

Referenced by getRoleMappings().

◆ $secret

ilOpenIdConnectSettings::$secret = ''

private

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

Referenced by getSecret(), and setSecret().

◆ $session_duration

ilOpenIdConnectSettings::$session_duration = 60

private

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

Referenced by getSessionDuration().

◆ $storage

ilOpenIdConnectSettings::$storage = null

private

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

◆ $uid

ilOpenIdConnectSettings::$uid = ''

private

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

Referenced by getUidField().

◆ $validate_scopes

ilOpenIdConnectSettings::$validate_scopes = self::URL_VALIDATION_PROVIDER

private

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

Referenced by getValidateScopes().

◆ DEFAULT_SCOPE

const ilOpenIdConnectSettings::DEFAULT_SCOPE = 'openid'

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ FILE_STORAGE

const ilOpenIdConnectSettings::FILE_STORAGE = 'openidconnect/login_form_image'

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

Referenced by ilOpenIdConnectSettingsGUI\saveImageFromHttpRequest().

◆ LOGIN_ELEMENT_TYPE_IMG

const ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_IMG = 1

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilStartUpGUI\showOpenIdConnectLoginForm().

◆ LOGIN_ELEMENT_TYPE_TXT

const ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_TXT = 0

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilStartUpGUI\showOpenIdConnectLoginForm().

◆ LOGIN_ENFORCE

const ilOpenIdConnectSettings::LOGIN_ENFORCE = 0

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

Referenced by ilAuthProviderOpenIdConnect\doAuthentication(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGIN_STANDARD

const ilOpenIdConnectSettings::LOGIN_STANDARD = 1

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGOUT_SCOPE_GLOBAL

const ilOpenIdConnectSettings::LOGOUT_SCOPE_GLOBAL = 0

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

Referenced by ilAuthProviderOpenIdConnect\doAuthentication(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGOUT_SCOPE_LOCAL

const ilOpenIdConnectSettings::LOGOUT_SCOPE_LOCAL = 1

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

Referenced by ilAuthProviderOpenIdConnect\handleLogout(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ STORAGE_ID

const ilOpenIdConnectSettings::STORAGE_ID = 'oidc'

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

◆ URL_VALIDATION_CUSTOM

const ilOpenIdConnectSettings::URL_VALIDATION_CUSTOM = 1

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilOpenIdConnectSettingsGUI\saveSettings().

◆ URL_VALIDATION_NONE

const ilOpenIdConnectSettings::URL_VALIDATION_NONE = 2

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ URL_VALIDATION_PROVIDER

const ilOpenIdConnectSettings::URL_VALIDATION_PROVIDER = 0

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilOpenIdConnectSettingsGUI\saveSettings().

◆ VALIDATION_ISSUE_DISCOVERY_ERROR

const ilOpenIdConnectSettings::VALIDATION_ISSUE_DISCOVERY_ERROR = 1

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

Referenced by validateScopes().

◆ VALIDATION_ISSUE_INVALID_SCOPE

const ilOpenIdConnectSettings::VALIDATION_ISSUE_INVALID_SCOPE = 0

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

Referenced by ilOpenIdConnectSettingsGUI\saveSettings(), and validateScopes().

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

Services/OpenIdConnect/classes/class.ilOpenIdConnectSettings.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowSync()

◆ deleteImageFile()

◆ getActive()

◆ getAdditionalScopes()

◆ getAllScopes()

◆ getClientId()

◆ getCustomDiscoveryUrl()

◆ getImageFilePath()

◆ getInstance()

◆ getLoginElemenText()

◆ getLoginElementImage()

◆ getLoginElementType()

◆ getLoginPromptType()

◆ getLogoutScope()

◆ getProfileMappingFields()

◆ getProfileMappingFieldUpdate()

◆ getProfileMappingFieldValue()

◆ getProvider()

◆ getRole()

◆ getRoleMappings()

◆ getRoleMappingUpdateForId()

◆ getRoleMappingValueForId()

◆ getSecret()

◆ getSessionDuration()

◆ getUidField()

◆ getValidateScopes()

◆ hasImageFile()

◆ isCustomSession()

◆ isSyncAllowed()

◆ load()

◆ save()

◆ setActive()

◆ setAdditionalScopes()

◆ setClientId()

◆ setCustomDiscoveryUrl()

◆ setLoginElementImage()

◆ setLoginElementText()

◆ setLoginElementType()

◆ setLoginPromptType()

◆ setLogoutScope()

◆ setProfileMappingFieldUpdate()

◆ setProfileMappingFieldValue()

◆ setProvider()

◆ setRole()

◆ setRoleMappings()

◆ setSecret()

◆ setSessionDuration()

◆ setUidField()

◆ setValidateScopes()

◆ useCustomSession()

◆ validateScopes()

Field Documentation

◆ $active

◆ $additional_scopes

◆ $allow_sync

◆ $client_id

◆ $custom_discovery_url

◆ $custom_session

◆ $filesystem

◆ $instance

◆ $login_element_img_name

◆ $login_element_text

◆ $login_element_type

◆ $login_prompt_type

◆ $logout_scope

◆ $profile_map

◆ $profile_update_map

◆ $provider

◆ $role