sspmod_saml_IdP_SQLNameID Class Reference

Collaboration diagram for sspmod_saml_IdP_SQLNameID:

Static Public Member Functions
static	add ($idpEntityId, $spEntityId, $user, $value)
	Add a NameID into the database. More...
static	get ($idpEntityId, $spEntityId, $user)
	Retrieve a NameID into from database. More...
static	delete ($idpEntityId, $spEntityId, $user)
	Delete a NameID from the database. More...
static	getIdentities ($idpEntityId, $spEntityId)
	Retrieve all federated identities for an IdP-SP pair. More...

Static Private Member Functions
static	createTable (\SimpleSAML\Store\SQL $store)
	Create NameID table in SQL, if it is missing. More...
static	getStore ()
	Retrieve the SQL datastore. More...

Detailed Description

Definition at line 8 of file SQLNameID.php.

Member Function Documentation

add()

static sspmod_saml_IdP_SQLNameID::add (   $idpEntityId,   $spEntityId,   $user,   $value  )

static

Add a NameID into the database.

Parameters

\SimpleSAML\Store\SQL	$store	The data store.
string	$idpEntityId	The IdP entityID.
string	$spEntityId	The SP entityID.
string	$user	The user's unique identificator (e.g. username).
string	$value	The NameID value.

Definition at line 66 of file SQLNameID.php.

References $idpEntityId, PHPMailer\PHPMailer\$params, $query, $spEntityId, $store, and $user.

Referenced by sspmod_saml_Auth_Process_SQLPersistentNameID\getValue().

    {
        assert(is_string($idpEntityId));
        assert(is_string($spEntityId));
        assert(is_string($user));
        assert(is_string($value));

        $store = self::getStore();

        $params = array(
            '_idp' => $idpEntityId,
            '_sp' => $spEntityId,
            '_user' => $user,
            '_value' => $value,
        );

        $query = 'INSERT INTO ' . $store->prefix . '_saml_PersistentNameID (_idp, _sp, _user, _value) VALUES(:_idp, :_sp, :_user, :_value)';
        $query = $store->pdo->prepare($query);
        $query->execute($params);
    }

Here is the caller graph for this function:

createTable()

static sspmod_saml_IdP_SQLNameID::createTable ( \SimpleSAML\Store\SQL  $store )

staticprivate

Create NameID table in SQL, if it is missing.

Parameters

\SimpleSAML\Store\SQL

$store

The datastore.

Definition at line 15 of file SQLNameID.php.

References $query.

    {
        if ($store->getTableVersion('saml_PersistentNameID') === 1) {
            return;
        }

        $query = 'CREATE TABLE ' . $store->prefix . '_saml_PersistentNameID (
            _idp VARCHAR(256) NOT NULL,
            _sp VARCHAR(256) NOT NULL,
            _user VARCHAR(256) NOT NULL,
            _value VARCHAR(40) NOT NULL,
            UNIQUE (_idp, _sp, _user)
        )';
        $store->pdo->exec($query);

        $query = 'CREATE INDEX ' . $store->prefix . '_saml_PersistentNameID_idp_sp ON '  . $store->prefix . '_saml_PersistentNameID (_idp, _sp)';
        $store->pdo->exec($query);

        $store->setTableVersion('saml_PersistentNameID', 1);
    }

delete()

static sspmod_saml_IdP_SQLNameID::delete (   $idpEntityId,   $spEntityId,   $user  )

static

Delete a NameID from the database.

Parameters

string	$idpEntityId	The IdP entityID.
string	$spEntityId	The SP entityID.
string	$user	The user's unique identificator (e.g. username).

Definition at line 131 of file SQLNameID.php.

References $idpEntityId, PHPMailer\PHPMailer\$params, $query, $store, and $user.

    {
        assert(is_string($idpEntityId));
        assert(is_string($spEntityId));
        assert(is_string($user));

        $store = self::getStore();

        $params = array(
            '_idp' => $idpEntityId,
            '_sp' => $spEntityId,
            '_user' => $user,
        );

        $query = 'DELETE FROM ' . $store->prefix . '_saml_PersistentNameID WHERE _idp = :_idp AND _sp = :_sp AND _user = :_user';
        $query = $store->pdo->prepare($query);
        $query->execute($params);
    }

get()

static sspmod_saml_IdP_SQLNameID::get (   $idpEntityId,   $spEntityId,   $user  )

static

Retrieve a NameID into from database.

Parameters

string	$idpEntityId	The IdP entityID.
string	$spEntityId	The SP entityID.
string	$user	The user's unique identificator (e.g. username).

Returns

string|NULL $value The NameID value, or NULL of no NameID value was found.

Definition at line 96 of file SQLNameID.php.

References $idpEntityId, PHPMailer\PHPMailer\$params, $query, $row, $store, and $user.

Referenced by sspmod_saml_Auth_Process_SQLPersistentNameID\getValue().

    {
        assert(is_string($idpEntityId));
        assert(is_string($spEntityId));
        assert(is_string($user));

        $store = self::getStore();

        $params = array(
            '_idp' => $idpEntityId,
            '_sp' => $spEntityId,
            '_user' => $user,
        );

        $query = 'SELECT _value FROM ' . $store->prefix . '_saml_PersistentNameID WHERE _idp = :_idp AND _sp = :_sp AND _user = :_user';
        $query = $store->pdo->prepare($query);
        $query->execute($params);

        $row = $query->fetch(PDO::FETCH_ASSOC);
        if ($row === false) {
            // No NameID found
            return null;
        }

        return $row['_value'];
    }

Here is the caller graph for this function:

getIdentities()

static sspmod_saml_IdP_SQLNameID::getIdentities (   $idpEntityId,   $spEntityId  )

static

Retrieve all federated identities for an IdP-SP pair.

Parameters

string	$idpEntityId	The IdP entityID.
string	$spEntityId	The SP entityID.

Returns

array Array of userid => NameID.

Definition at line 158 of file SQLNameID.php.

References $idpEntityId, PHPMailer\PHPMailer\$params, $query, $res, $row, and $store.

    {
        assert(is_string($idpEntityId));
        assert(is_string($spEntityId));

        $store = self::getStore();

        $params = array(
            '_idp' => $idpEntityId,
            '_sp' => $spEntityId,
        );

        $query = 'SELECT _user, _value FROM ' . $store->prefix . '_saml_PersistentNameID WHERE _idp = :_idp AND _sp = :_sp';
        $query = $store->pdo->prepare($query);
        $query->execute($params);

        $res = array();
        while (($row = $query->fetch(PDO::FETCH_ASSOC)) !== false) {
            $res[$row['_user']] = $row['_value'];
        }

        return $res;
    }

getStore()

static sspmod_saml_IdP_SQLNameID::getStore ( )

staticprivate

Retrieve the SQL datastore.

Will also ensure that the NameID table is present.

Returns

SQL datastore.

Definition at line 44 of file SQLNameID.php.

References $store, and SimpleSAML\Store\getInstance().

    {
        $store = \SimpleSAML\Store::getInstance();
        if (!($store instanceof \SimpleSAML\Store\SQL)) {
            throw new SimpleSAML_Error_Exception('SQL NameID store requires SimpleSAMLphp to be configured with a SQL datastore.');
        }

        self::createTable($store);

        return $store;
    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/saml/lib/IdP/SQLNameID.php