sspmod_sqlauth_Auth_Source_SQL Class Reference

Inheritance diagram for sspmod_sqlauth_Auth_Source_SQL:

Collaboration diagram for sspmod_sqlauth_Auth_Source_SQL:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...
Public Member Functions inherited from sspmod_core_Auth_UserPassBase
	__construct ($info, &$config)
	Constructor for this authentication source. More...
	setForcedUsername ($forcedUsername)
	Set forced username. More...
	getLoginLinks ()
	Return login links from configuration. More...
	getRememberUsernameEnabled ()
	Getter for the authsource config option remember.username.enabled. More...
	getRememberUsernameChecked ()
	Getter for the authsource config option remember.username.checked. More...
	isRememberMeEnabled ()
	Check if the "remember me" feature is enabled. More...
	isRememberMeChecked ()
	Check if the "remember me" checkbox should be checked. More...
	authenticate (&$state)
	Initialize login. More...
Public Member Functions inherited from SimpleSAML_Auth_Source
	__construct ($info, &$config)
	Constructor for an authentication source. More...
	getAuthId ()
	Retrieve the ID of this authentication source. More...
	authenticate (&$state)
	Process a request. More...
	reauthenticate (array &$state)
	Reauthenticate an user. More...
	initLogin ($return, $errorURL=null, array $params=array())
	Start authentication. More...
	logout (&$state)
	Log out from this authentication source. More...

Protected Member Functions
	login ($username, $password)
	Attempt to log in using the given username and password. More...
	login ($username, $password)
	Attempt to log in using the given username and password. More...
Protected Member Functions inherited from SimpleSAML_Auth_Source
	addLogoutCallback ($assoc, $state)
	Add a logout callback association. More...
	callLogoutCallback ($assoc)
	Call a logout callback based on association. More...

Private Member Functions
	connect ()
	Create a database connection. More...

Private Attributes
	$dsn
	The DSN we should connect to. More...
	$username
	The username we should connect to the database with. More...
	$password
	The password we should connect to the database with. More...
	$options
	The options that we should connect to the database with. More...
	$query
	The query we should use to retrieve the attributes for the user. More...

Additional Inherited Members
Static Public Member Functions inherited from sspmod_core_Auth_UserPassBase
static	handleLogin ($authStateId, $username, $password)
	Handle login request. More...
Static Public Member Functions inherited from SimpleSAML_Auth_Source
static	getSourcesOfType ($type)
	Get sources of a specific type. More...
static	completeAuth (&$state)
	Complete authentication. More...
static	loginCompleted ($state)
	Called when a login operation has finished. More...
static	completeLogout (&$state)
	Complete logout. More...
static	getById ($authId, $type=null)
	Retrieve authentication source. More...
static	logoutCallback ($state)
	Called when the authentication source receives an external logout request. More...
static	getSources ()
	Retrieve list of authentication sources. More...
Data Fields inherited from sspmod_core_Auth_UserPassBase
const	STAGEID = 'sspmod_core_Auth_UserPassBase.state'
	The string used to identify our states. More...
const	AUTHID = 'sspmod_core_Auth_UserPassBase.AuthId'
	The key of the AuthId field in the state. More...
Static Protected Member Functions inherited from SimpleSAML_Auth_Source
static	validateSource ($source, $id)
	Make sure that the first element of an auth source is its identifier. More...
Protected Attributes inherited from sspmod_core_Auth_UserPassBase
	$loginLinks
	Links to pages from login page. More...
	$rememberUsernameEnabled = FALSE
	$rememberUsernameChecked = FALSE
	$rememberMeEnabled = FALSE
	$rememberMeChecked = FALSE
Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 12 of file SQL.php.

Constructor & Destructor Documentation

__construct()

sspmod_sqlauth_Auth_Source_SQL::__construct	(		$info,
			$config
	)

Constructor for this authentication source.

Parameters

array	$info	Information about this authentication source.
array	$config	Configuration.

Definition at line 47 of file SQL.php.

    {
        assert(is_array($info));
        assert(is_array($config));
 
        // Call the parent constructor first, as required by the interface
        parent::__construct($info, $config);
 
        // Make sure that all required parameters are present.
        foreach (array('dsn', 'username', 'password', 'query') as $param) {
            if (!array_key_exists($param, $config)) {
                throw new Exception('Missing required attribute \'' . $param .
                    '\' for authentication source ' . $this->authId);
            }
 
            if (!is_string($config[$param])) {
                throw new Exception('Expected parameter \'' . $param .
                    '\' for authentication source ' . $this->authId .
                    ' to be a string. Instead it was: ' .
                    var_export($config[$param], true));
            }
        }
 
        $this->dsn = $config['dsn'];
        $this->username = $config['username'];
        $this->password = $config['password'];
        $this->query = $config['query'];
        if (isset($config['options'])) {
            $this->options = $config['options'];
        }
    }

