Auth_Container_DB Class Reference

Inheritance diagram for Auth_Container_DB:

Collaboration diagram for Auth_Container_DB:

Public Member Functions
	Auth_Container_DB ($dsn)
	Constructor of the container class.
	_connect ($dsn)
	Connect to database by using the given DSN string.
	_prepare ()
	Prepare database connection.
	query ($query)
	Prepare query to the database.
	_setDefaults ()
	Set some default options.
	_parseOptions ($array)
	Parse options passed to the container class.
	_quoteDBFields ()
	Quote the db_fields option to avoid the possibility of SQL injection.
	fetchData ($username, $password, $isChallengeResponse=false)
	Get user information from database.
	listUsers ()
	Returns a list of users from the container.
	addUser ($username, $password, $additional="")
	Add user to the storage container.
	removeUser ($username)
	Remove user from the storage container.
	changePassword ($username, $password)
	Change password for user in the storage container.
	supportsChallengeResponse ()
	Determine if this container supports password authentication with challenge response.
	getCryptType ()
	Returns the selected crypt type for this container.
Public Member Functions inherited from Auth_Container
	Auth_Container ()
	Constructor.
	verifyPassword ($password1, $password2, $cryptType="md5")
	Crypt and verfiy the entered password.
	getUser ($username)
	Returns a user assoc array.
	log ($message, $level=AUTH_LOG_DEBUG)
	Log a message to the Auth log.
Public Member Functions inherited from ilAuthContainerBase
	loginObserver ($a_username, $a_auth)
	Called after successful login.
	failedLoginObserver ($a_username, $a_auth)
	Called after failed login.
	checkAuthObserver ($a_username, $a_auth)
	Called after check auth requests.
	logoutObserver ($a_username, $a_auth)
	Called after logout.

Data Fields
	$options = array()
	$db = null
	$dsn = ''
	$activeUser = ''
Data Fields inherited from Auth_Container
	$activeUser = ""
	User that is currently selected from the storage container.
	$_auth_obj = null
	The Auth object this container is attached to.

Detailed Description

Definition at line 49 of file DB.php.

Member Function Documentation

Auth_Container_DB::_connect

(

$dsn

)

Connect to database by using the given DSN string.

private

Parameters

string

DSN string

Returns

mixed Object on error, otherwise bool

Definition at line 110 of file DB.php.

References $dsn, AUTH_LOG_DEBUG, elseif(), PEAR\isError(), Auth_Container\log(), PEAR_ERROR_RETURN, and PEAR\raiseError().

