ronin-db-activerecord 0.1.6 → 0.2.0

data/lib/ronin/db/host_name.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
@@ -101,6 +101,46 @@ module Ronin
       has_many :urls, dependent: :destroy,
                       class_name: 'URL'
 
+      # @!attribute [rw] vulnerabilities
+      #   The vulnerabilities which reference the host name.
+      #
+      #   @return [Array<Vulnerability>]
+      #
+      #   @since 0.2.0
+      has_many :vulnerabilities, dependent: :destroy
+
+      # @!attribute [rw] advisories
+      #   The advisories that the host names is vulnerable to.
+      #
+      #   @return [Array<Advisory>]
+      #
+      #   @since 0.2.0
+      has_many :advisories, through: :vulnerabilities
+
+      # @!attribute [rw] organization_host_names
+      #   The association of host names and organizations.
+      #
+      #   @return [Array<OrganizationHostName>]
+      #
+      #   @since 0.2.0
+      has_many :organization_host_names, dependent: :destroy
+
+      # @!attribute [rw] organizations
+      #   The organizations that claim ownership of the host name.
+      #
+      #   @return [Array<Organization>]
+      #
+      #   @since 0.2.0
+      has_many :organizations, through: :organization_host_names
+
+      # @!attribute [rw] notes
+      #   The associated notes.
+      #
+      #   @return [Array<Note>]
+      #
+      #   @since 0.2.0
+      has_many :notes, dependent: :destroy
+
       #
       # Looks up the host name.
       #
@@ -223,3 +263,7 @@ end
 
 require 'ronin/db/host_name_ip_address'
 require 'ronin/db/ip_address'
+require 'ronin/db/vulnerability'
+require 'ronin/db/advisory'
+require 'ronin/db/organization_host_name'
+require 'ronin/db/note'

data/lib/ronin/db/host_name_ip_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/http_header_name.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/http_query_param.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/http_query_param_name.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/http_request.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
@@ -21,6 +21,7 @@
 require 'ronin/db/model'
 
 require 'active_record'
+require 'resolv'
 
 module Ronin
   module DB
@@ -115,6 +116,17 @@ module Ronin
       #   @return [Time]
       attribute :created_at, :datetime
 
+      # @!attribute [rw] source_ip
+      #   The source IP Address.
+      #
+      #   @return [String, nil]
+      attribute :source_ip, :string
+      validates :source_ip, length: { maximum: 39 },
+                            format: {
+                              with: /#{Resolv::IPv4::Regex}|#{Resolv::IPv6::Regex}/,
+                              message: 'Must be a valid IP address'
+                            },
+                            allow_nil: true
     end
   end
 end

data/lib/ronin/db/http_request_header.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/http_response.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/http_response_header.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/ip_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
@@ -112,6 +112,47 @@ module Ronin
       has_many :oses, through: :os_guesses,
                       class_name: 'OS'
 
+      # @!attribute [rw] vulnerabilities
+      #   The vulnerabilities which reference the IP Address.
+      #
+      #   @return [Array<Vulnerability>]
+      #
+      #   @since 0.2.0
+      has_many :vulnerabilities, dependent: :destroy
+
+      # @!attribute [rw] advisories
+      #   The advisories that the IP Address is vulnerable to.
+      #
+      #   @return [Array<Advisory>]
+      #
+      #   @since 0.2.0
+      has_many :advisories, through: :vulnerabilities
+
+      # @!attribute [rw] organization_ip_addresses
+      #   The association of IP addresses and organizations.
+      #
+      #   @return [Array<OrganizationIPAddress>]
+      #
+      #   @since 0.2.0
+      has_many :organization_ip_addresses, class_name: 'OrganizationIPAddress',
+                                           dependent:  :destroy
+
+      # @!attribute [rw] organizations
+      #   The organizations that claim ownership of the IP address.
+      #
+      #   @return [Array<Organization>]
+      #
+      #   @since 0.2.0
+      has_many :organizations, through: :organization_ip_addresses
+
+      # @!attribute [rw] notes
+      #   The associated notes.
+      #
+      #   @return [Array<Note>]
+      #
+      #   @since 0.2.0
+      has_many :notes, dependent: :destroy
+
       #
       # Searches for all IPv4 addresses.
       #
@@ -349,3 +390,7 @@ require 'ronin/db/port'
 require 'ronin/db/os_guess'
 require 'ronin/db/os'
 require 'ronin/db/asn'
+require 'ronin/db/vulnerability'
+require 'ronin/db/advisory'
+require 'ronin/db/organization_ip_address'
+require 'ronin/db/note'

