Click here to Skip to main content
Click here to Skip to main content

Easy way to set up global API hooks

By , , 19 Mar 2012
 

Contents

1.      Introduction
1.1.       What is API hooking?
1.2.       Local and global hooks
2.      AppInit_DLLs infrastructure
3.      Mhook library
4.      Writing the code
4.1.       Original function
4.2.       Hooked function
4.3.       Setting the hook
4.4.       Unhooking
5.      Running a sample
6.      Limitations
7.      Useful references

1. Introduction

This article describes an easy way to set up system-wide global API hooks. It uses AppInit_DLLs registry key for DLL injection and Mhook library for API hooking. To illustrate this technique we will show how to easily hide calc.exe from the list of running processes.

1.1 What is API hooking?

API hooking means intercepting some API function calls. By means of it you can alter the behavior of any software. Hooks are widely used by antiviruses, security applications, system utilities, programming tools etc.

1.2 Local and global hooks

There are two types of hooks: local and global ones. Local hooks are applied only to the specific application. Global hooks are applied to all processes in the system. The hook technique, which is shown in this article, is global and impacts on all processes in all sessions (in contrast to the SetWindowsHooks way that is bounded to the specific desktop).

2. AppInit_DLLs infrastructure

AppInit_DLLs infrastructure is a mechanism for loading an arbitrary list of DLLs in all user-mode processes which are linked with User32.dll  (Actually, there are very few executables that are not linked with it). The DLLs are loaded by User32.dll on its initialization.

The behavior of the AppInit_DLLs infrastructure is configured by a set of values that are stored under the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT \CurrentVersion\Windows key in the registry. These registry values are described in the table:

Value Description Sample values
LoadAppInit_DLLs
(REG_DWORD)
Value that globally enables or disables AppInit_DLLs. 0x0 – AppInit_DLLs are disabled.
0x1 – AppInit_DLLs are enabled.

AppInit_DLLs
(REG_SZ)

Space - or comma -separated list of DLLs to load. The complete path to the DLL should be specified using short file names. C:\PROGRA~1\Test\Test.dll
RequireSignedAppInit_DLLs
(REG_DWORD)
Require code-signed DLLs. 0x0 – Load any DLLs.
0x1 – Load only code-signed DLLs.

Table 1 - AppInit_DLLs Infrastructure registry values.

3. Mhook library

There are several libraries for api hooking. The typical things that they do are:

  1. Overwriting the beginning of the target function with custom code (so-called trampoline). When the function executes it will jump to the hook handler.
  2. Storing overwritten original code of the target function somewhere. It is needed for the correct target function functioning.
  3. Restoring overwritten portion of the target function.

Mhook is a free open source library for api hooking. It supports both x86 and x64 platforms and it is very easy in use. Mhook interface is simple and quite self describing:

  BOOL  Mhook_SetHook(PVOID *ppSystemFunction, PVOID pHookFunction);
  BOOL  Mhook_Unhook(PVOID *ppHookedFunction);
For more info on library usage see the code sample shown in the next paragraph or visit Mhook home page.

4. Writing the code

We aregoing to write a user-mode DLL. First you should download the latest Mhook sources and add it to the project. If you are using precompiled headers turn it off for Mhook files.

As I’ve mentioned above our example will hide the calc.exe from the list of running processes.

4.1 Original function

The list of running processes is queried by calling NTAPI function NtQuerySystemInformation. So, we need to add some NTAPI stuff to our project. Unfortunately winternl.h header doesn’t contain full information and we have to define required data types ourselves:

/////////////////////////////////////////////////////////////////////////
// Defines and typedefs

#define STATUS_SUCCESS  ((NTSTATUS)0x00000000L)

typedef struct _MY_SYSTEM_PROCESS_INFORMATION 
{
    ULONG                   NextEntryOffset;
    ULONG                   NumberOfThreads;
    LARGE_INTEGER           Reserved[3];
    LARGE_INTEGER           CreateTime;
    LARGE_INTEGER           UserTime;
    LARGE_INTEGER           KernelTime;
    UNICODE_STRING          ImageName;
    ULONG                   BasePriority;
    HANDLE                  ProcessId;
    HANDLE                  InheritedFromProcessId;
} MY_SYSTEM_PROCESS_INFORMATION, *PMY_SYSTEM_PROCESS_INFORMATION;

typedef NTSTATUS (WINAPI *PNT_QUERY_SYSTEM_INFORMATION)(
    __in       SYSTEM_INFORMATION_CLASS SystemInformationClass,
    __inout    PVOID SystemInformation,
    __in       ULONG SystemInformationLength,
    __out_opt  PULONG ReturnLength
    );

To store original function address create a global variable and initialize it:

//////////////////////////////////////////////////////////////////////////
// Original function

PNT_QUERY_SYSTEM_INFORMATION OriginalNtQuerySystemInformation = 
    (PNT_QUERY_SYSTEM_INFORMATION)::GetProcAddress(::GetModuleHandle(L"ntdll"), "NtQuerySystemInformation");

