ronin-db-activerecord 0.1.6 → 0.2.0

data/lib/ronin/db/open_port.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
@@ -70,6 +70,12 @@ module Ronin
       #   @return [Boolean]
       attribute :ssl, :boolean
 
+      # @!attribute [rw] cert
+      #   The SSL/TLS certificate used by the open port.
+      #
+      #   @return [Cert, nil]
+      belongs_to :cert, optional: true
+
       # @!attribute [r] created_at
       #   Define the created_at timestamp
       #
@@ -88,6 +94,98 @@ module Ronin
       #   @return [Array<Credential>]
       has_many :credentials, through: :service_credentials
 
+      # @!attribute [rw] vulnerabilities
+      #   The vulnerabilities which reference the open port.
+      #
+      #   @return [Array<Vulnerability>]
+      #
+      #   @since 0.2.0
+      has_many :vulnerabilities, dependent: :destroy
+
+      # @!attribute [rw] advisories
+      #   The advisories that the open port is vulnerable to.
+      #
+      #   @return [Array<Advisory>]
+      #
+      #   @since 0.2.0
+      has_many :advisories, through: :vulnerabilities
+
+      # @!attribute [rw] notes
+      #   The associated notes.
+      #
+      #   @return [Array<Note>]
+      #
+      #   @since 0.2.0
+      has_many :notes, dependent: :destroy
+
+      #
+      # Queries all open ports with the port number.
+      #
+      # @param [Integer] number
+      #   The port number to search for.
+      #
+      # @return [Array<OpenPort>]
+      #   The open ports that use the port number.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_port_number(number)
+        joins(:port).where(port: {number: number})
+      end
+
+      #
+      # Queries all open ports with the protocol.
+      #
+      # @param [:tcp, ;udp] protocol
+      #   The protocol to search for.
+      #
+      # @return [Array<OpenPort>]
+      #   The open ports that use the protocol.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_protocol(protocol)
+        joins(:port).where(port: {protocol: protocol})
+      end
+
+      #
+      # Queries all open ports associated with the service name.
+      #
+      # @param [String] name
+      #   The service name to search for.
+      #
+      # @return [Array<OpenPort>]
+      #   The open ports associated with the service name.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_service_name(name)
+        joins(:service).where(service: {name: name})
+      end
+
+      #
+      # Queries all open ports associated with the IP address.
+      #
+      # @param [String] address
+      #   The IP address to search by.
+      #
+      # @return [Array<OpenPort>]
+      #   The open ports associated with the IP address.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_ip_address(address)
+        joins(:ip_address).where(ip_address: {address: address})
+      end
+
       #
       # The IP Address of the open port.
       #
@@ -133,8 +231,8 @@ module Ronin
       # @api public
       #
       def to_s
-        if self.service then "#{self.port} (#{self.service})"
-        else                 "#{self.port}"
+        if self.service then "#{self.ip_address} #{self.port} (#{self.service})"
+        else                 "#{self.ip_address} #{self.port}"
         end
       end
 
@@ -146,3 +244,6 @@ require 'ronin/db/ip_address'
 require 'ronin/db/port'
 require 'ronin/db/service'
 require 'ronin/db/service_credential'
+require 'ronin/db/vulnerability'
+require 'ronin/db/advisory'
+require 'ronin/db/note'

data/lib/ronin/db/organization.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,7 +19,8 @@
 #
 
 require 'ronin/db/model'
-require 'ronin/db/model/has_unique_name'
+require 'ronin/db/model/has_name'
+require 'ronin/db/model/importable'
 
 require 'active_record'
 
@@ -31,7 +32,11 @@ module Ronin
     class Organization < ActiveRecord::Base
 
       include Model
-      include Model::HasUniqueName
+      include Model::HasName
+      include Model::Importable
+
+      # NOTE: disable STI so we can use the type column as an enum.
+      self.inheritance_column = nil
 
       # @!attribute [rw] id
       #   Primary key of the organization
@@ -39,12 +44,241 @@ module Ronin
       #   @return [Integer]
       attribute :id, :integer
 
+      # @!attribute [rw] type
+      #   The type for the organization.
+      #
+      #   @return ["company", "government", "military", nil]
+      #
+      #   @since 0.2.0
+      enum :type, {
+        company:    'company',
+        government: 'government',
+        military:   'military'
+      }, prefix: 'is_'
+
       # @!attribute [r] created_at
       #   Tracks when the organization was first created
       #
       #   @return [Time]
       attribute :created_at, :datetime
 
