2020-07-06 11:53:15

by Walter Wu

[permalink] [raw]
Subject: [PATCH v3] kasan: fix KASAN unit tests for tag-based KASAN

We use tag-based KASAN, then KASAN unit tests don't detect out-of-bounds
memory access. They need to be fixed.

With tag-based KASAN, the state of each 16 aligned bytes of memory is
encoded in one shadow byte and the shadow value is tag of pointer, so
we need to read next shadow byte, the shadow value is not equal to tag
value of pointer, so that tag-based KASAN will detect out-of-bounds
memory access.

Signed-off-by: Walter Wu <[email protected]>
Suggested-by: Dmitry Vyukov <[email protected]>
Cc: Andrey Ryabinin <[email protected]>
Cc: Dmitry Vyukov <[email protected]>
Cc: Alexander Potapenko <[email protected]>
Cc: Matthias Brugger <[email protected]>
Cc: Andrey Konovalov <[email protected]>
Cc: Andrew Morton <[email protected]>
---

changes since v1:
- Reduce amount of non-compiled code.
- KUnit-KASAN Integration patchset is not merged yet. My patch should
have conflict with it, if needed, we can continue to wait it.

changes since v2:
- Add one marco to make unit tests more readability.

---
lib/test_kasan.c | 47 ++++++++++++++++++++++++++++++-----------------
1 file changed, 30 insertions(+), 17 deletions(-)

diff --git a/lib/test_kasan.c b/lib/test_kasan.c
index e3087d90e00d..b5049a807e25 100644
--- a/lib/test_kasan.c
+++ b/lib/test_kasan.c
@@ -23,6 +23,8 @@

#include <asm/page.h>

