Skip to contentSkip to conversation

tools: kwbimage: Verify supported image version

PATCH In review Pali Rohár 2 participants 12 messages Aug 11, 2021 – Sep 1, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/4 tools: kwbimage: Verify supported image version

Only image versions 0 and 1 are supported. Verify it in kwbimage_verify_header() function.

---
 tools/kwbimage.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
tools/kwbimage.c +3 -3
index 4bff02bb3fb5..80aae8a6b619 100644
@@ -1690,9 +1690,7 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
 			if (checksum != ext_hdr->checksum)
 				return -FDT_ERR_BADSTRUCTURE;
 		}
-	}
-
-	if (image_version((void *)ptr) == 1) {
+	} else if (image_version((void *)ptr) == 1) {
 		struct main_hdr_v1 *mhdr = (struct main_hdr_v1 *)ptr;
 		uint32_t offset;
 		uint32_t size;
@@ -1762,6 +1760,8 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
 		if (image_checksum32(ptr + offset, size - 4) !=
 		    *(uint32_t *)(ptr + offset + size - 4))
 			return -FDT_ERR_BADSTRUCTURE;
+	} else {
+		return -FDT_ERR_BADSTRUCTURE;
 	}
 
 	return 0;
Signature · 1 line
2.20.1
#1 lore raw

PATCH 2/4 tools: kwbimage: Verify size of v0 image header

Check that extended image header size is not larger than file size.

---
 tools/kwbimage.c | 3 +++
 1 file changed, 3 insertions(+)
