Class Auth_OpenID_FileStore

This is a filesystem-based store for OpenID associations and nonces. This store should be safe for use in concurrent systems on both windows and unix (excluding NFS filesystems). There are a couple race conditions in the system, but those failure cases have been set up in such a way that the worst-case behavior is someone having to try to log in a second time.

Most of the methods of this class are implementation details. People wishing to just use this store need only pay attention to the constructor.

Auth_OpenID_OpenIDStore

Auth_OpenID_FileStore

Package: OpenID
Copyright: 2005-2008 Janrain, Inc.
License: Apache
Author: JanRain, Inc. openid@janrain.com
Located at zp-extensions/federated_logon/Auth/OpenID/FileStore.php

Methods summary
`public`	# `Auth_OpenID_FileStore( string $directory )` Initializes a new `Auth_OpenID_FileStore`. This initializes the nonce and association directories, which are subdirectories of the directory passed in. Initializes a new `Auth_OpenID_FileStore`. This initializes the nonce and association directories, which are subdirectories of the directory passed in. Parameters `$directory` This is the directory to put the store directories in.
`public`	# `destroy( )`
`public`	# `_setup( )` Make sure that the directories in which we store our data exist. Make sure that the directories in which we store our data exist.
`public array`	# `_mktemp( )` Create a temporary file on the same filesystem as $this->association_dir. 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)
`public`	# `cleanupNonces( )` Overrides `Auth_OpenID_OpenIDStore::cleanupNonces()`
`public string`	# `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. 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
`public`	# `storeAssociation( string $server_url, Association $association )` Store an association in the association directory. Store an association in the association directory. Parameters `$server_url` The URL of the identity server that this association is with. Because of the way the server portion of the library uses this interface, don't assume there are any limitations on the character set of the input string. In particular, expect to see unescaped non-url-safe characters in the server_url field. `$association` The Association to store. Overrides `Auth_OpenID_OpenIDStore::storeAssociation()`
`public mixed`	# `getAssociation( string $server_url, mixed $handle = null )` Retrieve an association. If no handle is specified, return the association with the most recent issue time. Retrieve an association. If no handle is specified, return the association with the most recent issue time. Parameters `$server_url` The URL of the identity server to get the association for. Because of the way the server portion of the library uses this interface, don't assume there are any limitations on the character set of the input string. In particular, expect to see unescaped non-url-safe characters in the server_url field. `$handle` This optional parameter is the handle of the specific association to get. If no specific handle is provided, any valid association matching the server URL is returned. Returns mixed $association Overrides `Auth_OpenID_OpenIDStore::getAssociation()`
`public`	# `_getAssociation( $filename )`
`public boolean`	# `removeAssociation( string $server_url, string $handle )` Remove an association if it exists. Do nothing if it does not. Remove an association if it exists. Do nothing if it does not. Parameters `$server_url` The URL of the identity server the association to remove belongs to. Because of the way the server portion of the library uses this interface, don't assume there are any limitations on the character set of the input string. In particular, expect to see unescaped non-url-safe characters in the server_url field. `$handle` This is the handle of the association to remove. If there isn't an association found that matches both the given URL and handle, then there was no matching handle found. Returns boolean $success Overrides `Auth_OpenID_OpenIDStore::removeAssociation()`
`public boolean`	# `useNonce( string $server_url, $timestamp, $salt )` Return whether this nonce is present. As a side effect, mark it as no longer present. Return whether this nonce is present. As a side effect, mark it as no longer present. Parameters `$server_url` $nonce The nonce to use. `$timestamp` `$salt` Returns boolean $present Overrides `Auth_OpenID_OpenIDStore::useNonce()`
`public`	# `_allAssocs( )` Remove expired entries from the database. This is potentially expensive, so only run when it is acceptable to take time. Remove expired entries from the database. This is potentially expensive, so only run when it is acceptable to take time.
`public`	# `clean( )`
`public`	# `_rmtree( $dir )`
`public`	# `_mkstemp( $dir )`
`public static`	# `_mkdtemp( $dir )`
`public`	# `_listdir( $dir )`
`public`	# `_isFilenameSafe( $char )`
`public`	# `_safe64( $str )`
`public`	# `_filenameEscape( $str )`
`public boolean`	# `_removeIfPresent( $filename )` Attempt to remove a file, returning whether the file existed at the time of the call. Attempt to remove a file, returning whether the file existed at the time of the call. Returns boolean $result True if the file was present, false if not.
`public`	# `cleanupAssociations( )` Overrides `Auth_OpenID_OpenIDStore::cleanupAssociations()`

Methods inherited from Auth_OpenID_OpenIDStore
`cleanup(), reset(), supportsCleanup()`

Packages

Classes

Functions

Class Auth_OpenID_FileStore

Parameters

Returns

Overrides

Returns

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides