test.cpp File Reference

test command More...

#include "pch.h"

Functions
VOID	CommandTestHelp ()
	help of the test command
BOOLEAN	CommandTestPerformKernelTestsIoctl ()
	Send an IOCTL to the kernel to run the.
VOID	CommandTestAllFunctionalities ()
	perform test on for all functionalities
VOID	CommandTestAllHwdbg ()
	perform test for all functionalities of hwdbg
BOOLEAN	CommandTestPerformTest ()
	perform test on the remote process
VOID	CommandTestQueryState ()
	test command for query the state
VOID	CommandTestQueryTrapState ()
	test command for query the trap state
VOID	CommandTestQueryPreAllocPoolsState ()
	test command for query the state of pre-allocated pools
VOID	CommandTestSetTargetTaskToHaltedCores (BOOLEAN Synchronous)
	test command for setting target tasks to halted cores
VOID	CommandTestSetTargetTaskToTargetCore (UINT32 CoreNumber)
	test command for setting target task to the specified core
VOID	CommandTestSetBreakpointState (BOOLEAN State)
	test command for turning on/off the breakpoints (#DB)
VOID	CommandTestSetDebugBreakState (BOOLEAN State)
	test command for turning on/off the debug breaks (#DB)
VOID	CommandTest (vector< CommandToken > CommandTokens, string Command)
	test command handler

Variables
BOOLEAN	g_IsKdModuleLoaded
	shows whether the kernel debugger (KD) module is loaded or not
BOOLEAN	g_IsSerialConnectedToRemoteDebuggee
	Shows if the debugger was connected to remote debuggee over (A remote guest).

Detailed Description

test command

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.1

Date

2020-06-11

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CommandTest()

VOID CommandTest	(	vector< CommandToken >	CommandTokens,
		string	Command )

test command handler

Parameters

CommandTokens
Command

Returns

VOID

{
    UINT64 Context = NULL;
 
    UINT32 CommandSize = (UINT32)CommandTokens.size();
 
    if (CommandSize == 1)
    {
        ShowMessages("incorrect use of the '%s'\n\n",
                     GetCaseSensitiveStringFromCommandToken(CommandTokens.at(0)).c_str());
        CommandTestHelp();
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "query"))
    {
        //
        // Query the state of debuggee in debugger mode
        //
        CommandTestQueryState();
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "trap-status"))
    {
        //
        // Query the state of trap flag in debugger mode
        //
        CommandTestQueryTrapState();
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "pool"))
    {
        //
        // Query the state of pre-allocated pools in debugger mode
        //
        CommandTestQueryPreAllocPoolsState();
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "sync-task"))
    {
        //
        // Send target task to the halted cores in debugger mode (synchronous)
        //
        CommandTestSetTargetTaskToHaltedCores(TRUE);
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "async-task"))
    {
        //
        // Send target task to the halted cores in debugger mode (asynchronous)
        //
        CommandTestSetTargetTaskToHaltedCores(FALSE);
    }
    else if (CommandSize == 3 && CompareLowerCaseStrings(CommandTokens.at(1), "target-core-task"))
    {
        if (!ConvertTokenToUInt64(CommandTokens.at(2), &Context))
        {
            ShowMessages("err, you should enter a valid hex number as the core id\n\n");
            return;
        }
 
        //
        // Send target task to the specific halted core in debugger mode
        //
        CommandTestSetTargetTaskToTargetCore((UINT32)Context);
    }
    else if (CommandSize == 3 && CompareLowerCaseStrings(CommandTokens.at(1), "breakpoint"))
    {
        //
        // Change breakpoint state
        //
        if (CompareLowerCaseStrings(CommandTokens.at(2), "on"))
        {
            CommandTestSetBreakpointState(TRUE);
        }
        else if (CompareLowerCaseStrings(CommandTokens.at(2), "off"))
        {
            CommandTestSetBreakpointState(FALSE);
        }
        else
        {
            ShowMessages("err, couldn't resolve error at '%s'\n\n",
                         GetCaseSensitiveStringFromCommandToken(CommandTokens.at(2)).c_str());
            return;
        }
    }
    else if (CommandSize == 3 && CompareLowerCaseStrings(CommandTokens.at(1), "trap"))
    {
        //
        // Change debug break state
        //
        if (CompareLowerCaseStrings(CommandTokens.at(2), "on"))
        {
            CommandTestSetDebugBreakState(TRUE);
        }
        else if (CompareLowerCaseStrings(CommandTokens.at(2), "off"))
        {
            CommandTestSetDebugBreakState(FALSE);
        }
        else
        {
            ShowMessages("err, couldn't resolve error at '%s'\n\n",
                         GetCaseSensitiveStringFromCommandToken(CommandTokens.at(2)).c_str());
            return;
        }
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "all"))
    {
        //
        // For testing functionalities
        //
        CommandTestAllFunctionalities();
    }
    else if (CommandSize == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "hwdbg"))
    {
        //
        // For testing functionalities of hwdbg
        //
        CommandTestAllHwdbg();
    }
    else
    {
        ShowMessages("incorrect use of the '%s'\n\n",
                     GetCaseSensitiveStringFromCommandToken(CommandTokens.at(0)).c_str());
        CommandTestHelp();
        return;
    }
}

