ruby-stix2 0.1.3 → 0.1.4

data/lib/stix2/exception.rb

@@ -0,0 +1,131 @@
+module Stix2
+  module Exception
+    class Base < StandardError
+    end
+
+    class PropertyMissing < Base
+      def initialize(property_name)
+        @property_name = property_name
+      end
+
+      def message
+        "Property '#{@property_name}' is missing"
+      end
+    end
+
+    class MessageUnsupported < Base
+      def initialize(type)
+        @type = type
+      end
+
+      def message
+        "Message unsupported: '#{@type}'"
+      end
+    end
+
+    class BadType < Base
+      def initialize(type)
+        @type = type
+      end
+
+      def message
+        "Property 'type' must be '#{@type}'"
+      end
+    end
+
+    class InvalidValues < Base
+      def initialize(values)
+        @values = Array(values)
+      end
+
+      def message
+        pluralized_value = "value"
+        pluralized_value += "s" if @values.size > 1
+        "Invalid #{pluralized_value}: #{@values.join(", ")}"
+      end
+    end
+
+    class StorageInactive < Base
+      def message
+        "Stix2::Storage must be active to use toplevel-property-extension"
+      end
+    end
+
+    class InvalidExtensionNameFormat < Base
+      def initialize(name)
+        @name = name
+      end
+
+      def message
+        "Invalid extension name format: #{@name}"
+      end
+    end
+
+    class CustomExtensionFormat < Base
+      def initialize(value)
+        @value = value
+      end
+
+      def message
+        "Custom extension value must be Hash. Got: #{@value}"
+      end
+    end
+
+    class PropertyInvalidName < Base
+      def initialize(property_name)
+        @property_name = property_name
+      end
+
+      def message
+        "Invalid property name: #{@property_name}. Valid chars: a-z, 0-9 and _"
+      end
+    end
+
+    class PropertyInvalidSize < Base
+      def initialize(property_name)
+        @property_name = property_name
+      end
+
+      def message
+        "Invalid property size for #{@property_name}. Size must be > 3 and < 250"
+      end
+    end
+
+    class InvalidIdentifier < Base
+      def initialize(value)
+        @value = value
+      end
+
+      def message
+        "Invalid identifier: #{@value}"
+      end
+    end
+
+    class PropertyDefinitionSize < Base
+      def initialize(size)
+        @size = size
+      end
+
+      def message
+        "Property 'definition' must contain a single key. Got #{size} instead"
+      end
+    end
+
+    class PropertyDefinitionMatching < Base
+      def message
+        "Property 'definition_type' and 'definition' must have a matching key"
+      end
+    end
+
+    class InvalidRange < Base
+      def initialize(valid_range, value)
+        @valid_range = valid_range
+        @value = value
+      end
+
+      def message
+        "Invalid value #{@value} for range #{@valid_range}"
+      end
+    end
+  end
+end

data/lib/stix2/extension_definition.rb

@@ -4,7 +4,18 @@ module Stix2
     property :description, coerce: String
     property :schema, required: true, coerce: String
     property :version, required: true, coerce: String
-    property :extension_types, required: true, coerce: ->(values) { validate_array(values, EXTENSION_TYPE_ENUM) }
+    property :extension_types, required: true, coerce: [String]
     property :extension_properties, coerce: [String]
+
+    def initialize(args = {})
+      super
+      validate_extension_types!
+    end
+
+    private
+
+    def validate_extension_types!
+      Stix2::Validators::Array.new(extension_types, Stix2::EXTENSION_TYPE_ENUM)
+    end
   end
 end

data/lib/stix2/extensions/alternate_data_stream_type.rb

@@ -2,8 +2,19 @@ module Stix2
   module Extensions
     class AlternateDataStreamType < Stix2::Base
       property :name, required: true, coerce: String
-      property :hashes, coerce: ->(hsh) { hash_dict(hsh) }
+      property :hashes, coerce: Hash
       property :size, coerce: Integer
+
+      def initialize(args = {})
+        super
+        validate_hashes! if @strict
+      end
+
+      private
+
+      def validate_hashes!
+        Stix2::Validators::Hashes.new(hashes)
+      end
     end
   end
 end

