debug.cpp File Reference

.debug command More...

#include "pch.h"

Functions
VOID	CommandDebugHelp ()
	help of the .debug command
BOOLEAN	CommandDebugCheckComPort (const CHAR *ComPort, UINT32 *Port)
	Check if COM port is valid or not.
BOOLEAN	CommandDebugCheckBaudrate (DWORD Baudrate)
	Check if baud rate is valid or not.
BOOLEAN	HyperDbgDebugRemoteDeviceUsingComPort (const CHAR *PortName, DWORD Baudrate)
	Connect to a remote serial device (Debugger)
BOOLEAN	HyperDbgDebugRemoteDeviceUsingNamedPipe (const CHAR *NamedPipe)
	Connect to a remote named pipe (Debugger)
BOOLEAN	HyperDbgDebugCurrentDeviceUsingComPort (const CHAR *PortName, DWORD Baudrate)
	Connect to a remote serial device (Debuggee)
VOID	CommandDebug (vector< string > SplitCommand, string Command)
	.debug command handler

Variables
HANDLE	g_SerialListeningThreadHandle
	In debuggee and debugger, we save the handle of the user-mode listening thread for pauses here.
HANDLE	g_SerialRemoteComPortHandle
	In debugger (not debuggee), we save the handle of the user-mode listening thread for remote system here.
BOOLEAN	g_IsSerialConnectedToRemoteDebuggee
	Shows if the debugger was connected to remote debuggee over (A remote guest)
BOOLEAN	g_IsSerialConnectedToRemoteDebugger
	Shows if the debugger was connected to remote debugger (A remote host)
BOOLEAN	g_IsDebuggeeRunning
	Shows if the debuggee is running or not.

Detailed Description

.debug command

Author

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

Version

0.1

Date

2020-12-19

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CommandDebug()

VOID CommandDebug	(	vector< string >	SplitCommand,
		string	Command )

.debug command handler

Parameters

SplitCommand
Command

Returns

VOID

