ilSamlIdp Class Reference

Class ilSamlIdp. More...

Collaboration diagram for ilSamlIdp:

Public Member Functions
	__construct (protected int $idp_id=0)
	persist ()
	delete ()
	Deletes an idp with all relevant mapping rules. More...
	toArray ()
	bindDbRecord (array $record)
	getEntityId ()
	setEntityId (string $entity_id)
	isActive ()
	setActive (bool $is_active)
	getIdpId ()
	setIdpId (int $idp_id)
	allowLocalAuthentication ()
	setLocalLocalAuthenticationStatus (bool $status)
	getDefaultRoleId ()
	setDefaultRoleId (int $role_id)
	setUidClaim (string $claim)
	getUidClaim ()
	setLoginClaim (string $claim)
	getLoginClaim ()
	isSynchronizationEnabled ()
	setSynchronizationStatus (bool $sync)
	isAccountMigrationEnabled ()
	setAccountMigrationStatus (bool $status)

Static Public Member Functions
static	getFirstActiveIdp ()
static	getInstanceByIdpId (int $a_idp_id)
static	isAuthModeSaml (string $a_auth_mode)
static	getIdpIdByAuthMode (string $a_auth_mode)
static	geIdpIdByEntityId (string $entityId)
static	getActiveIdpList ()
static	getAllIdps ()
static	getAuthModeByKey (string $a_auth_key)
static	getKeyByAuthMode (string $a_auth_mode)

Private Member Functions
	read ()

Private Attributes
const	PROP_IDP_ID = 'idp_id'
const	PROP_IS_ACTIVE = 'is_active'
const	PROP_DEFAULT_ROLE_ID = 'default_role_id'
const	PROP_UID_CLAIM = 'uid_claim'
const	PROP_LOGIN_CLAIM = 'login_claim'
const	PROP_ENTITY_ID = 'entity_id'
const	PROP_SYNC_STATUS = 'sync_status'
const	PROP_ALLOW_LOCAL_AUTH = 'allow_local_auth'
const	PROP_ACCOUNT_MIGR_STATUS = 'account_migr_status'
readonly ilDBInterface	$db
bool	$is_active = false
bool	$allow_local_auth = false
int	$default_role_id = 0
string	$uid_claim = ''
string	$login_claim = ''
bool	$sync_status = false
string	$entity_id = ''
bool	$account_migration_status = false

Static Private Attributes
static array	$instances = []

Detailed Description

Class ilSamlIdp.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilSamlIdp.php.

Constructor & Destructor Documentation

__construct()

ilSamlIdp::__construct

(

protected int

$idp_id = 0

)

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

References $GLOBALS, and read().

    {
        $this->db = $GLOBALS['DIC']->database();

        if ($this->idp_id > 0) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

allowLocalAuthentication()

ilSamlIdp::allowLocalAuthentication

(

)

Definition at line 302 of file class.ilSamlIdp.php.

References $allow_local_auth.

                                              : bool
    {
        return $this->allow_local_auth;
    }

bindDbRecord()

ilSamlIdp::bindDbRecord

(

array

$record

)

Parameters

array<string,mixed>

$record

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

References ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), setAccountMigrationStatus(), setActive(), setDefaultRoleId(), setEntityId(), setIdpId(), setLocalLocalAuthenticationStatus(), setLoginClaim(), setSynchronizationStatus(), and setUidClaim().

