* [PATCH] MdeModulePkg/Bds: Check variable name even OptionNumber is NULL
@ 2017-10-10 8:58 Ruiyu Ni
2017-10-10 16:59 ` Laszlo Ersek
0 siblings, 1 reply; 3+ messages in thread
From: Ruiyu Ni @ 2017-10-10 8:58 UTC (permalink / raw)
To: edk2-devel; +Cc: Ard Biesheuvel, Laszlo Ersek
Current implementation skips to check whether the last four
characters are digits when the OptionNumber is NULL.
Even worse, it may incorrectly return FALSE when OptionNumber is
NULL.
The patch fixes it to always check the variable name even
OptionNumber is NULL.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Laszlo Ersek <lersek@redhat.com>
---
.../Library/UefiBootManagerLib/BmLoadOption.c | 45 ++++++++++++++--------
1 file changed, 30 insertions(+), 15 deletions(-)
diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
index b0a35058d0..32918caf32 100644
--- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
+++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
@@ -785,6 +785,8 @@ EfiBootManagerIsValidLoadOptionVariableName (
UINTN VariableNameLen;
UINTN Index;
UINTN Uint;
+ EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LocalOptionType;
+ UINT16 LocalOptionNumber;
if (VariableName == NULL) {
return FALSE;
@@ -792,39 +794,52 @@ EfiBootManagerIsValidLoadOptionVariableName (
VariableNameLen = StrLen (VariableName);
+ //
+ // Return FALSE when the variable name length is too small.
+ //
if (VariableNameLen <= 4) {
return FALSE;
}
- for (Index = 0; Index < ARRAY_SIZE (mBmLoadOptionName); Index++) {
- if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[Index])) &&
- (StrnCmp (VariableName, mBmLoadOptionName[Index], VariableNameLen - 4) == 0)
+ //
+ // Return FALSE when the variable name doesn't start with Driver/SysPrep/Boot/PlatformRecovery.
+ //
+ for (LocalOptionType = 0; LocalOptionType < ARRAY_SIZE (mBmLoadOptionName); LocalOptionType++) {
+ if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[LocalOptionType])) &&
+ (StrnCmp (VariableName, mBmLoadOptionName[LocalOptionType], VariableNameLen - 4) == 0)
) {
break;
}
}
+ if (LocalOptionType == ARRAY_SIZE (mBmLoadOptionName)) {
+ return FALSE;
+ }
- if (Index == ARRAY_SIZE (mBmLoadOptionName)) {
+ //
+ // Return FALSE when the last four characters are not hex digits.
+ //
+ LocalOptionNumber = 0;
+ for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
+ Uint = BmCharToUint (VariableName[Index]);
+ if (Uint == -1) {
+ break;
+ } else {
+ LocalOptionNumber = (UINT16) Uint + LocalOptionNumber * 0x10;
+ }
+ }
+ if (Index != VariableNameLen) {
return FALSE;
}
if (OptionType != NULL) {
- *OptionType = (EFI_BOOT_MANAGER_LOAD_OPTION_TYPE) Index;
+ *OptionType = LocalOptionType;
}
if (OptionNumber != NULL) {
- *OptionNumber = 0;
- for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
- Uint = BmCharToUint (VariableName[Index]);
- if (Uint == -1) {
- break;
- } else {
- *OptionNumber = (UINT16) Uint + *OptionNumber * 0x10;
- }
- }
+ *OptionNumber = LocalOptionNumber;
}
- return (BOOLEAN) (Index == VariableNameLen);
+ return TRUE;
}
/**
--
2.12.2.windows.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] MdeModulePkg/Bds: Check variable name even OptionNumber is NULL
2017-10-10 8:58 [PATCH] MdeModulePkg/Bds: Check variable name even OptionNumber is NULL Ruiyu Ni
@ 2017-10-10 16:59 ` Laszlo Ersek
2017-10-11 16:10 ` Ard Biesheuvel
0 siblings, 1 reply; 3+ messages in thread
From: Laszlo Ersek @ 2017-10-10 16:59 UTC (permalink / raw)
To: Ruiyu Ni, edk2-devel; +Cc: Ard Biesheuvel
On 10/10/17 10:58, Ruiyu Ni wrote:
> Current implementation skips to check whether the last four
> characters are digits when the OptionNumber is NULL.
> Even worse, it may incorrectly return FALSE when OptionNumber is
> NULL.
>
> The patch fixes it to always check the variable name even
> OptionNumber is NULL.
>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Cc: Laszlo Ersek <lersek@redhat.com>
> ---
> .../Library/UefiBootManagerLib/BmLoadOption.c | 45 ++++++++++++++--------
> 1 file changed, 30 insertions(+), 15 deletions(-)
>
> diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
> index b0a35058d0..32918caf32 100644
> --- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
> +++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
> @@ -785,6 +785,8 @@ EfiBootManagerIsValidLoadOptionVariableName (
> UINTN VariableNameLen;
> UINTN Index;
> UINTN Uint;
> + EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LocalOptionType;
> + UINT16 LocalOptionNumber;
>
> if (VariableName == NULL) {
> return FALSE;
> @@ -792,39 +794,52 @@ EfiBootManagerIsValidLoadOptionVariableName (
>
> VariableNameLen = StrLen (VariableName);
>
> + //
> + // Return FALSE when the variable name length is too small.
> + //
> if (VariableNameLen <= 4) {
> return FALSE;
> }
>
> - for (Index = 0; Index < ARRAY_SIZE (mBmLoadOptionName); Index++) {
> - if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[Index])) &&
> - (StrnCmp (VariableName, mBmLoadOptionName[Index], VariableNameLen - 4) == 0)
> + //
> + // Return FALSE when the variable name doesn't start with Driver/SysPrep/Boot/PlatformRecovery.
> + //
> + for (LocalOptionType = 0; LocalOptionType < ARRAY_SIZE (mBmLoadOptionName); LocalOptionType++) {
> + if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[LocalOptionType])) &&
> + (StrnCmp (VariableName, mBmLoadOptionName[LocalOptionType], VariableNameLen - 4) == 0)
> ) {
> break;
> }
> }
> + if (LocalOptionType == ARRAY_SIZE (mBmLoadOptionName)) {
> + return FALSE;
> + }
>
> - if (Index == ARRAY_SIZE (mBmLoadOptionName)) {
> + //
> + // Return FALSE when the last four characters are not hex digits.
> + //
> + LocalOptionNumber = 0;
> + for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
> + Uint = BmCharToUint (VariableName[Index]);
> + if (Uint == -1) {
> + break;
> + } else {
> + LocalOptionNumber = (UINT16) Uint + LocalOptionNumber * 0x10;
> + }
> + }
> + if (Index != VariableNameLen) {
> return FALSE;
> }
>
> if (OptionType != NULL) {
> - *OptionType = (EFI_BOOT_MANAGER_LOAD_OPTION_TYPE) Index;
> + *OptionType = LocalOptionType;
> }
>
> if (OptionNumber != NULL) {
> - *OptionNumber = 0;
> - for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
> - Uint = BmCharToUint (VariableName[Index]);
> - if (Uint == -1) {
> - break;
> - } else {
> - *OptionNumber = (UINT16) Uint + *OptionNumber * 0x10;
> - }
> - }
> + *OptionNumber = LocalOptionNumber;
> }
>
> - return (BOOLEAN) (Index == VariableNameLen);
> + return TRUE;
> }
>
> /**
>
I have some superficial comments:
- I think the subject should say
MdeModulePkg/Bds: Check variable name even *if* OptionNumber is NULL
- I'm not a huge fan of using enum types for loop counters; however, in
this case, I verified that there is LoadOptionTypeMax, and it equals
ARRAY_SIZE (mBmLoadOptionName). So it should be safe. If we want to be
more explicit about this, we could replace
CHAR16 *mBmLoadOptionName[] = {
with
CHAR16 *mBmLoadOptionName[LoadOptionTypeMax] = {
Anyway,
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Ard, can you test this patch in your original environment?
Thanks!
Laszlo
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] MdeModulePkg/Bds: Check variable name even OptionNumber is NULL
2017-10-10 16:59 ` Laszlo Ersek
@ 2017-10-11 16:10 ` Ard Biesheuvel
0 siblings, 0 replies; 3+ messages in thread
From: Ard Biesheuvel @ 2017-10-11 16:10 UTC (permalink / raw)
To: Laszlo Ersek; +Cc: Ruiyu Ni, edk2-devel@lists.01.org
On 10 October 2017 at 17:59, Laszlo Ersek <lersek@redhat.com> wrote:
> On 10/10/17 10:58, Ruiyu Ni wrote:
>> Current implementation skips to check whether the last four
>> characters are digits when the OptionNumber is NULL.
>> Even worse, it may incorrectly return FALSE when OptionNumber is
>> NULL.
>>
>> The patch fixes it to always check the variable name even
>> OptionNumber is NULL.
>>
>> Contributed-under: TianoCore Contribution Agreement 1.1
>> Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
>> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
>> Cc: Laszlo Ersek <lersek@redhat.com>
>> ---
>> .../Library/UefiBootManagerLib/BmLoadOption.c | 45 ++++++++++++++--------
>> 1 file changed, 30 insertions(+), 15 deletions(-)
>>
>> diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
>> index b0a35058d0..32918caf32 100644
>> --- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
>> +++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
>> @@ -785,6 +785,8 @@ EfiBootManagerIsValidLoadOptionVariableName (
>> UINTN VariableNameLen;
>> UINTN Index;
>> UINTN Uint;
>> + EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LocalOptionType;
>> + UINT16 LocalOptionNumber;
>>
>> if (VariableName == NULL) {
>> return FALSE;
>> @@ -792,39 +794,52 @@ EfiBootManagerIsValidLoadOptionVariableName (
>>
>> VariableNameLen = StrLen (VariableName);
>>
>> + //
>> + // Return FALSE when the variable name length is too small.
>> + //
>> if (VariableNameLen <= 4) {
>> return FALSE;
>> }
>>
>> - for (Index = 0; Index < ARRAY_SIZE (mBmLoadOptionName); Index++) {
>> - if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[Index])) &&
>> - (StrnCmp (VariableName, mBmLoadOptionName[Index], VariableNameLen - 4) == 0)
>> + //
>> + // Return FALSE when the variable name doesn't start with Driver/SysPrep/Boot/PlatformRecovery.
>> + //
>> + for (LocalOptionType = 0; LocalOptionType < ARRAY_SIZE (mBmLoadOptionName); LocalOptionType++) {
>> + if ((VariableNameLen - 4 == StrLen (mBmLoadOptionName[LocalOptionType])) &&
>> + (StrnCmp (VariableName, mBmLoadOptionName[LocalOptionType], VariableNameLen - 4) == 0)
>> ) {
>> break;
>> }
>> }
>> + if (LocalOptionType == ARRAY_SIZE (mBmLoadOptionName)) {
>> + return FALSE;
>> + }
>>
>> - if (Index == ARRAY_SIZE (mBmLoadOptionName)) {
>> + //
>> + // Return FALSE when the last four characters are not hex digits.
>> + //
>> + LocalOptionNumber = 0;
>> + for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
>> + Uint = BmCharToUint (VariableName[Index]);
>> + if (Uint == -1) {
>> + break;
>> + } else {
>> + LocalOptionNumber = (UINT16) Uint + LocalOptionNumber * 0x10;
>> + }
>> + }
>> + if (Index != VariableNameLen) {
>> return FALSE;
>> }
>>
>> if (OptionType != NULL) {
>> - *OptionType = (EFI_BOOT_MANAGER_LOAD_OPTION_TYPE) Index;
>> + *OptionType = LocalOptionType;
>> }
>>
>> if (OptionNumber != NULL) {
>> - *OptionNumber = 0;
>> - for (Index = VariableNameLen - 4; Index < VariableNameLen; Index++) {
>> - Uint = BmCharToUint (VariableName[Index]);
>> - if (Uint == -1) {
>> - break;
>> - } else {
>> - *OptionNumber = (UINT16) Uint + *OptionNumber * 0x10;
>> - }
>> - }
>> + *OptionNumber = LocalOptionNumber;
>> }
>>
>> - return (BOOLEAN) (Index == VariableNameLen);
>> + return TRUE;
>> }
>>
>> /**
>>
>
> I have some superficial comments:
>
> - I think the subject should say
>
> MdeModulePkg/Bds: Check variable name even *if* OptionNumber is NULL
>
> - I'm not a huge fan of using enum types for loop counters; however, in
> this case, I verified that there is LoadOptionTypeMax, and it equals
> ARRAY_SIZE (mBmLoadOptionName). So it should be safe. If we want to be
> more explicit about this, we could replace
>
> CHAR16 *mBmLoadOptionName[] = {
>
> with
>
> CHAR16 *mBmLoadOptionName[LoadOptionTypeMax] = {
>
> Anyway,
>
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
>
> Ard, can you test this patch in your original environment?
>
I will try this as soon as I get a chance (I have to switch back to an
older branch of the platform I am currently developing for)
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2017-10-11 16:06 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-10-10 8:58 [PATCH] MdeModulePkg/Bds: Check variable name even OptionNumber is NULL Ruiyu Ni
2017-10-10 16:59 ` Laszlo Ersek
2017-10-11 16:10 ` Ard Biesheuvel
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox