Skip to contentSkip to conversation

bootstage: Fix out-of-bounds read in reloc_bootstage()

PATCH In review Richard Weinberger 4 participants 5 messages Jul 31, 2024 – Aug 16, 2024

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 bootstage: Fix out-of-bounds read in reloc_bootstage()

bootstage_get_size() returns the total size of the data structure including associated records.
When copying from gd->bootstage, only the allocation size of gd->bootstage must be used. Otherwise too much memory is copied.

This bug caused no harm so far because gd->new_bootstage is always large enough and reading beyond the allocation length of gd->bootstage caused no problem due to the U-Boot memory layout.

Fix by using the correct size and perform the initial copy directly in bootstage_relocate() to have the whole relocation process in the same function.

---
Changes since v1:
- Pass gd->new_bootstage to bootstage_relocate()

---
 common/board_f.c    | 8 +-------
 common/bootstage.c  | 8 ++++++--
 include/bootstage.h | 4 ++--
 3 files changed, 9 insertions(+), 11 deletions(-)
common/board_f.c +1 -7
index 29e185137a..21a8944e2b 100644
@@ -683,13 +683,7 @@ static int reloc_bootstage(void)
 	if (gd->flags & GD_FLG_SKIP_RELOC)
 		return 0;
 	if (gd->new_bootstage) {
-		int size = bootstage_get_size();
-
-		debug("Copying bootstage from %p to %p, size %x\n",
-		      gd->bootstage, gd->new_bootstage, size);
-		memcpy(gd->new_bootstage, gd->bootstage, size);
-		gd->bootstage = gd->new_bootstage;
-		bootstage_relocate();
+		bootstage_relocate(gd->new_bootstage);
 	}
 #endif
 
common/bootstage.c +6 -2
index b6c268d9f4..49acc9078a 100644
@@ -54,12 +54,16 @@ struct bootstage_hdr {
 	u32 next_id;		/* Next ID to use for bootstage */
 };
 
