saml-kit-cli 0.3.6 → 0.3.7

data/lib/saml/kit/cli/signature_report.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    module Cli
+      class SignatureReport
+        attr_reader :content, :format, :path
+
+        def initialize(path, format:)
+          @format = format
+          @path = path
+          if File.exist?(File.expand_path(path))
+            @content = IO.read(File.expand_path(path))
+          else
+            uri = URI.parse(path)
+            @content = Net::HTTP.get_response(uri).body.chomp
+          end
+        end
+
+        def print(shell)
+          shell.say to_xml
+          return shell.say_status :success, "#{path} is valid", :green if valid?
+          errors.each { |error| shell.say_status(:error, error, :red) }
+          return unless full?
+          invalid_signatures.each { |x| shell.say(x.to_xml(indent: 2), :red) }
+        end
+
+        private
+
+        def document
+          @document ||= ::Xml::Kit::Document.new(content)
+        end
+
+        def to_xml
+          document.to_xml(pretty: true)
+        end
+
+        def valid?
+          document.valid?
+        end
+
+        def full?
+          format == 'full'
+        end
+
+        def errors
+          document.errors.full_messages
+        end
+
+        def invalid_signatures
+          document.send(:invalid_signatures).map(&:signature)
+        end
+      end
+    end
+  end
+end

data/lib/saml/kit/cli/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Saml
   module Kit
     module Cli
-      VERSION = "0.3.6"
+      VERSION = '0.3.7'.freeze
     end
   end
 end

data/lib/saml/kit/cli/yaml_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Saml
   module Kit
     module Cli
@@ -32,16 +34,13 @@ module Saml
         private
 
         def with_transaction
-          if @in_transaction
-            yield @items
-          else
-            @items.transaction do
-              begin
-                @in_transaction = true
-                yield @items
-              ensure
-                @in_transaction = false
-              end
+          return yield @items if @in_transaction
+          @items.transaction do
+            begin
+              @in_transaction = true
+              yield @items
+            ensure
+              @in_transaction = false
             end
           end
         end

data/lib/saml/kit/cli.rb

@@ -1,30 +1,47 @@
-require "saml/kit"
-require "thor"
-require "yaml/store"
-
-require "saml/kit/cli/certificate"
-require "saml/kit/cli/decode"
-require "saml/kit/cli/metadata"
-require "saml/kit/cli/report"
-require "saml/kit/cli/version"
-require "saml/kit/cli/xml_digital_signature"
-require "saml/kit/cli/yaml_registry"
+# frozen_string_literal: true
+
+require 'saml/kit'
+require 'thor'
+require 'yaml/store'
+require 'uri'
+
+require 'saml/kit/core_ext/assertion'
+require 'saml/kit/core_ext/authentication_request'
+require 'saml/kit/core_ext/document'
+require 'saml/kit/core_ext/document'
+require 'saml/kit/core_ext/logout_request'
+require 'saml/kit/core_ext/metadata'
+require 'saml/kit/core_ext/response'
+require 'saml/kit/core_ext/signature'
+
+require 'saml/kit/cli/certificate_report'
+require 'saml/kit/cli/commands'
+require 'saml/kit/cli/generate_key_pair'
+require 'saml/kit/cli/report'
+require 'saml/kit/cli/signature_report'
+require 'saml/kit/cli/version'
+require 'saml/kit/cli/yaml_registry'
 
 module Saml
   module Kit
     module Cli
       class Application < Thor
-        desc "decode SUBCOMMAND ...ARGS", "decode SAMLRequest/SAMLResponse."
-        subcommand "decode", Decode
+        desc 'decode SUBCOMMAND ...ARGS', 'decode SAMLRequest/SAMLResponse.'
+        subcommand 'decode', Commands::Decode
+
+        desc 'certificate SUBCOMMAND ...ARGS', 'Work with SAML Certificates.'
+        subcommand 'certificate', Commands::Certificate
 
