oscal 0.1.0 → 0.2.0

data/lib/oscal/common_utils.rb

@@ -0,0 +1,35 @@
+module Oscal
+  module CommonUtils
+    def find_object_by_id(id, obj = self, attribute_name = :id)
+      if obj.respond_to?(attribute_name) && obj.send(attribute_name) == id
+        return obj
+      end
+
+      res = nil
+
+      obj.instance_variables.each do |ins_var|
+        val = obj.send(ins_var.to_s.delete("@").to_sym)
+
+        if val.is_a? Array
+          val.each do |v|
+            res = find_object_by_id(id, v, attribute_name.to_sym)
+            break unless res.nil?
+          end
+        else
+          res = find_object_by_id(id, val, attribute_name.to_sym)
+        end
+
+        break unless res.nil?
+      end
+
+      res
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/lib/oscal/constraint.rb

@@ -0,0 +1,20 @@
+require_relative "base_class"
+
+module Oscal
+  class Constraint < Oscal::BaseClass
+    KEY = %i(description tests)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "test"
+        Test.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/control.rb

@@ -1,37 +1,27 @@
-module Oscal
-  class Control
-    KEY = %i(id title params props parts)
-    attr_accessor *KEY
-
-    def self.wrap(obj)
-      return obj if obj.is_a? Control
-      return Control.new(obj) unless obj.is_a? Array
-
-      obj.map do |x|
-        Control.wrap(x)
-      end
-    end
+require_relative "base_class"
 
-    def initialize(options={})
-      options.each_pair.each do |key,val|
-        key_name = key.gsub('-','_')
+module Oscal
+  class Control < Oscal::BaseClass
+    KEY = %i(id klass title params props links parts controls)
 
-        unless KEY.include?(key_name.to_sym)
-          raise UnknownAttributeError.new("Unknown key `#{key}` in Control")
-        end
+    attr_accessor *KEY
 
-        val = case key_name
-        when 'params'
-          Parameter.wrap(val)
-        when 'props'
-          Property.wrap(val)
-        when 'parts'
-          Part.wrap(val)
-        else
-          val
-        end
+    attr_serializable *KEY
 
-        self.send("#{key_name}=", val)
+    def set_value(key_name, val)
+      case key_name
+      when "params"
+        Parameter.wrap(val)
+      when "props"
+        Property.wrap(val)
+      when "links"
+        Link.wrap(val)
+      when "parts"
+        Part.wrap(val)
+      when "controls"
+        Control.wrap(val)
+      else
+        val
       end
     end
   end

data/lib/oscal/custom.rb

@@ -0,0 +1,22 @@
+require_relative "base_class"
+
+module Oscal
+  class Custom < Oscal::BaseClass
+    KEY = %i(groups insert_controls)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "groups"
+        Group.wrap(val)
+      when "insert_controls"
+        InsertControl.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/datatypes.rb

@@ -0,0 +1,50 @@
+module Oscal
+  class OscalDatatype < String
+    include ParsingLogger
+
+    def validate(value)
+      @logger.debug("validating against pattern #{self.class::PATTERN}")
+      unless self.class::PATTERN.match?(value)
+        raise Oscal::InvalidTypeError,
+              "#{value.to_s[0, 25]} does not match Pattern for #{self.class}"
+      end
+    end
+
+    def initialize(input)
+      super
+      @logger = get_logger
+      @logger.debug("#{self.class}.new called with #{input.to_s[0, 25]}")
+      validate(input) # Will raise an Error if invalid
+      @logger.debug("validation successful.")
+    end
+
+    def to_s
+      @value
+    end
+  end
+
+  class DateTimeWithTimezoneDataType < OscalDatatype
+    PATTERN = /(((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30)))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|(-((0[0-9]|1[0-2]):00|0[39]:30)|\+((0[0-9]|1[0-4]):00|(0[34569]|10):30|(0[58]|12):45)))/
+  end
+
+  class MarkupMultilineDataType < OscalDatatype
+    # Note that there are complex rules for MarkupMultilineDataType that we are ignoring
+    PATTERN = /.*/
+  end
+
+  class StringDataType < OscalDatatype
+    PATTERN = /\S(.*\S)?/
+  end
+
+  class TokenDataType < OscalDatatype
+    PATTERN = /(\p{L}|_)(\p{L}|\p{N}|[.\-_])*/
+  end
+
+  class UriReference < OscalDatatype
+    PATTERN = %r{^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?}
+  end
+
+  class Uuid < OscalDatatype
+    PATTERN = /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$/
+  end
+end

data/lib/oscal/document_id.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class DocumentId < Oscal::BaseClass
+    KEY = %i(schema identifier)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/email_address.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class EmailAddress < Oscal::BaseClass
+    KEY = %i(val)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/exclude_control.rb

