This is series 1 of the whole capsule solution. Version 4.
According to feedback, we split the big patch series to smaller one.

Series 1: Generic Update (MdeModulePkg/SecurityPkg)
        DxeCapsuleLib
        FmAuthenticationLib (*)
        CapsuleApp (*)

The code is also in https://github.com/jyao1/edk2
V4 is at Capsule_V4 branch.
V3, V2, V1 are also pushed to coresponding branch.

Below is detail description for each version.

==Below is V4 description==
1) SecurityPkg - Refine AuthenticateFmpImage() API to let caller
input PublicKeyData and PublicKeyDataLength, instead of PCD.
The benefit is that then this API can be used for a platform
which stores PublicKeyData in anywhere other than PCD.
2) SecurityPkg - Use OFFSET_OF(WIN_CERTIFICATE_UEFI_GUID, CertData)
for better understanding the code.
3) MdeModulePkg - Update CapsuleApp to let it consume
ShellParameters protocol to get Argc and Argv.
4) UefiCpuPkg - Update MicrocodeCapsuleApp to let it consume
ShellParameters protocol to get Argc and Argv.
5) QuarkPlatformPkg - Merge QuarkCapsule.fdf to Quark.fdf.

==Below is V3 description==
1) We move all EDKII related capsule definition to SignedCapsulePkg.
MdeModulePkg only contains FmAuthenticationLib and CapsuleApp,
because they are generic and follow UEFI specification on FMP/ESRT
and Microsoft platform firmware update document.
Any capsule implementation can use them.

Here is full library classes:
MdeModulePkg:
        FmpAuthenticationLib.h: new lib - follow UEFI spec. (*)
                Verify FMP signature of FMP Capsule
        CapsuleLib.h: new API ¨C ProcessCapsules()
                It processes all the capsules. Remove duplicated code in 
platform BDS.
UefiCpuPkg:
        MicrocodeFlashAccessLib.h: Update Microcode region.
SignedCapsulePkg:
        EdkiiSystemCapsuleLib.h ¨C Library for EDKII system FMP.
        IniParsingLib.h ¨C Library for INI file parsing.
        PlatformFlashAccessLib.h ¨C Library for write flash.

2) We will submit 5 series.
Series 1: Generic Update (MdeModulePkg/SecurityPkg)
        DxeCapsuleLib
        FmAuthenticationLib (*)
        CapsuleApp (*)
Series 2: EDKII Capsule (SignedCapsulePkg)
        IniParsingLib
        EdkiiSystemCapsuleLib
        PlatformFlashAccessLib
        SystemFirmwareUpdate driver
        RecoveryModuleLoadPei driver
Series 3: Microcode Update (UefiCpuPkg)
        MicrocodeFlashAccessLib
        MicrocodeUpdate driver.
Series 4: Quark update
Series 5: Vlv2 update

3) DxeCapsuleLib: Move code that performs authentication and parsing of
the capsule format into the implementation of the FMP Protocol.
We move the dispatch FV code from CapsuleLib to SystemFirmwareReport.efi.
SystemFirmwareReport.efi supports SetImage() to verify and dispatch the
SystemFirmwareUpdate.efi, then pass thru SetImage() request to
SystemFirmwareUpdate.efi.

Now the DxeCapsuleLib is very clean and it does not have any EDKII
capsule format knowledge.

4) DxeCapsuleLib: Fix issue where a reset may be too soon.
Defer reset to 2nd pass.

5) DxeCapsuleLib: Boot mode check is removed. 
Capsule should be populated to system table even boot mode is not BIOS_UPDATE.

5) FmAuthenticationLib: Add zero ImageSize check.

6) FmAuthenticationLib: Remove Authentication Library Registration.
Each FMP Producer needs to carry its own auth algoritms(s).
Now we have FmpAuthenticationLibPkcs7 and FmpAuthenticationLibRsa2048Sha256.
No registration is needed.

