ronin-db-activerecord 0.1.0.beta1

data/lib/ronin/db/address.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-db-activerecord is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-db-activerecord is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/db/model'
+require 'ronin/db/model/importable'
+require 'ronin/db/model/last_scanned_at'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # A base model which represents an Internet Address, such as:
+    #
+    # * {MACAddress}
+    # * {IPAddress}
+    # * {HostName}
+    #
+    class Address < ActiveRecord::Base
+
+      include Model
+      include Model::Importable
+      include Model::LastScannedAt
+
+      self.abstract_class = true
+
+      # @!attribute [rw] id
+      #   The primary key of the Address
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] address
+      #   The Address
+      #
+      #   @return [String]
+      attribute :address, :string
+      validates :address, presence: true, uniqueness: true
+
+      # @!attribute [rw] created_at
+      #   Tracks when the IP Address was first created
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+      #
+      # Looks up the address.
+      #
+      # @param [String] address
+      #   The address to query.
+      #
+      # @return [Address, nil]
+      #   The found address.
+      #
+      def self.lookup(address)
+        find_by(address: address)
+      end
+
+      #
+      # Imports an address.
+      #
+      # @param [String] address
+      #   The address to parse.
+      #
+      # @return [Address]
+      #   The parsed address.
+      #
+      # @api public
+      #
+      def self.import(address)
+        create(address: address)
+      end
+
+      #
+      # Converts the address into a string.
+      #
+      # @return [String]
+      #   The address.
+      #
+      # @api public
+      #
+      def to_s
+        self.address.to_s
+      end
+
+    end
+  end
+end

data/lib/ronin/db/advisory.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-db-activerecord is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-db-activerecord is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/db/model'
+require 'ronin/db/model/importable'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a vulnerability Advisory, with a Publisher, Number and
+    # URL.
+    #
+    class Advisory < ActiveRecord::Base
+
+      include Model
+      include Model::Importable
+
+      self.primary_key = :id
+
+      # @!attribute [rw] id
+      #   Primary key of the advisory.
+      #
+      #   @return [String]
+      attribute :id, :string
+
+      # @!attribute [rw] prefix
+      #   The ID prefix (ex: `CVE` or `GHSA`).
+      #
+      #   @return [String]
+      attribute :prefix, :string
+      validates :prefix, presence: true
+
+      # @!attribute [rw] year
+      #   The year the advisory was published in.
+      #
+      #   @return [Integer]
+      attribute :year, :integer
+      validates :year, allow_nil:  true,
+                       comparison: {
+                                     greater_than: 1990,
+                                     less_than_or_equal_to: Date.today.year
+                                   }
+
+      # @!attribute [rw] identifier
+      #   The advisory identifier
+      #
+      #   @return [String]
+      attribute :identifier, :string
+      validates :identifier, presence: true
+
+      #
+      # @api private
+      #
+      module ID
+        #
+        # Parses a security avdisory ID.
+        #
+        # @param [String] string
+        #   The security advisory ID String to split.
+        #
+        # @return [Hash{Symbol => Object}]
+        #   The parsed security advisory ID.
+        #
+        # @raise [ArgumentError]
+        #   The ID does not appear to be a valid security ID.
+        #
+        def self.parse(string)
+          if (match = string.match(/\A([A-Z]+)-(\d{4})[:-]([0-9][0-9-]+)\z/))
+            {
+              id:         match[0],
+              prefix:     match[1],
+              year:       match[2].to_i,
+              identifier: match[3]
+            }
+          elsif (match = string.match(/\AMS(\d{2})-(\d{3,})\z/))
+            {
+              id:         match[0],
+              prefix:     'MS',
+              year:       2000 + match[1].to_i,
+              identifier: match[2]
+            }
+          elsif (match = string.match(/\A([A-Z]+)-(.+)\z/))
+            {
+              id:         match[0],
+              prefix:     match[1],
+              identifier: match[2]
+            }
+          else
+            raise(ArgumentError,"id does not appear to be a valid security advisory ID: #{string.inspect}")
+          end
+        end
+      end
+
+      #
+      # Looks up the advisory.
+      #
+      # @param [String] id
+      #
+      # @return [Advisory, nil]
+      #
+      def self.lookup(id)
+        find_by(id: id)
+      end
+
+      #
+      # Parses an Advisory ID String.
+      #
+      # @param [String] id
+      #   The ID String for the advisory.
+      #
+      # @return [Advisory]
+      #   The new advisory.
+      #
+      # @api public
+      #
+      def self.import(id)
+        create(**ID.parse(id))
+      end
+
+      #
+      # Generates a URL for the advisory.
+      #
+      # @return [String, nil]
+      #   The URL for the advisory.
+      #
+      # @api public
+      #
+      def url
+        case prefix
+        when 'CVE'  then "https://nvd.nist.gov/vuln/detail/#{id}"
+        when 'RHSA' then "https://access.redhat.com/errata/#{id}"
+        when 'GHSA' then "https://github.com/advisories/#{id}"
+        end
+      end
+
+      #
+      # Converts the advisory to a String.
+      #
+      # @return [String]
+      #   The advisory ID string.
+      #
+      # @api public
+      #
+      def to_s
+        self.id
+      end
+
+    end
+  end
+end

