Add UTF8_STRING support (#175)

Signed-off-by: Alan Jowett <[email protected]> Co-authored-by: Alan Jowett <[email protected]>
microsoft · Mar 4, 2024 · e01d44e · e01d44e
1 parent 6459d3d
commit e01d44e
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 1 deletion.
diff --git a/inc/usersim/rtl.h b/inc/usersim/rtl.h
@@ -130,6 +130,9 @@ typedef struct _UNICODE_STRING
 } UNICODE_STRING, *PUNICODE_STRING;
 typedef const UNICODE_STRING* PCUNICODE_STRING;
 
+typedef STRING UTF8_STRING;
+typedef PSTRING PUTF8_STRING;
+
 #define DECLARE_CONST_UNICODE_STRING(_var, _string)                                                                   \
     const WCHAR _var##_buffer[] = _string;                                                                            \
     __pragma(warning(push)) __pragma(warning(disable : 4221)) __pragma(warning(disable : 4204))                       \
@@ -145,6 +148,65 @@ _IRQL_requires_max_(DISPATCH_LEVEL) _At_(destination_string->Buffer, _Post_equal
             USERSIM_API VOID NTAPI
     RtlInitUnicodeString(_Out_ PUNICODE_STRING destination_string, _In_opt_z_ __drv_aliasesMem PCWSTR source_string);
 
+_IRQL_requires_max_(DISPATCH_LEVEL)
+USERSIM_API
+VOID
+NTAPI
+RtlInitUTF8String(
+    _Out_ PUTF8_STRING DestinationString,
+    _In_opt_z_ __drv_aliasesMem const char* SourceString
+    );
+
+_IRQL_requires_max_(PASSIVE_LEVEL)
+USERSIM_API
+VOID
+NTAPI
+RtlFreeUnicodeString(
+    _Inout_ _At_(UnicodeString->Buffer, _Frees_ptr_opt_)
+        PUNICODE_STRING UnicodeString
+    );
+
+_When_(AllocateDestinationString,
+       _At_(DestinationString->MaximumLength,
+            _Out_range_(<=, (SourceString->MaximumLength / sizeof(WCHAR)))))
+_When_(!AllocateDestinationString,
+       _At_(DestinationString->Buffer, _Const_)
+       _At_(DestinationString->MaximumLength, _Const_))
+_IRQL_requires_max_(PASSIVE_LEVEL)
+_When_(AllocateDestinationString, _Must_inspect_result_)
+USERSIM_API
+NTSTATUS
+NTAPI
+RtlUnicodeStringToUTF8String(
+    _When_(AllocateDestinationString, _Out_ _At_(DestinationString->Buffer, __drv_allocatesMem(Mem)))
+    _When_(!AllocateDestinationString, _Inout_)
+        PUTF8_STRING DestinationString,
+    _In_ PCUNICODE_STRING SourceString,
+    _In_ BOOLEAN AllocateDestinationString
+    );
+
+_IRQL_requires_max_(PASSIVE_LEVEL)
+_Must_inspect_result_
+NTSYSAPI
+NTSTATUS
+NTAPI
+RtlUTF8StringToUnicodeString(
+    _When_(AllocateDestinationString, _Out_ _At_(DestinationString->Buffer, __drv_allocatesMem(Mem)))
+    _When_(!AllocateDestinationString, _Inout_)
+        PUNICODE_STRING DestinationString,
+    _In_ PUTF8_STRING SourceString,
+    _In_ BOOLEAN AllocateDestinationString
+    );
+
+_IRQL_requires_max_(PASSIVE_LEVEL)
+USERSIM_API
+void
+NTAPI
+RtlFreeUTF8String(
+    _Inout_ _At_(utf8String->Buffer, _Frees_ptr_opt_)
+        PUTF8_STRING utf8String
+    );
+
 typedef struct _OBJECT_ATTRIBUTES
 {
     ULONG Length;
@@ -167,4 +229,4 @@ USERSIM_API __analysis_noreturn void
 RtlAssertCPP(
     _In_ PVOID void_failed_assertion, _In_ PVOID void_file_name, _In_ ULONG line_number, _In_opt_ PSTR mutable_message);
 
-#endif
+#endif
diff --git a/tests/rtl_test.cpp b/tests/rtl_test.cpp
@@ -83,4 +83,30 @@ TEST_CASE("RtlInitUnicodeString", "[rtl]")
     REQUIRE(unicode_string.Buffer == buffer);
     REQUIRE(unicode_string.Length == 8);
     REQUIRE(unicode_string.MaximumLength == 10);
+}
+
+TEST_CASE("RtlUnicodeStringToUTF8String", "[rtl]")
+{
+    UNICODE_STRING unicode_string = {0};
+    RtlInitUnicodeString(&unicode_string, L"test");
+    UTF8_STRING utf8_string = {0};
+    REQUIRE(RtlUnicodeStringToUTF8String(&utf8_string, &unicode_string, TRUE) == STATUS_SUCCESS);
+    REQUIRE(utf8_string.Buffer != nullptr);
+    REQUIRE(utf8_string.Length == 4);
+    REQUIRE(utf8_string.MaximumLength == 5);
+    REQUIRE(strcmp(utf8_string.Buffer, "test") == 0);
+    RtlFreeUTF8String(&utf8_string);
+}
+
+TEST_CASE("RtlUTF8StringToUnicodeString", "[rtl]")
+{
+    UTF8_STRING utf8_string = {0};
+    RtlInitUTF8String(&utf8_string, "test");
+    UNICODE_STRING unicode_string = {0};
+    REQUIRE(RtlUTF8StringToUnicodeString(&unicode_string, &utf8_string, TRUE) == STATUS_SUCCESS);
+    REQUIRE(unicode_string.Buffer != nullptr);
+    REQUIRE(unicode_string.Length == 8);
+    REQUIRE(unicode_string.MaximumLength == 10);
+    REQUIRE(wcscmp(unicode_string.Buffer, L"test") == 0);
+    RtlFreeUnicodeString(&unicode_string);
 }