-        desc "certificate SUBCOMMAND ...ARGS", "Work with SAML Certificates."
-        subcommand "certificate", Certificate
+        desc 'metadata SUBCOMMAND ...ARGS', 'Work with SAML Metadata.'
+        subcommand 'metadata', Commands::Metadata
 
-        desc "metadata SUBCOMMAND ...ARGS", "Work with SAML Metadata."
-        subcommand "metadata", Metadata
+        desc 'xmldsig SUBCOMMAND ...ARGS', 'Check XML digital signatures.'
+        subcommand 'xmldsig', Commands::XmlDigitalSignature
 
-        desc "xmldsig SUBCOMMAND ...ARGS", "Check XML digital signatures."
-        subcommand "xmldsig", XmlDigitalSignature
+        desc 'version', 'Display the current version'
+        def version
+          say Saml::Kit::Cli::VERSION
+        end
       end
     end
   end

data/lib/saml/kit/core_ext/assertion.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class Assertion
+      TABLE = {
+        'Assertion Present?' => ->(x) { x.present? },
+        'Issuer' => ->(x) { x.issuer },
+        'Name Id' => ->(x) { x.name_id },
+        'Attributes' => ->(x) { x.attributes.inspect },
+        'Not Before' => ->(x) { x.started_at },
+        'Not After' => ->(x) { x.expired_at },
+        'Audiences' => ->(x) { x.audiences.inspect },
+        'Encrypted?' => ->(x) { x.encrypted? },
+        'Decryptable' => ->(x) { x.decryptable? },
+      }.freeze
+
+      def build_table(table = [])
+        TABLE.each do |key, callable|
+          table.push([key, callable.call(self)])
+        end
+        signature.build_table(table)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class AuthenticationRequest
+      def build_table(table = [])
+        super(table)
+        table.push(['ACS', assertion_consumer_service_url])
+        table.push(['Name Id Format', name_id_format])
+        table
+      end
+    end
+  end
+end

data/lib/saml/kit/core_ext/document.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class Document
+      TABLE = {
+        'ID' => ->(x) { x.id },
+        'Issuer' => ->(x) { x.issuer },
+        'Version' => ->(x) { x.version },
+        'Issue Instant' => ->(x) { x.issue_instant.iso8601 },
+        'Type' => ->(x) { x.name },
+        'Valid' => ->(x) { x.valid? },
+        'Signed?' => ->(x) { x.signed? },
+        'Trusted?' => ->(x) { x.trusted? },
+      }.freeze
+
+      def build_table(table = [])
+        TABLE.each do |key, callable|
+          table.push([key, callable.call(self)])
+        end
+        signature.build_table(table)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class LogoutRequest
+      def build_table(table = [])
+        super(table)
+        table.push(['Name Id', name_id])
+        table
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class Metadata
+      TABLE = {
+        'Entity Id' => ->(x) { x.entity_id },
+        'Type' => ->(x) { x.name },
+        'Valid' => ->(x) { x.valid? },
+        'Name Id Formats' => ->(x) { x.name_id_formats.inspect },
+        'Organization' => ->(x) { x.organization_name },
+        'Url' => ->(x) { x.organization_url },
+        'Contact' => ->(x) { x.contact_person_company },
+      }.freeze
+
+      SERVICES = %w[
+        SingleSignOnService
+        SingleLogoutService
+        AssertionConsumerService
+      ].freeze
+
+      def build_table(table = [])
+        TABLE.each { |key, callable| table.push([key, callable.call(self)]) }
+        build_services_table(table)
+        certificates.each do |certificate|
+          table.push(['', certificate.x509.to_text])
+        end
+        signature.build_table(table)
+      end
+
+      def build_services_table(table)
+        SERVICES.each do |type|
+          services(type).each do |service|
+            table.push([type, [service.location, service.binding]])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class Response
+      def build_table(table = [])
+        super(table)
+        assertion.build_table(table) if assertion.present?
+        table
+      end
+    end
+  end
+end