data/lib/ronin/db/arch.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-db-activerecord is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-db-activerecord is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/db/model'
+require 'ronin/db/model/has_unique_name'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a Computer Architecture and predefines many other common
+    # architectures ({x86}, {x86_64}, {ppc}, {ppc64}, {mips}, {mips_le},
+    # {mips_be}, {arm}, {arm_le}, and {arm_be}).
+    #
+    class Arch < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      # @!attribute [rw] id
+      #   The primary key of the arch.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] endian
+      #   Endianness of the architecture.
+      #
+      #   @return [:little, :big]
+      enum :endian, {little: 'little', big: 'big'}
+      validates :endian, presence: true
+
+      # @!attribute [rw] word_size
+      #   Address length of the architecture.
+      #
+      #   @return [Integer]
+      attribute :word_size, :integer
+      validates :word_size, presence: true,
+                            inclusion: {in: [4, 8]}
+
+      #
+      # The x86 Architecture
+      #
+      # @return [Arch]
+      #
+      def self.x86
+        find_or_create_by(name: 'x86')
+      end
+
+      #
+      # The i686 Architecture
+      #
+      # @return [Arch]
+      #
+      def self.i686
+        find_or_create_by(name: 'i686')
+      end
+
+      #
+      # The x86_64 Architecture
+      #
+      # @return [Arch]
+      #
+      def self.x86_64
+        find_or_create_by(name: 'x86-64')
+      end
+
+      #
+      # The 32-bit PowerPC Architecture
+      #
+      # @return [Arch]
+      #
+      def self.ppc
+        find_or_create_by(name: 'PPC')
+      end
+
+      #
+      # The 64-bit PowerPC Architecture
+      #
+      # @return [Arch]
+      #
+      def self.ppc64
+        find_or_create_by(name: 'PPC64')
+      end
+
+      #
+      # The MIPS Architecture
+      #
+      # @return [Arch]
+      #
+      def self.mips
+        find_or_create_by(name: 'MIPS')
+      end
+
+      #
+      # The MIPS (little endian) Architecture
+      #
+      # @return [Arch]
+      #
+      def self.mips_le
+        find_or_create_by(name: 'MIPS (Little-Endian)')
+      end
+
+      #
+      # The MIPS (big endian) Architecture
+      #
+      # @return [Arch]
+      #
+      def self.mips_be
+        find_or_create_by(name: 'MIPS (Big-Endian)')
+      end
+
+      #
+      # The ARM Architecture
+      #
+      # @return [Arch]
+      #
+      def self.arm
+        find_or_create_by(name: 'ARM')
+      end
+
+      #
+      # The ARM (little endian) Architecture
+      #
+      # @return [Arch]
+      #
+      def self.arm_le
+        find_or_create_by(name: 'ARM (Little-Endian)')
+      end
+
+      #
+      # The ARM (big endian) Architecture
+      #
+      # @return [Arch]
+      #
+      def self.arm_be
+        find_or_create_by(name: 'ARM (Big-Endian)')
+      end
+
+    end
+  end
+end

