validate_xml_xsi 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed79db97f53c99c86dff5c5acb649d7115dddd137ed5f91174aa12fe93187cf0
+  data.tar.gz: e6c379c63075f570f2f377f678476e410cbc5e0feb5a8091a4cc437b4b077877
+SHA512:
+  metadata.gz: b8b464eff0d093ad0d3d7939045dcf3867f053f03966675a053a520af5786ebbef560584c17116bd2b0af7c101056772561621f6d1745404d3827a1e4807e85c
+  data.tar.gz: 32cf5298a1c8eca642701cec2966612fd3eabe17ed41ac92d531200d3f96a89a85d74a8a447ce4b0fc82209de200e0b5b92550f6d91ffa3e8264012475e4928a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## v0.1.1
+
+* Rev Nokogiri requirement to ~> 1.12.5 for CVE-2021-41098
+
+## v0.1.0
+
+* Initial release
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in validate-xml.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 David Hansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# validate_xml_xsi
+
+This gem validates XML against it's xsi using the xsi:schemaLocation elements to define the location of XSD documents.
+
+It does this by first parsing the XML and searching for xsi:schemaLocation elements and then creating a schema document that imports the XSD's identified in the XML.
+
+It then validates the document against that schema and outputs any error messages.
+
+Note: this gem utilizes the 'nokogiri' gem for XML parsing and schema validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validate_xml_xsi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install validate_xml_xsi
+
+## Usage
+
+validate_xml_xsi <xmlfiles>
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/d-hansen/validate_xml_xsi.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/validate_xml_xsi

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'validate_xml_xsi'
+
+while ARGV.size > 0
+  fname = ARGV.shift
+  errors = XML::Schema::validate(fname)
+  if errors.empty?
+    puts "XML Schema check complete - NO ERRORS!"
+  else
+    puts "XML SCHEMA ERRORS FOUND:"
+    errors.each do |err|
+      puts err.description
+    end
+  end
+end

data/lib/validate_xml_xsi.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+require 'nokogiri'
+
+module XML
+  module Validation
+    class Error
+      Params = [:type, :file, :line, :column, :message, :err]
+      attr_reader *Params, :description
+      def initialize(*args)
+        Params.each.with_index { |param, idx| instance_variable_set("@#{param.to_s}", args[idx]) }
+        @description = "#{@type.to_s} ERROR [#{@file}:#{@line}:#{@column}]: #{@message}".freeze
+      end
+    end
+  end
+
+  def self.parse(obj)
+    filename = nil
+    obj = File::read(filename = obj) if obj.is_a?(String) && File::exist?(obj)
+    xml_doc = Nokogiri::XML.parse(obj) { |cfg| cfg.strict.pedantic.nonet }
+    xml_doc.instance_variable_set('@filename', filename)
+    xml_doc.define_singleton_method(:filename) { instance_variable_get('@filename') }
+    xml_doc
+  end
+
+  module Schema
+    def self.validate(xml_doc)
+      xml_doc = XML::parse(xml_doc) unless xml_doc.is_a?(Nokogiri::XML::Document)
+      errors = []
+      ## Build an all-in-one XSD document that imports all of the separate schema locations
+      xsd_doc = "<?xml version=\"1.0\"?>\n"
+      xsd_doc << "<xsd:schema targetNamespace=\"http://www.w3.orig/XML/1998/namespace\"\n" \
+                 "            xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n" \
+                 "            version=\"1.0\">\n"
+      ## Iterate over all the elements and find any xsi:schemaLocation attributes
+      ## and build a hash of all of the namespaces and locations
+      schemata_by_ns = {}
+      xml_doc.search('//*[@xsi:schemaLocation]').each do |elem|
+        elem['xsi:schemaLocation'].scan(/(\S+)\s+(\S+)/).each do |ns_set|
+          if ns_loc = schemata_by_ns[ns_set.first]
+            unless ns_loc.eql?(ns_set.last)
+              error "MISMATCHING XMLNS XSI: #{ns_set.first} -> #{ns_loc} VS #{ns_set.last}"
+            end
+          else
+            schemata_by_ns[ns_set.first] = ns_set.last
+          end
+        end
+      end
+      schemata_by_ns.each do |ns_href, ns_file|
+        xsd_doc << "  <xsd:import namespace=\"#{ns_href}\" schemaLocation=\"#{ns_file}\"/>\n"
+      end
+      xsd_doc << "</xsd:schema>\n"
+      xsd = Nokogiri::XML.Schema(xsd_doc)
+      xsd.errors.each do |err|
+        err_msg = (/ERROR: /.match(err.message)) ? $' : err.message
+        errors << XML::Validation::Error.new(:XSD, err.file, err.line, err.column, err_msg, err)
+      end
+      errs = xsd.validate(xml_doc)
+      errs.each do |err|
+        err_msg = (/ERROR: /.match(err.message)) ? $' : err.message
+        fname = (err.file.nil?) ? xml_doc.filename : err.file
+        errors << XML::Validation::Error.new(:XML, fname, err.line, err.column, err_msg, err)
+      end
+      errors
+    end
+  end
+end

data/validate_xml_xsi.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |spec|
+  spec.name          = "validate_xml_xsi"
+  spec.version       = "0.1.2"
+  spec.authors       = ["David Hansen"]
+  spec.email         = ["david@hansen4.net"]
+
+  spec.summary       = %q{Validate XML against it's embedded XSI elements that define the XSD's.}
+  spec.homepage      = "https://github.com/d-hansen/validate_xml_xsi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/d-hansen/validate_xml_xsi"
+  spec.metadata["changelog_uri"] = "https://github.com/d-hansen/validate_xml_xsi/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+
+  spec.add_dependency "nokogiri", "~> 1.12.5"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: validate_xml_xsi
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- David Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+description: 
+email:
+- david@hansen4.net
+executables:
+- validate_xml_xsi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/validate_xml_xsi
+- lib/validate_xml_xsi.rb
+- validate_xml_xsi.gemspec
+homepage: https://github.com/d-hansen/validate_xml_xsi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/d-hansen/validate_xml_xsi
+  source_code_uri: https://github.com/d-hansen/validate_xml_xsi
+  changelog_uri: https://github.com/d-hansen/validate_xml_xsi/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Validate XML against it's embedded XSI elements that define the XSD's.
+test_files: []