SecurityPkg: Add YAML files for CI builds

https://bugzilla.tianocore.org/show_bug.cgi?id=2315

Add YAML file to the package directory with the
configuration of the checks to perform during a
CI build.

Use BaseCryptLibNull for package CI builds to reduce package
build times.  Enabled with CONTINUOUS_INTEGRATION in YAML
files.  By default CONTINUOUS_INTEGRATION is not defined,
and the original lib mappings are preserved.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Chao Zhang <chao.b.zhang@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>

2 files changed, 110 insertions, 2 deletions

diff --git a/SecurityPkg/SecurityPkg.ci.yaml b/SecurityPkg/SecurityPkg.ci.yaml
new file mode 100644
index 0000000000..9532190533
--- /dev/null
+++ b/SecurityPkg/SecurityPkg.ci.yaml
@@ -0,0 +1,80 @@
+## @file

+# CI configuration for SecurityPkg

+#

+# Copyright (c) Microsoft Corporation

+# SPDX-License-Identifier: BSD-2-Clause-Patent

+##

+{

+    "CompilerPlugin": {

+        "DscPath": "SecurityPkg.dsc"

+    },

+    "CharEncodingCheck": {

+        "IgnoreFiles": []

+    },

+    "DependencyCheck": {

+        "AcceptableDependencies": [

+            "MdePkg/MdePkg.dec",

+            "MdeModulePkg/MdeModulePkg.dec",

+            "SecurityPkg/SecurityPkg.dec",

+            "CryptoPkg/CryptoPkg.dec"

+        ],

+        # For host based unit tests

+        "AcceptableDependencies-HOST_APPLICATION":[],

+        # For UEFI shell based apps

+        "AcceptableDependencies-UEFI_APPLICATION":[],

+        "IgnoreInf": []

+    },

+    "DscCompleteCheck": {

+        "DscPath": "SecurityPkg.dsc",

+        "IgnoreInf": []

+    },

+    "GuidCheck": {

+        "IgnoreGuidName": [],

+        "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],

+        "IgnoreFoldersAndFiles": [],

+        "IgnoreDuplicates": [

+            "Tpm2InstanceLibDTpm=gEfiTpmDeviceInstanceTpm20DtpmGuid", #  by design

+        ]

+    },

+    "LibraryClassCheck": {

+        "IgnoreHeaderFile": []

+    },

+

+    ## options defined ci/Plugin/SpellCheck

+    "SpellCheck": {

+        "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log

+        "ExtendWords": [             # words to extend to the dictionary for this package

+            "shortformed", # tpm acpi

+            "autodetect",

+            "blocksid",

+            "comid",

+            "cpinsidpin", #OpalSScV2

+            "ecdsa", # TPM

+            "ecschnorr", # TPM

+            "eisaid", # ACPI

+            "harddisk",

+            "hashall",

+            "hashto",

+            "kek's",

+            "lfanew", # PE/COFF

+            "pcrindex",

+            "pkglength",

+            "ppuser",

+            "preos",

+            "stclear",

+            "toctou",

+            "tpm's",

+            "tpmcmdbuflength",

+            "tpmcommlib",

+            "tpmnvvaluelength",

+            "wrlocked",

+            "xored"

+        ],

+        "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore

+        "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)

+    },

+

+    "Defines": {

+        "BLD_*_CONTINUOUS_INTEGRATION": "TRUE",

+    }

+}

diff --git a/SecurityPkg/SecurityPkg.dsc b/SecurityPkg/SecurityPkg.dsc
index 9a254087a3..a2eeadda7a 100644
--- a/SecurityPkg/SecurityPkg.dsc
+++ b/SecurityPkg/SecurityPkg.dsc
@@ -44,8 +44,6 @@
   HiiLib|MdeModulePkg/Library/UefiHiiLib/UefiHiiLib.inf

   UefiHiiServicesLib|MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLib.inf

   PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf

-  IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf

-  OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf

   IoLib|MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf

   TpmCommLib|SecurityPkg/Library/TpmCommLib/TpmCommLib.inf

   PlatformSecureLib|SecurityPkg/Library/PlatformSecureLibNull/PlatformSecureLibNull.inf

