saml_camel 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60103dee96fb0b95caeb04551deac81568e5149a
-  data.tar.gz: eb15b9fc8c642e88bf0ff8be268f206de1be3b73
+  metadata.gz: ce19d32b4ed9a740fc2af74f8ee5153b1605c6b7
+  data.tar.gz: 8c239788aca69ceefe788cc2112525160fe35d86
 SHA512:
-  metadata.gz: acda10e48b2cabdb24f187ffaf3fde6dbb5992efe032f56ca623098999b754c9094fe94271cbeac50097f00679a87710db95ebe96be7a22b0904607a7b62c165
-  data.tar.gz: 8ea077c92e5d0fcf0df9bcae2d086a5635152ceb3d37afbc7a0e7e4777a3d9dda32b651280d9bc54f12ecdf4f859c640c658e68ff972521d0473e25f9d465233
+  metadata.gz: f8a289587609b90ded6d97d4d878d23c9f6f382b8870d45ae69f1fd694f0679dc132fd86dc0bdd2b379da3e7574272ad969a6e3ec86ba1ac6dc7a1d7ced2ee26
+  data.tar.gz: 7a6aa2ebb91f906ac537e6e2204fd17d3ce1add3f95555e0dd80194b1b77f8b35a5fbf07f08d4cd19d617cf118637780e4c6a368ed707cb29ea608f143d07093

data/README.md

@@ -14,24 +14,25 @@ $ bundle
 
 
 ## Usage
-### IMPORTANT!
+### IMPORTANT: This step enables security features and is required to use the gem!
 1. in your environments config (`config/development.rb` for example) ensure that you have caching configured as follows
+**note** use ths cache_store most appropriate for your situation. It may make more sense to use a file store, or a redis server
 ```ruby
   config.action_controller.perform_caching = true
   config.cache_store = :memory_store
 ```
 
-1. run `rake saml_camel:generate_saml` to generate metadata files for each environment. you can also specify a specifc/custom environment like this `rake saml_camel:generate_saml  environment=acceptance`
+1. run `rake saml_camel:generate_saml` to generate metadata files for each environment. you can also specify a custom environment like this `rake saml_camel:generate_saml environment=acceptance`
 
-**Note: these steps will use development as an example, if you use seperate metadata per environemtn, you will repeat each step for your chosed environement**
+**Note: these steps will use development as an example, if you use separate metadata per environment, you will repeat each step for your chosen environment**
 
 2. from the root of your app open `saml/development/settings.json` and specify an entity ID of your choice. this is a unique identifier used by the
-Identity Provider(idp) to recognize your app. Typically it should take the form of a url, however note that it is just an identifier and does not have to be routeable (e.g. https://my-app-name/not/a/real/route)
+Identity Provider(idp) to recognize your app. Typically it should take the form of a url, however note that it is just an identifier and does not have to resolve (e.g. https://my-app-name/not/a/real/route)
 
-3. Go to https://idms-web.oit.duke.edu/spreg/sps and register your metadata with the identity provider. You will need the values from `saml/development/settings.json` in addition to the `saml/development/saml_certificate.crt`
+3. Go to https://authentication.oit.duke.edu/manager/register/sp and register your metadata with the identity provider. You will need the values from `saml/development/settings.json` in addition to the `saml/development/saml_certificate.crt`
 
   - copy the entity_id you chose in the `settings.json` file and paste it into the "Entity Field"
-  - fill out functional purpose, responsible dept, function owner dept, and audience with information relevent to your application
+  - fill out functional purpose, responsible dept, function owner dept, and audience with information relevant to your application
   - copy the cert from `saml/development/saml_certificate.crt` and paste it into the Certificate Field
   - copy the acs value and paste it into the Location field in the Assertion Consumer Service box
     - note that the default host value for ACS is `http://locahost:3000` which is the default `rails s` host. If you're using a differnet host (such as in production or using docker) you will want to replace the host value with what is relevent for your situation(*e.g. https://my-app.duke.edu/saml/consumeSaml*), but keep the path `/saml/consumeSaml`
@@ -41,15 +42,8 @@ Identity Provider(idp) to recognize your app. Typically it should take the form
 mount SamlCamel::Engine, at: "/saml"
 ```
 
-5. include saml helpers in `app/controllers/application_controller.rb`
-```ruby
-class ApplicationController < ActionController::Base
-  include SamlCamel::SamlHelpers
-end
-```
-
-6. now simply provide the `saml protect` method in your controllers (via `before_action`) to protect paths
 
+6. now simply provide the `saml_protect` method in your controllers (via `before_action`) to protect paths
 ```ruby
 class DashboardController < ApplicationController
   before_action :saml_protect, except: [:home]
@@ -68,7 +62,7 @@ end
 
 7. response attributes found in `session[:saml_attributes]`
 
-8. It is recommended to set   `config.force_ssl = true` in the `config/environments/production.rb` file
+8. It is recommended to set `config.force_ssl = true` in the `config/environments/production.rb` file for security
 
 
 9. Logging is turned on by default. Logging is configured in `saml/development/settings.json`. To utilize logging saml_logging should be set to true (default), and primary_id must have a value. primary_id is the saml attribute you consider to be a primary identifier for a user

data/app/controllers/saml_camel/application_controller.rb

@@ -1,5 +1,8 @@
 module SamlCamel
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception
+    def saml_stuff
+      puts "boo" * 80
+    end
   end
 end

data/app/controllers/saml_camel/saml_controller.rb

@@ -19,8 +19,10 @@ module SamlCamel
       permit_key = session[:session_id].to_sym
       redirect_path = Rails.cache.fetch(permit_key)[:redirect_url]
       Rails.cache.delete(permit_key) #we no longer need cache at this stage
+
       response          = OneLogin::RubySaml::Response.new(params[:SAMLResponse], :settings => saml_settings)
       response.settings = saml_settings
+
       if response.is_valid? # validate the SAML Response
         # authorize_success, log the user
         session[:saml_success] = true
@@ -29,7 +31,7 @@ module SamlCamel
         session[:saml_attributes] = SamlCamel::Transaction.map_attributes(response.attributes)
         SamlCamel::Logging.successfull_auth(session[:saml_attributes])
 
-        #TODO account for nil redirect
+
         redirect_to redirect_path
       else # otherwise list out the errors in the response
         permit_key = session[:session_id].to_sym
@@ -39,7 +41,7 @@ module SamlCamel
         response.errors
         SamlCamel::Logging.auth_failure(response.errors)
 
-        redirect_to main_app.try('root_path')
+        redirect_to action: "failure", locals:{errors: response.errors}
       end
     rescue => e
       permit_key = session[:session_id].to_sym

data/lib/saml_camel/engine.rb

@@ -6,9 +6,7 @@ module SamlCamel
     isolate_namespace SamlCamel
 
     config.to_prepare do
-      Dir.glob(Rails.root + "app/decorators/**/*_decorator*.rb").each do |c|
-        require_dependency(c)
-      end
+      ActionController::Base.include SamlCamel::SamlHelpers
     end
 
   end

data/lib/saml_camel/version.rb

@@ -1,3 +1,3 @@
 module SamlCamel
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saml_camel
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - 'Danai Adkisson '
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails