Auth_OpenID_FileStore Class Reference

Inheritance diagram for Auth_OpenID_FileStore:

Collaboration diagram for Auth_OpenID_FileStore:

Public Member Functions
	Auth_OpenID_FileStore ($directory)
	Initializes a new Auth_OpenID_FileStore. More...
	destroy ()
	_setup ()
	Make sure that the directories in which we store our data exist. More...
	_mktemp ()
	Create a temporary file on the same filesystem as $this->association_dir. More...
	cleanupNonces ()
	getAssociationFilename ($server_url, $handle)
	Create a unique filename for a given server url and handle. More...
	storeAssociation ($server_url, $association)
	Store an association in the association directory. More...
	getAssociation ($server_url, $handle=null)
	Retrieve an association. More...
	_getAssociation ($filename)
	private More...
	removeAssociation ($server_url, $handle)
	Remove an association if it exists. More...
	useNonce ($server_url, $timestamp, $salt)
	Return whether this nonce is present. More...
	_allAssocs ()
	Remove expired entries from the database. More...
	clean ()
	_rmtree ($dir)
	private More...
	_mkstemp ($dir)
	private More...
	_listdir ($dir)
	private More...
	_isFilenameSafe ($char)
	private More...
	_safe64 ($str)
	private More...
	_filenameEscape ($str)
	private More...
	_removeIfPresent ($filename)
	Attempt to remove a file, returning whether the file existed at the time of the call. More...
	cleanupAssociations ()
Public Member Functions inherited from Auth_OpenID_OpenIDStore
	storeAssociation ($server_url, $association)
	This method puts an Association object into storage, retrievable by server URL and handle. More...
	cleanupNonces ()
	cleanupAssociations ()
	cleanup ()
	supportsCleanup ()
	Report whether this storage supports cleanup. More...
	getAssociation ($server_url, $handle=null)
	This method returns an Association object from storage that matches the server URL and, if specified, handle. More...
	removeAssociation ($server_url, $handle)
	This method removes the matching association if it's found, and returns whether the association was removed or not. More...
	useNonce ($server_url, $timestamp, $salt)
	Called when using a nonce. More...
	reset ()
	Removes all entries from the store; implementation is optional. More...

Static Public Member Functions
static	_mkdtemp ($dir)
	private More...

Detailed Description

Definition at line 39 of file FileStore.php.

Member Function Documentation

_allAssocs()

Auth_OpenID_FileStore::_allAssocs

(

)

Remove expired entries from the database.

This is potentially expensive, so only run when it is acceptable to take time.

private

Definition at line 405 of file FileStore.php.

References _listdir(), _removeIfPresent(), and Auth_OpenID_Association\deserialize().

