[edk2-wiki][PATCH] Update the Boot Guard TOCTOU wiki page.

[edk2-wiki][PATCH] Update the Boot Guard TOCTOU wiki page.

[Guomin Jiang]

The Boot Guard TOCTOU have been migrated into edk2/master.
Update the document to meet the change.

Signed-off-by: Guomin Jiang <guomin.jiang@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
---
 Boot-Guard-TOCTOU-Vulnerability-Mitigation.md | 28 ++++++-------------
 1 file changed, 8 insertions(+), 20 deletions(-)

diff --git a/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md b/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md
index e59c7b1..5e0c856 100644
--- a/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md
+++ b/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md
@@ -45,32 +45,20 @@ references must be updated. In this mitigation, the process of performing these
 The changes described in this mitigation are intended to simply integrate into firmware solutions. For the changes to
 function as intended, the platform firmware implementation should follow these guidelines.
 
-The changes are currently being staged in the following EDK II fork for additional validation before being
-sent to the EDK II mailing list: https://github.com/makubacki/edk2/tree/btg_toctou_mitigation_staging
-
-The changes should not be considered final or production ready until they are reviewed and pushed onto edk2/master.
-
-1. Always ensure PcdShadowPeimOnBoot and PcdShadowPeimOnS3Boot
-   (if platform supports S3) are set to TRUE if Boot Guard is
-   enabled and V=1 or M=1.
-2. Always ensure PcdMigrateTemporaryRamFirmwareVolumes is set to TRUE.
-3. Ensure that all PEIMs are relocatable. Relocation tables should
+1. Always ensure PcdMigrateTemporaryRamFirmwareVolumes are set to TRUE
+   if Boot Guard is enabled and V=1 or M=1.
+2. Ensure that all PEIMs are relocatable. Relocation tables should
    not be stripped.
-4. If an Intel&reg; Firmware Support Package (FSP) binary solution is
+3. If an Intel&reg; Firmware Support Package (FSP) binary solution is
    used, the binary must have these mitigation changes integrated.
-5. Avoid maintaining pointers to pre-memory addresses inside embedded
+4. Avoid maintaining pointers to pre-memory addresses inside embedded
    structures or other non-standard structures that the automatic
    migration code introduced in this change cannot identify.
-6. Migrate the FIT table based on platform requirements for FIT
+5. Migrate the FIT table based on platform requirements for FIT
    access in post-memory.
 
-**Very Important**
-
-7. Enable paging after memory initialization and mark the IBB range
-   as Not Present (NP).
-
-   This will cause a page fault on access to the IBB region. This CR2 register can be used to identify the address
-   accessed and the IP.
+Notes: IBB will be set Not Present, you will see a page fault if any code access to the IBB region after migration.
+       the address where the code access can be identified in the CR2 register.
 
 # High-Level Migration Required
 Resources that must be migrated can be categorized as code or data.
-- 
2.25.1.windows.1

Re: [edk2-wiki][PATCH] Update the Boot Guard TOCTOU wiki page.

[Wang, Jian J]

Hi Guomin,

Thanks for updating the page. Just one minor comment below. With it addressed,

Reviewed-by: Jian J Wang <jian.j.wang@intel.com>

Regards,
Jian

> -----Original Message-----
> From: Jiang, Guomin <guomin.jiang@intel.com>
> Sent: Tuesday, August 04, 2020 9:44 AM
> To: devel@edk2.groups.io
> Cc: Wang, Jian J <jian.j.wang@intel.com>; Gao, Liming <liming.gao@intel.com>
> Subject: [edk2-wiki][PATCH] Update the Boot Guard TOCTOU wiki page.
> 
> The Boot Guard TOCTOU have been migrated into edk2/master.
> Update the document to meet the change.
> 
> Signed-off-by: Guomin Jiang <guomin.jiang@intel.com>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> ---
>  Boot-Guard-TOCTOU-Vulnerability-Mitigation.md | 28 ++++++-------------
>  1 file changed, 8 insertions(+), 20 deletions(-)
> 
> diff --git a/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md b/Boot-Guard-
> TOCTOU-Vulnerability-Mitigation.md
> index e59c7b1..5e0c856 100644
> --- a/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md
> +++ b/Boot-Guard-TOCTOU-Vulnerability-Mitigation.md
> @@ -45,32 +45,20 @@ references must be updated. In this mitigation, the
> process of performing these
>  The changes described in this mitigation are intended to simply integrate into
> firmware solutions. For the changes to
>  function as intended, the platform firmware implementation should follow
> these guidelines.
> 
> -The changes are currently being staged in the following EDK II fork for
> additional validation before being
> -sent to the EDK II mailing list:
> https://github.com/makubacki/edk2/tree/btg_toctou_mitigation_staging
> -
> -The changes should not be considered final or production ready until they are
> reviewed and pushed onto edk2/master.
> -
> -1. Always ensure PcdShadowPeimOnBoot and PcdShadowPeimOnS3Boot
> -   (if platform supports S3) are set to TRUE if Boot Guard is
> -   enabled and V=1 or M=1.
> -2. Always ensure PcdMigrateTemporaryRamFirmwareVolumes is set to TRUE.
> -3. Ensure that all PEIMs are relocatable. Relocation tables should
> +1. Always ensure PcdMigrateTemporaryRamFirmwareVolumes are set to TRUE

'are' -> 'is' (it's just one PCD)

> +   if Boot Guard is enabled and V=1 or M=1.
> +2. Ensure that all PEIMs are relocatable. Relocation tables should
>     not be stripped.
> -4. If an Intel&reg; Firmware Support Package (FSP) binary solution is
> +3. If an Intel&reg; Firmware Support Package (FSP) binary solution is
>     used, the binary must have these mitigation changes integrated.
> -5. Avoid maintaining pointers to pre-memory addresses inside embedded
> +4. Avoid maintaining pointers to pre-memory addresses inside embedded
>     structures or other non-standard structures that the automatic
>     migration code introduced in this change cannot identify.
> -6. Migrate the FIT table based on platform requirements for FIT
> +5. Migrate the FIT table based on platform requirements for FIT
>     access in post-memory.
> 
> -**Very Important**
> -
> -7. Enable paging after memory initialization and mark the IBB range
> -   as Not Present (NP).
> -
> -   This will cause a page fault on access to the IBB region. This CR2 register can
> be used to identify the address
> -   accessed and the IP.
> +Notes: IBB will be set Not Present, you will see a page fault if any code access
> to the IBB region after migration.
> +       the address where the code access can be identified in the CR2 register.
> 
>  # High-Level Migration Required
>  Resources that must be migrated can be categorized as code or data.
> --
> 2.25.1.windows.1