tools/kwbimage.c +3 -0
index 80aae8a6b619..84c41210e39e 100644
@@ -1682,6 +1682,9 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
 		if (mhdr->ext & 0x1) {
 			struct ext_hdr_v0 *ext_hdr;
 
+			if (header_size + sizeof(*ext_hdr) > image_size)
+				return -FDT_ERR_BADSTRUCTURE;
+
 			ext_hdr = (struct ext_hdr_v0 *)
 				(ptr + sizeof(struct main_hdr_v0));
 			checksum = image_checksum8(ext_hdr,
Signature · 1 line
2.20.1
Reviewed-by on v1 2/4
#2 lore raw

Re: [PATCH 2/4] tools: kwbimage: Verify size of v0 image header

Quoted 3 lines · Pali Rohár

Check that extended image header size is not larger than file size.

Thanks,
Stefan

Quoted 10 lines
---
  tools/kwbimage.c | 3 +++
  1 file changed, 3 insertions(+)
tools/kwbimage.c +0 -0
index 80aae8a6b619..84c41210e39e 100644

tools/kwbimage.c static int kwbimage_verify_header(unsigned char *ptr, int image_size, · line 1690

Quoted 9 lines
tools/kwbimage.c +3 -0
@@ -1682,6 +1682,9 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  		if (mhdr->ext & 0x1) {
  			struct ext_hdr_v0 *ext_hdr;
 
+			if (header_size + sizeof(*ext_hdr) > image_size)
+				return -FDT_ERR_BADSTRUCTURE;
+
  			ext_hdr = (struct ext_hdr_v0 *)
  				(ptr + sizeof(struct main_hdr_v0));
  			checksum = image_checksum8(ext_hdr,

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
#3 lore raw

Re: [PATCH 2/4] tools: kwbimage: Verify size of v0 image header

In reply to Pali Rohár
Quoted 3 lines · Pali Rohár

Check that extended image header size is not larger than file size.

Applied to u-boot-marvell/master

Thanks,
Stefan

Quoted 10 lines
---
  tools/kwbimage.c | 3 +++
  1 file changed, 3 insertions(+)
tools/kwbimage.c +0 -0
index 80aae8a6b619..84c41210e39e 100644

tools/kwbimage.c static int kwbimage_verify_header(unsigned char *ptr, int image_size, · line 1690

Quoted 9 lines
tools/kwbimage.c +3 -0
@@ -1682,6 +1682,9 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  		if (mhdr->ext & 0x1) {
  			struct ext_hdr_v0 *ext_hdr;
 
+			if (header_size + sizeof(*ext_hdr) > image_size)
+				return -FDT_ERR_BADSTRUCTURE;
+
  			ext_hdr = (struct ext_hdr_v0 *)
  				(ptr + sizeof(struct main_hdr_v0));
  			checksum = image_checksum8(ext_hdr,

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
#4 lore raw

PATCH 3/4 tools: kwbimage: Verify size of image data

In reply to Pali Rohár

Part of image data is 4 byte checksum, so every image must contain at least 4 bytes. Verify it to prevent memory corruptions.

---
 tools/kwbimage.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/kwbimage.c +1 -1
index 84c41210e39e..5ac34ac5e9c8 100644
@@ -1757,7 +1757,7 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
 			return -FDT_ERR_BADSTRUCTURE;
 
 		size = le32_to_cpu(mhdr->blocksize);
-		if (offset + size > image_size || size % 4 != 0)
+		if (size < 4 || offset + size > image_size || size % 4 != 0)
 			return -FDT_ERR_BADSTRUCTURE;
 
 		if (image_checksum32(ptr + offset, size - 4) !=
Signature · 1 line
2.20.1
Reviewed-by on v1 3/4
#5 lore raw

Re: [PATCH 3/4] tools: kwbimage: Verify size of image data

Quoted 4 lines · Pali Rohár

Part of image data is 4 byte checksum, so every image must contain at least 4 bytes. Verify it to prevent memory corruptions.

Thanks,
Stefan

Quoted 10 lines
---
  tools/kwbimage.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
tools/kwbimage.c +0 -0
index 84c41210e39e..5ac34ac5e9c8 100644

tools/kwbimage.c static int kwbimage_verify_header(unsigned char *ptr, int image_size, · line 1763

Quoted 8 lines
tools/kwbimage.c +1 -1
@@ -1757,7 +1757,7 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  			return -FDT_ERR_BADSTRUCTURE;
 
  		size = le32_to_cpu(mhdr->blocksize);
-		if (offset + size > image_size || size % 4 != 0)
+		if (size < 4 || offset + size > image_size || size % 4 != 0)
  			return -FDT_ERR_BADSTRUCTURE;
 
  		if (image_checksum32(ptr + offset, size - 4) !=

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
#6 lore raw

Re: [PATCH 3/4] tools: kwbimage: Verify size of image data

In reply to Pali Rohár
Quoted 4 lines · Pali Rohár

Part of image data is 4 byte checksum, so every image must contain at least 4 bytes. Verify it to prevent memory corruptions.

Applied to u-boot-marvell/master

Thanks,
Stefan

Quoted 10 lines
---
  tools/kwbimage.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
tools/kwbimage.c +0 -0
index 84c41210e39e..5ac34ac5e9c8 100644

tools/kwbimage.c static int kwbimage_verify_header(unsigned char *ptr, int image_size, · line 1763

Quoted 8 lines
tools/kwbimage.c +1 -1
@@ -1757,7 +1757,7 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  			return -FDT_ERR_BADSTRUCTURE;
 
  		size = le32_to_cpu(mhdr->blocksize);
-		if (offset + size > image_size || size % 4 != 0)
+		if (size < 4 || offset + size > image_size || size % 4 != 0)
  			return -FDT_ERR_BADSTRUCTURE;
 
  		if (image_checksum32(ptr + offset, size - 4) !=

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
#7 lore raw

PATCH 4/4 tools: kwbimage: Use IBR_HDR_* constants instead of raw numbers

In reply to Pali Rohár

There are already IBR_HDR_* constants for these numbers, so use them.

---
 tools/kwbimage.c | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)
tools/kwbimage.c +11 -11
index 5ac34ac5e9c8..c1269fb6633a 100644
@@ -59,13 +59,13 @@ struct hash_v1 {
 };
 
 struct boot_mode boot_modes[] = {
-	{ 0x4D, "i2c"  },
-	{ 0x5A, "spi"  },
-	{ 0x8B, "nand" },
-	{ 0x78, "sata" },
-	{ 0x9C, "pex"  },
-	{ 0x69, "uart" },
-	{ 0xAE, "sdio" },
+	{ IBR_HDR_I2C_ID, "i2c"  },
+	{ IBR_HDR_SPI_ID, "spi"  },
+	{ IBR_HDR_NAND_ID, "nand" },
+	{ IBR_HDR_SATA_ID, "sata" },
+	{ IBR_HDR_PEX_ID, "pex"  },
+	{ IBR_HDR_UART_ID, "uart" },
+	{ IBR_HDR_SDIO_ID, "sdio" },
 	{},
 };
 
@@ -75,10 +75,10 @@ struct nand_ecc_mode {
 };
 
 struct nand_ecc_mode nand_ecc_modes[] = {
-	{ 0x00, "default" },
-	{ 0x01, "hamming" },
-	{ 0x02, "rs" },
-	{ 0x03, "disabled" },
+	{ IBR_HDR_ECC_DEFAULT, "default" },
+	{ IBR_HDR_ECC_FORCED_HAMMING, "hamming" },
+	{ IBR_HDR_ECC_FORCED_RS, "rs" },
+	{ IBR_HDR_ECC_DISABLED, "disabled" },
 	{},
 };
 
Signature · 1 line
2.20.1
Reviewed-by on v1 4/4
#8 lore raw

Re: [PATCH 4/4] tools: kwbimage: Use IBR_HDR_* constants instead of raw numbers

Quoted 3 lines · Pali Rohár

There are already IBR_HDR_* constants for these numbers, so use them.

Thanks,
Stefan

Quoted 35 lines
---
  tools/kwbimage.c | 22 +++++++++++-----------
  1 file changed, 11 insertions(+), 11 deletions(-)
tools/kwbimage.c +7 -8
index 5ac34ac5e9c8..c1269fb6633a 100644
@@ -59,13 +59,13 @@ struct hash_v1 {
  };
 
  struct boot_mode boot_modes[] = {
-	{ 0x4D, "i2c"  },
-	{ 0x5A, "spi"  },
-	{ 0x8B, "nand" },
-	{ 0x78, "sata" },
-	{ 0x9C, "pex"  },
-	{ 0x69, "uart" },
-	{ 0xAE, "sdio" },
+	{ IBR_HDR_I2C_ID, "i2c"  },
+	{ IBR_HDR_SPI_ID, "spi"  },
+	{ IBR_HDR_NAND_ID, "nand" },
+	{ IBR_HDR_SATA_ID, "sata" },
+	{ IBR_HDR_PEX_ID, "pex"  },
+	{ IBR_HDR_UART_ID, "uart" },
+	{ IBR_HDR_SDIO_ID, "sdio" },
  	{},
  };
 
@@ -75,10 +75,10 @@ struct nand_ecc_mode {
  };
 
  struct nand_ecc_mode nand_ecc_modes[] = {
-	{ 0x00, "default" },

tools/kwbimage.c struct nand_ecc_mode { · line 84

Quoted 10 lines
tools/kwbimage.c +4 -3
-	{ 0x01, "hamming" },
-	{ 0x02, "rs" },
-	{ 0x03, "disabled" },
+	{ IBR_HDR_ECC_DEFAULT, "default" },
+	{ IBR_HDR_ECC_FORCED_HAMMING, "hamming" },
+	{ IBR_HDR_ECC_FORCED_RS, "rs" },
+	{ IBR_HDR_ECC_DISABLED, "disabled" },
  	{},
  };
 

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
#9 lore raw

Re: [PATCH 4/4] tools: kwbimage: Use IBR_HDR_* constants instead of raw numbers

In reply to Pali Rohár
Quoted 3 lines · Pali Rohár

There are already IBR_HDR_* constants for these numbers, so use them.

Applied to u-boot-marvell/master

Thanks,
Stefan

Quoted 35 lines
---
  tools/kwbimage.c | 22 +++++++++++-----------
  1 file changed, 11 insertions(+), 11 deletions(-)
tools/kwbimage.c +7 -8
index 5ac34ac5e9c8..c1269fb6633a 100644
@@ -59,13 +59,13 @@ struct hash_v1 {
  };
 
  struct boot_mode boot_modes[] = {
-	{ 0x4D, "i2c"  },
-	{ 0x5A, "spi"  },
-	{ 0x8B, "nand" },
-	{ 0x78, "sata" },
-	{ 0x9C, "pex"  },
-	{ 0x69, "uart" },
-	{ 0xAE, "sdio" },
+	{ IBR_HDR_I2C_ID, "i2c"  },
+	{ IBR_HDR_SPI_ID, "spi"  },
+	{ IBR_HDR_NAND_ID, "nand" },
+	{ IBR_HDR_SATA_ID, "sata" },
+	{ IBR_HDR_PEX_ID, "pex"  },
+	{ IBR_HDR_UART_ID, "uart" },
+	{ IBR_HDR_SDIO_ID, "sdio" },
  	{},
  };
 
@@ -75,10 +75,10 @@ struct nand_ecc_mode {
  };
 
  struct nand_ecc_mode nand_ecc_modes[] = {
-	{ 0x00, "default" },

tools/kwbimage.c struct nand_ecc_mode { · line 84

Quoted 10 lines
tools/kwbimage.c +4 -3
-	{ 0x01, "hamming" },
-	{ 0x02, "rs" },
-	{ 0x03, "disabled" },
+	{ IBR_HDR_ECC_DEFAULT, "default" },
+	{ IBR_HDR_ECC_FORCED_HAMMING, "hamming" },
+	{ IBR_HDR_ECC_FORCED_RS, "rs" },
+	{ IBR_HDR_ECC_DISABLED, "disabled" },
  	{},
  };
 

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
Reviewed-by on v1 1/4
#10 lore raw
In reply to Pali Rohár
Quoted 4 lines · Pali Rohár

Only image versions 0 and 1 are supported. Verify it in kwbimage_verify_header() function.

Thanks,
Stefan

Quoted 21 lines
---
  tools/kwbimage.c | 6 +++---
  1 file changed, 3 insertions(+), 3 deletions(-)
tools/kwbimage.c +1 -3
index 4bff02bb3fb5..80aae8a6b619 100644
@@ -1690,9 +1690,7 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  			if (checksum != ext_hdr->checksum)
  				return -FDT_ERR_BADSTRUCTURE;
  		}
-	}
-
-	if (image_version((void *)ptr) == 1) {
+	} else if (image_version((void *)ptr) == 1) {
  		struct main_hdr_v1 *mhdr = (struct main_hdr_v1 *)ptr;
  		uint32_t offset;
  		uint32_t size;

tools/kwbimage.c static int kwbimage_verify_header(unsigned char *ptr, int image_size, · line 1767

Quoted 8 lines
tools/kwbimage.c +2 -0
@@ -1762,6 +1760,8 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  		if (image_checksum32(ptr + offset, size - 4) !=
  		    *(uint32_t *)(ptr + offset + size - 4))
  			return -FDT_ERR_BADSTRUCTURE;
+	} else {
+		return -FDT_ERR_BADSTRUCTURE;
  	}
 
  	return 0;

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]
#11 lore raw
In reply to Pali Rohár
Quoted 4 lines · Pali Rohár

Only image versions 0 and 1 are supported. Verify it in kwbimage_verify_header() function.

Applied to u-boot-marvell/master

Thanks,
Stefan

Quoted 21 lines
---
  tools/kwbimage.c | 6 +++---
  1 file changed, 3 insertions(+), 3 deletions(-)
tools/kwbimage.c +1 -3
index 4bff02bb3fb5..80aae8a6b619 100644
@@ -1690,9 +1690,7 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  			if (checksum != ext_hdr->checksum)
  				return -FDT_ERR_BADSTRUCTURE;
  		}
-	}
-
-	if (image_version((void *)ptr) == 1) {
+	} else if (image_version((void *)ptr) == 1) {
  		struct main_hdr_v1 *mhdr = (struct main_hdr_v1 *)ptr;
  		uint32_t offset;
  		uint32_t size;

tools/kwbimage.c static int kwbimage_verify_header(unsigned char *ptr, int image_size, · line 1767

Quoted 8 lines
tools/kwbimage.c +2 -0
@@ -1762,6 +1760,8 @@ static int kwbimage_verify_header(unsigned char *ptr, int image_size,
  		if (image_checksum32(ptr + offset, size - 4) !=
  		    *(uint32_t *)(ptr + offset + size - 4))
  			return -FDT_ERR_BADSTRUCTURE;
+	} else {
+		return -FDT_ERR_BADSTRUCTURE;
  	}
 
  	return 0;

Viele Grüße,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: [email protected]