Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Mountable Rails engine that provides OpenID server/identity provider functionality
Ruby
branch: rails_4

This branch is 5 commits ahead, 18 commits behind dennisreimann:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
db/migrate
lib
script
test
.gitignore
.travis.yml
Gemfile
Gemfile.lock
Guardfile
MIT-LICENSE
README.md
Rakefile
masq.gemspec

README.md

Masq OpenID Server

Build Status

Masq is a mountable Rails engine that provides OpenID server/identity provider functionality. It is the successor of the stand-alone Rails application masquerade.

The project is released under the MIT-License and its source code is available at GitHub. Feel free to fork and submit patches :)

Installation

If you want to upgrade from masquerade, please skip this part and see the Upgrading section below

  1. In case you want to run masq as a standalone application (not integrated into an existing app), you will have to generate a barebone Rails app first:

    • rails new my_openid_provider
  2. Add masq to your Gemfile and install it:

    • gem 'masq'
    • bundle install
  3. Copy the configuration and edit it:

    • bundle exec rake masq:install:config
    • $EDITOR config/masq.yml
  4. Copy the migrations and migrate:

    • bundle exec rake masq:install:migrations
    • bundle exec rake db:migrate
  5. Configure the routes by mounting the masq engine:

    • For integration into an existing app, mount it in a subdirectory, like:
      • mount Masq::Engine => "/masq" or
      • mount Masq::Engine => "/openid"
    • Standalone installation, mount it at the root:
      • mount Masq::Engine => "/"

Upgrading from masquerade

  1. Generate a barebone Rails app:

    • rails new my_openid_provider
  2. Add masq to your Gemfile and install it:

    • gem 'masq'
    • bundle install
  3. Copy your existing masquerade config file from config/app_config.yml to the new apps config/masq.yml

  4. Copy the migrations and migrate:

    • PLEASE BACKUP YOUR DATABASE FIRST!
    • bundle exec rake masq:install:migrations
    • bundle exec rake db:migrate
  5. Configure the routes by mounting the masq engine:

    Rails.application.routes.draw do
      mount Masq::Engine => "/"
    end
    

Testing the installation

You can test the functionality in your local environment starting two instances: One as your Identity Provider/OpenID Server and another one as Relying Party.

* `rails server`
* `rails server -p 3001`

Open your browser with these urls (assumes you mounted the engine at /masq):

* [http://localhost:3000/masq](http://localhost:3000/masq) (Identity Provider)
* [http://localhost:3001/masq/consumer](http://localhost:3001/masq/consumer) (Relying Party testsuite)

First you have to create an account at the Identity Provider, after that you will be able to use the issued OpenID URL (http://localhost:3000/masq/YOUR_LOGIN) to send requests from the Relying Party to the server.

Use the options provided by the OpenID verification form to test several aspects of the client-server communication (like requesting simple registration data).

Development

Introduction

The main functionality is in the server controller, which is the endpoint for incoming OpenID requests. The server controller is supposed to only interact with relying parties a.k.a. consumer websites. It includes the OpenidServerSystem module, which provides some handy methods to access and answer OpenID requests.

Testing

You can run the tests with Rake: * DB_ADAPTER=sqlite3 bundle exec rake app:masq:test:ci * DB_ADAPTER=mysql2 bundle exec rake app:masq:test:ci * DB_ADAPTER=postgresql bundle exec rake app:masq:test:ci

The Rake task configures the database.yml for the chosen adapter.

In case you prefer running the tests continuously, use Guard: * bundle exec guard

Contact

Dennis Reimann: mail@dennisreimann.de

Something went wrong with that request. Please try again.