Module Hierarchy

• openid: This package is an implementation of the OpenID specification in Python.
  • association: This module contains code for dealing with associations between consumers and servers.
  • consumer: This package contains the portions of the library used only when implementing an OpenID consumer.
    • consumer: This module documents the main interface with the OpenID consumer library.
    • discover
  • dh
  • server: This package contains the portions of the library used only when implementing an OpenID server.
    • server: OpenID server protocol and logic.
    • trustroot: This module contains the TrustRoot class, which helps handle trust root checking.
  • store: This package contains the modules related to this library's use of persistent storage.
    • interface: This module contains the definition of the OpenIDStore interface.
    • filestore: This module contains an OpenIDStore implementation backed by flat files.
    • sqlstore: This module contains OpenIDStore implementations that use various SQL databases to back them.
    • dumbstore: This module contains an OpenIDStore implementation with no persistent backing, for use only by limited consumers.

Class Hierarchy

• __builtin__.object: The most base type
  • openid.association.Association: This class represents an association between a server and a consumer.
  • openid.consumer.consumer.AuthRequest
  • exceptions.BaseException: Common base class for all exceptions
    • exceptions.Exception: Common base class for all non-exit exceptions.
      • openid.server.server.EncodingError: Could not encode this as a protocol message.
        • openid.server.server.AlreadySigned: This response is already signed.
      • openid.server.server.ProtocolError: A message did not conform to the OpenID protocol.
        • openid.server.server.MalformedReturnURL: The return_to URL doesn't look like a valid URL.
        • openid.server.server.MalformedTrustRoot: The trust root is not well-formed.
        • openid.server.server.UntrustedReturnURL: A return_to is outside the trust_root.
  • openid.consumer.consumer.Consumer: An OpenID consumer implementation that performs discovery and does session management.
  • openid.server.server.Decoder: I decode an incoming web request in to a OpenIDRequest.
  • openid.dh.DiffieHellman
  • openid.server.server.DiffieHellmanServerSession: An object that knows how to handle association requests with the Diffie-Hellman session type.
  • openid.server.server.Encoder: I encode responses in to WebResponses.
    • openid.server.server.SigningEncoder: I encode responses in to WebResponses, signing them when required.
  • openid.server.server.OpenIDRequest: I represent an incoming OpenID request.
    • openid.server.server.AssociateRequest: A request to establish an association.
    • openid.server.server.CheckAuthRequest: A request to verify the validity of a previous response.
    • openid.server.server.CheckIDRequest: A request to confirm the identity of a user.
  • openid.server.server.OpenIDResponse: I am a response to an OpenID request.
  • openid.consumer.discover.OpenIDServiceEndpoint: Object representing an OpenID service endpoint.
  • openid.store.interface.OpenIDStore: This is the interface for the store objects the OpenID library uses.
    • openid.store.dumbstore.DumbStore: This is a store for use in the worst case, when you have no way of saving state on the consumer site.
    • openid.store.filestore.FileOpenIDStore: This is a filesystem-based store for OpenID associations and nonces.
    • openid.store.sqlstore.SQLStore: This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores.
      • openid.store.sqlstore.MySQLStore: This is a MySQL-based specialization of SQLStore.
      • openid.store.sqlstore.PostgreSQLStore: This is a PostgreSQL-based specialization of SQLStore.
      • openid.store.sqlstore.SQLiteStore: This is an SQLite-based specialization of SQLStore.
  • openid.server.server.PlainTextServerSession: An object that knows how to handle association requests with no session type.
  • openid.server.server.Server: I handle requests for an OpenID server.
  • openid.server.server.Signatory: I sign things.
  • openid.server.trustroot.TrustRoot: This class represents an OpenID trust root.
  • __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
  • openid.server.server.WebResponse: I am a response to an OpenID request in terms a web server understands.