References $config, and $info.

Member Function Documentation

connect()

sspmod_sqlauth_Auth_Source_SQL::connect ( )

private

Create a database connection.

Returns

PDO The database connection.

Definition at line 85 of file SQL.php.

    {
        try {
            $db = new PDO($this->dsn, $this->username, $this->password, $this->options);
        } catch (PDOException $e) {
            throw new Exception('sqlauth:' . $this->authId . ': - Failed to connect to \'' .
                $this->dsn . '\': '. $e->getMessage());
        }
 
        $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
 
        $driver = explode(':', $this->dsn, 2);
        $driver = strtolower($driver[0]);
 
        /* Driver specific initialization. */
        switch ($driver) {
        case 'mysql':
            /* Use UTF-8. */
            $db->exec("SET NAMES 'utf8mb4'");
            break;
        case 'pgsql':
            /* Use UTF-8. */
            $db->exec("SET NAMES 'UTF8'");
            break;
        }
 
        return $db;
    }

login()

sspmod_sqlauth_Auth_Source_SQL::login (   $username,   $password  )

protected

Attempt to log in using the given username and password.

On a successful login, this function should return the users attributes. On failure, it should throw an exception. If the error was caused by the user entering the wrong username or password, a SimpleSAML_Error_Error('WRONGUSERPASS') should be thrown.

Note that both the username and the password are UTF-8 encoded.

Parameters

string	$username	The username the user wrote.
string	$password	The password the user wrote.

Returns

array Associative array with the users attributes.

Reimplemented from sspmod_core_Auth_UserPassBase.

Definition at line 128 of file SQL.php.

    {
        assert(is_string($username));
        assert(is_string($password));
 
        $db = $this->connect();
 
        try {
            $sth = $db->prepare($this->query);
        } catch (PDOException $e) {
            throw new Exception('sqlauth:' . $this->authId .
                ': - Failed to prepare query: ' . $e->getMessage());
        }
 
        try {
            $sth->execute(array('username' => $username, 'password' => $password));
        } catch (PDOException $e) {
            throw new Exception('sqlauth:' . $this->authId .
                ': - Failed to execute query: ' . $e->getMessage());
        }
 
        try {
            $data = $sth->fetchAll(PDO::FETCH_ASSOC);
        } catch (PDOException $e) {
            throw new Exception('sqlauth:' . $this->authId .
                ': - Failed to fetch result set: ' . $e->getMessage());
        }
 
        SimpleSAML\Logger::info('sqlauth:' . $this->authId . ': Got ' . count($data) .
            ' rows from database');
 
        if (count($data) === 0) {
            /* No rows returned - invalid username/password. */
            SimpleSAML\Logger::error('sqlauth:' . $this->authId .
                ': No rows in result set. Probably wrong username/password.');
            throw new SimpleSAML_Error_Error('WRONGUSERPASS');
        }
 
        /* Extract attributes. We allow the resultset to consist of multiple rows. Attributes
         * which are present in more than one row will become multivalued. null values and
         * duplicate values will be skipped. All values will be converted to strings.
         */
        $attributes = array();
        foreach ($data as $row) {
            foreach ($row as $name => $value) {
 
                if ($value === null) {
                    continue;
                }
 
                $value = (string)$value;
 
                if (!array_key_exists($name, $attributes)) {
                    $attributes[$name] = array();
                }
 
                if (in_array($value, $attributes[$name], true)) {
                    /* Value already exists in attribute. */
                    continue;
                }
 
                $attributes[$name][] = $value;
            }
        }
 
        SimpleSAML\Logger::info('sqlauth:' . $this->authId . ': Attributes: ' .
            implode(',', array_keys($attributes)));
 
        return $attributes;
    }

Field Documentation

$dsn

sspmod_sqlauth_Auth_Source_SQL::$dsn

private

The DSN we should connect to.

Definition at line 17 of file SQL.php.

$options

sspmod_sqlauth_Auth_Source_SQL::$options

private

The options that we should connect to the database with.

Definition at line 32 of file SQL.php.

$password

sspmod_sqlauth_Auth_Source_SQL::$password

private

The password we should connect to the database with.

Definition at line 27 of file SQL.php.

$query

sspmod_sqlauth_Auth_Source_SQL::$query

private

The query we should use to retrieve the attributes for the user.

The username and password will be available as :username and :password.

Definition at line 39 of file SQL.php.

$username

sspmod_sqlauth_Auth_Source_SQL::$username

private

The username we should connect to the database with.

Definition at line 22 of file SQL.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/sqlauth/lib/Auth/Source/SQL.php