Skip to contentSkip to conversation

netconsole: fix NULL pointer dereference

PATCH In review Nikolay Aleksandrov 5 participants 8 messages Oct 23, 2013 – Oct 25, 2013

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 netconsole: fix NULL pointer dereference

We need to disable the netconsole (enabled = 0) before setting nt->np.dev to NULL because otherwise we might still have users after the netpoll_cleanup() since nt->enabled is set afterwards and we can have a message which will result in a NULL pointer dereference. It is very easy to hit dereferences all over the netpoll_send_udp function by running the following two loops in parallel:
while [ 1 ]; do echo 1 > enabled; echo 0 > enabled; done; while [ 1 ]; do echo 00:11:22:33:44:55 > remote_mac; done; (the second loop is to generate messages, it can be done by anything)

We're safe to set nt->np.dev = NULL and nt->enabled = 0 with the spinlock since it's required in the write_msg() function.

---
Taking the spinlock seems like the cleanest way to insure there's noone running in parallel, but I'm open to suggestions as I'm not satisfied with the looks of this. I'll prepare a net-next patchset for netconsole soon to clean it up properly, all of these can be easily simplified.

 drivers/net/netconsole.c | 8 ++++++++
 1 file changed, 8 insertions(+)
drivers/net/netconsole.c +8 -0
index adeee61..1505dcb 100644
@@ -310,6 +310,7 @@ static ssize_t store_enabled(struct netconsole_target *nt,
 			     const char *buf,
 			     size_t count)
 {
+	unsigned long flags;
 	int enabled;
 	int err;
 
@@ -342,6 +343,13 @@ static ssize_t store_enabled(struct netconsole_target *nt,
 		printk(KERN_INFO "netconsole: network logging started\n");
 
 	} else {	/* 0 */
+		/* We need to disable the netconsole before cleaning it up
+		 * otherwise we might end up in write_msg() with
+		 * nt->np.dev == NULL and nt->enabled == 1
+		 */
+		spin_lock_irqsave(&target_list_lock, flags);
+		nt->enabled = 0;
+		spin_unlock_irqrestore(&target_list_lock, flags);
 		netpoll_cleanup(&nt->np);
 	}
 
Signature · 1 line
1.8.1.4
Reviewed-by on v1 1/1
#1 lore raw
Quoted 13 lines · Nikolay Aleksandrov

We need to disable the netconsole (enabled = 0) before setting nt->np.dev to NULL because otherwise we might still have users after the netpoll_cleanup() since nt->enabled is set afterwards and we can have a message which will result in a NULL pointer dereference. It is very easy to hit dereferences all over the netpoll_send_udp function by running the following two loops in parallel:
while [ 1 ]; do echo 1 > enabled; echo 0 > enabled; done; while [ 1 ]; do echo 00:11:22:33:44:55 > remote_mac; done; (the second loop is to generate messages, it can be done by anything)

We're safe to set nt->np.dev = NULL and nt->enabled = 0 with the spinlock since it's required in the write_msg() function.

Quoted 6 lines

---
Taking the spinlock seems like the cleanest way to insure there's noone running in parallel, but I'm open to suggestions as I'm not satisfied with the looks of this. I'll prepare a net-next patchset for netconsole soon to clean it up properly, all of these can be easily simplified.

First when I've seen 'spin_lock(); a = 1; spin_unlock()' I've thought "WTF?", however indeed it will stop us racing with write_msg().

FWIW...

Quoted 37 lines

drivers/net/netconsole.c | 8 ++++++++

1 file changed, 8 insertions(+)
drivers/net/netconsole.c +8 -0
index adeee61..1505dcb 100644
@@ -310,6 +310,7 @@ static ssize_t store_enabled(struct netconsole_target *nt,
 			     const char *buf,
 			     size_t count)
 {
+	unsigned long flags;
 	int enabled;
 	int err;
 
@@ -342,6 +343,13 @@ static ssize_t store_enabled(struct netconsole_target *nt,
 		printk(KERN_INFO "netconsole: network logging started\n");
 
 	} else {	/* 0 */
+		/* We need to disable the netconsole before cleaning it up
+		 * otherwise we might end up in write_msg() with
+		 * nt->np.dev == NULL and nt->enabled == 1
+		 */
+		spin_lock_irqsave(&target_list_lock, flags);
+		nt->enabled = 0;
+		spin_unlock_irqrestore(&target_list_lock, flags);
 		netpoll_cleanup(&nt->np);
 	}
 
Signature · 6 lines
1.8.1.4

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
#2 lore raw
Quoted 7 lines
Quoted 4 lines

Taking the spinlock seems like the cleanest way to insure there's noone running in parallel, but I'm open to suggestions as I'm not satisfied with the looks of this. I'll prepare a net-next patchset for netconsole soon to clean it up properly, all of these can be easily simplified.

First when I've seen 'spin_lock(); a = 1; spin_unlock()' I've thought "WTF?", however indeed it will stop us racing with write_msg().

Ditto - might be worth saying:

    /* Acquire lock to wait for any write_msg() to complete. */

	David
maintainer
#3 lore raw

From: "David Laight" <[email protected]>
Date: Thu, 24 Oct 2013 11:39:02 +0100

Quoted 10 lines
Quoted 7 lines
Quoted 4 lines

Taking the spinlock seems like the cleanest way to insure there's noone running in parallel, but I'm open to suggestions as I'm not satisfied with the looks of this. I'll prepare a net-next patchset for netconsole soon to clean it up properly, all of these can be easily simplified.

First when I've seen 'spin_lock(); a = 1; spin_unlock()' I've thought "WTF?", however indeed it will stop us racing with write_msg().

Ditto - might be worth saying:

    /* Acquire lock to wait for any write_msg() to complete. */

Something this subtle definitely requires a comment.

#4 lore raw
Quoted 8 lines · David Miller

From: "David Laight" <[email protected]>
Date: Thu, 24 Oct 2013 11:39:02 +0100

Quoted 5 lines
Quoted 5 lines
Quoted 4 lines

Taking the spinlock seems like the cleanest way to insure there's noone running in parallel, but I'm open to suggestions as I'm not satisfied with the looks of this. I'll prepare a net-next patchset for netconsole soon to clean it up properly, all of these can be easily simplified.

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

First when I've seen 'spin_lock(); a = 1; spin_unlock()' I've thought "WTF?", however indeed it will stop us racing with write_msg().

Ditto - might be worth saying:

    /* Acquire lock to wait for any write_msg() to complete. */

Something this subtle definitely requires a comment.

Okay, thank you all for the reviews. I will re-submit a v2 with the comment edited.

Nik

#5 lore raw

Nikolay Aleksandrov <[email protected]> :

Quoted 2 lines · David Miller
Quoted 1 line

From: "David Laight" <[email protected]>

[...]

Quoted 7 lines
Quoted 5 lines
Quoted 2 lines

Ditto - might be worth saying:

    /* Acquire lock to wait for any write_msg() to complete. */

Something this subtle definitely requires a comment.

Okay, thank you all for the reviews. I will re-submit a v2 with the comment edited.

"edited" as in "removed" because:
1. an irq disabling spinlock loudly states what the intent is ("hey, this netconsole stuff could be concurrently used in irq or softirq context").
2. the target_list_lock spinlock itself tells where to look for:

drivers/net/netconsole.c
[...]
/* This needs to be a spinlock because write_msg() cannot sleep */ static DEFINE_SPINLOCK(target_list_lock);

Signature · 1 line
Ueimor
#6 lore raw
Quoted 17 lines · Francois Romieu

Nikolay Aleksandrov <[email protected]> :

Quoted 2 lines · David Miller
Quoted 1 line

From: "David Laight" <[email protected]>

[...]

Quoted 7 lines
Quoted 5 lines
Quoted 2 lines

Ditto - might be worth saying:

    /* Acquire lock to wait for any write_msg() to complete. */

Something this subtle definitely requires a comment.

Okay, thank you all for the reviews. I will re-submit a v2 with the comment edited.

"edited" as in "removed" because:
1. an irq disabling spinlock loudly states what the intent is ("hey, this netconsole stuff could be concurrently used in irq or softirq context").
2. the target_list_lock spinlock itself tells where to look for:

Quoted 5 lines

drivers/net/netconsole.c
[...]
/* This needs to be a spinlock because write_msg() cannot sleep */ static DEFINE_SPINLOCK(target_list_lock);

I thought so too. Although I also mentioned the problem and that it involves write_msg in the current comment:
+ /* We need to disable the netconsole before cleaning it up
+ * otherwise we might end up in write_msg() with
+ * nt->np.dev == NULL and nt->enabled == 1
+ */

I thought this implies that the spinlock protects us against running with write_msg().
It's fine by me either way (with or w/o the addition to the comment). It's up to you Dave, do you still want it explicitly there ?

#7 lore raw

Nikolay Aleksandrov <[email protected]> :
[...]

Quoted 4 lines

I thought this implies that the spinlock protects us against running with write_msg().
It's fine by me either way (with or w/o the addition to the comment). It's up to you Dave, do you still want it explicitly there ?

There was some facetiousness in David's comment.

Signature · 1 line
Ueimor