ronin-rb/ronin-exploits

# frozen_string_literal: true
#
# ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
# payload crafting functionality.
#
# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# ronin-exploits 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-exploits 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-exploits.  If not, see <https://www.gnu.org/licenses/>.
#

module Ronin
  module Exploits
    #
    # Base class for all test results.
    #
    # @api semipublic
    #
    # @since 1.0.0
    #
    class TestResult

      # The descriptive message of the test result.
      #
      # @api public
      attr_reader :message

      #
      # Initializes the test result.
      #
      # @param [String] message
      #   The descriptive message for the result.
      #
      # @api public
      #
      def initialize(message)
        @message = message
      end

      #
      # Converts the test result to a String.
      #
      # @return [String]
      #   The test result message.
      #
      # @api public
      #
      def to_s
        @message
      end

      #
      # Indicates the presence of a vulnerability.
      #
      class Vulnerable < TestResult
      end

      #
      # Indicates no vulnerability was found.
      #
      class NotVulnerable < TestResult
      end

      #
      # Indicates inconclusive results.
      #
      class Unknown < TestResult
      end
    end
  end
end