-int bootstage_relocate(void)
+int bootstage_relocate(void *to)
 {
-	struct bootstage_data *data = gd->bootstage;
+	struct bootstage_data *data;
 	int i;
 	char *ptr;
 
+	debug("Copying bootstage from %p to %p\n", gd->bootstage, to);
+	memcpy(to, gd->bootstage, sizeof(struct bootstage_data));
+	data = gd->bootstage = to;
+
 	/* Figure out where to relocate the strings to */
 	ptr = (char *)(data + 1);
 
include/bootstage.h +2 -2
index f4e77b09d7..57792648c4 100644
@@ -258,7 +258,7 @@ void show_boot_progress(int val);
  * relocation, since memory can be overwritten later.
  * Return: Always returns 0, to indicate success
  */
-int bootstage_relocate(void);
+int bootstage_relocate(void *to);
 
 /**
  * Add a new bootstage record
@@ -395,7 +395,7 @@ static inline ulong bootstage_add_record(enum bootstage_id id,
  * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
  */
 
-static inline int bootstage_relocate(void)
+static inline int bootstage_relocate(void *to)
 {
 	return 0;
 }
Signature · 1 line
2.35.3
Reviewed-by on v2 1/1
#1 lore raw

Hi Richard,

Quoted 15 lines · Richard Weinberger

bootstage_get_size() returns the total size of the data structure including associated records.
When copying from gd->bootstage, only the allocation size of gd->bootstage must be used. Otherwise too much memory is copied.

This bug caused no harm so far because gd->new_bootstage is always large enough and reading beyond the allocation length of gd->bootstage caused no problem due to the U-Boot memory layout.

Fix by using the correct size and perform the initial copy directly in bootstage_relocate() to have the whole relocation process in the same function.

Quoted 9 lines

---
Changes since v1:
- Pass gd->new_bootstage to bootstage_relocate()

---
 common/board_f.c    | 8 +-------
 common/bootstage.c  | 8 ++++++--
 include/bootstage.h | 4 ++--
 3 files changed, 9 insertions(+), 11 deletions(-)

nit below

Quoted 28 lines
common/board_f.c +1 -7
index 29e185137a..21a8944e2b 100644
@@ -683,13 +683,7 @@ static int reloc_bootstage(void)
        if (gd->flags & GD_FLG_SKIP_RELOC)
                return 0;
        if (gd->new_bootstage) {
-               int size = bootstage_get_size();
-
-               debug("Copying bootstage from %p to %p, size %x\n",
-                     gd->bootstage, gd->new_bootstage, size);
-               memcpy(gd->new_bootstage, gd->bootstage, size);
-               gd->bootstage = gd->new_bootstage;
-               bootstage_relocate();
+               bootstage_relocate(gd->new_bootstage);
        }
 #endif
 
common/bootstage.c +0 -1
index b6c268d9f4..49acc9078a 100644
@@ -54,12 +54,16 @@ struct bootstage_hdr {
        u32 next_id;            /* Next ID to use for bootstage */
 };
 
-int bootstage_relocate(void)

common/bootstage.c struct bootstage_hdr { · line 65

Quoted 10 lines
common/bootstage.c +5 -1
+int bootstage_relocate(void *to)
 {
-       struct bootstage_data *data = gd->bootstage;
+       struct bootstage_data *data;
        int i;
        char *ptr;
 
+       debug("Copying bootstage from %p to %p\n", gd->bootstage, to);
+       memcpy(to, gd->bootstage, sizeof(struct bootstage_data));
+       data = gd->bootstage = to;

should be a separate line (patman/checkpatch complains)

Quoted 27 lines
common/bootstage.c +1 -0
+
        /* Figure out where to relocate the strings to */
        ptr = (char *)(data + 1);
 
include/bootstage.h +2 -3
index f4e77b09d7..57792648c4 100644
@@ -258,7 +258,7 @@ void show_boot_progress(int val);
  * relocation, since memory can be overwritten later.
  * Return: Always returns 0, to indicate success
  */
-int bootstage_relocate(void);
+int bootstage_relocate(void *to);
 
 /**
  * Add a new bootstage record
@@ -395,7 +395,7 @@ static inline ulong bootstage_add_record(enum bootstage_id id,
  * and won't even do that unless CONFIG_SHOW_BOOT_PROGRESS is defined
  */
 
-static inline int bootstage_relocate(void)
+static inline int bootstage_relocate(void *to)
 {
        return 0;
 }
--
Quoted 2 lines

2.35.3

Regards,
Simon

#2 lore raw

Simon,

Am Donnerstag, 1. August 2024, 16:42:14 CEST schrieb Simon Glass:

Quoted 5 lines

common/bootstage.c struct bootstage_hdr { · line 65

Quoted 3 lines
common/bootstage.c +3 -0
+       debug("Copying bootstage from %p to %p\n", gd->bootstage, to);
+       memcpy(to, gd->bootstage, sizeof(struct bootstage_data));
+       data = gd->bootstage = to;

should be a separate line (patman/checkpatch complains)

I saw the suggestion of checkpatch.pl but ditched it as matter of taste. Do you want a v3?

Thanks,
//richard

Signature · 2 lines
​​​​​sigma star gmbh | Eduard-Bodem-Gasse 6, 6020 Innsbruck, AUT
UID/VAT Nr: ATU 66964118 | FN: 374287y
#3 lore raw

Hi Richard,

Quoted 4 lines · Richard Weinberger

Simon,

Am Donnerstag, 1. August 2024, 16:42:14 CEST schrieb Simon Glass:

Quoted 8 lines
Quoted 5 lines

common/bootstage.c struct bootstage_hdr { · line 65

Quoted 3 lines
common/bootstage.c +3 -0
+       debug("Copying bootstage from %p to %p\n", gd->bootstage, to);
+       memcpy(to, gd->bootstage, sizeof(struct bootstage_data));
+       data = gd->bootstage = to;

should be a separate line (patman/checkpatch complains)

I saw the suggestion of checkpatch.pl but ditched it as matter of taste. Do you want a v3?

It's OK I suppose. I used to hate that checkpatch.pl rule too, but have come to get used to it...it avoids hiding the gd-> assignment that my eye is looking for :-)

Regards,
Simon

Quoted 9 lines

Thanks,
//richard

--
sigma star gmbh | Eduard-Bodem-Gasse 6, 6020 Innsbruck, AUT UID/VAT Nr: ATU 66964118 | FN: 374287y

#4 lore raw
In reply to Richard Weinberger
Quoted 10 lines · Richard Weinberger

bootstage_get_size() returns the total size of the data structure including associated records.
When copying from gd->bootstage, only the allocation size of gd->bootstage must be used. Otherwise too much memory is copied.

This bug caused no harm so far because gd->new_bootstage is always large enough and reading beyond the allocation length of gd->bootstage caused no problem due to the U-Boot memory layout.

[...]

Applied to u-boot/next, thanks!

Signature · 1 line
Tom