Package openid :: Package store :: Module filestore :: Class FileOpenIDStore

Class FileOpenIDStore

           object --+    
                    |    
interface.OpenIDStore --+
                        |
                       FileOpenIDStore

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 __init__ method.

Methods of this object can raise OSError if unexpected filesystem conditions, such as bad permissions or missing directories, occur.

Instance Methods

[hide private]

__init__(self, directory)
Initializes a new FileOpenIDStore.

readAuthKey(self)
Read the auth key from the auth key file.

createAuthKey(self)
Generate a new random auth key and safely store it in the location specified by self.auth_key_name.

str getAuthKey(self)
Retrieve the auth key from the file specified by self.auth_key_name, creating it if it does not exist.

getAssociationFilename(self, server_url, handle)
Create a unique filename for a given server url and handle.

NoneType storeAssociation(self, server_url, association)
Store an association in the association directory.

Association or NoneType getAssociation(self, server_url, handle=None)
Retrieve an association.

bool or int removeAssociation(self, server_url, handle)
Remove an association if it exists.

NoneType storeNonce(self, nonce)
Mark this nonce as present.

bool or int useNonce(self, nonce)
Return whether this nonce is present.

clean(self)
Remove expired entries from the database.

Inherited from interface.OpenIDStore: isDumb

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

Inherited from interface.OpenIDStore: AUTH_KEY_LEN

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, directory)
(Constructor)

source code

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

Parameters:

directory (str) - This is the directory to put the store directories in.

Overrides: object.__init__

readAuthKey(self)

source code

Read the auth key from the auth key file. Will return None if there is currently no key.

() -> str or NoneType

createAuthKey(self)

source code

Generate a new random auth key and safely store it in the location specified by self.auth_key_name.

() -> str

getAuthKey(self)

source code

Retrieve the auth key from the file specified by self.auth_key_name, creating it if it does not exist.

() -> str

Returns: str: The key. It should be AUTH_KEY_LEN bytes in length, and use the full range of byte values. That is, it should be treated as a lump of binary data stored in a str instance.

Overrides: interface.OpenIDStore.getAuthKey

getAssociationFilename(self, server_url, handle)

source code

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.

(str, str) -> str