data/lib/stix2/extensions/icmp.rb

@@ -1,8 +1,24 @@
 module Stix2
   module Extensions
     class Icmp < Stix2::Base
-      property :icmp_type_hex, required: true, coerce: ->(value) { Stix2.is_hex?(value) && value }
-      property :icmp_code_hex, required: true, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :icmp_type_hex, required: true, coerce: String
+      property :icmp_code_hex, required: true, coerce: String
+
+      def initialize(args = {})
+        super
+        validate_icmp_type_hex! if @strict
+        validate_icmp_code_hex! if @strict
+      end
+
+      private
+
+      def validate_icmp_type_hex!
+        Stix2::Validators::Hex.new(icmp_type_hex)
+      end
+
+      def validate_icmp_code_hex!
+        Stix2::Validators::Hex.new(icmp_code_hex)
+      end
     end
   end
 end

data/lib/stix2/extensions/pdf.rb

@@ -2,7 +2,7 @@ module Stix2
   module Extensions
     class Pdf < Stix2::Base
       property :version, coerce: String
-      property :is_optimized, coerce: ->(value) { Stix2.to_bool(value) }
+      property :is_optimized, coerce: Stix2.bool
       property :document_info_dict, {String => String}
       property :pdfid0, coerce: String
       property :pdfid1, coerce: String

data/lib/stix2/extensions/socket.rb

@@ -2,9 +2,9 @@ module Stix2
   module Extensions
     class Socket < Stix2::Base
       property :address_family, required: true, values: NETWORK_SOCKET_ADDRESS_FAMILY_ENUM
-      property :is_blocking, coerce: ->(value) { Stix2.to_bool(value) }
-      property :is_listening, coerce: ->(value) { Stix2.to_bool(value) }
-      property :options, coerce: ->(hsh) { hsh.keys.all? { |k| k.is_a?(Integer) } && hsh }
+      property :is_blocking, coerce: Stix2.bool
+      property :is_listening, coerce: Stix2.bool
+      property :options, coerce: {String => Integer}
       property :socket_type, values: NETWORK_SOCKET_TYPE_ENUM
       property :socket_descriptor, coerce: Integer
       property :socket_handle, coerce: Integer

data/lib/stix2/extensions/tcp.rb

@@ -1,8 +1,24 @@
 module Stix2
   module Extensions
     class Tcp < Stix2::Base
-      property :src_flags_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
-      property :dst_flags_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :src_flags_hex, coerce: String
+      property :dst_flags_hex, coerce: String
+
+      def initialize(args = {})
+        super
+        validate_src_flags_hex! if @strict
+        validate_dst_flags_hex! if @strict
+      end
+
+      private
+
+      def validate_src_flags_hex!
+        Stix2::Validators::Hex.new(src_flags_hex)
+      end
+
+      def validate_dst_flags_hex!
+        Stix2::Validators::Hex.new(dst_flags_hex)
+      end
     end
   end
 end

data/lib/stix2/extensions/windows_pe_optional_header_type.rb

@@ -1,7 +1,7 @@
 module Stix2
   module Extensions
     class WindowsPeOptionalHeaderType < Stix2::Base
-      property :magic_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :magic_hex, coerce: String
       property :major_linker_version, coerce: Integer
       property :minor_linker_version, coerce: Integer
       property :size_of_code, coerce: Integer
@@ -19,19 +19,60 @@ module Stix2
       property :minor_image_version, coerce: Integer
       property :major_subsystem_version, coerce: Integer
       property :minor_subsystem_version, coerce: Integer
-      property :win32_version_value_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :win32_version_value_hex, coerce: String
       property :size_of_image, coerce: Integer
       property :size_of_headers, coerce: Integer
-      property :checksum_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
-      property :subsystem_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
-      property :dll_characteristics_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :checksum_hex, coerce: String
+      property :subsystem_hex, coerce: String
+      property :dll_characteristics_hex, coerce: String
       property :size_of_stack_reserve, coerce: Integer
       property :size_of_stack_commit, coerce: Integer
       property :size_of_heap_reserve, coerce: Integer
       property :size_of_heap_commit, coerce: Integer