@@ -84,7 +82,13 @@
   PeiServicesTablePointerLib|MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointerLib.inf

   HobLib|MdePkg/Library/PeiHobLib/PeiHobLib.inf

   MemoryAllocationLib|MdePkg/Library/PeiMemoryAllocationLib/PeiMemoryAllocationLib.inf

+!ifdef CONTINUOUS_INTEGRATION

+  BaseCryptLib|CryptoPkg/Library/BaseCryptLibNull/BaseCryptLibNull.inf

+!else

+  IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf

+  OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf

   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/PeiCryptLib.inf

+!endif

   HashLib|SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterPei.inf

   ReportStatusCodeLib|MdeModulePkg/Library/PeiReportStatusCodeLib/PeiReportStatusCodeLib.inf

   Tpm12DeviceLib|SecurityPkg/Library/Tpm12DeviceLibDTpm/Tpm12DeviceLibDTpm.inf

@@ -95,7 +99,13 @@
 [LibraryClasses.common.DXE_DRIVER]

   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

   ReportStatusCodeLib|MdeModulePkg/Library/DxeReportStatusCodeLib/DxeReportStatusCodeLib.inf

+!ifdef CONTINUOUS_INTEGRATION

+  BaseCryptLib|CryptoPkg/Library/BaseCryptLibNull/BaseCryptLibNull.inf

+!else

+  IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf

+  OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf

   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/BaseCryptLib.inf

+!endif

   HashLib|SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.inf

   Tpm12DeviceLib|SecurityPkg/Library/Tpm12DeviceLibTcg/Tpm12DeviceLibTcg.inf

   Tpm2DeviceLib|SecurityPkg/Library/Tpm2DeviceLibTcg2/Tpm2DeviceLibTcg2.inf

@@ -110,13 +120,25 @@
 

 [LibraryClasses.common.DXE_RUNTIME_DRIVER]

   ReportStatusCodeLib|MdeModulePkg/Library/RuntimeDxeReportStatusCodeLib/RuntimeDxeReportStatusCodeLib.inf

+!ifdef CONTINUOUS_INTEGRATION

+  BaseCryptLib|CryptoPkg/Library/BaseCryptLibNull/BaseCryptLibNull.inf

+!else

+  IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf

+  OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf

   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/RuntimeCryptLib.inf

+!endif

   HashLib|SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.inf

   Tpm12DeviceLib|SecurityPkg/Library/Tpm12DeviceLibTcg/Tpm12DeviceLibTcg.inf

   Tpm2DeviceLib|SecurityPkg/Library/Tpm2DeviceLibTcg2/Tpm2DeviceLibTcg2.inf

 

 [LibraryClasses.common.UEFI_DRIVER, LibraryClasses.common.UEFI_APPLICATION]

+!ifdef CONTINUOUS_INTEGRATION

+  BaseCryptLib|CryptoPkg/Library/BaseCryptLibNull/BaseCryptLibNull.inf

+!else

+  IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf

+  OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf

   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/BaseCryptLib.inf

+!endif

   HashLib|SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.inf

   Tpm12DeviceLib|SecurityPkg/Library/Tpm12DeviceLibTcg/Tpm12DeviceLibTcg.inf

   Tpm2DeviceLib|SecurityPkg/Library/Tpm2DeviceLibTcg2/Tpm2DeviceLibTcg2.inf

@@ -127,7 +149,13 @@
   MemoryAllocationLib|MdePkg/Library/SmmMemoryAllocationLib/SmmMemoryAllocationLib.inf

   ReportStatusCodeLib|MdeModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCodeLib.inf

   SmmMemLib|MdePkg/Library/SmmMemLib/SmmMemLib.inf

+!ifdef CONTINUOUS_INTEGRATION

+  BaseCryptLib|CryptoPkg/Library/BaseCryptLibNull/BaseCryptLibNull.inf

+!else

+  IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf

+  OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf

   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/SmmCryptLib.inf

+!endif

   Tpm12DeviceLib|SecurityPkg/Library/Tpm12DeviceLibTcg/Tpm12DeviceLibTcg.inf

   Tpm2DeviceLib|SecurityPkg/Library/Tpm2DeviceLibTcg2/Tpm2DeviceLibTcg2.inf

   Tcg2PhysicalPresenceLib|SecurityPkg/Library/SmmTcg2PhysicalPresenceLib/SmmTcg2PhysicalPresenceLib.inf