data/lib/saml/kit/core_ext/signature.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Saml
+  module Kit
+    class Signature
+      TABLE = {
+        'Digest Value' => ->(x) { x.digest_value },
+        'Expected Digest Value' => ->(x) { x.expected_digest_value },
+        'Digest Method' => ->(x) { x.digest_method },
+        'Signature Value' => ->(x) { x.truncate(x.signature_value) },
+        'Signature Method' => ->(x) { x.signature_method },
+        'Canonicalization Method' => ->(x) { x.canonicalization_method },
+      }.freeze
+
+      def build_table(table = [])
+        return table unless present?
+        TABLE.each do |key, callable|
+          table.push([key, callable.call(self)])
+        end
+        table.push(['', certificate.x509.to_text])
+      end
+
+      def truncate(text, max: 50)
+        text.length >= max ? "#{text[0..max]}..." : text
+      end
+    end
+  end
+end

data/saml-kit-cli.gemspec

@@ -1,30 +1,35 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "saml/kit/cli/version"
+require 'saml/kit/cli/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "saml-kit-cli"
+  spec.name          = 'saml-kit-cli'
   spec.version       = Saml::Kit::Cli::VERSION
-  spec.authors       = ["mo khan"]
-  spec.email         = ["mo@mokhan.ca"]
+  spec.authors       = ['mo khan']
+  spec.email         = ['mo@mokhan.ca']
 
-  spec.summary       = %q{A command line interface for saml-kit.}
-  spec.description   = %q{A command line interface for saml-kit.}
-  spec.homepage      = "http://www.mokhan.ca/"
-  spec.license       = "MIT"
+  spec.summary       = 'A command line interface for saml-kit.'
+  spec.description   = 'A command line interface for saml-kit.'
+  spec.homepage      = 'https://www.mokhan.ca/'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = "~> 2.0"
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.2'
 
-  spec.add_dependency "saml-kit", "1.0.9"
-  spec.add_dependency "thor", "~> 0.20"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'saml-kit', '1.0.14'
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saml-kit-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - mo khan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: saml-kit
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.9
+        version: 1.0.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.9
+        version: 1.0.14
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
 description: A command line interface for saml-kit.
 email:
 - mo@mokhan.ca
@@ -89,25 +131,41 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cibuild
 - bin/console
+- bin/lint
 - bin/setup
+- bin/test
 - exe/saml-kit
 - lib/saml/kit/cli.rb
-- lib/saml/kit/cli/certificate.rb
-- lib/saml/kit/cli/decode.rb
-- lib/saml/kit/cli/metadata.rb
+- lib/saml/kit/cli/certificate_report.rb
+- lib/saml/kit/cli/commands.rb
+- lib/saml/kit/cli/commands/certificate.rb
+- lib/saml/kit/cli/commands/decode.rb
+- lib/saml/kit/cli/commands/metadata.rb
+- lib/saml/kit/cli/commands/xml_digital_signature.rb
+- lib/saml/kit/cli/generate_key_pair.rb
 - lib/saml/kit/cli/report.rb
+- lib/saml/kit/cli/signature_report.rb
 - lib/saml/kit/cli/version.rb
-- lib/saml/kit/cli/xml_digital_signature.rb
 - lib/saml/kit/cli/yaml_registry.rb
+- lib/saml/kit/core_ext/assertion.rb
+- lib/saml/kit/core_ext/authentication_request.rb
+- lib/saml/kit/core_ext/document.rb
+- lib/saml/kit/core_ext/logout_request.rb
+- lib/saml/kit/core_ext/metadata.rb
+- lib/saml/kit/core_ext/response.rb
+- lib/saml/kit/core_ext/signature.rb
 - saml-kit-cli.gemspec
