nvd-json_feeds 0.1.0

data/lib/nvd/json_feeds/schema/configurations/node.rb

@@ -0,0 +1,98 @@
+require 'nvd/json_feeds/schema/cpe/match'
+
+module NVD
+  module JSONFeeds
+    module Schema
+      class Configurations
+        #
+        # Represents a value within `"nodes"`.
+        #
+        class Node
+
+          OPERATORS = {
+            'OR'  => :OR,
+            'AND' => :AND
+          }
+
+          # @return [:OR, :AND, String]
+          attr_reader :operator
+
+          # @return [Boolean, nil]
+          attr_reader :negate
+
+          # @return [Array<Node>]
+          attr_reader :children
+
+          # @return [Array<CPE::Match>]
+          attr_reader :cpe_match
+
+          #
+          # Initializes the node.
+          #
+          # @param [:OR, :AND, String] operator
+          #
+          # @param [Boolean, nil] negate
+          #
+          # @param [Array<Node>] children
+          #
+          # @param [Array<CPE::Match>] cpe_match
+          #
+          def initialize(operator: nil, negate: nil, children: [], cpe_match: [])
+            @operator = operator
+            @negate   = negate
+
+            @children = children
+            @cpe_match = cpe_match
+          end
+
+          #
+          # Determines if {#negate} is `true`.
+          #
+          # @return [Boolean]
+          #
+          def negate?
+            @negate == true
+          end
+
+          #
+          # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+          #
+          # @param [Hash{String => Object}] json
+          #   The parsed JSON.
+          #
+          # @return [Hash{Symbol => Object}]
+          #   The Symbol Hash.
+          #
+          # @see https://csrc.nist.gov/schema/nvd/feed/1.1-Beta/cvss-v2.0_beta.json
+          #
+          def self.from_json(json)
+            {
+              operator: if (operator = json['operator'])
+                          OPERATORS.fetch(operator,operator)
+                        end,
+              negate:   json['negate'],
+
+              children:  Array(json['children']).map(&method(:load)),
+              cpe_match: Array(json['cpe_match']).map(&CPE::Match.method(:load))
+            }
+          end
+
+          #
+          # Loads the node object from the parsed JSON.
+          #
+          # @param [Hash{String => Object}] json
+          #   The parsed JSON.
+          #
+          # @return [Node]
+          #   The node object.
+          #
+          def self.load(json)
+            new(**from_json(json))
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/nvd/json_feeds/schema/cpe/has_uri.rb

@@ -0,0 +1,66 @@
+module NVD
+  module JSONFeeds
+    module Schema
+      module CPE
+        #
+        # Adds the {#cpe23uri} and {#cpe22uri} attributes.
+        #
+        module HasURI
+          #
+          # Extends {ClassMethods}.
+          #
+          def self.included(base)
+            base.extend ClassMethods
+          end
+
+          #
+          # Class methods.
+          #
+          module ClassMethods
+            #
+            # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+            #
+            # @param [Hash{String => Object}] json
+            #   The parsed JSON.
+            #
+            # @return [Hash{Symbol => Object}]
+            #   The Symbol Hash.
+            #
+            def from_json(json)
+              {
+                cpe23uri: json.fetch('cpe23Uri'),
+                cpe22uri: json['cpe22Uri']
+              }
+            end
+          end
+
+          #
+          # Initializes the CPE URIs.
+          #
+          # @param [String] cpe23uri
+          #   The CPE 2.3 URI.
+          #
+          # @param [String] cpe22uri
+          #   The CPE 2.2 URI.
+          #
+          def initialize(cpe23uri: , cpe22uri: nil)
+            @cpe23uri = cpe23uri
+            @cpe22uri = cpe22uri
+          end
+
+          # The CPE 2.3 URI.
+          #
+          # @return [String]
+          attr_reader :cpe23uri
+
+          alias cpe_uri cpe23uri
+
+          # The CPE 2.2 URI.
+          #
+          # @return [String, nil]
+          attr_reader :cpe22uri
+        end
+      end
+    end
+  end
+end

data/lib/nvd/json_feeds/schema/cpe/match.rb