data/lib/ronin/db/ip_address_mac_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/mac_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
@@ -57,6 +57,30 @@ module Ronin
       has_many :ip_addresses, through:    :ip_address_mac_addresses,
                               class_name: 'IPAddress'
 
+      # @!attribute [rw] vulnerabilities
+      #   The vulnerabilities which reference the MAC Address.
+      #
+      #   @return [Array<Vulnerability>]
+      #
+      #   @since 0.2.0
+      has_many :vulnerabilities, dependent: :destroy
+
+      # @!attribute [rw] advisories
+      #   The advisories that the MAC Address 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
+
       #
       # The IP Address that most recently used the MAC Address.
       #
@@ -89,3 +113,6 @@ end
 
 require 'ronin/db/ip_address_mac_address'
 require 'ronin/db/ip_address'
+require 'ronin/db/vulnerability'
+require 'ronin/db/advisory'
+require 'ronin/db/note'

data/lib/ronin/db/migrations.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/model/has_name.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
@@ -77,6 +77,23 @@ module Ronin
 
             where(name_column.matches("%#{sanitize_sql_like(fragment)}%"))
           end
+
+          #
+          # Finds all models with the matching name.
+          #
+          # @param [String] name
+          #   The name to search for.
+          #
+          # @return [Array<Model>]
+          #   The found models.
+          #
+          # @api public
+          #
+          # @since 0.2.0
+          #
+          def with_name(name)
+            where(name: name)
+          end
         end
 
         #

data/lib/ronin/db/model/has_unique_name.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/model/importable.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/model/last_scanned_at.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/model.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/models.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
@@ -29,9 +29,21 @@ require 'ronin/db/ip_address_mac_address'
 require 'ronin/db/mac_address'
 require 'ronin/db/open_port'
 require 'ronin/db/organization'
+require 'ronin/db/organization_street_address'
+require 'ronin/db/organization_customer'
+require 'ronin/db/organization_department'
+require 'ronin/db/organization_phone_number'
+require 'ronin/db/organization_email_address'
+require 'ronin/db/organization_host_name'
+require 'ronin/db/organization_ip_address'
 require 'ronin/db/os'
 require 'ronin/db/os_guess'
 require 'ronin/db/password'
+require 'ronin/db/person'
+require 'ronin/db/personal_phone_number'
+require 'ronin/db/personal_email_address'
+require 'ronin/db/personal_street_address'
+require 'ronin/db/personal_connection'
 require 'ronin/db/port'
 require 'ronin/db/service'
 require 'ronin/db/service_credential'
@@ -40,6 +52,7 @@ require 'ronin/db/url_query_param_name'
 require 'ronin/db/url_query_param'
 require 'ronin/db/url_scheme'
 require 'ronin/db/url'
+require 'ronin/db/web_vuln'
 require 'ronin/db/user_name'
 require 'ronin/db/software_vendor'
 require 'ronin/db/web_credential'
@@ -53,6 +66,14 @@ require 'ronin/db/http_request'
 require 'ronin/db/http_response'
 require 'ronin/db/advisory'
 require 'ronin/db/vulnerability'
+require 'ronin/db/cert_name'
+require 'ronin/db/cert_issuer'
+require 'ronin/db/cert_subject'
+require 'ronin/db/cert_subject_alt_name'
+require 'ronin/db/cert'
+require 'ronin/db/dns_query'
+require 'ronin/db/dns_record'
+require 'ronin/db/note'
 
 module Ronin
   module DB
@@ -74,7 +95,19 @@ module Ronin
         OSGuess,
         OpenPort,
         Organization,
+        OrganizationStreetAddress,
+        OrganizationCustomer,
+        OrganizationDepartment,
+        OrganizationPhoneNumber,
+        OrganizationEmailAddress,
+        OrganizationHostName,
+        OrganizationIPAddress,
         Password,
+        Person,
+        PersonalPhoneNumber,
+        PersonalEmailAddress,
+        PersonalStreetAddress,
+        PersonalConnection,
         Port,
         Service,
         ServiceCredential,
@@ -83,6 +116,7 @@ module Ronin
         URLQueryParam,
         URLScheme,
         URL,
+        WebVuln,
         UserName,
         SoftwareVendor,
         WebCredential,
@@ -95,7 +129,15 @@ module Ronin
         HTTPRequest,
         HTTPResponse,
         Advisory,
-        Vulnerability
+        Vulnerability,
+        CertName,
+        CertIssuer,
+        CertSubject,
+        CertSubjectAltName,
+        Cert,
+        DNSQuery,
+        DNSRecord,
+        Note
       ]
 
       #

data/lib/ronin/db/note.rb