-homepage: http://www.mokhan.ca/
+homepage: https://www.mokhan.ca/
 licenses:
 - MIT
 metadata: {}
@@ -119,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -127,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A command line interface for saml-kit.

data/lib/saml/kit/cli/certificate.rb

@@ -1,45 +0,0 @@
-module Saml
-  module Kit
-    module Cli
-      class Certificate < Thor
-        desc "keypair", "Create a key pair using a self signed certificate."
-        method_option :format, default: "pem", required: false, enum: ["pem", "env"]
-        method_option :passphrase, default: nil, required: false
-        def keypair
-          passphrase = options[:passphrase]
-          format = options[:format]
-          generator = ::Xml::Kit::SelfSignedCertificate.new
-          certificate, private_key = generator.create(passphrase: passphrase)
-
-          if "pem" == format
-            say "** BEGIN PEM Format **", :green
-            print certificate
-            say private_key
-            say "***********************", :green
-          else
-            say "** BEGIN ENV Format **", :green
-            say "X509_CERTIFICATE=" + certificate.inspect
-            say
-            say "PRIVATE_KEY=" + private_key.inspect
-            say "***********************", :green
-          end
-
-          say
-          say "Private Key Passphrase:", :green
-          say passphrase.inspect
-        end
-
-        desc "dump", "Dump the details of a X509 Certificate."
-        def dump(raw)
-          certificate = ::Xml::Kit::Certificate.new(raw, use: :unknown)
-          x509 = certificate.x509
-          print_table [
-            ["Subject", "Issuer", "Serial", "Not Before", "Not After", "Fingerprint"],
-            [x509.subject, x509.issuer, x509.serial, x509.not_before, x509.not_after, certificate.fingerprint]
-          ]
-          say x509.to_text, :green
-        end
-      end
-    end
-  end
-end

data/lib/saml/kit/cli/decode.rb

@@ -1,44 +0,0 @@
-module Saml
-  module Kit
-    module Cli
-      class Decode < Thor
-        desc "redirect uri", "Decodes the uri using the HTTP Redirect binding"
-        def redirect(uri)
-          print_report_for(redirect_binding.deserialize(uri))
-        rescue StandardError => error
-          say error.message, :red
-        end
-
-        desc "post saml", "Decodes the SAMLRequest/SAMLResponse using the HTTP Post binding"
-        def post(saml_request)
-          print_report_for(post_binding.deserialize('SAMLRequest' => saml_request))
-        rescue StandardError => error
-          say error.message, :red
-        end
-
-        desc "raw <file>", "Decode the contents of a decoded file"
-        def raw(file)
-          content = IO.read(File.expand_path(file))
-          print_report_for(Document.to_saml_document(content))
-        rescue StandardError => error
-          say error.message, :red
-        end
-
-        private
-
-        def print_report_for(document)
-          2.times { say "" }
-          Report.new(document).print(self)
-        end
-
-        def post_binding(location = '')
-          Saml::Kit::Bindings::HttpPost.new(location: location)
-        end
-
-        def redirect_binding(location = '')
-          Saml::Kit::Bindings::HttpRedirect.new(location: location)
-        end
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-module Saml
-  module Kit
-    module Cli
-      class Metadata < Thor
-        desc "register url", "Registers the Metadata from the remote url."
-        def register(url)
-          say registry.register_url(url).to_xml(pretty: true), :green
-        end
-
-        desc "list", "List each of the registered entityId's"
-        def list
-          registry.each do |x|
-            say x.entity_id, :green
-          end
-        end
-
-        desc "show entity_id", "show the metadata associated with an entityId"
-        def show(entity_id)
-          metadata = registry.metadata_for(entity_id)
-          if metadata
-            Report.new(metadata).print(self)
-          else
-            say "`#{entity_id}` is not registered", :red
-          end
-        end
-
-        private
-
-        def registry
-          Saml::Kit.registry
-        end
-      end
-    end
-  end
-end