@@ -0,0 +1,22 @@
+require_relative "base_class"
+
+module Oscal
+  class ExcludeControl < Oscal::BaseClass
+    KEY = %i(with_child_controls with_ids matching)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "with_ids"
+        WithId.wrap(val)
+      when "matching"
+        Matching.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/external_id.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class ExternalId < Oscal::BaseClass
+    KEY = %i(schema id)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/group.rb

@@ -1,41 +1,33 @@
-module Oscal
-  class Group
-    KEYS = %i(id class title controls props parts groups)
-    attr_accessor *KEYS
-
-    def self.wrap(obj)
-      return obj if obj.is_a? Group
-      return Group.new(obj) unless obj.is_a? Array
+require_relative "base_class"
 
-      obj.map do |x|
-        Group.wrap(x)
-      end
-    end
-
-    def initialize(options={})
-      options.each_pair.each do |key,val|
-        key_name = key.gsub('-','_')
+module Oscal
+  class Group < Oscal::BaseClass
+    KEY = %i(id klass title params props links parts groups
+             controls insert_controls)
 
-        unless KEYS.include?(key_name.to_sym)
-          raise UnknownAttributeError.new("Unknown key `#{key}` in Group")
-        end
+    attr_accessor *KEY
 
-        val = case key_name
-        when 'groups'
-          Group.wrap(val)
-        when 'params'
-          Parameter.wrap(val)
-        when 'props'
-          Property.wrap(val)
-        when 'parts'
-          Part.wrap(val)
-        else
-          val
-        end
+    attr_serializable *KEY
 
-        self.send("#{key_name}=", val)
+    def set_value(key_name, val)
+      case key_name
+      when "params"
+        Parameter.wrap(val)
+      when "props"
+        Property.wrap(val)
+      when "links"
+        Link.wrap(val)
+      when "parts"
+        Part.wrap(val)
+      when "groups"
+        Group.wrap(val)
+      when "controls"
+        Control.wrap(val)
+      when "insert_controls"
+        InsertControl.wrap(val)
+      else
+        val
       end
     end
-
   end
-end
+end

data/lib/oscal/guideline.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class Guideline < Oscal::BaseClass
+    KEY = %i(prose)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/hash_object.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class HashObject < Oscal::BaseClass
+    KEY = %i(algorithm value)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/import_object.rb

@@ -0,0 +1,22 @@
+require_relative "base_class"
+
+module Oscal
+  class ImportObject < Oscal::BaseClass
+    KEY = %i(href include_all include_controls exclude_controls)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "include_controls"
+        IncludeControl.wrap(val)
+      when "exclude_controls"
+        ExcludeControl.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/include_control.rb

@@ -0,0 +1,22 @@
+require_relative "base_class"
+
+module Oscal
+  class IncludeControl < Oscal::BaseClass
+    KEY = %i(with_child_controls with_ids matching)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "with_ids"
+        WithId.wrap(val)
+      when "matching"
+        Matching.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/insert_control.rb

@@ -0,0 +1,22 @@
+require_relative "base_class"
+
+module Oscal
+  class InsertControl < Oscal::BaseClass
+    KEY = %i(order include_all include_controls exclude_controls)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "include_controls"
+        IncludeControl.wrap(val)
+      when "exclude_controls"
+        ExcludeControls.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/link.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class Link < Oscal::BaseClass
+    KEY = %i(href rel media_type text)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/list.rb