@@ -0,0 +1,117 @@
+require 'nvd/json_feeds/schema/cpe/name'
+
+module NVD
+  module JSONFeeds
+    module Schema
+      module CPE
+        #
+        # Represents the `"cpe_match"` value.
+        #
+        class Match
+
+          include HasURI
+
+          # @return [Boolean]
+          attr_reader :vulnerable
+
+          # @return [String, nil]
+          attr_reader :version_start_excluding
+
+          # @return [String, nil]
+          attr_reader :version_start_including
+
+          # @return [String, nil]
+          attr_reader :version_end_excluding
+
+          # @return [String, nil]
+          attr_reader :version_end_including
+
+          # @return [Array<Name>]
+          attr_reader :cpe_name
+
+          #
+          # Initializes the CPE match object.
+          #
+          # @param [Boolean] vulnerable
+          #
+          # @param [String, nil] version_start_excluding
+          #
+          # @param [String, nil] version_start_including
+          #
+          # @param [String, nil] version_end_excluding
+          #
+          # @param [String, nil] version_end_including
+          #
+          # @param [Array<Name>] cpe_name
+          #
+          def initialize(vulnerable: , version_start_excluding: nil,
+                                       version_start_including: nil,
+                                       version_end_excluding: nil,
+                                       version_end_including: nil,
+                                       cpe_name: [],
+                                       **kwargs)
+            super(**kwargs)
+
+            @vulnerable = vulnerable
+
+            @version_start_excluding = version_start_excluding
+            @version_start_including = version_start_including
+
+            @version_end_excluding = version_end_excluding
+            @version_end_including = version_end_including
+
+            @cpe_name = cpe_name
+          end
+
+          #
+          # Determines if the CPE match indicates whether it's vulnerable.
+          #
+          # @return [Boolean]
+          #
+          def vulnerable?
+            @vulnerable == true
+          end
+
+          #
+          # Maps the CPE match JSON to a Symbol Hash for {#initialize}.
+          #
+          # @param [Hash{String => Object}] json
+          #   The parsed JSON.
+          #
+          # @return [Hash{Symbol => Object}]
+          #   The mapped Symbol Hash.
+          #
+          def self.from_json(json)
+            {
+              vulnerable: json.fetch('vulnerable'),
+
+              **super(json),
+
+              version_start_excluding: json['versionStartExcluding'],
+              version_start_including: json['versionStartIncluding'],
+
+              version_end_excluding: json['versionEndExcluding'],
+              version_end_including: json['versionEndIncluding'],
+
+              cpe_name: Array(json['cpe_name']).map(&Name.method(:load))
+            }
+          end
+
+          #
+          # Loads the CPE match object from the parsed JSON.
+          #
+          # @param [Hash{String => Object}] json
+          #   The parsed JSON.
+          #
+          # @return [Match]
+          #   The loaded CPE match object.
+          #
+          def self.load(json)
+            new(**from_json(json))
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nvd/json_feeds/schema/cpe/name.rb

@@ -0,0 +1,67 @@
+require 'nvd/json_feeds/schema/cpe/has_uri'
+require 'nvd/json_feeds/schema/timestamp'
+
+module NVD
+  module JSONFeeds
+    module Schema
+      module CPE
+        #
+        # Represents the `"cpe_name"` value.
+        #
+        class Name
+
+          include HasURI
+
+          # Last modified date.
+          #
+          # @return [DateTime, nil]
+          attr_reader :last_modified_date
+
+          #
+          # Initializes the CPE name.
+          #
+          # @param [DateTime, nil] last_modified_date
+          #
+          def initialize(last_modified_date: nil, **kwargs)
+            super(**kwargs)
+
+            @last_modified_date = last_modified_date
+          end
+
+          #
+          # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+          #
+          # @param [Hash{String => Object}] json
+          #   The parsed JSON Hash.
+          #
+          # @return [Hash{Symbol => Object}]
+          #   The mapped Symbol Hash.
+          #
+          def self.from_json(json)
+            {
+              **super(json),
+
+              last_modified_date: if (last_modified_date = json['lastModifiedDate'])
+                                    Timestamp.parse(last_modified_date)
+                                  end
+            }
+          end
+
+          #
+          # Loads the CPE name object from the parsed JSON.
+          #
+          # @param [Hash{String => Object}] json
+          #   The parsed JSON Hash.
+          #
+          # @return [Name]
+          #   The loaded CPE name object.
+          #
+          def self.load(json)
+            new(**from_json(json))
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nvd/json_feeds/schema/cve_feed.rb

