ilSamlIdp Class Reference

Class ilSamlIdp. More...

Collaboration diagram for ilSamlIdp:

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

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

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

Static Protected Attributes
static	$idp_as_data = array()

Private Member Functions
	read ()

Static Private Attributes
static	$instances = array()

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

(

$a_idp_id = 0

)

Parameters

int

$a_idp_id

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

boolean

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

References $allow_local_auth.

Referenced by persist(), and toArray().

    {
        return (bool) $this->allow_local_auth;
    }

Here is the caller graph for this function:

bindDbRecord()

ilSamlIdp::bindDbRecord

(

array

$record

)

Parameters

array

$record

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

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

Referenced by read().

    {
        $this->setIdpId((int) $record['idp_id']);
        $this->setActive((bool) $record['is_active']);
        $this->setDefaultRoleId((int) $record['default_role_id']);
        $this->setUidClaim($record['uid_claim']);
        $this->setLoginClaim($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($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 156 of file class.ilSamlIdp.php.

References array, AUTH_SAML, and getIdpId().

    {
        require_once 'Services/Authentication/classes/External/UserAttributeMapping/class.ilExternalAuthUserAttributeMapping.php';
        $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:

getActiveIdpList()

static ilSamlIdp::getActiveIdpList ( )

static

Returns

self[]

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

References $idp, and array.

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

    {
        $idps = array();

        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 272 of file class.ilSamlIdp.php.

References $DIC, $idp, $res, $row, and array.

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

    {
        global $DIC;

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

        $idps = array();
        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 (   $a_auth_key )

static

Parameters

string

$a_auth_key

Returns

string

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

References array.

Referenced by ilAuthUtils\_getAuthModeName().

    {
        $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 384 of file class.ilSamlIdp.php.

References $default_role_id.

Referenced by persist(), and toArray().

    {
        return (int) $this->default_role_id;
    }

Here is the caller graph for this function:

getEntityId()

ilSamlIdp::getEntityId

(

)

Returns

string

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

References $entity_id.

Referenced by persist(), and toArray().

    {
        return $this->entity_id;
    }

Here is the caller graph for this function:

getFirstActiveIdp()

static ilSamlIdp::getFirstActiveIdp ( )

static

Returns

self

Exceptions

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

Referenced by ilAuthProviderSaml\__construct().

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

        require_once 'Services/Saml/exceptions/class.ilSamlException.php';
        throw new \ilSamlException('No active SAML IDP found');
    }

Here is the caller graph for this function:

getIdpId()

ilSamlIdp::getIdpId

(

)

Returns

int

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

References $idp_id.

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

    {
        return (int) $this->idp_id;
    }

Here is the caller graph for this function:

getIdpIdByAuthMode()

static ilSamlIdp::getIdpIdByAuthMode (   $a_auth_mode )

static

Parameters

string

$a_auth_mode

Returns

null|int

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

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

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

        return null;
    }

Here is the caller graph for this function:

getInstanceByIdpId()

static ilSamlIdp::getInstanceByIdpId (   $a_idp_id )

static

Parameters

int

$a_idp_id

Returns

self

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

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

    {
        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 (   $a_auth_mode )

static

Parameters

string

$a_auth_mode

Returns

int|string

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

References array, and AUTH_SAML.

Referenced by ilAuthUtils\_getAuthMode().

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

        return AUTH_SAML;
    }

Here is the caller graph for this function:

getLoginClaim()

ilSamlIdp::getLoginClaim

(

)

Returns

string

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

References $login_claim.

Referenced by persist(), and toArray().

    {
        return $this->login_claim;
    }

Here is the caller graph for this function:

getUidClaim()

ilSamlIdp::getUidClaim

(

)

Returns

string

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

References $uid_claim.

Referenced by persist(), and toArray().

    {
        return $this->uid_claim;
    }

Here is the caller graph for this function:

isAccountMigrationEnabled()

ilSamlIdp::isAccountMigrationEnabled

(

)

Returns

boolean

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

References $account_migration_status.

Referenced by persist(), and toArray().

    {
        return (bool) $this->account_migration_status;
    }

Here is the caller graph for this function:

isActive()

ilSamlIdp::isActive

(

)

Returns

boolean

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

References $is_active.

Referenced by persist(), and toArray().

    {
        return (bool) $this->is_active;
    }

Here is the caller graph for this function:

isAuthModeSaml()

static ilSamlIdp::isAuthModeSaml (   $a_auth_mode )

static

Parameters

string

$a_auth_mode

Returns

bool

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

References $GLOBALS, and AUTH_SAML.

Referenced by ilObjAuthSettingsGUI\authSettingsObject().

    {
        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 && $auth_arr[0] == AUTH_SAML && strlen($auth_arr[1]);
    }

Here is the caller graph for this function:

isSynchronizationEnabled()

ilSamlIdp::isSynchronizationEnabled

(

)

Returns

boolean

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

References $sync_status.

Referenced by persist(), and toArray().

    {
        return (bool) $this->sync_status;
    }

Here is the caller graph for this function:

persist()

ilSamlIdp::persist

(

)

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

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

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

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

Here is the call graph for this function:

read()

ilSamlIdp::read ( )

private

Exceptions

ilException

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

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

Referenced by __construct().

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

(

$status

)

Parameters

boolean

$status

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

Referenced by bindDbRecord().

    {
        $this->account_migration_status = (int) $status;
    }

Here is the caller graph for this function:

setActive()

ilSamlIdp::setActive

(

$is_active

)

Parameters

boolean

$is_active

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

References $is_active.

Referenced by bindDbRecord().

    {
        $this->is_active = (bool) $is_active;
    }

Here is the caller graph for this function:

setDefaultRoleId()

ilSamlIdp::setDefaultRoleId

(

$role_id

)

Parameters

int

$role_id

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

Referenced by bindDbRecord().

    {
        $this->default_role_id = (int) $role_id;
    }

Here is the caller graph for this function:

setEntityId()

ilSamlIdp::setEntityId

(

$entity_id

)

Parameters

string

$entity_id

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

References $entity_id.

Referenced by bindDbRecord().

    {
        $this->entity_id = $entity_id;
    }

Here is the caller graph for this function:

setIdpId()

ilSamlIdp::setIdpId

(

$idp_id

)

Parameters

int

$idp_id

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

References $idp_id.

Referenced by bindDbRecord(), and persist().

    {
        $this->idp_id = (int) $idp_id;
    }

Here is the caller graph for this function:

setLocalLocalAuthenticationStatus()

ilSamlIdp::setLocalLocalAuthenticationStatus

(

$status

)

Parameters

$status

boolean

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

Referenced by bindDbRecord().

    {
        $this->allow_local_auth = (bool) $status;
    }

Here is the caller graph for this function:

setLoginClaim()

ilSamlIdp::setLoginClaim

(

$claim

)

Parameters

$claim

string

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

Referenced by bindDbRecord().

    {
        $this->login_claim = $claim;
    }

Here is the caller graph for this function:

setSynchronizationStatus()

ilSamlIdp::setSynchronizationStatus

(

$sync

)

Parameters

boolean

$sync

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

References $sync.

Referenced by bindDbRecord().

    {
        $this->sync_status = (bool) $sync;
    }

Here is the caller graph for this function:

setUidClaim()

ilSamlIdp::setUidClaim

(

$claim

)

Parameters

$claim

string

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

Referenced by bindDbRecord().

    {
        $this->uid_claim = $claim;
    }

Here is the caller graph for this function:

toArray()

ilSamlIdp::toArray

(

)

Returns

array

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

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

    {
        return array(
            '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 63 of file class.ilSamlIdp.php.

Referenced by isAccountMigrationEnabled().

$allow_local_auth

ilSamlIdp::$allow_local_auth = false

protected

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

Referenced by allowLocalAuthentication().

$db

ilSamlIdp::$db

protected

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

$default_role_id

ilSamlIdp::$default_role_id = false

protected

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

Referenced by getDefaultRoleId().

$entity_id

ilSamlIdp::$entity_id = ''

protected

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

Referenced by getEntityId(), and setEntityId().

$idp_as_data

ilSamlIdp::$idp_as_data = array()

staticprotected

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

$idp_id

ilSamlIdp::$idp_id

protected

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

Referenced by getIdpId(), and setIdpId().

$instances

ilSamlIdp::$instances = array()

staticprivate

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

$is_active

ilSamlIdp::$is_active = false

protected

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

Referenced by isActive(), and setActive().

$login_claim

ilSamlIdp::$login_claim = ''

protected

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

Referenced by getLoginClaim().

$sync_status

ilSamlIdp::$sync_status = false

protected

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

Referenced by isSynchronizationEnabled().

$uid_claim

ilSamlIdp::$uid_claim = ''

protected

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