@@ -0,0 +1,160 @@
+require_relative("link")
+require_relative("property")
+require_relative("logger")
+
+module Oscal
+  class OscalArray < Array
+    include ParsingLogger
+
+    def validate_member_type(input)
+      @logger.debug("Validating array members are #{self.class::MEMBER_TYPE}")
+      input.map do |item|
+        self.class::MEMBER_TYPE.new(item)
+      end
+    end
+
+    def initialize(input)
+      super
+      @logger = get_logger
+      @logger.debug("#{self.class}.new called with #{input.to_s[0, 25]}")
+      validate_member_type(input)
+    end
+  end
+
+  # These classes define generic arrays of basic DataTypes,
+  # They appear in several different places in the Oscal specs
+  # and can be subclassed with a different name
+  class StringDataTypeArray < Oscal::OscalArray
+    MEMBER_TYPE = StringDataType
+  end
+
+  class TokenDataTypeArray < Oscal::OscalArray
+    MEMBER_TYPE = TokenDataType
+  end
+
+  class UuidArray < Oscal::OscalArray
+    MEMBER_TYPE = Uuid
+  end
+
+  module AssessmentResult
+    class ActivityArray < Oscal::OscalArray
+      MEMBER_TYPE = Activity
+    end
+
+    class AssessmentPlatformArray < Oscal::OscalArray
+      MEMBER_TYPE = AssessmentPlatform
+    end
+
+    class AssessmentTaskArray < Oscal::OscalArray
+      MEMBER_TYPE = AssessmentTask
+    end
+
+    class AssociatedActivityArray < Oscal::OscalArray
+      MEMBER_TYPE = AssociatedActivity
+    end
+
+    class AttestationArray < Oscal::OscalArray
+      MEMBER_TYPE = Attestation
+    end
+
+    class ComponentArray < Oscal::OscalArray
+      MEMBER_TYPE = Component
+    end
+
+    class ControlObjectiveSelectionArray < Oscal::OscalArray
+      MEMBER_TYPE = ControlObjectiveSelection
+    end
+
+    class ControlSelectionArray < Oscal::OscalArray
+      MEMBER_TYPE = ControlSelection
+    end
+
+    class EntryArray < Oscal::OscalArray
+      MEMBER_TYPE = Entry
+    end
+
+    class ExcludeControlArray < Oscal::OscalArray
+      MEMBER_TYPE = ExcludeControl
+    end
+
+    class ExcludeObjectiveArray < Oscal::OscalArray
+      MEMBER_TYPE = ExcludeObjective
+    end
+
+    class FindingArray < Oscal::OscalArray
+      MEMBER_TYPE = Finding
+    end
+
+    class IncludeControlArray < Oscal::OscalArray
+      MEMBER_TYPE = IncludeControl
+    end
+
+    class InventoryItemArray < Oscal::OscalArray
+      MEMBER_TYPE = InventoryItem
+    end
+
+    class LinkArray < Oscal::OscalArray
+      MEMBER_TYPE = Oscal::Link
+    end
+
+    class MethodArray < StringDataTypeArray
+    end
+
+    class ObjectivesAndMethodsArray < Oscal::OscalArray
+      MEMBER_TYPE = ObjectivesAndMethods
+    end
+
+    class ObservationArray < Oscal::OscalArray
+      MEMBER_TYPE = Observation
+    end
+
+    class PartArray < Oscal::OscalArray
+      MEMBER_TYPE = Link
+    end
+
+    class PartyUuidArray < UuidArray
+    end
+
+    class PropArray < Oscal::OscalArray
+      MEMBER_TYPE = Property
+    end
+
+    class RelatedObservationArray < Oscal::OscalArray
+      MEMBER_TYPE = RelatedObservation
+    end
+
+    class RelatedRiskArray < Oscal::OscalArray
+      MEMBER_TYPE = AssociatedRisk
+    end
+
+    class ResponsibleRoleArray < Oscal::OscalArray
+      MEMBER_TYPE = ResponsibleRole
+    end
+
+    class ResultArray < Oscal::OscalArray
+      MEMBER_TYPE = Result
+    end
+
+    class RiskArray < Oscal::OscalArray
+      MEMBER_TYPE = Risk
+    end
+
+    class StatementIdArray < TokenDataTypeArray
+    end
+
+    class StepArray < Oscal::OscalArray
+      MEMBER_TYPE = Step
+    end
+
+    class SubjectArray < Oscal::OscalArray
+      MEMBER_TYPE = Subject
+    end
+
+    class TypeArray < TokenDataTypeArray
+    end
+
+    class UserArray < Oscal::OscalArray
+      MEMBER_TYPE = User
+    end
+  end
+end

data/lib/oscal/location.rb

@@ -0,0 +1,31 @@
+require_relative "base_class"
+
+module Oscal
+  class Location < Oscal::BaseClass
+    KEY = %i(uuid title address email_addresses telephone_numbers urls
+             props links remakrs)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "address"
+        Address.wrap(val)
+      when "email_addresses"
+        EmailAddress.wrap(val)
+      when "telephone_numbers"
+        TelephoneNumber.wrap(val)
+      when "urls"
+        Url.wrap(val)
+      when "props"
+        Property.wrap(val)
+      when "links"
+        Link.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/location_uuid.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class LocationUuid < Oscal::BaseClass
+    KEY = %i(val)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/logger.rb

@@ -0,0 +1,8 @@
+module Oscal
+  module ParsingLogger
+    require "logger"
+    def get_logger
+      Logger.new($stdout)
+    end
+  end
+end

data/lib/oscal/matching.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class Matching < Oscal::BaseClass
+    KEY = %i(pattern)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/member_of_organization.rb

@@ -0,0 +1,11 @@
+require_relative "base_class"
+
+module Oscal
+  class MemberOfOrganization < Oscal::BaseClass
+    KEY = %i(val)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/merge.rb

@@ -0,0 +1,20 @@
+require_relative "base_class"
+
+module Oscal
+  class Merge < Oscal::BaseClass
+    KEY = %i(combine flat as_is custom)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "custom"
+        Custom.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end