ronin-db-activerecord 0.1.6 → 0.2.0.rc1

data/lib/ronin/db/organization_ip_address.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 {IPAddress}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationIPAddress < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   Primary key of the organization IP address.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] organization
+      #   The organization that owns the IP address.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+
+      # @!attribute [rw] ip_address
+      #   The IP address that the organization owns.
+      #
+      #   @return [IPAddress]
+      belongs_to :ip_address, class_name: 'IPAddress'
+
+      # @!attribute [r] created_at
+      #   Tracks when the organization claimed ownership of the IP address.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/ip_address'

data/lib/ronin/db/organization_member.rb

@@ -0,0 +1,158 @@
+# 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 member of an {Organization}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationMember < ActiveRecord::Base
+
+      include Model
+
+      # NOTE: disable STI so we can use the type column as an enum.
+      self.inheritance_column = nil
+
+      # @!attribute [rw] id
+      #   Primary key of the member.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] active
+      #   Specifies whether the member is active or not.
+      #
+      #   @return [Boolean]
+      attribute :active, :boolean, default: true
+
+      # @!attribute [rw] type
+      #   The type of organization membership.
+      #
+      #   @return ["advisor", "volunteer", "employee", "contractor", "intern", "board_member", nil]
+      enum :type, {
+        advisor:      'advisor',
+        volunteer:    'volunteer',
+        employee:     'employee',
+        contractor:   'contractor',
+        intern:       'intern',
+        board_member: 'board member'
+      }
+
+      # @!attribute [rw] role
+      #   The member's role within the organization.
+      #
+      #   @return [String, nil]
+      attribute :role, :string
+
+      # @!attribute [rw] title
+      #   The member's title.
+      #
+      #   @return [String, nil]
+      attribute :title, :string
+
+      # @!attribute [rw] rank
+      #   The member's rank.
+      #
+      #   @return [String, nil]
+      attribute :rank, :string
+
+      # @!attribute [rw] person
+      #   The person that belongs to the organization.
+      #
+      #   @return [Person]
+      belongs_to :person
+
+      # @!attribute [rw] department
+      #   The department that belongs to within the organization.
+      #
+      #   @return [Department, nil]
+      belongs_to :department, optional: true
+
+      # @!attribute [rw] organization
+      #   The organization that the member belongs to.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+
+      # @!attribute [rw] email_address
+      #   The member's organization email address.
+      #
+      #   @return [EmailAddress, nil]
+      belongs_to :email_address, optional: true
+
+      # @!attribute [rw] phone_number
+      #   The member's organization phone number.
+      #
+      #   @return [EmailAddress, nil]
+      belongs_to :phone_number, optional: true
+
+      # @!attribute [r] created_at
+      #   Tracks when the member was first created.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+      # @!attribute [r] updated_at
+      #   Tracks when the member was last updated.
+      #
+      #   @return [Time]
+      attribute :updated_at, :datetime
+
+      #
+      # Queries members that are currently active.
+      #
+      # @return [Array<Member>]
+      #
+      def self.active
+        where(active: true)
+      end
+
+      #
+      # Queries former members.
+      #
+      # @return [Array<Member>]
+      #
+      def self.former
+        where(active: false)
+      end
+
+      #
+      # Converts the organization member to a String.
+      #
+      # @return [String]
+      #
+      def to_s
+        person.to_s
+      end
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/person'
+require 'ronin/db/email_address'
+require 'ronin/db/phone_number'

data/lib/ronin/db/organization_phone_number.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 a {Organization}'s {PhoneNumber phone number}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationPhoneNumber < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary key of the organization phone number.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] organization
+      #   The organization.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+
+      # @!attribute [rw] phone_number
+      #   The phone number.
+      #
+      #   @return [PhoneNumber]
+      belongs_to :phone_number
+      validates :phone_number, uniqueness: {scope: :organization_id}
+
+      # @!attribute [rw] created_at
+      #   Tracks when the organization phone number was first created.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/phone_number'

