Skip to contentSkip to conversation

efi_loader: correct reported length in GetNextVariable()

PATCH Superseded Heinrich Schuchardt 3 participants 6 messages Mar 20, 2020 – Mar 30, 2020

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover efi_loader: correct reported length in GetNextVariable()

The runtime service GetNextVariable() returns the length of the next variable including the closing 0x0000. This length should be in bytes.

Comparing the output of EDK2 and U-Boot shows that this is currently not correctly implemented:

EDK2:
OsIndicationsSupported: 46
PlatformLang: 26
PlatformLangCodes: 36

U-Boot:
OsIndicationsSupported: 23
PlatformLang: 13
PlatformLangCodes: 18

Provide correct length in GetNextVariable().

Provide a unit test.

Heinrich Schuchardt (2):
efi_loader: correct reported length in GetNextVariable()
efi_selftest: check length report by GetNextVariableName()

 lib/efi_loader/efi_variable.c             | 2 +-
 lib/efi_selftest/efi_selftest_variables.c | 8 +++++++-
 2 files changed, 8 insertions(+), 2 deletions(-)

--
2.25.1

#1 lore raw

PATCH 1/2 efi_loader: correct reported length in GetNextVariable()

The runtime service GetNextVariable() returns the length of the next variable including the closing 0x0000. This length should be in bytes.

Comparing the output of EDK2 and U-Boot shows that this is currently not correctly implemented:

EDK2:
OsIndicationsSupported: 46
PlatformLang: 26
PlatformLangCodes: 36

U-Boot:
OsIndicationsSupported: 23
PlatformLang: 13
PlatformLangCodes: 18

Provide correct length in GetNextVariable().

Fixes d99a87f84b75 ("efi_loader: implement GetNextVariableName()")
---
 lib/efi_loader/efi_variable.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/efi_loader/efi_variable.c +1 -1
