fltsupport.c File Reference

#include <kmt_test.h>
#include "kmtest.h"
#include <kmt_public.h>
#include <assert.h>
#include <debug.h>

Include dependency graph for fltsupport.c:

Go to the source code of this file.

Classes
struct	_KMTFLT_MESSAGE_HEADER

Macros
#define	KMT_FLT_USER_MODE

Typedefs
typedef struct _KMTFLT_MESSAGE_HEADER	KMTFLT_MESSAGE_HEADER
typedef struct _KMTFLT_MESSAGE_HEADER *	PKMTFLT_MESSAGE_HEADER

Functions
KmtCloseService
Close the specified driver service handle Parameters ServiceHandle Pointer to a variable containing the service handle. Will be set to NULL on success Returns Win32 error code
DWORD	KmtpCreateService (IN PCWSTR ServiceName, IN PCWSTR ServicePath, IN PCWSTR DisplayName OPTIONAL, IN DWORD ServiceType, OUT SC_HANDLE *ServiceHandle)
KmtFltAddAltitude
Sets up the mini-filter altitude data in the registry Parameters hPort The altitude string to set Returns Win32 error code
DWORD	EnablePrivilegeInCurrentProcess (_In_z_ LPWSTR lpPrivName, _In_ BOOL bEnable)
DWORD	KmtFltAddAltitude (_In_z_ LPWSTR Altitude)
DWORD	EnablePrivilege (_In_ HANDLE hToken, _In_z_ LPWSTR lpPrivName, _In_ BOOL bEnable)
KmtFltCreateService
Create the specified driver service and return a handle to it Parameters ServiceName Name of the service to create ServicePath File name of the driver, relative to the current directory DisplayName Service display name ServiceHandle Pointer to a variable to receive the handle to the service Returns Win32 error code
DWORD	KmtFltCreateService (_In_z_ PCWSTR ServiceName, _In_z_ PCWSTR DisplayName, _Out_ SC_HANDLE *ServiceHandle)
KmtFltDeleteService
Delete the specified filter driver Parameters ServiceName If *ServiceHandle is NULL, name of the service to delete ServiceHandle Pointer to a variable containing the service handle. Will be set to NULL on success Returns Win32 error code
DWORD	KmtFltDeleteService (_In_opt_z_ PCWSTR ServiceName, _Inout_ SC_HANDLE *ServiceHandle)
KmtFltLoadDriver
Delete the specified filter driver Returns Win32 error code
DWORD	KmtFltLoadDriver (_In_ BOOLEAN EnableDriverLoadPrivlege, _In_ BOOLEAN RestartIfRunning, _In_ BOOLEAN ConnectComms, _Out_ HANDLE *hPort)
KmtFltUnloadDriver
Unload the specified filter driver Parameters hPort Handle to the filter's comms port DisonnectComms TRUE to disconnect the comms connection before unloading Returns Win32 error code
DWORD	KmtFltUnloadDriver (_In_ HANDLE *hPort, _In_ BOOLEAN DisonnectComms)
KmtFltConnectComms
Create a comms connection to the specified filter Parameters hPort Handle to the filter's comms port Returns Win32 error code
DWORD	KmtFltConnectComms (_Out_ HANDLE *hPort)
KmtFltDisconnectComms
Disconenct from the comms port Parameters hPort Handle to the filter's comms port Returns Win32 error code
DWORD	KmtFltDisconnectComms (_In_ HANDLE hPort)
KmtFltCloseService
Close the specified driver service handle Parameters ServiceHandle Pointer to a variable containing the service handle. Will be set to NULL on success Returns Win32 error code
DWORD	KmtFltCloseService (_Inout_ SC_HANDLE *ServiceHandle)
KmtFltRunKernelTest
Run the specified filter test part Parameters hPort Handle to the filter's comms port TestName Name of the test to run Returns Win32 error code
DWORD	KmtFltRunKernelTest (_In_ HANDLE hPort, _In_z_ PCSTR TestName)
KmtFltSendToDriver
Send an I/O control message with no arguments to the driver opened with KmtOpenDriver Parameters hPort Handle to the filter's comms port Message The message to send to the filter Returns Win32 error code
DWORD	KmtFltSendToDriver (_In_ HANDLE hPort, _In_ DWORD Message)
KmtFltSendStringToDriver
Send an I/O control message with a string argument to the driver opened with KmtOpenDriver Parameters hPort Handle to the filter's comms port Message The message associated with the string String An ANSI string to send to the filter Returns Win32 error code
DWORD	KmtFltSendStringToDriver (_In_ HANDLE hPort, _In_ DWORD Message, _In_ PCSTR String)
KmtFltSendWStringToDriver
Send an I/O control message with a wide string argument to the driver opened with KmtOpenDriver Parameters hPort Handle to the filter's comms port Message The message associated with the string String An wide string to send to the filter Returns Win32 error code
DWORD	KmtFltSendWStringToDriver (_In_ HANDLE hPort, _In_ DWORD Message, _In_ PCWSTR String)
KmtFltSendUlongToDriver
Send an I/O control message with an integer argument to the driver opened with KmtOpenDriver Parameters hPort Handle to the filter's comms port Message The message associated with the value Value An 32bit valueng to send to the filter Returns Win32 error code
DWORD	KmtFltSendUlongToDriver (_In_ HANDLE hPort, _In_ DWORD Message, _In_ DWORD Value)
KmtSendBufferToDriver
Send an I/O control message with the specified arguments to the driver opened with KmtOpenDriver Parameters hPort Handle to the filter's comms port Message The message associated with the value InBuffer Pointer to a buffer to send to the filter BufferSize Size of the buffer pointed to by InBuffer OutBuffer Pointer to a buffer to receive a response from the filter OutBufferSize Size of the buffer pointed to by OutBuffer BytesReturned Number of bytes written in the reply buffer Returns Win32 error code
DWORD	KmtFltSendBufferToDriver (_In_ HANDLE hPort, _In_ DWORD Message, _In_reads_bytes_(BufferSize) LPVOID InBuffer, _In_ DWORD BufferSize, _Out_writes_bytes_to_opt_(OutBufferSize, *BytesReturned) LPVOID OutBuffer, _In_ DWORD OutBufferSize, _Out_opt_ LPDWORD BytesReturned)

