openscap_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b79fdf725d0cb7a4bb9157c03871095ae0a53b1813c45c6a11cb8ceebb91ec24
+  data.tar.gz: cb31f6050f240a34d760a0c3c51eb80b38d420f2a574de61ed1d321c47a61833
+SHA512:
+  metadata.gz: cb2cfcec90e8207806b14a8d63b5f5dc294fcdde4676858019cc95d06fdcfb0e2c51690ec4a826641a3336ee58aa1cbce2dd1a4f248464c0369175687db3ebfa
+  data.tar.gz: 6c516e467e086ad79633392393234be4f3b9d0c4265222e91daf0d9f9bb6f41e3efd5adf68930b1dbb2694fc79577bc61d4cbb52bdc67085c87c68393ac25f4a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@daniellobato.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in openscap_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daniel Lobato Garcia
+
+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,54 @@
+# OpenscapParser
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/openscap_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openscap_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openscap_parser
+
+## Usage
+
+ARF/XCCDF report goes IN - Ruby hash goes OUT
+
+{
+	profile
+	host
+	score
+	start_time
+	end_time
+	rule_result
+
+}
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elobato/openscap_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenscapParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elobato/openscap_parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openscap_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openscap_parser/profiles.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenscapParser
+  # Methods related to saving profiles and finding which hosts
+  # they belong to
+  module Profiles
+    def self.included(base)
+      base.class_eval do
+        def profiles
+          @profiles ||= {
+            profile_node['id'] => profile_node.at_css('title').text
+          }
+        end
+
+        private
+
+        def profile_node
+          @report_xml.at_xpath(".//xmlns:Profile\
+                             [contains('#{test_result_node['id']}', @id)]")
+        end
+
+        def test_result_node
+          @test_result_node ||= @report_xml.at_css('TestResult')
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/rule.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Mimics openscap-ruby Rule interface
+module OpenscapParser
+  class Rule
+    def initialize(rule_xml: nil)
+      @rule_xml = rule_xml
+    end
+
+    def id
+      @id ||= @rule_xml['id']
+    end
+
+    def severity
+      @severity ||= @rule_xml['severity']
+    end
+
+    def title
+      @title ||= @rule_xml.at_css('title').children.first.text
+    end
+
+    def description
+      @description ||= @rule_xml.at_css('description').text.delete("\n")
+    end
+
+    def rationale
+      @rationale ||= @rule_xml.at_css('rationale').children.text.delete("\n")
+    end
+  end
+end
+

data/lib/openscap_parser/rule_result.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OpenscapParser
+  class RuleResult
+    attr_accessor :id, :result
+  end
+end
+

data/lib/openscap_parser/rules.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenscapParser
+  # Methods related to parsing rules
+  module Rules
+    def self.included(base)
+      base.class_eval do
+        def rule_ids
+          test_result_node.xpath('.//xmlns:rule-result/@idref').map(&:value)
+        end
+
+        def rule_objects
+          return @rule_objects unless @rule_objects.nil?
+
+          @rule_objects ||= @report_xml.search('Rule').map do |rule|
+            Rule.new(rule_xml: rule)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser/version.rb

@@ -0,0 +1,3 @@
+module OpenscapParser
+  VERSION = "0.1.0"
+end

data/lib/openscap_parser/xml_report.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'nokogiri'
+
+module OpenscapParser
+  # Methods related with parsing directly the XML from the Report
+  # as opposed to using the OpenSCAP APIs
+  module XMLReport
+    def self.included(base)
+      base.class_eval do
+        def host
+          @report_xml.search('target').text
+        end
+
+        def description
+          @report_xml.search('description').first.text
+        end
+
+        def report_xml(report_contents = '')
+          @report_xml ||= ::Nokogiri::XML.parse(report_contents)
+          @report_xml.remove_namespaces! if @report_xml.namespaces.keys.include? 'xmlns:arf'
+        end
+      end
+    end
+  end
+end

data/lib/openscap_parser.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require 'openscap_parser/profiles'
+require 'openscap_parser/rule'
+require 'openscap_parser/rule_result'
+require 'openscap_parser/rules'
+require 'openscap_parser/version'
+require 'openscap_parser/xml_report'
+
+require 'date'
+
+module OpenscapParser
+  class Error < StandardError; end
+
+  class Base
+    include OpenscapParser::XMLReport
+    include OpenscapParser::Profiles
+    include OpenscapParser::Rules
+
+    def initialize(report)
+      report_xml(report)
+    end
+
+    def score
+      test_result_node.search('score').text.to_f
+    end
+
+    def start_time
+      @start_time ||= DateTime.parse(test_result_node['start-time'])
+    end
+
+    def end_time
+      @end_time ||= DateTime.parse(test_result_node['end-time'])
+    end
+
+    def rule_results
+      @rule_results ||= test_result_node.search('rule-result').map do |rr|
+	rule_result_oscap = RuleResult.new
+	rule_result_oscap.id = rr.attributes['idref'].value
+	rule_result_oscap.result = rr.search('result').first.text
+	rule_result_oscap
+      end
+    end
+  end
+end

data/openscap_parser.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openscap_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openscap_parser"
+  spec.version       = OpenscapParser::VERSION
+  spec.authors       = ["Daniel Lobato Garcia"]
+  spec.email         = ["me@daniellobato.me"]
+
+  spec.summary       = %q{Parse OpenSCAP reports}
+ # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    # spec.metadata["homepage_uri"] = spec.homepage
+   # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  # 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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "shoulda-context"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: openscap_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Lobato Garcia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- me@daniellobato.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openscap_parser.rb
+- lib/openscap_parser/profiles.rb
+- lib/openscap_parser/rule.rb
+- lib/openscap_parser/rule_result.rb
+- lib/openscap_parser/rules.rb
+- lib/openscap_parser/version.rb
+- lib/openscap_parser/xml_report.rb
+- openscap_parser.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Parse OpenSCAP reports
+test_files: []