{
    UINT32 Baudrate;
    UINT32 Port;
 
    if (SplitCommand.size() == 2 && !SplitCommand.at(1).compare("close"))
    {
        //
        // Check if the debugger is attached to a debuggee
        //
        if (g_IsSerialConnectedToRemoteDebuggee)
        {
            KdCloseConnection();
        }
        else
        {
            ShowMessages(
                "err, debugger is not attached to any instance of debuggee\n");
        }
        return;
    }
    else if (SplitCommand.size() <= 3)
    {
        ShowMessages("incorrect use of the '.debug'\n\n");
        CommandDebugHelp();
        return;
    }
 
    //
    // Check the main command
    //
    if (!SplitCommand.at(1).compare("remote"))
    {
        //
        // in the case of the 'remote'
        //
 
        if (!SplitCommand.at(2).compare("serial"))
        {
            //
            // Connect to a remote serial device
            //
            if (SplitCommand.size() != 5)
            {
                ShowMessages("incorrect use of the '.debug'\n\n");
                CommandDebugHelp();
                return;
            }
 
            //
            // Set baudrate
            //
            if (!IsNumber(SplitCommand.at(3)))
            {
                //
                // Unknown parameter
                //
                ShowMessages("unknown parameter '%s'\n\n",
                             SplitCommand.at(3).c_str());
                CommandDebugHelp();
                return;
            }
 
            Baudrate = stoi(SplitCommand.at(3));
 
            //
            // Check if baudrate is valid or not
            //
            if (!CommandDebugCheckBaudrate(Baudrate))
            {
                //
                // Baud-rate is invalid
                //
                ShowMessages("err, baud rate is invalid\n\n");
                CommandDebugHelp();
                return;
            }
 
            //
            // check if com port address is valid or not
            //
            if (!CommandDebugCheckComPort(SplitCommand.at(4).c_str(), &Port))
            {
                //
                // com port is invalid
                //
                ShowMessages("err, COM port is invalid\n\n");
                CommandDebugHelp();
                return;
            }
 
            //
            // Everything is okay, connect to the remote machine to send (debugger)
            //
            HyperDbgDebugRemoteDeviceUsingComPort(SplitCommand.at(4).c_str(), Baudrate);
        }
        else if (!SplitCommand.at(2).compare("namedpipe"))
        {
            //
            // Connect to a remote namedpipe
            //
            string Delimiter = "namedpipe";
            string Token     = Command.substr(
                Command.find(Delimiter) + Delimiter.size() + 1,
                Command.size());
 
            //
            // Connect to a namedpipe (it's probably a Virtual Machine debugging)
            //
            HyperDbgDebugRemoteDeviceUsingNamedPipe(Token.c_str());
        }
        else
        {
            //
            // Unknown parameter
            //
            ShowMessages("unknown parameter '%s'\n\n", SplitCommand.at(2).c_str());
            CommandDebugHelp();
            return;
        }
    }
    else if (!SplitCommand.at(1).compare("prepare"))
    {
        if (SplitCommand.size() != 5)
        {
            ShowMessages("incorrect use of the '.debug'\n\n");
            CommandDebugHelp();
            return;
        }
 
        //
        // in the case of the 'prepare'
        // currently we only support serial
        //
        if (!SplitCommand.at(2).compare("serial"))
        {
            //
            // Set baudrate
            //
            if (!IsNumber(SplitCommand.at(3)))
            {
                //
                // Unknown parameter
                //
                ShowMessages("unknown parameter '%s'\n\n",
                             SplitCommand.at(3).c_str());
                CommandDebugHelp();
                return;
            }
 
            Baudrate = stoi(SplitCommand.at(3));
 
            //
            // Check if baudrate is valid or not
            //
            if (!CommandDebugCheckBaudrate(Baudrate))
            {
                //
                // Baud-rate is invalid
                //
                ShowMessages("err, baud rate is invalid\n\n");
                CommandDebugHelp();
                return;
            }
 
            //
            // check if com port address is valid or not
            //
            if (!CommandDebugCheckComPort(SplitCommand.at(4).c_str(), &Port))
            {
                //
                // com port is invalid
                //
                ShowMessages("err, COM port is invalid\n\n");
                CommandDebugHelp();
                return;
            }
 
            //
            // Everything is okay, prepare to send (debuggee)
            //
            HyperDbgDebugCurrentDeviceUsingComPort(SplitCommand.at(4).c_str(), Baudrate);
        }
        else
        {
            ShowMessages("invalid parameter '%s'\n\n", SplitCommand.at(2));
            CommandDebugHelp();
            return;
        }
    }
    else
    {
        ShowMessages("invalid parameter '%s'\n\n", SplitCommand.at(1));
        CommandDebugHelp();
        return;
    }
}

CommandDebugCheckBaudrate()

BOOLEAN CommandDebugCheckBaudrate

(

DWORD

Baudrate

)

Check if baud rate is valid or not.

Parameters

Baudrate

Returns

BOOLEAN

{
    if (Baudrate == CBR_110 || Baudrate == CBR_300 || Baudrate == CBR_600 ||
        Baudrate == CBR_1200 || Baudrate == CBR_2400 || Baudrate == CBR_4800 ||
        Baudrate == CBR_9600 || Baudrate == CBR_14400 || Baudrate == CBR_19200 ||
        Baudrate == CBR_38400 || Baudrate == CBR_56000 || Baudrate == CBR_57600 ||
        Baudrate == CBR_115200 || Baudrate == CBR_128000 ||
        Baudrate == CBR_256000)
    {
        return TRUE;
    }
    return FALSE;
}

CommandDebugCheckComPort()

BOOLEAN CommandDebugCheckComPort	(	const CHAR *	ComPort,
		UINT32 *	Port )

Check if COM port is valid or not.

Parameters

ComPort

Returns

BOOLEAN

{
    if (_stricmp(ComPort, "com1") == 0)
    {
        *Port = COM1_PORT;
        return TRUE;
    }
    else if (_stricmp(ComPort, "com2") == 0)
    {
        *Port = COM2_PORT;
        return TRUE;
    }
    else if (_stricmp(ComPort, "com3") == 0)
    {
        *Port = COM3_PORT;
        return TRUE;
    }
    else if (_stricmp(ComPort, "com4") == 0)
    {
        *Port = COM4_PORT;
        return TRUE;
    }
 
    return FALSE;
}

CommandDebugHelp()

VOID CommandDebugHelp

(

)

help of the .debug command

Returns

VOID