Referenced by _prepare().

    {
        $this->log('Auth_Container_DB::_connect() called.', AUTH_LOG_DEBUG);

        if (is_string($dsn) || is_array($dsn)) {
            $this->db = DB::Connect($dsn, $this->options['db_options']);
        } elseif (is_subclass_of($dsn, 'db_common')) {
            $this->db = $dsn;
        } elseif (DB::isError($dsn)) {
            return PEAR::raiseError($dsn->getMessage(), $dsn->getCode());
        } else {
            return PEAR::raiseError('The given dsn was not valid in file ' . __FILE__ . ' at line ' . __LINE__,
                                    41,
                                    PEAR_ERROR_RETURN,
                                    null,
                                    null
                                    );
        }

        if (DB::isError($this->db) || PEAR::isError($this->db)) {
            return PEAR::raiseError($this->db->getMessage(), $this->db->getCode());
        } else {
            return true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Auth_Container_DB::_parseOptions

(

$array

)

Parse options passed to the container class.

private

Parameters

array

Definition at line 230 of file DB.php.

References $key.

Referenced by Auth_Container_DB().

    {
        foreach ($array as $key => $value) {
            if (isset($this->options[$key])) {
                $this->options[$key] = $value;
            }
        }
    }

Here is the caller graph for this function:

Auth_Container_DB::_prepare

(

)

Prepare database connection.

This function checks if we have already opened a connection to the database. If that's not the case, a new connection is opened.

private

Returns

mixed True or a DB error object.

Definition at line 148 of file DB.php.

References $res, $t, _connect(), and PEAR\isError().

Referenced by addUser(), changePassword(), fetchData(), listUsers(), query(), and removeUser().

    {
        if (!DB::isConnection($this->db)) {
            $res = $this->_connect($this->options['dsn']);
            if (DB::isError($res) || PEAR::isError($res)) {
                return $res;
            }
        }
        if ($this->options['auto_quote'] && $this->db->dsn['phptype'] != 'sqlite') {
            if (strpos('.', $this->options['table']) === false) {
                $this->options['final_table'] = $this->db->quoteIdentifier($this->options['table']);
            } else {
                $t = explode('.', $this->options['table']);
                for ($i = 0, $count = count($t); $i < $count; $i++)
                    $t[$i] = $this->db->quoteIdentifier($t[$i]);
                $this->options['final_table'] = implode('.', $t);
            }
            $this->options['final_usernamecol'] = $this->db->quoteIdentifier($this->options['usernamecol']);
            $this->options['final_passwordcol'] = $this->db->quoteIdentifier($this->options['passwordcol']);
        } else {
            $this->options['final_table'] = $this->options['table'];
            $this->options['final_usernamecol'] = $this->options['usernamecol'];
            $this->options['final_passwordcol'] = $this->options['passwordcol'];
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Auth_Container_DB::_quoteDBFields

(

)

Quote the db_fields option to avoid the possibility of SQL injection.

private

Returns

string A properly quoted string that can be concatenated into a SELECT clause.

Definition at line 249 of file DB.php.

Referenced by fetchData(), and listUsers().

    {
        if (isset($this->options['db_fields'])) {
            if (is_array($this->options['db_fields'])) {
                if ($this->options['auto_quote']) {
                    $fields = array();
                    foreach ($this->options['db_fields'] as $field) {
                        $fields[] = $this->db->quoteIdentifier($field);
                    }
                    return implode(', ', $fields);
                } else {
                    return implode(', ', $this->options['db_fields']);
                }
            } else {
                if (strlen($this->options['db_fields']) > 0) {
                    if ($this->options['auto_quote']) {
                        return $this->db->quoteIdentifier($this->options['db_fields']);
                    } else {
                        return $this->options['db_fields'];
                    }
                }
            }
        }

        return '';
    }

Here is the caller graph for this function:

Auth_Container_DB::_setDefaults

(

)

Set some default options.

private

Returns

void

Definition at line 208 of file DB.php.

Referenced by Auth_Container_DB().

    {
        $this->options['table']       = 'auth';
        $this->options['usernamecol'] = 'username';
        $this->options['passwordcol'] = 'password';
        $this->options['dsn']         = '';
        $this->options['db_fields']   = '';
        $this->options['cryptType']   = 'md5';
        $this->options['db_options']  = array();
        $this->options['db_where']    = '';
        $this->options['auto_quote']  = true;
    }

Here is the caller graph for this function:

Auth_Container_DB::addUser	(		$username,
			$password,
			$additional = ""
	)

Add user to the storage container.

public

Parameters

string	Username
string	Password
mixed	Additional information that are stored in the DB

Returns

mixed True on success, otherwise error object

Reimplemented from Auth_Container.

Definition at line 452 of file DB.php.

References $err, $key, $password, $query, $res, _prepare(), AUTH_LOG_DEBUG, elseif(), Auth_Container\log(), query(), and PEAR\raiseError().

    {
        $this->log('Auth_Container_DB::addUser() called.', AUTH_LOG_DEBUG);
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }

        if (   isset($this->options['cryptType'])
            && $this->options['cryptType'] == 'none') {
            $cryptFunction = 'strval';
        } elseif (   isset($this->options['cryptType'])
                  && function_exists($this->options['cryptType'])) {
            $cryptFunction = $this->options['cryptType'];
        } else {
            $cryptFunction = 'md5';
        }

        $password = $cryptFunction($password);

        $additional_key   = '';
        $additional_value = '';

        if (is_array($additional)) {
            foreach ($additional as $key => $value) {
                if ($this->options['auto_quote']) {
                    $additional_key .= ', ' . $this->db->quoteIdentifier($key);
                } else {
                    $additional_key .= ', ' . $key;
                }
                $additional_value .= ", " . $this->db->quoteSmart($value);
            }
        }

        $query = sprintf("INSERT INTO %s (%s, %s%s) VALUES (%s, %s%s)",
                         $this->options['final_table'],
                         $this->options['final_usernamecol'],
                         $this->options['final_passwordcol'],
                         $additional_key,
                         $this->db->quoteSmart($username),
                         $this->db->quoteSmart($password),
                         $additional_value
                         );

        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);

        $res = $this->query($query);

        if (DB::isError($res)) {
            return PEAR::raiseError($res->getMessage(), $res->getCode());
        } else {
            return true;
        }
    }

Here is the call graph for this function:

Auth_Container_DB::Auth_Container_DB

(

$dsn

)

Constructor of the container class.

Save the initial options passed to the container. Initiation of the DB connection is no longer performed here and is only done when needed.

Parameters

string

Connection data or DB object

Returns

object Returns an error object if something went wrong

Definition at line 85 of file DB.php.

References $dsn, _parseOptions(), _setDefaults(), and PEAR\raiseError().

    {
        $this->_setDefaults();

        if (is_array($dsn)) {
            $this->_parseOptions($dsn);

            if (empty($this->options['dsn'])) {
                PEAR::raiseError('No connection parameters specified!');
            }
        } else {
            $this->options['dsn'] = $dsn;
        }
    }

Here is the call graph for this function:

Auth_Container_DB::changePassword	(		$username,
			$password
	)

Change password for user in the storage container.

Parameters

string	Username
string	The new password (plain text)

Reimplemented from Auth_Container.

Definition at line 562 of file DB.php.

References $err, $password, $query, $res, _prepare(), AUTH_LOG_DEBUG, elseif(), Auth_Container\log(), query(), and PEAR\raiseError().

    {
        $this->log('Auth_Container_DB::changePassword() called.', AUTH_LOG_DEBUG);
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }

        if (   isset($this->options['cryptType'])
            && $this->options['cryptType'] == 'none') {
            $cryptFunction = 'strval';
        } elseif (   isset($this->options['cryptType'])
                  && function_exists($this->options['cryptType'])) {
            $cryptFunction = $this->options['cryptType'];
        } else {
            $cryptFunction = 'md5';
        }

        $password = $cryptFunction($password);

        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $where = " AND ".$this->options['db_where'];
        } else {
            $where = '';
        }

        $query = sprintf("UPDATE %s SET %s = %s WHERE %s = %s %s",
                         $this->options['final_table'],
                         $this->options['final_passwordcol'],
                         $this->db->quoteSmart($password),
                         $this->options['final_usernamecol'],
                         $this->db->quoteSmart($username),
                         $where
                         );

        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);

        $res = $this->query($query);

        if (DB::isError($res)) {
            return PEAR::raiseError($res->getMessage(), $res->getCode());
        } else {
            return true;
        }
    }

