CryptoPkg/Library: Add BaseCryptLibOnProtocolPpi instances

https://bugzilla.tianocore.org/show_bug.cgi?id=2420 Based on the following package with changes to merge into CryptoPkg. https://github.com/microsoft/mu_plus/tree/dev/201908/SharedCryptoPkg Add the PeiCryptLib, DxeCryptLib, and SmmCryptLib instances of the BaseCryptLib library classes that are implemented using the services of EDK II Crypto Protocols/PPIs. These library instances all set a dependency expression on the EDK II Crypto Protocols/PPIs, so any modules that use these library instances are not dispatched until the modules that produce the EDK II Crypto Protocols/PPIs are dispatched. Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Xiaoyu Lu <xiaoyux.lu@intel.com> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
2019-11-21 09:24:53 -08:00
parent cc1d13c922
commit cd70de1cc0
8 changed files with 4741 additions and 0 deletions
--- a/CryptoPkg/Library/BaseCryptLibOnProtocolPpi/SmmCryptLib.c
+++ b/CryptoPkg/Library/BaseCryptLibOnProtocolPpi/SmmCryptLib.c
@@ -0,0 +1,79 @@
+/** @file
+  Implements the GetCryptoServices() API that retuns a pointer to the EDK II
+  SMM Crypto Protocol.
+
+  Copyright (C) Microsoft Corporation. All rights reserved.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <PiSmm.h>
+#include <Library/BaseLib.h>
+#include <Library/DebugLib.h>
+#include <Library/SmmServicesTableLib.h>
+#include <Protocol/SmmCrypto.h>
+
+EDKII_SMM_CRYPTO_PROTOCOL  *mSmmCryptoProtocol = NULL;
+
+/**
+  Internal worker function that returns the pointer to an EDK II Crypto
+  Protocol/PPI.  The layout of the PPI, DXE Protocol, and SMM Protocol are
+  identical which allows the implementation of the BaseCryptLib functions that
+  call through a Protocol/PPI to be shared for the PEI, DXE, and SMM
+  implementations.
+
+  This SMM implementation returns the pointer to the EDK II SMM Crypto Protocol
+  that was found in the library constructor SmmCryptLibConstructor().
+**/
+VOID *
+GetCryptoServices (
+  VOID
+  )
+{
+  return (VOID *)mSmmCryptoProtocol;
+}
+
+/**
+  Constructor looks up the EDK II SMM Crypto Protocol and verifies that it is
+  not NULL and has a high enough version value to support all the BaseCryptLib
+  functions.
+
+  @param  ImageHandle   The firmware allocated handle for the EFI image.
+  @param  SystemTable   A pointer to the EFI System Table.
+
+  @retval  EFI_SUCCESS    The EDK II SMM Crypto Protocol was found.
+  @retval  EFI_NOT_FOUND  The EDK II SMM Crypto Protocol was not found.
+**/
+EFI_STATUS
+EFIAPI
+SmmCryptLibConstructor (
+  IN EFI_HANDLE        ImageHandle,
+  IN EFI_SYSTEM_TABLE  *SystemTable
+  )
+{
+  EFI_STATUS  Status;
+  UINTN       Version;
+
+  Status = gSmst->SmmLocateProtocol (
+                    &gEdkiiSmmCryptoProtocolGuid,
+                    NULL,
+                    (VOID **)&mSmmCryptoProtocol
+                    );
+  if (EFI_ERROR (Status) || mSmmCryptoProtocol == NULL) {
+    DEBUG((DEBUG_ERROR, "[SmmCryptLib] Failed to locate Crypto SMM Protocol. Status = %r\n", Status));
+    ASSERT_EFI_ERROR (Status);
+    ASSERT (mSmmCryptoProtocol != NULL);
+    mSmmCryptoProtocol = NULL;
+    return EFI_NOT_FOUND;
+  }
+
+  Version = mSmmCryptoProtocol->GetVersion ();
+  if (Version < EDKII_CRYPTO_VERSION) {
+    DEBUG((DEBUG_ERROR, "[SmmCryptLib] Crypto SMM Protocol unsupported version %d\n", Version));
+    ASSERT (Version >= EDKII_CRYPTO_VERSION);
+    mSmmCryptoProtocol = NULL;
+    return EFI_NOT_FOUND;
+  }
+
+  return EFI_SUCCESS;
+}