]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
ubsan/overflow: Rework integer overflow sanitizer option to turn on everything
authorKees Cook <kees@kernel.org>
Fri, 7 Mar 2025 04:19:09 +0000 (20:19 -0800)
committerKees Cook <kees@kernel.org>
Sat, 8 Mar 2025 03:58:05 +0000 (19:58 -0800)
Since we're going to approach integer overflow mitigation a type at a
time, we need to enable all of the associated sanitizers, and then opt
into types one at a time.

Rename the existing "signed wrap" sanitizer to just the entire topic area:
"integer wrap". Enable the implicit integer truncation sanitizers, with
required callbacks and tests.

Notably, this requires features (currently) only available in Clang,
so we can depend on the cc-option tests to determine availability
instead of doing version tests.

Link: https://lore.kernel.org/r/20250307041914.937329-1-kees@kernel.org
Signed-off-by: Kees Cook <kees@kernel.org>
include/linux/compiler_types.h
kernel/configs/hardening.config
lib/Kconfig.ubsan
lib/test_ubsan.c
lib/ubsan.c
lib/ubsan.h
scripts/Makefile.lib
scripts/Makefile.ubsan

index f59393464ea75fd0504f02dc79752bd1af08e12f..4ad3e900bc3d365e63c1288bd8bb0ce31fee7c73 100644 (file)
@@ -360,7 +360,7 @@ struct ftrace_likely_data {
 #endif
 
 /* Do not trap wrapping arithmetic within an annotated function. */
-#ifdef CONFIG_UBSAN_SIGNED_WRAP
+#ifdef CONFIG_UBSAN_INTEGER_WRAP
 # define __signed_wrap __attribute__((no_sanitize("signed-integer-overflow")))
 #else
 # define __signed_wrap
index 3fabb8f55ef6e189133b01e77affefa76675f1e0..dd7c32fb5ac1bc72097ccd171a2cff2f0abe9b23 100644 (file)
@@ -46,7 +46,7 @@ CONFIG_UBSAN_BOUNDS=y
 # CONFIG_UBSAN_SHIFT is not set
 # CONFIG_UBSAN_DIV_ZERO is not set
 # CONFIG_UBSAN_UNREACHABLE is not set
-# CONFIG_UBSAN_SIGNED_WRAP is not set
+# CONFIG_UBSAN_INTEGER_WRAP is not set
 # CONFIG_UBSAN_BOOL is not set
 # CONFIG_UBSAN_ENUM is not set
 # CONFIG_UBSAN_ALIGNMENT is not set
index 1d4aa7a83b3a55ee9fc3612ceb1c1f157c2dafb7..63e5622010e0f771c1a0f01039398adca8f1fd0a 100644 (file)
@@ -116,21 +116,20 @@ config UBSAN_UNREACHABLE
          This option enables -fsanitize=unreachable which checks for control
          flow reaching an expected-to-be-unreachable position.
 
-config UBSAN_SIGNED_WRAP
-       bool "Perform checking for signed arithmetic wrap-around"
+config UBSAN_INTEGER_WRAP
+       bool "Perform checking for integer arithmetic wrap-around"
        default UBSAN
        depends on !COMPILE_TEST
-       # The no_sanitize attribute was introduced in GCC with version 8.
-       depends on !CC_IS_GCC || GCC_VERSION >= 80000
        depends on $(cc-option,-fsanitize=signed-integer-overflow)
-       help
-         This option enables -fsanitize=signed-integer-overflow which checks
-         for wrap-around of any arithmetic operations with signed integers.
-         This currently performs nearly no instrumentation due to the
-         kernel's use of -fno-strict-overflow which converts all would-be
-         arithmetic undefined behavior into wrap-around arithmetic. Future
-         sanitizer versions will allow for wrap-around checking (rather than
-         exclusively undefined behavior).
+       depends on $(cc-option,-fsanitize=unsigned-integer-overflow)
+       depends on $(cc-option,-fsanitize=implicit-signed-integer-truncation)
+       depends on $(cc-option,-fsanitize=implicit-unsigned-integer-truncation)
+       help
+         This option enables all of the sanitizers involved in integer overflow
+         (wrap-around) mitigation: signed-integer-overflow, unsigned-integer-overflow,
+         implicit-signed-integer-truncation, and implicit-unsigned-integer-truncation.
+         This is currently limited only to the size_t type while testing and
+         compiler development continues.
 
 config UBSAN_BOOL
        bool "Perform checking for non-boolean values used as boolean"
index 5d7b10e98610703776abea07584c43eb5f8a5b48..8772e5edaa4fa73d71170c1a4dbc65b4f41b6c10 100644 (file)
@@ -15,7 +15,7 @@ static void test_ubsan_add_overflow(void)
 {
        volatile int val = INT_MAX;
 
-       UBSAN_TEST(CONFIG_UBSAN_SIGNED_WRAP);
+       UBSAN_TEST(CONFIG_UBSAN_INTEGER_WRAP);
        val += 2;
 }
 
@@ -24,7 +24,7 @@ static void test_ubsan_sub_overflow(void)
        volatile int val = INT_MIN;
        volatile int val2 = 2;
 
-       UBSAN_TEST(CONFIG_UBSAN_SIGNED_WRAP);
+       UBSAN_TEST(CONFIG_UBSAN_INTEGER_WRAP);
        val -= val2;
 }
 