-      property :loader_flags_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :loader_flags_hex, coerce: String
       property :number_of_rva_and_sizes, coerce: Integer
-      property :hashes, coerce: ->(hsh) { hash_dict(hsh) }
+      property :hashes, coerce: Hash
+
+      def initialize(args = {})
+        super
+        validate_hashes! if @strict
+        validate_magic_hex! if @strict
+        validate_win32_version_value_hex! if @strict
+        validate_checksum_hex! if @strict
+        validate_subsystem_hex! if @strict
+        validate_dll_characteristics_hex! if @strict
+        validate_loader_flags_hex! if @strict
+      end
+
+      private
+
+      def validate_hashes!
+        Stix2::Validators::Hashes.new(hashes)
+      end
+
+      def validate_magic_hex!
+        Stix2::Validators::Hex.new(magic_hex)
+      end
+
+      def validate_win32_version_value_hex!
+        Stix2::Validators::Hex.new(win32_version_value_hex)
+      end
+
+      def validate_checksum_hex!
+        Stix2::Validators::Hex.new(checksum_hex)
+      end
+
+      def validate_subsystem_hex!
+        Stix2::Validators::Hex.new(subsystem_hex)
+      end
+
+      def validate_dll_characteristics_hex!
+        Stix2::Validators::Hex.new(dll_characteristics_hex)
+      end
+
+      def validate_loader_flags_hex!
+        Stix2::Validators::Hex.new(loader_flags_hex)
+      end
     end
   end
 end

data/lib/stix2/extensions/windows_pe_section_type.rb

@@ -4,7 +4,18 @@ module Stix2
       property :name, required: true, coerce: String
       property :size, coerce: Integer
       property :entropy, coerce: Float
-      property :hashes, coerce: ->(hsh) { hash_dict(hsh) }
+      property :hashes, coerce: Hash
+
+      def initialize(args = {})
+        super
+        validate_hashes! if @strict
+      end
+
+      private
+
+      def validate_hashes!
+        Stix2::Validators::Hashes.new(hashes)
+      end
     end
   end
 end

data/lib/stix2/extensions/windows_pebinary.rb

@@ -6,16 +6,42 @@ module Stix2
     class WindowsPebinary < Stix2::Base
       property :pe_type, required: true, values: WINDOWS_PEBINARY_TYPE_OV
       property :imphash, coerce: String
-      property :machine_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :machine_hex, coerce: String
       property :number_of_sections, coerce: Integer
       property :time_date_stamp, coerce: Time
-      property :pointer_to_symbol_table_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
+      property :pointer_to_symbol_table_hex, coerce: String
       property :number_of_symbols, coerce: Integer
       property :size_of_optional_header, coerce: Integer
-      property :characteristics_hex, coerce: ->(value) { Stix2.is_hex?(value) && value }
-      property :file_header_hashes, coerce: ->(hsh) { hash_dict(hsh) }
+      property :characteristics_hex, coerce: String
+      property :file_header_hashes, coerce: Hash
       property :optional_header, coerce: WindowsPeOptionalHeaderType
       property :sections, coerce: [WindowsPeSectionType]
+
+      def initialize(args = {})
+        super
+        validate_file_header_hashes! if @strict
+        validate_machine_hex! if @strict
+        validate_pointer_to_symbol_table_hex! if @strict
+        validate_characteristics_hex! if @strict
+      end
+
+      private
+
+      def validate_file_header_hashes!
+        Stix2::Validators::Hashes.new(file_header_hashes)
+      end
+
+      def validate_machine_hex!
+        Stix2::Validators::Hex.new(machine_hex)
+      end
+
+      def validate_pointer_to_symbol_table_hex!
+        Stix2::Validators::Hex.new(pointer_to_symbol_table_hex)
+      end
+
+      def validate_characteristics_hex!
+        Stix2::Validators::Hex.new(characteristics_hex)
+      end
     end
   end
 end

data/lib/stix2/extensions/windows_process.rb

@@ -1,8 +1,8 @@
 module Stix2
   module Extensions
     class WindowsProcess < Stix2::Base
