ronin-db-activerecord 0.1.0.beta1

data/lib/ronin/db/url_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 {URL}.
+    #
+    class URLQueryParam < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary-key of the URL query param
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The name of the URL query param.
+      #
+      #   @return [URLQueryParamName]
+      belongs_to :name, required:   true,
+                        class_name: 'URLQueryParamName'
+      validates :name_id, uniqueness: {scope: :url_id}
+
+      # @!attribute [rw] value
+      #   The value of the URL query param
+      #
+      #   @return [String]
+      attribute :value, :text
+
+      # @!attribute [rw] url
+      #   The URL that the query param belongs to.
+      #
+      #   @return [URL]
+      belongs_to :url, required:   true,
+                       class_name: 'URL'
+
+      #
+      # Converts the URL query param to a String.
+      #
+      # @return [String]
+      #   The dumped URL query param.
+      #
+      # @api public
+      #
+      def to_s
+        URI::QueryParams.dump(self.name.to_s => self.value)
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/url_query_param_name'
+require 'ronin/db/url'

data/lib/ronin/db/url_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/has_unique_name'
+require 'ronin/db/model'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents the name of a {URLQueryParam}.
+    #
+    class URLQueryParamName < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      # @!attribute [rw] id
+      #   The primary-key of the URL query param.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] name
+      #   The name of the URL query param.
+      #
+      #   @return [String]
+      attribute :name, :string # length:   256
+      validates :name, presence: true, uniqueness: true
+
+      # @!attribute [rw] query_params
+      #   The URL query params.
+      #
+      #   @return [Array<URLQueryParam>]
+      has_many :query_params, class_name:  'URLQueryParam',
+                              foreign_key: :name_id
+
+      # @!attribute [r] created_at
+      #   When the URL query param name was first created.
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+      #
+      # Converts the URL query param name to a String.
+      #
+      # @return [String]
+      #   The name of the URL query param
+      #
+      # @api public
+      #
+      def to_s
+        self.name.to_s
+      end
+
+    end
+  end
+end

data/lib/ronin/db/url_scheme.rb

@@ -0,0 +1,80 @@
+# 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 {URL} scheme.
+    #
+    class URLScheme < ActiveRecord::Base
+
+      include Model
+      include Model::HasUniqueName
+
+      self.table_name = 'ronin_url_schemes'
+      
+      # @!attribute [rw] id
+      #   The primary key of the URL scheme.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] urls
+      #   The URLs that use the scheme.
+      #
+      #   @return [Array<URL>]
+      has_many :urls, class_name: 'URL',
+                      foreign_key: :scheme_id
+
+      #
+      # The HTTP URL Scheme
+      #
+      # @return [URLScheme]
+      #
+      def self.http
+        where(name: 'http').first
+      end
+
+      #
+      # The HTTPS URL Scheme
+      #
+      # @return [URLScheme]
+      #
+      def self.https
+        where(name: 'https').first
+      end
+
+      #
+      # The FTP URL Scheme
+      #
+      # @return [URLScheme]
+      #
+      def self.ftp
+        where(name: 'ftp').first
+      end
+
+    end
+  end
+end

data/lib/ronin/db/user_name.rb

@@ -0,0 +1,96 @@
+# 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/has_unique_name'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a user name and their associated {Credential credentials}
+    # or {EmailAddress email addresses}.
+    #
+    class UserName < ActiveRecord::Base
+
+      include Model
+      include Model::Importable
+      include Model::HasUniqueName
+
+      self.table_name = 'ronin_user_names'
+
+      # @!attribute [rw] id
+      #   The primary key of the user name.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [r] created_at
+      #   Tracks when the user-name was created.
+      #
+      #   @return [Time]
+      attribute :created_at, :time
+
+      # @!attribute [rw] credentials
+      #   Any credentials belonging to the user.
+      #
+      #   @return [Array<Credential>]
+      has_many :credentials, dependent: :destroy
+
+      # @!attribute [rw] email_addresses
+      #   The email addresses of the user.
+      #
+      #   @return [Array<EmailAddress>]
+      has_many :email_addresses, dependent: :destroy
+
+      #
+      # Looks up the user name.
+      #
+      # @param [String] name
+      #   The user name to lookup.
+      #
+      # @return [UserName, nil]
+      #   The found user name.
+      #
+      def self.lookup(name)
+        find_by(name: name)
+      end
+
+      #
+      # Imports a user name.
+      #
+      # @param [String] name
+      #   The user name to import.
+      #
+      # @return [UserName]
+      #   The imported user name.
+      #
+      def self.import(name)
+        create(name: name)
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/credential'
+require 'ronin/db/email_address'

data/lib/ronin/db/vulnerability.rb

@@ -0,0 +1,81 @@
+# 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/advisory'
+require 'ronin/db/address'
+require 'ronin/db/open_port'
+require 'ronin/db/url'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    class Vulnerability < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary key of the vulnerability.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] mac_address
+      #   The MAC address that is vulnerable.
+      #
+      #   @return [MACAddress, nil]
+      belongs_to :mac_address, optional:   true,
+                               class_name: 'MACAddress'
+
+      # @!attribute [rw] ip_address
+      #   The IP address that is vulnerable.
+      #
+      #   @return [IPAddress, nil]
+      belongs_to :ip_address, optional:   true,
+                              class_name: 'IPAddress'
+
+      # @!attribute [rw] host_name
+      #   The host name that is vulnerable.
+      #
+      #   @return [HostName, nil]
+      belongs_to :host_name, optional: true
+
+      # @!attribute [rw] open_port
+      #   The open port that hosts a vulnerable service.
+      #
+      #   @return [OpenPort, nil]
+      belongs_to :open_port, optional: true
+
+      # @!attribute [rw] url
+      #   The URL that is vulnerable.
+      #
+      #   @return [URL, nil]
+      belongs_to :url, optional: true
+
+      # @!attribute [rw] advisory
+      #   The vulnerability advisory.
+      #
+      #   @return [Advisory]
+      belongs_to :advisory
+
+    end
+  end
+end

data/lib/ronin/db/web_credential.rb

@@ -0,0 +1,69 @@
+# 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 Credentials used to access websites at specified {URL}s.
+    #
+    class WebCredential < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   Primary key of the service credential.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] credential
+      #
+      #   @return [Credential]
+      belongs_to :credential
+
+      # @!attribute [rw] url
+      #   The URL the credential can be used with.
+      #
+      #   @return [URL, nil]
+      belongs_to :url, optional:   true,
+                       class_name: 'URL'
+
+      #
+      # Converts the web credential to a String.
+      #
+      # @return [String]
+      #   The user name, clear-text password and the optional URL.
+      #
+      # @api public
+      #
+      def to_s
+        "#{self.credential} (#{self.url})"
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/credential'
+require 'ronin/db/url'

data/ronin-db-activerecord.gemspec

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'ronin/db/version'
+                  Ronin::DB::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files  = `git ls-files`.split($/)
+  gem.files  = glob[gemspec['files']] if gemspec['files']
+  gem.files += Array(gemspec['generated_files'])
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || 'spec/{**/}*_spec.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end