@@ -0,0 +1,199 @@
+# 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
+    #
+    # A model for associating notes with other models.
+    #
+    # @since 0.2.0
+    #
+    class Note < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary key of the Note.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] body
+      #   The note text.
+      #
+      #   @return [String]
+      attribute :body, :text
+      validates :body, presence: true
+
+      # @!attribute [rw] created_at
+      #   Tracks when the note was created.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+      # @!attribute [rw] updated_at
+      #   Tracks when the note was last edited.
+      #
+      #   @return [Time]
+      attribute :updated_at, :datetime
+
+      # @!attribute [rw] mac_address
+      #   The associated MAC address.
+      #
+      #   @return [MACAddress, nil]
+      belongs_to :mac_address, optional:   true,
+                               class_name: 'MACAddress'
+
+      # @!attribute [rw] ip_address
+      #   The associated IP address.
+      #
+      #   @return [IPAddress, nil]
+      belongs_to :ip_address, optional:   true,
+                              class_name: 'IPAddress'
+
+      # @!attribute [rw] host_name
+      #   The associated host name.
+      #
+      #   @return [HostName, nil]
+      belongs_to :host_name, optional: true
+
+      # @!attribute [rw] port
+      #   The associated port.
+      #
+      #   @return [Port, nil]
+      belongs_to :port, optional: true
+
+      # @!attribute [rw] service
+      #   The associated service.
+      #
+      #   @return [Service, nil]
+      belongs_to :service, optional: true
+
+      # @!attribute [rw] open_port
+      #   The associated open port.
+      #
+      #   @return [OpenPort, nil]
+      belongs_to :open_port, optional: true
+
+      # @!attribute [rw] cert
+      #   The associated certificate.
+      #
+      #   @return [Cert, nil]
+      belongs_to :cert, optional: true
+
+      # @!attribute [rw] url
+      #   The associated URL.
+      #
+      #   @return [URL, nil]
+      belongs_to :url, optional:   true,
+                       class_name: 'URL'
+
+      # @!attribute [rw] user_name
+      #   The associated user name.
+      #
+      #   @return [UserName, nil]
+      belongs_to :user_name, optional: true
+
+      # @!attribute [rw] email_address
+      #   The associated email address.
+      #
+      #   @return [EmailAddress, nil]
+      belongs_to :email_address, optional: true
+
+      # @!attribute [rw] password
+      #   The associated password.
+      #
+      #   @return [Password, nil]
+      belongs_to :password, optional: true
+
+      # @!attribute [rw] credential
+      #   The associated credential.
+      #
+      #   @return [Credential, nil]
+      belongs_to :credential, optional: true
+
+      # @!attribute [rw] advisory
+      #   The associated advisory.
+      #
+      #   @return [Advisory, nil]
+      belongs_to :advisory, optional: true
+
+      # @!attribute [rw] phone_number
+      #   The associated phone number.
+      #
+      #   @return [PhoneNumber, nil]
+      belongs_to :phone_number, optional: true
+
+      # @!attribute [rw] street_address
+      #   The associated street address.
+      #
+      #   @return [StreetAddress, nil]
+      belongs_to :street_address, optional: true
+
+      # @!attribute [rw] person
+      #   The associated person.
+      #
+      #   @return [Person, nil]
+      belongs_to :person, optional: true
+
+      # @!attribute [rw] organization
+      #   The associated organization.
+      #
+      #   @return [Organization, nil]
+      belongs_to :organization, optional: true
+
+      validate :validate_at_least_one_belongs_to_set
+
+      private
+
+      #
+      # Validates that at least one of the `belongs_to` associations is set.
+      #
+      def validate_at_least_one_belongs_to_set
+        unless (mac_address || ip_address || host_name || port || service || open_port || cert || url || user_name || email_address || password || credential || advisory || phone_number || street_address || person || organization)
+          errors.add(:base, 'note must be associated with a MACAddress, IPAddress, HostName, Port, Service, OpenPort, Cert, URL, UserName, EmailAddress, Password, Credential, Advisory, PhoneNumber, StreetAddress, Person, or Organization')
+        end
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/mac_address'
+require 'ronin/db/ip_address'
+require 'ronin/db/host_name'
+require 'ronin/db/port'
+require 'ronin/db/service'
+require 'ronin/db/open_port'
+require 'ronin/db/cert'
+require 'ronin/db/url'
+require 'ronin/db/user_name'
+require 'ronin/db/email_address'
+require 'ronin/db/password'
+require 'ronin/db/credential'
+require 'ronin/db/advisory'
+require 'ronin/db/street_address'
+require 'ronin/db/phone_number'
+require 'ronin/db/person'
+require 'ronin/db/organization'