CommandTestAllFunctionalities()

VOID CommandTestAllFunctionalities

(

)

perform test on for all functionalities

Returns

VOID

{
    HANDLE ThreadHandle;
    HANDLE ProcessHandle;
 
    //
    // Test command parser
    //
    if (!OpenHyperDbgTestProcess(&ThreadHandle, &ProcessHandle, (CHAR *)TEST_CASE_PARAMETER_FOR_MAIN_COMMAND_PARSER))
    {
        ShowMessages("err, start HyperDbg test process for testing the main command parser\n");
        return;
    }
 
    //
    // Test PE parser helpers
    //
    if (!OpenHyperDbgTestProcess(&ThreadHandle, &ProcessHandle, (CHAR *)TEST_CASE_PARAMETER_FOR_PE_PARSER))
    {
        ShowMessages("err, start HyperDbg test process for testing the PE parser\n");
        return;
    }
 
    //
    // Test CodeView RSDS parser helpers
    //
    if (!OpenHyperDbgTestProcess(&ThreadHandle, &ProcessHandle, (CHAR *)TEST_CASE_PARAMETER_FOR_CODEVIEW_RSDS_PARSER))
    {
        ShowMessages("err, start HyperDbg test process for testing the CodeView RSDS parser\n");
        return;
    }
 
    //
    // Test script engine (script parser) using semantic tests
    //
    if (!OpenHyperDbgTestProcess(&ThreadHandle, &ProcessHandle, (CHAR *)TEST_CASE_PARAMETER_FOR_SCRIPT_SEMANTIC_TEST_CASES))
    {
        ShowMessages("err, start HyperDbg test process for testing semantic tests\n");
        return;
    }
}

CommandTestAllHwdbg()

VOID CommandTestAllHwdbg

(

)

perform test for all functionalities of hwdbg

Returns

VOID

{
    HANDLE ThreadHandle;
    HANDLE ProcessHandle;
 
    //
    // Test hwdbg functionalities
    //
    if (!OpenHyperDbgTestProcess(&ThreadHandle, &ProcessHandle, (CHAR *)TEST_HWDBG_FUNCTIONALITIES))
    {
        ShowMessages("err, start HyperDbg test process for testing hwdbg functionalities\n");
        return;
    }
}

CommandTestHelp()

VOID CommandTestHelp

(

)

help of the test command

Returns

VOID