+#define OOB_TAG_OFF (IS_ENABLED(CONFIG_KASAN_GENERIC) ? 0 : 13)
+
/*
* Note: test functions are marked noinline so that their names appear in
* reports.
@@ -40,7 +42,8 @@ static noinline void __init kmalloc_oob_right(void)
return;
}

- ptr[size] = 'x';
+ ptr[size + OOB_TAG_OFF] = 'x';
+
kfree(ptr);
}

@@ -92,7 +95,8 @@ static noinline void __init kmalloc_pagealloc_oob_right(void)
return;
}

- ptr[size] = 0;
+ ptr[size + OOB_TAG_OFF] = 0;
+
kfree(ptr);
}

@@ -162,7 +166,8 @@ static noinline void __init kmalloc_oob_krealloc_more(void)
return;
}

- ptr2[size2] = 'x';
+ ptr2[size2 + OOB_TAG_OFF] = 'x';
+
kfree(ptr2);
}

@@ -180,7 +185,9 @@ static noinline void __init kmalloc_oob_krealloc_less(void)
kfree(ptr1);
return;
}
- ptr2[size2] = 'x';
+
+ ptr2[size2 + OOB_TAG_OFF] = 'x';
+
kfree(ptr2);
}

@@ -216,7 +223,8 @@ static noinline void __init kmalloc_oob_memset_2(void)
return;
}

- memset(ptr+7, 0, 2);
+ memset(ptr + 7 + OOB_TAG_OFF, 0, 2);
+
kfree(ptr);
}

@@ -232,7 +240,8 @@ static noinline void __init kmalloc_oob_memset_4(void)
return;
}

- memset(ptr+5, 0, 4);
+ memset(ptr + 5 + OOB_TAG_OFF, 0, 4);
+
kfree(ptr);
}

@@ -249,7 +258,8 @@ static noinline void __init kmalloc_oob_memset_8(void)
return;
}

- memset(ptr+1, 0, 8);
+ memset(ptr + 1 + OOB_TAG_OFF, 0, 8);
+
kfree(ptr);
}

@@ -265,7 +275,8 @@ static noinline void __init kmalloc_oob_memset_16(void)
return;
}

- memset(ptr+1, 0, 16);
+ memset(ptr + 1 + OOB_TAG_OFF, 0, 16);
+
kfree(ptr);
}

@@ -281,7 +292,8 @@ static noinline void __init kmalloc_oob_in_memset(void)
return;
}

- memset(ptr, 0, size+5);
+ memset(ptr, 0, size + 5 + OOB_TAG_OFF);
+
kfree(ptr);
}

@@ -415,7 +427,8 @@ static noinline void __init kmem_cache_oob(void)
return;
}

- *p = p[size];
+ *p = p[size + OOB_TAG_OFF];
+
kmem_cache_free(cache, p);
kmem_cache_destroy(cache);
}
@@ -512,25 +525,25 @@ static noinline void __init copy_user_test(void)
}

pr_info("out-of-bounds in copy_from_user()\n");
- unused = copy_from_user(kmem, usermem, size + 1);
+ unused = copy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);

pr_info("out-of-bounds in copy_to_user()\n");
- unused = copy_to_user(usermem, kmem, size + 1);
+ unused = copy_to_user(usermem, kmem, size + 1 + OOB_TAG_OFF);

pr_info("out-of-bounds in __copy_from_user()\n");
- unused = __copy_from_user(kmem, usermem, size + 1);
+ unused = __copy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);

pr_info("out-of-bounds in __copy_to_user()\n");
- unused = __copy_to_user(usermem, kmem, size + 1);
+ unused = __copy_to_user(usermem, kmem, size + 1 + OOB_TAG_OFF);

pr_info("out-of-bounds in __copy_from_user_inatomic()\n");
- unused = __copy_from_user_inatomic(kmem, usermem, size + 1);
+ unused = __copy_from_user_inatomic(kmem, usermem, size + 1 + OOB_TAG_OFF);

pr_info("out-of-bounds in __copy_to_user_inatomic()\n");
- unused = __copy_to_user_inatomic(usermem, kmem, size + 1);
+ unused = __copy_to_user_inatomic(usermem, kmem, size + 1 + OOB_TAG_OFF);

pr_info("out-of-bounds in strncpy_from_user()\n");
- unused = strncpy_from_user(kmem, usermem, size + 1);
+ unused = strncpy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);

vm_munmap((unsigned long)usermem, PAGE_SIZE);
kfree(kmem);
--
2.18.0


2020-07-06 12:15:12

by Dmitry Vyukov

[permalink] [raw]
Subject: Re: [PATCH v3] kasan: fix KASAN unit tests for tag-based KASAN

On Mon, Jul 6, 2020 at 1:50 PM Walter Wu <[email protected]> wrote:
>
> We use tag-based KASAN, then KASAN unit tests don't detect out-of-bounds
> memory access. They need to be fixed.
>
> With tag-based KASAN, the state of each 16 aligned bytes of memory is
> encoded in one shadow byte and the shadow value is tag of pointer, so
> we need to read next shadow byte, the shadow value is not equal to tag
> value of pointer, so that tag-based KASAN will detect out-of-bounds
> memory access.
>
> Signed-off-by: Walter Wu <[email protected]>
> Suggested-by: Dmitry Vyukov <[email protected]>
> Cc: Andrey Ryabinin <[email protected]>
> Cc: Dmitry Vyukov <[email protected]>
> Cc: Alexander Potapenko <[email protected]>
> Cc: Matthias Brugger <[email protected]>
> Cc: Andrey Konovalov <[email protected]>
> Cc: Andrew Morton <[email protected]>

Acked-by: Dmitry Vyukov <[email protected]>

Thanks for fixing these tests!

> ---
>
> changes since v1:
> - Reduce amount of non-compiled code.
> - KUnit-KASAN Integration patchset is not merged yet. My patch should
> have conflict with it, if needed, we can continue to wait it.
>
> changes since v2:
> - Add one marco to make unit tests more readability.
>
> ---
> lib/test_kasan.c | 47 ++++++++++++++++++++++++++++++-----------------
> 1 file changed, 30 insertions(+), 17 deletions(-)
>
> diff --git a/lib/test_kasan.c b/lib/test_kasan.c
> index e3087d90e00d..b5049a807e25 100644
> --- a/lib/test_kasan.c
> +++ b/lib/test_kasan.c
> @@ -23,6 +23,8 @@
>
> #include <asm/page.h>
>
> +#define OOB_TAG_OFF (IS_ENABLED(CONFIG_KASAN_GENERIC) ? 0 : 13)
> +
> /*
> * Note: test functions are marked noinline so that their names appear in
> * reports.
> @@ -40,7 +42,8 @@ static noinline void __init kmalloc_oob_right(void)
> return;
> }
>
> - ptr[size] = 'x';
> + ptr[size + OOB_TAG_OFF] = 'x';
> +
> kfree(ptr);
> }
>
> @@ -92,7 +95,8 @@ static noinline void __init kmalloc_pagealloc_oob_right(void)
> return;
> }
>
> - ptr[size] = 0;
> + ptr[size + OOB_TAG_OFF] = 0;
> +
> kfree(ptr);
> }
>
> @@ -162,7 +166,8 @@ static noinline void __init kmalloc_oob_krealloc_more(void)
> return;
> }
>
> - ptr2[size2] = 'x';
> + ptr2[size2 + OOB_TAG_OFF] = 'x';
> +
> kfree(ptr2);
> }
>
> @@ -180,7 +185,9 @@ static noinline void __init kmalloc_oob_krealloc_less(void)
> kfree(ptr1);
> return;
> }
> - ptr2[size2] = 'x';
> +
> + ptr2[size2 + OOB_TAG_OFF] = 'x';
> +
> kfree(ptr2);
> }
>
> @@ -216,7 +223,8 @@ static noinline void __init kmalloc_oob_memset_2(void)
> return;
> }
>
> - memset(ptr+7, 0, 2);
> + memset(ptr + 7 + OOB_TAG_OFF, 0, 2);
> +
> kfree(ptr);
> }
>
> @@ -232,7 +240,8 @@ static noinline void __init kmalloc_oob_memset_4(void)
> return;
> }
>
> - memset(ptr+5, 0, 4);
> + memset(ptr + 5 + OOB_TAG_OFF, 0, 4);
> +
> kfree(ptr);
> }
>
> @@ -249,7 +258,8 @@ static noinline void __init kmalloc_oob_memset_8(void)
> return;
> }
>
> - memset(ptr+1, 0, 8);
> + memset(ptr + 1 + OOB_TAG_OFF, 0, 8);
> +
> kfree(ptr);
> }
>
> @@ -265,7 +275,8 @@ static noinline void __init kmalloc_oob_memset_16(void)
> return;
> }
>
> - memset(ptr+1, 0, 16);
> + memset(ptr + 1 + OOB_TAG_OFF, 0, 16);
> +
> kfree(ptr);
> }
>
> @@ -281,7 +292,8 @@ static noinline void __init kmalloc_oob_in_memset(void)
> return;
> }
>
> - memset(ptr, 0, size+5);
> + memset(ptr, 0, size + 5 + OOB_TAG_OFF);
> +
> kfree(ptr);
> }
>
> @@ -415,7 +427,8 @@ static noinline void __init kmem_cache_oob(void)
> return;
> }
>
> - *p = p[size];
> + *p = p[size + OOB_TAG_OFF];
> +
> kmem_cache_free(cache, p);
> kmem_cache_destroy(cache);
> }
> @@ -512,25 +525,25 @@ static noinline void __init copy_user_test(void)
> }
>
> pr_info("out-of-bounds in copy_from_user()\n");
> - unused = copy_from_user(kmem, usermem, size + 1);
> + unused = copy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in copy_to_user()\n");
> - unused = copy_to_user(usermem, kmem, size + 1);
> + unused = copy_to_user(usermem, kmem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_from_user()\n");
> - unused = __copy_from_user(kmem, usermem, size + 1);
> + unused = __copy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_to_user()\n");
> - unused = __copy_to_user(usermem, kmem, size + 1);
> + unused = __copy_to_user(usermem, kmem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_from_user_inatomic()\n");
> - unused = __copy_from_user_inatomic(kmem, usermem, size + 1);
> + unused = __copy_from_user_inatomic(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_to_user_inatomic()\n");
> - unused = __copy_to_user_inatomic(usermem, kmem, size + 1);
> + unused = __copy_to_user_inatomic(usermem, kmem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in strncpy_from_user()\n");
> - unused = strncpy_from_user(kmem, usermem, size + 1);
> + unused = strncpy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> vm_munmap((unsigned long)usermem, PAGE_SIZE);
> kfree(kmem);
> --
> 2.18.0
>
> --
> You received this message because you are subscribed to the Google Groups "kasan-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
> To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200706115039.16750-1-walter-zh.wu%40mediatek.com.

2020-07-08 12:39:17

by Andrey Konovalov

[permalink] [raw]
Subject: Re: [PATCH v3] kasan: fix KASAN unit tests for tag-based KASAN

On Mon, Jul 6, 2020 at 1:50 PM Walter Wu <[email protected]> wrote:
>
> We use tag-based KASAN, then KASAN unit tests don't detect out-of-bounds
> memory access. They need to be fixed.
>
> With tag-based KASAN, the state of each 16 aligned bytes of memory is
> encoded in one shadow byte and the shadow value is tag of pointer, so
> we need to read next shadow byte, the shadow value is not equal to tag
> value of pointer, so that tag-based KASAN will detect out-of-bounds
> memory access.
>
> Signed-off-by: Walter Wu <[email protected]>
> Suggested-by: Dmitry Vyukov <[email protected]>
> Cc: Andrey Ryabinin <[email protected]>
> Cc: Dmitry Vyukov <[email protected]>
> Cc: Alexander Potapenko <[email protected]>
> Cc: Matthias Brugger <[email protected]>
> Cc: Andrey Konovalov <[email protected]>
> Cc: Andrew Morton <[email protected]>
> ---
>
> changes since v1:
> - Reduce amount of non-compiled code.
> - KUnit-KASAN Integration patchset is not merged yet. My patch should
> have conflict with it, if needed, we can continue to wait it.
>
> changes since v2:
> - Add one marco to make unit tests more readability.
>
> ---
> lib/test_kasan.c | 47 ++++++++++++++++++++++++++++++-----------------
> 1 file changed, 30 insertions(+), 17 deletions(-)
>
> diff --git a/lib/test_kasan.c b/lib/test_kasan.c
> index e3087d90e00d..b5049a807e25 100644
> --- a/lib/test_kasan.c
> +++ b/lib/test_kasan.c
> @@ -23,6 +23,8 @@
>
> #include <asm/page.h>
>
> +#define OOB_TAG_OFF (IS_ENABLED(CONFIG_KASAN_GENERIC) ? 0 : 13)

Let's use KASAN_SHADOW_SCALE_SIZE instead of 13 to make sure the
access always lands in the next memory granule.

With that:

Reviewed-by: Andrey Konovalov <[email protected]>

> +
> /*
> * Note: test functions are marked noinline so that their names appear in
> * reports.
> @@ -40,7 +42,8 @@ static noinline void __init kmalloc_oob_right(void)
> return;
> }
>
> - ptr[size] = 'x';
> + ptr[size + OOB_TAG_OFF] = 'x';
> +
> kfree(ptr);
> }
>
> @@ -92,7 +95,8 @@ static noinline void __init kmalloc_pagealloc_oob_right(void)
> return;
> }
>
> - ptr[size] = 0;
> + ptr[size + OOB_TAG_OFF] = 0;
> +
> kfree(ptr);
> }
>
> @@ -162,7 +166,8 @@ static noinline void __init kmalloc_oob_krealloc_more(void)
> return;
> }
>
> - ptr2[size2] = 'x';
> + ptr2[size2 + OOB_TAG_OFF] = 'x';
> +
> kfree(ptr2);
> }
>
> @@ -180,7 +185,9 @@ static noinline void __init kmalloc_oob_krealloc_less(void)
> kfree(ptr1);
> return;
> }
> - ptr2[size2] = 'x';
> +
> + ptr2[size2 + OOB_TAG_OFF] = 'x';
> +
> kfree(ptr2);
> }
>
> @@ -216,7 +223,8 @@ static noinline void __init kmalloc_oob_memset_2(void)
> return;
> }
>
> - memset(ptr+7, 0, 2);
> + memset(ptr + 7 + OOB_TAG_OFF, 0, 2);
> +
> kfree(ptr);
> }
>
> @@ -232,7 +240,8 @@ static noinline void __init kmalloc_oob_memset_4(void)
> return;
> }
>
> - memset(ptr+5, 0, 4);
> + memset(ptr + 5 + OOB_TAG_OFF, 0, 4);
> +
> kfree(ptr);
> }
>
> @@ -249,7 +258,8 @@ static noinline void __init kmalloc_oob_memset_8(void)
> return;
> }
>
> - memset(ptr+1, 0, 8);
> + memset(ptr + 1 + OOB_TAG_OFF, 0, 8);
> +
> kfree(ptr);
> }
>
> @@ -265,7 +275,8 @@ static noinline void __init kmalloc_oob_memset_16(void)
> return;
> }
>
> - memset(ptr+1, 0, 16);
> + memset(ptr + 1 + OOB_TAG_OFF, 0, 16);
> +
> kfree(ptr);
> }
>
> @@ -281,7 +292,8 @@ static noinline void __init kmalloc_oob_in_memset(void)
> return;
> }
>
> - memset(ptr, 0, size+5);
> + memset(ptr, 0, size + 5 + OOB_TAG_OFF);
> +
> kfree(ptr);
> }
>
> @@ -415,7 +427,8 @@ static noinline void __init kmem_cache_oob(void)
> return;
> }
>
> - *p = p[size];
> + *p = p[size + OOB_TAG_OFF];
> +
> kmem_cache_free(cache, p);
> kmem_cache_destroy(cache);
> }
> @@ -512,25 +525,25 @@ static noinline void __init copy_user_test(void)
> }
>
> pr_info("out-of-bounds in copy_from_user()\n");
> - unused = copy_from_user(kmem, usermem, size + 1);
> + unused = copy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in copy_to_user()\n");
> - unused = copy_to_user(usermem, kmem, size + 1);
> + unused = copy_to_user(usermem, kmem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_from_user()\n");
> - unused = __copy_from_user(kmem, usermem, size + 1);
> + unused = __copy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_to_user()\n");
> - unused = __copy_to_user(usermem, kmem, size + 1);
> + unused = __copy_to_user(usermem, kmem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_from_user_inatomic()\n");
> - unused = __copy_from_user_inatomic(kmem, usermem, size + 1);
> + unused = __copy_from_user_inatomic(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in __copy_to_user_inatomic()\n");
> - unused = __copy_to_user_inatomic(usermem, kmem, size + 1);
> + unused = __copy_to_user_inatomic(usermem, kmem, size + 1 + OOB_TAG_OFF);
>
> pr_info("out-of-bounds in strncpy_from_user()\n");
> - unused = strncpy_from_user(kmem, usermem, size + 1);
> + unused = strncpy_from_user(kmem, usermem, size + 1 + OOB_TAG_OFF);
>
> vm_munmap((unsigned long)usermem, PAGE_SIZE);
> kfree(kmem);
> --
> 2.18.0
>
> --
> You received this message because you are subscribed to the Google Groups "kasan-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
> To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200706115039.16750-1-walter-zh.wu%40mediatek.com.