Referenced by clean(), and cleanupAssociations().

    {
        $all_associations = array();

        $association_filenames =
            Auth_OpenID_FileStore::_listdir($this->association_dir);

        foreach ($association_filenames as $association_filename) {
            $association_file = fopen($association_filename, 'rb');

            if ($association_file !== false) {
                $assoc_s = fread($association_file,
                                 filesize($association_filename));
                fclose($association_file);

                // Remove expired or corrupted associations
                $association =
                  Auth_OpenID_Association::deserialize(
                         'Auth_OpenID_Association', $assoc_s);

                if ($association === null) {
                    Auth_OpenID_FileStore::_removeIfPresent(
                                                 $association_filename);
                } else {
                    if ($association->getExpiresIn() == 0) {
                        $all_associations[] = array($association_filename,
                                                    $association);
                    }
                }
            }
        }

        return $all_associations;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_filenameEscape()

Auth_OpenID_FileStore::_filenameEscape

(

$str

)

private

Definition at line 576 of file FileStore.php.

References $filename, _isFilenameSafe(), and Auth_OpenID\toBytes().

Referenced by getAssociationFilename(), and useNonce().

    {
        $filename = "";
        $b = Auth_OpenID::toBytes($str);

        for ($i = 0; $i < count($b); $i++) {
            $c = $b[$i];
            if (Auth_OpenID_FileStore::_isFilenameSafe($c)) {
                $filename .= $c;
            } else {
                $filename .= sprintf("_%02X", ord($c));
            }
        }
        return $filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getAssociation()

Auth_OpenID_FileStore::_getAssociation

(

$filename

)

private

Definition at line 296 of file FileStore.php.

References $filename, _removeIfPresent(), and Auth_OpenID_Association\deserialize().

Referenced by getAssociation().

    {
        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return null;
        }

        $assoc_file = @fopen($filename, 'rb');

        if ($assoc_file === false) {
            return null;
        }

        $assoc_s = fread($assoc_file, filesize($filename));
        fclose($assoc_file);

        if (!$assoc_s) {
            return null;
        }

        $association =
            Auth_OpenID_Association::deserialize('Auth_OpenID_Association',
                                                $assoc_s);

        if (!$association) {
            Auth_OpenID_FileStore::_removeIfPresent($filename);
            return null;
        }

        if ($association->getExpiresIn() == 0) {
            Auth_OpenID_FileStore::_removeIfPresent($filename);
            return null;
        } else {
            return $association;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isFilenameSafe()

Auth_OpenID_FileStore::_isFilenameSafe

(

$char

)

private

Definition at line 554 of file FileStore.php.

References Auth_OpenID_digits, and Auth_OpenID_letters.

Referenced by _filenameEscape().

    {
        $_Auth_OpenID_filename_allowed = Auth_OpenID_letters .
            Auth_OpenID_digits . ".";
        return (strpos($_Auth_OpenID_filename_allowed, $char) !== false);
    }

Here is the caller graph for this function:

_listdir()

Auth_OpenID_FileStore::_listdir

(

$dir

)

private

Definition at line 539 of file FileStore.php.

References $filename.

Referenced by _allAssocs(), clean(), cleanupNonces(), and getAssociation().

    {
        $handle = opendir($dir);
        $files = array();
        while (false !== ($filename = readdir($handle))) {
            if (!in_array($filename, array('.', '..'))) {
                $files[] = $dir . DIRECTORY_SEPARATOR . $filename;
            }
        }
        return $files;
    }

Here is the caller graph for this function:

_mkdtemp()

static Auth_OpenID_FileStore::_mkdtemp (   $dir )

static

private

Definition at line 522 of file FileStore.php.

    {
        foreach (range(0, 4) as $i) {
            $name = $dir . strval(DIRECTORY_SEPARATOR) . strval(getmypid()) .
                "-" . strval(rand(1, time()));
            if (!mkdir($name, 0700)) {
                return false;
            } else {
                return $name;
            }
        }
        return false;
    }

_mkstemp()

Auth_OpenID_FileStore::_mkstemp

(

$dir

)

private

Definition at line 507 of file FileStore.php.

Referenced by _mktemp().

    {
        foreach (range(0, 4) as $i) {
            $name = tempnam($dir, "php_openid_filestore_");

            if ($name !== false) {
                return $name;
            }
        }
        return false;
    }

Here is the caller graph for this function:

_mktemp()

Auth_OpenID_FileStore::_mktemp

(

)

Create a temporary file on the same filesystem as $this->association_dir.

The temporary directory should not be cleaned if there are any processes using the store. If there is no active process using the store, it is safe to remove all of the files in the temporary directory.

Returns

array ($fd, $filename) private

Definition at line 108 of file FileStore.php.

References _mkstemp(), and _removeIfPresent().

Referenced by storeAssociation().

    {
        $name = Auth_OpenID_FileStore::_mkstemp($dir = $this->temp_dir);
        $file_obj = @fopen($name, 'wb');
        if ($file_obj !== false) {
            return array($file_obj, $name);
        } else {
            Auth_OpenID_FileStore::_removeIfPresent($name);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_removeIfPresent()

Auth_OpenID_FileStore::_removeIfPresent

(

$filename

)

Attempt to remove a file, returning whether the file existed at the time of the call.

private

Returns

bool $result True if the file was present, false if not.

Definition at line 599 of file FileStore.php.

References $filename.

Referenced by _allAssocs(), _getAssociation(), _mktemp(), clean(), cleanupAssociations(), cleanupNonces(), removeAssociation(), and storeAssociation().

    {
        return @unlink($filename);
    }

Here is the caller graph for this function:

_rmtree()

Auth_OpenID_FileStore::_rmtree

(

$dir

)

private

Definition at line 469 of file FileStore.php.

Referenced by destroy().

    {
        if ($dir[strlen($dir) - 1] != DIRECTORY_SEPARATOR) {
            $dir .= DIRECTORY_SEPARATOR;
        }

        if ($handle = opendir($dir)) {
            while ($item = readdir($handle)) {
                if (!in_array($item, array('.', '..'))) {
                    if (is_dir($dir . $item)) {

                        if (!Auth_OpenID_FileStore::_rmtree($dir . $item)) {
                            return false;
                        }
                    } else if (is_file($dir . $item)) {
                        if (!unlink($dir . $item)) {
                            return false;
                        }
                    }
                }
            }

            closedir($handle);

            if (!@rmdir($dir)) {
                return false;
            }

            return true;
        } else {
            // Couldn't open directory.
            return false;
        }
    }

Here is the caller graph for this function:

_safe64()

Auth_OpenID_FileStore::_safe64

(

$str

)

private

Definition at line 564 of file FileStore.php.

References Auth_OpenID_SHA1().

Referenced by getAssociationFilename(), and useNonce().

    {
        $h64 = base64_encode(Auth_OpenID_SHA1($str));
        $h64 = str_replace('+', '_', $h64);
        $h64 = str_replace('/', '.', $h64);
        $h64 = str_replace('=', '', $h64);
        return $h64;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_setup()

Auth_OpenID_FileStore::_setup

(

)

Make sure that the directories in which we store our data exist.

private

Definition at line 89 of file FileStore.php.

References Auth_OpenID\ensureDir().

Referenced by Auth_OpenID_FileStore().

    {
        return (Auth_OpenID::ensureDir($this->nonce_dir) &&
                Auth_OpenID::ensureDir($this->association_dir) &&
                Auth_OpenID::ensureDir($this->temp_dir));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Auth_OpenID_FileStore()

Auth_OpenID_FileStore::Auth_OpenID_FileStore

(

$directory

)

Initializes a new Auth_OpenID_FileStore.

This initializes the nonce and association directories, which are subdirectories of the directory passed in.

Parameters

string

$directory

This is the directory to put the store directories in.

Definition at line 49 of file FileStore.php.

References _setup(), and Auth_OpenID\ensureDir().

    {
        if (!Auth_OpenID::ensureDir($directory)) {
            trigger_error('Not a directory and failed to create: '
                          . $directory, E_USER_ERROR);
        }
        $directory = realpath($directory);

        $this->directory = $directory;
        $this->active = true;

        $this->nonce_dir = $directory . DIRECTORY_SEPARATOR . 'nonces';

        $this->association_dir = $directory . DIRECTORY_SEPARATOR .
            'associations';

        // Temp dir must be on the same filesystem as the assciations
        // $directory.
        $this->temp_dir = $directory . DIRECTORY_SEPARATOR . 'temp';

        $this->max_nonce_age = 6 * 60 * 60; // Six hours, in seconds

        if (!$this->_setup()) {
            trigger_error('Failed to initialize OpenID file store in ' .
                          $directory, E_USER_ERROR);
        }
    }

Here is the call graph for this function:

clean()

Auth_OpenID_FileStore::clean

(

)

Definition at line 440 of file FileStore.php.

References $filename, _allAssocs(), _listdir(), _removeIfPresent(), and Auth_OpenID_checkTimestamp().

    {
        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return null;
        }

        $nonces = Auth_OpenID_FileStore::_listdir($this->nonce_dir);
        $now = time();

        // Check all nonces for expiry
        foreach ($nonces as $nonce) {
            if (!Auth_OpenID_checkTimestamp($nonce, $now)) {
                $filename = $this->nonce_dir . DIRECTORY_SEPARATOR . $nonce;
                Auth_OpenID_FileStore::_removeIfPresent($filename);
            }
        }

        foreach ($this->_allAssocs() as $pair) {
            list($assoc_filename, $assoc) = $pair;
            if ($assoc->getExpiresIn() == 0) {
                Auth_OpenID_FileStore::_removeIfPresent($assoc_filename);
            }
        }
    }

Here is the call graph for this function:

cleanupAssociations()

Auth_OpenID_FileStore::cleanupAssociations

(

)

Definition at line 604 of file FileStore.php.

References _allAssocs(), and _removeIfPresent().

    {
        $removed = 0;
        foreach ($this->_allAssocs() as $pair) {
            list($assoc_filename, $assoc) = $pair;
            if ($assoc->getExpiresIn() == 0) {
                $this->_removeIfPresent($assoc_filename);
                $removed += 1;
            }
        }
        return $removed;
    }

Here is the call graph for this function:

cleanupNonces()

Auth_OpenID_FileStore::cleanupNonces

(

)

Definition at line 119 of file FileStore.php.

References $Auth_OpenID_SKEW, $timestamp, _listdir(), and _removeIfPresent().

    {
        global $Auth_OpenID_SKEW;

        $nonces = Auth_OpenID_FileStore::_listdir($this->nonce_dir);
        $now = time();

        $removed = 0;
        // Check all nonces for expiry
        foreach ($nonces as $nonce_fname) {
            $base = basename($nonce_fname);
            $parts = explode('-', $base, 2);
            $timestamp = $parts[0];
            $timestamp = intval($timestamp, 16);
            if (abs($timestamp - $now) > $Auth_OpenID_SKEW) {
                Auth_OpenID_FileStore::_removeIfPresent($nonce_fname);
                $removed += 1;
            }
        }
        return $removed;
    }

Here is the call graph for this function:

destroy()

Auth_OpenID_FileStore::destroy

(

)

Definition at line 77 of file FileStore.php.

References _rmtree().

    {
        Auth_OpenID_FileStore::_rmtree($this->directory);
        $this->active = false;
    }

Here is the call graph for this function:

getAssociation()

Auth_OpenID_FileStore::getAssociation	(		$server_url,
			$handle = null
	)

Retrieve an association.

If no handle is specified, return the association with the most recent issue time.

Returns

mixed $association

Definition at line 232 of file FileStore.php.

References $filename, _getAssociation(), _listdir(), and getAssociationFilename().

Referenced by removeAssociation().

    {
        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return null;
        }

        if ($handle === null) {
            $handle = '';
        }

        // The filename with the empty handle is a prefix of all other
        // associations for the given server URL.
        $filename = $this->getAssociationFilename($server_url, $handle);

        if ($handle) {
            return $this->_getAssociation($filename);
        } else {
            $association_files =
                Auth_OpenID_FileStore::_listdir($this->association_dir);
            $matching_files = array();

            // strip off the path to do the comparison
            $name = basename($filename);
            foreach ($association_files as $association_file) {
                $base = basename($association_file);
                if (strpos($base, $name) === 0) {
                    $matching_files[] = $association_file;
                }
            }

            $matching_associations = array();
            // read the matching files and sort by time issued
            foreach ($matching_files as $full_name) {
                $association = $this->_getAssociation($full_name);
                if ($association !== null) {
                    $matching_associations[] = array($association->issued,
                                                     $association);
                }
            }

            $issued = array();
            $assocs = array();
            foreach ($matching_associations as $key => $assoc) {
                $issued[$key] = $assoc[0];
                $assocs[$key] = $assoc[1];
            }

            array_multisort($issued, SORT_DESC, $assocs, SORT_DESC,
                            $matching_associations);

            // return the most recently issued one.
            if ($matching_associations) {
                list($issued, $assoc) = $matching_associations[0];
                return $assoc;
            } else {
                return null;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssociationFilename()

Auth_OpenID_FileStore::getAssociationFilename	(		$server_url,
			$handle
	)

Create a unique filename for a given server url and handle.

This implementation does not assume anything about the format of the handle. The filename that is returned will contain the domain name from the server URL for ease of human inspection of the data directory.

Returns

string $filename

Definition at line 150 of file FileStore.php.

References $filename, $rest, _filenameEscape(), and _safe64().

Referenced by getAssociation(), removeAssociation(), and storeAssociation().

    {
        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return null;
        }

        if (strpos($server_url, '://') === false) {
            trigger_error(sprintf("Bad server URL: %s", $server_url),
                          E_USER_WARNING);
            return null;
        }

        list($proto, $rest) = explode('://', $server_url, 2);
        $parts = explode('/', $rest);
        $domain = Auth_OpenID_FileStore::_filenameEscape($parts[0]);
        $url_hash = Auth_OpenID_FileStore::_safe64($server_url);
        if ($handle) {
            $handle_hash = Auth_OpenID_FileStore::_safe64($handle);
        } else {
            $handle_hash = '';
        }

        $filename = sprintf('%s-%s-%s-%s', $proto, $domain, $url_hash,
                            $handle_hash);

        return $this->association_dir. DIRECTORY_SEPARATOR . $filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeAssociation()

Auth_OpenID_FileStore::removeAssociation	(		$server_url,
			$handle
	)

Remove an association if it exists.

Do nothing if it does not.

Returns

bool $success

Definition at line 338 of file FileStore.php.

References $filename, _removeIfPresent(), getAssociation(), and getAssociationFilename().

    {
        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return null;
        }

        $assoc = $this->getAssociation($server_url, $handle);
        if ($assoc === null) {
            return false;
        } else {
            $filename = $this->getAssociationFilename($server_url, $handle);
            return Auth_OpenID_FileStore::_removeIfPresent($filename);
        }
    }

Here is the call graph for this function:

storeAssociation()

Auth_OpenID_FileStore::storeAssociation	(		$server_url,
			$association
	)

Store an association in the association directory.

Definition at line 182 of file FileStore.php.

References $filename, _mktemp(), _removeIfPresent(), and getAssociationFilename().

    {
        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return false;
        }

        $association_s = $association->serialize();
        $filename = $this->getAssociationFilename($server_url,
                                                  $association->handle);
        list($tmp_file, $tmp) = $this->_mktemp();

        if (!$tmp_file) {
            trigger_error("_mktemp didn't return a valid file descriptor",
                          E_USER_WARNING);
            return false;
        }

        fwrite($tmp_file, $association_s);

        fflush($tmp_file);

        fclose($tmp_file);

        if (@rename($tmp, $filename)) {
            return true;
        } else {
            // In case we are running on Windows, try unlinking the
            // file in case it exists.
            @unlink($filename);

            // Now the target should not exist. Try renaming again,
            // giving up if it fails.
            if (@rename($tmp, $filename)) {
                return true;
            }
        }

        // If there was an error, don't leave the temporary file
        // around.
        Auth_OpenID_FileStore::_removeIfPresent($tmp);
        return false;
    }

Here is the call graph for this function:

useNonce()

Auth_OpenID_FileStore::useNonce	(		$server_url,
			$timestamp,
			$salt
	)

Return whether this nonce is present.

As a side effect, mark it as no longer present.

Returns

bool $present

Definition at line 360 of file FileStore.php.

References $Auth_OpenID_SKEW, $filename, $rest, $result, $timestamp, _filenameEscape(), and _safe64().

    {
        global $Auth_OpenID_SKEW;

        if (!$this->active) {
            trigger_error("FileStore no longer active", E_USER_ERROR);
            return null;
        }

        if ( abs($timestamp - time()) > $Auth_OpenID_SKEW ) {
            return false;
        }

        if ($server_url) {
            list($proto, $rest) = explode('://', $server_url, 2);
        } else {
            $proto = '';
            $rest = '';
        }

        $parts = explode('/', $rest, 2);
        $domain = $this->_filenameEscape($parts[0]);
        $url_hash = $this->_safe64($server_url);
        $salt_hash = $this->_safe64($salt);

        $filename = sprintf('%08x-%s-%s-%s-%s', $timestamp, $proto,
                            $domain, $url_hash, $salt_hash);
        $filename = $this->nonce_dir . DIRECTORY_SEPARATOR . $filename;

        $result = @fopen($filename, 'x');

        if ($result === false) {
            return false;
        } else {
            fclose($result);
            return true;
        }
    }

Here is the call graph for this function:

---

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

• Services/OpenId/lib/Auth/OpenID/FileStore.php