RtlStrSafe.c File Reference

#include <kmt_test.h>
#include <ntstrsafe.h>
#include <ntdef.h>
#include <ndk/rtlfuncs.h>

Include dependency graph for RtlStrSafe.c:

Go to the source code of this file.

Macros
#define	KMT_EMULATE_KERNEL
#define	TESTAPI   static void

Functions
TESTAPI	Test_RtlUnicodeStringPrintf ()
TESTAPI	Test_RtlUnicodeStringPrintfEx ()
	START_TEST (RtlStrSafe)

Variables
static const WCHAR	FormatStringInts [] = L"%d %d %d"
static const WCHAR	FormatStringIntsResult [] = L"1 2 3"
static const WCHAR	FormatStringStrs [] = L"%s %s %s"

Macro Definition Documentation

KMT_EMULATE_KERNEL

#define KMT_EMULATE_KERNEL

Definition at line 9 of file RtlStrSafe.c.

TESTAPI

#define TESTAPI   static void

Definition at line 15 of file RtlStrSafe.c.

Function Documentation

START_TEST()

START_TEST

(

RtlStrSafe

)

Definition at line 181 of file RtlStrSafe.c.

{
    Test_RtlUnicodeStringPrintf();
    Test_RtlUnicodeStringPrintfEx();
}

Test_RtlUnicodeStringPrintf()

TESTAPI Test_RtlUnicodeStringPrintf

(

)

Definition at line 23 of file RtlStrSafe.c.

{
    NTSTATUS Status;
    PWSTR pBuffer = NULL;
    USHORT BufferSize;
    size_t EqualBytes;
    UNICODE_STRING UsString;
 
    KmtStartSeh();
 
    /* STATUS_SUCCESS test */
    BufferSize = 6 * sizeof(WCHAR);
    pBuffer = KmtAllocateGuarded(BufferSize);
    if (!pBuffer)
        goto Cleanup;
 
    RtlFillMemory(pBuffer, BufferSize, 0xAA);
    RtlInitEmptyUnicodeString(&UsString, pBuffer, BufferSize);
 
    Status = RtlUnicodeStringPrintf(&UsString, FormatStringInts, 1, 2, 3);
    EqualBytes = RtlCompareMemory(UsString.Buffer, FormatStringIntsResult, sizeof(FormatStringIntsResult));
    ok_eq_hex(Status, STATUS_SUCCESS);
    ok_eq_size(EqualBytes, sizeof(FormatStringIntsResult));
    ok_eq_uint(UsString.Length, sizeof(FormatStringIntsResult) - sizeof(WCHAR));
    ok_eq_uint(UsString.MaximumLength, BufferSize);
 
    KmtFreeGuarded(pBuffer);
    pBuffer = NULL;
 
    /* STATUS_BUFFER_OVERFLOW tests */
    BufferSize = 2 * sizeof(WCHAR);
    pBuffer = KmtAllocateGuarded(BufferSize);
    if (!pBuffer)
        goto Cleanup;
 
    RtlInitEmptyUnicodeString(&UsString, pBuffer, BufferSize);
 
    Status = RtlUnicodeStringPrintf(&UsString, FormatStringStrs, L"AAA", L"BBB", L"CCC");
    EqualBytes = RtlCompareMemory(UsString.Buffer, L"AA", BufferSize);
    ok_eq_hex(Status, STATUS_BUFFER_OVERFLOW);
    ok_eq_size(EqualBytes, BufferSize);
    ok_eq_uint(UsString.Length, UsString.MaximumLength);
 
    KmtFreeGuarded(pBuffer);
    pBuffer = NULL;
 
 
    BufferSize = 7 * sizeof(WCHAR);
    pBuffer = KmtAllocateGuarded(BufferSize);
    if (!pBuffer)
        goto Cleanup;
 
    RtlInitEmptyUnicodeString(&UsString, pBuffer, BufferSize);
 
    Status = RtlUnicodeStringPrintf(&UsString, FormatStringStrs, L"0123", L"4567", L"89AB");
    EqualBytes = RtlCompareMemory(UsString.Buffer, L"0123 45", BufferSize);
    ok_eq_hex(Status, STATUS_BUFFER_OVERFLOW);
    ok_eq_size(EqualBytes, BufferSize);
    ok_eq_uint(UsString.Length, UsString.MaximumLength);
 
    KmtFreeGuarded(pBuffer);
    pBuffer = NULL;
 
    // Note: RtlUnicodeStringPrintf returns STATUS_BUFFER_OVERFLOW here while RtlUnicodeStringPrintfEx returns STATUS_INVALID_PARAMETER!
    // Documented on MSDN and verified with the Win10 version of ntstrsafe.h
    RtlInitEmptyUnicodeString(&UsString, NULL, 0);
    Status = RtlUnicodeStringPrintf(&UsString, FormatStringStrs, L"AAA", L"BBB", L"CCC");
    ok_eq_hex(Status, STATUS_BUFFER_OVERFLOW);
 
 
Cleanup:
    if (pBuffer)
        KmtFreeGuarded(pBuffer);
 
    // None of these functions should have crashed.
    KmtEndSeh(STATUS_SUCCESS);
}

Referenced by START_TEST().

