gpio: prevent potential speculation leaks in gpio_device_get_desc()
PATCH v2 1/1 gpio: prevent potential speculation leaks in gpio_device_get_desc()
Users can call the gpio_ioctl() interface to get information about gpio chip lines.
Lines on the chip are identified by an offset in the range of [0,chip.lines).
Offset is copied from user and then used as an array index to get the gpio descriptor without sanitization.
This change ensures that the offset is sanitized by
"using array_index_nospec" to mitigate any possibility of speculative information leaks.
This bug was discovered and resolved using Coverity Static Analysis Security Testing (SAST) by Synopsys, Inc.
---
v2: call array_index_nospec() after the bounds check.
--- drivers/gpio/gpiolib.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/gpio/gpiolib.c +2 -1
@@ -17,6 +17,7 @@#include <linux/list.h> #include <linux/lockdep.h> #include <linux/module.h> +#include <linux/nospec.h> #include <linux/of.h> #include <linux/pinctrl/consumer.h> #include <linux/seq_file.h>
@@ -201,7 +202,7 @@ gpio_device_get_desc(struct gpio_device *gdev, unsigned int hwnum)if (hwnum >= gdev->ngpio)return ERR_PTR (-EINVAL ); -return &gdev->descs[hwnum]; +return &gdev->descs[array_index_nospec (hwnum, gdev->ngpio)]; }EXPORT_SYMBOL_GPL (gpio_device_get_desc);
Signature · 1 line
2.40.1
Quoted 11 lines · Hagar Hemdan
Users can call the
gpio_ioctl()interface to get information about gpio chip lines.
Lines on the chip are identified by an offset in the range of [0,chip.lines).
Offset is copied from user and then used as an array index to get the gpio descriptor without sanitization.This change ensures that the offset is sanitized by
"usingarray_index_nospec" to mitigate any possibility of speculative information leaks.
This could better describe the problem. I'm still not 100% sure I understand it, so it would be great if the comment could clarify it, specifically what "speculation leaks" means.
And when referencing functions use (), so array_index_nospec(), rather than quotes.
Quoted 4 lines
This bug was discovered and resolved using Coverity Static Analysis Security Testing (SAST) by Synopsys, Inc.
Fixes aad955842d1c ("gpiolib: cdev: support GPIO_V2_GET_LINEINFO_IOCTL and GPIO_V2_GET_LINEINFO_WATCH_IOCTL")
This is not the correct commit(s) - the bug would've been present in the character device uAPI since it was first added.
In fact two out of three places you patched in v1 pre-date this commit.
Quoted 20 lines
Signed-off-by Hagar Hemdan <[email protected]>---
v2: callarray_index_nospec()after the bounds check.--- drivers/gpio/gpiolib.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)drivers/gpio/gpiolib.c +1
-0@@ -17,6 +17,7 @@#include <linux/list.h> #include <linux/lockdep.h> #include <linux/module.h> +#include <linux/nospec.h> #include <linux/of.h> #include <linux/pinctrl/consumer.h> #include <linux/seq_file.h>
drivers/gpio/gpiolib.c gpio_device_get_desc(struct gpio_device *gdev, unsigned int hwnum) · line 208
Quoted 8 lines
drivers/gpio/gpiolib.c +1
-1@@ -201,7 +202,7 @@ gpio_device_get_desc(struct gpio_device *gdev, unsigned int hwnum)if (hwnum >= gdev->ngpio)return ERR_PTR (-EINVAL ); -return &gdev->descs[hwnum]; +return &gdev->descs[array_index_nospec (hwnum, gdev->ngpio)]; }EXPORT_SYMBOL_GPL (gpio_device_get_desc);
That makes more sense to me, so I no problem with the code change.
Cheers,
Kent.