Variables
HANDLE	KmtestHandle
static WCHAR	TestServiceName [MAX_PATH]

Macro Definition Documentation

KMT_FLT_USER_MODE

#define KMT_FLT_USER_MODE

Definition at line 10 of file fltsupport.c.

Typedef Documentation

KMTFLT_MESSAGE_HEADER

typedef struct _KMTFLT_MESSAGE_HEADER KMTFLT_MESSAGE_HEADER

PKMTFLT_MESSAGE_HEADER

typedef struct _KMTFLT_MESSAGE_HEADER * PKMTFLT_MESSAGE_HEADER

Function Documentation

EnablePrivilege()

DWORD EnablePrivilege	(	_In_ HANDLE	hToken,
		_In_z_ LPWSTR	lpPrivName,
		_In_ BOOL	bEnable
	)

Definition at line 532 of file fltsupport.c.

{
    TOKEN_PRIVILEGES TokenPrivileges;
    LUID luid;
    BOOL bSuccess;
    DWORD dwError = ERROR_SUCCESS;
 
    /* Get the luid for this privilege */
    if (!LookupPrivilegeValueW(NULL, lpPrivName, &luid))
        return GetLastError();
 
    /* Setup the struct with the priv info */
    TokenPrivileges.PrivilegeCount = 1;
    TokenPrivileges.Privileges[0].Luid = luid;
    TokenPrivileges.Privileges[0].Attributes = bEnable ? SE_PRIVILEGE_ENABLED : 0;
 
    /* Enable the privilege info in the token */
    bSuccess = AdjustTokenPrivileges(hToken,
                                     FALSE,
                                     &TokenPrivileges,
                                     sizeof(TOKEN_PRIVILEGES),
                                     NULL,
                                     NULL);
    if (bSuccess == FALSE) dwError = GetLastError();
 
    /* return status */
    return dwError;
}

Referenced by EnablePrivilegeInCurrentProcess().

EnablePrivilegeInCurrentProcess()

DWORD EnablePrivilegeInCurrentProcess	(	_In_z_ LPWSTR	lpPrivName,
		_In_ BOOL	bEnable
	)

Definition at line 564 of file fltsupport.c.

