Skip to contentSkip to conversation

check_netdev_priv: warn about using netdev priv data after free_netdev

PATCH In review Pavel Skripkin 2 participants 8 messages Aug 2, 2021 – Aug 4, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 check_netdev_priv: warn about using netdev priv data after free_netdev

After manual code review I found a lot of bugs, when code uses netdev_priv() pointer after free_{netdev,candev} call. Example:

	struct some_dev *dev = netdev_priv(net_dev);

	free_netdev(net_dev);
	do_clean_up(dev);

Obviously, that above code snippet will trigger UAF bug, since dev pointer goes away with net_dev. Since there isn't any check for this type of bug in other static analysis tools, let's add it to smatch.

Side note: this code requires further work to be able to find complex situtations like

	struct some_dev *dev = get_dev_from_smth(smth);

	free_netdev(dev->netdev);
	do_clean_up(dev);

In this case dev is dev->netdev private data and it's a bit difficult to to figure out if ->netdev is actual dev _parent_ or not.

---
 check_list.h        |   1 +
 check_netdev_priv.c | 117 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 118 insertions(+)
 create mode 100644 check_netdev_priv.c
check_list.h +1 -0
index fd205269..972b2795 100644
@@ -203,6 +203,7 @@ CK(check_list_add)
 CK(check_list_add_late)
 CK(check_sscanf_return)
 CK(check_kvmalloc_NOFS)
+CK(check_uaf_netdev_priv)
 
 /* wine specific stuff */
 CK(check_wine_filehandles)
check_netdev_priv.c new file +117 -0

117 lines not on this page · raw message

Signature · 1 line
2.32.0
#1 lore raw

Thanks Pavel!

It looks really nice. I've applied it. I'll test it tonight and push tomorrow.

I don't see any major issues with the check at all, but I have a few comments below.

Quoted 5 lines · Pavel Skripkin
check_netdev_priv.c new file +5 -0
+static void match_free_netdev(const char *fn, struct expression *expr, void *_arg_no)
+{
+	struct expression *arg;
+	const char *name;
+

check_netdev_priv.c line 86

Quoted 10 lines
check_netdev_priv.c new file +10 -0
+	arg = get_argument_from_call_expr(expr->args, PTR_INT(_arg_no));
+	if (!arg)
+		return;
+
+	name = expr_to_var(arg);
+	if (!name)
+		return;
+
+	set_state(my_id, name, NULL, &freed);
+}

There is a new param_key API which would make this function shorter.

static void free_netdev(struct expression *expr, const char *name, struct symbol *sym, void *data)

{
	set_state(my_id, name, NULL, &freed);
}

Then in the register function you'd add a hooks like this:

	add_function_param_key_hook("free_netdev", &free_netdev, 0, "$", NULL);
	add_function_param_key_hook("free_candev", &free_netdev, 0, "$", NULL);

Of course, you've already written your own code which works so it's fine. But that param_key API is really the most awesome thing.

check_netdev_priv.c line 92

Quoted 6 lines
check_netdev_priv.c new file +6 -0
+
+static void match_symbol(struct expression *expr)
+{
+	const char *parent_netdev, *name;
+	struct smatch_state *state;
+

This hook is run for every variable so it's tempting to add a shortcut here:

	if (!has_states(my_id))
		return;
Quoted 11 lines
check_netdev_priv.c new file +11 -0
+	name = expr_to_var(expr);
+	if (!name)
+		return;
+
+	parent_netdev = get_parent_netdev_name(expr);
+	if (!parent_netdev)
+		return;
+	
+	state = get_state(my_id, parent_netdev, NULL);
+	if (state == &freed)
+		sm_error("Using %s after free_{netdev,candev}(%s);\n", name, parent_netdev);

check_netdev_priv.c line 113

Quoted 10 lines
check_netdev_priv.c new file +10 -0
+}
+
+void check_uaf_netdev_priv(int id)
+{
+	if (option_project != PROJ_KERNEL)
+		return;
+
+	my_id = id;
+
+	add_function_hook("free_netdev", &match_free_netdev, NULL);

NULL works but INT_PTR(0) is nicer. ;)

check_netdev_priv.c line 117

Quoted 4 lines
check_netdev_priv.c new file +4 -0
+	add_function_hook("free_candev", &match_free_netdev, NULL);
+	add_modification_hook(my_id, &ok_to_use);
+	add_hook(&match_symbol, SYM_HOOK);
+}

Anyway, I think I will probably add the has_states() check but the rest isn't important.

regards,
dan carpenter

#2 lore raw

Hi, Dan!

Quoted 28 lines · Dan Carpenter

Thanks Pavel!

It looks really nice. I've applied it. I'll test it tonight and push tomorrow.

I don't see any major issues with the check at all, but I have a few comments below.

Quoted 5 lines · Pavel Skripkin
check_netdev_priv.c new file +5 -0
+static void match_free_netdev(const char *fn, struct expression *expr, void *_arg_no)
+{
+	struct expression *arg;
+	const char *name;
+

check_netdev_priv.c line 86

Quoted 10 lines
check_netdev_priv.c new file +10 -0
+	arg = get_argument_from_call_expr(expr->args, PTR_INT(_arg_no));
+	if (!arg)
+		return;
+
+	name = expr_to_var(arg);
+	if (!name)
+		return;
+
+	set_state(my_id, name, NULL, &freed);
+}

There is a new param_key API which would make this function shorter.

static void free_netdev(struct expression *expr, const char *name, struct symbol *sym, void *data)

Quoted 9 lines
{
	set_state(my_id, name, NULL, &freed);
}

