SecurityPkg/Pkcs7Verify: Add the comments to address security problem

[mirror_edk2.git] / MdePkg / Include / Base.h

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index e03fa823928492115854d12b85cf116dba38ccfc..02140a5ac2eea335d6aa330d0e4c4b113424c229 100644 (file)
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -6,7 +6,7 @@
   environment. There are a set of base libraries in the Mde Package that can\r
   be used to implement base modules.\r
 \r
-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
@@ -63,12 +63,35 @@ VERIFY_SIZE_OF (UINT64, 8);
 VERIFY_SIZE_OF (CHAR8, 1);\r
 VERIFY_SIZE_OF (CHAR16, 2);\r
 \r
+//\r
+// The following three enum types are used to verify that the compiler\r
+// configuration for enum types is compliant with Section 2.3.1 of the \r
+// UEFI 2.3 Specification. These enum types and enum values are not \r
+// intended to be used. A prefix of '__' is used avoid conflicts with\r
+// other types.\r
+//\r
+typedef enum {\r
+  __VerifyUint8EnumValue = 0xff\r
+} __VERIFY_UINT8_ENUM_SIZE;\r
+\r
+typedef enum {\r
+  __VerifyUint16EnumValue = 0xffff\r
+} __VERIFY_UINT16_ENUM_SIZE;\r
+\r
+typedef enum {\r
+  __VerifyUint32EnumValue = 0xffffffff\r
+} __VERIFY_UINT32_ENUM_SIZE;\r
+\r
+VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);\r
+VERIFY_SIZE_OF (__VERIFY_UINT16_ENUM_SIZE, 4);\r
+VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);\r
+\r
 //\r
 // The Microsoft* C compiler can removed references to unreferenced data items\r
 //  if the /OPT:REF linker option is used. We defined a macro as this is a\r
 //  a non standard extension\r
 //\r
-#if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)\r
+#if defined(_MSC_EXTENSIONS) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)\r
   ///\r
   /// Remove global variable from the linked image if there are no references to\r
   /// it after all compiler and linker optimizations have been performed.\r
@@ -242,6 +265,20 @@ typedef struct {
   UINT8   Data4[8];\r
 } GUID;\r
 \r
+///\r
+/// 4-byte buffer. An IPv4 internet protocol address.\r
+///\r
+typedef struct {\r
+  UINT8 Addr[4];\r
+} IPv4_ADDRESS;\r
+\r
+///\r
+/// 16-byte buffer. An IPv6 internet protocol address.\r
+///\r
+typedef struct {\r
+  UINT8 Addr[16];\r
+} IPv6_ADDRESS;\r
+\r
 //\r
 // 8-bytes unsigned value that represents a physical system address.\r
 //\r
@@ -302,7 +339,7 @@ struct _LIST_ENTRY {
 \r
 //\r
 //  UEFI specification claims 1 and 0. We are concerned about the\r
-//  complier portability so we did it this way.\r
+//  compiler portability so we did it this way.\r
 //\r
 \r
 ///\r
@@ -322,6 +359,11 @@ struct _LIST_ENTRY {
 ///\r
 #define NULL  ((VOID *) 0)\r
 \r
+//\r
+// Null character\r
+//\r
+#define CHAR_NULL             0x0000\r
+\r
 ///\r
 /// Maximum values for common UEFI Data Types\r
 ///\r
@@ -589,7 +631,7 @@ struct _LIST_ENTRY {
 \r
 #define VA_COPY(Dest, Start)          __va_copy (Dest, Start)\r
 \r
-#elif defined(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS)\r
+#elif defined(__GNUC__)\r
 \r
 #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)\r
 //\r
@@ -1171,6 +1213,7 @@ typedef UINTN RETURN_STATUS;
     (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r
 \r
 #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)\r
+  void * _ReturnAddress(void);\r
   #pragma intrinsic(_ReturnAddress)\r
   /**\r
     Get the return address of the calling function.\r
@@ -1211,5 +1254,18 @@ typedef UINTN RETURN_STATUS;
   #define RETURN_ADDRESS(L)     ((VOID *) 0)\r
 #endif\r
 \r
+/**\r
+  Return the number of elements in an array.\r
+\r
+  @param  Array  An object of array type. Array is only used as an argument to\r
+                 the sizeof operator, therefore Array is never evaluated. The\r
+                 caller is responsible for ensuring that Array's type is not\r
+                 incomplete; that is, Array must have known constant size.\r
+\r
+  @return The number of elements in Array. The result has type UINTN.\r
+\r
+**/\r
+#define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))\r
+\r
 #endif\r
 \r