logger.rb

#
# Copyright (c) 2006-2025 Wade Alcorn - [email protected]
# Browser Exploitation Framework (BeEF) - https://beefproject.com
# See the file 'doc/COPYING' for copying permission
#

module BeEF
  module Core
    class Logger
      include Singleton

      # Constructor
      def initialize
        @logs = BeEF::Core::Models::Log
        @config = BeEF::Core::Configuration.instance

        # if notifications are enabled create a new instance
        notifications_enabled = @config.get('beef.extension.notifications.enable')
        @notifications = BeEF::Extension::Notifications::Notifications unless notifications_enabled == false or notifications_enabled.nil?
      end

      #
      # Registers a new event in the logs
      # @param [String] from The origin of the event (i.e. Authentication, Hooked Browser)
      # @param [String] event The event description
      # @param [Integer] hb The id of the hooked browser affected (default = 0 if no HB)
      #
      # @return [Boolean] True if the register was successful
      #
      def register(from, event, hb = 0)
        # type conversion to enforce standards
        hb = hb.to_i

        # get time now
        time_now = Time.now

        # arguments type checking
        raise TypeError, "'from' is #{from.class}; expected String" unless from.is_a?(String)
        raise TypeError, "'event' is #{event.class}; expected String" unless event.is_a?(String)
        raise TypeError, "'hb' hooked browser ID is #{hb.class}; expected Integer" unless hb.is_a?(Integer)

        # logging the new event into the database
        @logs.create(logtype: from.to_s, event: event.to_s, date: time_now, hooked_browser_id: hb).save!
        print_debug "Event: #{event}"
        # if notifications are enabled send the info there too
        @notifications.new(from, event, time_now, hb) if @notifications

        true
      end

      @logs
    end
  end
end