kl-ruby-saml 0.0.3 → 0.0.4

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/logoutresponse.rb

@@ -1,17 +1,17 @@
 require "xml_security"
-require "onelogin/ruby-saml/saml_message"
+require "onelogin/kl-ruby-saml/saml_message"
 
 require "time"
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Logout Response (SLO IdP initiated, Parser)
     #
     class Logoutresponse < SamlMessage
 
-      # OneLogin::RubySaml::Settings Toolkit settings
+      # OneLogin::KlRubySaml::Settings Toolkit settings
       attr_accessor :settings
 
       # Array with the causes
@@ -25,7 +25,7 @@ module OneLogin
 
       # Constructs the Logout Response. A Logout Response Object that is an extension of the SamlMessage class.
       # @param response  [String] A UUEncoded logout response from the IdP.
-      # @param settings  [OneLogin::RubySaml::Settings|nil] Toolkit settings
+      # @param settings  [OneLogin::KlRubySaml::Settings|nil] Toolkit settings
       # @param options   [Hash] Extra parameters. 
       #                    :matches_request_id It will validate that the logout response matches the ID of the request.
       #                    :get_params GET Parameters, including the SAMLResponse
@@ -142,7 +142,7 @@ module OneLogin
         return true if success?
 
         error_msg = 'The status code of the Logout Response was not Success'
-        status_error_msg = OneLogin::RubySaml::Utils.status_error_msg(error_msg, status_code, status_message)
+        status_error_msg = OneLogin::KlRubySaml::Utils.status_error_msg(error_msg, status_code, status_message)
         append_error(status_error_msg)
       end
 
@@ -215,14 +215,14 @@ module OneLogin
         return true unless options[:get_params].has_key? 'Signature'
         return true if settings.nil? || settings.get_idp_cert.nil?
         
