ruby-saml-idp 0.2.5 → 0.2.6

data/README.md

@@ -1,8 +1,8 @@
-# Ruby SAML IdP [![Build Status](https://secure.travis-ci.org/lawrencepit/ruby-saml-idp.png)](http://travis-ci.org/lawrencepit/ruby-saml-idp?branch=master) [![Dependency Status](https://gemnasium.com/lawrencepit/ruby-saml-idp.png)](https://gemnasium.com/lawrencepit/ruby-saml-idp)
+# Ruby SAML Idendity Provider (IdP) [![Build Status](https://secure.travis-ci.org/lawrencepit/ruby-saml-idp.png)](http://travis-ci.org/lawrencepit/ruby-saml-idp?branch=master) [![Dependency Status](https://gemnasium.com/lawrencepit/ruby-saml-idp.png)](https://gemnasium.com/lawrencepit/ruby-saml-idp)
 
-The Ruby SAML IdP library is for implementing the server side of SAML authentication. It allows your application to act as an IdP (Identity Provider) using the [SAML v2.0](http://en.wikipedia.org/wiki/Security_Assertion_Markup_Language) protocol. It provides a means for managing authentication requests and confirmation responses for SPs (Service Providers).
+The ruby SAML Identity Provider library is for implementing the server side of SAML authentication. It allows your application to act as an IdP (Identity Provider) using the [SAML v2.0](http://en.wikipedia.org/wiki/Security_Assertion_Markup_Language) protocol. It provides a means for managing authentication requests and confirmation responses for SPs (Service Providers).
 
-Setting up a "real" IdP is such an undertaking I didn't care for such an achievement. I wanted something very simple that just works without having to install extra components. In it's current form it's very basic. This is because currently I use it for manual and end-to-end testing purposes only. It is reversed engineered from real-world SAML Responses send by ADFS systems.
+Setting up a "real" IdP is such an undertaking I didn't care for such an achievement. I wanted something very simple that just works without having to install extra components and setup extra infrastructure. In it's current form it's basic. This is because currently I use it for manual and end-to-end testing purposes of the Service Provider side only. It is reversed engineered from real-world SAML Responses sent by ADFS systems.
 
 
 Installation and Usage
@@ -14,7 +14,11 @@ Add this to your Gemfile:
 
 ### Not using rails?
 
-Include `SamlIdp::Controller` and see the examples that use rails. It should be straightforward for you. Basically you call `decode_SAMLRequest(params[:SAMLRequest])` and then use the value `saml_acs_url` to determine the source for which you need to authenticate a user. Once a user has successfully authenticated on your system send the Service Provider a SAMLReponse by posting to `saml_acs_url` the parameter `SAMLResponse` with the return value from a call to `encode_SAMLResponse(user_email)`
+Include `SamlIdp::Controller` and see the examples that use rails. It should be straightforward for you.
+
+Basically you call `decode_SAMLRequest(params[:SAMLRequest])` on an incoming request and then use the value `saml_acs_url` to determine the source for which you need to authenticate a user. How you authenticate a user is entirely up to you.
+
+Once a user has successfully authenticated on your system send the Service Provider a SAMLReponse by posting to `saml_acs_url` the parameter `SAMLResponse` with the return value from a call to `encode_SAMLResponse(user_email)`.
 
 ### Using rails?
 
@@ -56,7 +60,7 @@ end
 Keys and Secrets
 ----------------
 
-To generate the SAML Response it uses a default X.509 certificate and secret key... which isn't so secret. You can find them in `SamlIdp::Default`. The X.509 certificate is valid until year 2032. Obviously you shouldn't use these if you intend to use this in production environments. In that case, within the controller set the properties `x509_certificate` and `secret_key` using a `prepend_before_filter` callback within the current request context or set them globally via the `SamlIdp.x509_certificate` and `SamlIdp.secret_key` properties.
+To generate the SAML Response it uses a default X.509 certificate and secret key... which isn't so secret. You can find them in `SamlIdp::Default`. The X.509 certificate is valid until year 2032. Obviously you shouldn't use these if you intend to use this in production environments. In that case, within the controller set the properties `x509_certificate` and `secret_key` using a `prepend_before_filter` callback within the current request context or set them globally via the `SamlIdp.config.x509_certificate` and `SamlIdp.config.secret_key` properties.
 
 The fingerprint to use, if you use the default X.509 certificate of this gem, is:
 

data/app/controllers/saml_idp/idp_controller.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module SamlIdp
   class IdpController < ActionController::Base
     include SamlIdp::Controller

data/lib/ruby-saml-idp.rb

@@ -1,24 +1,18 @@
+# encoding: utf-8
 module SamlIdp
-  autoload :Controller,   'saml-idp/controller'
-  autoload :Default,      'saml-idp/default'
-  autoload :Engine,       'saml-idp/engine'
-  autoload :Version,      'saml-idp/version'
+  require 'saml-idp/configurator'
+  require 'saml-idp/controller'
+  require 'saml-idp/default'
+  require 'saml-idp/version'
+  require 'saml-idp/engine' if defined?(::Rails) && Rails::VERSION::MAJOR > 2
 
-  def self.x509_certificate
-    @@x509_certificate
+  def self.config=(config)
+    @config = config
   end
-  def self.x509_certificate=(x509_certificate)
-    @@x509_certificate = x509_certificate
-  end
-  @@x509_certificate = Default::X509_CERTIFICATE
 
-  def self.secret_key
-    @@secret_key
-  end
-  def self.secret_key=(secret_key)
-    @@secret_key = secret_key
+  def self.config
+    @config ||= SamlIdp::Configurator.new
   end
-  @@secret_key = Default::SECRET_KEY
 
 end
 

data/lib/saml-idp/configurator.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module SamlIdp
+  class Configurator
+    attr_accessor :x509_certificate, :secret_key
+
+    def initialize(config_file = nil)
+      self.x509_certificate = Default::X509_CERTIFICATE
+      self.secret_key = Default::SECRET_KEY
+      instance_eval(File.read(config_file), config_file) if config_file
+    end
+  end
+end

data/lib/saml-idp/controller.rb

@@ -1,24 +1,21 @@
-require 'openssl'
-require 'base64'
-require 'time'
-
+# encoding: utf-8
 module SamlIdp
   module Controller
+    require 'openssl'
+    require 'base64'
+    require 'time'
 
     attr_accessor :x509_certificate, :secret_key
-
-    def saml_acs_url
-      @saml_acs_url
-    end
+    attr_accessor :saml_acs_url
 
     def x509_certificate
       return @x509_certificate if defined?(@x509_certificate)
-      @x509_certificate = SamlIdp.x509_certificate
+      @x509_certificate = SamlIdp.config.x509_certificate
     end
 
     def secret_key
       return @secret_key if defined?(@secret_key)
-      @secret_key = SamlIdp.secret_key
+      @secret_key = SamlIdp.config.secret_key
     end
 
     protected

data/lib/saml-idp/default.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module SamlIdp
   module Default
 

data/lib/saml-idp/engine.rb

@@ -1,4 +1,5 @@
+# encoding: utf-8
 module SamlIdp
   class Engine < Rails::Engine
   end
-end if defined?(::Rails) && Rails::VERSION::MAJOR > 2
+end

data/lib/saml-idp/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module SamlIdp
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/ruby-saml-idp.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors = ["Lawrence Pit"]
   s.email = %q{lawrence.pit@gmail.com}
   s.homepage = %q{http://github.com/lawrencepit/ruby-saml-idp}
-  s.summary = %q{SAML IdP in ruby}
-  s.description = %q{SAML Identity Provider library in ruby}
+  s.summary = %q{SAML Indentity Provider in ruby}
+  s.description = %q{SAML IdP (Identity Provider) library in ruby}
   s.date = Time.now.utc.strftime("%Y-%m-%d")
   s.files = Dir.glob("app/**/*") + Dir.glob("lib/**/*") + [
      "MIT-LICENSE",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-saml-idp
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Lawrence Pit
@@ -73,7 +73,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: SAML Identity Provider library in ruby
+description: SAML IdP (Identity Provider) library in ruby
 email: lawrence.pit@gmail.com
 executables: []
 
@@ -86,6 +86,7 @@ files:
 - app/views/saml_idp/idp/new.html.erb
 - app/views/saml_idp/idp/saml_post.html.erb
 - lib/ruby-saml-idp.rb
+- lib/saml-idp/configurator.rb
 - lib/saml-idp/controller.rb
 - lib/saml-idp/default.rb
 - lib/saml-idp/engine.rb
@@ -128,7 +129,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: SAML IdP in ruby
+summary: SAML Indentity Provider in ruby
 test_files: 
 - spec/controller_spec.rb
 - spec/spec_helper.rb