7) FmAuthenticationLib: Move MonotonicCount handling after Payload
We confirmed with USWG to process MonotonicCount after PayLoad.

==Below is V2 description==
The V2 series patch incorporated the feedback for V1.

There are 3 major updates.
1) BDS is update to display a warning message if TEST key
is used to sign recovery image or capsule image.
So a production BIOS should always use its own production singing
key for the capsule image generation. A production BIOS should
never use test key.
2) IniParsingLib is enhanced to do more sanity check for invalid
input. The detail data format is added in IniParsingLib.h header
file. If there is any vialation, the OpenInitFile() API will
return failure.
3) The *Bios* keyword is renamed to *SystemFirmware* in any
header file or c file data structure definition.

The rest is minor update, such as add help info, clean
up debug message, coding style.

==Below is V1 description==
This series patch provides sample on how to do signed capsule update
and recovery in EDKII.

This series patch is also checked into [email protected]:jyao1/edk2.git.

The feature includes:
1) Define EDKII signed system BIOS capsule format.
2) Provide EDKII signed system BIOS update sample.
3) Provide EDKII signed recovery sample.
4) Provide Microcode update sample for X86 system.
5) Update Quark to use new capsule/recovery solution.
6) Update Vlv2(MinnowMax) to use new capsule/recovery solution.

The signed capsule/recovery solution is in MdeModulePkg.
The capsule in IntelFrameworkModulePkg is deprecated.
The Microcode update solution is in UefiCpuPkg.

Cc: Feng Tian <[email protected]>
Cc: Star Zeng <[email protected]>
Cc: Michael D Kinney <[email protected]>
Cc: Liming Gao <[email protected]>
Cc: Chao Zhang <[email protected]>
Cc: Jeff Fan <[email protected]>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <[email protected]>

Jiewen Yao (15):
  MdeModulePkg/Include: Add FmpAuthenticationLib header.
  MdeModulePkg/CapsuleLib: Add ProcessCapsules() API.
  MdeModulePkg/MdeModulePkg.dec: Add capsule related definition.
  MdeModulePkg/FmpAuthenticationLibNull: Add NULL instance FMP.
  MdeModulePkg/DxeCapsuleLibNull: Add ProcessCapsules() interface.
  MdeModulePkg/DxeCapsuleLibFmp: Add DxeCapsuleLibFmp instance.
  MdeModulePkg/Esrt: Add ESRT_FW_TYPE_SYSTEMFIRMWARE check.
  MdeModulePkg/CapsuleApp: Add CapsuleApp application.
  MdeModulePkg/UiApp: Show test key warning info in FrontPage.
  MdeModulePkg/MdeModulePkg.dsc: Add FMP related component.
  IntelFrameworkModulePkg/DxeCapsuleLib: Add ProcessCapsules()
    interface.
  SecurityPkg/SecurityPkg.dec: Add PcdPkcs7CertBuffer PCD.
  SecurityPkg/FmpAuthenticationLibPkcs7: Add PKCS7 instance for FMP.
  SecurityPkg/FmpAuthenticationLibRsa2048Sha256: Add RSA2048 instance.
  SecurityPkg/SecurityPkg.dsc: Add FmpAuthenticationLib*.

 IntelFrameworkModulePkg/Library/DxeCapsuleLib/DxeCapsuleLib.c                  
             |   40 +-
 MdeModulePkg/Application/CapsuleApp/AppSupport.c                               
             |  445 +++++++
 MdeModulePkg/Application/CapsuleApp/CapsuleApp.c                               
             |  853 ++++++++++++
 MdeModulePkg/Application/CapsuleApp/CapsuleApp.inf                             
             |   71 +
 MdeModulePkg/Application/CapsuleApp/CapsuleApp.uni                             
             |   22 +
 MdeModulePkg/Application/CapsuleApp/CapsuleAppExtra.uni                        
             |   19 +
 MdeModulePkg/Application/CapsuleApp/CapsuleDump.c                              
             |  740 +++++++++++
 MdeModulePkg/Application/UiApp/FrontPageCustomizedUi.c                         
             |   13 +
 MdeModulePkg/Application/UiApp/FrontPageStrings.uni                            
             |    4 +-
 MdeModulePkg/Application/UiApp/UiApp.inf                                       
             |    3 +-
 MdeModulePkg/Include/Library/CapsuleLib.h                                      
             |   46 +-
 MdeModulePkg/Include/Library/FmpAuthenticationLib.h                            
             |   57 +
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c                          
             | 1363 ++++++++++++++++++++
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.inf                        
             |   80 ++
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.uni                        
             |   22 +
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c                   
             |  486 +++++++
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLib.c                    
             |  489 +++++++
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleRuntime.c                      
             |  112 ++
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf                 
             |   83 ++
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.uni                 
             |   22 +
 MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c                     
             |   48 +-
 MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.c       
             |   57 +
 MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.inf     
             |   40 +
 MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.uni     
             |   22 +
 MdeModulePkg/MdeModulePkg.dec                                                  
             |   59 +
 MdeModulePkg/MdeModulePkg.dsc                                                  
             |   10 +
 MdeModulePkg/Universal/EsrtDxe/EsrtDxe.inf                                     
             |    3 +-
 MdeModulePkg/Universal/EsrtDxe/EsrtImpl.c                                      
             |   37 +-
 SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.c      
             |  213 +++
 SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.inf    
             |   49 +
 SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.uni    
             |   26 +
 
