saml-kit 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6e4cc97ac1b952312da27f68858628cc913868c59184ace6d64b04369e045e
-  data.tar.gz: e86e6d0a6551896ebaa627827d176f8d300b155811af1c27b42a963356f32589
+  metadata.gz: f94e30d77a2e999c93935934dccb12d6cb491924a2dae47f94a946a491ceb373
+  data.tar.gz: 4e2116c0e7b04010dff208231eaae5eaad02c02539d0d23235fe2effad457f68
 SHA512:
-  metadata.gz: 91c05ab684c6e4da67e9a2b28d905d36c1e9edbe320879e61c9cc5fc79b8bdb8d0b7bae58c816aa6e2842521da524947183c6d65b6c55c32e5e052731f908f40
-  data.tar.gz: 2a78ce0bd35526550ab46e8cc4070be57a46e4805ab02a41105ba35a222f7dc4e9db67137c036914a84ff1df80b87ecb46e35523f0ba15d47cbcf1da033ae38c
+  metadata.gz: 4b8c2639dd377b437487f76978f8afd7bbad8fa8b4a8256e5f25adae08152b2efcaa6907d67f1c201a4fc72abc8e29ab8675252657ad502e8668f87b65a0c0bf
+  data.tar.gz: d1f0acc593a9fae6d8f1087e59779fa6e0868e52f1b2c00280f44bb43a7ced70c8ea33c06ae7e0e87dd63edf243831ab1529f4fb13de7136457f3cf9b7635847

data/README.md