data/lib/ronin/db/organization_street_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 a {Organization}'s {StreetAddress street address}.
+    #
+    # @since 0.2.0
+    #
+    class OrganizationStreetAddress < ActiveRecord::Base
+
+      include Model
+
+      # @!attribute [rw] id
+      #   The primary key of the organization street address.
+      #
+      #   @return [Integer]
+      attribute :id, :integer
+
+      # @!attribute [rw] organization
+      #   The organization.
+      #
+      #   @return [Organization]
+      belongs_to :organization
+
+      # @!attribute [rw] street_address
+      #   The street address.
+      #
+      #   @return [StreetAddress]
+      belongs_to :street_address
+      validates :street_address, uniqueness: {scope: :organization_id}
+
+      # @!attribute [rw] created_at
+      #   Tracks when the organization street address was first created.
+      #
+      #   @return [Time]
+      attribute :created_at, :datetime
+
+    end
+  end
+end
+
+require 'ronin/db/organization'
+require 'ronin/db/street_address'

data/lib/ronin/db/os.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
@@ -68,6 +68,40 @@ module Ronin
       has_many :ip_addresses, through:    :os_guesses,
                               class_name: 'IPAddress'
 
+      #
+      # Queries all OSes with the matching flavor.
+      #
+      # @param [:linux, :bsd] flavor
+      #   The flavor to search for.
+      #
+      # @return [Array<OS>]
+      #   The matching OSes.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_flavor(flavor)
+        where(flavor: flavor)
+      end
+
+      #
+      # Queries all OSes with the matching version.
+      #
+      # @param [String] version
+      #   The version number to search for.
+      #
+      # @return [Array<OS>]
+      #   The matching OSes.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_version(version)
+        where(version: version)
+      end
+
       #
       # The Linux OS
       #

data/lib/ronin/db/os_guess.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/password.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
@@ -59,6 +59,88 @@ module Ronin
       #   @return [Array<UserName>]
       has_many :user_names, through: :credentials
 
+      # @!attribute [rw] email_addresses
+      #   The email addresses which use the password.
+      #
+      #   @return [Array<EmailAddress>]
+      #
+      #   @since 0.2.0
+      has_many :email_addresses, through: :credentials
+
+      # @!attribute [rw] service_credentials
+      #   The service credentials that use the password.
+      #
+      #   @return [Array<ServiceCredential>]
+      #
+      #   @since 0.2.0
+      has_many :service_credentials, through: :credentials
+
+      # @!attribute [rw] web_credentials
+      #   Any web credentials that use the password.
+      #
+      #   @return [Array<WebCredential>]
+      #
+      #   @since 0.2.0
+      has_many :web_credentials, through: :credentials
+
+      # @!attribute [rw] notes
+      #   The associated notes.
+      #
+      #   @return [Array<Note>]
+      #
+      #   @since 0.2.0
+      has_many :notes, dependent: :destroy
+
+      #
+      # Searches for all passwords used by a specific user.
+      #
+      # @param [String] name
+      #   The name of the user.
+      #
+      # @return [Array<Password>]
+      #   The passwords for the user.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.for_user(name)
+        joins(credentials: :user_name).where(credentials: {ronin_user_names: {name: name}})
+      end
+
+      #
+      # Searches all passwords that are associated with an email address.
+      #
+      # @param [String] email
+      #   The email address to search for.
+      #
+      # @return [Array<Password>]
+      #   The passwords associated with the email address.
+      #
+      # @raise [ArgumentError]
+      #   The given email address was not a valid email address.
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def self.with_email_address(email)
+        unless email.include?('@')
+          raise(ArgumentError,"invalid email address #{email.inspect}")
+        end
+
+        user, domain = email.split('@',2)
+
+        return joins(credentials: {email_address: [:user_name, :host_name]}).where(
+          credentials: {
+            email_address: {
+              ronin_user_names: {name: user},
+              ronin_host_names: {name: domain}
+            }
+          }
+        )
+      end
+
       #
       # Looks up the password.
       #
@@ -165,3 +247,4 @@ module Ronin
 end
 
 require 'ronin/db/credential'
+require 'ronin/db/note'