Class OpenID::GenericConsumer
In: lib/openid/consumer.rb
Parent: Object

This class implements the common logic for OpenID consumers. It is used by the higher level OpenID::Consumer class. Only advanced users with special needs should ever have to look at this class.

The only part of the library which has to be used and isn‘t documented in full here is the store required to create an OpenID::Consumer instance. More on the abstract store type and concrete implementations of it that are provided in the documentation of OpenID::Consumer.new

Methods

Attributes

fetcher  [R] 

Public Class methods

Creates a new Consumer instance. You should create a new instance of the Consumer object with every HTTP request. Do not store the instance of it in a global variable somewhere.

store
This must be an object that implements the OpenID::Store interface. Several concrete implementations are provided, to cover most common use cases. We recommend using the simple file based store bundled with the library: OpenID::FilesystemStore.
fetcher
Optional. If provided, this must be an instance that implements Fetcher interface. If no fetcher is provided, an instance of OpenID::StandardFetcher will be created for you automatically.

Public Instance methods

Make the openid.associate call to the server.

See the interface documentation for Consumer.begin_without_discovery for arugumnets and return values of this method. begin_without_discovery is a light wrapper around this method, and the has the same interface.

Set the path to a pem certificate authority file for verifying server certificates during HTTPS. If you are interested in verifying certs like the mozilla web browser, have a look at the files here:

curl.haxx.se/docs/caextract.html

Low level method for performing OpenID check_authenticaion requests

Please see the interface docs for Consumer.complete. This method accpets a service paramter which is provided though the SuccessRequest object generated in the begin call. The service should be stored somewhere in the user‘s session or environment and passed into this method along with the full query string Hash. Consumer.complete has the full list of return values for this method.

Create a nonce and store it for preventing replace attacks.

Low level method for handling the OpenID server response.

Get existing or create a new association (shared secret) with the server at server_url.

[Validate]