data/lib/ronin/db/asn.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-db-activerecord is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-db-activerecord is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/db/model'
+
+module Ronin
+  module DB
+    #
+    # Represents an ASN range.
+    #
+    class ASN < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary key of the ASN range.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] version
+      #   Whether the ASN range represents an IPv4 or IPv6 range.
+      #
+      #   @return [Integer]
+      attribute :version, :integer
+      validates :version, presence:  true,
+                          inclusion: {in: [4, 6]}
+
+      # @!attribute [rw] range_start
+      #   The starting IP address of the ASN range.
+      #
+      #   @return [String]
+      attribute :range_start, :string
+      validates :range_start, presence: true
+
+      # @!attribute [rw] range_end
+      #   The ending IP address of the ASN range.
+      #
+      #   @return [String]
+      attribute :range_end, :string
+      validates :range_end, presence: true
+
+      # @!attribute [r] range_start_hton
+      #   The starting IP address of the ASN range, but in network byte-order.
+      #
+      #   @return [String]
+      attribute :range_start_hton, :binary
+
+      # @!attribute [r] range_end_hton
+      #   The ending IP address of the ASN range, but in network byte-order.
+      #
+      #   @return [String]
+      attribute :range_end_hton, :binary
+
+      before_save :set_hton
+
+      # @!attribute [rw] number
+      #   The ASN number.
+      #
+      #   @return [Integer]
+      attribute :number, :integer
+      validates :number, presence:   true,
+                         uniqueness: {scope: [:range_start, :range_end]}
+
+      # @!attribute [rw] country_code
+      #   The country code of the ASN.
+      #
+      #   @return [String]
+      attribute :country_code, :string
+
+      # @!attribute [rw] name
+      #   The organization the ASN is currently assigned to.
+      #
+      #   @return [String]
+      attribute :name, :string
+
+      #
+      # Searches for all IPv4 ASNs.
+      #
+      # @return [Array<ASN>]
+      #   The IPv4 ASNs.
+      #
+      # @api public
+      #
+      def self.v4
+        where(version: 4)
+      end
+
+      #
+      # Searches for all IPv6 ASNs.
+      #
+      # @return [Array<ASNs>]
+      #   The IPv6 ASNs.
+      #
+      # @api public
+      #
+      def self.v6
+        where(version: 6)
+      end
+
+      #
+      # Searches for all ASNs with the matching AS number.
+      #
+      # @param [Integer] number
+      #   The AS number to search for.
+      #
+      # @return [Array<ASN>]
+      #
+      def self.with_number(number)
+        where(number: number)
+      end
+
+      #
+      # Searches for all ASNs with the matching country code.
+      #
+      # @param [String] country_code
+      #   The two letter country code to search for.
+      #
+      # @return [Array<ASN>]
+      #
+      def self.with_country_code(country_code)
+        where(country_code: country_code)
+      end
+
+      #
+      # Searches for all ASNs with the matching name.
+      #
+      # @param [String] name 
+      #   The name to search for.
+      #
+      # @return [Array<ASN>]
+      #
+      def self.with_name(name)
+        where(name: name)
+      end
+
+      #
+      # Queries the ASN that contains the given IP address.
+      #
+      # @param [IPAddr, String] ip
+      #
+      # @return [ASN, nil]
+      #
+      def self.containing_ip(ip)
+        ip = IPAddr.new(ip) unless ip.kind_of?(IPAddr)
+        ip_hton = ip.hton
+
+        range_start_hton = self.arel_table[:range_start_hton]
+        range_end_hton  = self.arel_table[:range_end_hton]
+
+        where(range_start_hton.lteq(ip_hton).and(range_end_hton.gteq(ip_hton))).first
+      end
+
+      #
+      # @return [IPAddr, nil]
+      #
+      def range_start_ipaddr
+        @range_start_ipaddr ||= if self.range_start
+                                  IPAddr.new(self.range_start)
+                                end
+      end
+
+      #
+      # @return [IPAddr, nil]
+      #
+      def range_end_ipaddr
+        @range_end_ipaddr ||= if self.range_end
+                                IPAddr.new(self.range_end)
+                              end
+      end
+
+      #
+      # Queries all IP addresses within the ASN IP range.
+      #
+      # @return [Array<IPAddress>]
+      #
+      def ip_addresses
+        IPAddress.between(range_start,range_end)
+      end
+
+      private
+
+      #
+      # Sets the `range_start_hton` and `range_end_hton` attributes.
+      #
+      def set_hton
+        self.range_start_hton = range_start_ipaddr.hton
+        self.range_end_hton   = range_end_ipaddr.hton
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/ip_address'