oscal 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3d2839d5707adc52e720080828918e04373d2399cbd138edd403055b1712cc0
-  data.tar.gz: 0fc05ead23c4745d188f9bf359c2594463867fd1cce5256a271cf93befef287e
+  metadata.gz: 562c827a391c4d86af9edb5cdf98ee1a61fb3a7d57374aa29a3a70609df09bb3
+  data.tar.gz: 2031cf36b122b094cb3532bff51534de756907327d7f3bb09456a9120a510607
 SHA512:
-  metadata.gz: 91233436e998fe98ae7d84873ac7d8b68f9fc84ec6f7a7775533ee45922beaeb507c031ed88da4fe0ed71f34e76064861e6e3b0cb340acac23d25b3134cc323f
-  data.tar.gz: 957a56d62c3c43b5d22f4659b993acbd6e85ad344fe042fda702a3e07dda5fed576caf6ad0b742eb783597ac0e1165020af957a8d6c9699b0aad977910a910aa
+  metadata.gz: cbd11774c99f75b1e8b365488fb3fdd4969a7917de692cbf7546118b2a3102767af8b9ed9a140c2998a0d4cff9f282061eeea03da47371b864d67067307433c3
+  data.tar.gz: d7510b9543be93b734be45f0d4140d32413af2d8a5462339bac65db9de3ff9a98c3b696537af73a9f23c1f491e85b269e898008df07da5180b2036e52fdff48a

data/.docker/Dockerfile

@@ -0,0 +1,19 @@
+ARG RUBY_IMAGE=ruby:3.1.2-slim
+
+FROM ${RUBY_IMAGE}
+
+RUN apt-get update \
+    && apt-get install -y build-essential git \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# install latest bundler
+RUN gem install bundler
+
+# Create app directory
+WORKDIR /workspace
+
+# Set bundle path
+ENV BUNDLE_PATH /bundle
+
+# Default to console
+CMD ["bin/console"]

data/.docker/Makefile

@@ -0,0 +1,43 @@
+export SPEC ?= spec
+SPEC_FILE = $(subst ../,, $(SPEC))
+export RUBY_IMAGE ?= ruby:3.1.2-slim
+
+.PHONY: up
+up:
+	docker-compose up
+
+.PHONY: down
+down:
+	docker-compose down
+
+.PHONY: test
+test: rspec
+
+.PHONY: ssh
+ssh:
+	docker-compose run lib bash
+
+.PHONY: install
+install:
+	docker-compose run lib bin/setup
+
+.PHONY: console
+console:
+	docker-compose run lib bin/console
+
+.PHONY: rspec
+rspec:
+	docker-compose run lib bin/rspec ${SPEC_FILE}
+
+.PHONY: rake
+rake:
+	docker-compose run lib bundle exec rake
+
+.PHONY: lint
+lint:
+	docker-compose run lib bundle exec rubocop
+
+.PHONY: setup
+setup:
+	docker-compose build --build-arg RUBY_IMAGE=${RUBY_IMAGE}
+	docker-compose run lib bin/setup

data/.docker/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3"
+
+services:
+  lib:
+    build:
+      context: .
+      dockerfile: ./.docker/Dockerfile
+
+    volumes:
+      - .:/workspace
+      - bundle:/bundle
+
+volumes:
+  bundle:

data/.docker/readme.md

