ilSamlIdp Class Reference

Class ilSamlIdp. More...

Collaboration diagram for ilSamlIdp:

Public Member Functions
	__construct (int $a_idp_id=0)
	persist ()
	delete ()
	Deletes an idp with all relvant 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 ($entityId)
static	getActiveIdpList ()
static	getAllIdps ()
static	getAuthModeByKey (string $a_auth_key)
static	getKeyByAuthMode (string $a_auth_mode)

Protected Attributes
	$db
	$idp_id
	$is_active = false
	$allow_local_auth = false
	$default_role_id = 0
	$uid_claim = ''
	$login_claim = ''
	$sync_status = false
	$entity_id = ''
	$account_migration_status = false

Static Protected Attributes
static	$idp_as_data = []

Private Member Functions
	read ()

Static Private Attributes
static	$instances = []

Detailed Description

Class ilSamlIdp.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilSamlIdp::__construct

(

int

$a_idp_id = 0

)

Parameters

int

$a_idp_id

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

References $GLOBALS, and read().

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

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

Here is the call graph for this function:

Member Function Documentation

allowLocalAuthentication()

ilSamlIdp::allowLocalAuthentication

(

)

Returns

bool

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

References $allow_local_auth.

Referenced by persist(), and toArray().

                                               : bool
    {
        return $this->allow_local_auth;
    }

Here is the caller graph for this function:

bindDbRecord()

ilSamlIdp::bindDbRecord

(

array

$record

)

Parameters

array

$record

Definition at line 158 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['idp_id']);
        $this->setActive((bool) $record['is_active']);
        $this->setDefaultRoleId((int) $record['default_role_id']);
        $this->setUidClaim((string) $record['uid_claim']);
        $this->setLoginClaim((string) $record['login_claim']);
        $this->setSynchronizationStatus((bool) $record['sync_status']);
        $this->setAccountMigrationStatus((bool) $record['account_migr_status']);
        $this->setLocalLocalAuthenticationStatus((bool) $record['allow_local_auth']);
        $this->setEntityId((string) $record['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 relvant mapping rules.

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

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

References AUTH_SAML, and getIdpId().

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

        $this->db->manipulateF(
            'UPDATE usr_data SET auth_mode = %s WHERE auth_mode = %s',
            array('text', 'text'),
            array('default', AUTH_SAML . '_' . $this->getIdpId())
        );

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

Here is the call graph for this function:

geIdpIdByEntityId()

static ilSamlIdp::geIdpIdByEntityId (   $entityId )

static

Parameters

string

$entityId

Returns

int

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

References $entityId.

Referenced by ilStartUpGUI\doSamlAuthentication().

    {
        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 241 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 257 of file class.ilSamlIdp.php.

References $DIC, and $res.

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

                                        : 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

Parameters

string

$a_auth_key

Returns

string

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

Referenced by ilAuthUtils\_getAuthModeName().

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

        return 'saml';
    }

Here is the caller graph for this function:

getDefaultRoleId()

ilSamlIdp::getDefaultRoleId

(

)

Returns

int

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

References $default_role_id.

Referenced by persist(), and toArray().

                                       : int
    {
        return $this->default_role_id;
    }

Here is the caller graph for this function:

getEntityId()

ilSamlIdp::getEntityId

(

)

Returns

string

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

References $entity_id.

Referenced by persist(), and toArray().

                                  : string
    {
        return $this->entity_id;
    }

Here is the caller graph for this function:

getFirstActiveIdp()

static ilSamlIdp::getFirstActiveIdp ( )

static

Returns

self

Exceptions

ilSamlException

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

Referenced by ilAuthProviderSaml\__construct().

                                               : self
    {
        $idps = self::getActiveIdpList();
        if (count($idps) > 0) {
            return current($idps);
        }

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

Here is the caller graph for this function:

getIdpId()

ilSamlIdp::getIdpId

(

)

Returns

int

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

References $idp_id.

Referenced by delete(), persist(), ilSamlSettingsGUI\populateWithMetadata(), read(), ilSamlSettingsGUI\storeMetadata(), and toArray().

                               : int
    {
        return $this->idp_id;
    }

Here is the caller graph for this function:

getIdpIdByAuthMode()

static ilSamlIdp::getIdpIdByAuthMode ( string  $a_auth_mode )

static

Parameters

string

$a_auth_mode

Returns

null|int

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

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

                                                                   : ?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

Parameters

int

$a_idp_id

Returns

self

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

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

                                                             : 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

Parameters

string

$a_auth_mode

Returns

string

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

References AUTH_SAML.

Referenced by ilAuthUtils\_getAuthMode().

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

        return (string) AUTH_SAML;
    }

Here is the caller graph for this function:

getLoginClaim()

ilSamlIdp::getLoginClaim

(

)

Returns

string

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

References $login_claim.

Referenced by persist(), and toArray().

                                    : string
    {
        return $this->login_claim;
    }

Here is the caller graph for this function:

getUidClaim()

ilSamlIdp::getUidClaim

(

)

Returns

string

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

References $uid_claim.

Referenced by persist(), and toArray().

                                  : string
    {
        return $this->uid_claim;
    }

Here is the caller graph for this function:

isAccountMigrationEnabled()

ilSamlIdp::isAccountMigrationEnabled

(

)

Returns

bool

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

References $account_migration_status.

Referenced by persist(), and toArray().

                                                : bool
    {
        return $this->account_migration_status;
    }

Here is the caller graph for this function:

isActive()

ilSamlIdp::isActive

(

)

Returns

bool

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

References $is_active.

Referenced by persist(), and toArray().

                               : bool
    {
        return $this->is_active;
    }

Here is the caller graph for this function:

isAuthModeSaml()

static ilSamlIdp::isAuthModeSaml ( string  $a_auth_mode )

static

Parameters

string

$a_auth_mode

Returns

bool

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

References $GLOBALS, and AUTH_SAML.

Referenced by ilObjAuthSettingsGUI\authSettingsObject().

                                                               : bool
    {
        if (!$a_auth_mode) {
            $GLOBALS['DIC']->logger()->auth()->write(__METHOD__ . ': No auth mode given..............');
            return false;
        }

        $auth_arr = explode('_', $a_auth_mode);
        return (
            count($auth_arr) === 2 &&
            (int) $auth_arr[0] === (int) AUTH_SAML &&
            strlen($auth_arr[1]) > 0
        );
    }

Here is the caller graph for this function:

isSynchronizationEnabled()

ilSamlIdp::isSynchronizationEnabled

(

)

Returns

bool

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

References $sync_status.

Referenced by persist(), and toArray().

                                               : bool
    {
        return $this->sync_status;
    }

Here is the caller graph for this function:

persist()

ilSamlIdp::persist

(

)

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

References allowLocalAuthentication(), getDefaultRoleId(), getEntityId(), getIdpId(), getLoginClaim(), getUidClaim(), isAccountMigrationEnabled(), isActive(), isSynchronizationEnabled(), and setIdpId().

                              : void
    {
        if (!$this->getIdpId()) {
            $this->setIdpId((int) $this->db->nextId('saml_idp_settings'));
        }

        $this->db->replace(
            'saml_idp_settings',
            [
                'idp_id' => ['integer', $this->getIdpId()]
            ],
            [
                'is_active' => ['integer', (int) $this->isActive()],
                'default_role_id' => ['integer', $this->getDefaultRoleId()],
                'uid_claim' => ['text', $this->getUidClaim()],
                'login_claim' => ['text', $this->getLoginClaim()],
                'entity_id' => ['text', $this->getEntityId()],
                'sync_status' => ['integer', (int) $this->isSynchronizationEnabled()],
                'allow_local_auth' => ['integer', (int) $this->allowLocalAuthentication()],
                'account_migr_status' => ['integer', (int) $this->isAccountMigrationEnabled()]
            ]
        );
    }

Here is the call graph for this function:

read()

ilSamlIdp::read ( )

private

Exceptions

ilException

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

References $query, $res, bindDbRecord(), and getIdpId().

Referenced by __construct().

                            : void
    {
        $query = 'SELECT * FROM saml_idp_settings WHERE idp_id = ' . $this->db->quote($this->getIdpId(), '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

)

Parameters

bool

$status

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

)

Parameters

bool

$is_active

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

)

Parameters

int

$role_id

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

)

