saml_camel 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db6a8d7294f375eadf0c0358d7e438fb367a2b45
-  data.tar.gz: c89095973afa1aaa726f242cabb7b2d360360f33
+  metadata.gz: 7a2a4e67055ffc48f78dc0139b9c759e2433549c
+  data.tar.gz: e76ae8caa11b55411a315c284fae6d4fe8a38555
 SHA512:
-  metadata.gz: ba097413cf902c8bd2184c64e4fcb87b39027cf223042952732a5022245901196edafd7e3b9c20d9f9e76b76c95eb23bf1eda86f2b3d5c35d9ba814e5b5ad280
-  data.tar.gz: afb5650b0e054af8cb911461b7211106eddb305d994e77c9941738f03f6c085a6a0fa8fe1a05ca1c0fe0d561214ac0304cfeac3bb97a880cee5fd0423b9b7ff7
+  metadata.gz: 9cfb538fa1e85ef6d3089431b4f30e97ce773d4fce4498c9349c602a799427499fbe2cd25f37e0ffb53aee3ae4672210903c00017e97de2eb2580e42a4122374
+  data.tar.gz: 9dd9c2fe2afc86d84bbf4333e57853c546ab76c096d3f08c08b16c4987fb65640e7759ba77d72c86ca61ca2a151d76a2c8b412609f4fe27c2fefcf1dfbd1d043

data/README.md

@@ -3,9 +3,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-source "https://gems-internal.oit.duke.edu" do
   gem 'saml_camel'
-end
 ```
 
 
@@ -46,8 +44,6 @@ end
 6. now simply provide the `saml protect` method in your controllers (via `around_action`) to protect paths
 **NOTE: it is important you MUST use around_action**
 
-7. to logout simply make a post to `localhost:3000/saml/logout`. This will kill the local saml session, and the session with the identity provider. You can specify a return url in `saml/development/settings.json`
-
 ```ruby
 class DashboardController < ApplicationController
   around_action :saml_protect, except: [:home]
