ronin-db-activerecord 0.1.0.beta1

data/lib/ronin/db/host_name_ip_address.rb

@@ -0,0 +1,65 @@
+# 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 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Associates a {HostName} with an {IPAddress}.
+    #
+    class HostNameIPAddress < ActiveRecord::Base
+
+      include Model
+
+      # self.table_name = 'ronin_host_name_ip_addresses'
+
+      # @!attribute [rw] id
+      #   The primary-key of the join model.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] host_name
+      #   The host name pointing to the IP Address
+      #
+      #   @return [HostName]
+      belongs_to :host_name, required: true,
+                             inverse_of: :host_name_ip_addresses
+
+      # @!attribute [rw] ip_address
+      #   The associated IP address.
+      #
+      #   @return [IPAddress]
+      belongs_to :ip_address, required:   true,
+                              inverse_of: :host_name_ip_addresses,
+                              class_name: 'IPAddress'
+
+      # @!attribute [rw] created_at
+      #   Tracks when a IP Address is associated with a host name
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+    end
+  end
+end

data/lib/ronin/db/http_header_name.rb

@@ -0,0 +1,75 @@
+# 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 HTTP request or response Header name.
+    #
+    class HTTPHeaderName < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      # @!attribute [rw] id
+      #   The primary key of the HTTP header name.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The Header name.
+      #
+      #   @return [String]
+      attribute :name, :string # length: 256
+      validates :name, presence: true, uniqueness: true
+
+      # @!attribute [rw] http_request_headers
+      #   The associated HTTP request headers.
+      #
+      #   @return [Array<HTTPRequestHeader>]
+      has_many :http_request_headers
+
+      # @!attribute [rw] http_requests
+      #   The HTTP requests which contain this HTTP Header name.
+      #
+      #   @return [Array<HTTPRequest>]
+      has_many :http_requests, through: :http_request_headers
+
+      # @!attribute [rw] http_response_headers
+      #   The associated HTTP response headers.
+      #
+      #   @return [Array<HTTPResponseHeader>]
+      has_many :http_response_headers
+
+      # @!attribute [rw] http_responses
+      #   The HTTP responses which contain this HTTP Header name.
+      #
+      #   @return [Array<HTTPResponse>]
+      has_many :http_responses, through: :http_response_headers
+
+    end
+  end
+end

data/lib/ronin/db/http_query_param.rb

@@ -0,0 +1,79 @@
+# 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 'active_record'
+require 'uri/query_params'
+
+module Ronin
+  module DB
+    #
+    # Represents a query param that belongs to a {HTTPRequest}.
+    #
+    class HTTPQueryParam < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary-key of the HTTP query param
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The name of the HTTP query param
+      #
+      #   @return [HTTPQueryParamName]
+      belongs_to :name, required:   true,
+                        class_name: 'HTTPQueryParamName'
+      validates :name_id, uniqueness: {scope: :request_id}
+
+      # @!attribute [rw] value
+      #   The value of the HTTP query param
+      #
+      #   @return [String]
+      attribute :value, :text
+
+      # @!attribute [rw] request
+      #   The HTTP request which contains this HTTP query param.
+      #
+      #   @return [HTTPRequest]
+      belongs_to :request, required:   true,
+                           class_name: 'HTTPRequest'
+
+      #
+      # Converts the HTTP query param to a String.
+      #
+      # @return [String]
+      #   The dumped HTTP query param.
+      #
+      # @api public
+      #
+      def to_s
+        URI::QueryParams.dump(self.name.to_s => self.value)
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/http_query_param_name'
+require 'ronin/db/http_request'

data/lib/ronin/db/http_query_param_name.rb

@@ -0,0 +1,76 @@
+# 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 the name of a {HTTPQueryParam}.
+    #
+    class HTTPQueryParamName < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      # @!attribute [rw] id
+      #   The primary-key of the HTTP query param
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The name of the HTTP query param.
+      #
+      #   @return [String]
+      attribute :name, :string # length:   256
+      validates :name, presence: true, uniqueness: true
+
+      # @!attribute [rw] query_params
+      #   The HTTP query params.
+      #
+      #   @return [Array<URLQueryParam>]
+      has_many :query_params, class_name:  'HTTPQueryParam',
+                              foreign_key: :name_id
+
+      # @!attribute [rw] created_at
+      #   When the HTTP query param name was first created.
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+      #
+      # Converts the HTTP query param name to a String.
+      #
+      # @return [String]
+      #   The name of the HTTP query param
+      #
+      # @api public
+      #
+      def to_s
+        self.name.to_s
+      end
+
+    end
+  end
+end

data/lib/ronin/db/http_request.rb

