ronin-db-activerecord 0.1.0.beta1

data/lib/ronin/db/model/has_name.rb

@@ -0,0 +1,102 @@
+# 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
+    module Model
+      #
+      # Adds a `name` property to a model.
+      #
+      module HasName
+        #
+        # @!attribute [rw] name
+        #   The name attribute of the model.
+        #
+        #   @return [String]
+        #
+
+        #
+        # Adds the `name` property and {ClassMethods} to the model.
+        #
+        # @param [Class] base
+        #   The model.
+        #
+        # @api private
+        #
+        def self.included(base)
+          base.send :include, Model, InstanceMethods
+          base.send :extend, ClassMethods
+
+          base.module_eval do
+            # The name attribute of the model
+            attribute :name, :string
+            validates :name, presence: true
+          end
+        end
+
+        #
+        # Class methods that are added when {HasName} is included into a
+        # model.
+        #
+        module ClassMethods
+          #
+          # Finds models with names containing a given fragment of text.
+          #
+          # @param [String] fragment
+          #   The fragment of text to search for within the names of models.
+          #
+          # @return [Array<Model>]
+          #   The found models.
+          #
+          # @example
+          #   Exploit.named 'ProFTP'
+          #
+          # @api public
+          #
+          def named(fragment)
+            name_column = self.arel_table[:name]
+
+            where(name_column.matches("%#{sanitize_sql_like(fragment)}%"))
+          end
+        end
+
+        #
+        # Instance methods that are added when {HasName} is included into a
+        # model.
+        #
+        module InstanceMethods
+          #
+          # Converts the named resource into a String.
+          #
+          # @return [String]
+          #   The name of the resource.
+          #
+          # @api public
+          #
+          def to_s
+            self.name.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/model/has_unique_name.rb

@@ -0,0 +1,82 @@
+# 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/has_name'
+
+module Ronin
+  module DB
+    module Model
+      #
+      # Adds a unique `name` property to a model.
+      #
+      module HasUniqueName
+        #
+        # @!attribute [rw] name
+        #   The unqiue name of the model.
+        #
+        #   @return [String]
+        #
+
+        #
+        # Adds the unique `name` property and {HasName::ClassMethods} to the
+        # model.
+        #
+        # @param [Class] base
+        #   The model.
+        #
+        # @api semipublic
+        #
+        def self.included(base)
+          base.send :include, Model,
+                              HasName::InstanceMethods
+
+          base.send :extend,  HasName::ClassMethods,
+                              HasUniqueName::ClassMethods
+
+          base.module_eval do
+            # The name of the model
+            attribute :name, :string
+            validates :name, presence: true, uniqueness: true
+          end
+        end
+
+        #
+        # Class methods that will be added when {HasUniqueName} is included.
+        #
+        module ClassMethods
+          #
+          # Parses a unique name.
+          #
+          # @param [String] name
+          #   The name to parse.
+          #
+          # @return [Model]
+          #   A new or previously saved resource.
+          #
+          # @api public
+          #
+          def parse(name)
+            find_or_initialize_by(name: name.strip)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/model/importable.rb