Here is the call graph for this function:

Auth_Container_DB::fetchData	(		$username,
			$password,
			$isChallengeResponse = false
	)

Get user information from database.

This function uses the given username to fetch the corresponding login data from the database table. If an account that matches the passed username and password is found, the function returns true. Otherwise it returns false.

Parameters

string	Username
string	Password
boolean	If true password is secured using a md5 hash the frontend and auth are responsible for making sure the container supports challenge response password authentication

Returns

mixed Error object or boolean

Reimplemented from Auth_Container.

Definition at line 295 of file DB.php.

References $err, $key, $password, $query, $res, _prepare(), _quoteDBFields(), AUTH_LOG_DEBUG, DB_FETCHMODE_ASSOC, Auth_Container\log(), PEAR\raiseError(), and Auth_Container\verifyPassword().

    {
        $this->log('Auth_Container_DB::fetchData() called.', AUTH_LOG_DEBUG);
        // Prepare for a database query
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }

        // Find if db_fields contains a *, if so assume all columns are selected
        if (is_string($this->options['db_fields'])
            && strstr($this->options['db_fields'], '*')) {
            $sql_from = "*";
        } else {
            $sql_from = $this->options['final_usernamecol'].
                ", ".$this->options['final_passwordcol'];

            if (strlen($fields = $this->_quoteDBFields()) > 0) {
                $sql_from .= ', '.$fields;
            }
        }

        $query = "SELECT ".$sql_from.
                " FROM ".$this->options['final_table'].
                " WHERE ".$this->options['final_usernamecol']." = ".$this->db->quoteSmart($username);

        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $query .= " AND ".$this->options['db_where'];
        }

        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);

        $res = $this->db->getRow($query, null, DB_FETCHMODE_ASSOC);

        if (DB::isError($res)) {
            return PEAR::raiseError($res->getMessage(), $res->getCode());
        }

        if (!is_array($res)) {
            $this->activeUser = '';
            return false;
        }

        // Perform trimming here before the hashihg
        $password = trim($password, "\r\n");
        $res[$this->options['passwordcol']] = trim($res[$this->options['passwordcol']], "\r\n");

        // If using Challenge Response md5 the pass with the secret
        if ($isChallengeResponse) {
            $res[$this->options['passwordcol']] = md5($res[$this->options['passwordcol']]
                    .$this->_auth_obj->session['loginchallenege']);

            // UGLY cannot avoid without modifying verifyPassword
            if ($this->options['cryptType'] == 'md5') {
                $res[$this->options['passwordcol']] = md5($res[$this->options['passwordcol']]);
            }

            //print " Hashed Password [{$res[$this->options['passwordcol']]}]<br/>\n";
        }

        if ($this->verifyPassword($password,
                                  $res[$this->options['passwordcol']],
                                  $this->options['cryptType'])) {
            // Store additional field values in the session
            foreach ($res as $key => $value) {
                if ($key == $this->options['passwordcol'] ||
                    $key == $this->options['usernamecol']) {
                    continue;
                }

                $this->log('Storing additional field: '.$key, AUTH_LOG_DEBUG);

                // Use reference to the auth object if exists
                // This is because the auth session variable can change so a
                // static call to setAuthData does not make sence
                $this->_auth_obj->setAuthData($key, $value);
            }
            return true;
        }
        $this->activeUser = $res[$this->options['usernamecol']];
        return false;
    }

