Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(developer): prevent buffer overrun in u16tok #11910

Merged
merged 2 commits into from
Jul 23, 2024
Merged

fix(developer): prevent buffer overrun in u16tok #11910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69d8b30
fix(developer): prevent buffer overrun in `u16tok`
mcdurdin Jul 2, 2024
b15b10c
Merge branch 'master' into fix/developer/11814-kmx_u16-buffer-overrun
mcdurdin Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions developer/src/kmcmplib/src/kmx_u16.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ KMX_WCHAR * u16tok(KMX_WCHAR *p, const KMX_WCHAR ch, KMX_WCHAR **ctx) {
else {
*ctx = NULL;
}
return p;
return *p ? p : NULL;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prevents delimiters at end of string from returning an empty string. (Matching strtok behaviour)

}

KMX_WCHAR * u16tok(KMX_WCHAR* p, const KMX_WCHAR* delim, KMX_WCHAR** ctx) {
Expand All @@ -259,13 +259,13 @@ KMX_WCHAR * u16tok(KMX_WCHAR* p, const KMX_WCHAR* delim, KMX_WCHAR** ctx) {
if (*q) {
*q = 0;
q++;
while (u16chr(delim, *q)) q++;
while (*q && u16chr(delim, *q)) q++;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prevent buffer overrun

*ctx = q;
}
else {
*ctx = NULL;
}
return p;
return *p ? p : NULL;
}

double u16tof( KMX_WCHAR* str)
Expand Down
60 changes: 60 additions & 0 deletions developer/src/kmcmplib/tests/gtest-kmx_u16-test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
#include <gtest/gtest.h>
#include "../src/kmx_u16.h"

/*class kmx_u16_Test : public testing::Test {
protected:
kmx_u16_Test() {}
~kmx_u16_Test() override {}
void SetUp() override {}
void TearDown() override {}
};*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these stubs needed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really, but we may need them again soon as we extend the tests.


TEST(kmx_u16_Test, u16tok_char_delim) {
// For char delimiter: KMX_WCHAR * u16tok(KMX_WCHAR *p, const KMX_WCHAR ch, KMX_WCHAR **ctx) ;

KMX_WCHAR *ctx = nullptr;
EXPECT_EQ(nullptr, u16tok(nullptr, ' ', &ctx));

KMX_WCHAR buffer[128] = u"test a space and two";
EXPECT_TRUE(!u16cmp(u"test", u16tok(buffer, ' ', &ctx)));
EXPECT_TRUE(!u16cmp(u"a", u16tok(nullptr, ' ', &ctx)));
EXPECT_TRUE(!u16cmp(u"space", u16tok(nullptr, ' ', &ctx)));
EXPECT_TRUE(!u16cmp(u"and", u16tok(nullptr, ' ', &ctx)));
EXPECT_TRUE(!u16cmp(u"two", u16tok(nullptr, ' ', &ctx)));

KMX_WCHAR buffer_space[128] = u" ";
EXPECT_EQ(nullptr, u16tok(buffer_space, ' ', &ctx));
EXPECT_EQ(nullptr, u16tok(nullptr, ' ', &ctx));
}

TEST(kmx_u16_Test, u16tok_str_delim) {
// For string delimiter: KMX_WCHAR * u16tok(KMX_WCHAR* p, const KMX_WCHAR* ch, KMX_WCHAR** ctx) ;

KMX_WCHAR *ctx = nullptr;
EXPECT_EQ(nullptr, u16tok(nullptr, u" ", &ctx));

KMX_WCHAR buffer[128] = u"test a space and two";
EXPECT_TRUE(!u16cmp(u"test", u16tok(buffer, u" ", &ctx)));
EXPECT_TRUE(!u16cmp(u"a", u16tok(nullptr, u" ", &ctx)));
EXPECT_TRUE(!u16cmp(u"space", u16tok(nullptr, u" ", &ctx)));
EXPECT_TRUE(!u16cmp(u"and", u16tok(nullptr, u" ", &ctx)));
EXPECT_TRUE(!u16cmp(u"two", u16tok(nullptr, u" ", &ctx)));

KMX_WCHAR buffer_space[128] = u" ";
EXPECT_EQ(nullptr, u16tok(buffer_space, u" ", &ctx));
EXPECT_EQ(nullptr, u16tok(nullptr, u" ", &ctx));
}

TEST(kmx_u16_Test, u16tok_str_compare_to_strtok) {
// Compare behaviour of strtok:
char sbuffer[128] = "test a space and two";
EXPECT_TRUE(!strcmp("test", strtok(sbuffer, " ")));
EXPECT_TRUE(!strcmp("a", strtok(nullptr, " ")));
EXPECT_TRUE(!strcmp("space", strtok(nullptr, " ")));
EXPECT_TRUE(!strcmp("and", strtok(nullptr, " ")));
EXPECT_TRUE(!strcmp("two", strtok(nullptr, " ")));

char sbuffer_space[128] = " ";
EXPECT_EQ(nullptr, strtok(sbuffer_space, " "));
EXPECT_EQ(nullptr, strtok(nullptr, " "));
}
13 changes: 12 additions & 1 deletion developer/src/kmcmplib/tests/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,4 +177,15 @@ gtestcompmsgtest = executable('gtest-compmsg-test', 'gtest-compmsg-test.cpp',
dependencies: [ icuuc_dep, gtest_dep, gmock_dep ],
)

test('gtest-compmsg-test', gtestcompmsgtest)
test('gtest-compmsg-test', gtestcompmsgtest)

gtestkmx_u16test = executable('gtest-kmx_u16-test', 'gtest-kmx_u16-test.cpp',
cpp_args: defns + flags,
include_directories: inc,
name_suffix: name_suffix,
link_args: links + tests_links,
objects: lib.extract_all_objects(),
dependencies: [ icuuc_dep, gtest_dep, gmock_dep ],
)

test('gtest-kmx_u16-test', gtestkmx_u16test)
Loading