Class OpenID::Server::CheckIDRequest
In: lib/openid/server.rb
Parent: OpenIDRequest

Object representing a request to confirm the identity of a user. This object handles requests for openid.mode checkid_immediate, and checkid_setup.

Methods

Attributes

assoc_handle  [RW] 
identity  [RW] 
immediate  [RW] 
mode  [RW] 
query  [RW] 
return_to  [RW] 
trust_root  [RW] 

Public Class methods

Create a CheckIDRequest object from a web query. May raise a ProtocolError if request is a malformed checkid_* reuquest.

Create a new CheckIDRequest instance. Most likely you‘ll want to use CheckIDRequest.from_query to create this object.

Public Instance methods

Generate a response to this checkid_* request.

Paramters

allow
Boolean value stating whether or not to allow this user to "claim" supplied identity and let the consumer have the information. The value of allow should be follow the following algorithm:

The identity URL provided (openid.identity) and available through the identity_url method of this object is owned by the logged in user, and they have approved the consumer receive the identity assertion.

server_url
When an immeditate mode request does not succeed, it gets back a URL where the request may be continued in a not-so-immediate fashion. The URL returned is generated using the supplied server_url here. server_url should be the full URL of you openid server endpoint.

Create the URL to cancel this request. Useful for creating a "Cancel" button on your "approve this openid transaction" form.

Encode this request as a GET URL, returning the URL.

The identity_url which was requested to be verified. Your server should provide a page at identity_url, and be able to assert that the logged in user does or does not "own" that URL. "Owning" an identity_url is in the details of the server account name to URL mapping.

Returns true or false according to whether the return_to is under the supplied trust_root.

[Validate]