fortify: Add KUnit tests for runtime overflows
Subsystems (8)
v2 cover fortify: Add KUnit tests for runtime overflows
Hi,
This series adds KUnit tests for the CONFIG_FORTIFY_SOURCE behavior of the standard C string functions, and for the strcat() family of functions, as those were updated during refactoring. Finally, fortification error messages are improved to give more context for the failure condition.
-Kees
v2:
- fix From/SoB
- strcat: force non-const length arguments (lkp)
- fix x86 and arm fortify_panic prototypes (lkp)
- move test-skip to init function (dlatypov)
- constify p_size, q_size everywhere (miguel)
- enum-ify, string-ify, bit-ify function name passing (aleksander & andy)
v1: https://lore.kernel.org/lkml/[email protected]/
Kees Cook (10):
kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
fortify: Allow KUnit test to build without FORTIFY
string: Add Kunit tests for strcat() family
fortify: Use const variables for __member_size tracking
fortify: Add protection for strlcat()
fortify: strcat: Move definition to use fortified strlcat()
fortify: Split reporting and avoid passing string pointer
fortify: Provide KUnit counters for failure testing
fortify: Add KUnit tests for runtime overflows
fortify: Improve buffer overflow reporting
MAINTAINERS | 1 + arch/arm/boot/compressed/misc.c | 2 +- arch/x86/boot/compressed/misc.c | 2 +- include/linux/fortify-string.h | 257 +++++-- lib/Kconfig.debug | 7 +- lib/Makefile | 1 + lib/fortify_kunit.c | 731 +++++++++++++++++++ lib/strcat_kunit.c | 104 +++ lib/string_helpers.c | 26 +- tools/objtool/check.c | 2 +- tools/testing/kunit/configs/all_tests.config | 2 + tools/testing/kunit/configs/arch_uml.config | 3 + 12 files changed, 1059 insertions(+), 79 deletions(-) create mode 100644 lib/strcat_kunit.c
Signature · 1 line
2.34.1
PATCH v2 1/10 kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
Since commit ba38961a069b ("um: Enable FORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. Enable CONFIG_FORTIFY_SOURCE when running with --altests to gain additional coverage, and by default under UML.
--- tools/testing/kunit/configs/all_tests.config | 2 ++ tools/testing/kunit/configs/arch_uml.config | 3 +++ 2 files changed, 5 insertions(+)
tools/testing/kunit/configs/all_tests.config +2 -0
@@ -9,6 +9,8 @@ CONFIG_KUNIT=y CONFIG_KUNIT_EXAMPLE_TEST=y CONFIG_KUNIT_ALL_TESTS=y +CONFIG_FORTIFY_SOURCE=y + CONFIG_IIO=y CONFIG_EXT4_FS=y
tools/testing/kunit/configs/arch_uml.config +3 -0
@@ -3,3 +3,6 @@ # Enable virtio/pci, as a lot of tests require it. CONFIG_VIRTIO_UML=y CONFIG_UML_PCI_OVER_VIRTIO=y + +# Enable FORTIFY_SOURCE for wider checking. +CONFIG_FORTIFY_SOURCE=y
Signature · 1 line
2.34.1
Re: [PATCH v2 01/10] kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
Quoted 4 lines · Kees Cook
Since commit
ba38961a069b("um: EnableFORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. EnableCONFIG_FORTIFY_SOURCEwhen running with --altests to gain additional coverage, and by default under
two L's in alltest?
Quoted 35 lines
UML.
Signed-off-by Kees Cook <[email protected]>--- tools/testing/kunit/configs/all_tests.config | 2 ++ tools/testing/kunit/configs/arch_uml.config | 3 +++ 2 files changed, 5 insertions(+)tools/testing/kunit/configs/all_tests.config +2
-0@@ -9,6 +9,8 @@ CONFIG_KUNIT=y CONFIG_KUNIT_EXAMPLE_TEST=y CONFIG_KUNIT_ALL_TESTS=y +CONFIG_FORTIFY_SOURCE=y + CONFIG_IIO=y CONFIG_EXT4_FS=ytools/testing/kunit/configs/arch_uml.config +3
-1@@ -3,3 +3,6 @@ # Enable virtio/pci, as a lot of tests require it. CONFIG_VIRTIO_UML=y CONFIG_UML_PCI_OVER_VIRTIO=y + +# Enable FORTIFY_SOURCE for wider checking. +CONFIG_FORTIFY_SOURCE=y --2.34.1
Signature · 2 lines
Thanks, ~Nick Desaulniers
Re: [PATCH v2 01/10] kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
Quoted 8 lines · Nick Desaulniers
Quoted 4 lines · Kees Cook
Since commit
ba38961a069b("um: EnableFORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. EnableCONFIG_FORTIFY_SOURCEwhen running with --altests to gain additional coverage, and by default undertwo L's in alltest?
Also, while testing this series:
```
$ LLVM=1 ./tools/testing/kunit/kunit.py run
...
[16:40:09] ================== fortify (24 subtests) ===================
[16:40:09] [PASSED] known_sizes_test
[16:40:09] [PASSED] control_flow_split_test
[16:40:09] [PASSED] alloc_size_kmalloc_const_test
[16:40:09] # alloc_size_kmalloc_dynamic_test: EXPECTATION FAILED
at lib/fortify_kunit.c:249
[16:40:09] Expected __builtin_dynamic_object_size(p, 1) == expected, but
[16:40:09] __builtin_dynamic_object_size(p, 1) == -1
(0xffffffffffffffff)
[16:40:09] expected == 11 (0xb)
[16:40:09] __alloc_size() not working with __bdos on kmemdup("hello
there", len, gfp)
[16:40:09] [FAILED] alloc_size_kmalloc_dynamic_test
[16:40:09] [PASSED] alloc_size_vmalloc_const_test
[16:40:09] [PASSED] alloc_size_vmalloc_dynamic_test
[16:40:09] [PASSED] alloc_size_kvmalloc_const_test
[16:40:09] [PASSED] alloc_size_kvmalloc_dynamic_test
[16:40:09] [PASSED] alloc_size_devm_kmalloc_const_test
[16:40:09] [PASSED] alloc_size_devm_kmalloc_dynamic_test
[16:40:09] [PASSED] strlen_test
[16:40:09] [PASSED] strnlen_test
[16:40:09] [PASSED] strcpy_test
[16:40:09] [PASSED] strncpy_test
[16:40:09] [PASSED] strlcpy_test
[16:40:09] [PASSED] strscpy_test
[16:40:09] [PASSED] strcat_test
[16:40:09] [PASSED] strncat_test
[16:40:09] [PASSED] strlcat_test
[16:40:09] [PASSED] memscan_test
[16:40:09] [PASSED] memchr_test
[16:40:09] [PASSED] memchr_inv_test
[16:40:09] [PASSED] memcmp_test
[16:40:09] [PASSED] kmemdup_test
[16:40:09] # fortify: pass:23 fail:1 skip:0 total:24
[16:40:09] # Totals: pass:23 fail:1 skip:0 total:24
[16:40:09] ===================== [FAILED] fortify =====================
```It would be cool to understand that failure in BDOS BEFORE turning on these tests by default.
Quoted 41 lines
Quoted 34 lines
UML.
Signed-off-by Kees Cook <[email protected]>--- tools/testing/kunit/configs/all_tests.config | 2 ++ tools/testing/kunit/configs/arch_uml.config | 3 +++ 2 files changed, 5 insertions(+)tools/testing/kunit/configs/all_tests.config +2
-0@@ -9,6 +9,8 @@ CONFIG_KUNIT=y CONFIG_KUNIT_EXAMPLE_TEST=y CONFIG_KUNIT_ALL_TESTS=y +CONFIG_FORTIFY_SOURCE=y + CONFIG_IIO=y CONFIG_EXT4_FS=ytools/testing/kunit/configs/arch_uml.config +3
-1@@ -3,3 +3,6 @@ # Enable virtio/pci, as a lot of tests require it. CONFIG_VIRTIO_UML=y CONFIG_UML_PCI_OVER_VIRTIO=y + +# Enable FORTIFY_SOURCE for wider checking. +CONFIG_FORTIFY_SOURCE=y --Quoted 2 lines
2.34.1
--
Thanks,
~Nick Desaulniers
Signature · 2 lines
Thanks, ~Nick Desaulniers
Re: [PATCH v2 01/10] kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
Quoted 12 lines · Nick Desaulniers
Quoted 8 lines · Nick Desaulniers
Quoted 4 lines · Kees Cook
Since commit
ba38961a069b("um: EnableFORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. EnableCONFIG_FORTIFY_SOURCEwhen running with --altests to gain additional coverage, and by default undertwo L's in alltest?
Also, while testing this series:
```
Quoted 14 lines
$ LLVM=1 ./tools/testing/kunit/kunit.py run
...
[16:40:09] ================== fortify (24 subtests) ===================
[16:40:09] [PASSED] known_sizes_test
[16:40:09] [PASSED] control_flow_split_test
[16:40:09] [PASSED] alloc_size_kmalloc_const_test
[16:40:09] # alloc_size_kmalloc_dynamic_test: EXPECTATION FAILED
at lib/fortify_kunit.c:249
[16:40:09] Expected __builtin_dynamic_object_size(p, 1) == expected, but
[16:40:09] __builtin_dynamic_object_size(p, 1) == -1
(0xffffffffffffffff)
[16:40:09] expected == 11 (0xb)
[16:40:09] __alloc_size() not working with __bdos on kmemdup("hello
there", len, gfp)I'm still tracking this down. I'm not sure what's happening here, but it seems to be Clang-specific, and due to some interaction with the changes I made for Kunit examination. WHY it happens I haven't found yet.
Signature · 1 line
Kees Cook
Re: [PATCH v2 01/10] kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
Quoted 29 lines · Kees Cook
Quoted 12 lines · Nick Desaulniers
Quoted 8 lines · Nick Desaulniers
Quoted 4 lines · Kees Cook
Since commit
ba38961a069b("um: EnableFORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. EnableCONFIG_FORTIFY_SOURCEwhen running with --altests to gain additional coverage, and by default undertwo L's in alltest?
Also, while testing this series:
```Quoted 14 lines
$ LLVM=1 ./tools/testing/kunit/kunit.py run ... [16:40:09] ================== fortify (24 subtests) =================== [16:40:09] [PASSED] known_sizes_test [16:40:09] [PASSED] control_flow_split_test [16:40:09] [PASSED] alloc_size_kmalloc_const_test [16:40:09] # alloc_size_kmalloc_dynamic_test: EXPECTATION FAILED at lib/fortify_kunit.c:249 [16:40:09] Expected __builtin_dynamic_object_size(p, 1) == expected, but [16:40:09] __builtin_dynamic_object_size(p, 1) == -1 (0xffffffffffffffff) [16:40:09] expected == 11 (0xb) [16:40:09] __alloc_size() not working with __bdos on kmemdup("hello there", len, gfp)
Quoted 3 lines
I'm still tracking this down. I'm not sure what's happening here, but it seems to be Clang-specific, and due to some interaction with the changes I made for Kunit examination. WHY it happens I haven't found yet.
Was this what exposed https://github.com/llvm/llvm-project/issues/62789?
Signature · 2 lines
Thanks, ~Nick Desaulniers
Re: [PATCH v2 01/10] kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
Quoted 30 lines · Nick Desaulniers
Quoted 29 lines · Kees Cook
Quoted 26 lines · Nick Desaulniers
Quoted 8 lines · Nick Desaulniers
Quoted 4 lines · Kees Cook
Since commit
ba38961a069b("um: EnableFORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. EnableCONFIG_FORTIFY_SOURCEwhen running with --altests to gain additional coverage, and by default undertwo L's in alltest?
Also, while testing this series:
```$ LLVM=1 ./tools/testing/kunit/kunit.py run ... [16:40:09] ================== fortify (24 subtests) =================== [16:40:09] [PASSED] known_sizes_test [16:40:09] [PASSED] control_flow_split_test [16:40:09] [PASSED] alloc_size_kmalloc_const_test [16:40:09] # alloc_size_kmalloc_dynamic_test: EXPECTATION FAILED at lib/fortify_kunit.c:249 [16:40:09] Expected __builtin_dynamic_object_size(p, 1) == expected, but [16:40:09] __builtin_dynamic_object_size(p, 1) == -1 (0xffffffffffffffff) [16:40:09] expected == 11 (0xb) [16:40:09] __alloc_size() not working with __bdos on kmemdup("hello there", len, gfp)
Quoted 5 lines
Quoted 3 lines
I'm still tracking this down. I'm not sure what's happening here, but it seems to be Clang-specific, and due to some interaction with the changes I made for Kunit examination. WHY it happens I haven't found yet.
Was this what exposed https://github.com/llvm/llvm-project/issues/62789?
Nope -- I found this while working on:
https://lore.kernel.org/lkml/[email protected]/
i.e. I was surprised I could use static initializers with a flexible array, and then I went and verified various related behaviors between GCC and Clang.
Signature · 1 line
Kees Cook
Re: [PATCH v2 01/10] kunit: tool: Enable CONFIG_FORTIFY_SOURCE under UML
In reply to Nick DesaulniersQuoted 7 lines · Nick Desaulniers
Quoted 4 lines · Kees Cook
Since commit
ba38961a069b("um: EnableFORTIFY_SOURCE"), it's possible to run the FORTIFY tests under UML. EnableCONFIG_FORTIFY_SOURCEwhen running with --altests to gain additional coverage, and by default undertwo L's in alltest?
Oops. Fixed. :)
Signature · 1 line
Kees Cook
PATCH v2 2/10 fortify: Allow KUnit test to build without FORTIFY
In reply to Kees CookIn order for CI systems to notice all the skipped tests related to CONFIG_FORTIFY_SOURCE, allow the FORTIFY_SOURCE KUnit tests to build with or without CONFIG_FORTIFY_SOURCE.
--- lib/Kconfig.debug | 2 +- lib/fortify_kunit.c | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-)
lib/Kconfig.debug +1 -1
@@ -2614,7 +2614,7 @@ config STACKINIT_KUNIT_TEST config FORTIFY_KUNIT_TEST tristate "Test fortified str*() and mem*() function internals at runtime" if !KUNIT_ALL_TESTS - depends on KUNIT && FORTIFY_SOURCE + depends on KUNIT default KUNIT_ALL_TESTS help Builds unit tests for checking internals of FORTIFY_SOURCE as used
lib/fortify_kunit.c +14 -0
@@ -25,6 +25,11 @@ static const char array_of_10[] = "this is 10";static const char *ptr_of_11 ="this is 11!" ;static char array_unknown[] ="compiler thinks I might change" ; +/* Handle being built without CONFIG_FORTIFY_SOURCE */ +#ifndef __compiletime_strlen +# define __compiletime_strlen __builtin_strlen +#endif +static void known_sizes_test (struct kunit *test) {KUNIT_EXPECT_EQ (test,__compiletime_strlen ("88888888" ),8 );
@@ -307,6 +312,14 @@ DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) }while (0 ) DEFINE_ALLOC_SIZE_TEST_PAIR(devm_kmalloc) +static int fortify_test_init (struct kunit *test) +{ +if (!IS_ENABLED (CONFIG_FORTIFY_SOURCE )) +kunit_skip (test,"Not built with CONFIG_FORTIFY_SOURCE=y" ); + +return 0 ; +} +static struct kunit_case fortify_test_cases[] = {KUNIT_CASE (known_sizes_test),KUNIT_CASE (control_flow_split_test),
@@ -323,6 +336,7 @@ static struct kunit_case fortify_test_cases[] = {static struct kunit_suite fortify_test_suite = { .name ="fortify" , + .init = fortify_test_init, .test_cases = fortify_test_cases, };
Signature · 1 line
2.34.1
Re: [PATCH v2 02/10] fortify: Allow KUnit test to build without FORTIFY
Hi Kees,
Quoted 5 lines · Kees Cook
In order for CI systems to notice all the skipped tests related to
CONFIG_FORTIFY_SOURCE, allow theFORTIFY_SOURCEKUnit tests to build with or withoutCONFIG_FORTIFY_SOURCE.Signed-off-by Kees Cook <[email protected]>
Thanks for your patch, which is now commit a9dc8d0442294b42 ("fortify: Allow KUnit test to build without FORTIFY") upstream.
lib/Kconfig.debug config STACKINIT_KUNIT_TEST · line 2617
Quoted 8 lines
lib/Kconfig.debug +1
-1@@ -2614,7 +2614,7 @@ config STACKINIT_KUNIT_TEST config FORTIFY_KUNIT_TEST tristate "Test fortified str*() and mem*() function internals at runtime" if !KUNIT_ALL_TESTS - depends on KUNIT && FORTIFY_SOURCE + depends on KUNIT
All other tests depend on the functionality they test. Which makes sense, as you only want to test the functionality that is available in the kernel you want to run.
Quoted 9 lines
lib/Kconfig.debug +0
-0default KUNIT_ALL_TESTS help Builds unit tests for checking internals of FORTIFY_SOURCE as usedlib/fortify_kunit.c +0
-0
lib/fortify_kunit.c DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) · line 318
Quoted 7 lines
lib/fortify_kunit.c +4
-0@@ -307,6 +312,14 @@ DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) }while (0 ) DEFINE_ALLOC_SIZE_TEST_PAIR(devm_kmalloc) +static int fortify_test_init (struct kunit *test) +{ +if (!IS_ENABLED (CONFIG_FORTIFY_SOURCE )) +kunit_skip (test,"Not built with CONFIG_FORTIFY_SOURCE=y" );
I was greeted by this message, which wasn't that helpful, as CONFIG_FORTIFY_SOURCE depends on CONFIG_ARCH_HAS_FORTIFY_SOURCE, which is not available yet on all architectures.
So I think the proper thing to do is to revert this patch. Thanks!
lib/fortify_kunit.c DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) · line 325
Quoted 7 lines
lib/fortify_kunit.c +4
-0+ +return 0 ; +} +static struct kunit_case fortify_test_cases[] = {KUNIT_CASE (known_sizes_test),KUNIT_CASE (control_flow_split_test),
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Re: [PATCH v2 02/10] fortify: Allow KUnit test to build without FORTIFY
Quoted 16 lines · Geert Uytterhoeven
Hi Kees,
Quoted 5 lines · Kees Cook
In order for CI systems to notice all the skipped tests related to
CONFIG_FORTIFY_SOURCE, allow theFORTIFY_SOURCEKUnit tests to build with or withoutCONFIG_FORTIFY_SOURCE.Signed-off-by Kees Cook <[email protected]>Thanks for your patch, which is now commit
a9dc8d0442294b42("fortify: Allow KUnit test to build without FORTIFY") upstream.Quoted 4 lines
lib/Kconfig.debug +0
-0@@ -2614,7 +2614,7 @@ config STACKINIT_KUNIT_TEST
Quoted 8 lines
lib/Kconfig.debug config STACKINIT_KUNIT_TEST · line 2617
Quoted 4 lines
lib/Kconfig.debug +1
-1config FORTIFY_KUNIT_TEST tristate "Test fortified str*() and mem*() function internals at runtime" if !KUNIT_ALL_TESTS - depends on KUNIT && FORTIFY_SOURCE + depends on KUNITAll other tests depend on the functionality they test. Which makes sense, as you only want to test the functionality that is available in the kernel you want to run.
Yeah, that is true for KUnit.
Quoted 22 lines
Quoted 10 lines
lib/Kconfig.debug +0
-0default KUNIT_ALL_TESTS help Builds unit tests for checking internals of FORTIFY_SOURCE as usedlib/fortify_kunit.c +0
-0lib/fortify_kunit.c DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) · line 318
Quoted 7 lines
lib/fortify_kunit.c +4
-0@@ -307,6 +312,14 @@ DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) }while (0 ) DEFINE_ALLOC_SIZE_TEST_PAIR(devm_kmalloc) +static int fortify_test_init (struct kunit *test) +{ +if (!IS_ENABLED (CONFIG_FORTIFY_SOURCE )) +kunit_skip (test,"Not built with CONFIG_FORTIFY_SOURCE=y" );I was greeted by this message, which wasn't that helpful, as
CONFIG_FORTIFY_SOURCEdepends onCONFIG_ARCH_HAS_FORTIFY_SOURCE, which is not available yet on all architectures.
Quoted 2 lines
So I think the proper thing to do is to revert this patch. Thanks!
I created this patch so that I could add CONFIG_FORTIFY_SOURCE support to UML, but you have a good point about other archs. I'll prepare a revert.
Signature · 1 line
Kees Cook
PATCH v2 3/10 string: Add Kunit tests for strcat() family
In reply to Kees CookAdd tests to make sure the strcat() family of functions behave correctly.
--- MAINTAINERS | 1 + lib/Kconfig.debug | 5 +++ lib/Makefile | 1 + lib/strcat_kunit.c | 104 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 111 insertions(+) create mode 100644 lib/strcat_kunit.c
MAINTAINERS +1 -0
@@ -8021,6 +8021,7 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git for-next/har F: include/linux/fortify-string.h F: lib/fortify_kunit.c F: lib/memcpy_kunit.c +F: lib/strcat_kunit.c F: lib/strscpy_kunit.c F: lib/test_fortify/* F: scripts/test_fortify.sh
lib/Kconfig.debug +5 -0
@@ -2631,6 +2631,11 @@ config HW_BREAKPOINT_KUNIT_TEST If unsure, say N. +config STRCAT_KUNIT_TEST + tristate "Test strcat() family of functions at runtime" if !KUNIT_ALL_TESTS + depends on KUNIT + default KUNIT_ALL_TESTS + config STRSCPY_KUNIT_TEST tristate "Test strscpy*() family of functions at runtime" if !KUNIT_ALL_TESTS depends on KUNIT
lib/Makefile +1 -0
@@ -389,6 +389,7 @@ obj-$(CONFIG_STACKINIT_KUNIT_TEST) += stackinit_kunit.o CFLAGS_fortify_kunit.o += $(call cc-disable-warning, unsequenced) CFLAGS_fortify_kunit.o += $(DISABLE_STRUCTLEAK_PLUGIN) obj-$(CONFIG_FORTIFY_KUNIT_TEST) += fortify_kunit.o +obj-$(CONFIG_STRCAT_KUNIT_TEST) += strcat_kunit.o obj-$(CONFIG_STRSCPY_KUNIT_TEST) += strscpy_kunit.o obj-$(CONFIG_SIPHASH_KUNIT_TEST) += siphash_kunit.o
lib/strcat_kunit.c new file +104 -0
104 lines not on this page · raw message
Signature · 1 line
2.34.1
PATCH v2 4/10 fortify: Use const variables for __member_size tracking
In reply to Kees CookThe sizes reported by __member_size should never change in a given function. Mark them as such.
--- include/linux/fortify-string.h | 42 +++++++++++++++++----------------- 1 file changed, 21 insertions(+), 21 deletions(-)
include/linux/fortify-string.h +21 -21
@@ -20,7 +20,7 @@ void __write_overflow_field(size_t avail, size_t wanted) __compiletime_warning(" ({ \ char *__p = (char *)(p); \ size_t __ret = SIZE_MAX; \ - size_t __p_size = __member_size(p); \ + const size_t __p_size = __member_size(p); \ if (__p_size != SIZE_MAX && \ __builtin_constant_p(*__p)) { \ size_t __p_len = __p_size - 1; \
@@ -142,7 +142,7 @@ extern char *__underlying_strncpy(char *p, const char *q, __kernel_size_t size) __FORTIFY_INLINE __diagnose_as(__builtin_strncpy, 1, 2, 3) char *strncpy(char * const POS p, const char *q, __kernel_size_t size) { - size_t p_size = __member_size(p); + const size_t p_size = __member_size(p); if (__compiletime_lessthan(p_size, size)) __write_overflow();
@@ -169,7 +169,7 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size) __FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) char *strcat(char * const POS p, const char *q) { - size_t p_size = __member_size(p); + const size_t p_size = __member_size(p); if (p_size == SIZE_MAX) return __underlying_strcat(p, q);
@@ -191,8 +191,8 @@ extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(st*/ __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size_t maxlen) { -size_t p_size =__member_size (p); -size_t p_len =__compiletime_strlen (p); +const size_t p_size =__member_size (p); +const size_t p_len =__compiletime_strlen (p);size_t ret;/* We can take compile-time actions when maxlen is const. */
@@ -233,8 +233,8 @@ __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size __FORTIFY_INLINE __diagnose_as(__builtin_strlen, 1) __kernel_size_t __fortify_strlen(const char * const POS p) { + const size_t p_size = __member_size(p); __kernel_size_t ret; - size_t p_size = __member_size(p); /* Give up if we don't know how large p is. */ if (p_size == SIZE_MAX)
@@ -267,8 +267,8 @@ extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy);*/ __FORTIFY_INLINE size_t strlcpy(char * const POS p, const char * const POS q, size_t size) { -size_t p_size =__member_size (p); -size_t q_size =__member_size (q); +const size_t p_size =__member_size (p); +const size_t q_size =__member_size (q);size_t q_len;/* Full count of source string length. */ size_t len;/* Count of characters going into destination. */
@@ -318,10 +318,10 @@ extern ssize_t __real_strscpy(char *, const char *, size_t) __RENAME(strscpy);*/ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, size_t size) { -size_t len;/* Use string size rather than possible enclosing struct size. */ -size_t p_size =__member_size (p); -size_t q_size =__member_size (q); +const size_t p_size =__member_size (p); +const size_t q_size =__member_size (q); +size_t len;/* If we cannot get size of p and q default to call strscpy. */ if (p_size ==SIZE_MAX && q_size ==SIZE_MAX )
@@ -394,9 +394,9 @@ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, s __FORTIFY_INLINE __diagnose_as(__builtin_strncat, 1, 2, 3) char *strncat(char * const POS p, const char * const POS q, __kernel_size_t count) { + const size_t p_size = __member_size(p); + const size_t q_size = __member_size(q); size_t p_len, copy_len; - size_t p_size = __member_size(p); - size_t q_size = __member_size(q); if (p_size == SIZE_MAX && q_size == SIZE_MAX) return __underlying_strncat(p, q, count);
@@ -639,7 +639,7 @@ __FORTIFY_INLINE bool fortify_memcpy_chk(__kernel_size_t size,extern void *__real_memscan (void *,int ,__kernel_size_t )__RENAME (memscan); __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size) { -size_t p_size =__struct_size (p); +const size_t p_size =__struct_size (p);if (__compiletime_lessthan (p_size, size))__read_overflow ();
@@ -651,8 +651,8 @@ __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size) __FORTIFY_INLINE __diagnose_as(__builtin_memcmp, 1, 2, 3) int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t size) { - size_t p_size = __struct_size(p); -size_t q_size =__struct_size (q); +const size_t p_size =__struct_size (p); +const size_t q_size =__struct_size (q); if (__builtin_constant_p(size)) {if (__compiletime_lessthan (p_size, size))
@@ -668,7 +668,7 @@ int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t __FORTIFY_INLINE __diagnose_as(__builtin_memchr, 1, 2, 3) void *memchr(const void * const POS0 p, int c, __kernel_size_t size) { - size_t p_size = __struct_size(p); + const size_t p_size = __struct_size(p); if (__compiletime_lessthan(p_size, size)) __read_overflow();
@@ -680,7 +680,7 @@ void *memchr(const void * const POS0 p, int c, __kernel_size_t size)void *__real_memchr_inv (const void *s,int c,size_t n)__RENAME (memchr_inv); __FORTIFY_INLINE void *memchr_inv(const void * const POS0 p, int c, size_t size) { -size_t p_size =__struct_size (p); +const size_t p_size =__struct_size (p);if (__compiletime_lessthan (p_size, size))__read_overflow ();
@@ -693,7 +693,7 @@ extern void *__real_kmemdup(const void *src, size_t len, gfp_t gfp) __RENAME(kme__realloc_size (2 ); __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfp) { -size_t p_size =__struct_size (p); +const size_t p_size =__struct_size (p);if (__compiletime_lessthan (p_size, size))__read_overflow ();
@@ -720,8 +720,8 @@ __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfp __FORTIFY_INLINE __diagnose_as(__builtin_strcpy, 1, 2) char *strcpy(char * const POS p, const char * const POS q) { - size_t p_size = __member_size(p); - size_t q_size = __member_size(q); + const size_t p_size = __member_size(p); + const size_t q_size = __member_size(q); size_t size; /* If neither buffer size is known, immediately give up. */
Signature · 1 line
2.34.1
Re: [PATCH v2 04/10] fortify: Use const variables for __member_size tracking
Quoted 7 lines · Kees Cook
The sizes reported by
__member_sizeshould never change in a given function. Mark them as such.Suggested-by Miguel Ojeda <[email protected]>Signed-off-by Kees Cook <[email protected]>
Thanks for the patch!
Quoted 154 lines
--- include/linux/fortify-string.h | 42 +++++++++++++++++----------------- 1 file changed, 21 insertions(+), 21 deletions(-)include/linux/fortify-string.h +21
-22@@ -20,7 +20,7 @@ void __write_overflow_field(size_t avail, size_t wanted) __compiletime_warning(" ({ \ char *__p = (char *)(p); \ size_t __ret = SIZE_MAX; \ - size_t __p_size = __member_size(p); \ + const size_t __p_size = __member_size(p); \ if (__p_size != SIZE_MAX && \ __builtin_constant_p(*__p)) { \ size_t __p_len = __p_size - 1; \@@ -142,7 +142,7 @@ extern char *__underlying_strncpy(char *p, const char *q, __kernel_size_t size) __FORTIFY_INLINE __diagnose_as(__builtin_strncpy, 1, 2, 3) char *strncpy(char * const POS p, const char *q, __kernel_size_t size) { - size_t p_size = __member_size(p); + const size_t p_size = __member_size(p); if (__compiletime_lessthan(p_size, size)) __write_overflow();@@ -169,7 +169,7 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size) __FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) char *strcat(char * const POS p, const char *q) { - size_t p_size = __member_size(p); + const size_t p_size = __member_size(p); if (p_size == SIZE_MAX) return __underlying_strcat(p, q);@@ -191,8 +191,8 @@ extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(st*/ __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size_t maxlen) { -size_t p_size =__member_size (p); -size_t p_len =__compiletime_strlen (p); +const size_t p_size =__member_size (p); +const size_t p_len =__compiletime_strlen (p);size_t ret;/* We can take compile-time actions when maxlen is const. */ @@ -233,8 +233,8 @@ __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size __FORTIFY_INLINE __diagnose_as(__builtin_strlen, 1) __kernel_size_t __fortify_strlen(const char * const POS p) { + const size_t p_size = __member_size(p); __kernel_size_t ret; - size_t p_size = __member_size(p); /* Give up if we don't know how large p is. */ if (p_size == SIZE_MAX)@@ -267,8 +267,8 @@ extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy);*/ __FORTIFY_INLINE size_t strlcpy(char * const POS p, const char * const POS q, size_t size) { -size_t p_size =__member_size (p); -size_t q_size =__member_size (q); +const size_t p_size =__member_size (p); +const size_t q_size =__member_size (q);size_t q_len;/* Full count of source string length. */ size_t len;/* Count of characters going into destination. */ @@ -318,10 +318,10 @@ extern ssize_t __real_strscpy(char *, const char *, size_t) __RENAME(strscpy);*/ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, size_t size) { -size_t len;/* Use string size rather than possible enclosing struct size. */ -size_t p_size =__member_size (p); -size_t q_size =__member_size (q); +const size_t p_size =__member_size (p); +const size_t q_size =__member_size (q); +size_t len;/* If we cannot get size of p and q default to call strscpy. */ if (p_size ==SIZE_MAX && q_size ==SIZE_MAX )@@ -394,9 +394,9 @@ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, s __FORTIFY_INLINE __diagnose_as(__builtin_strncat, 1, 2, 3) char *strncat(char * const POS p, const char * const POS q, __kernel_size_t count) { + const size_t p_size = __member_size(p); + const size_t q_size = __member_size(q); size_t p_len, copy_len; - size_t p_size = __member_size(p); - size_t q_size = __member_size(q); if (p_size == SIZE_MAX && q_size == SIZE_MAX) return __underlying_strncat(p, q, count);@@ -639,7 +639,7 @@ __FORTIFY_INLINE bool fortify_memcpy_chk(__kernel_size_t size,extern void *__real_memscan (void *,int ,__kernel_size_t )__RENAME (memscan); __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size) { -size_t p_size =__struct_size (p); +const size_t p_size =__struct_size (p);if (__compiletime_lessthan (p_size, size))__read_overflow ();@@ -651,8 +651,8 @@ __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size) __FORTIFY_INLINE __diagnose_as(__builtin_memcmp, 1, 2, 3) int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t size) { - size_t p_size = __struct_size(p); -size_t q_size =__struct_size (q); +const size_t p_size =__struct_size (p); +const size_t q_size =__struct_size (q); if (__builtin_constant_p(size)) {if (__compiletime_lessthan (p_size, size))@@ -668,7 +668,7 @@ int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t __FORTIFY_INLINE __diagnose_as(__builtin_memchr, 1, 2, 3) void *memchr(const void * const POS0 p, int c, __kernel_size_t size) { - size_t p_size = __struct_size(p); + const size_t p_size = __struct_size(p); if (__compiletime_lessthan(p_size, size)) __read_overflow();@@ -680,7 +680,7 @@ void *memchr(const void * const POS0 p, int c, __kernel_size_t size)void *__real_memchr_inv (const void *s,int c,size_t n)__RENAME (memchr_inv); __FORTIFY_INLINE void *memchr_inv(const void * const POS0 p, int c, size_t size) { -size_t p_size =__struct_size (p); +const size_t p_size =__struct_size (p);if (__compiletime_lessthan (p_size, size))__read_overflow ();@@ -693,7 +693,7 @@ extern void *__real_kmemdup(const void *src, size_t len, gfp_t gfp) __RENAME(kme__realloc_size (2 ); __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfp) { -size_t p_size =__struct_size (p); +const size_t p_size =__struct_size (p);if (__compiletime_lessthan (p_size, size))__read_overflow ();@@ -720,8 +720,8 @@ __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfp __FORTIFY_INLINE __diagnose_as(__builtin_strcpy, 1, 2) char *strcpy(char * const POS p, const char * const POS q) { - size_t p_size = __member_size(p); - size_t q_size = __member_size(q); + const size_t p_size = __member_size(p); + const size_t q_size = __member_size(q); size_t size; /* If neither buffer size is known, immediately give up. */ --2.34.1
Signature · 2 lines
Thanks, ~Nick Desaulniers
PATCH v2 5/10 fortify: Add protection for strlcat()
In reply to Kees CookThe definition of strcat() was defined in terms of unfortified strlcat(), but that meant there was no bounds checking done on the internal strlen() calls, and the (bounded) copy would be performed before reporting a failure. Additionally, pathological cases (i.e. unterminated destination buffer) did not make calls to fortify_panic(), which will make future unit testing more difficult. Instead, explicitly define a fortified strlcat() wrapper for strcat() to use.
--- include/linux/fortify-string.h | 64 ++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+)
include/linux/fortify-string.h +64 -0
@@ -371,6 +371,70 @@ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, sreturn __real_strscpy (p, q, len); } +/* Defined after fortified strlen() to reuse it. */ +extern size_t __real_strlcat(char *p, const char *q, size_t avail) __RENAME(strlcat); +/** +* strlcat - Append a string to an existing string +* +* @p: pointer to %NUL-terminated string to append to +* @q: pointer to %NUL-terminated string to append from +* @avail: Maximum bytes available in @p +* +* Appends %NUL-terminated string @q after the %NUL-terminated +* string at @p, but will not write beyond @avail bytes total, +* potentially truncating the copy from @q. @p will stay +* %NUL-terminated only if a %NUL already existed within +* the @avail bytes of @p. If so, the resulting number of +* bytes copied from @q will be at most "@avail - strlen(@p) - 1". +* +* Do not use this function. While FORTIFY_SOURCE tries to avoid +* read and write overflows, this is only possible when the sizes +* of @p and @q are known to the compiler. Prefer building the +* string with formatting, via scnprintf(), seq_buf, or similar. +* +* Returns total bytes that _would_ have been contained by @p +* regardless of truncation, similar to snprintf(). If return +* value is >= @avail, the string has been truncated. +* +*/ +__FORTIFY_INLINE +size_t strlcat(char * const POS p, const char * const POS q, size_t avail) +{ +const size_t p_size =__member_size (p); +const size_t q_size =__member_size (q); +size_t p_len, copy_len; +size_t actual, wanted; + +/* Give up immediately if both buffer sizes are unknown. */ +if (p_size ==SIZE_MAX && q_size ==SIZE_MAX ) +return __real_strlcat (p, q, avail); + + p_len =strnlen (p, avail); + copy_len =strlen (q); + wanted = actual = p_len + copy_len; + +/* Cannot append any more: report truncation. */ +if (avail <= p_len) +return wanted; + +/* Give up if string is already overflowed. */ +if (p_size <= p_len) +fortify_panic (__func__); + +if (actual >= avail) { + copy_len = avail - p_len -1 ; + actual = p_len + copy_len; + } + +/* Give up if copy will overflow. */ +if (p_size <= actual) +fortify_panic (__func__); +__underlying_memcpy (p + p_len, q, copy_len); + p[actual] ='\0' ; + +return wanted; +} +/** * strncat - Append a string to an existing string *
Signature · 1 line
2.34.1
PATCH v2 6/10 fortify: strcat: Move definition to use fortified strlcat()
In reply to Kees CookMove the definition of fortified strcat() to after strlcat() to use it for bounds checking.
--- include/linux/fortify-string.h | 53 +++++++++++++++++----------------- 1 file changed, 26 insertions(+), 27 deletions(-)
include/linux/fortify-string.h +26 -27
@@ -151,33 +151,6 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size)return __underlying_strncpy (p, q, size); } -/** -* strcat - Append a string to an existing string -* -* @p: pointer to NUL-terminated string to append to -* @q: pointer to NUL-terminated source string to append from -* -* Do not use this function. While FORTIFY_SOURCE tries to avoid -* read and write overflows, this is only possible when the -* destination buffer size is known to the compiler. Prefer -* building the string with formatting, via scnprintf() or similar. -* At the very least, use strncat(). -* -* Returns @p. -* -*/ -__FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) -char *strcat(char * const POS p, const char *q) -{ - const size_t p_size = __member_size(p); - - if (p_size == SIZE_MAX) - return __underlying_strcat(p, q); - if (strlcat(p, q, p_size) >= p_size) - fortify_panic(__func__); - return p; -} - extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen);/** * strnlen - Return bounded count of characters in a NUL-terminated string
@@ -435,6 +408,32 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)return wanted; } +/* Defined after fortified strlcat() to reuse it. */ +/** +* strcat - Append a string to an existing string +* +* @p: pointer to NUL-terminated string to append to +* @q: pointer to NUL-terminated source string to append from +* +* Do not use this function. While FORTIFY_SOURCE tries to avoid +* read and write overflows, this is only possible when the +* destination buffer size is known to the compiler. Prefer +* building the string with formatting, via scnprintf() or similar. +* At the very least, use strncat(). +* +* Returns @p. +* +*/ +__FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) +char *strcat(char * const POS p, const char *q) +{ + const size_t p_size = __member_size(p); + + if (strlcat(p, q, p_size) >= p_size) + fortify_panic(__func__); + return p; +} +/** * strncat - Append a string to an existing string *
Signature · 1 line
2.34.1
Re: [PATCH v2 06/10] fortify: strcat: Move definition to use fortified strlcat()
Quoted 48 lines · Kees Cook
Move the definition of fortified
strcat()to afterstrlcat()to use it for bounds checking.Signed-off-by Kees Cook <[email protected]>--- include/linux/fortify-string.h | 53 +++++++++++++++++----------------- 1 file changed, 26 insertions(+), 27 deletions(-)include/linux/fortify-string.h +0
-27@@ -151,33 +151,6 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size)return __underlying_strncpy (p, q, size); } -/** -* strcat - Append a string to an existing string -* -* @p: pointer to NUL-terminated string to append to -* @q: pointer to NUL-terminated source string to append from -* -* Do not use this function. While FORTIFY_SOURCE tries to avoid -* read and write overflows, this is only possible when the -* destination buffer size is known to the compiler. Prefer -* building the string with formatting, via scnprintf() or similar. -* At the very least, use strncat(). -* -* Returns @p. -* -*/ -__FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) -char *strcat(char * const POS p, const char *q) -{ - const size_t p_size = __member_size(p); - - if (p_size == SIZE_MAX) - return __underlying_strcat(p, q); - if (strlcat(p, q, p_size) >= p_size) - fortify_panic(__func__); - return p; -} - extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen);/** * strnlen - Return bounded count of characters in a NUL-terminated string
include/linux/fortify-string.h size_t strlcat(char * const POS p, const char * const POS q, size_t avail) · line 411
Quoted 4 lines
include/linux/fortify-string.h +1
-0@@ -435,6 +408,32 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)return wanted; } +/* Defined after fortified strlcat() to reuse it. */
I don't follow; the previous location was already defined in terms of calls to strlcat. Why is this patch necessary?
Could this be fixed in 5/10
https://lore.kernel.org/linux-hardening/[email protected]/
by just putting strlcat in the expected place in the first place?
Quoted 10 lines
include/linux/fortify-string.h +10
-0+/** +* strcat - Append a string to an existing string +* +* @p: pointer to NUL-terminated string to append to +* @q: pointer to NUL-terminated source string to append from +* +* Do not use this function. While FORTIFY_SOURCE tries to avoid +* read and write overflows, this is only possible when the +* destination buffer size is known to the compiler. Prefer +* building the string with formatting, via scnprintf() or similar.
include/linux/fortify-string.h size_t strlcat(char * const POS p, const char * const POS q, size_t avail) · line 431
Quoted 10 lines
include/linux/fortify-string.h +10
-0+* At the very least, use strncat(). +* +* Returns @p. +* +*/ +__FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) +char *strcat(char * const POS p, const char *q) +{ + const size_t p_size = __member_size(p); +
This drops the p_size == SIZE_MAX guard. Might it be faster at runtime to dispatch to __underlying_strcat rather than __real_strlcat in such cases?
What's the convention for __underlying_ vs __real_ prefixes in include/linux/fortify-string.h?
Quoted 11 lines
include/linux/fortify-string.h +5
-1+if (strlcat (p, q, p_size) >= p_size) +fortify_panic (__func__); +return p; +} +/** * strncat - Append a string to an existing string * -- 2.34.1
Signature · 2 lines
Thanks, ~Nick Desaulniers
Re: [PATCH v2 06/10] fortify: strcat: Move definition to use fortified strlcat()
Quoted 52 lines · Nick Desaulniers
Quoted 51 lines · Kees Cook
Move the definition of fortified
strcat()to afterstrlcat()to use it for bounds checking.Signed-off-by Kees Cook <[email protected]>--- include/linux/fortify-string.h | 53 +++++++++++++++++----------------- 1 file changed, 26 insertions(+), 27 deletions(-)include/linux/fortify-string.h +0
-27@@ -151,33 +151,6 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size)return __underlying_strncpy (p, q, size); } -/** -* strcat - Append a string to an existing string -* -* @p: pointer to NUL-terminated string to append to -* @q: pointer to NUL-terminated source string to append from -* -* Do not use this function. While FORTIFY_SOURCE tries to avoid -* read and write overflows, this is only possible when the -* destination buffer size is known to the compiler. Prefer -* building the string with formatting, via scnprintf() or similar. -* At the very least, use strncat(). -* -* Returns @p. -* -*/ -__FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2) -char *strcat(char * const POS p, const char *q) -{ - const size_t p_size = __member_size(p); - - if (p_size == SIZE_MAX) - return __underlying_strcat(p, q); - if (strlcat(p, q, p_size) >= p_size) - fortify_panic(__func__); - return p; -} - extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen);/** * strnlen - Return bounded count of characters in a NUL-terminated string @@ -435,6 +408,32 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)return wanted; }
Quoted 8 lines
include/linux/fortify-string.h size_t strlcat(char * const POS p, const char * const POS q, size_t avail) · line 411
Quoted 1 line
include/linux/fortify-string.h +1
-0+/* Defined after fortified strlcat() to reuse it. */ I don't follow; the previous location was already defined in terms of calls to strlcat. Why is this patch necessary?
Could this be fixed in 5/10
https://lore.kernel.org/linux-hardening/[email protected]/
by just putting strlcat in the expected place in the first place?
I wanted to collect all the str*cat functions together.
Quoted 16 lines
Quoted 16 lines
include/linux/fortify-string.h +16
-0+/** +* strcat - Append a string to an existing string +* +* @p: pointer to NUL-terminated string to append to +* @q: pointer to NUL-terminated source string to append from +* +* Do not use this function. While FORTIFY_SOURCE tries to avoid +* read and write overflows, this is only possible when the +* destination buffer size is known to the compiler. Prefer +* building the string with formatting, via scnprintf() or similar. +* At the very least, use strncat(). +* +* Returns @p. +* +*/ +__FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2)
Quoted 8 lines
include/linux/fortify-string.h size_t strlcat(char * const POS p, const char * const POS q, size_t avail) · line 431
Quoted 4 lines
include/linux/fortify-string.h +4
-0+char *strcat(char * const POS p, const char *q) +{ +const size_t p_size =__member_size (p); +This drops the
p_size == SIZE_MAXguard. Might it be faster at runtime to dispatch to__underlying_strcatrather than__real_strlcatin such cases?
I wanted to avoid repeating the same checks, so since strlcat() already does the right checking, I avoided repeating it here.
Quoted 2 lines
What's the convention for
__underlying_vs__real_prefixes ininclude/linux/fortify-string.h?
__underlying may be wrapped by K*SAN before being implemented via __builtin, where as __real is used for things that aren't wrapped and/or aren't available with a __builtin (e.g. strscpy).
Signature · 1 line
Kees Cook
PATCH v2 7/10 fortify: Split reporting and avoid passing string pointer
In reply to Kees CookIn preparation for KUnit testing and further improvements in fortify failure reporting, split out the report and encode the function and access failure (read or write overflow) into a single u8 argument. This mainly ends up saving some space in the data segment. For a defconfig with FORTIFY_SOURCE enabled:
$ size gcc/vmlinux.before gcc/vmlinux.after text data bss dec hex filename 26132309 9760658 2195460 38088427 2452eeb gcc/vmlinux.before 26132386 9748382 2195460 38076228 244ff44 gcc/vmlinux.after
--- arch/arm/boot/compressed/misc.c | 2 +- arch/x86/boot/compressed/misc.c | 2 +- include/linux/fortify-string.h | 84 ++++++++++++++++++++++++--------- lib/string_helpers.c | 23 +++++++-- tools/objtool/check.c | 2 +- 5 files changed, 85 insertions(+), 28 deletions(-)
arch/arm/boot/compressed/misc.c +1 -1
@@ -160,7 +160,7 @@ decompress_kernel(unsigned long output_start, unsigned long free_mem_ptr_p,putstr (" done, booting the kernel.\n" ); } -void fortify_panic (const char *name) +void __fortify_panic (const u8 reason) {error ("detected buffer overflow" ); }
arch/x86/boot/compressed/misc.c +1 -1
@@ -470,7 +470,7 @@ asmlinkage __visible void *extract_kernel(void *rmode, memptr heap,return output + entry_offset; } -void fortify_panic (const char *name) +void __fortify_panic (const u8 reason) {error ("detected buffer overflow" ); }
include/linux/fortify-string.h +62 -22
210 lines not on this page · raw message
lib/string_helpers.c +20 -3
@@ -1021,10 +1021,27 @@ EXPORT_SYMBOL(__read_overflow2_field);void __write_overflow_field (size_t avail,size_t wanted) { }EXPORT_SYMBOL (__write_overflow_field); -void fortify_panic (const char *name) +#define MAKE_FORTIFY_FUNC_NAME (func) [MAKE_FORTIFY_FUNC(func)] = #func + +static const char *const fortify_func_name[] = { +EACH_FORTIFY_FUNC (MAKE_FORTIFY_FUNC_NAME ) +}; + +void __fortify_report (const u8 reason) +{ +const u8 func =FORTIFY_REASON_FUNC (reason); +const bool write =FORTIFY_REASON_DIR (reason); +const char *name; + + name = fortify_func_name[min_t (u8, func,FORTIFY_FUNC_UNKNOWN )]; +WARN (1 ,"%s: detected buffer %s overflow\n" , name,str_read_write (!write)); +} +EXPORT_SYMBOL (__fortify_report); + +void __fortify_panic (const u8 reason) { -pr_emerg ("detected buffer overflow in %s\n" , name); +__fortify_report (reason);BUG (); } -EXPORT_SYMBOL (fortify_panic); +EXPORT_SYMBOL (__fortify_panic);#endif /* CONFIG_FORTIFY_SOURCE */
tools/objtool/check.c +1 -1
@@ -197,6 +197,7 @@ static bool __dead_end_function(struct objtool_file *file, struct symbol *func,* attribute isn't provided in ELF data. Keep 'em sorted. */ static const char *const global_noreturns[] = { +"__fortify_panic" ,"__invalid_creds" ,"__module_put_and_kthread_exit" ,"__reiserfs_panic" ,
@@ -208,7 +209,6 @@ static bool __dead_end_function(struct objtool_file *file, struct symbol *func,"do_group_exit" ,"do_task_dead" ,"ex_handler_msr_mce" , -"fortify_panic" ,"kthread_complete_and_exit" ,"kthread_exit" , "kunit_try_catch_throw",
Signature · 1 line
2.34.1
kernel test robot
build botRe: [PATCH v2 07/10] fortify: Split reporting and avoid passing string pointer
kernel test robot noticed the following build warnings:
Hi Kees,
kernel test robot noticed the following build warnings:
[auto build test WARNING on kees/for-next/hardening]
[also build test WARNING on kees/for-next/pstore kees/for-next/kspp linus/master tip/x86/core v6.3-rc5 next-20230406] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Kees-Cook/kunit-tool-Enable-CONFIG_FORTIFY_SOURCE-under-UML/20230408-032959 base: https://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git for-next/hardening patch link: https://lore.kernel.org/r/20230407192717.636137-7-keescook%40chromium.org patch subject: [PATCH v2 07/10] fortify: Split reporting and avoid passing string pointer config: arm-randconfig-r046-20230404 (https://download.01.org/0day-ci/archive/20230408/[email protected]/config) compiler: arm-linux-gnueabi-gcc (GCC) 12.1.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/124d051177d6812a0b5bd445a9f89e0694d56f2d
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Kees-Cook/kunit-tool-Enable-CONFIG_FORTIFY_SOURCE-under-UML/20230408-032959 git checkout 124d051177d6812a0b5bd445a9f89e0694d56f2d
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=arm olddefconfig COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=arm SHELL=/bin/bash
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
arch/arm/boot/compressed/misc.c:129:17: warning: no previous prototype for '__div0' [-Wmissing-prototypes]
129 | asmlinkage void __div0(void)
| ^~~~~~
arch/arm/boot/compressed/misc.c:138:1: warning: no previous prototype for 'decompress_kernel' [-Wmissing-prototypes]
138 | decompress_kernel(unsigned long output_start, unsigned long free_mem_ptr_p,
| ^~~~~~~~~~~~~~~~~
>> arch/arm/boot/compressed/misc.c:163:6: warning: no previous prototype for '__fortify_panic' [-Wmissing-prototypes] 163 | void __fortify_panic(const u8 reason)
| ^~~~~~~~~~~~~~~
vim +/__fortify_panic +163 arch/arm/boot/compressed/misc.c
128
> 129 asmlinkage void __div0(void)
130 {
131 error("Attempting division by 0!");
132 }
133
134 extern int do_decompress(u8 *input, int len, u8 *output, void (*error)(char *x));
135
136
137 void
138 decompress_kernel(unsigned long output_start, unsigned long free_mem_ptr_p,
139 unsigned long free_mem_ptr_end_p,
140 int arch_id)
141 {
142 int ret;
143
144 output_data = (unsigned char *)output_start;
145 free_mem_ptr = free_mem_ptr_p;
146 free_mem_end_ptr = free_mem_ptr_end_p;
147 __machine_arch_type = arch_id;
148
149 #ifdef CONFIG_ARCH_EP93XX
150 ep93xx_decomp_setup();
151 #endif
152 arch_decomp_setup();
153
154 putstr("Uncompressing Linux...");
155 ret = do_decompress(input_data, input_data_end - input_data,
156 output_data, error);
157 if (ret)
158 error("decompressor returned an error");
159 else
160 putstr(" done, booting the kernel.\n");
161 }
162
> 163 void __fortify_panic(const u8 reason)Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests
Re: [PATCH v2 07/10] fortify: Split reporting and avoid passing string pointer
In reply to Kees CookFrom: Kees Cook <[email protected]>
Date: Fri, 7 Apr 2023 12:27:13 -0700
Quoted 5 lines
In preparation for KUnit testing and further improvements in fortify failure reporting, split out the report and encode the function and access failure (read or write overflow) into a single u8 argument. This mainly ends up saving some space in the data segment. For a defconfig with
FORTIFY_SOURCEenabled:
[...]
Quoted 9 lines
lib/string_helpers.c +0
-1@@ -1021,10 +1021,27 @@ EXPORT_SYMBOL(__read_overflow2_field);void __write_overflow_field (size_t avail,size_t wanted) { }EXPORT_SYMBOL (__write_overflow_field); -void fortify_panic (const char *name)
lib/string_helpers.c EXPORT_SYMBOL(__read_overflow2_field); · line 1033
Quoted 10 lines
lib/string_helpers.c +10
-0+#define MAKE_FORTIFY_FUNC_NAME (func) [MAKE_FORTIFY_FUNC(func)] = #func + +static const char *const fortify_func_name[] = { +EACH_FORTIFY_FUNC (MAKE_FORTIFY_FUNC_NAME ) +}; + +void __fortify_report (const u8 reason) +{ +const u8 func =FORTIFY_REASON_FUNC (reason); +const bool write =FORTIFY_REASON_DIR (reason);
Nano-nit: RCT style here :s
Quoted 6 lines
lib/string_helpers.c +6
-0+const char *name; + + name = fortify_func_name[min_t (u8, func,FORTIFY_FUNC_UNKNOWN )]; +WARN (1 ,"%s: detected buffer %s overflow\n" , name,str_read_write (!write)); +} +EXPORT_SYMBOL (__fortify_report);
lib/string_helpers.c EXPORT_SYMBOL(__read_overflow2_field); · line 1047
Quoted 10 lines
lib/string_helpers.c +4
-2+ +void __fortify_panic (const u8 reason) { -pr_emerg ("detected buffer overflow in %s\n" , name); +__fortify_report (reason);BUG (); } -EXPORT_SYMBOL (fortify_panic); +EXPORT_SYMBOL (__fortify_panic);#endif /* CONFIG_FORTIFY_SOURCE */
[...]
There's also a small build warning issue. Apart from that, I like how it does look now, thanks!
Thanks,
Olek
PATCH v2 8/10 fortify: Provide KUnit counters for failure testing
In reply to Kees CookThe standard C string APIs were not designed to have a failure mode; they were expected to always succeed without memory safety issues. Normally, CONFIG_FORTIFY_SOURCE will use fortify_panic() to stop processing, as truncating a read or write may provide an even worse system state. However, this creates a problem for testing under things like KUnit, which needs a way to survive failures.
When building with CONFIG_KUNIT, provide a failure path for all users for fortify_panic, and track whether the failure was a read overflow or a write overflow, for KUnit tests to examine. Inspired by similar logic in the slab tests.
--- include/linux/fortify-string.h | 45 +++++++++++++++++++--------------- lib/fortify_kunit.c | 44 +++++++++++++++++++++++++++++++++ lib/string_helpers.c | 2 ++ 3 files changed, 71 insertions(+), 20 deletions(-)
include/linux/fortify-string.h +25 -20
@@ -15,8 +15,12 @@#define FORTIFY_REASON (func, write) (FIELD_PREP(BIT(0), write) | \ FIELD_PREP(GENMASK(7, 1), func)) -#define fortify_panic (func, write) \ +#ifdef FORTIFY_KUNIT_OVERRIDE +# define fortify_panic kunit_fortify_panic +#else +# define fortify_panic (func, write, retfail) \ __fortify_panic(FORTIFY_REASON(func, write)) +#endif #define FORTIFY_READ 0#define FORTIFY_WRITE 1
@@ -186,7 +190,7 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size)if (__compiletime_lessthan (p_size, size))__write_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_strncpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strncpy,FORTIFY_WRITE , p);return __underlying_strncpy (p, q, size); }
@@ -217,7 +221,7 @@ __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size/* Do not check characters beyond the end of p. */ ret =__real_strnlen (p, maxlen < p_size ? maxlen : p_size);if (p_size <= ret && maxlen != ret) -fortify_panic (FORTIFY_FUNC_strnlen,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_strnlen,FORTIFY_READ , ret);return ret; }
@@ -253,7 +257,7 @@ __kernel_size_t __fortify_strlen(const char * const POS p)return __underlying_strlen (p); ret =strnlen (p, p_size);if (p_size <= ret) -fortify_panic (FORTIFY_FUNC_strlen,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_strlen,FORTIFY_READ , ret);return ret; }
@@ -295,7 +299,7 @@ __FORTIFY_INLINE size_t strlcpy(char * const POS p, const char * const POS q, si }if (size) {if (len >= p_size) -fortify_panic (FORTIFY_FUNC_strlcpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strlcpy,FORTIFY_WRITE , q_len);__underlying_memcpy (p, q, len); p[len] ='\0' ; }
@@ -373,7 +377,7 @@ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, s* p_size. */ if (len > p_size) -fortify_panic (FORTIFY_FUNC_strscpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strscpy,FORTIFY_WRITE , -E2BIG );/* * We can now safely call vanilla strscpy because we are protected from:
@@ -431,7 +435,7 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)/* Give up if string is already overflowed. */ if (p_size <= p_len) -fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_READ , wanted);if (actual >= avail) { copy_len = avail - p_len -1 ;
@@ -440,7 +444,7 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)/* Give up if copy will overflow. */ if (p_size <= actual) -fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_WRITE , wanted);__underlying_memcpy (p + p_len, q, copy_len); p[actual] ='\0' ;
@@ -469,7 +473,7 @@ char *strcat(char * const POS p, const char *q)const size_t p_size =__member_size (p);if (strlcat (p, q, p_size) >= p_size) -fortify_panic (FORTIFY_FUNC_strcat,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strcat,FORTIFY_WRITE , p);return p; }
@@ -505,13 +509,13 @@ char *strncat(char * const POS p, const char * const POS q, __kernel_size_t coun p_len =strlen (p); copy_len =strnlen (q, count);if (p_size < p_len + copy_len +1 ) -fortify_panic (FORTIFY_FUNC_strncat,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strncat,FORTIFY_WRITE , p);__underlying_memcpy (p + p_len, q, copy_len); p[p_len + copy_len] ='\0' ;return p; } -__FORTIFY_INLINE void fortify_memset_chk(__kernel_size_t size, +__FORTIFY_INLINE bool fortify_memset_chk(__kernel_size_t size,const size_t p_size,const size_t p_size_field) {
@@ -546,7 +550,8 @@ __FORTIFY_INLINE void fortify_memset_chk(__kernel_size_t size,* lengths are unknown.) */ if (p_size !=SIZE_MAX && p_size < size) -fortify_panic (FORTIFY_FUNC_memset,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_memset,FORTIFY_WRITE , true); +return false; }#define __fortify_memset_chk (p, c, size, p_size, p_size_field) ({ \
@@ -645,9 +650,9 @@ __FORTIFY_INLINE bool fortify_memcpy_chk(__kernel_size_t size,* lengths are unknown.) */ if (p_size !=SIZE_MAX && p_size < size) -fortify_panic (func,FORTIFY_WRITE ); +fortify_panic (func,FORTIFY_WRITE , true);else if (q_size !=SIZE_MAX && q_size < size) -fortify_panic (func,FORTIFY_READ ); +fortify_panic (func,FORTIFY_READ , true);/* * Warn when writing beyond destination field size.
@@ -747,7 +752,7 @@ __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size)if (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_memscan,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memscan,FORTIFY_READ ,NULL );return __real_memscan (p, c, size); }
@@ -764,7 +769,7 @@ int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t__read_overflow2 (); }if (p_size < size || q_size < size) -fortify_panic (FORTIFY_FUNC_memcmp,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memcmp,FORTIFY_READ ,INT_MIN );return __underlying_memcmp (p, q, size); }
@@ -776,7 +781,7 @@ void *memchr(const void * const POS0 p, int c, __kernel_size_t size)if (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_memchr,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memchr,FORTIFY_READ ,NULL );return __underlying_memchr (p, c, size); }
@@ -788,7 +793,7 @@ __FORTIFY_INLINE void *memchr_inv(const void * const POS0 p, int c, size_t size)if (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_memchr_inv,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memchr_inv,FORTIFY_READ ,NULL );return __real_memchr_inv (p, c, size); }
@@ -801,7 +806,7 @@ __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfpif (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_kmemdup,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_kmemdup,FORTIFY_READ ,NULL );return __real_kmemdup (p, size, gfp); }
@@ -838,7 +843,7 @@ char *strcpy(char * const POS p, const char * const POS q)__write_overflow ();/* Run-time check for dynamic size overflow. */ if (p_size < size) -fortify_panic (FORTIFY_FUNC_strcpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strcpy,FORTIFY_WRITE , p);__underlying_memcpy (p, q, size);return p; }
lib/fortify_kunit.c +44 -0
68 lines not on this page · raw message
lib/string_helpers.c +2 -0
@@ -18,6 +18,8 @@#include <linux/slab.h> #include <linux/string.h> #include <linux/string_helpers.h> +#include <kunit/test.h> +#include <kunit/test-bug.h> /** * string_get_size - get the size in the specified units
Signature · 1 line
2.34.1
Re: [PATCH v2 08/10] fortify: Provide KUnit counters for failure testing
Quoted 25 lines · Kees Cook
The standard C string APIs were not designed to have a failure mode; they were expected to always succeed without memory safety issues. Normally,
CONFIG_FORTIFY_SOURCEwill usefortify_panic()to stop processing, as truncating a read or write may provide an even worse system state. However, this creates a problem for testing under things like KUnit, which needs a way to survive failures.When building with
CONFIG_KUNIT, provide a failure path for all users forfortify_panic, and track whether the failure was a read overflow or a write overflow, for KUnit tests to examine. Inspired by similar logic in the slab tests.Signed-off-by Kees Cook <[email protected]>--- include/linux/fortify-string.h | 45 +++++++++++++++++++--------------- lib/fortify_kunit.c | 44 +++++++++++++++++++++++++++++++++ lib/string_helpers.c | 2 ++ 3 files changed, 71 insertions(+), 20 deletions(-)include/linux/fortify-string.h +0
-0
include/linux/fortify-string.h line 23
Quoted 10 lines
include/linux/fortify-string.h +5
-1@@ -15,8 +15,12 @@#define FORTIFY_REASON (func, write) (FIELD_PREP(BIT(0), write) | \ FIELD_PREP(GENMASK(7, 1), func)) -#define fortify_panic (func, write) \ +#ifdef FORTIFY_KUNIT_OVERRIDE +# define fortify_panic kunit_fortify_panic +#else +# define fortify_panic (func, write, retfail) \ __fortify_panic(FORTIFY_REASON(func, write)) +#endif
Could we provide a different definition of fortify_panic in lib/string_helpers.c rather than this macro indirection?
Quoted 173 lines
include/linux/fortify-string.h +20
-19#define FORTIFY_READ 0#define FORTIFY_WRITE 1@@ -186,7 +190,7 @@ char *strncpy(char * const POS p, const char *q, __kernel_size_t size)if (__compiletime_lessthan (p_size, size))__write_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_strncpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strncpy,FORTIFY_WRITE , p);return __underlying_strncpy (p, q, size); }@@ -217,7 +221,7 @@ __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size/* Do not check characters beyond the end of p. */ ret =__real_strnlen (p, maxlen < p_size ? maxlen : p_size);if (p_size <= ret && maxlen != ret) -fortify_panic (FORTIFY_FUNC_strnlen,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_strnlen,FORTIFY_READ , ret);return ret; }@@ -253,7 +257,7 @@ __kernel_size_t __fortify_strlen(const char * const POS p)return __underlying_strlen (p); ret =strnlen (p, p_size);if (p_size <= ret) -fortify_panic (FORTIFY_FUNC_strlen,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_strlen,FORTIFY_READ , ret);return ret; }@@ -295,7 +299,7 @@ __FORTIFY_INLINE size_t strlcpy(char * const POS p, const char * const POS q, si }if (size) {if (len >= p_size) -fortify_panic (FORTIFY_FUNC_strlcpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strlcpy,FORTIFY_WRITE , q_len);__underlying_memcpy (p, q, len); p[len] ='\0' ; }@@ -373,7 +377,7 @@ __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, s* p_size. */ if (len > p_size) -fortify_panic (FORTIFY_FUNC_strscpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strscpy,FORTIFY_WRITE , -E2BIG );/* * We can now safely call vanilla strscpy because we are protected from: @@ -431,7 +435,7 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)/* Give up if string is already overflowed. */ if (p_size <= p_len) -fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_READ , wanted);if (actual >= avail) { copy_len = avail - p_len -1 ;@@ -440,7 +444,7 @@ size_t strlcat(char * const POS p, const char * const POS q, size_t avail)/* Give up if copy will overflow. */ if (p_size <= actual) -fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strlcat,FORTIFY_WRITE , wanted);__underlying_memcpy (p + p_len, q, copy_len); p[actual] ='\0' ;@@ -469,7 +473,7 @@ char *strcat(char * const POS p, const char *q)const size_t p_size =__member_size (p);if (strlcat (p, q, p_size) >= p_size) -fortify_panic (FORTIFY_FUNC_strcat,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strcat,FORTIFY_WRITE , p);return p; }@@ -505,13 +509,13 @@ char *strncat(char * const POS p, const char * const POS q, __kernel_size_t coun p_len =strlen (p); copy_len =strnlen (q, count);if (p_size < p_len + copy_len +1 ) -fortify_panic (FORTIFY_FUNC_strncat,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strncat,FORTIFY_WRITE , p);__underlying_memcpy (p + p_len, q, copy_len); p[p_len + copy_len] ='\0' ;return p; } -__FORTIFY_INLINE void fortify_memset_chk(__kernel_size_t size, +__FORTIFY_INLINE bool fortify_memset_chk(__kernel_size_t size,const size_t p_size,const size_t p_size_field) {@@ -546,7 +550,8 @@ __FORTIFY_INLINE void fortify_memset_chk(__kernel_size_t size,* lengths are unknown.) */ if (p_size !=SIZE_MAX && p_size < size) -fortify_panic (FORTIFY_FUNC_memset,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_memset,FORTIFY_WRITE , true); +return false; }#define __fortify_memset_chk (p, c, size, p_size, p_size_field) ({ \@@ -645,9 +650,9 @@ __FORTIFY_INLINE bool fortify_memcpy_chk(__kernel_size_t size,* lengths are unknown.) */ if (p_size !=SIZE_MAX && p_size < size) -fortify_panic (func,FORTIFY_WRITE ); +fortify_panic (func,FORTIFY_WRITE , true);else if (q_size !=SIZE_MAX && q_size < size) -fortify_panic (func,FORTIFY_READ ); +fortify_panic (func,FORTIFY_READ , true);/* * Warn when writing beyond destination field size. @@ -747,7 +752,7 @@ __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size)if (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_memscan,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memscan,FORTIFY_READ ,NULL );return __real_memscan (p, c, size); }@@ -764,7 +769,7 @@ int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t__read_overflow2 (); }if (p_size < size || q_size < size) -fortify_panic (FORTIFY_FUNC_memcmp,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memcmp,FORTIFY_READ ,INT_MIN );return __underlying_memcmp (p, q, size); }@@ -776,7 +781,7 @@ void *memchr(const void * const POS0 p, int c, __kernel_size_t size)if (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_memchr,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memchr,FORTIFY_READ ,NULL );return __underlying_memchr (p, c, size); }@@ -788,7 +793,7 @@ __FORTIFY_INLINE void *memchr_inv(const void * const POS0 p, int c, size_t size)if (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_memchr_inv,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_memchr_inv,FORTIFY_READ ,NULL );return __real_memchr_inv (p, c, size); }@@ -801,7 +806,7 @@ __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfpif (__compiletime_lessthan (p_size, size))__read_overflow ();if (p_size < size) -fortify_panic (FORTIFY_FUNC_kmemdup,FORTIFY_READ ); +fortify_panic (FORTIFY_FUNC_kmemdup,FORTIFY_READ ,NULL );return __real_kmemdup (p, size, gfp); }@@ -838,7 +843,7 @@ char *strcpy(char * const POS p, const char * const POS q)__write_overflow ();/* Run-time check for dynamic size overflow. */ if (p_size < size) -fortify_panic (FORTIFY_FUNC_strcpy,FORTIFY_WRITE ); +fortify_panic (FORTIFY_FUNC_strcpy,FORTIFY_WRITE , p);__underlying_memcpy (p, q, size);return p; }lib/fortify_kunit.c +0
-0@@ -15,12 +15,28 @@*/
lib/fortify_kunit.c line 25
Quoted 10 lines
lib/fortify_kunit.c +8
-0#define pr_fmt (fmt) KBUILD_MODNAME ": " fmt +/* Call kunit_fortify_panic() instead of fortify_panic() */ +#define FORTIFY_KUNIT_OVERRIDE +void fortify_add_kunit_error (int write); +#define kunit_fortify_panic (func, write, retfail) \ + do { \ + __fortify_report(FORTIFY_REASON(func, write)); \ + fortify_add_kunit_error(write); \ + return (retfail); \
^ Does this return value even matter? Could we just return -1 or some other constant for all cases? Then you don't need an optional parameter addition to fortify_panic.
Quoted 64 lines
lib/fortify_kunit.c +36
-0+ } while (0) +#include <kunit/test.h> +#include <kunit/test-bug.h> #include <linux/device.h> #include <linux/slab.h> #include <linux/string.h> #include <linux/vmalloc.h> +static struct kunit_resource read_resource; +static struct kunit_resource write_resource; +static int fortify_read_overflows; +static int fortify_write_overflows; +static const char array_of_10[] ="this is 10" ;static const char *ptr_of_11 ="this is 11!" ;static char array_unknown[] ="compiler thinks I might change" ;@@ -30,6 +46,25 @@ static char array_unknown[] = "compiler thinks I might change";# define __compiletime_strlen __builtin_strlen#endif +void fortify_add_kunit_error (int write) +{ +struct kunit_resource *resource; +struct kunit *current_test; + + current_test =kunit_get_current_test (); +if (!current_test) +return ; + + resource =kunit_find_named_resource (current_test, + write ?"fortify_write_overflows" + :"fortify_read_overflows" ); +if (!resource) +return ; + + (*(int *)resource->data)++; +kunit_put_resource (resource); +} +static void known_sizes_test (struct kunit *test) {KUNIT_EXPECT_EQ (test,__compiletime_strlen ("88888888" ),8 );@@ -317,6 +352,15 @@ static int fortify_test_init(struct kunit *test)if (!IS_ENABLED (CONFIG_FORTIFY_SOURCE ))kunit_skip (test,"Not built with CONFIG_FORTIFY_SOURCE=y" ); + fortify_read_overflows =0 ; +kunit_add_named_resource (test,NULL ,NULL , &read_resource, +"fortify_read_overflows" , + &fortify_read_overflows); + fortify_write_overflows =0 ; +kunit_add_named_resource (test,NULL ,NULL , &write_resource, +"fortify_write_overflows" , + &fortify_write_overflows); +return 0 ; }lib/string_helpers.c +0
-0
lib/string_helpers.c line 22
Quoted 5 lines
lib/string_helpers.c +2
-0@@ -18,6 +18,8 @@#include <linux/slab.h> #include <linux/string.h> #include <linux/string_helpers.h> +#include <kunit/test.h> +#include <kunit/test-bug.h>
Why do we need these headers here?
Quoted 6 lines
lib/string_helpers.c +0
-1/** * string_get_size - get the size in the specified units -- 2.34.1
--
Thanks,
~Nick Desaulniers
PATCH v2 9/10 fortify: Add KUnit tests for runtime overflows
In reply to Kees CookWith fortify overflows able to be redirected, we can use KUnit to exercise the overflow conditions. Add tests for every API covered by CONFIG_FORTIFY_SOURCE.
--- lib/fortify_kunit.c | 673 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 673 insertions(+)
lib/fortify_kunit.c +673 -0
@@ -347,6 +347,663 @@ DEFINE_ALLOC_SIZE_TEST_PAIR(kvmalloc) }while (0 )DEFINE_ALLOC_SIZE_TEST_PAIR (devm_kmalloc) +/* +* We can't have an array at the end of a structure or else +* builds without -fstrict-flex-arrays=3 will report them as +* being an unknown length. Additionally, add bytes before +* and after the string to catch over/underflows if tests +* fail. + */ +struct fortify_padding { +unsigned long bytes_before; +char buf[32 ]; +unsigned long bytes_after; +}; +/* Force compiler into not being able to resolve size at compile-time. */ +static volatile int unconst; + +static void strlen_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +int i, end =sizeof (pad.buf) -1 ; + +/* Fill 31 bytes with valid characters. */ +for (i =0 ; i <sizeof (pad.buf) -1 ; i++) + pad.buf[i] = i +'0' ; +/* Trailing bytes are still %NUL. */ +KUNIT_EXPECT_EQ (test, pad.buf[end],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* String is terminated, so strlen() is valid. */ +KUNIT_EXPECT_EQ (test,strlen (pad.buf), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); + +/* Make string unterminated, and recount. */ + pad.buf[end] ='A' ; + end =sizeof (pad.buf); +KUNIT_EXPECT_EQ (test,strlen (pad.buf), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +} + +static void strnlen_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +int i, end =sizeof (pad.buf) -1 ; + +/* Fill 31 bytes with valid characters. */ +for (i =0 ; i <sizeof (pad.buf) -1 ; i++) + pad.buf[i] = i +'0' ; +/* Trailing bytes are still %NUL. */ +KUNIT_EXPECT_EQ (test, pad.buf[end],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* String is terminated, so strnlen() is valid. */ +KUNIT_EXPECT_EQ (test,strnlen (pad.buf,sizeof (pad.buf)), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +/* A truncated strnlen() will be safe, too. */ +KUNIT_EXPECT_EQ (test,strnlen (pad.buf,sizeof (pad.buf) /2 ), +sizeof (pad.buf) /2 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); + +/* Make string unterminated, and recount. */ + pad.buf[end] ='A' ; + end =sizeof (pad.buf); +/* Reading beyond with strncpy() will fail. */ +KUNIT_EXPECT_EQ (test,strnlen (pad.buf, end +1 ), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_EXPECT_EQ (test,strnlen (pad.buf, end +2 ), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); + +/* Early-truncated is safe still, though. */ +KUNIT_EXPECT_EQ (test,strnlen (pad.buf, end), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); + + end =sizeof (pad.buf) /2 ; +KUNIT_EXPECT_EQ (test,strnlen (pad.buf, end), end); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +} + +static void strcpy_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[sizeof (pad.buf) +1 ] = { }; +int i; + +/* Fill 31 bytes with valid characters. */ +for (i =0 ; i <sizeof (src) -2 ; i++) + src[i] = i +'0' ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strcpy() 1 less than of max size. */ +KUNIT_ASSERT_TRUE (test,strcpy (pad.buf, src) + == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Only last byte should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + + src[sizeof (src) -2 ] ='A' ; +/* But now we trip the overflow checking. */ +KUNIT_ASSERT_TRUE (test,strcpy (pad.buf, src) + == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +/* Trailing %NUL -- thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + + src[sizeof (src) -1 ] ='A' ; +/* And for sure now, two bytes past. */ +KUNIT_ASSERT_TRUE (test,strcpy (pad.buf, src) + == pad.buf); +/* +* Which trips both the strlen() on the unterminated src, +* and the resulting copy attempt. +*/ +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +/* Trailing %NUL -- thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); +} + +static void strncpy_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[] ="Copy me fully into a small buffer and I will overflow!" ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strncpy() 1 less than of max size. */ +KUNIT_ASSERT_TRUE (test,strncpy (pad.buf, src, +sizeof (pad.buf) + unconst -1 ) + == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Only last byte should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* Legitimate (though unterminated) max-size strncpy. */ +KUNIT_ASSERT_TRUE (test,strncpy (pad.buf, src, +sizeof (pad.buf) + unconst) + == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* No trailing %NUL -- thanks strncpy API. */ +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* But we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Now verify that FORTIFY is working... */ +KUNIT_ASSERT_TRUE (test,strncpy (pad.buf, src, +sizeof (pad.buf) + unconst +1 ) + == pad.buf); +/* Should catch the overflow. */ +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* And further... */ +KUNIT_ASSERT_TRUE (test,strncpy (pad.buf, src, +sizeof (pad.buf) + unconst +2 ) + == pad.buf); +/* Should catch the overflow. */ +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); +} + +static void strlcpy_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[] ="Copy me fully into a small buffer and I will overflow!" ; +char tiny[4 ] ="abcd" ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strlcpy() 1 less than of max size. */ +KUNIT_ASSERT_EQ (test,strlcpy (pad.buf, src, +sizeof (pad.buf) + unconst -1 ), +sizeof (src) -1 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Keeping space for %NUL, last two bytes should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* Legitimate max-size strlcpy. */ +KUNIT_ASSERT_EQ (test,strlcpy (pad.buf, src, +sizeof (pad.buf) + unconst), +sizeof (src) -1 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* A trailing %NUL will exist. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); + +/* Now verify that FORTIFY is working... */ +KUNIT_ASSERT_EQ (test,strlcpy (pad.buf, src, +sizeof (pad.buf) + unconst +1 ), +sizeof (src) -1 ); +/* Should catch the overflow. */ +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* And much further... */ +KUNIT_ASSERT_EQ (test,strlcpy (pad.buf, src, +sizeof (src) *2 + unconst), +sizeof (src) -1 ); +/* Should catch the overflow. */ +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Catch over-read. */ +KUNIT_ASSERT_EQ (test,strlcpy (pad.buf, tiny, +sizeof (pad.buf) + unconst), +sizeof (tiny)); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +} + +static void strscpy_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[] ="Copy me fully into a small buffer and I will overflow!" ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strscpy() 1 less than of max size. */ +KUNIT_ASSERT_EQ (test,strscpy (pad.buf, src, +sizeof (pad.buf) + unconst -1 ), + -E2BIG ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Keeping space for %NUL, last two bytes should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* Legitimate max-size strscpy. */ +KUNIT_ASSERT_EQ (test,strscpy (pad.buf, src, +sizeof (pad.buf) + unconst), + -E2BIG ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* A trailing %NUL will exist. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); + +/* Now verify that FORTIFY is working... */ +KUNIT_ASSERT_EQ (test,strscpy (pad.buf, src, +sizeof (pad.buf) + unconst +1 ), + -E2BIG ); +/* Should catch the overflow. */ +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* And much further... */ +KUNIT_ASSERT_EQ (test,strscpy (pad.buf, src, +sizeof (src) *2 + unconst), + -E2BIG ); +/* Should catch the overflow. */ +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +/* And we will not have gone beyond. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); +} + +static void strcat_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[sizeof (pad.buf) /2 ] = { }; +char one[] ="A" ; +char two[] ="BC" ; +int i; + +/* Fill 15 bytes with valid characters. */ +for (i =0 ; i <sizeof (src) -1 ; i++) + src[i] = i +'A' ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strcat() using less than half max size. */ +KUNIT_ASSERT_TRUE (test,strcat (pad.buf, src) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Legitimate strcat() now 2 bytes shy of end. */ +KUNIT_ASSERT_TRUE (test,strcat (pad.buf, src) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Last two bytes should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* Add one more character to the end. */ +KUNIT_ASSERT_TRUE (test,strcat (pad.buf, one) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Last byte should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* And this one char will overflow. */ +KUNIT_ASSERT_TRUE (test,strcat (pad.buf, one) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +/* Last byte should be %NUL thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* And adding two will overflow more. */ +KUNIT_ASSERT_TRUE (test,strcat (pad.buf, two) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +/* Last byte should be %NUL thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); +} + +static void strncat_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[sizeof (pad.buf)] = { }; +int i, partial; + +/* Fill 31 bytes with valid characters. */ + partial =sizeof (src) /2 -1 ; +for (i =0 ; i < partial; i++) + src[i] = i +'A' ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strncat() using less than half max size. */ +KUNIT_ASSERT_TRUE (test,strncat (pad.buf, src, partial) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Legitimate strncat() now 2 bytes shy of end. */ +KUNIT_ASSERT_TRUE (test,strncat (pad.buf, src, partial) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Last two bytes should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* Add one more character to the end. */ +KUNIT_ASSERT_TRUE (test,strncat (pad.buf, src,1 ) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Last byte should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* And this one char will overflow. */ +KUNIT_ASSERT_TRUE (test,strncat (pad.buf, src,1 ) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +/* Last byte should be %NUL thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* And adding two will overflow more. */ +KUNIT_ASSERT_TRUE (test,strncat (pad.buf, src,2 ) == pad.buf); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +/* Last byte should be %NUL thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Force an unterminated destination, and overflow. */ + pad.buf[sizeof (pad.buf) -1 ] ='A' ; +KUNIT_ASSERT_TRUE (test,strncat (pad.buf, src,1 ) == pad.buf); +/* This will have tripped both strlen() and strcat(). */ +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,3 ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +/* But we should not go beyond the end. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); +} + +static void strlcat_test (struct kunit *test) +{ +struct fortify_padding pad = { }; +char src[sizeof (pad.buf)] = { }; +int i, partial; +int len =sizeof (pad.buf) + unconst; + +/* Fill 15 bytes with valid characters. */ + partial =sizeof (src) /2 -1 ; +for (i =0 ; i < partial; i++) + src[i] = i +'A' ; + +/* Destination is %NUL-filled to start with. */ +KUNIT_EXPECT_EQ (test, pad.bytes_before,0 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Legitimate strlcat() using less than half max size. */ +KUNIT_ASSERT_EQ (test,strlcat (pad.buf, src, len), partial); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Legitimate strlcat() now 2 bytes shy of end. */ +KUNIT_ASSERT_EQ (test,strlcat (pad.buf, src, len), partial *2 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Last two bytes should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* Add one more character to the end. */ +KUNIT_ASSERT_EQ (test,strlcat (pad.buf,"Q" , len), partial *2 +1 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,0 ); +/* Last byte should be %NUL */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); + +/* And this one char will overflow. */ +KUNIT_ASSERT_EQ (test,strlcat (pad.buf,"V" , len *2 ), len); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,1 ); +/* Last byte should be %NUL thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* And adding two will overflow more. */ +KUNIT_ASSERT_EQ (test,strlcat (pad.buf,"QQ" , len *2 ), len +1 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +/* Last byte should be %NUL thanks to FORTIFY. */ +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Force an unterminated destination, and overflow. */ + pad.buf[sizeof (pad.buf) -1 ] ='A' ; +KUNIT_ASSERT_EQ (test,strlcat (pad.buf,"TT" , len *2 ), len +2 ); +/* This will have tripped both strlen() and strlcat(). */ +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,2 ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -2 ],'\0' ); +KUNIT_EXPECT_NE (test, pad.buf[sizeof (pad.buf) -3 ],'\0' ); +/* But we should not go beyond the end. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); + +/* Force an unterminated source, and overflow. */ +memset (src,'B' ,sizeof (src)); + pad.buf[sizeof (pad.buf) -1 ] ='\0' ; +KUNIT_ASSERT_EQ (test,strlcat (pad.buf, src, len *3 ), len -1 +sizeof (src)); +/* This will have tripped both strlen() and strlcat(). */ +KUNIT_EXPECT_EQ (test, fortify_read_overflows,3 ); +KUNIT_EXPECT_EQ (test, fortify_write_overflows,3 ); +KUNIT_EXPECT_EQ (test, pad.buf[sizeof (pad.buf) -1 ],'\0' ); +/* But we should not go beyond the end. */ +KUNIT_EXPECT_EQ (test, pad.bytes_after,0 ); +} + +static void memscan_test (struct kunit *test) +{ +char haystack[] ="Where oh where is my memory range?" ; +char *mem = haystack +strlen ("Where oh where is " ); +char needle ='m' ; +size_t len =sizeof (haystack) + unconst; + +KUNIT_ASSERT_PTR_EQ (test,memscan (haystack, needle, len), + mem); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +/* Catch too-large range. */ +KUNIT_ASSERT_PTR_EQ (test,memscan (haystack, needle, len +1 ), +NULL ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_ASSERT_PTR_EQ (test,memscan (haystack, needle, len *2 ), +NULL ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +} + +static void memchr_test (struct kunit *test) +{ +char haystack[] ="Where oh where is my memory range?" ; +char *mem = haystack +strlen ("Where oh where is " ); +char needle ='m' ; +size_t len =sizeof (haystack) + unconst; + +KUNIT_ASSERT_PTR_EQ (test,memchr (haystack, needle, len), + mem); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +/* Catch too-large range. */ +KUNIT_ASSERT_PTR_EQ (test,memchr (haystack, needle, len +1 ), +NULL ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_ASSERT_PTR_EQ (test,memchr (haystack, needle, len *2 ), +NULL ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +} + +static void memchr_inv_test (struct kunit *test) +{ +char haystack[] ="Where oh where is my memory range?" ; +char *mem = haystack +1 ; +char needle ='W' ; +size_t len =sizeof (haystack) + unconst; + +/* Normal search is okay. */ +KUNIT_ASSERT_PTR_EQ (test,memchr_inv (haystack, needle, len), + mem); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +/* Catch too-large range. */ +KUNIT_ASSERT_PTR_EQ (test,memchr_inv (haystack, needle, len +1 ), +NULL ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +KUNIT_ASSERT_PTR_EQ (test,memchr_inv (haystack, needle, len *2 ), +NULL ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +} + +static void memcmp_test (struct kunit *test) +{ +char one[] ="My mind is going ..." ; +char two[] ="My mind is going ... I can feel it." ; +size_t one_len =sizeof (one) + unconst -1 ; +size_t two_len =sizeof (two) + unconst -1 ; + +/* We match the first string (ignoring the %NUL). */ +KUNIT_ASSERT_EQ (test,memcmp (one, two, one_len),0 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +/* Still in bounds, but no longer matching. */ +KUNIT_ASSERT_EQ (test,memcmp (one, two, one_len +1 ),-32 ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); + +/* Catch too-large ranges. */ +KUNIT_ASSERT_EQ (test,memcmp (one, two, one_len +2 ),INT_MIN ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); + +KUNIT_ASSERT_EQ (test,memcmp (two, one, two_len +2 ),INT_MIN ); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +} + +static void kmemdup_test (struct kunit *test) +{ +char src[] ="I got Doom running on it!" ; +char *copy; +size_t len =sizeof (src) + unconst; + +/* Copy is within bounds. */ + copy =kmemdup (src, len,GFP_KERNEL ); +KUNIT_EXPECT_NOT_NULL (test, copy); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +kfree (copy); + +/* Without %NUL. */ + copy =kmemdup (src, len -1 ,GFP_KERNEL ); +KUNIT_EXPECT_NOT_NULL (test, copy); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +kfree (copy); + +/* Tiny bounds. */ + copy =kmemdup (src,1 ,GFP_KERNEL ); +KUNIT_EXPECT_NOT_NULL (test, copy); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,0 ); +kfree (copy); + +/* Out of bounds by 1 byte. */ + copy =kmemdup (src, len +1 ,GFP_KERNEL ); +KUNIT_EXPECT_NULL (test, copy); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,1 ); +kfree (copy); + +/* Way out of bounds. */ + copy =kmemdup (src, len *2 ,GFP_KERNEL ); +KUNIT_EXPECT_NULL (test, copy); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,2 ); +kfree (copy); + +/* Starting offset causing out of bounds. */ + copy =kmemdup (src +1 , len,GFP_KERNEL ); +KUNIT_EXPECT_NULL (test, copy); +KUNIT_EXPECT_EQ (test, fortify_read_overflows,3 ); +kfree (copy); +} +static int fortify_test_init (struct kunit *test) {if (!IS_ENABLED (CONFIG_FORTIFY_SOURCE ))
@@ -375,6 +1032,22 @@ static struct kunit_case fortify_test_cases[] = {KUNIT_CASE (alloc_size_kvmalloc_dynamic_test),KUNIT_CASE (alloc_size_devm_kmalloc_const_test),KUNIT_CASE (alloc_size_devm_kmalloc_dynamic_test), +KUNIT_CASE (strlen_test), +KUNIT_CASE (strnlen_test), +KUNIT_CASE (strcpy_test), +KUNIT_CASE (strncpy_test), +KUNIT_CASE (strlcpy_test), +KUNIT_CASE (strscpy_test), +KUNIT_CASE (strcat_test), +KUNIT_CASE (strncat_test), +KUNIT_CASE (strlcat_test), +/* skip memset: performs bounds checking on whole structs */ +/* skip memcpy: still using warn-and-clobber instead of hard-fail */ +KUNIT_CASE (memscan_test), +KUNIT_CASE (memchr_test), +KUNIT_CASE (memchr_inv_test), +KUNIT_CASE (memcmp_test), + KUNIT_CASE(kmemdup_test), {} };
Signature · 1 line
2.34.1
kernel test robot
build botkernel test robot noticed the following build warnings:
Hi Kees,
kernel test robot noticed the following build warnings:
[auto build test WARNING on kees/for-next/hardening]
[also build test WARNING on kees/for-next/pstore kees/for-next/kspp linus/master tip/x86/core v6.3-rc5 next-20230406] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Kees-Cook/kunit-tool-Enable-CONFIG_FORTIFY_SOURCE-under-UML/20230408-032959 base: https://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git for-next/hardening patch link: https://lore.kernel.org/r/20230407192717.636137-9-keescook%40chromium.org patch subject: [PATCH v2 09/10] fortify: Add KUnit tests for runtime overflows config: openrisc-randconfig-r034-20230405 (https://download.01.org/0day-ci/archive/20230408/[email protected]/config) compiler: or1k-linux-gcc (GCC) 12.1.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/d212962ef7682ee160bf38fa455475558f031759
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Kees-Cook/kunit-tool-Enable-CONFIG_FORTIFY_SOURCE-under-UML/20230408-032959 git checkout d212962ef7682ee160bf38fa455475558f031759
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=openrisc olddefconfig COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=openrisc SHELL=/bin/bash lib/
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
In file included from lib/fortify_kunit.c:28:
lib/fortify_kunit.c: In function 'strnlen_test':
>> lib/fortify_kunit.c:412:31: warning: 'strnlen' specified bound 33 exceeds source size 32 [-Wstringop-overread]
412 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 1), end);
include/kunit/test.h:584:38: note: in definition of macro 'KUNIT_BASE_BINARY_ASSERTION'
584 | const typeof(left) __left = (left); \
| ^~~~
include/kunit/test.h:776:9: note: in expansion of macro 'KUNIT_BINARY_INT_ASSERTION'
776 | KUNIT_BINARY_INT_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:773:9: note: in expansion of macro 'KUNIT_EXPECT_EQ_MSG'
773 | KUNIT_EXPECT_EQ_MSG(test, left, right, NULL)
| ^~~~~~~~~~~~~~~~~~~
lib/fortify_kunit.c:412:9: note: in expansion of macro 'KUNIT_EXPECT_EQ'
412 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 1), end);
| ^~~~~~~~~~~~~~~
lib/fortify_kunit.c:359:14: note: source object allocated here
359 | char buf[32];
| ^~~
lib/fortify_kunit.c:414:31: warning: 'strnlen' specified bound 34 exceeds source size 32 [-Wstringop-overread]
414 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 2), end);
include/kunit/test.h:584:38: note: in definition of macro 'KUNIT_BASE_BINARY_ASSERTION'
584 | const typeof(left) __left = (left); \
| ^~~~
include/kunit/test.h:776:9: note: in expansion of macro 'KUNIT_BINARY_INT_ASSERTION'
776 | KUNIT_BINARY_INT_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:773:9: note: in expansion of macro 'KUNIT_EXPECT_EQ_MSG'
773 | KUNIT_EXPECT_EQ_MSG(test, left, right, NULL)
| ^~~~~~~~~~~~~~~~~~~
lib/fortify_kunit.c:414:9: note: in expansion of macro 'KUNIT_EXPECT_EQ'
414 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 2), end);
| ^~~~~~~~~~~~~~~
lib/fortify_kunit.c:359:14: note: source object allocated here
359 | char buf[32];
| ^~~vim +/strnlen +412 lib/fortify_kunit.c
387
388 static void strnlen_test(struct kunit *test)
389 {
390 struct fortify_padding pad = { };
391 int i, end = sizeof(pad.buf) - 1;
392
393 /* Fill 31 bytes with valid characters. */
394 for (i = 0; i < sizeof(pad.buf) - 1; i++)
395 pad.buf[i] = i + '0';
396 /* Trailing bytes are still %NUL. */
397 KUNIT_EXPECT_EQ(test, pad.buf[end], '\0');
398 KUNIT_EXPECT_EQ(test, pad.bytes_after, 0);
399
400 /* String is terminated, so strnlen() is valid. */
401 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, sizeof(pad.buf)), end);
402 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 0);
403 /* A truncated strnlen() will be safe, too. */
404 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, sizeof(pad.buf) / 2),
405 sizeof(pad.buf) / 2);
406 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 0);
407
408 /* Make string unterminated, and recount. */
409 pad.buf[end] = 'A';
410 end = sizeof(pad.buf);
411 /* Reading beyond with strncpy() will fail. */
> 412 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 1), end);
413 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 1);
414 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 2), end);
415 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 2);
416
417 /* Early-truncated is safe still, though. */
418 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end), end);
419 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 2);
420
421 end = sizeof(pad.buf) / 2;
422 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end), end);
423 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 2);
424 }
425
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests
Quoted 29 lines · kernel test robot
Hi Kees,
kernel test robot noticed the following build warnings:
[auto build test WARNING on kees/for-next/hardening]
[also build test WARNING on kees/for-next/pstore kees/for-next/kspp linus/master tip/x86/core v6.3-rc5 next-20230406] [If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]url: https://github.com/intel-lab-lkp/linux/commits/Kees-Cook/kunit-tool-Enable-CONFIG_FORTIFY_SOURCE-under-UML/20230408-032959 base: https://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git for-next/hardening patch link: https://lore.kernel.org/r/20230407192717.636137-9-keescook%40chromium.org patch subject: [PATCH v2 09/10] fortify: Add KUnit tests for runtime overflows config: openrisc-randconfig-r034-20230405 (https://download.01.org/0day-ci/archive/20230408/[email protected]/config) compiler: or1k-linux-gcc (GCC) 12.1.0reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/d212962ef7682ee160bf38fa455475558f031759
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Kees-Cook/kunit-tool-Enable-CONFIG_FORTIFY_SOURCE-under-UML/20230408-032959 git checkoutd212962ef7682ee160bf38fa455475558f031759
# save the config file
mkdirbuild_dir&& cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=openrisc olddefconfig COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=openrisc SHELL=/bin/bashlib/
Quoted 9 lines
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/All warnings (new ones prefixed by >>):
In file included from
lib/fortify_kunit.c:28:
lib/fortify_kunit.c: In function 'strnlen_test':Quoted 1 line
Quoted 1 line
lib/fortify_kunit.c:412:31: warning: 'strnlen' specified bound 33 exceeds source size 32 [-Wstringop-overread]
If we expect to validate the runtime behavior of fortify, but using constants that the compiler can check for readability in this test, then we might need to use the
_Pragma/__diag infrastructure from include/linux/compiler_types.h to disable -Wstringop-overread; or disable it at the makefile level.
Quoted 80 lines
412 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 1), end); include/kunit/test.h:584:38: note: in definition of macro 'KUNIT_BASE_BINARY_ASSERTION' 584 | const typeof(left) __left = (left); \ | ^~~~ include/kunit/test.h:776:9: note: in expansion of macro 'KUNIT_BINARY_INT_ASSERTION' 776 | KUNIT_BINARY_INT_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:773:9: note: in expansion of macro 'KUNIT_EXPECT_EQ_MSG' 773 | KUNIT_EXPECT_EQ_MSG(test, left, right, NULL) | ^~~~~~~~~~~~~~~~~~~ lib/fortify_kunit.c:412:9: note: in expansion of macro 'KUNIT_EXPECT_EQ' 412 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 1), end); | ^~~~~~~~~~~~~~~ lib/fortify_kunit.c:359:14: note: source object allocated here 359 | char buf[32]; | ^~~ lib/fortify_kunit.c:414:31: warning: 'strnlen' specified bound 34 exceeds source size 32 [-Wstringop-overread] 414 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 2), end); include/kunit/test.h:584:38: note: in definition of macro 'KUNIT_BASE_BINARY_ASSERTION' 584 | const typeof(left) __left = (left); \ | ^~~~ include/kunit/test.h:776:9: note: in expansion of macro 'KUNIT_BINARY_INT_ASSERTION' 776 | KUNIT_BINARY_INT_ASSERTION(test, \ | ^~~~~~~~~~~~~~~~~~~~~~~~~~ include/kunit/test.h:773:9: note: in expansion of macro 'KUNIT_EXPECT_EQ_MSG' 773 | KUNIT_EXPECT_EQ_MSG(test, left, right, NULL) | ^~~~~~~~~~~~~~~~~~~ lib/fortify_kunit.c:414:9: note: in expansion of macro 'KUNIT_EXPECT_EQ' 414 | KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 2), end); | ^~~~~~~~~~~~~~~ lib/fortify_kunit.c:359:14: note: source object allocated here 359 | char buf[32]; | ^~~vim +/strnlen +412
lib/fortify_kunit.c387 388 static void strnlen_test(struct kunit *test) 389 { 390 struct fortify_padding pad = { }; 391 int i, end = sizeof(pad.buf) - 1; 392 393 /* Fill 31 bytes with valid characters. */ 394 for (i = 0; i < sizeof(pad.buf) - 1; i++) 395 pad.buf[i] = i + '0'; 396 /* Trailing bytes are still %NUL. */ 397 KUNIT_EXPECT_EQ(test, pad.buf[end], '\0'); 398 KUNIT_EXPECT_EQ(test, pad.bytes_after, 0); 399 400 /* String is terminated, so strnlen() is valid. */ 401 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, sizeof(pad.buf)), end); 402 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 0); 403 /* A truncated strnlen() will be safe, too. */ 404 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, sizeof(pad.buf) / 2), 405 sizeof(pad.buf) / 2); 406 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 0); 407 408 /* Make string unterminated, and recount. */ 409 pad.buf[end] = 'A'; 410 end = sizeof(pad.buf); 411 /* Reading beyond with strncpy() will fail. */Quoted 1 line
412
KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 1), end);413 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 1); 414 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end + 2), end); 415 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 2); 416 417 /* Early-truncated is safe still, though. */ 418 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end), end); 419 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 2); 420 421 end = sizeof(pad.buf) / 2; 422 KUNIT_EXPECT_EQ(test, strnlen(pad.buf, end), end); 423 KUNIT_EXPECT_EQ(test, fortify_read_overflows, 2);424 }
425--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
Signature · 2 lines
Thanks, ~Nick Desaulniers
PATCH v2 10/10 fortify: Improve buffer overflow reporting
In reply to Kees CookImprove the reporting of buffer overflows under CONFIG_FORTIFY_SOURCE to help accelerate debugging efforts. The calculations are all just sitting in registers anyway, so pass them along to the function to be reported.
For example, before:
detected buffer overflow in memcpy
and after:
memcpy: detected buffer overflow: 4096 byte read from buffer of size 1
--- arch/arm/boot/compressed/misc.c | 2 +- arch/x86/boot/compressed/misc.c | 2 +- include/linux/fortify-string.h | 61 ++++++++++++++++++--------------- lib/fortify_kunit.c | 4 +-- lib/string_helpers.c | 9 ++--- 5 files changed, 42 insertions(+), 36 deletions(-)
arch/arm/boot/compressed/misc.c +1 -1
@@ -160,7 +160,7 @@ decompress_kernel(unsigned long output_start, unsigned long free_mem_ptr_p,putstr (" done, booting the kernel.\n" ); } -void __fortify_panic (const u8 reason) +void __fortify_panic (const u8 reason,size_t avail,size_t size) {error ("detected buffer overflow" ); }
arch/x86/boot/compressed/misc.c +1 -1
@@ -470,7 +470,7 @@ asmlinkage __visible void *extract_kernel(void *rmode, memptr heap,return output + entry_offset; } -void __fortify_panic (const u8 reason) +void __fortify_panic (const u8 reason,size_t avail,size_t size) {error ("detected buffer overflow" ); }
include/linux/fortify-string.h +33 -28
182 lines not on this page · raw message
lib/fortify_kunit.c +2 -2
@@ -18,9 +18,9 @@/* Call kunit_fortify_panic() instead of fortify_panic() */ #define FORTIFY_KUNIT_OVERRIDE void fortify_add_kunit_error (int write); -#define kunit_fortify_panic (func, write, retfail) \ +#define kunit_fortify_panic (func, write, avail, size, retfail) \ do { \ - __fortify_report(FORTIFY_REASON(func, write)); \ + __fortify_report(FORTIFY_REASON(func, write), avail, size); \ fortify_add_kunit_error(write); \ return (retfail); \ } while (0)
lib/string_helpers.c +5 -4
@@ -1029,20 +1029,21 @@ static const char * const fortify_func_name[] = { EACH_FORTIFY_FUNC(MAKE_FORTIFY_FUNC_NAME) }; -void __fortify_report (const u8 reason) +void __fortify_report (const u8 reason,const size_t avail,const size_t size) {const u8 func =FORTIFY_REASON_FUNC (reason);const bool write =FORTIFY_REASON_DIR (reason);const char *name; name = fortify_func_name[min_t (u8, func,FORTIFY_FUNC_UNKNOWN )]; -WARN (1 ,"%s: detected buffer %s overflow\n" , name,str_read_write (!write)); +WARN (1 ,"%s: detected buffer overflow: %zu byte %s buffer of size %zu\n" , + name, size,str_read_write (!write), avail); }EXPORT_SYMBOL (__fortify_report); -void __fortify_panic (const u8 reason) +void __fortify_panic (const u8 reason,const size_t avail,const size_t size) { -__fortify_report (reason); +__fortify_report (reason, avail, size);BUG (); }EXPORT_SYMBOL (__fortify_panic);
Signature · 1 line
2.34.1