HyperDbg/hyperdbg/hprdbgctrl/msrread.cpp

/**
 * @file msrread.cpp
 * @author Sina Karvandi (sina@rayanfam.com)
 * @brief !msrread command
 * @details
 * @version 0.1
 * @date 2020-06-01
 *
 * @copyright This project is released under the GNU Public License v3.
 *
 */
#include "pch.h"

/**
 * @brief help of !msrread command
 *
 * @return VOID
 */
VOID CommandMsrreadHelp() {
  ShowMessages("!msrread : Detects the execution of rdmsr instructions.\n\n");
  ShowMessages("syntax : \t!msrread [msr (hex value) - if not specific means "
               "all msrs] core [core index (hex value)] pid [process id (hex "
               "value)] condition {[assembly "
               "in hex]} code {[assembly in hex]} buffer [pre-require buffer - "
               "(hex value)] \n");

  ShowMessages("\t\te.g : !msrread\n");
  ShowMessages("\t\te.g : !msrread 0xc0000082\n");
  ShowMessages("\t\te.g : !msread pid 400\n");
  ShowMessages("\t\te.g : !msrread core 2 pid 400\n");
}

/**
 * @brief !msrread command handler
 *
 * @param SplittedCommand
 * @return VOID
 */
VOID CommandMsrread(vector<string> SplittedCommand) {

  PDEBUGGER_GENERAL_EVENT_DETAIL Event = NULL;
  PDEBUGGER_GENERAL_ACTION ActionBreakToDebugger = NULL;
  PDEBUGGER_GENERAL_ACTION ActionCustomCode = NULL;
  PDEBUGGER_GENERAL_ACTION ActionScript = NULL;
  UINT32 EventLength;
  UINT32 ActionBreakToDebuggerLength = 0;
  UINT32 ActionCustomCodeLength = 0;
  UINT32 ActionScriptLength = 0;
  UINT64 SpecialTarget = DEBUGGER_EVENT_MSR_READ_OR_WRITE_ALL_MSRS;
  BOOLEAN GetAddress = FALSE;

  //
  // Interpret and fill the general event and action fields
  //
  //
  if (!InterpretGeneralEventAndActionsFields(
          &SplittedCommand, RDMSR_INSTRUCTION_EXECUTION, &Event, &EventLength,
          &ActionBreakToDebugger, &ActionBreakToDebuggerLength,
          &ActionCustomCode, &ActionCustomCodeLength, &ActionScript,
          &ActionScriptLength)) {
    CommandMsrreadHelp();
    return;
  }

  //
  // Interpret command specific details (if any), it is because we can use
  // special msr bitmap here
  //
  for (auto Section : SplittedCommand) {
    if (!Section.compare("!msrread")) {
      continue;
    } else if (!GetAddress) {

      //
      // It's probably an msr
      //
      if (!ConvertStringToUInt64(Section, &SpecialTarget)) {
        //
        // Unkonwn parameter
        //
        ShowMessages("Unknown parameter '%s'\n\n", Section.c_str());
        CommandMsrreadHelp();
        return;
      } else {
        GetAddress = TRUE;
      }
    } else {
      //
      // Unkonwn parameter
      //
      ShowMessages("Unknown parameter '%s'\n\n", Section.c_str());
      CommandMsrreadHelp();
      return;
    }
  }

  //
  // Set the target msr (if not specific then it means all msrs)
  //
  Event->OptionalParam1 = SpecialTarget;

  //
  // Send the ioctl to the kernel for event registeration
  //
  if (!SendEventToKernel(Event, EventLength)) {

    //
    // There was an error, probably the handle was not initialized
    // we have to free the Action before exit, it is because, we
    // already freed the Event and string buffers
    //
    if (ActionBreakToDebugger != NULL) {
      free(ActionBreakToDebugger);
    }
    if (ActionCustomCode != NULL) {
      free(ActionCustomCode);
    }
    if (ActionScript != NULL) {
      free(ActionScript);
    }
    return;
  }

  //
  // Add the event to the kernel
  //
  if (!RegisterActionToEvent(ActionBreakToDebugger, ActionBreakToDebuggerLength,
                             ActionCustomCode, ActionCustomCodeLength,
                             ActionScript, ActionScriptLength)) {
    //
    // There was an error
    //
    return;
  }
}