CryptoPkg: BaseCryptLib: Add unit tests (Host and Shell based)

[mirror_edk2.git] / CryptoPkg / Test / UnitTest / Library / BaseCryptLib / TestBaseCryptLib.h

/** @file\r
  Application for Cryptographic Primitives Validation.\r
\r
Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __CRYPTEST_H__\r
#define __CRYPTEST_H__\r
\r
#include <PiPei.h>\r
#include <Uefi.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UnitTestLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/BaseCryptLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
//#include <UnitTestTypes.h>\r
#include <Library/UnitTestLib.h>\r
//#include <Library/UnitTestAssertLib.h>\r
\r
#define UNIT_TEST_NAME        "BaseCryptLib Unit Test"\r
#define UNIT_TEST_VERSION     "1.0"\r
\r
typedef struct {\r
  CHAR8                *Description;\r
  CHAR8                *ClassName;\r
  UNIT_TEST_FUNCTION     Func;\r
  UNIT_TEST_PREREQUISITE PreReq;\r
  UNIT_TEST_CLEANUP      CleanUp;\r
  UNIT_TEST_CONTEXT      Context;\r
} TEST_DESC;\r
\r
typedef struct {\r
  CHAR8                     *Title;\r
  CHAR8                     *Package;\r
  UNIT_TEST_SUITE_SETUP      Sup;\r
  UNIT_TEST_SUITE_TEARDOWN   Tdn;\r
  UINTN                      *TestNum;\r
  TEST_DESC                  *TestDesc;\r
} SUITE_DESC;\r
\r
extern UINTN mPkcs7EkuTestNum;\r
extern TEST_DESC mPkcs7EkuTest[];\r
\r
extern UINTN mHashTestNum;\r
extern TEST_DESC mHashTest[];\r
\r
extern UINTN mHmacTestNum;\r
extern TEST_DESC mHmacTest[];\r
\r
extern UINTN mBlockCipherTestNum;\r
extern TEST_DESC mBlockCipherTest[];\r
\r
extern UINTN mRsaTestNum;\r
extern TEST_DESC mRsaTest[];\r
\r
extern UINTN mRsaCertTestNum;\r
extern TEST_DESC mRsaCertTest[];\r
\r
extern UINTN mPkcs7TestNum;\r
extern TEST_DESC mPkcs7Test[];\r
\r
extern UINTN mPkcs5TestNum;\r
extern TEST_DESC mPkcs5Test[];\r
\r
extern UINTN mAuthenticodeTestNum;\r
extern TEST_DESC mAuthenticodeTest[];\r
\r
extern UINTN mImageTimestampTestNum;\r
extern TEST_DESC mImageTimestampTest[];\r
\r
extern UINTN mDhTestNum;\r
extern TEST_DESC mDhTest[];\r
\r
extern UINTN mPrngTestNum;\r
extern TEST_DESC mPrngTest[];\r
\r
extern UINTN mOaepTestNum;\r
extern TEST_DESC mOaepTest[];\r
\r
/** Creates a framework you can use */\r
EFI_STATUS\r
EFIAPI\r
CreateUnitTest (\r
    IN     CHAR8*                     UnitTestName,\r
    IN     CHAR8*                     UnitTestVersion,\r
    IN OUT UNIT_TEST_FRAMEWORK_HANDLE* Framework\r
);\r
\r
/**\r
  Validate UEFI-OpenSSL DH Interfaces.\r
\r
  @retval  EFI_SUCCESS  Validation succeeded.\r
  @retval  EFI_ABORTED  Validation failed.\r
\r
**/\r
EFI_STATUS\r
ValidateCryptDh (\r
  VOID\r
  );\r
\r
/**\r
  Validate UEFI-OpenSSL pseudorandom number generator interfaces.\r
\r
  @retval  EFI_SUCCESS  Validation succeeded.\r
  @retval  EFI_ABORTED  Validation failed.\r
\r
**/\r
EFI_STATUS\r
ValidateCryptPrng (\r
  VOID\r
  );\r
\r
\r
\r
#endif\r