@@ -0,0 +1,120 @@
+# 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 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a HTTP request.
+    #
+    class HTTPRequest < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary ID for the HTTP request.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] version
+      #   The HTTP version of the HTTP request.
+      #
+      #   @return [String]
+      attribute :version, :string
+      validates :version, presence: true,
+                          inclusion: {in: %w[1.0 1.1 2.0]}
+
+      # @!attribute [rw] request_method
+      #   The request method.
+      #
+      #   @return [:copy, :delete, :get, :head, :lock, :mkcol, :move, :options, :patch, :post, :propfind, :proppatch, :put, :trace, :unlock]
+      enum request_method: [
+        :copy,
+        :delete,
+        :get,
+        :head,
+        :lock,
+        :mkcol,
+        :move,
+        :options,
+        :patch,
+        :post,
+        :propfind,
+        :proppatch,
+        :put,
+        :trace,
+        :unlock
+      ], _suffix: :requests
+      validates :request_method, presence: true
+
+      # @!attribute [rw] path
+      #   The path of the HTTP request.
+      #
+      #   @return [String]
+      attribute :path, :string
+      validates :path, presence: true
+
+      # @!attribute [rw] query
+      #   The query string of the HTTP request.
+      #
+      #   @return [String, nil]
+      attribute :query, :string
+
+      # @!attribute [rw] query_params
+      #   The additional parsed query params of the HTTP request.
+      #
+      #   @return [Array<HTTPQueryParam>]
+      has_many :query_params, foreign_key: 'request_id',
+                              class_name: 'HTTPQueryParam',
+                              dependent:  :destroy
+      # @!attribute [rw] body
+      #   The optional body of the HTTP request.
+      #
+      #   @return [String, nil]
+      attribute :body, :text
+
+      # @!attribute [rw] headers
+      #   The additional headers of HTTP request.
+      #
+      #   @return [Array<HTTPRequestHeader>]
+      has_many :headers, foreign_key: 'request_id',
+                         class_name:  'HTTPRequestHeader',
+                         dependent:   :destroy
+
+      # @!attribute [rw] response
+      #   The optional HTTP response associated with the HTTP request.
+      #
+      #   @return [HTTPResponse, nil]
+      belongs_to :response, class_name: 'HTTPResponse',
+                            dependent:  :destroy
+
+      # @!attribute [rw] created_at
+      #   When the HTTP request was created.
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+    end
+  end
+end

data/lib/ronin/db/http_request_header.rb

@@ -0,0 +1,78 @@
+# 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 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a HTTP header sent in a HTTP request.
+    #
+    class HTTPRequestHeader < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary ID of the HTTP request header.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The name of the HTTP request header.
+      #
+      #   @return [HTTPHeaderName]
+      belongs_to :name, required:   true,
+                        class_name: 'HTTPHeaderName'
+
+      # @!attribute [rw] value
+      #   The value of the HTTP request header.
+      #
+      #   @return [String]
+      attribute :value, :string
+      validates :value, presence: true
+
+      # @!attribute [rw] request
+      #   The HTTP request that the header belongs to.
+      #
+      #   @return [HTTPRequest]
+      belongs_to :request, required:   true,
+                           class_name: 'HTTPRequest'
+
+      #
+      # Converts the HTTP request header to a String.
+      #
+      # @return [String]
+      #   The header's name and value.
+      #
+      # @api public
+      #
+      def to_s
+        "#{self.name}: #{self.value}"
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/http_header_name'
+require 'ronin/db/http_request'

data/lib/ronin/db/http_response.rb

@@ -0,0 +1,91 @@
+# 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 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a HTTP response.
+    #
+    class HTTPResponse < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary ID of the HTTP reponse.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] status
+      #   The HTTP status code of the response.
+      #
+      #   @return [Integer]
+      attribute :status, :integer
+      validates :status, presence: true,
+                         inclusion: {
+                           in: [
+                             100, 101, 103,
+                             200, 201, 202, 203, 204, 206, 207, 208, 226,
+                             300, 301, 302, 303, 304, 305, 306, 307, 308,
+                             400, 401, 402, 403, 404, 405, 406, 407, 408, 409,
+                             410, 411, 412, 413, 414, 415, 416, 417, 418,
+                             421, 422, 423, 424, 425, 426, 428, 429,
+                             431, 451,
+                             500, 501, 502, 503, 504, 505, 506, 507, 508, 511
+                           ]
+                         }
+
+      # @!attribute [rw] headers
+      #   The associated headers of the HTTP response.
+      #
+      #   @return [Array<HTTPResponseHeader>]
+      has_many :headers, foreign_key: :request_id,
+                         class_name:  'HTTPResponseHeader',
+                         dependent:   :destroy
+
+      # @!attribute [rw] body
+      #   The optional body of the HTTP response.
+      #
+      #   @return [String, nil]
+      attribute :body, :text
+
+      # @!attribute [r] created_at
+      #   When the HTTP response was created.
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+      # @!attribute [rw] request
+      #   The associated HTTP request that the response was returned for.
+      #
+      #   @return [HTTPRequest]
+      has_one :request, required:   true,
+                        foreign_key: :response_id,
+                        class_name: 'HTTPRequest'
+
+    end
+  end
+end
+
+require 'ronin/db/http_request'

data/lib/ronin/db/http_response_header.rb

@@ -0,0 +1,78 @@
+# 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 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a HTTP header belonging to an HTTP response.
+    #
+    class HTTPResponseHeader < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary ID of the HTTP response header.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The name of the HTTP response header.
+      #
+      #   @return [HTTPHeaderName]
+      belongs_to :name, required:   true,
+                        class_name: 'HTTPHeaderName'
+
+      # @!attribute [rw] value
+      #   The value of the HTTP response header.
+      #
+      #   @return [String]
+      attribute :value, :string
+      validates :value, presence: true
+
+      # @!attribute [rw] response
+      #   The associated HTTP response that the HTTP response header belongs to.
+      #
+      #   @return [HTTPResponse]
+      belongs_to :response, required:   true,
+                            class_name: 'HTTPResponse'
+
+      #
+      # Converts the HTTP request header to a String.
+      #
+      # @return [String]
+      #   The header's name and value.
+      #
+      # @api public
+      #
+      def to_s
+        "#{self.name}: #{self.value}"
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/http_header_name'
+require 'ronin/db/http_response'