Parameters

string

$entity_id

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

)

Parameters

int

$idp_id

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

References $idp_id.

Referenced by bindDbRecord(), and persist().

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

Here is the caller graph for this function:

setLocalLocalAuthenticationStatus()

ilSamlIdp::setLocalLocalAuthenticationStatus

(

bool

$status

)

Parameters

$status

boolean

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

)

Parameters

$claim

string

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

)

Parameters

bool

$sync

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

)

Parameters

$claim

string

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

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

References allowLocalAuthentication(), getDefaultRoleId(), getEntityId(), getIdpId(), getLoginClaim(), getUidClaim(), isAccountMigrationEnabled(), isActive(), and isSynchronizationEnabled().

                              : array
    {
        return [
            'idp_id' => $this->getIdpId(),
            'is_active' => $this->isActive(),
            'default_role_id' => $this->getDefaultRoleId(),
            'uid_claim' => $this->getUidClaim(),
            'login_claim' => $this->getLoginClaim(),
            'sync_status' => $this->isSynchronizationEnabled(),
            'account_migr_status' => $this->isAccountMigrationEnabled(),
            'allow_local_auth' => $this->allowLocalAuthentication(),
            'entity_id' => $this->getEntityId()
        ];
    }

Here is the call graph for this function:

Field Documentation

$account_migration_status

ilSamlIdp::$account_migration_status = false

protected

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

Referenced by isAccountMigrationEnabled().

$allow_local_auth

ilSamlIdp::$allow_local_auth = false

protected

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

Referenced by allowLocalAuthentication().

$db

ilSamlIdp::$db

protected

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

$default_role_id

ilSamlIdp::$default_role_id = 0

protected

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

Referenced by getDefaultRoleId().

$entity_id

ilSamlIdp::$entity_id = ''

protected

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

Referenced by getEntityId(), and setEntityId().

$idp_as_data

ilSamlIdp::$idp_as_data = []

staticprotected

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

$idp_id

ilSamlIdp::$idp_id

protected

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

Referenced by getIdpId(), and setIdpId().

$instances

ilSamlIdp::$instances = []

staticprivate

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

$is_active

ilSamlIdp::$is_active = false

protected

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

Referenced by isActive(), and setActive().

$login_claim

ilSamlIdp::$login_claim = ''

protected

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

Referenced by getLoginClaim().

$sync_status

ilSamlIdp::$sync_status = false

protected

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

Referenced by isSynchronizationEnabled().

$uid_claim

ilSamlIdp::$uid_claim = ''

protected

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

Referenced by getUidClaim().

---

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

• Services/Saml/classes/class.ilSamlIdp.php