Skip to content

Commit

Permalink
Add XTF test tool (tklengyel#1203)
Browse files Browse the repository at this point in the history
  • Loading branch information
tklengyel authored Apr 14, 2021
1 parent af70557 commit 789b86f
Show file tree
Hide file tree
Showing 6 changed files with 268 additions and 13 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ injector
xen_memclone
proc_stat
repl
xtf

libtool
ltmain.sh
Expand Down
7 changes: 7 additions & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,13 @@ AC_ARG_ENABLE([ipt],
[enable_ipt="yes"])
AM_CONDITIONAL([ENABLE_IPT], [test x$enable_ipt = xyes])

AC_ARG_ENABLE([xtf],
[AS_HELP_STRING([--enable-xtf],
[Enable the XTF test tool @<:@no@:>@])],
[xtf="$enableval"],
[xtf="no"])
AM_CONDITIONAL([XTF], [test x$xtf = xyes])

#####################################################
# AUTOHARDEN START
# We want to check for compiler flag support, but there is no way to make
Expand Down
6 changes: 6 additions & 0 deletions src/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ injector_LDADD += libinjector/libinjector.la

proc_stat_LDADD = libdrakvuf/libdrakvuf.la

if XTF
bin_PROGRAMS += xtf
xtf_SOURCES = xtf.c
xtf_LDADD = libdrakvuf/libdrakvuf.la
endif

if REPL
bin_PROGRAMS += repl

Expand Down
14 changes: 8 additions & 6 deletions src/libdrakvuf/drakvuf.c
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ void drakvuf_close(drakvuf_t drakvuf, const bool pause)
bool drakvuf_init(drakvuf_t* drakvuf, const char* domain, const char* json_kernel_path, const char* json_wow_path, bool _verbose, bool libvmi_conf, addr_t kpgd, bool fast_singlestep, uint64_t limited_traps_ttl)
{

if ( !domain || !json_kernel_path )
if ( !domain )
return 0;

#ifdef DRAKVUF_DEBUG
Expand All @@ -176,12 +176,12 @@ bool drakvuf_init(drakvuf_t* drakvuf, const char* domain, const char* json_kerne
*drakvuf = (drakvuf_t)g_try_malloc0(sizeof(struct drakvuf));

(*drakvuf)->limited_traps_ttl = limited_traps_ttl;

(*drakvuf)->json_kernel_path = g_strdup(json_kernel_path);

(*drakvuf)->context_switch_intercept_processes = NULL;
(*drakvuf)->enable_cr3_based_interception = false;

if ( json_kernel_path )
(*drakvuf)->json_kernel_path = g_strdup(json_kernel_path);

if ( json_wow_path )
{
(*drakvuf)->json_wow = json_object_from_file(json_wow_path);
Expand Down Expand Up @@ -224,8 +224,7 @@ bool drakvuf_init(drakvuf_t* drakvuf, const char* domain, const char* json_kerne
case VMI_OS_UNKNOWN: /* fall-through */
case VMI_OS_FREEBSD: /* fall-through */
default:
fprintf(stderr, "The Rekall profile describes an unknown operating system kernel!\n");
goto err;
break;
}

PRINT_DEBUG("libdrakvuf initialized\n");
Expand Down Expand Up @@ -362,7 +361,10 @@ bool inject_trap_breakpoint(drakvuf_t drakvuf, drakvuf_trap_t* trap)
{
addr_t trap_pa;
if ( VMI_FAILURE == vmi_pagetable_lookup(drakvuf->vmi, trap->breakpoint.dtb, trap->breakpoint.addr, &trap_pa) )
{
PRINT_DEBUG("Breakpoint VA 0x%" PRIx64" not found in pagetable at 0x%" PRIx64 "\n", trap->breakpoint.addr, trap->breakpoint.dtb);
return 0;
}

PRINT_DEBUG("Breakpoint VA 0x%" PRIx64" -> PA 0x%" PRIx64 "\n", trap->breakpoint.addr, trap_pa);

Expand Down
14 changes: 7 additions & 7 deletions src/libdrakvuf/vmi.c
Original file line number Diff line number Diff line change
Expand Up @@ -1590,7 +1590,7 @@ bool init_vmi(drakvuf_t drakvuf, bool libvmi_conf, bool fast_singlestep)

if (libvmi_conf)
drakvuf->os = vmi_init_os(drakvuf->vmi, VMI_CONFIG_GLOBAL_FILE_ENTRY, NULL, NULL);
else
else if ( drakvuf->json_kernel_path )
{
GHashTable* config = g_hash_table_new(g_str_hash, g_str_equal);
g_hash_table_insert(config, "volatility_ist", drakvuf->json_kernel_path);
Expand All @@ -1601,20 +1601,20 @@ bool init_vmi(drakvuf_t drakvuf, bool libvmi_conf, bool fast_singlestep)
drakvuf->os = vmi_init_os(drakvuf->vmi, VMI_CONFIG_GHASHTABLE, config, NULL);
g_hash_table_destroy(config);
}

if ( drakvuf->os == VMI_OS_UNKNOWN )
else
{
PRINT_DEBUG("Failed to init LibVMI library.\n");
return 0;
vmi_init_paging(drakvuf->vmi, 0);
drakvuf->os = VMI_OS_UNKNOWN;
}
PRINT_DEBUG("init_vmi: initializing vmi OS done\n");

PRINT_DEBUG("init_vmi: initializing vmi OS bits done: %u\n", drakvuf->os);

drakvuf->pm = vmi_get_page_mode(drakvuf->vmi, 0);
drakvuf->address_width = vmi_get_address_width(drakvuf->vmi);
drakvuf->vcpus = vmi_get_num_vcpus(drakvuf->vmi);
drakvuf->init_memsize = xen_get_maxmemkb(drakvuf->xen, drakvuf->domID);

if ( !drakvuf->kpgd )
if ( !drakvuf->kpgd && drakvuf->os != VMI_OS_UNKNOWN )
vmi_get_offset(drakvuf->vmi, "kpgd", &drakvuf->kpgd);

if ( xc_domain_maximum_gpfn(drakvuf->xen->xc, drakvuf->domID, &drakvuf->max_gpfn) < 0 )
Expand Down
239 changes: 239 additions & 0 deletions src/xtf.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,239 @@
/*********************IMPORTANT DRAKVUF LICENSE TERMS***********************
* *
* DRAKVUF (C) 2014-2021 Tamas K Lengyel. *
* Tamas K Lengyel is hereinafter referred to as the author. *
* This program is free software; you may redistribute and/or modify it *
* under the terms of the GNU General Public License as published by the *
* Free Software Foundation; Version 2 ("GPL"), BUT ONLY WITH ALL OF THE *
* CLARIFICATIONS AND EXCEPTIONS DESCRIBED HEREIN. This guarantees your *
* right to use, modify, and redistribute this software under certain *
* conditions. If you wish to embed DRAKVUF technology into proprietary *
* software, alternative licenses can be acquired from the author. *
* *
* Note that the GPL places important restrictions on "derivative works", *
* yet it does not provide a detailed definition of that term. To avoid *
* misunderstandings, we interpret that term as broadly as copyright law *
* allows. For example, we consider an application to constitute a *
* derivative work for the purpose of this license if it does any of the *
* following with any software or content covered by this license *
* ("Covered Software"): *
* *
* o Integrates source code from Covered Software. *
* *
* o Reads or includes copyrighted data files. *
* *
* o Is designed specifically to execute Covered Software and parse the *
* results (as opposed to typical shell or execution-menu apps, which will *
* execute anything you tell them to). *
* *
* o Includes Covered Software in a proprietary executable installer. The *
* installers produced by InstallShield are an example of this. Including *
* DRAKVUF with other software in compressed or archival form does not *
* trigger this provision, provided appropriate open source decompression *
* or de-archiving software is widely available for no charge. For the *
* purposes of this license, an installer is considered to include Covered *
* Software even if it actually retrieves a copy of Covered Software from *
* another source during runtime (such as by downloading it from the *
* Internet). *
* *
* o Links (statically or dynamically) to a library which does any of the *
* above. *
* *
* o Executes a helper program, module, or script to do any of the above. *
* *
* This list is not exclusive, but is meant to clarify our interpretation *
* of derived works with some common examples. Other people may interpret *
* the plain GPL differently, so we consider this a special exception to *
* the GPL that we apply to Covered Software. Works which meet any of *
* these conditions must conform to all of the terms of this license, *
* particularly including the GPL Section 3 requirements of providing *
* source code and allowing free redistribution of the work as a whole. *
* *
* Any redistribution of Covered Software, including any derived works, *
* must obey and carry forward all of the terms of this license, including *
* obeying all GPL rules and restrictions. For example, source code of *
* the whole work must be provided and free redistribution must be *
* allowed. All GPL references to "this License", are to be treated as *
* including the terms and conditions of this license text as well. *
* *
* Because this license imposes special exceptions to the GPL, Covered *
* Work may not be combined (even as part of a larger work) with plain GPL *
* software. The terms, conditions, and exceptions of this license must *
* be included as well. This license is incompatible with some other open *
* source licenses as well. In some cases we can relicense portions of *
* DRAKVUF or grant special permissions to use it in other open source *
* software. Please contact tamas.k.lengyel@gmail.com with any such *
* requests. Similarly, we don't incorporate incompatible open source *
* software into Covered Software without special permission from the *
* copyright holders. *
* *
* If you have any questions about the licensing restrictions on using *
* DRAKVUF in other works, are happy to help. As mentioned above, *
* alternative license can be requested from the author to integrate *
* DRAKVUF into proprietary applications and appliances. Please email *
* tamas.k.lengyel@gmail.com for further information. *
* *
* If you have received a written license agreement or contract for *
* Covered Software stating terms other than these, you may choose to use *
* and redistribute Covered Software under those terms instead of these. *
* *
* Source is provided to this software because we believe users have a *
* right to know exactly what a program is going to do before they run it. *
* This also allows you to audit the software for security holes. *
* *
* Source code also allows you to port DRAKVUF to new platforms, fix bugs, *
* and add new features. You are highly encouraged to submit your changes *
* on https://github.com/tklengyel/drakvuf, or by other methods. *
* By sending these changes, it is understood (unless you specify *
* otherwise) that you are offering unlimited, non-exclusive right to *
* reuse, modify, and relicense the code. DRAKVUF will always be *
* available Open Source, but this is important because the inability to *
* relicense code has caused devastating problems for other Free Software *
* projects (such as KDE and NASM). *
* To specify special license conditions of your contributions, just say *
* so when you send them. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the DRAKVUF *
* license file for more details (it's in a COPYING file included with *
* DRAKVUF, and also available from *
* https://github.com/tklengyel/drakvuf/COPYING) *
* *
***************************************************************************/

#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <unistd.h>
#include <libvmi/libvmi.h>

#include <libdrakvuf/libdrakvuf.h>

static drakvuf_t drakvuf;
static unsigned int counter;
static int ret;
static bool breakpoint_called;

event_response_t cpuid_callback(drakvuf_t drakvuf __attribute__((unused)), drakvuf_trap_info_t* info);
event_response_t breakpoint_callback(drakvuf_t drakvuf __attribute__((unused)), drakvuf_trap_info_t* info);

drakvuf_trap_t cpuid_trap =
{
.type = CPUID,
.cb = cpuid_callback,
.ttl = UNLIMITED_TTL
};

drakvuf_trap_t breakpoint_trap =
{
.type = BREAKPOINT,
.cb = breakpoint_callback,
.ttl = UNLIMITED_TTL,
.breakpoint.lookup_type = LOOKUP_NONE,
.breakpoint.addr_type = ADDR_PA
};

static void close_handler(int sig)
{
drakvuf_interrupt(drakvuf, sig);
}

static bool is_interrupted(drakvuf_t drakvuf, void* data __attribute__((unused)))
{
return drakvuf_is_interrupted(drakvuf);
}

event_response_t breakpoint_callback(drakvuf_t drakvuf __attribute__((unused)), drakvuf_trap_info_t* info)
{
printf("Breakpoint callback @ 0x%lx!\n", info->regs->rip);
breakpoint_called = true;
return 0;
}

event_response_t cpuid_callback(drakvuf_t drakvuf, drakvuf_trap_info_t* info)
{
printf("CPUID leaf 0x%x subleaf 0x%x\n", info->cpuid->leaf, info->cpuid->subleaf);

if ( info->cpuid->leaf == 0xdeadbeef )
counter = counter + 1;

if ( counter == 1 )
{
breakpoint_trap.breakpoint.dtb = info->regs->cr3;
breakpoint_trap.breakpoint.addr = info->cpuid->subleaf;

if ( drakvuf_add_trap(drakvuf, &breakpoint_trap) )
printf("Breakpoint activated at 0x%x\n", info->cpuid->subleaf);
else
printf("Failed to add breakpoint!\n");
}

if ( counter == 2 )
{
if ( info->cpuid->subleaf != 0xFF )
{
printf("Shadow page test FAILED\n");
ret = 1;
}
else
{
printf("Shadow page test SUCCESS\n");
}

drakvuf_remove_trap(drakvuf, info->trap, NULL);
drakvuf_interrupt(drakvuf, 1);
}

return 0;
}

int main(int argc, char** argv)
{
if ( argc != 2 )
{
printf("%s <domain>\n", argv[0]);
return 1;
}

if (!drakvuf_init(&drakvuf, argv[1], NULL, NULL, false, false, 0, false, UNLIMITED_TTL))
{
fprintf(stderr, "Failed to initialize on domain %s\n", argv[1]);
return 1;
}

/* for a clean exit */
struct sigaction act;
act.sa_handler = close_handler;
act.sa_flags = 0;
sigemptyset(&act.sa_mask);
sigaction(SIGHUP, &act, NULL);
sigaction(SIGTERM, &act, NULL);
sigaction(SIGINT, &act, NULL);
sigaction(SIGALRM, &act, NULL);

printf("DRAKVUF initialized\n");

if ( drakvuf_add_trap(drakvuf, &cpuid_trap) )
{
printf("CPUID trap registered on %s\n", argv[1]);
drakvuf_loop(drakvuf, is_interrupted, NULL);
}
else
{
printf("CPUID trap NOT registered on %s\n", argv[1]);
}

drakvuf_remove_trap(drakvuf, &breakpoint_trap, NULL);
drakvuf_resume(drakvuf);

drakvuf_close(drakvuf, 0);

if ( !breakpoint_called || counter != 2 )
{
printf("XTF test failed\n");
ret = 1;
}

return ret;
}

0 comments on commit 789b86f

Please sign in to comment.