@@ -0,0 +1,61 @@
+## Docker
+
+This directory is only meant to be used for development, and contains some
+necessary setup to spin up docker containers with multiple ruby environment.
+
+### Setup
+
+Before doing anything, you might want to create a symlink to the docker file and
+Makefile. This would allow you to avoid some of the unnecessary work related to
+the file paths To do that run the following from the root of the project.
+
+```
+ln -sf .docker/Makefile .
+ln -sf .docker/docker-compose.yml .
+```
+
+By default it usages the most recent ruby version for docker environment, but if
+you want to run it in any specific version then you can set it up by exporting
+`RUBY_IMAGE` environment variable in your shell:
+
+```sh
+export RUBY_IMAGE=ruby:3.0-buster
+```
+
+Once everything is set then you would need to build the development images for
+the first time and you can do that using:
+
+```sh
+make setup
+```
+
+The setup process will install all dependencies and it will also setup a volume
+to speed up the repeated gem installation.
+
+### Playground
+
+The `Makefile` contains two target for tests, and you can run the tests using
+any of the following commands:
+
+```sh
+make test
+
+# or
+make rspec
+```
+
+If you need more control, and you want to do some development on the go then you
+can get into the container using:
+
+```sh
+make ssh
+```
+
+### Cleanup
+
+Once you are done with your experiment then you can cleanup the docker
+environment using the following command.
+
+```sh
+make down
+```

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+.rubocop-https---**
+Gemfile.lock

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -7,4 +7,4 @@ inherit_from:
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/Gemfile

@@ -12,3 +12,5 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 
 gem "rubocop-performance", "~> 1.16"
+
+gem "debug"

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2023, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Makefile

@@ -0,0 +1 @@
+.docker/Makefile

data/README.adoc

@@ -110,3 +110,6 @@ Everyone interacting in the Oscal project's codebases, issue trackers, chat room
 == LICENSE
 
 Copyright Ribose. The OSCAL schema is published by NIST.
+
+Published under the 2-clause BSD license.
+

data/Rakefile

@@ -3,10 +3,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
+# Note:
+#
+# There seems to be lots of issue with the current rubocop rules
+# We are commenting this out for the moment, so instead of fixing
+# those right away, we can focus on the new codes and then later
+# come back to this and fix the issues.
+#
+# require "rubocop/rake_task"
+# RuboCop::RakeTask.new
+#
+# task default: %i[spec rubocop]
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -14,9 +14,9 @@ require "oscal"
 require "irb"
 
 def reload!(print = true)
-  puts 'Reloading ...' if print
+  puts "Reloading ..." if print
   # Main project directory.
-  root_dir = File.expand_path('..', __dir__)
+  root_dir = File.expand_path("..", __dir__)
   # Directories within the project that should be reloaded.
   reload_dirs = %w{lib}
   # Loop through and reload every file in all relevant project directories.

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/docker-compose.yml

@@ -0,0 +1 @@
+.docker/docker-compose.yml

data/lib/oscal/add.rb

@@ -5,17 +5,18 @@ module Oscal
     KEY = %i(position by_id title params props links parts)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'params'
+      when "params"
         Parameter.wrap(val)
-      when 'props'
+      when "props"
         Property.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
-      when 'part'
+      when "part"
         Part.wrap(val)
       else
         val

data/lib/oscal/address.rb

@@ -5,13 +5,14 @@ module Oscal
     KEY = %i(type addr_lines city state postal_code country)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'addr_lines'
+      when "addr_lines"
         AddressLine.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
       else
         val

data/lib/oscal/address_line.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(val)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/alter.rb

@@ -5,13 +5,14 @@ module Oscal
     KEY = %i(control_id klass removes adds)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'removes'
+      when "removes"
         Remove.wrap(val)
-      when 'adds'
+      when "adds"
         Add.wrap(val)
       else
         val

data/lib/oscal/assembly.rb

