string.h: detect intra-object overflow in fortified string functions
PATCH 1/1 string.h: detect intra-object overflow in fortified string functions
When the fortify feature was first introduced in commit 6974f0c4555e ("include/linux/string.h: add the option of fortified string.h functions"), Daniel Micay observed:
* It should be possible to optionally use __builtin_object_size(x, 1) for some functions (C strings) to detect intra-object overflows (like glibc's _FORTIFY_SOURCE=2), but for now this takes the conservative approach to avoid likely compatibility issues.
This is a case that often cannot be caught by KASAN. Consider:
struct foo {
char a[10];
char b[10];
}void test() {
char *msg;
struct foo foo;
msg = kmalloc(16, GFP_KERNEL);
strcpy(msg, "Hello world!!");
// this copy overwrites foo.b
strcpy(foo.a, msg);
}The questionable copy overflows foo.a and writes to foo.b as well. It cannot be detected by KASAN. Currently it is also not detected by fortify, because strcpy considers __builtin_object_size(x, 0), which considers the size of the surrounding object (here, struct foo). However, if we switch the string functions over to use __builtin_object_size(x, 1), the compiler will measure the size of the closest surrounding subobject (here, foo.a), rather than the size of the surrounding object as a whole. See
https://gcc.gnu.org/onlinedocs/gcc/Object-Size-Checking.html for more info.
Only do this for string functions: we cannot use it on things like memcpy, memmove, memcmp and memchr_inv due to code like this which purposefully operates on multiple structure members:
(arch/x86/kernel/traps.c)
/* * regs->sp points to the failing IRET frame on the * ESPFIX64 stack. Copy it to the entry stack. This fills * in gpregs->ss through gpregs->ip. * */ memmove(&gpregs->ip, (void *)regs->sp, 5*8);
This change passes an allyesconfig on powerpc and x86, and an x86 kernel built with it survives running with syz-stress from syzkaller, so it seems safe so far.
Add a test demonstrating and validating the feature to lkdtm:FORTIFY_SUBOBJECT.
--- drivers/misc/lkdtm/bugs.c | 26 ++++++++++++++++++++++++++ drivers/misc/lkdtm/core.c | 1 + drivers/misc/lkdtm/lkdtm.h | 1 + include/linux/string.h | 27 ++++++++++++++++----------- 4 files changed, 44 insertions(+), 11 deletions(-)
drivers/misc/lkdtm/bugs.c +26 -0
@@ -11,6 +11,7 @@#include <linux/sched/signal.h> #include <linux/sched/task_stack.h> #include <linux/uaccess.h> +#include <linux/slab.h> #ifdef CONFIG_X86_32 #include <asm/desc.h>
@@ -376,3 +377,28 @@ void lkdtm_DOUBLE_FAULT(void) panic("tried to double fault but didn't die\n"); }#endif + +void lkdtm_FORTIFY_SUBOBJECT (void ) +{ +struct target { +char a[10 ]; +char b[10 ]; + } target; +char *src; + + src =kmalloc (20 ,GFP_KERNEL ); +strscpy (src,"over ten bytes" ,20 ); + +pr_info ("trying to strcpy past the end of a member of a struct\n" ); + +/* +* strncpy(target.a, src, 20); will hit a compile error because the +* compiler knows at build time that target.a < 20 bytes. Use strcpy() +* to force a runtime error. +*/ +strcpy (target.a, src); + +/* Use target.a to prevent the code from being eliminated */ +pr_err ("FAIL: fortify did not catch an sub-object overrun!\n" +"\"%s\" was copied.\n" , target.a); +}
drivers/misc/lkdtm/core.c +1 -0
@@ -117,6 +117,7 @@ static const struct crashtype crashtypes[] = {CRASHTYPE (STACK_GUARD_PAGE_TRAILING ),CRASHTYPE (UNSET_SMEP ),CRASHTYPE (UNALIGNED_LOAD_STORE_WRITE ), +CRASHTYPE (FORTIFY_SUBOBJECT ),CRASHTYPE (OVERWRITE_ALLOCATION ),CRASHTYPE (WRITE_AFTER_FREE ), CRASHTYPE(READ_AFTER_FREE),
drivers/misc/lkdtm/lkdtm.h +1 -0
@@ -31,6 +31,7 @@ void lkdtm_UNSET_SMEP(void);#ifdef CONFIG_X86_32 void lkdtm_DOUBLE_FAULT (void );#endif +void lkdtm_FORTIFY_SUBOBJECT (void );/* lkdtm_heap.c */ void __init lkdtm_heap_init (void );
include/linux/string.h +16 -11
@@ -319,7 +319,7 @@ void __write_overflow(void) __compiletime_error("detected write beyond size of o#if !defined(__NO_FORTIFY) && defined(__OPTIMIZE__) && defined(CONFIG_FORTIFY_SOURCE ) __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );if (__builtin_constant_p (size) && p_size < size)__write_overflow ();if (p_size < size)
@@ -329,7 +329,7 @@ __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size) __FORTIFY_INLINE char *strcat(char *p, const char *q) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );if (p_size == (size_t )-1 )return __builtin_strcat (p, q);if (strlcat (p, q, p_size) >= p_size)
@@ -340,7 +340,7 @@ __FORTIFY_INLINE char *strcat(char *p, const char *q) __FORTIFY_INLINE __kernel_size_t strlen(const char *p) {__kernel_size_t ret; -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );/* Work around gcc excess stack consumption issue */ if (p_size == (size_t)-1 ||
@@ -355,7 +355,7 @@ __FORTIFY_INLINE __kernel_size_t strlen(const char *p) extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen); __FORTIFY_INLINE __kernel_size_t strnlen(const char *p, __kernel_size_t maxlen) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );__kernel_size_t ret =__real_strnlen (p, maxlen < p_size ? maxlen : p_size);if (p_size <= ret && maxlen != ret)fortify_panic (__func__);
@@ -367,8 +367,8 @@ extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy); __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size) {size_t ret; -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 );if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __real_strlcpy (p, q, size); ret =strlen (q);
@@ -388,8 +388,8 @@ __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size) __FORTIFY_INLINE char *strncat(char *p, const char *q, __kernel_size_t count) {size_t p_len, copy_len; -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 );if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __builtin_strncat (p, q, count); p_len =strlen (p);
@@ -502,11 +502,16 @@ __FORTIFY_INLINE void *kmemdup(const void *p, size_t size, gfp_t gfp)/* defined after fortified strlen and memcpy to reuse them */ __FORTIFY_INLINE char *strcpy(char *p, const char *q) { -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 ); +size_t size;if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __builtin_strcpy (p, q); -memcpy (p, q,strlen (q) +1 ); + size =strlen (q) +1 ; +/* test here to use the more stringent object size */ +if (p_size < size) +fortify_panic (__func__); +memcpy (p, q, size);return p; }
Signature · 1 line
2.20.1
Quoted 9 lines · Daniel Axtens
When the fortify feature was first introduced in commit
6974f0c4555e("include/linux/string.h: add the option of fortifiedstring.hfunctions"), Daniel Micay observed:* It should be possible to optionally use
__builtin_object_size(x, 1)for some functions (C strings) to detect intra-object overflows (like glibc's _FORTIFY_SOURCE=2), but for now this takes the conservative approach to avoid likely compatibility issues.
Yes please! :)
Quoted 39 lines
This is a case that often cannot be caught by KASAN. Consider:
struct foo { char a[10]; char b[10]; }void test() { char *msg; struct foo foo; msg = kmalloc(16, GFP_KERNEL); strcpy(msg, "Hello world!!"); // this copy overwrites foo.b strcpy(foo.a, msg); }The questionable copy overflows foo.a and writes to foo.b as well. It cannot be detected by KASAN. Currently it is also not detected by fortify, because strcpy considers
__builtin_object_size(x, 0), which considers the size of the surrounding object (here, struct foo). However, if we switch the string functions over to use__builtin_object_size(x, 1), the compiler will measure the size of the closest surrounding subobject (here, foo.a), rather than the size of the surrounding object as a whole. See
https://gcc.gnu.org/onlinedocs/gcc/Object-Size-Checking.html for more info.Only do this for string functions: we cannot use it on things like memcpy, memmove, memcmp and
memchr_invdue to code like this which purposefully operates on multiple structure members:
(arch/x86/kernel/traps.c)/* * regs->sp points to the failing IRET frame on the * ESPFIX64 stack. Copy it to the entry stack. This fills * in gpregs->ss through gpregs->ip. * */ memmove(&gpregs->ip, (void *)regs->sp, 5*8);
Quoted 6 lines
This change passes an allyesconfig on powerpc and x86, and an x86 kernel built with it survives running with syz-stress from syzkaller, so it seems safe so far.
Add a test demonstrating and validating the feature to lkdtm:
FORTIFY_SUBOBJECT.
Can you actually split this into two patches? One with the lkdtm changes and one with the string.h changes?
I can take the lkdtm changes and then akpm can take the string.h changes (please add him as the To for v2, and include lkml in Cc too). (Also, it's be nice to have a non-subobject fortify test in lkdtm too.)
Thanks for doing this! Please consider these:
-Kees
Quoted 161 lines
Cc Daniel Micay <[email protected]>Cc Kees Cook <[email protected]>Signed-off-by Daniel Axtens <[email protected]>--- drivers/misc/lkdtm/bugs.c | 26 ++++++++++++++++++++++++++ drivers/misc/lkdtm/core.c | 1 + drivers/misc/lkdtm/lkdtm.h | 1 + include/linux/string.h | 27 ++++++++++++++++----------- 4 files changed, 44 insertions(+), 11 deletions(-)drivers/misc/lkdtm/bugs.c +26
-0@@ -11,6 +11,7 @@#include <linux/sched/signal.h> #include <linux/sched/task_stack.h> #include <linux/uaccess.h> +#include <linux/slab.h> #ifdef CONFIG_X86_32 #include <asm/desc.h> @@ -376,3 +377,28 @@ void lkdtm_DOUBLE_FAULT(void) panic("tried to double fault but didn't die\n"); }#endif + +void lkdtm_FORTIFY_SUBOBJECT (void ) +{ +struct target { +char a[10 ]; +char b[10 ]; + } target; +char *src; + + src =kmalloc (20 ,GFP_KERNEL ); +strscpy (src,"over ten bytes" ,20 ); + +pr_info ("trying to strcpy past the end of a member of a struct\n" ); + +/* +* strncpy(target.a, src, 20); will hit a compile error because the +* compiler knows at build time that target.a < 20 bytes. Use strcpy() +* to force a runtime error. +*/ +strcpy (target.a, src); + +/* Use target.a to prevent the code from being eliminated */ +pr_err ("FAIL: fortify did not catch an sub-object overrun!\n" +"\"%s\" was copied.\n" , target.a); +}drivers/misc/lkdtm/core.c +1
-0@@ -117,6 +117,7 @@ static const struct crashtype crashtypes[] = {CRASHTYPE (STACK_GUARD_PAGE_TRAILING ),CRASHTYPE (UNSET_SMEP ),CRASHTYPE (UNALIGNED_LOAD_STORE_WRITE ), +CRASHTYPE (FORTIFY_SUBOBJECT ),CRASHTYPE (OVERWRITE_ALLOCATION ),CRASHTYPE (WRITE_AFTER_FREE ), CRASHTYPE(READ_AFTER_FREE),drivers/misc/lkdtm/lkdtm.h +1
-0@@ -31,6 +31,7 @@ void lkdtm_UNSET_SMEP(void);#ifdef CONFIG_X86_32 void lkdtm_DOUBLE_FAULT (void );#endif +void lkdtm_FORTIFY_SUBOBJECT (void );/* lkdtm_heap.c */ void __init lkdtm_heap_init (void );include/linux/string.h +16
-11@@ -319,7 +319,7 @@ void __write_overflow(void) __compiletime_error("detected write beyond size of o#if !defined(__NO_FORTIFY) && defined(__OPTIMIZE__) && defined(CONFIG_FORTIFY_SOURCE ) __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );if (__builtin_constant_p (size) && p_size < size)__write_overflow ();if (p_size < size)@@ -329,7 +329,7 @@ __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size) __FORTIFY_INLINE char *strcat(char *p, const char *q) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );if (p_size == (size_t )-1 )return __builtin_strcat (p, q);if (strlcat (p, q, p_size) >= p_size)@@ -340,7 +340,7 @@ __FORTIFY_INLINE char *strcat(char *p, const char *q) __FORTIFY_INLINE __kernel_size_t strlen(const char *p) {__kernel_size_t ret; -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );/* Work around gcc excess stack consumption issue */ if (p_size == (size_t)-1 ||@@ -355,7 +355,7 @@ __FORTIFY_INLINE __kernel_size_t strlen(const char *p) extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen); __FORTIFY_INLINE __kernel_size_t strnlen(const char *p, __kernel_size_t maxlen) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );__kernel_size_t ret =__real_strnlen (p, maxlen < p_size ? maxlen : p_size);if (p_size <= ret && maxlen != ret)fortify_panic (__func__);@@ -367,8 +367,8 @@ extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy); __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size) {size_t ret; -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 );if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __real_strlcpy (p, q, size); ret =strlen (q);@@ -388,8 +388,8 @@ __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size) __FORTIFY_INLINE char *strncat(char *p, const char *q, __kernel_size_t count) {size_t p_len, copy_len; -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 );if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __builtin_strncat (p, q, count); p_len =strlen (p);@@ -502,11 +502,16 @@ __FORTIFY_INLINE void *kmemdup(const void *p, size_t size, gfp_t gfp)/* defined after fortified strlen and memcpy to reuse them */ __FORTIFY_INLINE char *strcpy(char *p, const char *q) { -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 ); +size_t size;if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __builtin_strcpy (p, q); -memcpy (p, q,strlen (q) +1 ); + size =strlen (q) +1 ; +/* test here to use the more stringent object size */ +if (p_size < size) +fortify_panic (__func__); +memcpy (p, q, size);return p; }Signature · 1 line
2.20.1
Signature · 1 line
Kees Cook
Hi Kees,
Quoted 5 lines
Quoted 2 lines
Add a test demonstrating and validating the feature to lkdtm:
FORTIFY_SUBOBJECT.Can you actually split this into two patches? One with the lkdtm changes and one with the
string.hchanges?
Will do.
Quoted 3 lines
I can take the lkdtm changes and then akpm can take the
string.hchanges (please add him as the To for v2, and include lkml in Cc too). (Also, it's be nice to have a non-subobject fortify test in lkdtm too.)
(D'oh, both of those are obvious recipients in hind-sight, clearly I shouldn't send patches right before leaving work on Friday!)
Quoted 4 lines
Thanks for doing this! Please consider these:
Reviewed-by Kees Cook <[email protected]>
Thanks!
Daniel
Quoted 167 lines
-Kees
Quoted 161 lines
Cc Daniel Micay <[email protected]>Cc Kees Cook <[email protected]>Signed-off-by Daniel Axtens <[email protected]>--- drivers/misc/lkdtm/bugs.c | 26 ++++++++++++++++++++++++++ drivers/misc/lkdtm/core.c | 1 + drivers/misc/lkdtm/lkdtm.h | 1 + include/linux/string.h | 27 ++++++++++++++++----------- 4 files changed, 44 insertions(+), 11 deletions(-)drivers/misc/lkdtm/bugs.c +26
-0@@ -11,6 +11,7 @@#include <linux/sched/signal.h> #include <linux/sched/task_stack.h> #include <linux/uaccess.h> +#include <linux/slab.h> #ifdef CONFIG_X86_32 #include <asm/desc.h> @@ -376,3 +377,28 @@ void lkdtm_DOUBLE_FAULT(void) panic("tried to double fault but didn't die\n"); }#endif + +void lkdtm_FORTIFY_SUBOBJECT (void ) +{ +struct target { +char a[10 ]; +char b[10 ]; + } target; +char *src; + + src =kmalloc (20 ,GFP_KERNEL ); +strscpy (src,"over ten bytes" ,20 ); + +pr_info ("trying to strcpy past the end of a member of a struct\n" ); + +/* +* strncpy(target.a, src, 20); will hit a compile error because the +* compiler knows at build time that target.a < 20 bytes. Use strcpy() +* to force a runtime error. +*/ +strcpy (target.a, src); + +/* Use target.a to prevent the code from being eliminated */ +pr_err ("FAIL: fortify did not catch an sub-object overrun!\n" +"\"%s\" was copied.\n" , target.a); +}drivers/misc/lkdtm/core.c +1
-0@@ -117,6 +117,7 @@ static const struct crashtype crashtypes[] = {CRASHTYPE (STACK_GUARD_PAGE_TRAILING ),CRASHTYPE (UNSET_SMEP ),CRASHTYPE (UNALIGNED_LOAD_STORE_WRITE ), +CRASHTYPE (FORTIFY_SUBOBJECT ),CRASHTYPE (OVERWRITE_ALLOCATION ),CRASHTYPE (WRITE_AFTER_FREE ), CRASHTYPE(READ_AFTER_FREE),drivers/misc/lkdtm/lkdtm.h +1
-0@@ -31,6 +31,7 @@ void lkdtm_UNSET_SMEP(void);#ifdef CONFIG_X86_32 void lkdtm_DOUBLE_FAULT (void );#endif +void lkdtm_FORTIFY_SUBOBJECT (void );/* lkdtm_heap.c */ void __init lkdtm_heap_init (void );include/linux/string.h +16
-11@@ -319,7 +319,7 @@ void __write_overflow(void) __compiletime_error("detected write beyond size of o#if !defined(__NO_FORTIFY) && defined(__OPTIMIZE__) && defined(CONFIG_FORTIFY_SOURCE ) __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );if (__builtin_constant_p (size) && p_size < size)__write_overflow ();if (p_size < size)@@ -329,7 +329,7 @@ __FORTIFY_INLINE char *strncpy(char *p, const char *q, __kernel_size_t size) __FORTIFY_INLINE char *strcat(char *p, const char *q) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );if (p_size == (size_t )-1 )return __builtin_strcat (p, q);if (strlcat (p, q, p_size) >= p_size)@@ -340,7 +340,7 @@ __FORTIFY_INLINE char *strcat(char *p, const char *q) __FORTIFY_INLINE __kernel_size_t strlen(const char *p) {__kernel_size_t ret; -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );/* Work around gcc excess stack consumption issue */ if (p_size == (size_t)-1 ||@@ -355,7 +355,7 @@ __FORTIFY_INLINE __kernel_size_t strlen(const char *p) extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen); __FORTIFY_INLINE __kernel_size_t strnlen(const char *p, __kernel_size_t maxlen) { -size_t p_size =__builtin_object_size (p,0 ); +size_t p_size =__builtin_object_size (p,1 );__kernel_size_t ret =__real_strnlen (p, maxlen < p_size ? maxlen : p_size);if (p_size <= ret && maxlen != ret)fortify_panic (__func__);@@ -367,8 +367,8 @@ extern size_t __real_strlcpy(char *, const char *, size_t) __RENAME(strlcpy); __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size) {size_t ret; -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 );if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __real_strlcpy (p, q, size); ret =strlen (q);@@ -388,8 +388,8 @@ __FORTIFY_INLINE size_t strlcpy(char *p, const char *q, size_t size) __FORTIFY_INLINE char *strncat(char *p, const char *q, __kernel_size_t count) {size_t p_len, copy_len; -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 );if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __builtin_strncat (p, q, count); p_len =strlen (p);@@ -502,11 +502,16 @@ __FORTIFY_INLINE void *kmemdup(const void *p, size_t size, gfp_t gfp)/* defined after fortified strlen and memcpy to reuse them */ __FORTIFY_INLINE char *strcpy(char *p, const char *q) { -size_t p_size =__builtin_object_size (p,0 ); -size_t q_size =__builtin_object_size (q,0 ); +size_t p_size =__builtin_object_size (p,1 ); +size_t q_size =__builtin_object_size (q,1 ); +size_t size;if (p_size == (size_t )-1 && q_size == (size_t )-1 )return __builtin_strcpy (p, q); -memcpy (p, q,strlen (q) +1 ); + size =strlen (q) +1 ; +/* test here to use the more stringent object size */ +if (p_size < size) +fortify_panic (__func__); +memcpy (p, q, size);return p; }Signature · 1 line
2.20.1Signature · 1 line
Kees Cook