{
    ShowMessages(
        ".debug : debugs a target machine or makes this machine a debuggee.\n\n");
 
    ShowMessages(
        "syntax : \t.debug [remote] [serial|namedpipe] [Baudrate (decimal)] [Address (string)]\n");
    ShowMessages(
        "syntax : \t.debug [prepare] [serial] [Baudrate (decimal)] [Address (string)]\n");
    ShowMessages("syntax : \t.debug [close]\n");
 
    ShowMessages("\n");
    ShowMessages("\t\te.g : .debug remote serial 115200 com2\n");
    ShowMessages("\t\te.g : .debug remote namedpipe \\\\.\\pipe\\HyperDbgPipe\n");
    ShowMessages("\t\te.g : .debug prepare serial 115200 com1\n");
    ShowMessages("\t\te.g : .debug prepare serial 115200 com2\n");
    ShowMessages("\t\te.g : .debug close\n");
 
    ShowMessages(
        "\nvalid baud rates (decimal) : 110, 300, 600, 1200, 2400, 4800, 9600, "
        "14400, 19200, 38400, 56000, 57600, 115200, 128000, 256000\n");
    ShowMessages("valid COM ports : COM1, COM2, COM3, COM4 \n");
}

HyperDbgDebugCurrentDeviceUsingComPort()

BOOLEAN HyperDbgDebugCurrentDeviceUsingComPort	(	const CHAR *	PortName,
		DWORD	Baudrate )

Connect to a remote serial device (Debuggee)

Parameters

PortName
Baudrate

Returns

BOOLEAN

{
    UINT32 Port;
 
    //
    // Check if baudrate is valid or not
    //
    if (!CommandDebugCheckBaudrate(Baudrate))
    {
        //
        // Baud-rate is invalid
        //
        return FALSE;
    }
 
    //
    // check if com port address is valid or not
    //
    if (!CommandDebugCheckComPort(PortName, &Port))
    {
        //
        // com port is invalid
        //
        return FALSE;
    }
 
    //
    // Everything is okay, connect to the remote machine to send (debuggee)
    //
    return KdPrepareAndConnectDebugPort(PortName, Baudrate, Port, TRUE, FALSE);
}

HyperDbgDebugRemoteDeviceUsingComPort()

BOOLEAN HyperDbgDebugRemoteDeviceUsingComPort	(	const CHAR *	PortName,
		DWORD	Baudrate )

Connect to a remote serial device (Debugger)

Parameters

PortName
Baudrate

Returns

BOOLEAN

{
    UINT32 Port;
 
    //
    // Check if baudrate is valid or not
    //
    if (!CommandDebugCheckBaudrate(Baudrate))
    {
        //
        // Baud-rate is invalid
        //
        return FALSE;
    }
 
    //
    // check if com port address is valid or not
    //
    if (!CommandDebugCheckComPort(PortName, &Port))
    {
        //
        // com port is invalid
        //
        return FALSE;
    }
 
    //
    // Everything is okay, connect to the remote machine to send (debugger)
    //
    return KdPrepareAndConnectDebugPort(PortName, Baudrate, Port, FALSE, FALSE);
}

HyperDbgDebugRemoteDeviceUsingNamedPipe()

BOOLEAN HyperDbgDebugRemoteDeviceUsingNamedPipe

(

const CHAR *

NamedPipe

)

Connect to a remote named pipe (Debugger)

Parameters

NamedPipe

Returns

BOOLEAN

{
    return KdPrepareAndConnectDebugPort(NamedPipe, NULL, NULL, FALSE, TRUE);
}

Variable Documentation

g_IsDebuggeeRunning

BOOLEAN g_IsDebuggeeRunning

extern

Shows if the debuggee is running or not.

g_IsSerialConnectedToRemoteDebuggee

BOOLEAN g_IsSerialConnectedToRemoteDebuggee

extern

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

g_IsSerialConnectedToRemoteDebugger

BOOLEAN g_IsSerialConnectedToRemoteDebugger

extern

Shows if the debugger was connected to remote debugger (A remote host)

g_SerialListeningThreadHandle

HANDLE g_SerialListeningThreadHandle

extern

In debuggee and debugger, we save the handle of the user-mode listening thread for pauses here.

g_SerialRemoteComPortHandle

HANDLE g_SerialRemoteComPortHandle

extern

In debugger (not debuggee), we save the handle of the user-mode listening thread for remote system here.