-      property :aslr_enabled, coerce: ->(value) { Stix2.to_bool(value) }
-      property :dep_enabled, coerce: ->(value) { Stix2.to_bool(value) }
+      property :aslr_enabled, coerce: Stix2.bool
+      property :dep_enabled, coerce: Stix2.bool
       property :priority, coerce: String
       property :owner_sid, coerce: String
       property :window_title, coerce: String

data/lib/stix2/external_reference.rb

@@ -3,7 +3,18 @@ module Stix2
     property :source_name, coerce: String, required: true
     property :description, coerce: String
     property :url, coerce: String
-    property :hashes, coerce: ->(hsh) { hash_dict(hsh) }
+    property :hashes, coerce: Hash
     property :external_id, coerce: String
+
+    def initialize(args = {})
+      super
+      validate_hashes! if @strict
+    end
+
+    private
+
+    def validate_hashes!
+      Stix2::Validators::Hashes.new(hashes)
+    end
   end
 end

data/lib/stix2/identifier.rb

@@ -1,8 +1,8 @@
 module Stix2
   class Identifier < String
     def initialize(value)
-      value.match(/.*--.*/) || raise("Invalid identifier: #{value}")
-      super(value)
+      value.match(/.*--.*/) || raise(Exception::InvalidIdentifier.new(value))
+      super
     end
   end
 end

data/lib/stix2/meta_objects/data_markings/marking_definition.rb

@@ -6,11 +6,17 @@ module Stix2
         property :definition_type, required: true, coerce: String
         property :definition, required: true, coerce: {String => String}
 
-        def initialize(args)
-          super(args)
-          raise("Property 'definition' must contain a single key") if definition.size > 1
+        def initialize(args = {})
+          super
+          validate_definitions!
+        end
+
+        private
+
+        def validate_definitions!
+          raise(Exception::PropertyDefinitionSize.new(definition.size)) if definition.size > 1
           if definition_type != definition.keys.first
-            raise("Property 'definition_type' and 'definition' must have a matching key")
+            raise(Exception::PropertyDefinitionMatching.new)
           end
         end
       end

data/lib/stix2/meta_objects/data_markings/object_marking.rb

@@ -3,8 +3,8 @@ module Stix2
     module DataMarking
       class ObjectMarking < String
         def initialize(value)
-          value.match(/marking-definition--.*/) || raise("Invalid value: #{value}")
-          super(value)
+          value.match(/marking-definition--.*/) || raise(Exception::InvalidValues.new(value))
+          super
         end
       end
     end

data/lib/stix2/meta_objects/language_content.rb

@@ -3,7 +3,18 @@ module Stix2
     class LanguageContent < Base
       property :object_ref, coerce: Identifier
       property :object_modified, coerce: Time
-      property :contents, coerce: ->(hsh) { validate_array(hsh.keys, Stix2::RFC5646_LANGUAGE_TAGS.keys) && hsh }
+      property :contents, coerce: Hash
+
+      def initialize(args = {})
+        super
+        validate_content! if @strict
+      end
+
+      private
+
+      def validate_content!
+        Stix2::Validators::Array.new(contents.keys, Stix2::RFC5646_LANGUAGE_TAGS.keys) if contents
+      end
     end
   end
 end

data/lib/stix2/relationship_objects/relationship.rb

@@ -8,7 +8,7 @@ module Stix2
       property :start_time, coerce: Time
       property :stop_time, coerce: Time
 
-      def initialize(args)
+      def initialize(args = {})
         if !args[:relationship_type] && args[:source_ref] && args[:target_ref]
           objects = DOMAIN_OBJECTS + CYBEROBSERVABLE_OBJECTS
           source_type = type_by_id(args[:source_ref])
@@ -18,7 +18,8 @@ module Stix2
           args[:relationship_type] = relationships.first unless relationships.empty?
         end
 
-        super(args)
+        super
+        validate_relationship_type! if @strict
       end
 
       COMMON_RELATIONSHIPS = ["related-to", "derived-from", "duplicate-of"].freeze
