ronin-db-activerecord 0.1.6 → 0.2.0

data/db/migrate/0057_create_ronin_organization_members_table.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_members` table.
+#
+class CreateRoninOrganizationMembersTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_members, if_not_exists: true do |t|
+      t.boolean :active, default: true
+      t.string :type, null: true, length: 12
+      t.string :role
+      t.string :title
+      t.string :rank
+
+      t.references :person, null: false,
+                            foreign_key: {
+                              to_table: :ronin_people
+                            }
+      t.references :department, null: true,
+                                foreign_key: {
+                                  to_table: :ronin_organization_departments
+                                }
+      t.references :organization, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_organizations
+                                  }
+      t.references :email_address, null: true,
+                                   foreign_key: {
+                                     to_table: :ronin_email_addresses
+                                   }
+      t.references :phone_number, null: true,
+                                  foreign_key: {
+                                    to_table: :ronin_phone_numbers
+                                  }
+      t.timestamps
+
+      t.index :type
+    end
+  end
+
+end

data/db/migrate/0058_create_ronin_organization_customers_table.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_customers` table.
+#
+class CreateRoninOrganizationCustomersTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_customers, if_not_exists: true do |t|
+      t.references :vendor, null: false,
+                            foreign_key: {
+                              to_table: :ronin_organizations
+                            }
+
+      t.references :customer_organization, null: false,
+                                           foreign_key: {
+                                             to_table: :ronin_organizations
+                                           }
+
+      t.references :customer, null: false,
+                              foreign_key: {
+                                to_table: :ronin_people
+                              }
+
+      t.datetime :created_at, null: false
+
+      t.index [:vendor_id, :customer_organization_id, :customer_id], unique: true,
+                                                                     name:   :index_ronin_organization_customers_table_unique
+    end
+  end
+
+end

data/db/migrate/0059_create_ronin_organization_phone_numbers_table.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_phone_numbers` table.
+#
+class CreateRoninOrganizationPhoneNumbersTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_phone_numbers, if_not_exists: true do |t|
+      t.references :organization, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_organizations
+                                  }
+
+      t.references :phone_number, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_phone_numbers
+                                  }
+
+      t.datetime :created_at, null: false
+
+      t.index [:organization_id, :phone_number_id], unique: true,
+                                                    name:   :index_ronin_organization_phone_numbers_table_unique
+    end
+  end
+
+end

data/db/migrate/0060_create_ronin_organization_email_addresses_table.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_email_addresses` table.
+#
+class CreateRoninOrganizationEmailAddressesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_email_addresses, if_not_exists: true do |t|
+      t.references :organization, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_organizations
+                                  }
+      t.references :email_address, null: true,
+                                   foreign_key: {
+                                     to_table: :ronin_email_addresses
+                                   }
+      t.datetime :created_at, null: false
+
+      t.index [:organization_id, :email_address_id], unique: true,
+                                                     name:   :index_ronin_organization_email_addresses_table_unique
+    end
+  end
+
+end

data/db/migrate/0061_create_ronin_organization_street_addresses_table.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_street_addresses` table.
+#
+class CreateRoninOrganizationStreetAddressesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_street_addresses, if_not_exists: true do |t|
+      t.references :organization, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_organizations
+                                  }
+
+      t.references :street_address, null: false,
+                                    foreign_key: {
+                                      to_table: :ronin_street_addresses
+                                    }
+
+      t.datetime :created_at, null: false
+
+      t.index [:organization_id, :street_address_id], unique: true,
+                                                      name:   :index_ronin_organization_street_addresses_table_unique
+    end
+  end
+
+end

data/db/migrate/0062_add_source_ip_column_to_http_requests_table.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Adds the `source_ip` column to the `ronin_http_requests` table.
+#
+class AddSourceIpColumnToHttpRequestsTable < ActiveRecord::Migration[7.0]
+  def change
+    add_column :ronin_http_requests, :source_ip, :string, length: 39, null: true
+  end
+end

data/db/migrate/0063_create_ronin_dns_queries_table.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_dns_queries` table.
+#
+class CreateRoninDnsQueriesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_dns_queries, if_not_exists: true do |t|
+      t.string :type, length: 5, null: false
+      t.string :label, null: false
+      t.string :source_addr, length: 39, null: false
+
+      t.datetime :created_at, null: false
+
+      t.index :type
+      t.index :label
+      t.index :source_addr
+    end
+  end
+end

data/db/migrate/0064_create_ronin_dns_records_table.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_dns_records` table.
+#
+class CreateRoninDnsRecordsTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_dns_records, if_not_exists: true do |t|
+      t.integer :ttl, null: false
+      t.string :value, null: false, length: 255
+
+      t.datetime :created_at, null: false
+      t.references :dns_query, null: false,
+                               foreign_key: {
+                                 to_table: :ronin_dns_queries
+                               }
+
+      t.index :value
+    end
+  end
+end

data/db/migrate/0065_create_ronin_organization_host_names_table.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_host_names` table.
+#
+class CreateRoninOrganizationHostNamesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_host_names, if_not_exists: true do |t|
+      t.references :organization, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_organizations
+                                  }
+
+      t.references :host_name, null: false,
+                               foreign_key: {
+                                 to_table: :ronin_host_names
+                               }
+
+      t.datetime :created_at, null: false
+    end
+  end
+end