@@ -0,0 +1,119 @@
+require_relative "parsing_functions"
+require_relative "logger"
+require_relative "metadata_block"
+
+module Oscal
+  class MetadataBlockWrapper < Oscal::MetadataBlock
+    include ParsingFunctions
+    def initialize(metadata_hash)
+      # MetadataBlock likes to get strings, but may sometimes get symbols
+      # this little function makes sure it gets strings everytime
+      super(metadata_hash.transform_keys { |key| sym2str(key) })
+    end
+  end
+
+  class Assembly
+    include Oscal::ParsingFunctions
+    include Oscal::ParsingLogger
+
+    def mandatory_attributes
+      if self.class.constants.include?(:MANDATORY)
+        self.class::MANDATORY
+      else
+        []
+      end
+    end
+
+    def allowed_attributes
+      if self.class.constants.include?(:OPTIONAL)
+        mandatory_attributes + self.class::OPTIONAL
+      else
+        mandatory_attributes
+      end
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def to_h
+      allowed_attributes.each_with_object({}) do |var, hash|
+        attr_value = method(var).call
+        hash[sym2str(var)] = if attr_value == nil
+                               next
+                             elsif attr_value.class <= OscalArray
+                               attr_value.each(&:to_h)
+                             elsif attr_value.class <= OscalDatatype
+                               attr_value
+                             else
+                               attr_value.to_h
+                             end
+      end
+    end
+
+    def check_and_normalize_input(input)
+      @logger.debug("Checking to see if input is a Hash")
+      unless input.is_a? Hash
+        raise Oscal::InvalidTypeError,
+              "Assemblies can only be created from Hash types"
+      end
+      @logger.debug("Assembly is hash with keys #{input.keys}")
+
+      @logger.debug("Attempting to transform strings to symbols.")
+      # Transform the keys from Strings to Symbols
+      input.transform_keys { |key| str2sym(key) }
+    end
+
+    def validate_input(input)
+      @logger.debug("Checking mandatory and optional values.")
+      missing_values?(mandatory_attributes, input)
+      extra_values?(allowed_attributes, input)
+    end
+
+    def missing_values?(mandatory, provided)
+      @logger.debug("Checking mandatory values: #{mandatory}")
+      missing_values = mandatory - provided.keys.intersection(mandatory)
+      if missing_values.length.positive?
+        raise Oscal::InvalidTypeError,
+              "Missing mandatory values: #{missing_values}"
+      end
+    end
+
+    def extra_values?(allowed, provided)
+      @logger.debug("Checking allowed values: #{allowed}")
+      extra_values = provided.keys - provided.keys.intersection(allowed)
+      if extra_values.length.positive?
+        raise Oscal::InvalidTypeError,
+              "Extra attributes provided #{extra_values}"
+      end
+    end
+
+    def validate_content(key, value)
+      @logger.info("Validating #{value}")
+      expected_class = Oscal::get_type_of_attribute(key)
+      @logger.debug("Attempting to instiate #{key} as #{expected_class}")
+      instantiated = expected_class.new(value)
+    rescue Oscal::InvalidTypeError
+      raise Oscal::InvalidTypeError,
+            "Value #{value.to_s[0, 25]} not a valid #{key}"
+    else
+      instantiated # Return the valid class
+    end
+
+    def initialize(input)
+      @logger = get_logger
+      @logger.debug("#{self.class}.new called with #{input.to_s[0, 25]}")
+
+      # covert String:String to Symbol:String
+      sym_hash = check_and_normalize_input(input)
+
+      # Make sure all required and no extra keys are provided
+      validate_input(sym_hash)
+
+      # Attempt to convert each value to it's registered type
+      sym_hash.each do |key, value|
+        method("#{key}=".to_sym).call(validate_content(key, value))
+      end
+    end
+  end
+end

data/lib/oscal/assessment_plan.rb

@@ -0,0 +1,28 @@
+require_relative "assembly"
+require_relative "metadata_block"
+require_relative "datatypes"
+
+module Oscal
+  module AssessmentPlan
+    class ImportSSP < Assembly
+      attr_accessor(*(MANDATORY = %i(href).freeze),
+                    *(OPTIONAL = %i(remarks).freeze))
+    end
+
+    class ReviewedControls < Assembly
+      attr_accessor(*(MANDATORY = %i(control_selections).freeze),
+                    *(OPTIONAL = %i(description props links
+                                    control_objective_selections
+                                    remarks).freeze))
+    end
+
+    class AssessmentPlan < Assembly
+      attr_accessor(*(MANDATORY = %i(uuid metadata import_ssp
+                                     reviewed_controls).freeze),
+                    *(OPTIONAL = %i(local_definitions terms_and_conditions
+                                    reviewed_controls assessment_subjects
+                                    assessment_assets tasks
+                                    back_matter).freeze))
+    end
+  end
+end