ronin-db-activerecord 0.1.0.beta1

data/lib/ronin/db/os.rb

@@ -0,0 +1,183 @@
+# 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_name'
+
+module Ronin
+  module DB
+    #
+    # Represents an Operating System and pre-defines other common ones
+    # ({linux}, {freebsd}, {openbsd}, {netbsd}, {macos}, and {windows}.
+    #
+    class OS < ActiveRecord::Base
+
+      include Model
+      include Model::HasName
+
+      self.table_name = 'ronin_oses'
+
+      # @!attribute [rw] id
+      #   The primary key of the OS.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] flavor
+      #   The flavor of the OS (Linux, BSD).
+      #
+      #   @return [:linux, :bsd]
+      enum :flavor, {linux: 'Linux', bsd: 'BSD'}
+
+      # @!attribute [rw] version
+      #   The version of the Operating System.
+      #
+      #   @return [String]
+      attribute :version, :string
+      validates :version, presence: true,
+                          uniqueness: {scope: :name}
+
+      # @!attribute [rw] os_guesses
+      #   Any OS guesses for the Operating System.
+      #
+      #   @return [Array<OSGuess>]
+      has_many :os_guesses, dependent: :destroy,
+                            class_name: 'OSGuess'
+
+      # @!attribute [rw] ip_addresses
+      #   Any IP Addresses that might be running the Operating System
+      #
+      #   @return [Array<IPAddress>]
+      has_many :ip_addresses, through:    :os_guesses,
+                              class_name: 'IPAddress'
+
+      #
+      # The Linux OS
+      #
+      # @param [String] version
+      #   Optional version of the OS.
+      #
+      # @return [OS]
+      #
+      def self.linux(version)
+        find_or_create_by(name: 'Linux', flavor: :linux, version: version)
+      end
+
+      #
+      # The FreeBSD OS
+      #
+      # @param [String] version
+      #   Optional version of the OS.
+      #
+      # @return [OS]
+      #
+      def self.freebsd(version)
+        find_or_create_by(name: 'FreeBSD', flavor: :bsd, version: version)
+      end
+
+      #
+      # The OpenBSD OS
+      #
+      # @param [String] version
+      #   Optional version of the OS.
+      #
+      # @return [OS]
+      #
+      def self.openbsd(version)
+        find_or_create_by(name: 'OpenBSD', flavor: :bsd, version: version)
+      end
+
+      #
+      # The NetBSD OS
+      #
+      # @param [String] version
+      #   Optional version of the OS.
+      #
+      # @return [OS]
+      #
+      def self.netbsd(version)
+        find_or_create_by(name: 'NetBSD', flavor: :bsd, version: version)
+      end
+
+      #
+      # The macOS OS.
+      #
+      # @param [String] version
+      #   Optional version of the OS.
+      #
+      # @return [OS]
+      #
+      def self.macos(version)
+        find_or_create_by(name: 'macOS', flavor: :bsd, version: version)
+      end
+
+      #
+      # The Windows OS
+      #
+      # @param [String] version
+      #   Optional version of the OS.
+      #
+      # @return [OS]
+      #
+      def self.windows(version)
+        find_or_create_by(name: 'Windows', version: version)
+      end
+
+      #
+      # The IP Address that was most recently guessed to be using the
+      # Operating System.
+      #
+      # @return [IPAddress]
+      #   The IP Address most recently guessed to be using the
+      #   Operating System.
+      #
+      # @api public
+      #
+      def recent_ip_address
+        relation = self.os_guesses.order('created_at DESC').first
+
+        if relation
+          return relation.ip_address
+        end
+      end
+
+      #
+      # Converts the Operating System to a String.
+      #
+      # @return [String]
+      #   The OS name and version.
+      #
+      # @example
+      #   os = OS.new(name: 'Linux', version: '2.6.11')
+      #   os.to_s
+      #   # => "Linux 2.6.11"
+      #
+      # @api public
+      #
+      def to_s
+        "#{self.name} #{self.version}"
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/os_guess'
+require 'ronin/db/ip_address'

