MinHook.hpp

/*
 *  MinHook - The Minimalistic API Hooking Library for x64/x86
 *  Copyright (C) 2009-2017 Tsuda Kageyu.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 *  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
 *  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#pragma once

#if !(defined _M_IX86) && !(defined _M_X64) && !(defined __i386__) && !(defined __x86_64__)
    #error MinHook supports only x86 and x64 systems.
#endif

#include <windows.h>
#include <string>
#include <cstdint>

// Can be passed as a parameter to MH_EnableHook, MH_DisableHook,
// MH_QueueEnableHook or MH_QueueDisableHook.
#define MH_ALL_HOOKS NULL

//#define MH_DLL_EXPORT // If you're building into a library file.
//#define MH_DLL_IMPORT // If you're using an already built library file in your project.
#define MH_DLL_USE      // If you're building and using the entire source in your project.

#ifdef MH_DLL_EXPORT
    #define MH_DECLARE _declspec(dllexport)
#elif defined(MH_DLL_IMPORT)
    #define MH_DECLARE _declspec(dllimport)
#else defined(MH_DLL_USE)
    #define MH_DECLARE
#endif

namespace MinHook
{
    // MinHook Error Codes.
    enum class MH_STATUS : int32_t
    {
        // Unknown error. Should not be returned.
        MH_UNKNOWN = -1,

        // Successful.
        MH_OK = 0,

        // MinHook is already initialized.
        MH_ERROR_ALREADY_INITIALIZED,

        // MinHook is not initialized yet, or already uninitialized.
        MH_ERROR_NOT_INITIALIZED,

        // The hook for the specified target function is already created.
        MH_ERROR_ALREADY_CREATED,

        // The hook for the specified target function is not created yet.
        MH_ERROR_NOT_CREATED,

        // The hook for the specified target function is already enabled.
        MH_ERROR_ENABLED,

        // The hook for the specified target function is not enabled yet, or already disabled.
        MH_ERROR_DISABLED,

        // The specified pointer is invalid. It points the address of non-allocated and/or non-executable region.
        MH_ERROR_NOT_EXECUTABLE,

        // F_ERROR flags where set while trying to disasemble the given function.
        MH_ERROR_TRAMP_DISASM,

        // LOOPNZ/LOOPZ/LOOP/JCXZ/JECXZ to the outside are not supported for the given function.
        MH_ERROR_TRAMP_NO_JUMP,

        // Can't alter the instruction length in a branch.
        MH_ERROR_TRAMP_LENGTH,

        // Trampoline function is too large.
        MH_ERROR_TRAMP_TOO_BIG,

        // Trampoline function has too many instructions.
        MH_ERROR_TRAMP_TOO_MANY,

        // Trampoline function doesn't have enough space for a short jump.
        MH_ERROR_TRAMP_NO_SHORT,

        // Trampoline function doesn't have enough space for a long jump.
        MH_ERROR_TRAMP_NO_LONG,

        // Trampoline function doesn't have enough space for code padding.
        MH_ERROR_TRAMP_NO_PADDING,

        // Failed to allocate memory.
        MH_ERROR_MEMORY_ALLOC,

        // Failed to change the memory protection.
        MH_ERROR_MEMORY_PROTECT,

        // The specified module is not loaded.
        MH_ERROR_MODULE_NOT_FOUND,

        // The specified function is not found.
        MH_ERROR_FUNCTION_NOT_FOUND
    };

    // Initialize the MinHook library. You must call this function EXACTLY ONCE
    // at the beginning of your program.
    MH_DECLARE MH_STATUS WINAPI MH_Initialize(void);

    // Uninitialize the MinHook library. You must call this function EXACTLY
    // ONCE at the end of your program.
    MH_DECLARE MH_STATUS WINAPI MH_Uninitialize(void);

    // Creates a hook for the specified target function, in disabled state.
    // Parameters:
    //   pTarget     [in]  A pointer to the target function, which will be
    //                     overridden by the detour function.
    //   pDetour     [in]  A pointer to the detour function, which will override
    //                     the target function.
    //   ppOriginal  [out] A pointer to the trampoline function, which will be
    //                     used to call the original target function.
    //                     This parameter can be NULL.
    MH_DECLARE MH_STATUS WINAPI MH_CreateHook(LPVOID pTarget, LPVOID pDetour, LPVOID* ppOriginal);

    // Creates a hook for the specified API function, in disabled state.
    // Parameters:
    //   pszModule   [in]  A pointer to the loaded module name which contains the
    //                     target function.
    //   pszProcName [in]  A pointer to the target function name, which will be
    //                     overridden by the detour function.
    //   pDetour     [in]  A pointer to the detour function, which will override
    //                     the target function.
    //   ppOriginal  [out] A pointer to the trampoline function, which will be
    //                     used to call the original target function.
    //                     This parameter can be NULL.
    MH_DECLARE MH_STATUS WINAPI MH_CreateHookApi(LPCWSTR pszModule, LPCSTR pszProcName, LPVOID pDetour, LPVOID* ppOriginal);

    // Creates a hook for the specified API function, in disabled state.
    // Parameters:
    //   pszModule   [in]  A pointer to the loaded module name which contains the
    //                     target function.
    //   pszProcName [in]  A pointer to the target function name, which will be
    //                     overridden by the detour function.
    //   pDetour     [in]  A pointer to the detour function, which will override
    //                     the target function.
    //   ppOriginal  [out] A pointer to the trampoline function, which will be
    //                     used to call the original target function.
    //                     This parameter can be NULL.
    //   ppTarget    [out] A pointer to the target function, which will be used
    //                     with other functions.
    //                     This parameter can be NULL.
    MH_DECLARE MH_STATUS WINAPI MH_CreateHookApiEx(LPCWSTR pszModule, LPCSTR pszProcName, LPVOID pDetour, LPVOID* ppOriginal, LPVOID* ppTarget);

    // Removes an already created hook.
    // Parameters:
    //   pTarget [in] A pointer to the target function.
    MH_DECLARE MH_STATUS WINAPI MH_RemoveHook(LPVOID pTarget);

    // Enables an already created hook.
    // Parameters:
    //   pTarget [in] A pointer to the target function.
    //                If this parameter is MH_DLL_IMPORT, all created hooks are
    //                enabled in one go.
    MH_DECLARE MH_STATUS WINAPI MH_EnableHook(LPVOID pTarget);

    // Disables an already created hook.
    // Parameters:
    //   pTarget [in] A pointer to the target function.
    //                If this parameter is MH_DLL_IMPORT, all created hooks are
    //                disabled in one go.
    MH_DECLARE MH_STATUS WINAPI MH_DisableHook(LPVOID pTarget);

    // Queues to enable an already created hook.
    // Parameters:
    //   pTarget [in] A pointer to the target function.
    //                If this parameter is MH_DLL_IMPORT, all created hooks are
    //                queued to be enabled.
    MH_DECLARE MH_STATUS WINAPI MH_QueueEnableHook(LPVOID pTarget);

    // Queues to disable an already created hook.
    // Parameters:
    //   pTarget [in] A pointer to the target function.
    //                If this parameter is MH_DLL_IMPORT, all created hooks are
    //                queued to be disabled.
    MH_DECLARE MH_STATUS WINAPI MH_QueueDisableHook(LPVOID pTarget);

    // Applies all queued changes in one go.
    MH_DECLARE MH_STATUS WINAPI MH_ApplyQueued(void);

    // Translates the MH_STATUS to its name as a string.
    MH_DECLARE std::string WINAPI MH_StatusToString(MH_STATUS status);
}