!epthook2 (hidden hook with EPT - detours)

Description of '!epthook2' command in HyperDbg.

Command

!epthook2

Syntax

!epthook2 [address] [pid (hex value)] [core (hex value)] [imm (yes|no)] [event options]

Description

Puts an in-line, detours-style kernel EPT hidden hook. (fast)

This implementation of the hidden hook won't cause vm-exit when it triggers. It's like detours, and everything is done in vmx non-root, so it's much faster than !epthook, but it some limitations. See Remarks for more information.

Parameters

[address]

The Virtual address of where we want to put the hook

[pid (hex value)]

Optional value to trigger the event in just a specific process. Add pid xx to your command; thus, the command will be executed if the process id is equal to xx. If you don't specify this option, then by default, you receive events on all processes.

[core (hex value)]

Optional value to trigger the event in just a specific core. Add core xx to your command thus command will be executed if core id is equal to xx. If you don't specify this option, then by default, you receive events on all cores.

[imm (yes|no)]

Optional value in which yes means the results (printed texts in scripts) should be delivered immediately to the debugger. no means that the results can be accumulated and delivered as a couple of messages when the buffer is full; thus, it's substantially faster, but it's not real-time. By default, this value is set to yes.

[event options]

Regular event parameters that are used in HyperDbg events. (For more information, read this topic)

Context

As the Context (r8 in custom code and rdx in condition code register) to the event trigger, HyperDbg sends the physical address of where put the hidden hook's breakpoint.

Debugger

This event supports three debugging mechanisms.

  • Break

  • Script

  • Custom Code

Please read "How to create a condition?" if you need a conditional event, a conditional event can be used in all "Break", "Script", and "Custom Code".

Break

Imagine we want to put a hook on fffff800`4ed6f010, this will break into the debugger when the target address hits and gives the control back to you.

HyperDbg> !epthook2 fffff800`4ed6f010

Script

Using the following command, you can use HyperDbg's Script Engine. You should replace the string between braces (HyperDbg Script Here) with your script. You can find script examples here.

HyperDbg> !epthook2 fffff800`4ed6f010 script { HyperDbg Script Here }

The above command when messages don't need to be delivered immediately.

HyperDbg> !epthook2 fffff800`4ed6f010 script { HyperDbg Script Here } imm no

Script (From File)

If you saved your script into a file, then you can add file: instead of a script and append the file path to it. For example, the following examples show how you can run a script from file:c:\users\sina\desktop\script.txt.

HyperDbg> !epthook2 fffff800`4ed6f010 script {file:c:\users\sina\desktop\script.txt}

You can use event forwarding to forward the event monitoring results from this event and other events to an external source, e.g., File, NamedPipe, or TCP Socket. This way, you can use HyperDbg as a monitoring tool and gather your target system's behavior and use it later or analyze it on other systems.

Custom Code

Please read "How to create an action?" to get an idea about how to run a custom buffer code in HyperDbg.

Your custom code will be executed in vmx-root mode. Take a look at this topic for more information. Running code in vmx-root is considered "unsafe".

Run Custom Code (Unconditional)

Putting a hook on fffff801deadbeef and run 3 nops whenever the hook is triggered. Take a look at Run Custom Code for more information.

HyperDbg> !epthook2 fffff801deadbeef code {90 90 90}

Run Custom Code (Conditional)

Putting a hook on fffff801deadbeef and run 3 nops whenever the hook is triggered and also 3 nops condition. Take a look at Run Custom Code and how to create a condition for more information.

HyperDbg> !epthook2 fffff801deadbeef code {90 90 90} condition {90 90 90}

Keep in mind that a conditional event can be used in Breaking to Debugger and Running Script too.

IOCTL

This command uses the same method to send IOCTL for regular events.

Use HIDDEN_HOOK_EXEC_DETOURS as EventType, and send the address of where you want to hook in OptionalParam1in DEBUGGER_GENERAL_EVENT_DETAIL.

Design

Take a look at "Design of !epthook2" to see how does it work.

Remarks

This command is much faster than !epthook, but it has the following limitations:

  • It can be used only in kernel addresses, which means that you cannot use it for user-mode addresses.

  • You can only use one hook in a page of memory. For example, if you put a hook on fffff80126551006 then you cannot put another hook in the range of fffff80126551000 to fffff80126551fff because it's within the same page (0x1000 or 4096 bytes).

  • It has the limitation of classic detours hooks. We patch 18 bytes for our detours hook, so when you put a hook anywhere in your assembly, you have to make sure that there is no relative jump or relative call within 18 bytes after the hook address. Most of the time, the start address of the function is detours-compatible (doesn't start with relative jumps or relative calls), especially in x64 fast call functions; thus, the start address of a function is a good point to put these hidden hooks.

  • r11 is modified in the hook, so you need to make sure that the target address doesn't use this register (at least at that point of the program). If you need the r11 compile the HyperDbg with another register (change the register in EptHookWriteAbsoluteJump and EptHookWriteAbsoluteJump2in Ept.c).

You shouldn't use any of !monitor, !epthook, bp, and !epthook2 commands on the same page (4KB) simultaneously. For example, when you put a hidden hook (!epthook2) on 0x10000005, you shouldn't use any of !monitor or !epthook or bp commands on the address starting from 0x10000000 to 0x10000fff.

You can use !epthook or bp (just !epthook not !epthook2 and not !monitor) on two or more addresses on the same page (means that you can use the !epthook or bp multiple times for addresses between a single page or putting multiple hidden breakpoints on a single page). But you can't use !monitor or !epthook2 twice on the same page.

This is an event command, but in the current version of HyperDbg (in Debugger Mode), this command will continue the debuggee for some time; however, you can use this trick to make sure you won't lose any event.

Requirements

Post-Nehalem Processor (EPT)

Processor with Execute-only Pages Support

!epthook (hidden hook with EPT - stealth breakpoints)