data/lib/ronin/db/os_guess.rb

@@ -0,0 +1,67 @@
+# 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 guess about what {OS} an {IPAddress} might be running.
+    #
+    class OSGuess < ActiveRecord::Base
+
+      include Model
+
+      self.table_name = 'ronin_os_guesses'
+
+      # @!attribute [rw] id
+      #   The primary-key of the OS guess.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] ip_address
+      #   The IP Address the OS guess was made against.
+      #
+      #   @return [IPAddress]
+      belongs_to :ip_address, required:   true,
+                              class_name: 'IPAddress'
+
+      # @!attribute [rw] os
+      #   The guessed OS.
+      #
+      #   @return [OS]
+      belongs_to :os, required:   true,
+                      class_name: 'OS'
+
+      # @!attribute [r] created_at
+      #   Tracks when an OS guess is made against an IP Address.
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+    end
+  end
+end
+
+require 'ronin/db/ip_address'
+require 'ronin/db/os'

data/lib/ronin/db/password.rb

@@ -0,0 +1,167 @@
+# 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'
+require 'digest'
+
+module Ronin
+  module DB
+    #
+    # Represents a password used by {Service services} or {URL websites}.
+    #
+    class Password < ActiveRecord::Base
+
+      include Model
+      include Model::Importable
+
+      # @!attribute [rw] id
+      #   The primary key of the password.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] plain_text
+      #   The clear-text of the password.
+      #
+      #   @return [String]
+      attribute :plain_text, :string # length:   256,
+      validates :plain_text, presence: true, uniqueness: true
+
+      # @!attribute [rw] credentials
+      #   The credentials which use the password.
+      #
+      #   @return [Array<Credential>]
+      has_many :credentials, dependent: :destroy
+
+      # @!attribute [rw] user_names
+      #   The user names which use the password.
+      #
+      #   @return [Array<UserName>]
+      has_many :user_names, through: :credentials
+
+      #
+      # Looks up the password.
+      #
+      # @param [#to_s] password
+      #   The password to lookup.
+      #
+      # @return [Password, nil]
+      #   The found password.
+      #
+      # @api public
+      #
+      def self.lookup(password)
+        find_by(plain_text: password.to_s)
+      end
+
+      #
+      # Parses a password.
+      #
+      # @param [#to_s] password
+      #   The password to import.
+      #
+      # @return [Password]
+      #   The imported password.
+      #
+      # @api public
+      #
+      def self.import(password)
+        create(plain_text: password.to_s)
+      end
+
+      #
+      # Hashes the password.
+      #
+      # @param [Symbol, String] algorithm
+      #   The digest algorithm to use.
+      #
+      # @param [String, nil] prepend_salt
+      #   The salt data to prepend to the password.
+      #
+      # @param [String, nil] append_salt
+      #   The salt data to append to the password.
+      #
+      # @return [String]
+      #   The hex-digest of the hashed password.
+      #
+      # @raise [ArgumentError]
+      #   Unknown Digest algorithm.
+      #
+      # @example
+      #   pass = Password.new(plain_text: 'secret')
+      #   
+      #   pass.digest(:sha1)
+      #   # => "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4"
+      #   
+      #   pass.digest(:sha1, prepend_salt: "A\x90\x00")
+      #   # => "e2817656a48c49f24839ccf9295b389d8f985904"
+      #   
+      #   pass.digest(:sha1, append_salt: "BBBB")
+      #   # => "aa6ca21e446d425fc044bbb26e950a788444a5b8"
+      #
+      # @api public
+      #
+      def digest(algorithm, prepend_salt: nil, append_salt: nil)
+        digest_class = begin
+                         Digest.const_get(algorithm.upcase)
+                       rescue LoadError
+                         raise(ArgumentError,"Unknown Digest algorithm #{algorithm}")
+                       end
+
+        hash = digest_class.new
+        hash << prepend_salt.to_s if prepend_salt
+        hash << self.plain_text
+        hash << append_salt.to_s if append_salt
+
+        return hash.hexdigest
+      end
+
+      #
+      # The number of credentials which use this password.
+      #
+      # @return [Integer]
+      #   The number of credentials that use the password.
+      #
+      # @api public
+      #
+      def count
+        self.credentials.count
+      end
+
+      #
+      # Converts the password into a String.
+      #
+      # @return [String]
+      #   The clear-text of the password.
+      #
+      # @api public
+      #
+      def to_s
+        self.plain_text
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/credential'