{
    HANDLE hToken;
    BOOL bSuccess;
    DWORD dwError = ERROR_SUCCESS;
 
    /* Get a handle to our token */
    bSuccess = OpenProcessToken(GetCurrentProcess(),
                                TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY,
                                &hToken);
    if (bSuccess == FALSE) return GetLastError();
 
    /* Enable the privilege in the agent token */
    dwError = EnablePrivilege(hToken, lpPrivName, bEnable);
 
    /* We're done with this now */
    CloseHandle(hToken);
 
    /* return status */
    return dwError;
}

Referenced by KmtFltLoadDriver().

KmtFltAddAltitude()

DWORD KmtFltAddAltitude

(

_In_z_ LPWSTR

Altitude

)

Definition at line 448 of file fltsupport.c.

{
    WCHAR DefaultInstance[128];
    WCHAR KeyPath[256];
    HKEY hKey = NULL;
    HKEY hSubKey = NULL;
    DWORD Zero = 0;
    LONG Error;
 
    StringCbCopyW(KeyPath, sizeof(KeyPath), L"SYSTEM\\CurrentControlSet\\Services\\");
    StringCbCatW(KeyPath, sizeof(KeyPath), TestServiceName);
    StringCbCatW(KeyPath, sizeof(KeyPath), L"\\Instances\\");
 
    Error = RegCreateKeyEx(HKEY_LOCAL_MACHINE,
                           KeyPath,
                           0,
                           NULL,
                           REG_OPTION_NON_VOLATILE,
                           KEY_CREATE_SUB_KEY | KEY_SET_VALUE,
                           NULL,
                           &hKey,
                           NULL);
    if (Error != ERROR_SUCCESS)
    {
        return Error;
    }
 
    StringCbCopyW(DefaultInstance, sizeof(DefaultInstance), TestServiceName);
    StringCbCatW(DefaultInstance, sizeof(DefaultInstance), L" Instance");
 
    Error = RegSetValueExW(hKey,
                           L"DefaultInstance",
                           0,
                           REG_SZ,
                           (LPBYTE)DefaultInstance,
                           (lstrlenW(DefaultInstance) + 1) * sizeof(WCHAR));
    if (Error != ERROR_SUCCESS)
    {
        goto Quit;
    }
 
    Error = RegCreateKeyW(hKey, DefaultInstance, &hSubKey);
    if (Error != ERROR_SUCCESS)
    {
        goto Quit;
    }
 
    Error = RegSetValueExW(hSubKey,
                           L"Altitude",
                           0,
                           REG_SZ,
                           (LPBYTE)Altitude,
                           (lstrlenW(Altitude) + 1) * sizeof(WCHAR));
    if (Error != ERROR_SUCCESS)
    {
        goto Quit;
    }
 
    Error = RegSetValueExW(hSubKey,
                           L"Flags",
                           0,
                           REG_DWORD,
                           (LPBYTE)&Zero,
                           sizeof(DWORD));
 
Quit:
    if (hSubKey)
    {
        RegCloseKey(hSubKey);
    }
    if (hKey)
    {
        RegCloseKey(hKey);
    }
 
    return Error;
 
}

Referenced by START_TEST().

KmtFltCloseService()

DWORD KmtFltCloseService

(

_Inout_ SC_HANDLE *

ServiceHandle

)

Definition at line 242 of file fltsupport.c.

{
    return KmtCloseService(ServiceHandle);
}

KmtFltConnectComms()

DWORD KmtFltConnectComms

(

_Out_ HANDLE *

hPort

)

Definition at line 207 of file fltsupport.c.

{
    return KmtFltConnect(TestServiceName, hPort);
}

Referenced by KmtFltLoadDriver(), and START_TEST().

KmtFltCreateService()

DWORD KmtFltCreateService	(	_In_z_ PCWSTR	ServiceName,
		_In_z_ PCWSTR	DisplayName,
		_Out_ SC_HANDLE *	ServiceHandle
	)

Definition at line 63 of file fltsupport.c.

{
    WCHAR ServicePath[MAX_PATH];
 
    StringCbCopyW(ServicePath, sizeof(ServicePath), ServiceName);
    StringCbCatW(ServicePath, sizeof(ServicePath), L"_drv.sys");
 
    StringCbCopyW(TestServiceName, sizeof(TestServiceName), L"Kmtest-");
    StringCbCatW(TestServiceName, sizeof(TestServiceName), ServiceName);
 
    return KmtpCreateService(TestServiceName,
                             ServicePath,
                             DisplayName,
                             SERVICE_FILE_SYSTEM_DRIVER,
                             ServiceHandle);
}

