rack-saml 0.0.4 → 0.0.5

data/README.md

@@ -90,13 +90,14 @@ Configuration to set SAML parameters. At least, you must configure saml_idp or s
 * *saml_sess_timeout*: SP session timeout (default: 1800 seconds)
 * *shib_app_id*: If you want to use the middleware as Shibboleth SP, you should specify an application ID. In the Shibboleth SP default configuration, 'default' is used as the application ID.
 * *shib_ds*: If you want to use the middleware as Shibboleth SP and use discovery service, specify the uri of the Discovery Service.
+* *saml_sp*: Set the SAML SP's entity ID
 * *sp_cert*: path to the SAML SP's certificate file, e.g. cert.pem (AuthnRequest Signing and Response Encryption are not supported yet)
 * *sp_key*: path to the SAML SP's key file, e.g. key.pem (AuthnRequest Signing and Response Encryption are not supported yet)
 
-SAML SP's entity ID (saml_sp) is automatically generated from request URI and /rack-saml-sp (fixed path name). The Assertion Consumer Service URI is generated from request URI and protected_path.
+If not set explicitly, SAML SP's entity ID (saml_sp) is automatically generated from request URI and /rack-saml-sp (fixed path name). The Assertion Consumer Service URI is generated from request URI and protected_path.
 
     saml_sp_prefix = "#{request.scheme}://#{request.host}#{":#{request.port}" if request.port}#{request.script_name}"
-    @config['saml_sp'] = "#{saml_sp_prefix}/rack-saml-sp"
+    @config['saml_sp'] ||= "#{saml_sp_prefix}/rack-saml-sp"
     @config['assertion_consumer_service_uri'] = "#{saml_sp_prefix}#{@config['protected_path']}"
 
 **metadata.yml**
@@ -152,6 +153,21 @@ Add the following configuration after <rp:DefaultRelyingParty> in relying-party.
       <rp:ProfileConfiguration xsi:type="saml:SAML2SSOProfile" includeAttributeStatement="true" assertionLifetime="PT5M" assertionProxyCount="0" signResponses="never" signAssertions="always" encryptAssertions="never" encryptNameIds="never"/>
     </rp:RelyingParty>
 
+## Advanced Topics
+
+### Use with OmniAuth
+
+You can connect rack-saml to omniauth-shibboleth. Basically, you do not need any specific configuration to use with omniauth-shibboleth.
+
+### Use with Devise
+
+You can connect rack-saml to devise by using it together with omniauth and omniauth-shibboleth. The details of how to connect omniauth and devise are described in the following page:
+
+OmniAuth: Overview
+https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+
+When you use omniauth with devise, the omniauth provider path becomes "/users/auth/shibboleth". So thus, you must set the *protected_path* parameter as "/users/auth/shibboleth/callback". After changing the configuration, you must also re-generate SP Metadata (/Shibboleth.sso/Metadata) and import it to IdP because *<AssertionConsumerService>* parameter in SP Metadata is generated by the *protected_path* parameter.
+
 ## TODO
 
 * write spec files
@@ -159,7 +175,7 @@ Add the following configuration after <rp:DefaultRelyingParty> in relying-party.
 
 ## License (MIT License)
 
-Copyright (C) 2011 by Toyokazu Akiyama.
+rack-saml is released under the MIT license.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/rack/saml.rb

@@ -146,7 +146,7 @@ module Rack
       # saml_sp: SAML SP's entity_id
       # generate saml_sp from request uri and default path (rack-saml-sp)
       saml_sp_prefix = "#{request.scheme}://#{request.host}#{":#{request.port}" if request.port}#{request.script_name}"
-      @config['saml_sp'] = "#{saml_sp_prefix}/rack-saml-sp"
+      @config['saml_sp'] ||= "#{saml_sp_prefix}/rack-saml-sp"
       @config['assertion_consumer_service_uri'] = "#{saml_sp_prefix}#{@config['protected_path']}"
       # for debug
       #return [

data/lib/rack-saml/version.rb

@@ -1,6 +1,6 @@
 require 'rack'
 module Rack
   module Saml
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-saml
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-14 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-saml
-  requirement: &70289036886900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70289036886900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70289036886520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289036886520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SAML middleware for Rack (using ruby-saml)
 email:
 - toyokazu@gmail.com
@@ -99,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: SAML middleware for Rack (using ruby-saml)