-        query_string = OneLogin::RubySaml::Utils.build_query(
+        query_string = OneLogin::KlRubySaml::Utils.build_query(
           :type        => 'SAMLResponse',
           :data        => options[:get_params]['SAMLResponse'],
           :relay_state => options[:get_params]['RelayState'],
           :sig_alg     => options[:get_params]['SigAlg']
         )
 
-        valid = OneLogin::RubySaml::Utils.verify_signature(
+        valid = OneLogin::KlRubySaml::Utils.verify_signature(
           :cert         => settings.get_idp_cert,
           :sig_alg      => options[:get_params]['SigAlg'],
           :signature    => options[:get_params]['Signature'],

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/metadata.rb

@@ -1,18 +1,18 @@
 require "uri"
 require "uuid"
 
-require "onelogin/ruby-saml/logging"
+require "onelogin/kl-ruby-saml/logging"
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Metadata. XML Metadata Builder
     # 
     class Metadata
 
       # Return SP metadata based on the settings.
-      # @param settings [OneLogin::RubySaml::Settings|nil] Toolkit settings
+      # @param settings [OneLogin::KlRubySaml::Settings|nil] Toolkit settings
       # @param pretty_print [Boolean] Pretty print or not the response 
       #                               (No pretty print if you gonna validate the signature)
       # @return [String] XML Metadata of the Service Provider

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/response.rb

@@ -1,12 +1,12 @@
 require "xml_security"
-require "onelogin/ruby-saml/attributes"
+require "onelogin/kl-ruby-saml/attributes"
 
 require "time"
 require "nokogiri"
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Authentication Response. SAML Response
     #
@@ -18,7 +18,7 @@ module OneLogin
 
       # TODO: Settings should probably be initialized too... WDYT?
 
-      # OneLogin::RubySaml::Settings Toolkit settings
+      # OneLogin::KlRubySaml::Settings Toolkit settings
       attr_accessor :settings
 
       # Array with the causes [Array of strings]
@@ -33,7 +33,7 @@ module OneLogin
 
       # Constructs the SAML Response. A Response Object that is an extension of the SamlMessage class.
       # @param response [String] A UUEncoded SAML response from the IdP.
-      # @param options  [Hash]   :settings to provide the OneLogin::RubySaml::Settings object 
+      # @param options  [Hash]   :settings to provide the OneLogin::KlRubySaml::Settings object 
       #                          Or some options for the response validation process like skip the conditions validation
       #                          with the :skip_conditions, or allow a clock_drift when checking dates with :allowed_clock_drift
       #                          or :matches_request_id that will validate that the response matches the ID of the request.
@@ -110,16 +110,16 @@ module OneLogin
       # Gets the Attributes from the AttributeStatement element.
       #
       # All attributes can be iterated over +attributes.each+ or returned as array by +attributes.all+
-      # For backwards compatibility ruby-saml returns by default only the first value for a given attribute with
+      # For backwards compatibility kl-ruby-saml returns by default only the first value for a given attribute with
       #    attributes['name']
       # To get all of the attributes, use:
       #    attributes.multi('name')
       # Or turn off the compatibility:
-      #    OneLogin::RubySaml::Attributes.single_value_compatibility = false
+      #    OneLogin::KlRubySaml::Attributes.single_value_compatibility = false
       # Now this will return an array:
       #    attributes['name']
       #
-      # @return [Attributes] OneLogin::RubySaml::Attributes enumerable collection.
+      # @return [Attributes] OneLogin::KlRubySaml::Attributes enumerable collection.
       #      
       def attributes
         @attr_statements ||= begin
@@ -298,7 +298,7 @@ module OneLogin
         return true if success?
           
         error_msg = 'The status code of the Response was not Success'
-        status_error_msg = OneLogin::RubySaml::Utils.status_error_msg(error_msg, status_code, status_message)
+        status_error_msg = OneLogin::KlRubySaml::Utils.status_error_msg(error_msg, status_code, status_message)
         append_error(status_error_msg)
       end
 
@@ -696,7 +696,7 @@ module OneLogin
           return validation_error('An ' + encrypt_node.name + ' found and no SP private key found on the settings to decrypt it')
         end
 
-        elem_plaintext = OneLogin::RubySaml::Utils.decrypt_data(encrypt_node, settings.get_sp_key)
+        elem_plaintext = OneLogin::KlRubySaml::Utils.decrypt_data(encrypt_node, settings.get_sp_key)
         # If we get some problematic noise in the plaintext after decrypting.
         # This quick regexp parse will grab only the Element and discard the noise.
         elem_plaintext = elem_plaintext.match(rgrex)[0]

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/saml_message.rb

@@ -8,7 +8,7 @@ require 'thread'
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Message
     #
@@ -105,7 +105,7 @@ module OneLogin
 
       # Deflate, base64 encode and url-encode a SAML Message (To be used in the HTTP-redirect binding)
       # @param saml [String] The plain SAML Message
-      # @param settings [OneLogin::RubySaml::Settings|nil] Toolkit settings
+      # @param settings [OneLogin::KlRubySaml::Settings|nil] Toolkit settings
       # @return [String] The deflated and encoded SAML Message (encoded if the compression is requested)
       #
       def encode_raw_saml(saml, settings)

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/settings.rb

@@ -1,10 +1,10 @@
 require "xml_security"
-require "onelogin/ruby-saml/attribute_service"
-require "onelogin/ruby-saml/utils"
+require "onelogin/kl-ruby-saml/attribute_service"
+require "onelogin/kl-ruby-saml/utils"
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Toolkit Settings
     #
@@ -118,7 +118,7 @@ module OneLogin
       def get_idp_cert
         return nil if idp_cert.nil? || idp_cert.empty?
 
-        formated_cert = OneLogin::RubySaml::Utils.format_cert(idp_cert)
+        formated_cert = OneLogin::KlRubySaml::Utils.format_cert(idp_cert)
         OpenSSL::X509::Certificate.new(formated_cert)
       end
 
@@ -127,7 +127,7 @@ module OneLogin
       def get_sp_cert
         return nil if certificate.nil? || certificate.empty?
 
-        formated_cert = OneLogin::RubySaml::Utils.format_cert(certificate)
+        formated_cert = OneLogin::KlRubySaml::Utils.format_cert(certificate)
         OpenSSL::X509::Certificate.new(formated_cert)
       end
 
@@ -136,7 +136,7 @@ module OneLogin
       def get_sp_key
         return nil if private_key.nil? || private_key.empty?
         
-        formated_private_key = OneLogin::RubySaml::Utils.format_private_key(private_key)
+        formated_private_key = OneLogin::KlRubySaml::Utils.format_private_key(private_key)
         OpenSSL::PKey::RSA.new(formated_private_key)
       end
 

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/slo_logoutrequest.rb

@@ -2,17 +2,17 @@ require 'zlib'
 require 'time'
 require 'nokogiri'
 
-require "onelogin/ruby-saml/saml_message"
+require "onelogin/kl-ruby-saml/saml_message"
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Logout Request (SLO IdP initiated, Parser)
     #
     class SloLogoutrequest < SamlMessage
 
-      # OneLogin::RubySaml::Settings Toolkit settings
+      # OneLogin::KlRubySaml::Settings Toolkit settings
       attr_accessor :settings
 
       # Array with the causes [Array of strings]
@@ -26,7 +26,7 @@ module OneLogin
 
       # Constructs the Logout Request. A Logout Request Object that is an extension of the SamlMessage class.
       # @param request [String] A UUEncoded Logout Request from the IdP.
-      # @param options [Hash]  :settings to provide the OneLogin::RubySaml::Settings object 
+      # @param options [Hash]  :settings to provide the OneLogin::KlRubySaml::Settings object 
       #                        Or :allowed_clock_drift for the logout request validation process to allow a clock drift when checking dates with
       #
       # @raise [ArgumentError] If Request is nil
@@ -232,14 +232,14 @@ module OneLogin
         return true unless options[:get_params].has_key? 'Signature'
         return true if settings.nil? || settings.get_idp_cert.nil?
 
-        query_string = OneLogin::RubySaml::Utils.build_query(
+        query_string = OneLogin::KlRubySaml::Utils.build_query(
           :type        => 'SAMLRequest',
           :data        => options[:get_params]['SAMLRequest'],
           :relay_state => options[:get_params]['RelayState'],
           :sig_alg     => options[:get_params]['SigAlg']
         )
 
-        valid = OneLogin::RubySaml::Utils.verify_signature(
+        valid = OneLogin::KlRubySaml::Utils.verify_signature(
           :cert         => settings.get_idp_cert,
           :sig_alg      => options[:get_params]['SigAlg'],
           :signature    => options[:get_params]['Signature'],

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/slo_logoutresponse.rb

@@ -1,11 +1,11 @@
 require "uuid"
 
-require "onelogin/ruby-saml/logging"
-require "onelogin/ruby-saml/saml_message"
+require "onelogin/kl-ruby-saml/logging"
+require "onelogin/kl-ruby-saml/saml_message"
 
 # Only supports SAML 2.0
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Logout Response (SLO SP initiated, Parser)
     #
@@ -22,7 +22,7 @@ module OneLogin
       end
 
       # Creates the Logout Response string.
-      # @param settings [OneLogin::RubySaml::Settings|nil] Toolkit settings
+      # @param settings [OneLogin::KlRubySaml::Settings|nil] Toolkit settings
       # @param request_id [String] The ID of the LogoutRequest sent by this SP to the IdP. That ID will be placed as the InResponseTo in the logout response
       # @param logout_message [String] The Message to be placed as StatusMessage in the logout response
       # @param params [Hash] Some extra parameters to be added in the GET for example the RelayState
@@ -41,7 +41,7 @@ module OneLogin
       end
 
       # Creates the Get parameters for the logout response.
-      # @param settings [OneLogin::RubySaml::Settings|nil] Toolkit settings
+      # @param settings [OneLogin::KlRubySaml::Settings|nil] Toolkit settings
       # @param request_id [String] The ID of the LogoutRequest sent by this SP to the IdP. That ID will be placed as the InResponseTo in the logout response
       # @param logout_message [String] The Message to be placed as StatusMessage in the logout response
       # @param params [Hash] Some extra parameters to be added in the GET for example the RelayState
@@ -67,7 +67,7 @@ module OneLogin
 
         if settings.security[:logout_responses_signed] && !settings.security[:embed_sign] && settings.private_key
           params['SigAlg']    = settings.security[:signature_method]
-          url_string = OneLogin::RubySaml::Utils.build_query(
+          url_string = OneLogin::KlRubySaml::Utils.build_query(
             :type => 'SAMLResponse',
             :data => base64_response,
             :relay_state => relay_state,
@@ -86,7 +86,7 @@ module OneLogin
       end
 
       # Creates the SAMLResponse String.
-      # @param settings [OneLogin::RubySaml::Settings|nil] Toolkit settings
+      # @param settings [OneLogin::KlRubySaml::Settings|nil] Toolkit settings
       # @param request_id [String] The ID of the LogoutRequest sent by this SP to the IdP. That ID will be placed as the InResponseTo in the logout response
       # @param logout_message [String] The Message to be placed as StatusMessage in the logout response
       # @return [String] The SAMLResponse String.

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/utils.rb

@@ -1,5 +1,5 @@
 module OneLogin
-  module RubySaml
+  module KlRubySaml
 
     # SAML2 Auxiliary class
     #    

data/lib/onelogin/{ruby-saml → kl-ruby-saml}/validation_error.rb

@@ -1,5 +1,5 @@
 module OneLogin
-  module RubySaml
+  module KlRubySaml
     class ValidationError < StandardError
     end
   end

data/lib/onelogin/kl-ruby-saml/version.rb

@@ -0,0 +1,5 @@
+module OneLogin
+  module KlRubySaml
+    VERSION = '0.0.4'
+  end
+end

data/lib/xml_security.rb

@@ -29,7 +29,7 @@ require "openssl"
 require 'nokogiri'
 require "digest/sha1"
 require "digest/sha2"
-require "onelogin/ruby-saml/validation_error"
+require "onelogin/kl-ruby-saml/validation_error"
 
 module XMLSecurity
 
@@ -203,7 +203,7 @@ module XMLSecurity
         if soft
           return false
         else
-          raise OneLogin::RubySaml::ValidationError.new("Certificate element missing in response (ds:X509Certificate)")
+          raise OneLogin::KlRubySaml::ValidationError.new("Certificate element missing in response (ds:X509Certificate)")
         end
       end
       base64_cert = cert_element.text
@@ -220,7 +220,7 @@ module XMLSecurity
       # check cert matches registered idp cert
       if fingerprint != idp_cert_fingerprint.gsub(/[^a-zA-Z0-9]/,"").downcase
         @errors << "Fingerprint mismatch"
-        return soft ? false : (raise OneLogin::RubySaml::ValidationError.new("Fingerprint mismatch"))
+        return soft ? false : (raise OneLogin::KlRubySaml::ValidationError.new("Fingerprint mismatch"))
       end
 
       validate_signature(base64_cert, soft)
@@ -299,7 +299,7 @@ module XMLSecurity
 
         unless digests_match?(hash, digest_value)
           @errors << "Digest mismatch"
-          return soft ? false : (raise OneLogin::RubySaml::ValidationError.new("Digest mismatch"))
+          return soft ? false : (raise OneLogin::KlRubySaml::ValidationError.new("Digest mismatch"))
         end
       end
 
@@ -325,7 +325,7 @@ module XMLSecurity
 
       unless cert.public_key.verify(signature_algorithm.new, signature, canon_string)
         @errors << "Key validation error"
-        return soft ? false : (raise OneLogin::RubySaml::ValidationError.new("Key validation error"))
+        return soft ? false : (raise OneLogin::KlRubySaml::ValidationError.new("Key validation error"))
       end
 
       return true

data/test/idp_metadata_parser_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
-require 'onelogin/ruby-saml/idp_metadata_parser'
+require 'onelogin/kl-ruby-saml/idp_metadata_parser'
 
 class IdpMetadataParserTest < Minitest::Test
   class MockSuccessResponse < Net::HTTPSuccess
@@ -19,7 +19,7 @@ class IdpMetadataParserTest < Minitest::Test
 
   describe "parsing an IdP descriptor file" do
     it "extract settings details from xml" do
-      idp_metadata_parser = OneLogin::RubySaml::IdpMetadataParser.new
+      idp_metadata_parser = OneLogin::KlRubySaml::IdpMetadataParser.new
 
       settings = idp_metadata_parser.parse(idp_metadata)
 
@@ -44,7 +44,7 @@ class IdpMetadataParserTest < Minitest::Test
     end
 
     it "extract settings from remote xml" do
-      idp_metadata_parser = OneLogin::RubySaml::IdpMetadataParser.new
+      idp_metadata_parser = OneLogin::KlRubySaml::IdpMetadataParser.new
       settings = idp_metadata_parser.parse_remote(@url)
 
       assert_equal "https://example.hello.com/access/saml/idp.xml", settings.idp_entity_id
@@ -56,7 +56,7 @@ class IdpMetadataParserTest < Minitest::Test
     end
 
     it "accept self signed certificate if insturcted" do
-      idp_metadata_parser = OneLogin::RubySaml::IdpMetadataParser.new
+      idp_metadata_parser = OneLogin::KlRubySaml::IdpMetadataParser.new
       idp_metadata_parser.parse_remote(@url, false)
 
       assert_equal OpenSSL::SSL::VERIFY_NONE, @http.verify_mode
@@ -65,7 +65,7 @@ class IdpMetadataParserTest < Minitest::Test
 
   describe "download failure cases" do
     it "raises an exception when the url has no scheme" do
-      idp_metadata_parser = OneLogin::RubySaml::IdpMetadataParser.new
+      idp_metadata_parser = OneLogin::KlRubySaml::IdpMetadataParser.new
 
       exception = assert_raises(ArgumentError) do
         idp_metadata_parser.parse_remote("blahblah")
@@ -83,9 +83,9 @@ class IdpMetadataParserTest < Minitest::Test
       Net::HTTP.expects(:new).returns(@http)
       @http.expects(:request).returns(mock_response)
 
-      idp_metadata_parser = OneLogin::RubySaml::IdpMetadataParser.new
+      idp_metadata_parser = OneLogin::KlRubySaml::IdpMetadataParser.new
 
-      exception = assert_raises(OneLogin::RubySaml::HttpError) do
+      exception = assert_raises(OneLogin::KlRubySaml::HttpError) do
         idp_metadata_parser.parse_remote("https://example.hello.com/access/saml/idp.xml")
       end
 

data/test/logging_test.rb

@@ -1,22 +1,22 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
-require 'onelogin/ruby-saml/logging'
+require 'onelogin/kl-ruby-saml/logging'
 
 class LoggingTest < Minitest::Test
 
   describe "Logging" do
     before do
-      OneLogin::RubySaml::Logging.logger = nil
+      OneLogin::KlRubySaml::Logging.logger = nil
     end
 
     after do
-      OneLogin::RubySaml::Logging.logger = ::TEST_LOGGER
+      OneLogin::KlRubySaml::Logging.logger = ::TEST_LOGGER
     end
 
     describe "given no specific logging setup" do
       it "prints to stdout" do
-        OneLogin::RubySaml::Logging::DEFAULT_LOGGER.expects(:debug).with('hi mom')
-        OneLogin::RubySaml::Logging.debug('hi mom')
+        OneLogin::KlRubySaml::Logging::DEFAULT_LOGGER.expects(:debug).with('hi mom')
+        OneLogin::KlRubySaml::Logging.debug('hi mom')
       end
     end
 
@@ -36,26 +36,26 @@ class LoggingTest < Minitest::Test
         logger.expects(:debug).with('hi mom')
         logger.expects(:info).with('sup?')
 
-        OneLogin::RubySaml::Logging.debug('hi mom')
-        OneLogin::RubySaml::Logging.info('sup?')
+        OneLogin::KlRubySaml::Logging.debug('hi mom')
+        OneLogin::KlRubySaml::Logging.info('sup?')
       end
     end
 
     describe "given a specific Logger" do
       let(:logger) { mock('Logger') }
 
-      before { OneLogin::RubySaml::Logging.logger = logger }
+      before { OneLogin::KlRubySaml::Logging.logger = logger }
 
       after do
-        OneLogin::RubySaml::Logging.logger = ::TEST_LOGGER
+        OneLogin::KlRubySaml::Logging.logger = ::TEST_LOGGER
       end
 
       it "delegates to the object" do
         logger.expects(:debug).with('hi mom')
         logger.expects(:info).with('sup?')
 
-        OneLogin::RubySaml::Logging.debug('hi mom')
-        OneLogin::RubySaml::Logging.info('sup?')
+        OneLogin::KlRubySaml::Logging.debug('hi mom')
+        OneLogin::KlRubySaml::Logging.info('sup?')
       end
     end
   end