cvaldemar / redmine_saml_auth

Simple SAML authentication for Redmine
9 stars 7 forks source link

= Redmine SAML authentication plugin

This redmine plugin enables SAML authentication using the Onelogin toolkit.

The plugin adds two new routes, for the SAML discovery and consumer actions. The discovery (/auth/saml) initiates the SAML exchange and the consumer (/auth/saml/consumer) recieves the SAML assertion and logs the user in.

NB: Work in progress, but functional, see TODO for where this is heading.

== Installation

  1. Install required gems gem install XMLCanonicalizer gem install ruby-saml
  2. Copy plugin to +vendor/plugins+
  3. Copy +saml_auth.yml.example+ to +config/saml_auth.yml+
  4. Configure +saml_auth.yml+ (see below)
  5. Restart webserver/passenger/mongrel_rails

== Configuration

Open +saml_auth.yml+ and set up the plugin, a sample configuration is provided. Restart passenger/mongrel after changes to configuration.

Use the following routes to configure your IdP

== Notes

Patches, fixes or complete rewrites are welcome ;)

== Todo

== License and copyright

Copyright (c) 2011 Casper Valdemar Poulsen. License follows Redmine - GNU General Public License v2 (GPL).