index c316bdfec0..04ead34c6f 100644
@@ -299,7 +299,7 @@ static efi_status_t parse_uboot_variable(char *variable,
 	p = variable_name;
 	utf8_utf16_strncpy(&p, name, name_len);
 	variable_name[name_len] = 0;
-	*variable_name_size = name_len + 1;
+	*variable_name_size = sizeof(u16) * (name_len + 1);
 
 	/* guid */
 	c = *(name - 1);

--
2.25.1

#2 lore raw

PATCH 1/2 efi_loader: correct reported length in GetNextVariable()

Hi Heinrich,

Quoted 29 lines · Heinrich Schuchardt

The runtime service GetNextVariable() returns the length of the next variable including the closing 0x0000. This length should be in bytes.

Comparing the output of EDK2 and U-Boot shows that this is currently not correctly implemented:

EDK2:
OsIndicationsSupported: 46
PlatformLang: 26
PlatformLangCodes: 36

U-Boot:
OsIndicationsSupported: 23
PlatformLang: 13
PlatformLangCodes: 18

Provide correct length in GetNextVariable().

Fixes d99a87f84b75 ("efi_loader: implement GetNextVariableName()")
---
 lib/efi_loader/efi_variable.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/efi_loader/efi_variable.c +0 -0
index c316bdfec0..04ead34c6f 100644

lib/efi_loader/efi_variable.c static efi_status_t parse_uboot_variable(char *variable, · line 302

Quoted 5 lines
lib/efi_loader/efi_variable.c +1 -1
@@ -299,7 +299,7 @@ static efi_status_t parse_uboot_variable(char *variable,
 	p = variable_name;
 	utf8_utf16_strncpy(&p, name, name_len);
 	variable_name[name_len] = 0;
-	*variable_name_size = name_len + 1;
+	*variable_name_size = sizeof(u16) * (name_len + 1);

Maybe I am missing something, but isn't a similar fix needed in the function where the buffer is checked for sufficient size?

For context, I am referring to

	if (*variable_name_size < (name_len + 1)) {
		*variable_name_size = name_len + 1;
		return EFI_BUFFER_TOO_SMALL;
	}

Thanks,
Punit

Quoted 5 lines
lib/efi_loader/efi_variable.c +0 -1
 	/* guid */
 	c = *(name - 1);
--

2.25.1

#3 lore raw

PATCH 1/2 efi_loader: correct reported length in GetNextVariable()

In reply to Heinrich Schuchardt
Quoted 11 lines · Heinrich Schuchardt

The runtime service GetNextVariable() returns the length of the next variable including the closing 0x0000. This length should be in bytes.

Comparing the output of EDK2 and U-Boot shows that this is currently not correctly implemented:

EDK2:
OsIndicationsSupported: 46
PlatformLang: 26
PlatformLangCodes: 36

Quoted 6 lines

U-Boot:
OsIndicationsSupported: 23
PlatformLang: 13
PlatformLangCodes: 18

Provide correct length in GetNextVariable().

Please also correct a function description of GetNextVariable().

-Takahiro Akashi

Quoted 22 lines
Fixes d99a87f84b75 ("efi_loader: implement GetNextVariableName()")
---
 lib/efi_loader/efi_variable.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/efi_loader/efi_variable.c +1 -2
index c316bdfec0..04ead34c6f 100644
@@ -299,7 +299,7 @@ static efi_status_t parse_uboot_variable(char *variable,
 	p = variable_name;
 	utf8_utf16_strncpy(&p, name, name_len);
 	variable_name[name_len] = 0;
-	*variable_name_size = name_len + 1;
+	*variable_name_size = sizeof(u16) * (name_len + 1);
 
 	/* guid */
 	c = *(name - 1);
--

2.25.1

#4 lore raw

PATCH 2/2 efi_selftest: check length report by GetNextVariableName()

In reply to Heinrich Schuchardt

GetNextVariableName should report the length of the variable including the final 0x0000 in bytes.

Check this in the unit test.

---
 lib/efi_selftest/efi_selftest_variables.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
lib/efi_selftest/efi_selftest_variables.c +7 -1
index 5d98c029b8..b7ead340f5 100644
@@ -155,8 +155,14 @@ static int execute(void)
 			return EFI_ST_FAILURE;
 		}
 		if (!memcmp(&guid, &guid_vendor0, sizeof(efi_guid_t)) &&
-		    !efi_st_strcmp_16_8(varname, "efi_st_var0"))
+		    !efi_st_strcmp_16_8(varname, "efi_st_var0")) {
 			flag |= 1;
+			if (len != 24) {
+				efi_st_error("GetNextVariableName report wrong length %u, expected 24\n",
+					     (unsigned int)len);
+				return EFI_ST_FAILURE;
+			}
+		}
 		if (!memcmp(&guid, &guid_vendor1, sizeof(efi_guid_t)) &&
 		    !efi_st_strcmp_16_8(varname, "efi_st_var1"))
 			flag |= 2;

--
2.25.1

#5 lore raw

PATCH 2/2 efi_selftest: check length report by GetNextVariableName()

Quoted 19 lines · Heinrich Schuchardt

GetNextVariableName should report the length of the variable including the final 0x0000 in bytes.

Check this in the unit test.

---
 lib/efi_selftest/efi_selftest_variables.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
lib/efi_selftest/efi_selftest_variables.c +0 -1
index 5d98c029b8..b7ead340f5 100644
@@ -155,8 +155,14 @@ static int execute(void)
 			return EFI_ST_FAILURE;
 		}
 		if (!memcmp(&guid, &guid_vendor0, sizeof(efi_guid_t)) &&
-		    !efi_st_strcmp_16_8(varname, "efi_st_var0"))

lib/efi_selftest/efi_selftest_variables.c static int execute(void) · line 167

Quoted 10 lines
lib/efi_selftest/efi_selftest_variables.c +7 -0
+		    !efi_st_strcmp_16_8(varname, "efi_st_var0")) {
 			flag |= 1;
+			if (len != 24) {
+				efi_st_error("GetNextVariableName report wrong length %u, expected 24\n",
+					     (unsigned int)len);
+				return EFI_ST_FAILURE;
+			}
+		}
 		if (!memcmp(&guid, &guid_vendor1, sizeof(efi_guid_t)) &&
 		    !efi_st_strcmp_16_8(varname, "efi_st_var1"))

Logically, length check should be added here, too.

-Takahiro Akashi

Quoted 4 lines
lib/efi_selftest/efi_selftest_variables.c +0 -1
 			flag |= 2;
--

2.25.1