Module openid.server.server
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.OpenIDStoreopenid.store.filestore.FileOpenIDStoreopenid.store.sqlstoreUpgrading
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.