@@ -0,0 +1,85 @@
+# 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/>.
+#
+
+module Ronin
+  module DB
+    module Model
+      #
+      # Allows a model to import records from raw values.
+      #
+      module Importable
+        #
+        # Adds {ClassMethods} to the model including {Importable}.
+        #
+        # @param [Class] model
+        #   The model including {Importable}.
+        #
+        # @api private
+        #
+        def self.included(model)
+          model.extend ClassMethods
+        end
+
+        module ClassMethods
+          #
+          # Looks up a record with the given value.
+          #
+          # @param [Object] value
+          #   The raw value to use for the query.
+          #
+          # @return [ActiveRecord::Base, nil]
+          #   The found record.
+          #
+          def lookup(value)
+            raise(NotImplementedError,"#{self} did not define a self.lookup method")
+          end
+
+          #
+          # Imports a record from the given value.
+          #
+          # @param [Object] value
+          #   The raw value that represents the record.
+          #
+          # @return [ActiveRecord::Base]
+          #   The imported record.
+          #
+          # @abstract
+          #
+          def import(value)
+            raise(NotImplementedError,"#{self} did not define a self.import method")
+          end
+
+          #
+          # Finds or imports a new record.
+          #
+          # @param [Object] value
+          #   The raw value that represents the record.
+          #
+          # @return [ActiveRecord::Base]
+          #   The found or created record.
+          #
+          def find_or_import(value)
+            lookup(value) || import(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/model/last_scanned_at.rb

@@ -0,0 +1,48 @@
+# 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/>.
+#
+
+module Ronin
+  module DB
+    module Model
+      module LastScannedAt
+        #
+        # @!attribute [rw] last_scanned_at
+        #   Whenever the model was last scanned.
+        #
+        #   @return [Time, nil]
+        #
+
+        #
+        # Adds the `last_scanned_at` attribute to the model.
+        #
+        # @param [Class<ActiveRecord::Base>] model
+        #   The ActiveRecord model which is including {LastScannedAt}.
+        #
+        # @api private
+        #
+        def self.included(model)
+          model.class_eval do
+            attribute :last_scanned_at, :time
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/model.rb

@@ -0,0 +1,37 @@
+# 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/>.
+#
+
+module Ronin
+  module DB
+    module Model
+      #
+      # Sets the models `table_name_prefix` to `ronin_`.
+      #
+      # @param [Class<ActiveRecord::Base>] model
+      #   The ActiveRecord model class which is including {Model}.
+      #
+      # @api private
+      #
+      def self.included(model)
+        model.table_name_prefix = 'ronin_'
+      end
+    end
+  end
+end

data/lib/ronin/db/models.rb

@@ -0,0 +1,108 @@
+# 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/address'
+require 'ronin/db/arch'
+require 'ronin/db/credential'
+require 'ronin/db/email_address'
+require 'ronin/db/host_name'
+require 'ronin/db/host_name_ip_address'
+require 'ronin/db/ip_address'
+require 'ronin/db/ip_address_mac_address'
+require 'ronin/db/mac_address'
+require 'ronin/db/open_port'
+require 'ronin/db/organization'
+require 'ronin/db/os'
+require 'ronin/db/os_guess'
+require 'ronin/db/password'
+require 'ronin/db/port'
+require 'ronin/db/service'
+require 'ronin/db/service_credential'
+require 'ronin/db/software'
+require 'ronin/db/url_query_param_name'
+require 'ronin/db/url_query_param'
+require 'ronin/db/url_scheme'
+require 'ronin/db/url'
+require 'ronin/db/user_name'
+require 'ronin/db/software_vendor'
+require 'ronin/db/web_credential'
+require 'ronin/db/asn'
+require 'ronin/db/http_query_param_name'
+require 'ronin/db/http_query_param'
+require 'ronin/db/http_header_name'
+require 'ronin/db/http_request_header'
+require 'ronin/db/http_response_header'
+require 'ronin/db/http_request'
+require 'ronin/db/http_response'
+require 'ronin/db/advisory'
+require 'ronin/db/vulnerability'
+
+module Ronin
+  module DB
+    module Models
+      ALL = [
+        Address,
+        Arch,
+        Credential,
+        EmailAddress,
+        HostName,
+        HostNameIPAddress,
+        IPAddress,
+        IPAddressMACAddress,
+        MACAddress,
+        OS,
+        OSGuess,
+        OpenPort,
+        Organization,
+        Password,
+        Port,
+        Service,
+        ServiceCredential,
+        Software,
+        URLQueryParamName,
+        URLQueryParam,
+        URLScheme,
+        URL,
+        UserName,
+        SoftwareVendor,
+        WebCredential,
+        ASN,
+        HTTPQueryParamName,
+        HTTPQueryParam,
+        HTTPHeaderName,
+        HTTPRequestHeader,
+        HTTPResponseHeader,
+        HTTPRequest,
+        HTTPResponse,
+        Advisory,
+        Vulnerability
+      ]
+
+      #
+      # Calls `.connect` on all {Ronin::DB} models.
+      #
+      # @api semipublic
+      #
+      def self.connect
+        ALL.each(&:connection)
+      end
+    end
+  end
+end

data/lib/ronin/db/open_port.rb

@@ -0,0 +1,148 @@
+# 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/last_scanned_at'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a open port at a specified IP address.
+    #
+    class OpenPort < ActiveRecord::Base
+
+      include Model
+      include Model::LastScannedAt
+
+      # @!attribute [rw] id
+      #   The primary key of the open port.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] ip_address
+      #   The IP Address that was scanned.
+      #
+      #   @return [IPAddress]
+      belongs_to :ip_address, required: true,
+                              class_name: 'IPAddress'
+
+      # @!attribute [rw] port
+      #   The port.
+      #
+      #   @return [Port]
+      belongs_to :port, required: true
+
+      # @!attribute [rw] service
+      #   The service detected on the port
+      #
+      #   @return [Service, nil]
+      belongs_to :service, optional: true
+
+      # @!attribute [rw] software
+      #   The software running on the open port
+      #
+      #   @return [Software]
+      belongs_to :software, optional: true
+
+      # @!attribute [rw] ssl
+      #   Specifies whether the service requires SSL.
+      #
+      #   @return [Boolean]
+      attribute :ssl, :boolean
+
+      # @!attribute [r] created_at
+      #   Define the created_at timestamp
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+      # @!attribute [rw] service_credentials
+      #   Credentials used by the service running on the port
+      #
+      #   @return [Array<ServiceCredential>]
+      has_many :service_credentials, dependent: :destroy
+
+      # @!attribute [rw] credentials
+      #   The credentials that will work with this open port.
+      #
+      #   @return [Array<Credential>]
+      has_many :credentials, through: :service_credentials
+
+      #
+      # The IP Address of the open port.
+      #
+      # @return [String]
+      #   The IP Address.
+      #
+      # @api public
+      #
+      def address
+        self.ip_address.address
+      end
+
+      #
+      # The port number.
+      #
+      # @return [Integer]
+      #   The port number.
+      #
+      # @api public
+      #
+      def number
+        self.port.number
+      end
+
+      #
+      # Converts the open port to an integer.
+      #
+      # @return [Integer]
+      #   The port number.
+      #
+      # @api public
+      #
+      def to_i
+        self.port.to_i
+      end
+
+      #
+      # Converts the open port to a string.
+      #
+      # @return [String]
+      #   The information of the open port.
+      #
+      # @api public
+      #
+      def to_s
+        if self.service then "#{self.port} (#{self.service})"
+        else                 "#{self.port}"
+        end
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/ip_address'
+require 'ronin/db/port'
+require 'ronin/db/service'
+require 'ronin/db/service_credential'

data/lib/ronin/db/organization.rb

@@ -0,0 +1,50 @@
+# 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 an Company.
+    #
+    class Organization < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      # @!attribute [rw] id
+      #   Primary key of the organization
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [r] created_at
+      #   Tracks when the organization was first created
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+    end
+  end
+end