# frozen_string_literal: true
#
# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
#
# Copyright (c) 2022-2023 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