+      # @!attribute [rw] parent
+      #   The optional parent organization.
+      #
+      #   @return [Organization, nil]
+      #
+      #   @since 0.2.0
+      belongs_to :parent, optional:   true,
+                          class_name: 'Organization'
+
+      # NOTE: ensure the name is unique with respect to the parent organization
+      validates :name, uniqueness: {scope: [:parent_id]}
+
+      # @!attribute [rw] organization_street_addresses
+      #   The association of street addresses associated with the organization.
+      #
+      #   @return [Array<OrganizationStreetAddress>]
+      #
+      #   @since 0.2.0
+      has_many :organization_street_addresses, dependent: :destroy
+
+      # @!attribute [rw] street_addresses
+      #   The street addresses that are associated with the organization.
+      #
+      #   @return [Array<StreetAddress>]
+      #
+      #   @since 0.2.0
+      has_many :street_addresses, through: :organization_street_addresses
+
+      # @!attribute [rw] organization_phone_numbers
+      #   The association of phone numbers associated with the organization.
+      #
+      #   @return [Array<OrganizationPhoneNumber>]
+      #
+      #   @since 0.2.0
+      has_many :organization_phone_numbers, dependent: :destroy
+
+      # @!attribute [rw] phone_numbers
+      #   The phone numbers that are associated with the organization.
+      #
+      #   @return [Array<PhoneNumber>]
+      #
+      #   @since 0.2.0
+      has_many :phone_numbers, through: :organization_phone_numbers
+
+      # @!attribute [rw] organization_email_addresses
+      #   The association of email addresses associated directly with the
+      #   organization.
+      #
+      #   @return [Array<OrganizationEmailAddress>]
+      #
+      #   @since 0.2.0
+      has_many :organization_email_addresses, dependent: :destroy
+
+      # @!attribute [rw] organization_email_addresses
+      #   The email addresses directly associated directly with the
+      #   organization.
+      #
+      #   @return [Array<EmailAddress>]
+      #
+      #   @since 0.2.0
+      has_many :email_addresses, through: :organization_email_addresses
+
+      # @!attribute [rw] departments
+      #   The associated departments of the organization.
+      #
+      #   @return [Array<OrganizationDepartment>]
+      #
+      #   @since 0.2.0
+      has_many :departments, class_name: 'OrganizationDepartment',
+                             dependent:  :destroy
+
+      # @!attribute [rw] members
+      #   The members that belong to the organization.
+      #
+      #   @return [Array<OrganizationMember>]
+      #
+      #   @since 0.2.0
+      has_many :members, class_name: 'OrganizationMember'
+
+      # @!attribute [rw] member_email_addresses
+      #   The email addresses used by members of the organization.
+      #
+      #   @return [Array<EmailAddress>]
+      #
+      #   @since 0.2.0
+      has_many :member_email_addresses, through: :members,
+                                        source:  :email_address
+
+      # @!attribute [rw] organization_customers
+      #   The organization's customer relationships.
+      #
+      #   @return [Array<OrganizationCustomer>]
+      #
+      #   @since 0.2.0
+      has_many :organization_customers, class_name:  'OrganizationCustomer',
+                                        foreign_key: :vendor_id,
+                                        dependent:   :destroy
+
+      # @!attribute [rw] customers
+      #   The individual customers (B2C) of the organization/
+      #
+      #   @return [Array<Person>]
+      #
+      #   @since 0.2.0
+      has_many :customers, through: :organization_customers
+
+      # @!attribute [rw] customer_organizations
+      #   The other customer organizations (B2B) of the organization.
+      #
+      #   @return [Array<Organization>]
+      #
+      #   @since 0.2.0
+      has_many :customer_organizations, through: :organization_customers
+
+      # @!attribute [rw] vendor_relationships
+      #   The organization's vendor relationships with other organizations.
+      #
+      #   @return [Array<OrganizationCustomer>]
+      #
+      #   @since 0.2.0
+      has_many :organization_vendors, class_name:  'OrganizationCustomer',
+                                      foreign_key: :customer_organization_id,
+                                      dependent:   :destroy
+
+      # @!attribute [rw] vendors
+      #   The vendor companies that the organization is a customer of.
+      #
+      #   @return [Array<Organization>]
+      #
+      #   @since 0.2.0
+      has_many :vendors, through: :organization_vendors
+
+      # @!attribute [rw] organization_host_names
+      #   The association of organizations and host names.
+      #
+      #   @return [Array<OrganizationHostName>]
+      #
+      #   @since 0.2.0
+      has_many :organization_host_names, dependent: :destroy
+
+      # @!attribute [rw] host_names
+      #   The host names that the organization owns.
+      #
+      #   @return [Array<HostName>]
+      #
+      #   @since 0.2.0
+      has_many :host_names, through: :organization_host_names
+
+      # @!attribute [rw] organization_ip_addresses
+      #   The association of organizations and IP addresses.
+      #
+      #   @return [Array<OrganizationIPAddress>]
+      #
+      #   @since 0.2.0
+      has_many :organization_ip_addresses, class_name: 'OrganizationIPAddress',
+                                           dependent:  :destroy
+
+      # @!attribute [rw] ip_addresses
+      #   The IP addresses that the organization owns.
+      #
+      #   @return [Array<IPAddress>]
+      #
+      #   @since 0.2.0
+      has_many :ip_addresses, through: :organization_ip_addresses
+
+      # @!attribute [rw] notes
+      #   The associated notes.
+      #
+      #   @return [Array<Note>]
+      #
+      #   @since 0.2.0
+      has_many :notes, dependent: :destroy
+
+      #
+      # Looks up the organization.
+      #
+      # @param [String] name
+      #   The organization name to query.
+      #
+      # @return [Organization, nil]
+      #   The found organization.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.lookup(name)
+        find_by(name: name)
+      end
+
+      #
+      # Imports an organization.
+      #
+      # @param [String] name
+      #   The organization name to import.
+      #
+      # @return [Organization]
+      #   The imported organization.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.import(name)
+        create(name: name)
+      end
+
     end
   end
 end