data/db/migrate/0066_create_ronin_organization_ip_addresses_table.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# 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/>.
+#
+
+#
+# Creates the `ronin_organization_ip_addresses` table.
+#
+class CreateRoninOrganizationIpAddressesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_organization_ip_addresses, if_not_exists: true do |t|
+      t.references :organization, null: false,
+                                  foreign_key: {
+                                    to_table: :ronin_organizations
+                                  }
+
+      t.references :ip_address, null: false,
+                                foreign_key: {
+                                  to_table: :ronin_ip_addresses
+                                }
+
+      t.datetime :created_at, null: false
+    end
+  end
+end

data/gemspec.yml

@@ -1,9 +1,10 @@
 name: ronin-db-activerecord
-version: 0.1.6
+version: 0.2.0
 summary: ActiveRecord backend for the Ronin Database
 description:
   ronin-db-activerecord contains ActiveRecord models and migrations for the
-  Ronin Database.
+  Ronin Database. Provides database models storing and querying network data,
+  advisory data, credentials, and OSINT data.
 
 license: LGPL-3.0
 authors: Postmodern

data/lib/ronin/db/address.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
-# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2022-2024 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

data/lib/ronin/db/advisory.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
-# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2022-2024 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
@@ -67,6 +67,63 @@ module Ronin
       attribute :identifier, :string
       validates :identifier, presence: true
 
+      # @!attribute [rw] vulnerabilities
+      #   The vulnerabilities which reference the advisory.
+      #
+      #   @return [Array<Vulnerability>]
+      #
+      #   @since 0.2.0
+      has_many :vulnerabilities, dependent: :destroy
+
+      # @!attribute [rw] mac_addresses
+      #   The MAC Addresses that are vulnerable to this advisory.
+      #
+      #   @return [Array<MACAddress>]
+      #
+      #   @since 0.2.0
+      has_many :mac_addresses, through: :vulnerabilities
+
+      # @!attribute [rw] ip_addresses
+      #   The IP Addresses that are vulnerable to this advisory.
+      #
+      #   @return [Array<IPAddress>]
+      #
+      #   @since 0.2.0
+      has_many :ip_addresses, through: :vulnerabilities
+
+      # @!attribute [rw] open_ports
+      #   The open ports that are vulnerable to this advisory.
+      #
+      #   @return [Array<OpenPort>]
+      #
+      #   @since 0.2.0
+      has_many :open_ports, through: :vulnerabilities
+
+      # @!attribute [rw] host_names
+      #   The host names that are vulnerable to this advisory.
+      #
+      #   @return [Array<HostName>]
+      #
+      #   @since 0.2.0
+      has_many :host_names, through: :vulnerabilities
+
+      # @!attribute [rw] urls
+      #   The URLs that are vulnerable to this advisory.
+      #
+      #   @return [Array<URL>]
+      #
+      #   @since 0.2.0
+      has_many :urls, through: :vulnerabilities,
+                      class_name: 'URL'
+
+      # @!attribute [rw] notes
+      #   The associated notes.
+      #
+      #   @return [Array<Note>]
+      #
+      #   @since 0.2.0
+      has_many :notes, dependent: :destroy
+
       #
       # @api private
       #
@@ -167,3 +224,11 @@ module Ronin
     end
   end
 end
+
+require 'ronin/db/vulnerability'
+require 'ronin/db/mac_address'
+require 'ronin/db/ip_address'
+require 'ronin/db/open_port'
+require 'ronin/db/host_name'
+require 'ronin/db/url'
+require 'ronin/db/note'

data/lib/ronin/db/arch.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
-# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2022-2024 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

data/lib/ronin/db/asn.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
-# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2022-2024 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
@@ -19,6 +19,7 @@
 #
 
 require 'ronin/db/model'
+require 'ronin/db/model/has_name'
 
 module Ronin
   module DB
@@ -28,6 +29,7 @@ module Ronin
     class ASN < ActiveRecord::Base
 
       include Model
+      extend Model::HasName::ClassMethods
 
       # @!attribute [rw] id
       #   The primary key of the ASN range.
@@ -195,6 +197,18 @@ module Ronin
         IPAddress.between(range_start,range_end)
       end
 
+      #
+      # Converts the ASN to a String.
+      #
+      # @return [String]
+      #   The `AS<number>` String.
+      #
+      # @since 0.2.0
+      #
+      def to_s
+        "AS#{self.number}"
+      end
+
       private
 
       #