@@ -160,6 +161,10 @@ module Stix2
       def type_by_id(id)
         id.split("--").first
       end
+
+      def validate_relationship_type!
+        relationship_type.match?(/[a-z0-9-]/) || raise(Exception::InvalidValues.new(relationship_type))
+      end
     end
   end
 end

data/lib/stix2/relationship_objects/sighting.rb

@@ -8,7 +8,7 @@ module Stix2
       property :sighting_of_ref, required: true, coerce: String
       property :observed_data_refs, coerce: [String]
       property :where_sighted_refs, coerce: [String]
-      property :summary, coerce: ->(v) { Stix2.to_bool(v) }
+      property :summary, coerce: Stix2.bool
     end
   end
 end

data/lib/stix2/validators/array.rb

@@ -0,0 +1,11 @@
+module Stix2
+  module Validators
+    class Array
+      def initialize(values, array)
+        raise(ArgumentError.new("array argument must be an actual array. Got: #{array.class}")) if !array.is_a?(::Array)
+        excess = Array(values).map(&:to_s) - array.map(&:to_s)
+        raise(Exception::InvalidValues.new(excess)) if !excess.empty?
+      end
+    end
+  end
+end

data/lib/stix2/validators/hashes.rb

@@ -0,0 +1,11 @@
+module Stix2
+  module Validators
+    class Hashes
+      def initialize(hsh)
+        return if !hsh
+        raise(ArgumentError.new("hash argument must be an actual hash. Got: #{hsh.class}")) if !hsh.is_a?(::Hash)
+        Stix2::Validators::Array.new(hsh.keys, Stix2::HASH_ALGORITHM_OV)
+      end
+    end
+  end
+end

data/lib/stix2/validators/hex.rb

@@ -0,0 +1,10 @@
+module Stix2
+  module Validators
+    class Hex
+      def initialize(value)
+        return if !value
+        value.match?(/^\h*$/) || raise(Exception::InvalidValues.new(value))
+      end
+    end
+  end
+end

data/lib/stix2/version.rb

@@ -1,3 +1,3 @@
 module Stix2
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/stix2.rb

@@ -3,6 +3,7 @@ require "json"
 require "time"
 
 require "stix2/version"
+require "stix2/bool"
 require "stix2/ov"
 require "stix2/enum"
 require "stix2/base"
@@ -11,10 +12,15 @@ require "stix2/external_reference"
 require "stix2/identifier"
 require "stix2/kill_chain_phase"
 
+require "stix2/validators/array"
+require "stix2/validators/hashes"
+require "stix2/validators/hex"
+
 require "stix2/meta_objects/data_markings/granular_marking"
 require "stix2/meta_objects/data_markings/object_marking"
 
 require "stix2/common"
+require "stix2/exception"
 require "stix2/domain_objects/base"
 require "stix2/domain_objects/attack_pattern"
 require "stix2/domain_objects/campaign"
@@ -105,7 +111,7 @@ module Stix2
     end
     Hashie.symbolize_keys!(options_)
     type = options_[:type]
-    raise("Property 'type' is missing") if !type
+    raise Exception::PropertyMissing.new("type") if !type
     # Let's try to guess the domain of the object, among the known ones
     [nil, "DomainObject", "RelationshipObject", "CyberobservableObject", "MetaObject",
       "MetaObject::DataMarking"].each do |family|
@@ -116,14 +122,6 @@ module Stix2
       end
       return Module.const_get(class_name).new(options_) if Module.const_defined?(class_name)
     end
-    raise("Message unsupported: #{type}")
-  end
-
-  def self.to_bool(value)
-    (value == true) || (value == "true")
-  end
-
-  def self.is_hex?(value)
-    value.match?(/^\h*$/)
+    raise Exception::MessageUnsupported.new(type)
   end
 end

data/ruby-stix2.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "irb", "~> 1.7.0"
   spec.add_development_dependency "mutex_m", "~> 0.2.0"
   spec.add_development_dependency "standardrb", "~> 1.0.1"
+  spec.add_development_dependency "ostruct", "~> 0.6.1"
+  spec.add_development_dependency "logger", "~> 1.6.5"
 end