Test_RtlUnicodeStringPrintfEx()

TESTAPI Test_RtlUnicodeStringPrintfEx

(

)

Definition at line 102 of file RtlStrSafe.c.

{
    NTSTATUS Status;
    PWSTR pBuffer = NULL;
    USHORT BufferSize;
    size_t EqualBytes;
    UNICODE_STRING RemString;
    UNICODE_STRING UsString;
    WCHAR FillResult[10];
 
    RtlFillMemory(FillResult, sizeof(FillResult), 0xAA);
 
    KmtStartSeh();
 
    /* STATUS_SUCCESS test, fill behind flag: low-byte as fill character */
    BufferSize = sizeof(FormatStringIntsResult) - sizeof(UNICODE_NULL) + sizeof(FillResult);
    pBuffer = KmtAllocateGuarded(BufferSize);
    if (!pBuffer)
        goto Cleanup;
 
    RtlInitEmptyUnicodeString(&UsString, pBuffer, BufferSize);
    RtlInitEmptyUnicodeString(&RemString, NULL, 0);
 
    Status = RtlUnicodeStringPrintfEx(&UsString, &RemString, STRSAFE_FILL_BEHIND | 0xAA, FormatStringInts, 1, 2, 3);
    EqualBytes = RtlCompareMemory(UsString.Buffer, FormatStringIntsResult, sizeof(FormatStringIntsResult) - sizeof(WCHAR));
    ok_eq_hex(Status, STATUS_SUCCESS);
    ok_eq_size(EqualBytes, sizeof(FormatStringIntsResult) - sizeof(WCHAR));
    ok_eq_uint(UsString.Length, sizeof(FormatStringIntsResult) - sizeof(WCHAR));
    ok_eq_uint(UsString.MaximumLength, BufferSize);
 
    ok_eq_pointer(RemString.Buffer, &UsString.Buffer[UsString.Length / sizeof(WCHAR)]);
    ok_eq_uint(RemString.Length, 0);
    ok_eq_uint(RemString.MaximumLength, UsString.MaximumLength - UsString.Length);
 
    EqualBytes = RtlCompareMemory(RemString.Buffer, FillResult, RemString.MaximumLength);
    ok_eq_size(EqualBytes, sizeof(FillResult));
 
    KmtFreeGuarded(pBuffer);
    pBuffer = NULL;
 
 
    /* STATUS_BUFFER_OVERFLOW test  */
    BufferSize = 8 * sizeof(WCHAR);
    pBuffer = KmtAllocateGuarded(BufferSize);
    if (!pBuffer)
        goto Cleanup;
 
    RtlInitEmptyUnicodeString(&UsString, pBuffer, BufferSize);
    RtlInitEmptyUnicodeString(&RemString, NULL, 0);
 
    Status = RtlUnicodeStringPrintfEx(&UsString, &RemString, 0, FormatStringStrs, L"AAA", L"BBB", L"CCC");
    EqualBytes = RtlCompareMemory(UsString.Buffer, L"AAA BBB ", UsString.Length);
    ok_eq_hex(Status, STATUS_BUFFER_OVERFLOW);
    ok_eq_size(EqualBytes, UsString.Length);
    ok_eq_uint(UsString.Length, UsString.MaximumLength);
 
    ok_eq_pointer(RemString.Buffer, &UsString.Buffer[UsString.Length / sizeof(WCHAR)]);
    ok_eq_uint(RemString.Length, 0);
    ok_eq_uint(RemString.MaximumLength, 0);
 
    KmtFreeGuarded(pBuffer);
    pBuffer = NULL;
 
 
    // Note: RtlUnicodeStringPrintf returns STATUS_BUFFER_OVERFLOW here while RtlUnicodeStringPrintfEx returns STATUS_INVALID_PARAMETER!
    // Documented on MSDN and verified with the Win10 version of ntstrsafe.h
    RtlInitEmptyUnicodeString(&UsString, NULL, 0);
    Status = RtlUnicodeStringPrintfEx(&UsString, NULL, 0, FormatStringStrs, L"AAA", L"BBB", L"CCC");
    ok_eq_hex(Status, STATUS_INVALID_PARAMETER);
 
 
Cleanup:
    if (pBuffer)
        KmtFreeGuarded(pBuffer);
 
    // None of these functions should have crashed.
    KmtEndSeh(STATUS_SUCCESS);
}

Referenced by START_TEST().

Variable Documentation

FormatStringInts

const WCHAR FormatStringInts[] = L"%d %d %d"

static

Definition at line 17 of file RtlStrSafe.c.

Referenced by Test_RtlUnicodeStringPrintf(), and Test_RtlUnicodeStringPrintfEx().

FormatStringIntsResult

const WCHAR FormatStringIntsResult[] = L"1 2 3"

static

Definition at line 18 of file RtlStrSafe.c.

Referenced by Test_RtlUnicodeStringPrintf(), and Test_RtlUnicodeStringPrintfEx().

FormatStringStrs

const WCHAR FormatStringStrs[] = L"%s %s %s"

static

Definition at line 19 of file RtlStrSafe.c.

Referenced by Test_RtlUnicodeStringPrintf(), and Test_RtlUnicodeStringPrintfEx().