HyperDbg/hyperdbg/libhyperdbg/code/debugger/commands/meta-commands/script.cpp

/**
 * @file script.cpp
 * @author Sina Karvandi (sina@hyperdbg.org)
 * @brief .script command
 * @details
 * @version 0.1
 * @date 2020-07-03
 *
 * @copyright This project is released under the GNU Public License v3.
 *
 */
#include "pch.h"

using namespace std;

//
// Global Variables
//
extern BOOLEAN g_ExecutingScript;

/**
 * @brief help of the .script command
 *
 * @return VOID
 */
VOID
CommandScriptHelp()
{
    ShowMessages(".script : runs a HyperDbg script.\n\n");

    ShowMessages("syntax : .script [FilePath (string)] [Args (string)]\n");

    ShowMessages("\n");
    ShowMessages("\t\te.g : .script C:\\scripts\\script.ds\n");
    ShowMessages("\t\te.g : .script C:\\scripts\\script.ds 95 85 @rsp\n");
    ShowMessages("\t\te.g : .script \"C:\\scripts\\hello world.ds\"\n");
    ShowMessages("\t\te.g : .script \"C:\\scripts\\hello world.ds\" @rax\n");
    ShowMessages("\t\te.g : .script \"C:\\scripts\\hello world.ds\" @rax @rcx+55 $pid\n");
    ShowMessages("\t\te.g : .script \"C:\\scripts\\hello world.ds\" 12 55 @rip\n");
}

/**
 * @brief Run the command
 *
 * @return VOID
 */
VOID
CommandScriptRunCommand(std::string Input, vector<string> PathAndArgs)
{
    INT    CommandExecutionResult = 0;
    CHAR * LineContent            = NULL;
    INT    i                      = 0;

    //
    // Replace the $arg*s
    // This is not a good approach to replace between strings,
    // but we let it work this way and in the future versions
    // we'll integrate the command parsing in the debugger with
    // the script engine's command parser
    //
    for (auto item : PathAndArgs)
    {
        string ToReplace = "$arg" + std::to_string(i);
        i++;

        ReplaceAll(Input, ToReplace, item);
    }

    //
    // Convert script to char*
    //
    LineContent = (CHAR *)Input.c_str();

    if (IsEmptyString(LineContent))
    {
        return;
    }

    //
    // Show current running command
    //
    HyperDbgShowSignature();

    ShowMessages("%s\n", LineContent);

    CommandExecutionResult = HyperDbgInterpreter(LineContent);

    ShowMessages("\n");

    //
    // if the debugger encounters an exit state then the return will be 1
    //
    if (CommandExecutionResult == 1)
    {
        //
        // Exit from the debugger
        //
        exit(0);
    }
}

/**
 * @brief Read file and run the script
 *
 * @return VOID
 */
VOID
HyperDbgScriptReadFileAndExecuteCommand(std::vector<std::string> & PathAndArgs)
{
    std::string Line;
    BOOLEAN     IsOpened         = FALSE;
    BOOLEAN     Reset            = FALSE;
    string      CommandToExecute = "";
    string      PathOfScriptFile = "";

    //
    // Parse the script file,
    // the first argument is the path
    //
    PathOfScriptFile = PathAndArgs.at(0);
    ReplaceAll(PathOfScriptFile, "\"", "");

    ifstream File(PathOfScriptFile);

    if (File.is_open())
    {
        IsOpened = TRUE;

        //
        // Indicate that it's a script
        //
        g_ExecutingScript = TRUE;

        //
        // Reset multiline command
        //
        Reset = TRUE;

        while (std::getline(File, Line))
        {
            //
            // Check for multiline commands
            //
            if (CheckMultilineCommand((char *)Line.c_str(), Reset))
            {
                //
                // if the reset is true, we should make the saving buffer empty
                //
                if (Reset)
                {
                    CommandToExecute.clear();
                }

                //
                // The command is expected to be continued
                //
                Reset = FALSE;

                //
                // Append to the previous command
                //
                CommandToExecute += Line + "\n";

                continue;
            }
            else
            {
                //
                // Reset for the next commands round
                //
                Reset = TRUE;

                //
                // Append this line too
                //
                CommandToExecute += Line;
            }

            //
            // Run the command
            //
            CommandScriptRunCommand(CommandToExecute, PathAndArgs);

            //
            // Clear the command
            //
            CommandToExecute.clear();
        }

        //
        // Check for some probably not ended commands
        //
        if (!CommandToExecute.empty())
        {
            CommandScriptRunCommand(CommandToExecute, PathAndArgs);

            //
            // Clear the command
            //
            CommandToExecute.clear();
        }

        //
        // Indicate that script is finished
        //
        g_ExecutingScript = FALSE;

        File.close();
    }

    if (!IsOpened)
    {
        ShowMessages("err, invalid file specified for the script\n");
    }
}

/**
 * @brief Parsing the command line options for scripts
 * @param argc
 * @param argv
 *
 * @return INT
 */
INT
HyperDbgScriptReadFileAndExecuteCommandline(INT argc, CHAR * argv[])
{
    vector<string> Args;

    //
    // Convert it to the array
    //
    for (SIZE_T i = 2; i < argc; i++)
    {
        std::string TempStr(argv[i]);
        Args.push_back(TempStr);
    }

    //
    // Check if the target path and args for script is not empty
    //
    if (!Args.empty())
    {
        HyperDbgScriptReadFileAndExecuteCommand(Args);
        printf("\n");
    }
    else
    {
        printf("err, invalid command line options passed to the HyperDbg!\n");
        return FALSE;
    }

    return TRUE;
}

/**
 * @brief .script command handler
 *
 * @param CommandTokens
 * @param Command
 * @return VOID
 */
VOID
CommandScript(vector<CommandToken> CommandTokens, string Command)
{
    vector<string> PathAndArgs;
    BOOLEAN        IsFirstCommand = FALSE;

    if (CommandTokens.size() == 1)
    {
        ShowMessages("please specify a file\n\n");
        CommandScriptHelp();
        return;
    }

    for (auto Section : CommandTokens)
    {
        if (!IsFirstCommand)
        {
            IsFirstCommand = TRUE;
            continue;
        }

        //
        // Add the path and the arguments
        //
        PathAndArgs.push_back(GetCaseSensitiveStringFromCommandToken(Section));
    }

    //
    // Parse the file and the possible arguments
    //
    HyperDbgScriptReadFileAndExecuteCommand(PathAndArgs);
}