{
    ShowMessages(
        "test : tests essential features of HyperDbg in current machine.\n");
 
    ShowMessages("syntax : \ttest [Task (string)]\n");
 
    ShowMessages("\n");
    ShowMessages("\t\te.g : test query\n");
    ShowMessages("\t\te.g : test trap-status\n");
    ShowMessages("\t\te.g : test pool\n");
    ShowMessages("\t\te.g : test query\n");
    ShowMessages("\t\te.g : test breakpoint on\n");
    ShowMessages("\t\te.g : test breakpoint off\n");
    ShowMessages("\t\te.g : test trap on\n");
    ShowMessages("\t\te.g : test trap off\n");
}

CommandTestPerformKernelTestsIoctl()

BOOLEAN CommandTestPerformKernelTestsIoctl

(

)

Send an IOCTL to the kernel to run the.

Returns

BOOLEAN

{
    BOOL                          Status;
    ULONG                         ReturnedLength;
    DEBUGGER_PERFORM_KERNEL_TESTS KernelTestRequest = {0};
 
    AssertShowMessageReturnStmt(g_IsKdModuleLoaded, g_DeviceHandle, ASSERT_MESSAGE_KD_NOT_LOADED, ASSERT_MESSAGE_DRIVER_NOT_LOADED, AssertReturnFalse);
 
    //
    // By the way, we don't need to send an input buffer
    // to the kernel, but let's keep it like this, if we
    // want to pass some other arguments to the kernel in
    // the future
    //
    Status = DeviceIoControl(
        g_DeviceHandle,                       // Handle to device
        IOCTL_PERFORM_KERNEL_SIDE_TESTS,      // IO Control Code (IOCTL)
        &KernelTestRequest,                   // Input Buffer to driver.
        SIZEOF_DEBUGGER_PERFORM_KERNEL_TESTS, // Input buffer length
        &KernelTestRequest,                   // Output Buffer from driver.
        SIZEOF_DEBUGGER_PERFORM_KERNEL_TESTS, // Length of output buffer in
                                              // bytes.
        &ReturnedLength,                      // Bytes placed in buffer.
        NULL                                  // synchronous call
    );
 
    if (!Status)
    {
        ShowMessages("ioctl failed with code 0x%x\n", GetLastError());
        return FALSE;
    }
 
    if (KernelTestRequest.KernelStatus == DEBUGGER_OPERATION_WAS_SUCCESSFUL)
    {
        //
        // Nothing to show
        //
        return TRUE;
    }
    else
    {
        //
        // Show err message
        //
        ShowErrorMessage(KernelTestRequest.KernelStatus);
        return FALSE;
    }
}

CommandTestPerformTest()

BOOLEAN CommandTestPerformTest

(

)

perform test on the remote process

Returns

BOOLEAN returns true if the results was true and false if the results was not ok

{
    BOOLEAN ResultOfTest = FALSE;
    HANDLE  PipeHandle;
    HANDLE  ThreadHandle;
    HANDLE  ProcessHandle;
    UINT32  ReadBytes;
    CHAR *  Buffer = NULL;
 
    //
    // Allocate memory
    //
    Buffer = (CHAR *)malloc(TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE);
 
    if (!Buffer)
    {
        ShowMessages("err, enable allocate communication buffer\n");
        return FALSE;
    }
 
    RtlZeroMemory(Buffer, TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE);
 
    //
    // Create tests process to create a thread for us
    //
    if (!CreateProcessAndOpenPipeConnection(&PipeHandle,
                                            &ThreadHandle,
                                            &ProcessHandle))
    {
        ShowMessages("err, enable to connect to the test process\n");
 
        free(Buffer);
 
        return FALSE;
    }
 
    //
    // ***** Perform test specific routines *****
    //
 
    //
    // Wait for the result of test to be received
    //
 
SendCommandAndWaitForResponse:
 
    CHAR TestCommand[] = "this is a test command";
 
    BOOLEAN SentMessageResult = NamedPipeServerSendMessageToClient(
        PipeHandle,
        TestCommand,
        (UINT32)strlen(TestCommand) + 1);
 
    if (!SentMessageResult)
    {
        //
        // error in sending
        //
        return FALSE;
    }
 
    RtlZeroMemory(Buffer, TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE);
    ReadBytes =
        NamedPipeServerReadClientMessage(PipeHandle, (CHAR *)Buffer, TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE);
 
    if (!ReadBytes)
    {
        //
        // Nothing to read
        //
        free(Buffer);
 
        return FALSE;
    }
 
    goto SendCommandAndWaitForResponse;
 
    //
    // Close connection and remote process
    //
    CloseProcessAndClosePipeConnection(PipeHandle, ThreadHandle, ProcessHandle);
 
    free(Buffer);
 
    return ResultOfTest;
}