Referenced by START_TEST().

KmtFltDeleteService()

DWORD KmtFltDeleteService	(	_In_opt_z_ PCWSTR	ServiceName,
		_Inout_ SC_HANDLE *	ServiceHandle
	)

Definition at line 97 of file fltsupport.c.

{
    return KmtDeleteService(ServiceName, ServiceHandle);
}

Referenced by START_TEST().

KmtFltDisconnectComms()

DWORD KmtFltDisconnectComms

(

_In_ HANDLE

hPort

)

Definition at line 224 of file fltsupport.c.

{
    return KmtFltDisconnect(hPort);
}

Referenced by START_TEST().

KmtFltLoadDriver()

DWORD KmtFltLoadDriver	(	_In_ BOOLEAN	EnableDriverLoadPrivlege,
		_In_ BOOLEAN	RestartIfRunning,
		_In_ BOOLEAN	ConnectComms,
		_Out_ HANDLE *	hPort
	)

Definition at line 112 of file fltsupport.c.

{
    DWORD Error;
 
    if (EnableDriverLoadPrivlege)
    {
        Error = EnablePrivilegeInCurrentProcess(SE_LOAD_DRIVER_NAME , TRUE);
        if (Error)
        {
            return Error;
        }
    }
 
    Error = KmtFltLoad(TestServiceName);
    if ((Error == ERROR_SERVICE_ALREADY_RUNNING) && RestartIfRunning)
    {
        Error = KmtFltUnload(TestServiceName);
        if (Error)
        {
            // TODO
            __debugbreak();
        }
 
        Error = KmtFltLoad(TestServiceName);
    }
 
    if (Error)
    {
        return Error;
    }
 
    if (ConnectComms)
    {
        Error = KmtFltConnectComms(hPort);
    }
 
    return Error;
}

Referenced by START_TEST().

KmtFltRunKernelTest()

DWORD KmtFltRunKernelTest	(	_In_ HANDLE	hPort,
		_In_z_ PCSTR	TestName
	)

Definition at line 261 of file fltsupport.c.

{
    return KmtFltSendStringToDriver(hPort, KMTFLT_RUN_TEST, TestName);
}

KmtFltSendBufferToDriver()

DWORD KmtFltSendBufferToDriver	(	_In_ HANDLE	hPort,
		_In_ DWORD	Message,
		_In_reads_bytes_(BufferSize) LPVOID	InBuffer,
		_In_ DWORD	BufferSize,
		_Out_writes_bytes_to_opt_(OutBufferSize, *BytesReturned) LPVOID	OutBuffer,
		_In_ DWORD	OutBufferSize,
		_Out_opt_ LPDWORD	BytesReturned
	)

Definition at line 384 of file fltsupport.c.

{
    PKMTFLT_MESSAGE_HEADER Ptr;
    KMTFLT_MESSAGE_HEADER Header;
    BOOLEAN FreeMemory = FALSE;
    DWORD InBufferSize;
    DWORD Error;
 
    assert(hPort);
 
    if (BufferSize)
    {
        assert(InBuffer);
 
        InBufferSize = sizeof(KMTFLT_MESSAGE_HEADER) + BufferSize;
        Ptr = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, InBufferSize);
        if (!Ptr)
        {
            return ERROR_NOT_ENOUGH_MEMORY;
        }
        FreeMemory = TRUE;
    }
    else
    {
        InBufferSize = sizeof(KMTFLT_MESSAGE_HEADER);
        Ptr = &Header;
    }
 
    Ptr->Message = Message;
    if (BufferSize)
    {
        Ptr->Buffer = (Ptr + 1);
        StringCbCopy(Ptr->Buffer, BufferSize, InBuffer);
        Ptr->BufferSize = BufferSize;
    }
 
    Error = KmtFltSendMessage(hPort, Ptr, InBufferSize, OutBuffer, OutBufferSize, BytesReturned);
 
    if (FreeMemory)
    {
        HeapFree(GetProcessHeap(), 0, Ptr);
    }
 
    return Error;
}

Referenced by KmtFltSendStringToDriver(), KmtFltSendToDriver(), KmtFltSendUlongToDriver(), and KmtFltSendWStringToDriver().

