Package openid :: Package server :: Module server
[frames] | no frames]

Module server

source code

OpenID server protocol and logic.

Overview

An OpenID server must perform three tasks:
  • Examine the incoming request to determine its nature and validity.
  • Make a decision about how to respond to this request.
  • Format the response according to the protocol.
  • The first and last of these tasks may performed by the decodeRequest and encodeResponse methods of the Server object. Who gets to do the intermediate task -- deciding how to respond to the request -- will depend on what type of request it is.

    If it's a request to authenticate a user (a checkid_setup or checkid_immediate request), you need to decide if you will assert that this user may claim the identity in question. Exactly how you do that is a matter of application policy, but it generally involves making sure the user has an account with your system and is logged in, checking to see if that identity is hers to claim, and verifying with the user that she does consent to releasing that information to the party making the request.

    Examine the properties of the CheckIDRequest object, and if and when you've come to a decision, form a response by calling CheckIDRequest.answer.

    Other types of requests relate to establishing associations between client and server and verifying the authenticity of previous communications. Server contains all the logic and data necessary to respond to such requests; just pass it to Server.handleRequest.

    OpenID Extensions

    Do you want to provide other information for your users in addition to authentication? Version 1.2 of the OpenID protocol allows consumers to add extensions to their requests. For example, with sites using the Simple Registration Extension, a user can agree to have their nickname and e-mail address sent to a site when they sign up.

    Since extensions do not change the way OpenID authentication works, code to handle extension requests may be completely separate from the OpenIDRequest class here. But you'll likely want data sent back by your extension to be signed. OpenIDResponse provides methods with which you can add data to it which can be signed with the other data in the OpenID signature.

    For example:
       # when request is a checkid_* request
       response = request.answer(True)
       # this will a signed 'openid.sreg.timezone' parameter to the response
       response.addField('sreg', 'timezone', 'America/Los_Angeles')
    

    Stores

    The OpenID server needs to maintain state between requests in order to function. Its mechanism for doing this is called a store. The store interface is defined in openid.store.interface.OpenIDStore. Additionally, several concrete store implementations are provided, so that most sites won't need to implement a custom store. For a store backed by flat files on disk, see openid.store.filestore.FileOpenIDStore. For stores based on MySQL or SQLite, see the openid.store.sqlstore module.

    Upgrading

    The keys by which a server looks up associations in its store have changed in version 1.2 of this library. If your store has entries created from version 1.0 code, you should empty it.

    Classes [hide private]
      PlainTextServerSession
    An object that knows how to handle association requests with no session type.
      DiffieHellmanServerSession
    An object that knows how to handle association requests with the Diffie-Hellman session type.
      WebResponse
    I am a response to an OpenID request in terms a web server understands.
      Signatory
    I sign things.
      Encoder
    I encode responses in to WebResponses.
      SigningEncoder
    I encode responses in to WebResponses, signing them when required.
      Decoder
    I decode an incoming web request in to a OpenIDRequest.
      Server
    I handle requests for an OpenID server.
      ProtocolError
    A message did not conform to the OpenID protocol.
      EncodingError
    Could not encode this as a protocol message.
      AlreadySigned
    This response is already signed.
      UntrustedReturnURL
    A return_to is outside the trust_root.
      MalformedReturnURL
    The return_to URL doesn't look like a valid URL.
      MalformedTrustRoot
    The trust root is not well-formed.
        Requests
      OpenIDRequest
    I represent an incoming OpenID request.
      CheckAuthRequest
    A request to verify the validity of a previous response.
      AssociateRequest
    A request to establish an association.
      CheckIDRequest
    A request to confirm the identity of a user.
        Responses
      OpenIDResponse
    I am a response to an OpenID request.

    Variables [hide private]
      BROWSER_REQUEST_MODES = ['checkid_setup', 'checkid_immediate']
      OPENID_PREFIX = 'openid.'
        HTTP Codes
      HTTP_OK = 200
      HTTP_REDIRECT = 302
      HTTP_ERROR = 400
        Response Encodings
      ENCODE_KVFORM = ('kvform',)
      ENCODE_URL = ('URL/redirect',)

    Variables Details [hide private]

    HTTP_OK

    Value:
    200                                                                   
          

    HTTP_REDIRECT

    Value:
    302                                                                   
          

    HTTP_ERROR

    Value:
    400                                                                   
          

    BROWSER_REQUEST_MODES

    Value:
    ['checkid_setup', 'checkid_immediate']                                 
          

    OPENID_PREFIX

    Value:
    'openid.'                                                              
          

    ENCODE_KVFORM

    Value:
    ('kvform',)                                                            
          

    ENCODE_URL

    Value:
    ('URL/redirect',)