CommandTestQueryPreAllocPoolsState()

VOID CommandTestQueryPreAllocPoolsState

(

)

test command for query the state of pre-allocated pools

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the query to the debuggee
    //
    KdSendTestQueryPacketToDebuggee(TEST_QUERY_PREALLOCATED_POOL_STATE);
}

CommandTestQueryState()

VOID CommandTestQueryState

(

)

test command for query the state

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the query to the debuggee
    //
    KdSendTestQueryPacketToDebuggee(TEST_QUERY_HALTING_CORE_STATUS);
}

CommandTestQueryTrapState()

VOID CommandTestQueryTrapState

(

)

test command for query the trap state

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the query to the debuggee
    //
    KdSendTestQueryPacketToDebuggee(TEST_QUERY_TRAP_STATE);
}

CommandTestSetBreakpointState()

VOID CommandTestSetBreakpointState

(

BOOLEAN

State

)

test command for turning on/off the breakpoints (#DB)

Parameters

State

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the breakpoint settings to the debuggee
    //
    if (State)
    {
        KdSendTestQueryPacketToDebuggee(TEST_BREAKPOINT_TURN_ON_BPS);
    }
    else
    {
        KdSendTestQueryPacketToDebuggee(TEST_BREAKPOINT_TURN_OFF_BPS);
    }
}

CommandTestSetDebugBreakState()

VOID CommandTestSetDebugBreakState

(

BOOLEAN

State

)

test command for turning on/off the debug breaks (#DB)

Parameters

State

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the debug break settings to the debuggee
    //
    if (State)
    {
        KdSendTestQueryPacketToDebuggee(TEST_BREAKPOINT_TURN_ON_DBS);
    }
    else
    {
        KdSendTestQueryPacketToDebuggee(TEST_BREAKPOINT_TURN_OFF_DBS);
    }
}

CommandTestSetTargetTaskToHaltedCores()

VOID CommandTestSetTargetTaskToHaltedCores

(

BOOLEAN

Synchronous

)

test command for setting target tasks to halted cores

Parameters

Synchronous

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the target tasks to the halted cores
    //
    KdSendTestQueryPacketToDebuggee(Synchronous ? TEST_SETTING_TARGET_TASKS_ON_HALTED_CORES_SYNCHRONOUS : TEST_SETTING_TARGET_TASKS_ON_HALTED_CORES_ASYNCHRONOUS);
}

CommandTestSetTargetTaskToTargetCore()

VOID CommandTestSetTargetTaskToTargetCore

(

UINT32

CoreNumber

)

test command for setting target task to the specified core

Parameters

CoreNumber

Returns

VOID

{
    if (!g_IsSerialConnectedToRemoteDebuggee)
    {
        ShowMessages("err, query state of the debuggee is only possible when you connected "
                     "in debugger mode\n");
        return;
    }
 
    //
    // Send the target task to the target halted core
    //
    KdSendTestQueryPacketWithContextToDebuggee(TEST_SETTING_TARGET_TASKS_ON_TARGET_HALTED_CORES, (UINT64)CoreNumber);
}

Variable Documentation

g_IsKdModuleLoaded

BOOLEAN g_IsKdModuleLoaded

extern

shows whether the kernel debugger (KD) module is loaded or not

g_IsSerialConnectedToRemoteDebuggee

BOOLEAN g_IsSerialConnectedToRemoteDebuggee

extern

Shows if the debugger was connected to remote debuggee over (A remote guest).