Then in the register function you'd add a hooks like this:

	add_function_param_key_hook("free_netdev", &free_netdev, 0, "$", NULL);
	add_function_param_key_hook("free_candev", &free_netdev, 0, "$", NULL);

I guess, I missed that API, sorry :( Next time I will use it instead.

Quoted 40 lines

Of course, you've already written your own code which works so it's fine. But that param_key API is really the most awesome thing.

check_netdev_priv.c line 92

Quoted 6 lines
check_netdev_priv.c new file +6 -0
+
+static void match_symbol(struct expression *expr)
+{
+	const char *parent_netdev, *name;
+	struct smatch_state *state;
+

This hook is run for every variable so it's tempting to add a shortcut here:

	if (!has_states(my_id))
		return;
Quoted 11 lines
check_netdev_priv.c new file +11 -0
+	name = expr_to_var(expr);
+	if (!name)
+		return;
+
+	parent_netdev = get_parent_netdev_name(expr);
+	if (!parent_netdev)
+		return;
+	
+	state = get_state(my_id, parent_netdev, NULL);
+	if (state == &freed)
+		sm_error("Using %s after free_{netdev,candev}(%s);\n", name, parent_netdev);

check_netdev_priv.c line 113

Quoted 10 lines
check_netdev_priv.c new file +10 -0
+}
+
+void check_uaf_netdev_priv(int id)
+{
+	if (option_project != PROJ_KERNEL)
+		return;
+
+	my_id = id;
+
+	add_function_hook("free_netdev", &match_free_netdev, NULL);

NULL works but INT_PTR(0) is nicer. ;)

Quoted 7 lines

check_netdev_priv.c line 117

Quoted 4 lines
check_netdev_priv.c new file +4 -0
+	add_function_hook("free_candev", &match_free_netdev, NULL);
+	add_modification_hook(my_id, &ok_to_use);
+	add_hook(&match_symbol, SYM_HOOK);
+}

Anyway, I think I will probably add the has_states() check but the rest isn't important.

Thank you for applying and your guidelines, I appreciate it :)

With regards,
Pavel Skripkin

#3 lore raw
Quoted 35 lines · Pavel Skripkin

Hi, Dan!

Quoted 32 lines · Dan Carpenter

Thanks Pavel!

It looks really nice. I've applied it. I'll test it tonight and push tomorrow.

I don't see any major issues with the check at all, but I have a few comments below.

Quoted 5 lines · Pavel Skripkin
check_netdev_priv.c new file +5 -0
+static void match_free_netdev(const char *fn, struct expression *expr, void *_arg_no)
+{
+	struct expression *arg;
+	const char *name;
+

check_netdev_priv.c line 86

Quoted 10 lines
check_netdev_priv.c new file +10 -0
+	arg = get_argument_from_call_expr(expr->args, PTR_INT(_arg_no));
+	if (!arg)
+		return;
+
+	name = expr_to_var(arg);
+	if (!name)
+		return;
+
+	set_state(my_id, name, NULL, &freed);
+}

There is a new param_key API which would make this function shorter.

static void free_netdev(struct expression *expr, const char *name, struct symbol *sym, void *data)

{
	set_state(my_id, name, NULL, &freed);
}
Quoted 7 lines
Quoted 5 lines

Then in the register function you'd add a hooks like this:

	add_function_param_key_hook("free_netdev", &free_netdev, 0, "$", NULL);
	add_function_param_key_hook("free_candev", &free_netdev, 0, "$", NULL);

I guess, I missed that API, sorry :( Next time I will use it instead.

It's new, I wouldn't have expected anyone to be aware of it yet. But it's really nice.

regards,
dan carpenter

#4 lore raw
In reply to Pavel Skripkin

Pushed!

This finds two bugs in my allmodconfig. They're both real bugs.

drivers/net/ethernet/freescale/fec_main.c:3994 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/freescale/fec_main.c:3995 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev);

Presumably you already sent fixes or reported these?

regards,
dan carpenter

#5 lore raw
Quoted 11 lines · Dan Carpenter

Pushed!

This finds two bugs in my allmodconfig. They're both real bugs.

drivers/net/ethernet/freescale/fec_main.c:3994 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/freescale/fec_main.c:3995 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev);

Wow!

I did't test it with allmodconfig, but I've tested it with my config for reproducing syzkaller bugs.

I've fixed few bugs while writing this checker and fixes are already upstreamed.

Quoted 5 lines

Presumably you already sent fixes or reported these?

regards,
dan carpenter

With regards,
Pavel Skripkin

#6 lore raw
In reply to Dan Carpenter
Quoted 11 lines · Dan Carpenter

Pushed!

This finds two bugs in my allmodconfig. They're both real bugs.

drivers/net/ethernet/freescale/fec_main.c:3994 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/freescale/fec_main.c:3995 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev);

I can send patches to fix these errors with Reported-by tag, or You will take care of it?

With regards,
Pavel Skripkin

#7 lore raw
Quoted 13 lines · Pavel Skripkin
Quoted 11 lines · Dan Carpenter

Pushed!

This finds two bugs in my allmodconfig. They're both real bugs.

drivers/net/ethernet/freescale/fec_main.c:3994 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/freescale/fec_main.c:3995 fec_drv_remove() error: Using fep after free_{netdev,candev}(ndev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3518 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev); drivers/net/ethernet/neterion/vxge/vxge-main.c:3520 vxge_device_unregister() error: Using vdev after free_{netdev,candev}(dev);

Quoted 2 lines

I can send patches to fix these errors with Reported-by tag, or You will take care of it?

Yes, please send the fixes. These are your discovery. You get first dibs. ;)

regards,
dan carpenter