+
+require 'ronin/db/organization_street_address'
+require 'ronin/db/organization_phone_number'
+require 'ronin/db/organization_email_address'
+require 'ronin/db/organization_department'
+require 'ronin/db/organization_member'
+require 'ronin/db/organization_customer'
+require 'ronin/db/organization_host_name'
+require 'ronin/db/organization_ip_address'
+require 'ronin/db/note'

data/lib/ronin/db/organization_customer.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# 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
+# 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 customer relationship of an {Organization}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationCustomer < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   Primary key of the customer relationship.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] vendor
+      #   The vendor company.
+      #
+      #   @return [Organization]
+      belongs_to :vendor, class_name: 'Organization'
+
+      # @!attribute [rw] organization
+      #   The customer organization.
+      #
+      #   @return [Organization, nil]
+      belongs_to :customer_organization, class_name: 'Organization'
+      validates :customer_organization, uniqueness: {scope: :vendor_id}
+
+      # @!attribute [rw] person
+      #   The customer organization.
+      #
+      #   @return [Person, nil]
+      belongs_to :customer, class_name: 'Person'
+      validates :customer, uniqueness: {scope: :vendor_id}
+
+      # @!attribute [r] created_at
+      #   Tracks when the customer relationship was first created
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/person'

data/lib/ronin/db/organization_department.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# 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
+# 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'
+
+require 'active_record'
+
+module Ronin
+  module DB
+    #
+    # Represents a department of an organization.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationDepartment < ActiveRecord::Base
+
+      include Model
+      include Model::HasName
+
+      # @!attribute [rw] organization
+      #   The organization that the department belongs to.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+      validates :name, uniqueness: {scope: :organization_id}
+
+      # @!attribute [rw] street_address
+      #   The optional street address of the department.
+      #
+      #   @return [StreetAddress, nil]
+      belongs_to :street_address, optional: true
+
+      # @!attribute [rw] phone_number
+      #   The optional phone number of the department.
+      #
+      #   @return [PhoneNumber, nil]
+      belongs_to :phone_number, optional: true
+
+      # @!attribute [rw] email_address
+      #   The optional email address of the department.
+      #
+      #   @return [EmailAddress, nil]
+      belongs_to :email_address, optional: true
+
+      # @!attribute [rw] parent_department
+      #   The optional parent department of the subdepartment.
+      #
+      #   @return [OrganizationDepartment, nil]
+      belongs_to :parent_department, optional:   true,
+                                     class_name: 'OrganizationDepartment'
+
+      # @!attribute [r] created_at
+      #   Tracks when the organization was first created
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+      # @!attribute [rw] subdepartments
+      #   The associated subdepartments of the department.
+      #
+      #   @return [Array<OrganizationDepartment>]
+      has_many :subdepartments, class_name:  'OrganizationDepartment',
+                                foreign_key: :parent_department_id,
+                                dependent:   :destroy
+
+      # @!attribute [rw] members
+      #   The members that belong to the department.
+      #
+      #   @return [Array<OrganizationMember>]
+      has_many :members, class_name: 'OrganizationMember'
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/street_address'
+require 'ronin/db/phone_number'
+require 'ronin/db/email_address'

data/lib/ronin/db/organization_email_address.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# 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
+# 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 an email address associated with an {Organization}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationEmailAddress < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   Primary key of the member.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] organization
+      #   The organization.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+
+      # @!attribute [rw] email_address
+      #   The email address associated with the organization.
+      #
+      #   @return [EmailAddress]
+      belongs_to :email_address
+      validates :email_address, uniqueness: {scope: :organization_id}
+
+      # @!attribute [r] created_at
+      #   Tracks when the organization email address was first created.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+    end
+  end
+end
+
+require 'ronin/db/email_address'
+require 'ronin/db/organization'

data/lib/ronin/db/organization_host_name.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# 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
+# 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 an association between an {Organization} and a {HostName}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationHostName < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   Primary key of the organization
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] organization
+      #   The organization that owns the host name.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+
+      # @!attribute [rw] host_name
+      #   The host name that the organization owns.
+      #
+      #   @return [HostName]
+      belongs_to :host_name
+
+      # @!attribute [r] created_at
+      #   Tracks when the organization claimed ownership of the host name.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/host_name'