@@ -33,7 +33,7 @@ To specify a global configuration: (useful for a rails application)
 
 ```ruby
 Saml::Kit.configure do |configuration|
-  configuration.issuer = ENV['ISSUER']
+  configuration.entity_id = ENV['ISSUER']
   configuration.generate_key_pair_for(use: :signing)
   configuration.add_key_pair(ENV["CERTIFICATE"], ENV["PRIVATE_KEY"], passphrase: ENV['PASSPHRASE'], use: :signing)
   configuration.generate_key_pair_for(use: :encryption)

data/lib/saml-kit.rb

@@ -0,0 +1 @@
+require 'saml/kit'

data/lib/saml/kit/assertion.rb

@@ -100,7 +100,7 @@ module Saml
       end
 
       def must_match_issuer
-        unless audiences.include?(configuration.issuer)
+        unless audiences.include?(configuration.entity_id)
           errors[:audience] << error_message(:must_match_issuer)
         end
       end

data/lib/saml/kit/buildable.rb

@@ -4,12 +4,16 @@ module Saml
       extend ActiveSupport::Concern
 
       class_methods do
-        def build(*args, &block) # :yields builder
-          builder(*args, &block).build
+        def build(*args) # :yields builder
+          builder(*args) do |builder|
+            yield builder if block_given?
+          end.build
         end
 
-        def build_xml(*args, &block) # :yields builder
-          builder(*args, &block).to_xml
+        def build_xml(*args) # :yields builder
+          builder(*args) do |builder|
+            yield builder if block_given?
+          end.to_xml
         end
 
         def builder(*args) # :yields builder

data/lib/saml/kit/builders/authentication_request.rb

@@ -12,7 +12,7 @@ module Saml
         def initialize(configuration: Saml::Kit.configuration)
           @configuration = configuration
           @id = ::Xml::Kit::Id.generate
-          @issuer = configuration.issuer
+          @issuer = configuration.entity_id
           @name_id_format = Namespaces::PERSISTENT
           @now = Time.now.utc
           @version = "2.0"

data/lib/saml/kit/builders/identity_provider_metadata.rb

@@ -16,7 +16,7 @@ module Saml
         def initialize(configuration: Saml::Kit.configuration)
           @attributes = []
           @configuration = configuration
-          @entity_id = configuration.issuer
+          @entity_id = configuration.entity_id
           @id = ::Xml::Kit::Id.generate
           @logout_urls = []
           @name_id_formats = [Namespaces::PERSISTENT]

data/lib/saml/kit/builders/logout_request.rb

@@ -13,7 +13,7 @@ module Saml
           @configuration = configuration
           @user = user
           @id = ::Xml::Kit::Id.generate
-          @issuer = configuration.issuer
+          @issuer = configuration.entity_id
           @name_id_format = Saml::Kit::Namespaces::PERSISTENT
           @now = Time.now.utc
           @version = "2.0"

data/lib/saml/kit/builders/logout_response.rb

@@ -12,7 +12,7 @@ module Saml
         def initialize(request, configuration: Saml::Kit.configuration)
           @configuration = configuration
           @id = ::Xml::Kit::Id.generate
-          @issuer = configuration.issuer
+          @issuer = configuration.entity_id
           @now = Time.now.utc
           @request = request
           @status_code = Namespaces::SUCCESS

data/lib/saml/kit/builders/metadata.rb

@@ -15,7 +15,7 @@ module Saml
 
         def initialize(configuration: Saml::Kit.configuration)
           @id = ::Xml::Kit::Id.generate
-          @entity_id = configuration.issuer
+          @entity_id = configuration.entity_id
           @configuration = configuration
         end
 

data/lib/saml/kit/builders/response.rb

@@ -19,7 +19,7 @@ module Saml
           @now = Time.now.utc
           @version = "2.0"
           @status_code = Namespaces::SUCCESS
-          @issuer = configuration.issuer
+          @issuer = configuration.entity_id
           @encrypt = encryption_certificate.present?
           @configuration = configuration
         end

data/lib/saml/kit/configuration.rb

@@ -3,7 +3,7 @@ module Saml
     # This class represents the main configuration that is use for generating SAML documents.
     #
     #   Saml::Kit::Configuration.new do |config|
-    #     config.issuer = "com:saml:kit"
+    #     config.entity_id = "com:saml:kit"
     #     config.signature_method = :SHA256
     #     config.digest_method = :SHA256
     #     config.registry = Saml::Kit::DefaultRegistry.new
@@ -15,14 +15,14 @@ module Saml
     #   that runs at the start of the program.
     #
     #   Saml::Kit.configure do |configuration|
-    #     configuration.issuer = "https://www.example.com/saml/metadata"
+    #     configuration.entity_id = "https://www.example.com/saml/metadata"
     #     configuration.generate_key_pair_for(use: :signing)
     #     configuration.add_key_pair(ENV["X509_CERTIFICATE"], ENV["PRIVATE_KEY"], passphrase: ENV['PRIVATE_KEY_PASSPHRASE'], use: :encryption)
     #   end
     class Configuration
       USES = [:signing, :encryption]
-      # The issuer or entity_id to use.
-      attr_accessor :issuer
+      # The issuer to use in requests or responses from this entity to use.
+      attr_accessor :entity_id
       # The signature method to use when generating signatures (See {Saml::Kit::Builders::XmlSignature::SIGNATURE_METHODS})
       attr_accessor :signature_method
       # The digest method to use when generating signatures (See {Saml::Kit::Builders::XmlSignature::DIGEST_METHODS})
@@ -112,6 +112,18 @@ module Saml
         certificates(use: :signing).any?
       end
 
+      # @deprecated Use {#entity_id} instead of this method.
+      def issuer
+        Saml::Kit.deprecate("issuer is deprecated. Use entity_id instead")
+        self.entity_id
+      end
+
+      # @deprecated Use {#entity_id=} instead of this method.
+      def issuer=(value)
+        Saml::Kit.deprecate("issuer= is deprecated. Use entity_id= instead")
+        self.entity_id = value
+      end
+
       private
 
       def ensure_proper_use!(use)

data/lib/saml/kit/default_registry.rb

@@ -22,7 +22,7 @@ module Saml
     #   end
     #
     #   Saml::Kit.configure do |configuration|
-    #     configuration.issuer = ENV['ISSUER']
+    #     configuration.entity_id = ENV['ENTITY_ID']
     #     configuration.registry = OnDemandRegistry.new(configuration.registry)
     #     configuration.logger = Rails.logger
     #   end

data/lib/saml/kit/rspec.rb

@@ -0,0 +1,2 @@
+require 'saml/kit/rspec/have_query_param'
+require 'saml/kit/rspec/have_xpath'

data/lib/saml/kit/rspec/have_query_param.rb

@@ -0,0 +1,19 @@
+require 'uri'
+
+RSpec::Matchers.define :have_query_param do |key|
+  match do |url|
+    query_params_from(url)[key].present?
+  end
+
+  def query_params_from(url)
+    Hash[query_for(url).split("&").map { |x| x.split('=', 2) }]
+  end
+
+  def uri_for(url)
+    URI.parse(url)
+  end
+
+  def query_for(url)
+    uri_for(url).query
+  end
+end

data/lib/saml/kit/rspec/have_xpath.rb

@@ -0,0 +1,28 @@
+RSpec::Matchers.define :have_xpath do |xpath|
+  match do |actual|
+    namespaces = {
+      "NameFormat": Saml::Kit::Namespaces::ATTR_SPLAT,
+      "ds": ::Xml::Kit::Namespaces::XMLDSIG,
+      "md": Saml::Kit::Namespaces::METADATA,
+      "saml": Saml::Kit::Namespaces::ASSERTION,
+      "samlp": Saml::Kit::Namespaces::PROTOCOL,
+    }
+    xml_document(actual).xpath(xpath, namespaces).any?
+  end
+
+  failure_message do |actual|
+    "Expected xpath: #{xpath.inspect} to match in:\n #{xml_pretty_print(actual)}"
+  end
+
+  failure_message_when_negated do |actual|
+    "Expected xpath: #{xpath.inspect} not to match in:\n #{xml_pretty_print(actual)}"
+  end
+
+  def xml_pretty_print(raw_xml)
+    xml_document(raw_xml).to_xml(indent: 2)
+  end
+
+  def xml_document(raw_xml)
+    Nokogiri::XML(raw_xml)
+  end
+end

data/lib/saml/kit/version.rb

@@ -1,5 +1,5 @@
 module Saml
   module Kit
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saml-kit
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - mo khan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-13 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -145,6 +145,7 @@ files:
 - exe/saml-kit-create-self-signed-certificate
 - exe/saml-kit-decode-http-post
 - exe/saml-kit-decode-http-redirect
+- lib/saml-kit.rb
 - lib/saml/kit.rb
 - lib/saml/kit/assertion.rb
 - lib/saml/kit/authentication_request.rb
@@ -187,6 +188,9 @@ files:
 - lib/saml/kit/requestable.rb
 - lib/saml/kit/respondable.rb
 - lib/saml/kit/response.rb
+- lib/saml/kit/rspec.rb
+- lib/saml/kit/rspec/have_query_param.rb
+- lib/saml/kit/rspec/have_xpath.rb
 - lib/saml/kit/serializable.rb
 - lib/saml/kit/service_provider_metadata.rb
 - lib/saml/kit/signature.rb