KmtFltSendStringToDriver()

DWORD KmtFltSendStringToDriver	(	_In_ HANDLE	hPort,
		_In_ DWORD	Message,
		_In_ PCSTR	String
	)

Definition at line 305 of file fltsupport.c.

{
    assert(hPort);
    assert(String);
    return KmtFltSendBufferToDriver(hPort, Message, (PVOID)String, (DWORD)strlen(String), NULL, 0, NULL);
}

Referenced by KmtFltRunKernelTest().

KmtFltSendToDriver()

DWORD KmtFltSendToDriver	(	_In_ HANDLE	hPort,
		_In_ DWORD	Message
	)

Definition at line 281 of file fltsupport.c.

{
    assert(hPort);
    return KmtFltSendBufferToDriver(hPort, Message, NULL, 0, NULL, 0, NULL);
}

KmtFltSendUlongToDriver()

DWORD KmtFltSendUlongToDriver	(	_In_ HANDLE	hPort,
		_In_ DWORD	Message,
		_In_ DWORD	Value
	)

Definition at line 353 of file fltsupport.c.

{
    return KmtFltSendBufferToDriver(hPort, Message, &Value, sizeof(Value), NULL, 0, NULL);
}

KmtFltSendWStringToDriver()

DWORD KmtFltSendWStringToDriver	(	_In_ HANDLE	hPort,
		_In_ DWORD	Message,
		_In_ PCWSTR	String
	)

Definition at line 330 of file fltsupport.c.

{
    return KmtFltSendBufferToDriver(hPort, Message, (PVOID)String, (DWORD)wcslen(String) * sizeof(WCHAR), NULL, 0, NULL);
}

KmtFltUnloadDriver()

DWORD KmtFltUnloadDriver	(	_In_ HANDLE *	hPort,
		_In_ BOOLEAN	DisonnectComms
	)

Definition at line 169 of file fltsupport.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    if (DisonnectComms)
    {
        Error = KmtFltDisconnect(hPort);
 
        if (Error)
        {
            return Error;
        }
    }
 
    Error = KmtFltUnload(TestServiceName);
 
    if (Error)
    {
        // TODO
        __debugbreak();
    }
 
    return Error;
}

Referenced by START_TEST().

KmtpCreateService()

DWORD KmtpCreateService	(	IN PCWSTR	ServiceName,
		IN PCWSTR	ServicePath,
		IN PCWSTR DisplayName	OPTIONAL,
		IN DWORD	ServiceType,
		OUT SC_HANDLE *	ServiceHandle
	)

Definition at line 414 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
    WCHAR DriverPath[MAX_PATH];
    HRESULT result = S_OK;
 
    assert(ServiceHandle);
    assert(ServiceName && ServicePath);
 
    if (!GetModuleFileName(NULL, DriverPath, sizeof DriverPath / sizeof DriverPath[0]))
        error_goto(Error, cleanup);
 
    assert(wcsrchr(DriverPath, L'\\') != NULL);
    wcsrchr(DriverPath, L'\\')[1] = L'\0';
 
    result = StringCbCatW(DriverPath, sizeof(DriverPath), ServicePath);
    if (FAILED(result))
        error_value_goto(Error, result, cleanup);
 
    if (GetFileAttributes(DriverPath) == INVALID_FILE_ATTRIBUTES)
        error_goto(Error, cleanup);
 
    *ServiceHandle = CreateService(ScmHandle, ServiceName, DisplayName,
                                   SERVICE_ACCESS, ServiceType, SERVICE_DEMAND_START,
                                   SERVICE_ERROR_NORMAL, DriverPath, NULL, NULL, NULL, NULL, NULL);
 
    if (!*ServiceHandle)
        error_goto(Error, cleanup);
 
cleanup:
    return Error;
}

Referenced by KmtCreateService(), and KmtFltCreateService().

Variable Documentation

KmtestHandle

HANDLE KmtestHandle

extern

Definition at line 32 of file kmtest.c.

TestServiceName

WCHAR TestServiceName[MAX_PATH]

static

Definition at line 42 of file fltsupport.c.

Referenced by KmtFltAddAltitude(), KmtFltConnectComms(), KmtFltCreateService(), KmtFltLoadDriver(), KmtFltUnloadDriver(), and START_TEST().