data/lib/ronin/db/port.rb

@@ -0,0 +1,123 @@
+# 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 TCP or UDP port.
+    #
+    class Port < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary key of the port.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] protocol
+      #   The protocol of the port (either `'tcp'` / `'udp'`).
+      #
+      #   @return [:tcp, :udp]
+      enum :protocol, {tcp: 'tcp', udp: 'udp'}, default: :tcp
+      validates :protocol, presence: true
+
+      # @!attribute [rw] number
+      #   The port number.
+      #
+      #   @return [Integer]
+      attribute :number, :integer
+      validates :number, presence: true,
+                         numericality: {
+                           greater_than_or_equal_to: 1,
+                           less_than_or_equal_to:    65535
+                         },
+                         uniqueness: {scope: :protocol}
+
+      # @!attribute [rw] open_ports
+      #   The open ports.
+      #
+      #   @return [Array<OpenPort>]
+      has_many :open_ports, dependent: :destroy
+
+      #
+      # Looks up a port by it's number.
+      #
+      # @param [String, Integer] number
+      #   The port number to query.
+      #
+      # @return [Port, nil]
+      #   The found port number.
+      #
+      # @api public
+      #
+      def self.lookup(number)
+        find_by(number: number)
+      end
+
+      #
+      # Creates a new Port.
+      #
+      # @param [String, Integer] number
+      #   The port number.
+      #
+      # @return [Port]
+      #   The new or previously saved port.
+      #
+      # @api public
+      #
+      def self.import(number)
+        create(number: number)
+      end
+
+      #
+      # Converts the port to an integer.
+      #
+      # @return [Integer]
+      #   The port number.
+      #
+      # @api public
+      #
+      def to_i
+        self.number.to_i
+      end
+
+      #
+      # Converts the port to a string.
+      #
+      # @return [String]
+      #   The port number and protocol.
+      #
+      # @api public
+      #
+      def to_s
+        "#{self.number}/#{self.protocol}"
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/open_port'

data/lib/ronin/db/root.rb

@@ -0,0 +1,28 @@
+# 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
+    # Path to `ronin-db-activerecord` root directory.
+    #
+    # @api private
+    ROOT = File.expand_path(File.join(__dir__,'..','..','..'))
+  end
+end

data/lib/ronin/db/schema_migration.rb

@@ -0,0 +1,34 @@
+# 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 'active_record'
+require 'active_record/schema_migration'
+
+module Ronin
+  module DB
+    #
+    # Represents the `ronin_schema_migrations` table which tracks the applied
+    # migrations.
+    #
+    class SchemaMigration < ActiveRecord::SchemaMigration
+      self.table_name_prefix = 'ronin_'
+    end
+  end
+end

data/lib/ronin/db/service.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/>.
+#
+
+require 'ronin/db/model'
+require 'ronin/db/model/has_unique_name'
+
+module Ronin
+  module DB
+    #
+    # Represents a TCP/UDP Service that runs on various common ports.
+    #
+    class Service < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      # @!attribute [rw] id
+      #   Primary key of the service
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] open_ports
+      #   The open ports running the service
+      #
+      #   @return [Array<OpenPort>]
+      has_many :open_ports
+
+    end
+  end
+end