Hooked function

In the hooked function we call the original function first. Then check SystemInformationClass. If it is SystemProcessInformation we loop through the list of the running processes and find all entries for calc.exe to cut them out from the list. That’s all!

Note: This function must have the same signature as the original one.

//////////////////////////////////////////////////////////////////////////
// Hooked function

NTSTATUS WINAPI HookedNtQuerySystemInformation(
    __in       SYSTEM_INFORMATION_CLASS SystemInformationClass,
    __inout    PVOID                    SystemInformation,
    __in       ULONG                    SystemInformationLength,
    __out_opt  PULONG                   ReturnLength
    )
{
    NTSTATUS status = OriginalNtQuerySystemInformation(SystemInformationClass,
        SystemInformation,
        SystemInformationLength,
        ReturnLength);

    if (SystemProcessInformation == SystemInformationClass && STATUS_SUCCESS == status)
    {
        //
        // Loop through the list of processes
        //

        PMY_SYSTEM_PROCESS_INFORMATION pCurrent = NULL;
        PMY_SYSTEM_PROCESS_INFORMATION pNext    = (PMY_SYSTEM_PROCESS_INFORMATION)SystemInformation;
        
        do
        {
            pCurrent = pNext;
            pNext    = (PMY_SYSTEM_PROCESS_INFORMATION)((PUCHAR)pCurrent + pCurrent->NextEntryOffset);

            if (!wcsncmp(pNext->ImageName.Buffer, L"calc.exe", pNext->ImageName.Length))
            {
                if (0 == pNext->NextEntryOffset)
                {
                    pCurrent->NextEntryOffset = 0;
                }
                else
                {
                    pCurrent->NextEntryOffset += pNext->NextEntryOffset;
                }

                pNext = pCurrent;
            }            
        } 
        while(pCurrent->NextEntryOffset != 0);
    }

    return status;
}
 

4.3 Setting the hook

Setting the hook is pretty easy: call Mhook_SetHook from DllMain when the DLL is loaded to a new process:

//////////////////////////////////////////////////////////////////////////
// Entry point