Here is the call graph for this function:

Auth_Container_DB::getCryptType

(

)

Returns the selected crypt type for this container.

Reimplemented from Auth_Container.

Definition at line 631 of file DB.php.

    {
        return($this->options['cryptType']);
    }

Auth_Container_DB::listUsers

(

)

Returns a list of users from the container.

Returns

mixed public

Reimplemented from Auth_Container.

Definition at line 389 of file DB.php.

References $err, $query, $res, $user, _prepare(), _quoteDBFields(), AUTH_LOG_DEBUG, DB_FETCHMODE_ASSOC, Auth_Container\log(), and PEAR\raiseError().

    {
        $this->log('Auth_Container_DB::listUsers() called.', AUTH_LOG_DEBUG);
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }

        $retVal = array();

        // Find if db_fields contains a *, if so assume all col are selected
        if (   is_string($this->options['db_fields'])
            && strstr($this->options['db_fields'], '*')) {
            $sql_from = "*";
        } else {
            $sql_from = $this->options['final_usernamecol'].
                ", ".$this->options['final_passwordcol'];

            if (strlen($fields = $this->_quoteDBFields()) > 0) {
                $sql_from .= ', '.$fields;
            }
        }

        $query = sprintf("SELECT %s FROM %s",
                         $sql_from,
                         $this->options['final_table']
                         );

        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $query .= " WHERE ".$this->options['db_where'];
        }

        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);

        $res = $this->db->getAll($query, null, DB_FETCHMODE_ASSOC);

        if (DB::isError($res)) {
            return PEAR::raiseError($res->getMessage(), $res->getCode());
        } else {
            foreach ($res as $user) {
                $user['username'] = $user[$this->options['usernamecol']];
                $retVal[] = $user;
            }
        }
        $this->log('Found '.count($retVal).' users.', AUTH_LOG_DEBUG);
        return $retVal;
    }

Here is the call graph for this function:

Auth_Container_DB::query

(

$query

)

Prepare query to the database.

This function checks if we have already opened a connection to the database. If that's not the case, a new connection is opened. After that the query is passed to the database.

public

Parameters

string

Query string

Returns

mixed a DB_result object or DB_OK on success, a DB or PEAR error on failure

Definition at line 190 of file DB.php.

References $err, $query, and _prepare().

Referenced by addUser(), changePassword(), and removeUser().

    {
        $err = $this->_prepare();
        if ($err !== true) {
            return $err;
        }
        return $this->db->query($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Auth_Container_DB::removeUser

(

$username

)

Remove user from the storage container.

public

Parameters

string

Username

Returns

mixed True on success, otherwise error object

Reimplemented from Auth_Container.

Definition at line 518 of file DB.php.

References $err, $query, $res, _prepare(), AUTH_LOG_DEBUG, Auth_Container\log(), query(), and PEAR\raiseError().

    {
        $this->log('Auth_Container_DB::removeUser() called.', AUTH_LOG_DEBUG);

        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }

        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $where = " AND ".$this->options['db_where'];
        } else {
            $where = '';
        }

        $query = sprintf("DELETE FROM %s WHERE %s = %s %s",
                         $this->options['final_table'],
                         $this->options['final_usernamecol'],
                         $this->db->quoteSmart($username),
                         $where
                         );

        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);

        $res = $this->query($query);

        if (DB::isError($res)) {
           return PEAR::raiseError($res->getMessage(), $res->getCode());
        } else {
          return true;
        }
    }

Here is the call graph for this function:

Auth_Container_DB::supportsChallengeResponse

(

)

Determine if this container supports password authentication with challenge response.

Returns

bool public

Reimplemented from Auth_Container.

Definition at line 620 of file DB.php.

    {
        return in_array($this->options['cryptType'], array('md5', 'none', ''));
    }

Field Documentation

Auth_Container_DB::$activeUser = ''

Definition at line 71 of file DB.php.

Auth_Container_DB::$db = null

Definition at line 64 of file DB.php.

Auth_Container_DB::$dsn = ''

Definition at line 65 of file DB.php.

Referenced by _connect(), and Auth_Container_DB().

Auth_Container_DB::$options = array()

Definition at line 58 of file DB.php.

---

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

• Services/PEAR/lib/Auth/Container/DB.php