OpenID Consumer

A Ruby library for verifying and serving OpenID identities.

This library is a port of the Python OpenID library. See www.openidenabled.com/openid/libraries/python for more info on the Python library.

Features

• Easy to use API for verifying OpenID identites - OpenID::OpenIDConsumer
• New support for serving OpenID identites - OpenID::OpenIDServer
• Does not depend on underlying web framework
• Supports multiple storage mechanisms (Filesystem, SQL)
• Example code to help you get started, including:
  • WEBrick based consumer
  • Ruby on rails based consumer
  • Ruby on rails based server
  • OpeIDLoginGenerator for quickly getting creating a rails app that uses OpenID for authentication
  • ActiveRecord adapter for using an SQL store in rails
• Comprehensive test suite

Installing

Before running the examples or writing your own code you‘ll need to install the library. See the INSTALL file.

The library has been tested using Ruby 1.8, though it may work with earlier versions. Examples were tested with Rails 1.0.

Getting Started with OpenID::OpenIDConsumer

OpenID::OpenIDConsumer is the place to start if you‘d like to support OpenID login or verification on your website. The examples contains several working examples to help you get started, and the OpenID::OpenIDConsumer class is well documented.

Serving OpenID with OpenID::OpenIDServer

The examples directory contains fully functional OpenID server that uses the Ruby on Rails framework. Start by reading about the OpenID::OpenIDServer interface documentation and looking at the example.

Homepage

www.openidenabled.com/openid/libraries/ruby

Author

Copyright 2006, Janrain, Inc. Contact Brian Ellin: brian -at- janrain -dot- com

License

LGPL. For more information see the COPYING file.