@@ -61,8 +57,18 @@ class DashboardController < ApplicationController
 end
 ```
 
+
+7. to logout simply make a post to `localhost:3000/saml/logout`. This will kill the local saml session, and the session with the identity provider. You can specify a return url in `saml/development/settings.json`
+
 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
+
+
+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
+
+10. Users can go to http://localhost:3000/saml/attributes to view attributes being passed through 
+
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/concerns/saml_camel/saml_helpers.rb

@@ -2,6 +2,8 @@ require_dependency "saml_camel/application_controller"
 
 module SamlCamel::SamlHelpers
     extend ActiveSupport::Concern
+    SP_SETTINGS = JSON.parse(File.read("saml/#{Rails.env}/settings.json"))
+
 
     #this generates a call to the idp, which will then be returned to the consume action the in saml_contorller
     def saml_request(host_request)

data/app/controllers/saml_camel/saml_controller.rb

@@ -2,7 +2,9 @@ require_dependency "saml_camel/application_controller"
 
 module SamlCamel
   class SamlController < ApplicationController
+    include SamlCamel::SamlHelpers
     skip_before_action :verify_authenticity_token ,only: [:consume,:logout]
+    around_action :saml_protect, only: [:attr_check]
 
 
     #TODO ROUTABLE STUFF GOES IN THE SHIB CONTROLLER, METHODS CALLED BUT NOT ROUTED GO TO SAML_CONTROLLER
@@ -19,6 +21,7 @@ module SamlCamel
         session[:saml_success] = true
         session[:sp_session] = true
         session[:saml_attributes] = SamlCamel::Transaction.map_attributes(response.attributes)
+        SamlCamel::Logging.successfull_auth(session[:saml_attributes])
 
         #TODO account for nil redirect
         redirect_to cookies.encrypted[:saml_camel_redirect]
@@ -26,11 +29,14 @@ module SamlCamel
         #TODO how do we handle errors?
         session[:saml_success] = false
         response.errors
+        SamlCamel::Logging.auth_failure(response.errors)
+
         redirect_to main_app.try('root_path')
       end
     end
 
     def logout
+      SamlCamel::Logging.logout(session[:saml_attributes])
       session[:saml_attributes] = nil
       session[:sp_session] = nil
 
@@ -38,6 +44,10 @@ module SamlCamel
       redirect_to return_url
     end
 
+    def attr_check
+
+    end
+
 
     private
     def saml_settings

data/app/models/saml_camel/application_record.rb

@@ -1,5 +1,5 @@
 module SamlCamel
-  class ApplicationRecord 
-    self.abstract_class = true
+  class ApplicationRecord
+    
   end
 end

data/app/models/saml_camel/logging.rb

@@ -0,0 +1,23 @@
+module SamlCamel
+  class Logging
+    SP_SETTINGS = JSON.parse(File.read("saml/#{Rails.env}/settings.json"))
+    PRIMARY_ID = SP_SETTINGS["settings"]["primary_id"]
+    SHOULD_LOG = SP_SETTINGS["settings"]["saml_logging"]
+
+    def self.successfull_auth(saml_attrs)
+      logger = Logger.new("log/saml.log")
+      logger.info("#{saml_attrs[PRIMARY_ID]} has succesfully authenticated.")
+    end
+
+    def self.auth_failure(error_context)
+      logger = Logger.new("log/saml.log")
+      logger.error("An error occured during authentication.")
+    end
+
+    def self.logout(saml_attrs)
+      logger = Logger.new("log/saml.log")
+      logger.info("#{saml_attrs[PRIMARY_ID]} has succesfully logged out.")
+    end
+
+  end
+end

data/app/models/saml_camel/transaction.rb

@@ -46,7 +46,7 @@ module SamlCamel
       mapped_attributes
     end
 
-
+    #currently duke specifc
     def self.logout
       url = URI("https://shib.oit.duke.edu/cgi-bin/logout.pl")
 

data/app/views/saml_camel/saml/attr_check.html.erb

@@ -0,0 +1,5 @@
+<h1>SAML Attributes</h1>
+<% session[:saml_attributes].each do |k,v| %>
+  <strong><%= k %></strong>
+  <p><%= v %></p>
+<% end %>

data/config/routes.rb

@@ -1,5 +1,6 @@
 SamlCamel::Engine.routes.draw do
   get "/" => "saml#index"
+  get "/attributes" => 'saml#attr_check'
   post "/consumeSaml" => "saml#consume"
   post "/logout" => "saml#logout"
 end

data/lib/saml_camel/engine.rb

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

data/lib/saml_camel/version.rb

@@ -1,3 +1,3 @@
 module SamlCamel
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/tasks/saml_camel_tasks.rake

@@ -58,10 +58,6 @@ tA6SX0infqNRyPRNJK+bnQd1yOP4++tjD/lAPE+5tiD/waI3fArt43ZE/qp7pYMS
   end
 
 
-
-
-
-
   def generate_saml_settings
     {
       _comment: "note you will need to restart the application when you make changes to this file",
@@ -69,7 +65,9 @@ tA6SX0infqNRyPRNJK+bnQd1yOP4++tjD/lAPE+5tiD/waI3fArt43ZE/qp7pYMS
         acs: "http://localhost:3000/saml/consumeSaml" ,
         entity_id: "https://your-entity-id.com",
         sso_url: "https://shib.oit.duke.edu/idp/profile/SAML2/Redirect/SSO",
-        logout_return_url: "http://localhost:3000"
+        logout_return_url: "http://localhost:3000",
+        primary_id: "eduPersonPrincipalName",
+        saml_logging: true
       },
       "attribute_map": {
         "urn:oid:1.3.6.1.4.1.5923.1.1.1.9": "eduPersonScopedAffiliation",
@@ -80,7 +78,7 @@ tA6SX0infqNRyPRNJK+bnQd1yOP4++tjD/lAPE+5tiD/waI3fArt43ZE/qp7pYMS
         "urn:oid:1.3.6.1.4.1.5923.1.1.1.5": "eduPersonPrimaryAffiliation",
         "urn:oid:2.16.840.1.113730.3.1.241": "displayName",
         "urn:mace:duke.edu:idms:unique-id": "duDukeID",
-        "urn:mace:duke.edu:idms:dku-id": "urn:mace:duke.edu:idms:dku-id",
+        "urn:mace:duke.edu:idms:dku-id": "dku-id",
         "urn:oid:1.3.6.1.4.1.5923.1.5.1.1": "isMemberOf",
         "urn:oid:2.5.4.42": "givenName",
         "urn:oid:2.5.4.4": "sn",
@@ -89,8 +87,6 @@ tA6SX0infqNRyPRNJK+bnQd1yOP4++tjD/lAPE+5tiD/waI3fArt43ZE/qp7pYMS
         "urn:oid:2.5.4.20": "telephoneNumber",
         "urn:oid:2.5.4.12": "title",
         "urn:mace:duke.edu:idms:middle-name1": "duMiddleName1",
-        "urn:mace:duke.edu:idms:sap:name-first": "duSAPNameFirst",
-        "urn:mace:duke.edu:idms:sap:name-last": "duSAPNameLast",
         "urn:mace:duke.edu:idms:proxy-token": "duProxyToken"
       }
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saml_camel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - 'Danai Adkisson '
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,8 +87,10 @@ files:
 - app/jobs/saml_camel/application_job.rb
 - app/mailers/saml_camel/application_mailer.rb
 - app/models/saml_camel/application_record.rb
+- app/models/saml_camel/logging.rb
 - app/models/saml_camel/transaction.rb
 - app/views/layouts/saml_camel/application.html.erb
+- app/views/saml_camel/saml/attr_check.html.erb
 - config/routes.rb
 - lib/saml_camel.rb
 - lib/saml_camel/engine.rb