Referenced by read().

                                               : void
    {
        $this->setIdpId((int) $record[self::PROP_IDP_ID]);
        $this->setActive((bool) $record[self::PROP_IS_ACTIVE]);
        $this->setDefaultRoleId((int) $record[self::PROP_DEFAULT_ROLE_ID]);
        $this->setUidClaim((string) $record[self::PROP_UID_CLAIM]);
        $this->setLoginClaim((string) $record[self::PROP_LOGIN_CLAIM]);
        $this->setSynchronizationStatus((bool) $record[self::PROP_SYNC_STATUS]);
        $this->setAccountMigrationStatus((bool) $record[self::PROP_ACCOUNT_MIGR_STATUS]);
        $this->setLocalLocalAuthenticationStatus((bool) $record[self::PROP_ALLOW_LOCAL_AUTH]);
        $this->setEntityId((string) $record[self::PROP_ENTITY_ID]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilSamlIdp::delete

(

)

Deletes an idp with all relevant mapping rules.

Furthermore, the auth_mode of the relevant user accounts will be switched to 'default'

Definition at line 117 of file class.ilSamlIdp.php.

References ilAuthUtils\AUTH_SAML, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                            : void
    {
        $mapping = new ilExternalAuthUserAttributeMapping('saml', $this->idp_id);
        $mapping->delete();

        $this->db->manipulateF(
            'UPDATE usr_data SET auth_mode = %s WHERE auth_mode = %s',
            [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
            ['default', ilAuthUtils::AUTH_SAML . '_' . $this->idp_id]
        );

        $this->db->manipulate('DELETE FROM saml_idp_settings WHERE idp_id = ' . $this->db->quote(
            $this->idp_id,
            ilDBConstants::T_INTEGER
        ));
    }

geIdpIdByEntityId()

static ilSamlIdp::geIdpIdByEntityId ( string  $entityId )

static

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

Referenced by ilStartUpGUI\doSamlAuthentication().

                                                              : int
    {
        foreach (self::getAllIdps() as $idp) {
            if ($idp->isActive() && $idp->getEntityId() === $entityId) {
                return $idp->getIdpId();
            }
        }

        return 0;
    }

Here is the caller graph for this function:

getActiveIdpList()

static ilSamlIdp::getActiveIdpList ( )

static

Returns

self[]

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

Referenced by ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_isExternalAccountEnabled(), ilStartUpGUI\doSamlAuthentication(), ilUserImportParser\importBeginTag(), ilStartUpGUI\showSamlLoginForm(), and ilUserImportParser\verifyBeginTag().

                                             : array
    {
        $idps = [];
        foreach (self::getAllIdps() as $idp) {
            if ($idp->isActive()) {
                $idps[] = $idp;
            }
        }

        return $idps;
    }

Here is the caller graph for this function:

getAllIdps()

static ilSamlIdp::getAllIdps ( )

static

Returns

self[]

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

References $DIC, and $res.

Referenced by ilSamlIdpTableGUI\__construct(), and ilAuthUtils\_getAllAuthModes().

                                       : array
    {
        global $DIC;

        $res = $DIC->database()->query('SELECT * FROM saml_idp_settings');

        $idps = [];
        while ($row = $DIC->database()->fetchAssoc($res)) {
            $idp = new self();
            $idp->bindDbRecord($row);

            $idps[] = $idp;
        }

        return $idps;
    }

Here is the caller graph for this function:

getAuthModeByKey()

static ilSamlIdp::getAuthModeByKey ( string  $a_auth_key )

static

Definition at line 252 of file class.ilSamlIdp.php.

Referenced by ilAuthUtils\_getAuthModeName().

                                                               : string
    {
        $auth_arr = explode('_', $a_auth_key);
        if (count($auth_arr) > 1) {
            return 'saml_' . $auth_arr[1];
        }

        return 'saml';
    }

Here is the caller graph for this function:

getDefaultRoleId()

ilSamlIdp::getDefaultRoleId

(

)

Definition at line 312 of file class.ilSamlIdp.php.

References $default_role_id.

                                      : int
    {
        return $this->default_role_id;
    }

getEntityId()

ilSamlIdp::getEntityId

(

)

Definition at line 272 of file class.ilSamlIdp.php.

References $entity_id.

Referenced by ilSamlIdpTableGUI\getRecords().

                                 : string
    {
        return $this->entity_id;
    }

Here is the caller graph for this function:

getFirstActiveIdp()

static ilSamlIdp::getFirstActiveIdp ( )

static

Definition at line 58 of file class.ilSamlIdp.php.

Referenced by ilAuthProviderSaml\__construct().

                                              : self
    {
        $idps = self::getActiveIdpList();
        if ($idps !== []) {
            return current($idps);
        }

        throw new ilSamlException('No active SAML IDP found');
    }

Here is the caller graph for this function:

getIdpId()

ilSamlIdp::getIdpId

(

)

Definition at line 292 of file class.ilSamlIdp.php.

Referenced by ilSamlSettingsGUI\populateWithMetadata(), ilSamlSettingsGUI\saveNewIdp(), and ilSamlSettingsGUI\storeMetadata().

                              : int
    {
        return $this->idp_id;
    }

Here is the caller graph for this function:

getIdpIdByAuthMode()

static ilSamlIdp::getIdpIdByAuthMode ( string  $a_auth_mode )

static

Definition at line 196 of file class.ilSamlIdp.php.

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilAuthUtils\getAuthModeTranslation(), ilAuthProviderFactory\getProviderByAuthMode(), and ilAuthUtils\isLocalPasswordEnabledForAuthMode().

                                                                  : ?int
    {
        if (self::isAuthModeSaml($a_auth_mode)) {
            $auth_arr = explode('_', $a_auth_mode);
            return (int) $auth_arr[1];
        }

        return null;
    }

Here is the caller graph for this function:

getInstanceByIdpId()

static ilSamlIdp::getInstanceByIdpId ( int  $a_idp_id )

static

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

Referenced by ilAuthProviderSaml\__construct(), ilObjAuthSettingsGUI\authSettingsObject(), ilAuthUtils\getAuthModeTranslation(), ilSamlSettingsGUI\initIdp(), and ilAuthUtils\isLocalPasswordEnabledForAuthMode().

                                                            : self
    {
        if (!isset(self::$instances[$a_idp_id]) || !(self::$instances[$a_idp_id] instanceof self)) {
            self::$instances[$a_idp_id] = new self($a_idp_id);
        }

        return self::$instances[$a_idp_id];
    }

Here is the caller graph for this function:

getKeyByAuthMode()

static ilSamlIdp::getKeyByAuthMode ( string  $a_auth_mode )

static

Definition at line 262 of file class.ilSamlIdp.php.

References ilAuthUtils\AUTH_SAML.

Referenced by ilAuthUtils\_getAuthMode().

                                                                : string
    {
        $auth_arr = explode('_', $a_auth_mode);
        if (count($auth_arr) > 1) {
            return ilAuthUtils::AUTH_SAML . '_' . $auth_arr[1];
        }

        return (string) ilAuthUtils::AUTH_SAML;
    }

Here is the caller graph for this function:

getLoginClaim()

ilSamlIdp::getLoginClaim

(

)

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

References $login_claim.

                                   : string
    {
        return $this->login_claim;
    }

getUidClaim()

ilSamlIdp::getUidClaim

(

)

Definition at line 327 of file class.ilSamlIdp.php.

References $uid_claim.

                                 : string
    {
        return $this->uid_claim;
    }

isAccountMigrationEnabled()

ilSamlIdp::isAccountMigrationEnabled

(

)

Definition at line 352 of file class.ilSamlIdp.php.

References $account_migration_status.

                                               : bool
    {
        return $this->account_migration_status;
    }

isActive()

ilSamlIdp::isActive

(

)

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

References $is_active.

Referenced by ilSamlIdpTableGUI\getRecords().

                              : bool
    {
        return $this->is_active;
    }

Here is the caller graph for this function:

isAuthModeSaml()

static ilSamlIdp::isAuthModeSaml ( string  $a_auth_mode )

static

Definition at line 182 of file class.ilSamlIdp.php.

References ilAuthUtils\AUTH_SAML.

Referenced by ilObjAuthSettingsGUI\authSettingsObject().

                                                              : bool
    {
        if ('' === $a_auth_mode) {
            return false;
        }

        $auth_arr = explode('_', $a_auth_mode);
        return (
            count($auth_arr) === 2 &&
            (int) $auth_arr[0] === ilAuthUtils::AUTH_SAML &&
            is_string($auth_arr[1]) && $auth_arr[1] !== ''
        );
    }

Here is the caller graph for this function:

isSynchronizationEnabled()

ilSamlIdp::isSynchronizationEnabled

(

)

Definition at line 342 of file class.ilSamlIdp.php.

References $sync_status.

                                              : bool
    {
        return $this->sync_status;
    }

persist()

ilSamlIdp::persist

(

)

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

References setIdpId(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ilSamlSettingsGUI\saveNewIdp().

                             : void
    {
        if ($this->idp_id === 0) {
            $this->setIdpId($this->db->nextId('saml_idp_settings'));
        }

        $this->db->replace(
            'saml_idp_settings',
            [
                self::PROP_IDP_ID => [ilDBConstants::T_INTEGER, $this->idp_id]
            ],
            [
                self::PROP_IS_ACTIVE => [ilDBConstants::T_INTEGER, (int) $this->is_active],
                self::PROP_DEFAULT_ROLE_ID => [ilDBConstants::T_INTEGER, $this->default_role_id],
                self::PROP_UID_CLAIM => [ilDBConstants::T_TEXT, $this->uid_claim],
                self::PROP_LOGIN_CLAIM => [ilDBConstants::T_TEXT, $this->login_claim],
                self::PROP_ENTITY_ID => [ilDBConstants::T_TEXT, $this->entity_id],
                self::PROP_SYNC_STATUS => [ilDBConstants::T_INTEGER, (int) $this->sync_status],
                self::PROP_ALLOW_LOCAL_AUTH => [ilDBConstants::T_INTEGER, (int) $this->allow_local_auth],
                self::PROP_ACCOUNT_MIGR_STATUS => [ilDBConstants::T_INTEGER, (int) $this->account_migration_status]
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilSamlIdp::read ( )

private

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

References $res, bindDbRecord(), and ilDBConstants\T_INTEGER.

Referenced by __construct().

                           : void
    {
        $query = 'SELECT * FROM saml_idp_settings WHERE idp_id = ' . $this->db->quote($this->idp_id, ilDBConstants::T_INTEGER);
        $res = $this->db->query($query);
        while ($record = $this->db->fetchAssoc($res)) {
            $this->bindDbRecord($record);
            return;
        }

        throw new ilException('Could not find idp');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAccountMigrationStatus()

ilSamlIdp::setAccountMigrationStatus

(

bool

$status

)

Definition at line 357 of file class.ilSamlIdp.php.

Referenced by bindDbRecord().

                                                           : void
    {
        $this->account_migration_status = $status;
    }

Here is the caller graph for this function:

setActive()

ilSamlIdp::setActive

(

bool

$is_active

)

Definition at line 287 of file class.ilSamlIdp.php.

References $is_active.

Referenced by bindDbRecord().

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

Here is the caller graph for this function:

setDefaultRoleId()

ilSamlIdp::setDefaultRoleId

(

int

$role_id

)

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

Referenced by bindDbRecord().

                                                  : void
    {
        $this->default_role_id = $role_id;
    }

Here is the caller graph for this function:

setEntityId()

ilSamlIdp::setEntityId

(

string

$entity_id

)

Definition at line 277 of file class.ilSamlIdp.php.

References $entity_id.

Referenced by bindDbRecord().

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

Here is the caller graph for this function:

setIdpId()

ilSamlIdp::setIdpId

(

int

$idp_id

)

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

Referenced by bindDbRecord(), and persist().

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

Here is the caller graph for this function:

setLocalLocalAuthenticationStatus()

ilSamlIdp::setLocalLocalAuthenticationStatus

(

bool

$status

)

Definition at line 307 of file class.ilSamlIdp.php.

Referenced by bindDbRecord().

                                                                   : void
    {
        $this->allow_local_auth = $status;
    }

Here is the caller graph for this function:

setLoginClaim()

ilSamlIdp::setLoginClaim

(

string

$claim

)

Definition at line 332 of file class.ilSamlIdp.php.

Referenced by bindDbRecord().

                                                : void
    {
        $this->login_claim = $claim;
    }

Here is the caller graph for this function:

setSynchronizationStatus()

ilSamlIdp::setSynchronizationStatus

(

bool

$sync

)

Definition at line 347 of file class.ilSamlIdp.php.

Referenced by bindDbRecord().

                                                        : void
    {
        $this->sync_status = $sync;
    }

Here is the caller graph for this function:

setUidClaim()

ilSamlIdp::setUidClaim

(

string

$claim

)

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

Referenced by bindDbRecord().

                                              : void
    {
        $this->uid_claim = $claim;
    }

Here is the caller graph for this function:

toArray()

ilSamlIdp::toArray

(

)

Returns

array{idp_id: int, is_active: bool, default_role_id: int, uid_claim: string, login_claim: string, sync_status: bool, account_migr_status: bool, allow_local_auth: bool, entity_id: string}

Definition at line 137 of file class.ilSamlIdp.php.

References $account_migration_status, $allow_local_auth, $default_role_id, $entity_id, $is_active, $login_claim, $sync_status, and $uid_claim.

                             : array
    {
        return [
            self::PROP_IDP_ID => $this->idp_id,
            self::PROP_IS_ACTIVE => $this->is_active,
            self::PROP_DEFAULT_ROLE_ID => $this->default_role_id,
            self::PROP_UID_CLAIM => $this->uid_claim,
            self::PROP_LOGIN_CLAIM => $this->login_claim,
            self::PROP_SYNC_STATUS => $this->sync_status,
            self::PROP_ACCOUNT_MIGR_STATUS => $this->account_migration_status,
            self::PROP_ALLOW_LOCAL_AUTH => $this->allow_local_auth,
            self::PROP_ENTITY_ID => $this->entity_id
        ];
    }

Field Documentation

$account_migration_status

bool ilSamlIdp::$account_migration_status = false

private

Definition at line 47 of file class.ilSamlIdp.php.

Referenced by isAccountMigrationEnabled(), and toArray().

$allow_local_auth

bool ilSamlIdp::$allow_local_auth = false

private

Definition at line 41 of file class.ilSamlIdp.php.

Referenced by allowLocalAuthentication(), and toArray().

$db

readonly ilDBInterface ilSamlIdp::$db

private

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

$default_role_id

int ilSamlIdp::$default_role_id = 0

private

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

Referenced by getDefaultRoleId(), and toArray().

$entity_id

string ilSamlIdp::$entity_id = ''

private

Definition at line 46 of file class.ilSamlIdp.php.

Referenced by getEntityId(), setEntityId(), and toArray().

$instances

array ilSamlIdp::$instances = []

staticprivate

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

$is_active

bool ilSamlIdp::$is_active = false

private

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

Referenced by isActive(), setActive(), and toArray().

$login_claim

string ilSamlIdp::$login_claim = ''

private

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

Referenced by getLoginClaim(), and toArray().

$sync_status

bool ilSamlIdp::$sync_status = false

private

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

Referenced by isSynchronizationEnabled(), and toArray().

$uid_claim

string ilSamlIdp::$uid_claim = ''

private

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

Referenced by getUidClaim(), and toArray().

PROP_ACCOUNT_MIGR_STATUS

const ilSamlIdp::PROP_ACCOUNT_MIGR_STATUS = 'account_migr_status'

private

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

PROP_ALLOW_LOCAL_AUTH

const ilSamlIdp::PROP_ALLOW_LOCAL_AUTH = 'allow_local_auth'

private

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

PROP_DEFAULT_ROLE_ID

const ilSamlIdp::PROP_DEFAULT_ROLE_ID = 'default_role_id'

private

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

PROP_ENTITY_ID

const ilSamlIdp::PROP_ENTITY_ID = 'entity_id'

private

Definition at line 32 of file class.ilSamlIdp.php.

PROP_IDP_ID

const ilSamlIdp::PROP_IDP_ID = 'idp_id'

private

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

PROP_IS_ACTIVE

const ilSamlIdp::PROP_IS_ACTIVE = 'is_active'

private

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

PROP_LOGIN_CLAIM

const ilSamlIdp::PROP_LOGIN_CLAIM = 'login_claim'

private

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

PROP_SYNC_STATUS

const ilSamlIdp::PROP_SYNC_STATUS = 'sync_status'

private

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

PROP_UID_CLAIM

const ilSamlIdp::PROP_UID_CLAIM = 'uid_claim'

private

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

---

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

• components/ILIAS/Saml/classes/class.ilSamlIdp.php