@@ -32,7 +32,7 @@ static void test_ubsan_mul_overflow(void)
 {
        volatile int val = INT_MAX / 2;
 
-       UBSAN_TEST(CONFIG_UBSAN_SIGNED_WRAP);
+       UBSAN_TEST(CONFIG_UBSAN_INTEGER_WRAP);
        val *= 3;
 }
 
@@ -40,7 +40,7 @@ static void test_ubsan_negate_overflow(void)
 {
        volatile int val = INT_MIN;
 
-       UBSAN_TEST(CONFIG_UBSAN_SIGNED_WRAP);
+       UBSAN_TEST(CONFIG_UBSAN_INTEGER_WRAP);
        val = -val;
 }
 
@@ -53,6 +53,15 @@ static void test_ubsan_divrem_overflow(void)
        val /= val2;
 }
 
+static void test_ubsan_truncate_signed(void)
+{
+       volatile long val = LONG_MAX;
+       volatile int val2 = 0;
+
+       UBSAN_TEST(CONFIG_UBSAN_INTEGER_WRAP);
+       val2 = val;
+}
+
 static void test_ubsan_shift_out_of_bounds(void)
 {
        volatile int neg = -1, wrap = 4;
@@ -127,6 +136,7 @@ static const test_ubsan_fp test_ubsan_array[] = {
        test_ubsan_sub_overflow,
        test_ubsan_mul_overflow,
        test_ubsan_negate_overflow,
+       test_ubsan_truncate_signed,
        test_ubsan_shift_out_of_bounds,
        test_ubsan_out_of_bounds,
        test_ubsan_load_invalid_value,
index a1c983d148f16fe34493d6b933577556832bcdf6..cdc1d31c3821bdb26ed82c4beec7dbd8f83040ee 100644 (file)
@@ -44,7 +44,7 @@ const char *report_ubsan_failure(struct pt_regs *regs, u32 check_type)
        case ubsan_shift_out_of_bounds:
                return "UBSAN: shift out of bounds";
 #endif
-#if defined(CONFIG_UBSAN_DIV_ZERO) || defined(CONFIG_UBSAN_SIGNED_WRAP)
+#if defined(CONFIG_UBSAN_DIV_ZERO) || defined(CONFIG_UBSAN_INTEGER_WRAP)
        /*
         * SanitizerKind::IntegerDivideByZero and
         * SanitizerKind::SignedIntegerOverflow emit
@@ -79,7 +79,7 @@ const char *report_ubsan_failure(struct pt_regs *regs, u32 check_type)
        case ubsan_type_mismatch:
                return "UBSAN: type mismatch";
 #endif
-#ifdef CONFIG_UBSAN_SIGNED_WRAP
+#ifdef CONFIG_UBSAN_INTEGER_WRAP
        /*
         * SanitizerKind::SignedIntegerOverflow emits
         * SanitizerHandler::AddOverflow, SanitizerHandler::SubOverflow,
@@ -303,6 +303,30 @@ void __ubsan_handle_negate_overflow(void *_data, void *old_val)
 }
 EXPORT_SYMBOL(__ubsan_handle_negate_overflow);
 
+void __ubsan_handle_implicit_conversion(void *_data, void *from_val, void *to_val)
+{
+       struct implicit_conversion_data *data = _data;
+       char from_val_str[VALUE_LENGTH];
+       char to_val_str[VALUE_LENGTH];
+
+       if (suppress_report(&data->location))
+               return;
+
+       val_to_string(from_val_str, sizeof(from_val_str), data->from_type, from_val);
+       val_to_string(to_val_str, sizeof(to_val_str), data->to_type, to_val);
+
+       ubsan_prologue(&data->location, "implicit-conversion");
+
+       pr_err("cannot represent %s value %s during %s %s, truncated to %s\n",
+               data->from_type->type_name,
+               from_val_str,
+               type_check_kinds[data->type_check_kind],
+               data->to_type->type_name,
+               to_val_str);
+
+       ubsan_epilogue();
+}
+EXPORT_SYMBOL(__ubsan_handle_implicit_conversion);
 
 void __ubsan_handle_divrem_overflow(void *_data, void *lhs, void *rhs)
 {
index 07e37d4429b4bef389f8c3d2bd4e899705b91750..b37e22374e7748a25c4793469f3b37103ac736fb 100644 (file)
@@ -62,6 +62,13 @@ struct overflow_data {
        struct type_descriptor *type;
 };
 
+struct implicit_conversion_data {
+       struct source_location location;
+       struct type_descriptor *from_type;
+       struct type_descriptor *to_type;
+       unsigned char type_check_kind;
+};
+
 struct type_mismatch_data {
        struct source_location location;
        struct type_descriptor *type;
@@ -142,6 +149,7 @@ void ubsan_linkage __ubsan_handle_sub_overflow(void *data, void *lhs, void *rhs)
 void ubsan_linkage __ubsan_handle_mul_overflow(void *data, void *lhs, void *rhs);
 void ubsan_linkage __ubsan_handle_negate_overflow(void *_data, void *old_val);
 void ubsan_linkage __ubsan_handle_divrem_overflow(void *_data, void *lhs, void *rhs);
+void ubsan_linkage __ubsan_handle_implicit_conversion(void *_data, void *lhs, void *rhs);
 void ubsan_linkage __ubsan_handle_type_mismatch(struct type_mismatch_data *data, void *ptr);
 void ubsan_linkage __ubsan_handle_type_mismatch_v1(void *_data, void *ptr);
 void ubsan_linkage __ubsan_handle_out_of_bounds(void *_data, void *index);
index cad20f0e66ee9cf5942b51f37cdd8e52802493e4..981d14ef9db29f770857ea4e13fd5ec283b5a1de 100644 (file)
@@ -166,8 +166,8 @@ _c_flags += $(if $(patsubst n%,, \
                $(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_SANITIZE)$(is-kernel-object)), \
                $(CFLAGS_UBSAN))
 _c_flags += $(if $(patsubst n%,, \
-               $(UBSAN_SIGNED_WRAP_$(target-stem).o)$(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_SIGNED_WRAP)$(UBSAN_SANITIZE)$(is-kernel-object)), \
-               $(CFLAGS_UBSAN_SIGNED_WRAP))
+               $(UBSAN_INTEGER_WRAP_$(target-stem).o)$(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_INTEGER_WRAP)$(UBSAN_SANITIZE)$(is-kernel-object)), \
+               $(CFLAGS_UBSAN_INTEGER_WRAP))
 endif
 
 ifeq ($(CONFIG_KCOV),y)
index b2d3b273b8028c779fe1fff26e26d28af428eb77..4fad9afed24cf9ee91159e8c492e81dc64629a90 100644 (file)
@@ -14,5 +14,9 @@ ubsan-cflags-$(CONFIG_UBSAN_TRAP)             += $(call cc-option,-fsanitize-trap=undefined
 
 export CFLAGS_UBSAN := $(ubsan-cflags-y)
 
-ubsan-signed-wrap-cflags-$(CONFIG_UBSAN_SIGNED_WRAP)     += -fsanitize=signed-integer-overflow
-export CFLAGS_UBSAN_SIGNED_WRAP := $(ubsan-signed-wrap-cflags-y)
+ubsan-integer-wrap-cflags-$(CONFIG_UBSAN_INTEGER_WRAP)     +=  \
+       -fsanitize=signed-integer-overflow                      \
+       -fsanitize=unsigned-integer-overflow                    \
+       -fsanitize=implicit-signed-integer-truncation           \
+       -fsanitize=implicit-unsigned-integer-truncation
+export CFLAGS_UBSAN_INTEGER_WRAP := $(ubsan-integer-wrap-cflags-y)