BOOL WINAPI DllMain(
    __in HINSTANCE  hInstance,
    __in DWORD      Reason,
    __in LPVOID     Reserved
    )
{        
    switch (Reason)
    {
    case DLL_PROCESS_ATTACH:
        Mhook_SetHook((PVOID*)&OriginalNtQuerySystemInformation, HookedNtQuerySystemInformation);
        break;
 

4.4 Unhooking

Unhooking is performed by calling Mhook_Unhook from DllMain when the DLL is unloaded from the process:

//////////////////////////////////////////////////////////////////////////
// Entry point

BOOL WINAPI DllMain(
    __in HINSTANCE  hInstance,
    __in DWORD      Reason,
    __in LPVOID     Reserved
    )
{        
    switch (Reason)
    {
    ...
    case DLL_PROCESS_DETACH:
        Mhook_Unhook((PVOID*)&OriginalNtQuerySystemInformation);
        break;
    }

5. Running a sample

Now it’s time to show the described hook in action. Build the project and put the resulting AppInitHook.dll to the root of the disk C.

api-hooks/diskc.PNG

Figure 1 - The hook DLL is put to the root of the disk C.

Open the registry editor and locate AppInit_DLLs registry key (The key is HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT \CurrentVersion\Windows). Then specify the path to the hook DLL (C:\AppInitHook.dll in our case).

api-hooks/registry.PNG

Figure 2 – Modifying the registry.

After the registry has been modified the hook starts working. Let’s run a few instances of calc.exe. Then open Windows Task Manager and look at the processes tab. There is no calc.exe at all!

api-hooks/taskmgr.png

Figure 3 - Windows Task Manager processes tab.

Let’s see what shows another popular tool written by Mark Russinovich - Process Explorer.

api-hooks/procexp.png

Figure 4 - Process Explorer shows no calc.exe.

All calc.exe instances are hidden successfully. And finally run command line tool tasklist.exe:

api-hooks/tasklist.png

Figure 5 - Tasklist.exe listing of the running processes.

The hook is working!

6. Limitations

There are a few limitations of this hook technique you should know about:

  1. As it was mentioned before this hook is applied only to those processes that are linked to User32.dll.
  2. As hooking is performed in DllMain of User32.dll you can call functions only from Kernel32.dll and Ntdll.dll (other libraries are not initialized yet).
  3. Windows7/Windows 2008 R2 introduces the new security feature – AppInit DLLs have to be digitally signed (however there is a registry key that can turn this feature off).
  4. The file path to AppInit DLL must not contain spaces.

Useful references

  1. Working with the AppInit_DLLs registry value
  2. AppInit DLLs in Windows 7 and Windows Server 2008 R2
  3. API hooking revealed
  4. Mhook, an API hooking library, v2.2
  5. Microsoft Research's Detours
  6. DllMain Callback Function

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Authors

Sergey Podobry
Software Developer (Senior) ApriorIT
Ukraine Ukraine
Member
No Biography provided

Apriorit Inc
Apriorit Inc.
Ukraine Ukraine
Member
Organisation
31 members

ApriorIT is a Software Research and Development company that works in advanced knowledge-intensive scopes.
 
Company offers integrated research&development services for the software projects in such directions as Corporate Security, Remote Control, Mobile Development, Embedded Systems, Virtualization, Drivers and others.
 
Official site http://www.apriorit.com

Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board.
Search this forum  
    Spacing  Noise  Layout  Per page   
AnswerRe: hooking of user32.dllmemberSergey Podobry16 Nov '11 - 23:44 
That's right. Also you can hook LoadLibrary from kernel32.dll and detect when user32.dll gets loaded and set hooks to it.
GeneralRe: hooking of user32.dllmemberdc_200019 Aug '12 - 17:36 
Thanks, but there're too many variables to this process that almost deserve the part II for this article. For instance:
 
1. There're two versions of the API: LoadLibraryA and LoadLibraryW. Which one do we need to hook to?
 
2. There's also LoadLibraryExA and LoadLibraryExW that could be used to load a DLL.
 
3. Any of the LoadLibrary(Ex) APIs can be called repeatedly for the same DLL, what shall be done then?
 
4. When do we need to unhook, during the FreeLibrary call (by previously hooking to it)?
 
So it would be nice if you could explain all this...
AnswerRe: hooking of user32.dllmemberSergey Podobry20 Aug '12 - 3:24 
Thanks for the good food for the part II Smile | :)
 
Here is a short guide:
 
1. You have to hook LoadLibrary. You need to hook all function: LoadLibraryA/W and LoadLibraryExA/W. If your dll will never be run under WOW64 then you may hook only LoadLibraryExW.
2. After executing the original function call GetModuleHandleEx with the name of the dll you want to hook.
3. If GetModuleHandleEx returns a valid handle hook the dll and make it unloadable (don't call FreeLibrary).
4. Make sure that operations above are atomic. Use critical section for that.
5. Don't hook twice (unless you really want to do that).
QuestionFreezing issue in PowerPoint 2007membernick_qi2 Mar '11 - 17:03 
I've coded a simple project to hook StartDocW function from Windows GDI using mHook. It basically pops up a modal MessageBox upon intercepting StartDocW calls then return the values from the original function. Nothing fancy.
 
It worked for all Windows applications I tested, except PowerPoint 2007 on Windows 7. After closing the MessageBox, PowerPoint 2007 would stop accepting user inputs.
 
I did a bit of trial and error and I found that:
 
* To replicate the issue, I must have a Word 2007 instance running in the background.
* It's not a problem for PowerPoint 2007 on Windows XP.
 
Anyone has any ideas if it's hooking related?
QuestionRe: Freezing issue in PowerPoint 2007memberSergey Podobry6 Mar '11 - 22:29 
What if remove MessageBox? Just call the original function.
AnswerRe: Freezing issue in PowerPoint 2007membernick_qi8 Mar '11 - 13:46 
That's not a problem with an UI.
QuestionAny other resource?memberXercoy25 Jan '11 - 12:21 
I'm trying to learn how to use mhook to do some API hooking, and even after studying and reading this article thoroughly, I'm not having any luck creating my own hook. I was wondering if you could provide any other links or resources for me to learn from. I'm trying to hook the InternetOpenUrl function of the WinINet.dll API, but I'm not having any luck. I'd rather not ask you for help every step of the way, I would much rather be able to learn myself. Thank you for taking the time to both write this article and read my post!
AnswerRe: Any other resource?memberSergey Podobry25 Jan '11 - 22:00 
Soon there will be a new article from my college "Intercepting calls to COM interfaces". He uses mhook in his example.
 
I'll give you some tips:
1. There are two InternetOpenUrl functions: InternetOpenUrlA and InternetOpenUrlW.
2. WinINet.dll is not loaded to all processes (or you references it in you hook dll?).
3. Don't forget that API functions have stdcall calling convention.
4. Don't forget that in DllMain you cannot load libraries and call function from any other libraries except kernel32 and ntdll.
 
Have a nice day!
GeneralRe: Any other resource?memberXercoy26 Jan '11 - 8:48 
Are there any other APIs that you suggest I could play around with and manipulate first, just to try different things and learn by doing different examples? Thank you very much Sergey, I appreciate the tips and prompt response greatly!
AnswerRe: Any other resource?memberSergey Podobry26 Jan '11 - 23:18 
First try to hook something from kernel32 or ntdll. For example hook CreateFile and deny access to *.txt files. Or just send file names to debug output. And don't test it on your machine, use a virtual one Smile | :)
 
Good luck!

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Permalink | Advertise | Privacy | Mobile
Web02 | 2.6.130523.1 | Last Updated 19 Mar 2012
Article Copyright 2009 by Sergey Podobry, Apriorit Inc
Everything else Copyright © CodeProject, 1999-2013
Terms of Use
Layout: fixed | fluid