SecurityPkg/Library/FmpAuthenticationLibRsa2048Sha256/FmpAuthenticationLibRsa2048Sha256.c
   |  346 +++++
 
SecurityPkg/Library/FmpAuthenticationLibRsa2048Sha256/FmpAuthenticationLibRsa2048Sha256.inf
 |   53 +
 
SecurityPkg/Library/FmpAuthenticationLibRsa2048Sha256/FmpAuthenticationLibRsa2048Sha256.uni
 |   26 +
 SecurityPkg/SecurityPkg.dec                                                    
             |    8 +-
 SecurityPkg/SecurityPkg.dsc                                                    
             |    3 +
 36 files changed, 5957 insertions(+), 13 deletions(-)
 create mode 100644 MdeModulePkg/Application/CapsuleApp/AppSupport.c
 create mode 100644 MdeModulePkg/Application/CapsuleApp/CapsuleApp.c
 create mode 100644 MdeModulePkg/Application/CapsuleApp/CapsuleApp.inf
 create mode 100644 MdeModulePkg/Application/CapsuleApp/CapsuleApp.uni
 create mode 100644 MdeModulePkg/Application/CapsuleApp/CapsuleAppExtra.uni
 create mode 100644 MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
 create mode 100644 MdeModulePkg/Include/Library/FmpAuthenticationLib.h
 create mode 100644 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
 create mode 100644 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.inf
 create mode 100644 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.uni
 create mode 100644 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
 create mode 100644 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLib.c
 create mode 100644 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleRuntime.c
 create mode 100644 
MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
 create mode 100644 
MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.uni
 create mode 100644 
MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.c
 create mode 100644 
MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.inf
 create mode 100644 
MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.uni
 create mode 100644 
SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.c
 create mode 100644 
SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.inf
 create mode 100644 
SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.uni
 create mode 100644 
SecurityPkg/Library/FmpAuthenticationLibRsa2048Sha256/FmpAuthenticationLibRsa2048Sha256.c
 create mode 100644 
SecurityPkg/Library/FmpAuthenticationLibRsa2048Sha256/FmpAuthenticationLibRsa2048Sha256.inf
 create mode 100644 
SecurityPkg/Library/FmpAuthenticationLibRsa2048Sha256/FmpAuthenticationLibRsa2048Sha256.uni

-- 
2.7.4.windows.1

_______________________________________________
edk2-devel mailing list
[email protected]
https://lists.01.org/mailman/listinfo/edk2-devel

Reply via email to