@@ -0,0 +1,142 @@
+require 'nvd/json_feeds/schema/has_data_version'
+require 'nvd/json_feeds/schema/timestamp'
+require 'nvd/json_feeds/schema/cve_item'
+
+module NVD
+  module JSONFeeds
+    module Schema
+      #
+      # Represents the parsed contents of a JSON CVE feed.
+      #
+      class CVEFeed
+
+        include HasDataVersion
+        include Enumerable
+
+        DATA_TYPES = {
+          'CVE' => :CVE
+        }
+
+        DATA_FORMATS = {
+          'MITRE' => :MITRE
+        }
+
+        # The feed format.
+        #
+        # @return [:MITRE]
+        attr_reader :data_format
+
+        alias format data_format
+
+        # The feed type.
+        #
+        # @return [:CVE]
+        attr_reader :data_type
+
+        alias type data_type
+
+        # The number of CVEs.
+        #
+        # @return [Integer, nil]
+        attr_reader :data_number_of_cves
+
+        alias number_of_cves data_number_of_cves
+
+        # The feed timestamp.
+        #
+        # @return [DateTime, nil]
+        attr_reader :data_timestamp
+
+        alias timestamp data_timestamp
+
+        # The CVE items.
+        #
+        # @return [Array<CVEItem>]
+        attr_reader :cve_items
+
+        #
+        # Initializes the JSON feed.
+        #
+        # @param [:MITRE] data_format
+        #
+        # @param [:CVE] data_type
+        #
+        # @param [Integer, nil] data_number_of_cves
+        #
+        # @param [DateTime, nil] data_timestamp
+        #
+        # @param [Array<CVEItem>] cve_items
+        #
+        def initialize(data_format: , data_type: , data_number_of_cves: nil,
+                                                   data_timestamp: nil,
+                                                   cve_items: ,
+                                                   **kwargs)
+          super(**kwargs)
+
+          @data_format = data_format
+          @data_type   = data_type
+
+          @data_number_of_cves = data_number_of_cves
+          @data_timestamp      = data_timestamp
+
+          @cve_items = cve_items
+        end
+
+        #
+        # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+        #
+        # @param [Hash{String => Object}] json
+        #   The parsed JSON.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The mapped Symbol Hash.
+        #
+        def self.from_json(json)
+          {
+            data_type:   DATA_TYPES.fetch(json.fetch('CVE_data_type')),
+            data_format: DATA_FORMATS.fetch(json.fetch('CVE_data_format')),
+            **super(json),
+
+            data_number_of_cves: json.fetch('CVE_data_numberOfCVEs').to_i,
+
+            data_timestamp: if (timestamp = json['CVE_data_timestamp'])
+                              Timestamp.parse(timestamp)
+                            end,
+
+            cve_items: json.fetch('CVE_Items').map(&CVEItem.method(:load))
+          }
+        end
+
+        #
+        # Loads the JSON feed data from the parsed JSON.
+        #
+        # @param [Hash{String => Object}] json
+        #   The parsed JSON.
+        #
+        # @return [JSONFeed]
+        #   The loaded JSON data.
+        #
+        def self.load(json)
+          new(**from_json(json))
+        end
+
+        #
+        # Enumerates over each CVE item in the feed.
+        #
+        # @yield [cve_itme]
+        #   The given block will be passed each CVE Item.
+        #
+        # @yieldparam [CVEItem] cve_item
+        #   A CVE Item in the feed.
+        #
+        # @return [Enumerator]
+        #   If no block is given, an enumerator will be returned.
+        #
+        def each(&block)
+          @cve_items.each(&block)
+        end
+
+      end
+    end
+  end
+end