Commit | Line | Data |
---|---|---|
0c18794e | 1 | /** @file\r |
3cd2484e | 2 | Implement image verification services for secure boot service\r |
0c18794e | 3 | \r |
dc204d5a JY |
4 | Caution: This file requires additional review when modified.\r |
5 | This library will have external input - PE/COFF image.\r | |
6 | This external input must be validated carefully to avoid security issue like\r | |
7 | buffer overflow, integer overflow.\r | |
8 | \r | |
9 | DxeImageVerificationLibImageRead() function will make sure the PE/COFF image content\r | |
10 | read is within the image buffer.\r | |
11 | \r | |
12 | DxeImageVerificationHandler(), HashPeImageByType(), HashPeImage() function will accept\r | |
13 | untrusted PE/COFF image and validate its data structure within this image buffer before use.\r | |
14 | \r | |
91422384 | 15 | Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r |
45bf2c47 | 16 | This program and the accompanying materials\r |
17 | are licensed and made available under the terms and conditions of the BSD License\r | |
18 | which accompanies this distribution. The full text of the license may be found at\r | |
0c18794e | 19 | http://opensource.org/licenses/bsd-license.php\r |
20 | \r | |
45bf2c47 | 21 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
0c18794e | 22 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
23 | \r | |
24 | **/\r | |
25 | \r | |
26 | #include "DxeImageVerificationLib.h"\r | |
27 | \r | |
dc204d5a JY |
28 | //\r |
29 | // Caution: This is used by a function which may receive untrusted input.\r | |
30 | // These global variables hold PE/COFF image data, and they should be validated before use.\r | |
31 | //\r | |
0c18794e | 32 | EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION mNtHeader;\r |
45bf2c47 | 33 | UINT32 mPeCoffHeaderOffset;\r |
0c18794e | 34 | EFI_GUID mCertType;\r |
35 | \r | |
dc204d5a JY |
36 | //\r |
37 | // Information on current PE/COFF image\r | |
38 | //\r | |
39 | UINTN mImageSize;\r | |
40 | UINT8 *mImageBase = NULL;\r | |
41 | UINT8 mImageDigest[MAX_DIGEST_SIZE];\r | |
42 | UINTN mImageDigestSize;\r | |
43 | \r | |
0c18794e | 44 | //\r |
45 | // Notify string for authorization UI.\r | |
46 | //\r | |
47 | CHAR16 mNotifyString1[MAX_NOTIFY_STRING_LEN] = L"Image verification pass but not found in authorized database!";\r | |
48 | CHAR16 mNotifyString2[MAX_NOTIFY_STRING_LEN] = L"Launch this image anyway? (Yes/Defer/No)";\r | |
49 | //\r | |
50 | // Public Exponent of RSA Key.\r | |
51 | //\r | |
52 | CONST UINT8 mRsaE[] = { 0x01, 0x00, 0x01 };\r | |
53 | \r | |
54 | \r | |
55 | //\r | |
56 | // OID ASN.1 Value for Hash Algorithms\r | |
57 | //\r | |
58 | UINT8 mHashOidValue[] = {\r | |
0c18794e | 59 | 0x2B, 0x0E, 0x03, 0x02, 0x1A, // OBJ_sha1\r |
60 | 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x04, // OBJ_sha224\r | |
61 | 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, // OBJ_sha256\r | |
62 | 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x02, // OBJ_sha384\r | |
63 | 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x03, // OBJ_sha512\r | |
64 | };\r | |
65 | \r | |
66 | HASH_TABLE mHash[] = {\r | |
20333c6d QL |
67 | { L"SHA1", 20, &mHashOidValue[0], 5, Sha1GetContextSize, Sha1Init, Sha1Update, Sha1Final },\r |
68 | { L"SHA224", 28, &mHashOidValue[5], 9, NULL, NULL, NULL, NULL },\r | |
69 | { L"SHA256", 32, &mHashOidValue[14], 9, Sha256GetContextSize, Sha256Init, Sha256Update, Sha256Final},\r | |
70 | { L"SHA384", 48, &mHashOidValue[23], 9, Sha384GetContextSize, Sha384Init, Sha384Update, Sha384Final},\r | |
71 | { L"SHA512", 64, &mHashOidValue[32], 9, Sha512GetContextSize, Sha512Init, Sha512Update, Sha512Final}\r | |
0c18794e | 72 | };\r |
73 | \r | |
c1d93242 JY |
74 | /**\r |
75 | SecureBoot Hook for processing image verification.\r | |
76 | \r | |
77 | @param[in] VariableName Name of Variable to be found.\r | |
78 | @param[in] VendorGuid Variable vendor GUID.\r | |
79 | @param[in] DataSize Size of Data found. If size is less than the\r | |
80 | data, this value contains the required size.\r | |
81 | @param[in] Data Data pointer.\r | |
82 | \r | |
83 | **/\r | |
84 | VOID\r | |
85 | EFIAPI\r | |
86 | SecureBootHook (\r | |
87 | IN CHAR16 *VariableName,\r | |
88 | IN EFI_GUID *VendorGuid,\r | |
89 | IN UINTN DataSize,\r | |
90 | IN VOID *Data\r | |
91 | );\r | |
92 | \r | |
28186d45 ED |
93 | /**\r |
94 | Reads contents of a PE/COFF image in memory buffer.\r | |
95 | \r | |
dc204d5a JY |
96 | Caution: This function may receive untrusted input.\r |
97 | PE/COFF image is external input, so this function will make sure the PE/COFF image content\r | |
98 | read is within the image buffer.\r | |
99 | \r | |
28186d45 ED |
100 | @param FileHandle Pointer to the file handle to read the PE/COFF image.\r |
101 | @param FileOffset Offset into the PE/COFF image to begin the read operation.\r | |
20333c6d | 102 | @param ReadSize On input, the size in bytes of the requested read operation.\r |
28186d45 ED |
103 | On output, the number of bytes actually read.\r |
104 | @param Buffer Output buffer that contains the data read from the PE/COFF image.\r | |
20333c6d QL |
105 | \r |
106 | @retval EFI_SUCCESS The specified portion of the PE/COFF image was read and the size\r | |
28186d45 ED |
107 | **/\r |
108 | EFI_STATUS\r | |
109 | EFIAPI\r | |
e0192326 | 110 | DxeImageVerificationLibImageRead (\r |
28186d45 ED |
111 | IN VOID *FileHandle,\r |
112 | IN UINTN FileOffset,\r | |
113 | IN OUT UINTN *ReadSize,\r | |
114 | OUT VOID *Buffer\r | |
115 | )\r | |
116 | {\r | |
117 | UINTN EndPosition;\r | |
118 | \r | |
119 | if (FileHandle == NULL || ReadSize == NULL || Buffer == NULL) {\r | |
20333c6d | 120 | return EFI_INVALID_PARAMETER;\r |
28186d45 ED |
121 | }\r |
122 | \r | |
123 | if (MAX_ADDRESS - FileOffset < *ReadSize) {\r | |
124 | return EFI_INVALID_PARAMETER;\r | |
125 | }\r | |
126 | \r | |
127 | EndPosition = FileOffset + *ReadSize;\r | |
128 | if (EndPosition > mImageSize) {\r | |
129 | *ReadSize = (UINT32)(mImageSize - FileOffset);\r | |
130 | }\r | |
131 | \r | |
132 | if (FileOffset >= mImageSize) {\r | |
133 | *ReadSize = 0;\r | |
134 | }\r | |
135 | \r | |
136 | CopyMem (Buffer, (UINT8 *)((UINTN) FileHandle + FileOffset), *ReadSize);\r | |
137 | \r | |
138 | return EFI_SUCCESS;\r | |
139 | }\r | |
140 | \r | |
0c18794e | 141 | \r |
142 | /**\r | |
143 | Get the image type.\r | |
144 | \r | |
145 | @param[in] File This is a pointer to the device path of the file that is\r | |
45bf2c47 | 146 | being dispatched.\r |
0c18794e | 147 | \r |
45bf2c47 | 148 | @return UINT32 Image Type\r |
0c18794e | 149 | \r |
150 | **/\r | |
151 | UINT32\r | |
152 | GetImageType (\r | |
153 | IN CONST EFI_DEVICE_PATH_PROTOCOL *File\r | |
154 | )\r | |
155 | {\r | |
156 | EFI_STATUS Status;\r | |
45bf2c47 | 157 | EFI_HANDLE DeviceHandle;\r |
0c18794e | 158 | EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r |
159 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
160 | \r | |
5db28a67 LG |
161 | if (File == NULL) {\r |
162 | return IMAGE_UNKNOWN;\r | |
163 | }\r | |
164 | \r | |
0c18794e | 165 | //\r |
166 | // First check to see if File is from a Firmware Volume\r | |
167 | //\r | |
168 | DeviceHandle = NULL;\r | |
45bf2c47 | 169 | TempDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) File;\r |
0c18794e | 170 | Status = gBS->LocateDevicePath (\r |
171 | &gEfiFirmwareVolume2ProtocolGuid,\r | |
172 | &TempDevicePath,\r | |
173 | &DeviceHandle\r | |
174 | );\r | |
175 | if (!EFI_ERROR (Status)) {\r | |
176 | Status = gBS->OpenProtocol (\r | |
177 | DeviceHandle,\r | |
178 | &gEfiFirmwareVolume2ProtocolGuid,\r | |
179 | NULL,\r | |
180 | NULL,\r | |
181 | NULL,\r | |
182 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
183 | );\r | |
184 | if (!EFI_ERROR (Status)) {\r | |
185 | return IMAGE_FROM_FV;\r | |
186 | }\r | |
187 | }\r | |
188 | \r | |
189 | //\r | |
190 | // Next check to see if File is from a Block I/O device\r | |
191 | //\r | |
192 | DeviceHandle = NULL;\r | |
45bf2c47 | 193 | TempDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) File;\r |
0c18794e | 194 | Status = gBS->LocateDevicePath (\r |
195 | &gEfiBlockIoProtocolGuid,\r | |
196 | &TempDevicePath,\r | |
197 | &DeviceHandle\r | |
198 | );\r | |
199 | if (!EFI_ERROR (Status)) {\r | |
200 | BlockIo = NULL;\r | |
201 | Status = gBS->OpenProtocol (\r | |
202 | DeviceHandle,\r | |
203 | &gEfiBlockIoProtocolGuid,\r | |
204 | (VOID **) &BlockIo,\r | |
205 | NULL,\r | |
206 | NULL,\r | |
207 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
208 | );\r | |
209 | if (!EFI_ERROR (Status) && BlockIo != NULL) {\r | |
210 | if (BlockIo->Media != NULL) {\r | |
211 | if (BlockIo->Media->RemovableMedia) {\r | |
212 | //\r | |
213 | // Block I/O is present and specifies the media is removable\r | |
214 | //\r | |
215 | return IMAGE_FROM_REMOVABLE_MEDIA;\r | |
216 | } else {\r | |
217 | //\r | |
218 | // Block I/O is present and specifies the media is not removable\r | |
219 | //\r | |
220 | return IMAGE_FROM_FIXED_MEDIA;\r | |
221 | }\r | |
222 | }\r | |
223 | }\r | |
224 | }\r | |
225 | \r | |
226 | //\r | |
45bf2c47 | 227 | // File is not in a Firmware Volume or on a Block I/O device, so check to see if\r |
0c18794e | 228 | // the device path supports the Simple File System Protocol.\r |
229 | //\r | |
230 | DeviceHandle = NULL;\r | |
45bf2c47 | 231 | TempDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) File;\r |
0c18794e | 232 | Status = gBS->LocateDevicePath (\r |
233 | &gEfiSimpleFileSystemProtocolGuid,\r | |
234 | &TempDevicePath,\r | |
235 | &DeviceHandle\r | |
236 | );\r | |
237 | if (!EFI_ERROR (Status)) {\r | |
238 | //\r | |
239 | // Simple File System is present without Block I/O, so assume media is fixed.\r | |
240 | //\r | |
241 | return IMAGE_FROM_FIXED_MEDIA;\r | |
242 | }\r | |
243 | \r | |
244 | //\r | |
245 | // File is not from an FV, Block I/O or Simple File System, so the only options\r | |
45bf2c47 | 246 | // left are a PCI Option ROM and a Load File Protocol such as a PXE Boot from a NIC.\r |
0c18794e | 247 | //\r |
45bf2c47 | 248 | TempDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) File;\r |
0c18794e | 249 | while (!IsDevicePathEndType (TempDevicePath)) {\r |
250 | switch (DevicePathType (TempDevicePath)) {\r | |
45bf2c47 | 251 | \r |
0c18794e | 252 | case MEDIA_DEVICE_PATH:\r |
253 | if (DevicePathSubType (TempDevicePath) == MEDIA_RELATIVE_OFFSET_RANGE_DP) {\r | |
254 | return IMAGE_FROM_OPTION_ROM;\r | |
255 | }\r | |
256 | break;\r | |
257 | \r | |
258 | case MESSAGING_DEVICE_PATH:\r | |
259 | if (DevicePathSubType(TempDevicePath) == MSG_MAC_ADDR_DP) {\r | |
260 | return IMAGE_FROM_REMOVABLE_MEDIA;\r | |
45bf2c47 | 261 | }\r |
0c18794e | 262 | break;\r |
263 | \r | |
264 | default:\r | |
265 | break;\r | |
266 | }\r | |
267 | TempDevicePath = NextDevicePathNode (TempDevicePath);\r | |
268 | }\r | |
45bf2c47 | 269 | return IMAGE_UNKNOWN;\r |
0c18794e | 270 | }\r |
271 | \r | |
272 | /**\r | |
69f8bb52 | 273 | Calculate hash of Pe/Coff image based on the authenticode image hashing in\r |
0c18794e | 274 | PE/COFF Specification 8.0 Appendix A\r |
275 | \r | |
dc204d5a JY |
276 | Caution: This function may receive untrusted input.\r |
277 | PE/COFF image is external input, so this function will validate its data structure\r | |
278 | within this image buffer before use.\r | |
279 | \r | |
0c18794e | 280 | @param[in] HashAlg Hash algorithm type.\r |
45bf2c47 | 281 | \r |
0c18794e | 282 | @retval TRUE Successfully hash image.\r |
283 | @retval FALSE Fail in hash image.\r | |
284 | \r | |
285 | **/\r | |
45bf2c47 | 286 | BOOLEAN\r |
0c18794e | 287 | HashPeImage (\r |
288 | IN UINT32 HashAlg\r | |
289 | )\r | |
290 | {\r | |
291 | BOOLEAN Status;\r | |
292 | UINT16 Magic;\r | |
293 | EFI_IMAGE_SECTION_HEADER *Section;\r | |
294 | VOID *HashCtx;\r | |
295 | UINTN CtxSize;\r | |
296 | UINT8 *HashBase;\r | |
297 | UINTN HashSize;\r | |
298 | UINTN SumOfBytesHashed;\r | |
299 | EFI_IMAGE_SECTION_HEADER *SectionHeader;\r | |
300 | UINTN Index;\r | |
301 | UINTN Pos;\r | |
551d8081 | 302 | UINT32 CertSize;\r |
303 | UINT32 NumberOfRvaAndSizes;\r | |
45bf2c47 | 304 | \r |
0c18794e | 305 | HashCtx = NULL;\r |
306 | SectionHeader = NULL;\r | |
307 | Status = FALSE;\r | |
308 | \r | |
20333c6d | 309 | if ((HashAlg >= HASHALG_MAX)) {\r |
0c18794e | 310 | return FALSE;\r |
311 | }\r | |
45bf2c47 | 312 | \r |
0c18794e | 313 | //\r |
314 | // Initialize context of hash.\r | |
315 | //\r | |
316 | ZeroMem (mImageDigest, MAX_DIGEST_SIZE);\r | |
317 | \r | |
20333c6d QL |
318 | switch (HashAlg) {\r |
319 | case HASHALG_SHA1:\r | |
320 | mImageDigestSize = SHA1_DIGEST_SIZE;\r | |
321 | mCertType = gEfiCertSha1Guid;\r | |
322 | break;\r | |
323 | \r | |
324 | case HASHALG_SHA256:\r | |
325 | mImageDigestSize = SHA256_DIGEST_SIZE;\r | |
326 | mCertType = gEfiCertSha256Guid;\r | |
327 | break;\r | |
328 | \r | |
329 | case HASHALG_SHA384:\r | |
330 | mImageDigestSize = SHA384_DIGEST_SIZE;\r | |
331 | mCertType = gEfiCertSha384Guid;\r | |
332 | break;\r | |
333 | \r | |
334 | case HASHALG_SHA512:\r | |
335 | mImageDigestSize = SHA512_DIGEST_SIZE;\r | |
336 | mCertType = gEfiCertSha512Guid;\r | |
337 | break;\r | |
338 | \r | |
339 | default:\r | |
0c18794e | 340 | return FALSE;\r |
341 | }\r | |
342 | \r | |
343 | CtxSize = mHash[HashAlg].GetContextSize();\r | |
45bf2c47 | 344 | \r |
0c18794e | 345 | HashCtx = AllocatePool (CtxSize);\r |
570b3d1a | 346 | if (HashCtx == NULL) {\r |
347 | return FALSE;\r | |
348 | }\r | |
0c18794e | 349 | \r |
350 | // 1. Load the image header into memory.\r | |
351 | \r | |
352 | // 2. Initialize a SHA hash context.\r | |
353 | Status = mHash[HashAlg].HashInit(HashCtx);\r | |
45bf2c47 | 354 | \r |
0c18794e | 355 | if (!Status) {\r |
356 | goto Done;\r | |
357 | }\r | |
551d8081 | 358 | \r |
0c18794e | 359 | //\r |
360 | // Measuring PE/COFF Image Header;\r | |
361 | // But CheckSum field and SECURITY data directory (certificate) are excluded\r | |
362 | //\r | |
de2447dd | 363 | if (mNtHeader.Pe32->FileHeader.Machine == IMAGE_FILE_MACHINE_IA64 && mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
364 | //\r | |
20333c6d QL |
365 | // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value\r |
366 | // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the\r | |
de2447dd | 367 | // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC\r |
368 | // then override the magic value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC\r | |
369 | //\r | |
370 | Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;\r | |
371 | } else {\r | |
372 | //\r | |
373 | // Get the magic value from the PE/COFF Optional Header\r | |
374 | //\r | |
375 | Magic = mNtHeader.Pe32->OptionalHeader.Magic;\r | |
376 | }\r | |
20333c6d | 377 | \r |
0c18794e | 378 | //\r |
379 | // 3. Calculate the distance from the base of the image header to the image checksum address.\r | |
380 | // 4. Hash the image header from its base to beginning of the image checksum.\r | |
381 | //\r | |
382 | HashBase = mImageBase;\r | |
383 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r | |
384 | //\r | |
385 | // Use PE32 offset.\r | |
386 | //\r | |
387 | HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32->OptionalHeader.CheckSum) - HashBase);\r | |
551d8081 | 388 | NumberOfRvaAndSizes = mNtHeader.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r |
570b3d1a | 389 | } else if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {\r |
0c18794e | 390 | //\r |
391 | // Use PE32+ offset.\r | |
392 | //\r | |
393 | HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32Plus->OptionalHeader.CheckSum) - HashBase);\r | |
551d8081 | 394 | NumberOfRvaAndSizes = mNtHeader.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r |
570b3d1a | 395 | } else {\r |
396 | //\r | |
397 | // Invalid header magic number.\r | |
398 | //\r | |
399 | Status = FALSE;\r | |
400 | goto Done;\r | |
0c18794e | 401 | }\r |
402 | \r | |
403 | Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);\r | |
404 | if (!Status) {\r | |
405 | goto Done;\r | |
406 | }\r | |
551d8081 | 407 | \r |
0c18794e | 408 | //\r |
409 | // 5. Skip over the image checksum (it occupies a single ULONG).\r | |
0c18794e | 410 | //\r |
551d8081 | 411 | if (NumberOfRvaAndSizes <= EFI_IMAGE_DIRECTORY_ENTRY_SECURITY) {\r |
0c18794e | 412 | //\r |
551d8081 | 413 | // 6. Since there is no Cert Directory in optional header, hash everything\r |
414 | // from the end of the checksum to the end of image header.\r | |
0c18794e | 415 | //\r |
551d8081 | 416 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
417 | //\r | |
418 | // Use PE32 offset.\r | |
419 | //\r | |
420 | HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.CheckSum + sizeof (UINT32);\r | |
421 | HashSize = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders - (UINTN) (HashBase - mImageBase);\r | |
422 | } else {\r | |
423 | //\r | |
424 | // Use PE32+ offset.\r | |
425 | //\r | |
426 | HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.CheckSum + sizeof (UINT32);\r | |
427 | HashSize = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders - (UINTN) (HashBase - mImageBase);\r | |
428 | }\r | |
429 | \r | |
430 | if (HashSize != 0) {\r | |
431 | Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);\r | |
432 | if (!Status) {\r | |
433 | goto Done;\r | |
434 | }\r | |
435 | }\r | |
0c18794e | 436 | } else {\r |
437 | //\r | |
551d8081 | 438 | // 7. Hash everything from the end of the checksum to the start of the Cert Directory.\r |
45bf2c47 | 439 | //\r |
551d8081 | 440 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
441 | //\r | |
442 | // Use PE32 offset.\r | |
443 | //\r | |
444 | HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.CheckSum + sizeof (UINT32);\r | |
445 | HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]) - HashBase);\r | |
446 | } else {\r | |
447 | //\r | |
448 | // Use PE32+ offset.\r | |
449 | //\r | |
450 | HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.CheckSum + sizeof (UINT32);\r | |
451 | HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]) - HashBase);\r | |
452 | }\r | |
453 | \r | |
454 | if (HashSize != 0) {\r | |
455 | Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);\r | |
456 | if (!Status) {\r | |
457 | goto Done;\r | |
458 | }\r | |
459 | }\r | |
0c18794e | 460 | \r |
0c18794e | 461 | //\r |
551d8081 | 462 | // 8. Skip over the Cert Directory. (It is sizeof(IMAGE_DATA_DIRECTORY) bytes.)\r |
463 | // 9. Hash everything from the end of the Cert Directory to the end of image header.\r | |
0c18794e | 464 | //\r |
551d8081 | 465 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
466 | //\r | |
467 | // Use PE32 offset\r | |
468 | //\r | |
469 | HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1];\r | |
470 | HashSize = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders - (UINTN) (HashBase - mImageBase);\r | |
471 | } else {\r | |
472 | //\r | |
473 | // Use PE32+ offset.\r | |
474 | //\r | |
475 | HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1];\r | |
476 | HashSize = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders - (UINTN) (HashBase - mImageBase);\r | |
477 | }\r | |
0c18794e | 478 | \r |
551d8081 | 479 | if (HashSize != 0) {\r |
480 | Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);\r | |
481 | if (!Status) {\r | |
482 | goto Done;\r | |
483 | }\r | |
20333c6d | 484 | }\r |
0c18794e | 485 | }\r |
551d8081 | 486 | \r |
0c18794e | 487 | //\r |
488 | // 10. Set the SUM_OF_BYTES_HASHED to the size of the header.\r | |
489 | //\r | |
490 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r | |
491 | //\r | |
492 | // Use PE32 offset.\r | |
493 | //\r | |
494 | SumOfBytesHashed = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders;\r | |
495 | } else {\r | |
496 | //\r | |
497 | // Use PE32+ offset\r | |
498 | //\r | |
499 | SumOfBytesHashed = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders;\r | |
500 | }\r | |
501 | \r | |
570b3d1a | 502 | \r |
503 | Section = (EFI_IMAGE_SECTION_HEADER *) (\r | |
504 | mImageBase +\r | |
505 | mPeCoffHeaderOffset +\r | |
506 | sizeof (UINT32) +\r | |
507 | sizeof (EFI_IMAGE_FILE_HEADER) +\r | |
508 | mNtHeader.Pe32->FileHeader.SizeOfOptionalHeader\r | |
509 | );\r | |
510 | \r | |
0c18794e | 511 | //\r |
512 | // 11. Build a temporary table of pointers to all the IMAGE_SECTION_HEADER\r | |
513 | // structures in the image. The 'NumberOfSections' field of the image\r | |
514 | // header indicates how big the table should be. Do not include any\r | |
515 | // IMAGE_SECTION_HEADERs in the table whose 'SizeOfRawData' field is zero.\r | |
516 | //\r | |
517 | SectionHeader = (EFI_IMAGE_SECTION_HEADER *) AllocateZeroPool (sizeof (EFI_IMAGE_SECTION_HEADER) * mNtHeader.Pe32->FileHeader.NumberOfSections);\r | |
570b3d1a | 518 | if (SectionHeader == NULL) {\r |
519 | Status = FALSE;\r | |
520 | goto Done;\r | |
521 | }\r | |
0c18794e | 522 | //\r |
523 | // 12. Using the 'PointerToRawData' in the referenced section headers as\r | |
524 | // a key, arrange the elements in the table in ascending order. In other\r | |
525 | // words, sort the section headers according to the disk-file offset of\r | |
526 | // the section.\r | |
527 | //\r | |
0c18794e | 528 | for (Index = 0; Index < mNtHeader.Pe32->FileHeader.NumberOfSections; Index++) {\r |
529 | Pos = Index;\r | |
530 | while ((Pos > 0) && (Section->PointerToRawData < SectionHeader[Pos - 1].PointerToRawData)) {\r | |
531 | CopyMem (&SectionHeader[Pos], &SectionHeader[Pos - 1], sizeof (EFI_IMAGE_SECTION_HEADER));\r | |
532 | Pos--;\r | |
533 | }\r | |
534 | CopyMem (&SectionHeader[Pos], Section, sizeof (EFI_IMAGE_SECTION_HEADER));\r | |
535 | Section += 1;\r | |
536 | }\r | |
537 | \r | |
538 | //\r | |
539 | // 13. Walk through the sorted table, bring the corresponding section\r | |
540 | // into memory, and hash the entire section (using the 'SizeOfRawData'\r | |
541 | // field in the section header to determine the amount of data to hash).\r | |
542 | // 14. Add the section's 'SizeOfRawData' to SUM_OF_BYTES_HASHED .\r | |
543 | // 15. Repeat steps 13 and 14 for all the sections in the sorted table.\r | |
544 | //\r | |
545 | for (Index = 0; Index < mNtHeader.Pe32->FileHeader.NumberOfSections; Index++) {\r | |
546 | Section = &SectionHeader[Index];\r | |
547 | if (Section->SizeOfRawData == 0) {\r | |
548 | continue;\r | |
549 | }\r | |
550 | HashBase = mImageBase + Section->PointerToRawData;\r | |
551 | HashSize = (UINTN) Section->SizeOfRawData;\r | |
552 | \r | |
553 | Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);\r | |
554 | if (!Status) {\r | |
555 | goto Done;\r | |
556 | }\r | |
557 | \r | |
558 | SumOfBytesHashed += HashSize;\r | |
559 | }\r | |
560 | \r | |
561 | //\r | |
562 | // 16. If the file size is greater than SUM_OF_BYTES_HASHED, there is extra\r | |
563 | // data in the file that needs to be added to the hash. This data begins\r | |
564 | // at file offset SUM_OF_BYTES_HASHED and its length is:\r | |
565 | // FileSize - (CertDirectory->Size)\r | |
566 | //\r | |
567 | if (mImageSize > SumOfBytesHashed) {\r | |
568 | HashBase = mImageBase + SumOfBytesHashed;\r | |
551d8081 | 569 | \r |
570 | if (NumberOfRvaAndSizes <= EFI_IMAGE_DIRECTORY_ENTRY_SECURITY) {\r | |
571 | CertSize = 0;\r | |
0c18794e | 572 | } else {\r |
551d8081 | 573 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
574 | //\r | |
575 | // Use PE32 offset.\r | |
576 | //\r | |
577 | CertSize = mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size;\r | |
578 | } else {\r | |
579 | //\r | |
580 | // Use PE32+ offset.\r | |
581 | //\r | |
582 | CertSize = mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size;\r | |
28186d45 | 583 | }\r |
0c18794e | 584 | }\r |
585 | \r | |
551d8081 | 586 | if (mImageSize > CertSize + SumOfBytesHashed) {\r |
587 | HashSize = (UINTN) (mImageSize - CertSize - SumOfBytesHashed);\r | |
588 | \r | |
589 | Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);\r | |
590 | if (!Status) {\r | |
591 | goto Done;\r | |
592 | }\r | |
593 | } else if (mImageSize < CertSize + SumOfBytesHashed) {\r | |
594 | Status = FALSE;\r | |
0c18794e | 595 | goto Done;\r |
596 | }\r | |
597 | }\r | |
551d8081 | 598 | \r |
0c18794e | 599 | Status = mHash[HashAlg].HashFinal(HashCtx, mImageDigest);\r |
600 | \r | |
601 | Done:\r | |
602 | if (HashCtx != NULL) {\r | |
603 | FreePool (HashCtx);\r | |
604 | }\r | |
605 | if (SectionHeader != NULL) {\r | |
606 | FreePool (SectionHeader);\r | |
607 | }\r | |
608 | return Status;\r | |
609 | }\r | |
610 | \r | |
611 | /**\r | |
69f8bb52 | 612 | Recognize the Hash algorithm in PE/COFF Authenticode and calculate hash of\r |
45bf2c47 | 613 | Pe/Coff image based on the authenticode image hashing in PE/COFF Specification\r |
0c18794e | 614 | 8.0 Appendix A\r |
615 | \r | |
dc204d5a JY |
616 | Caution: This function may receive untrusted input.\r |
617 | PE/COFF image is external input, so this function will validate its data structure\r | |
618 | within this image buffer before use.\r | |
619 | \r | |
f6f9031f | 620 | @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed image.\r |
621 | @param[in] AuthDataSize Size of the Authenticode Signature in bytes.\r | |
20333c6d | 622 | \r |
0c18794e | 623 | @retval EFI_UNSUPPORTED Hash algorithm is not supported.\r |
624 | @retval EFI_SUCCESS Hash successfully.\r | |
625 | \r | |
626 | **/\r | |
45bf2c47 | 627 | EFI_STATUS\r |
0c18794e | 628 | HashPeImageByType (\r |
f6f9031f | 629 | IN UINT8 *AuthData,\r |
630 | IN UINTN AuthDataSize\r | |
0c18794e | 631 | )\r |
632 | {\r | |
633 | UINT8 Index;\r | |
badd40f9 | 634 | \r |
45bf2c47 | 635 | for (Index = 0; Index < HASHALG_MAX; Index++) {\r |
0c18794e | 636 | //\r |
637 | // Check the Hash algorithm in PE/COFF Authenticode.\r | |
45bf2c47 | 638 | // According to PKCS#7 Definition:\r |
0c18794e | 639 | // SignedData ::= SEQUENCE {\r |
640 | // version Version,\r | |
641 | // digestAlgorithms DigestAlgorithmIdentifiers,\r | |
642 | // contentInfo ContentInfo,\r | |
643 | // .... }\r | |
644 | // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm in PE/COFF hashing\r | |
645 | // This field has the fixed offset (+32) in final Authenticode ASN.1 data.\r | |
bd0de396 | 646 | // Fixed offset (+32) is calculated based on two bytes of length encoding.\r |
45bf2c47 | 647 | //\r |
f6f9031f | 648 | if ((*(AuthData + 1) & TWO_BYTE_ENCODE) != TWO_BYTE_ENCODE) {\r |
bd0de396 | 649 | //\r |
650 | // Only support two bytes of Long Form of Length Encoding.\r | |
651 | //\r | |
652 | continue;\r | |
653 | }\r | |
654 | \r | |
f6f9031f | 655 | if (AuthDataSize < 32 + mHash[Index].OidLength) {\r |
badd40f9 | 656 | return EFI_UNSUPPORTED;\r |
657 | }\r | |
658 | \r | |
f6f9031f | 659 | if (CompareMem (AuthData + 32, mHash[Index].OidValue, mHash[Index].OidLength) == 0) {\r |
0c18794e | 660 | break;\r |
661 | }\r | |
662 | }\r | |
663 | \r | |
664 | if (Index == HASHALG_MAX) {\r | |
665 | return EFI_UNSUPPORTED;\r | |
666 | }\r | |
667 | \r | |
668 | //\r | |
669 | // HASH PE Image based on Hash algorithm in PE/COFF Authenticode.\r | |
670 | //\r | |
671 | if (!HashPeImage(Index)) {\r | |
672 | return EFI_UNSUPPORTED;\r | |
673 | }\r | |
674 | \r | |
675 | return EFI_SUCCESS;\r | |
676 | }\r | |
677 | \r | |
678 | \r | |
679 | /**\r | |
680 | Returns the size of a given image execution info table in bytes.\r | |
681 | \r | |
682 | This function returns the size, in bytes, of the image execution info table specified by\r | |
683 | ImageExeInfoTable. If ImageExeInfoTable is NULL, then 0 is returned.\r | |
684 | \r | |
685 | @param ImageExeInfoTable A pointer to a image execution info table structure.\r | |
45bf2c47 | 686 | \r |
0c18794e | 687 | @retval 0 If ImageExeInfoTable is NULL.\r |
688 | @retval Others The size of a image execution info table in bytes.\r | |
689 | \r | |
690 | **/\r | |
691 | UINTN\r | |
692 | GetImageExeInfoTableSize (\r | |
693 | EFI_IMAGE_EXECUTION_INFO_TABLE *ImageExeInfoTable\r | |
694 | )\r | |
695 | {\r | |
696 | UINTN Index;\r | |
697 | EFI_IMAGE_EXECUTION_INFO *ImageExeInfoItem;\r | |
698 | UINTN TotalSize;\r | |
699 | \r | |
700 | if (ImageExeInfoTable == NULL) {\r | |
701 | return 0;\r | |
702 | }\r | |
703 | \r | |
704 | ImageExeInfoItem = (EFI_IMAGE_EXECUTION_INFO *) ((UINT8 *) ImageExeInfoTable + sizeof (EFI_IMAGE_EXECUTION_INFO_TABLE));\r | |
705 | TotalSize = sizeof (EFI_IMAGE_EXECUTION_INFO_TABLE);\r | |
706 | for (Index = 0; Index < ImageExeInfoTable->NumberOfImages; Index++) {\r | |
707 | TotalSize += ReadUnaligned32 ((UINT32 *) &ImageExeInfoItem->InfoSize);\r | |
708 | ImageExeInfoItem = (EFI_IMAGE_EXECUTION_INFO *) ((UINT8 *) ImageExeInfoItem + ReadUnaligned32 ((UINT32 *) &ImageExeInfoItem->InfoSize));\r | |
709 | }\r | |
710 | \r | |
711 | return TotalSize;\r | |
712 | }\r | |
713 | \r | |
714 | /**\r | |
715 | Create an Image Execution Information Table entry and add it to system configuration table.\r | |
716 | \r | |
717 | @param[in] Action Describes the action taken by the firmware regarding this image.\r | |
718 | @param[in] Name Input a null-terminated, user-friendly name.\r | |
719 | @param[in] DevicePath Input device path pointer.\r | |
720 | @param[in] Signature Input signature info in EFI_SIGNATURE_LIST data structure.\r | |
721 | @param[in] SignatureSize Size of signature.\r | |
45bf2c47 | 722 | \r |
0c18794e | 723 | **/\r |
724 | VOID\r | |
725 | AddImageExeInfo (\r | |
45bf2c47 | 726 | IN EFI_IMAGE_EXECUTION_ACTION Action,\r |
727 | IN CHAR16 *Name OPTIONAL,\r | |
0c18794e | 728 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
729 | IN EFI_SIGNATURE_LIST *Signature OPTIONAL,\r | |
730 | IN UINTN SignatureSize\r | |
731 | )\r | |
732 | {\r | |
0c18794e | 733 | EFI_IMAGE_EXECUTION_INFO_TABLE *ImageExeInfoTable;\r |
734 | EFI_IMAGE_EXECUTION_INFO_TABLE *NewImageExeInfoTable;\r | |
735 | EFI_IMAGE_EXECUTION_INFO *ImageExeInfoEntry;\r | |
736 | UINTN ImageExeInfoTableSize;\r | |
737 | UINTN NewImageExeInfoEntrySize;\r | |
738 | UINTN NameStringLen;\r | |
739 | UINTN DevicePathSize;\r | |
4fc08e8d | 740 | CHAR16 *NameStr;\r |
0c18794e | 741 | \r |
0c18794e | 742 | ImageExeInfoTable = NULL;\r |
743 | NewImageExeInfoTable = NULL;\r | |
744 | ImageExeInfoEntry = NULL;\r | |
745 | NameStringLen = 0;\r | |
4fc08e8d | 746 | NameStr = NULL;\r |
0c18794e | 747 | \r |
570b3d1a | 748 | if (DevicePath == NULL) {\r |
749 | return ;\r | |
750 | }\r | |
45bf2c47 | 751 | \r |
0c18794e | 752 | if (Name != NULL) {\r |
753 | NameStringLen = StrSize (Name);\r | |
b3d42170 | 754 | } else {\r |
755 | NameStringLen = sizeof (CHAR16);\r | |
0c18794e | 756 | }\r |
757 | \r | |
45bf2c47 | 758 | EfiGetSystemConfigurationTable (&gEfiImageSecurityDatabaseGuid, (VOID **) &ImageExeInfoTable);\r |
0c18794e | 759 | if (ImageExeInfoTable != NULL) {\r |
760 | //\r | |
761 | // The table has been found!\r | |
b3d42170 | 762 | // We must enlarge the table to accomodate the new exe info entry.\r |
0c18794e | 763 | //\r |
764 | ImageExeInfoTableSize = GetImageExeInfoTableSize (ImageExeInfoTable);\r | |
765 | } else {\r | |
766 | //\r | |
767 | // Not Found!\r | |
768 | // We should create a new table to append to the configuration table.\r | |
769 | //\r | |
770 | ImageExeInfoTableSize = sizeof (EFI_IMAGE_EXECUTION_INFO_TABLE);\r | |
771 | }\r | |
772 | \r | |
773 | DevicePathSize = GetDevicePathSize (DevicePath);\r | |
4fc08e8d CZ |
774 | \r |
775 | //\r | |
776 | // Signature size can be odd. Pad after signature to ensure next EXECUTION_INFO entry align\r | |
777 | //\r | |
778 | NewImageExeInfoEntrySize = sizeof (EFI_IMAGE_EXECUTION_INFO) + NameStringLen + DevicePathSize + SignatureSize;\r | |
779 | \r | |
0c18794e | 780 | NewImageExeInfoTable = (EFI_IMAGE_EXECUTION_INFO_TABLE *) AllocateRuntimePool (ImageExeInfoTableSize + NewImageExeInfoEntrySize);\r |
570b3d1a | 781 | if (NewImageExeInfoTable == NULL) {\r |
782 | return ;\r | |
783 | }\r | |
0c18794e | 784 | \r |
785 | if (ImageExeInfoTable != NULL) {\r | |
786 | CopyMem (NewImageExeInfoTable, ImageExeInfoTable, ImageExeInfoTableSize);\r | |
787 | } else {\r | |
788 | NewImageExeInfoTable->NumberOfImages = 0;\r | |
789 | }\r | |
790 | NewImageExeInfoTable->NumberOfImages++;\r | |
791 | ImageExeInfoEntry = (EFI_IMAGE_EXECUTION_INFO *) ((UINT8 *) NewImageExeInfoTable + ImageExeInfoTableSize);\r | |
792 | //\r | |
ffccb935 | 793 | // Update new item's information.\r |
0c18794e | 794 | //\r |
1fee5304 ED |
795 | WriteUnaligned32 ((UINT32 *) ImageExeInfoEntry, Action);\r |
796 | WriteUnaligned32 ((UINT32 *) ((UINT8 *) ImageExeInfoEntry + sizeof (EFI_IMAGE_EXECUTION_ACTION)), (UINT32) NewImageExeInfoEntrySize);\r | |
0c18794e | 797 | \r |
4fc08e8d | 798 | NameStr = (CHAR16 *)(ImageExeInfoEntry + 1);\r |
0c18794e | 799 | if (Name != NULL) {\r |
4fc08e8d | 800 | CopyMem ((UINT8 *) NameStr, Name, NameStringLen);\r |
b3d42170 | 801 | } else {\r |
4fc08e8d | 802 | ZeroMem ((UINT8 *) NameStr, sizeof (CHAR16));\r |
0c18794e | 803 | }\r |
4fc08e8d | 804 | \r |
0c18794e | 805 | CopyMem (\r |
4fc08e8d | 806 | (UINT8 *) NameStr + NameStringLen,\r |
0c18794e | 807 | DevicePath,\r |
808 | DevicePathSize\r | |
809 | );\r | |
810 | if (Signature != NULL) {\r | |
811 | CopyMem (\r | |
4fc08e8d | 812 | (UINT8 *) NameStr + NameStringLen + DevicePathSize,\r |
0c18794e | 813 | Signature,\r |
814 | SignatureSize\r | |
815 | );\r | |
816 | }\r | |
817 | //\r | |
818 | // Update/replace the image execution table.\r | |
819 | //\r | |
570b3d1a | 820 | gBS->InstallConfigurationTable (&gEfiImageSecurityDatabaseGuid, (VOID *) NewImageExeInfoTable);\r |
45bf2c47 | 821 | \r |
0c18794e | 822 | //\r |
823 | // Free Old table data!\r | |
824 | //\r | |
825 | if (ImageExeInfoTable != NULL) {\r | |
826 | FreePool (ImageExeInfoTable);\r | |
827 | }\r | |
828 | }\r | |
829 | \r | |
20333c6d QL |
830 | /**\r |
831 | Check whether the hash of an given X.509 certificate is in forbidden database (DBX).\r | |
832 | \r | |
833 | @param[in] Certificate Pointer to X.509 Certificate that is searched for.\r | |
834 | @param[in] CertSize Size of X.509 Certificate.\r | |
835 | @param[in] SignatureList Pointer to the Signature List in forbidden database.\r | |
836 | @param[in] SignatureListSize Size of Signature List.\r | |
837 | @param[out] RevocationTime Return the time that the certificate was revoked.\r | |
838 | \r | |
839 | @return TRUE The certificate hash is found in the forbidden database.\r | |
840 | @return FALSE The certificate hash is not found in the forbidden database.\r | |
841 | \r | |
842 | **/\r | |
843 | BOOLEAN\r | |
844 | IsCertHashFoundInDatabase (\r | |
845 | IN UINT8 *Certificate,\r | |
846 | IN UINTN CertSize,\r | |
847 | IN EFI_SIGNATURE_LIST *SignatureList,\r | |
848 | IN UINTN SignatureListSize,\r | |
849 | OUT EFI_TIME *RevocationTime\r | |
850 | )\r | |
851 | {\r | |
852 | BOOLEAN IsFound;\r | |
5789fe35 | 853 | BOOLEAN Status;\r |
20333c6d QL |
854 | EFI_SIGNATURE_LIST *DbxList;\r |
855 | UINTN DbxSize;\r | |
856 | EFI_SIGNATURE_DATA *CertHash;\r | |
857 | UINTN CertHashCount;\r | |
858 | UINTN Index;\r | |
859 | UINT32 HashAlg;\r | |
860 | VOID *HashCtx;\r | |
861 | UINT8 CertDigest[MAX_DIGEST_SIZE];\r | |
862 | UINT8 *DbxCertHash;\r | |
863 | UINTN SiglistHeaderSize;\r | |
12d95665 LQ |
864 | UINT8 *TBSCert;\r |
865 | UINTN TBSCertSize;\r | |
20333c6d QL |
866 | \r |
867 | IsFound = FALSE;\r | |
868 | DbxList = SignatureList;\r | |
869 | DbxSize = SignatureListSize;\r | |
870 | HashCtx = NULL;\r | |
871 | HashAlg = HASHALG_MAX;\r | |
872 | \r | |
12d95665 LQ |
873 | if ((RevocationTime == NULL) || (DbxList == NULL)) {\r |
874 | return FALSE;\r | |
875 | }\r | |
876 | \r | |
877 | //\r | |
878 | // Retrieve the TBSCertificate from the X.509 Certificate.\r | |
879 | //\r | |
880 | if (!X509GetTBSCert (Certificate, CertSize, &TBSCert, &TBSCertSize)) {\r | |
881 | return FALSE;\r | |
882 | }\r | |
20333c6d QL |
883 | \r |
884 | while ((DbxSize > 0) && (SignatureListSize >= DbxList->SignatureListSize)) {\r | |
885 | //\r | |
886 | // Determine Hash Algorithm of Certificate in the forbidden database.\r | |
887 | //\r | |
888 | if (CompareGuid (&DbxList->SignatureType, &gEfiCertX509Sha256Guid)) {\r | |
889 | HashAlg = HASHALG_SHA256;\r | |
890 | } else if (CompareGuid (&DbxList->SignatureType, &gEfiCertX509Sha384Guid)) {\r | |
891 | HashAlg = HASHALG_SHA384;\r | |
892 | } else if (CompareGuid (&DbxList->SignatureType, &gEfiCertX509Sha512Guid)) {\r | |
893 | HashAlg = HASHALG_SHA512;\r | |
894 | } else {\r | |
895 | DbxSize -= DbxList->SignatureListSize;\r | |
896 | DbxList = (EFI_SIGNATURE_LIST *) ((UINT8 *) DbxList + DbxList->SignatureListSize);\r | |
897 | continue;\r | |
898 | }\r | |
899 | \r | |
900 | //\r | |
12d95665 | 901 | // Calculate the hash value of current TBSCertificate for comparision.\r |
20333c6d QL |
902 | //\r |
903 | if (mHash[HashAlg].GetContextSize == NULL) {\r | |
904 | goto Done;\r | |
905 | }\r | |
906 | ZeroMem (CertDigest, MAX_DIGEST_SIZE);\r | |
907 | HashCtx = AllocatePool (mHash[HashAlg].GetContextSize ());\r | |
908 | if (HashCtx == NULL) {\r | |
909 | goto Done;\r | |
910 | }\r | |
911 | Status = mHash[HashAlg].HashInit (HashCtx);\r | |
912 | if (!Status) {\r | |
913 | goto Done;\r | |
914 | }\r | |
12d95665 | 915 | Status = mHash[HashAlg].HashUpdate (HashCtx, TBSCert, TBSCertSize);\r |
20333c6d QL |
916 | if (!Status) {\r |
917 | goto Done;\r | |
918 | }\r | |
919 | Status = mHash[HashAlg].HashFinal (HashCtx, CertDigest);\r | |
920 | if (!Status) {\r | |
921 | goto Done;\r | |
922 | }\r | |
923 | \r | |
924 | SiglistHeaderSize = sizeof (EFI_SIGNATURE_LIST) + DbxList->SignatureHeaderSize;\r | |
925 | CertHash = (EFI_SIGNATURE_DATA *) ((UINT8 *) DbxList + SiglistHeaderSize);\r | |
926 | CertHashCount = (DbxList->SignatureListSize - SiglistHeaderSize) / DbxList->SignatureSize;\r | |
927 | for (Index = 0; Index < CertHashCount; Index++) {\r | |
928 | //\r | |
929 | // Iterate each Signature Data Node within this CertList for verify.\r | |
930 | //\r | |
931 | DbxCertHash = CertHash->SignatureData;\r | |
932 | if (CompareMem (DbxCertHash, CertDigest, mHash[HashAlg].DigestLength) == 0) {\r | |
933 | //\r | |
934 | // Hash of Certificate is found in forbidden database.\r | |
935 | //\r | |
936 | IsFound = TRUE;\r | |
937 | \r | |
938 | //\r | |
939 | // Return the revocation time.\r | |
940 | //\r | |
941 | CopyMem (RevocationTime, (EFI_TIME *)(DbxCertHash + mHash[HashAlg].DigestLength), sizeof (EFI_TIME));\r | |
942 | goto Done;\r | |
943 | }\r | |
944 | CertHash = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertHash + DbxList->SignatureSize);\r | |
945 | }\r | |
946 | \r | |
947 | DbxSize -= DbxList->SignatureListSize;\r | |
948 | DbxList = (EFI_SIGNATURE_LIST *) ((UINT8 *) DbxList + DbxList->SignatureListSize);\r | |
949 | }\r | |
950 | \r | |
951 | Done:\r | |
952 | if (HashCtx != NULL) {\r | |
953 | FreePool (HashCtx);\r | |
954 | }\r | |
955 | \r | |
956 | return IsFound;\r | |
957 | }\r | |
958 | \r | |
0c18794e | 959 | /**\r |
960 | Check whether signature is in specified database.\r | |
961 | \r | |
962 | @param[in] VariableName Name of database variable that is searched in.\r | |
963 | @param[in] Signature Pointer to signature that is searched for.\r | |
964 | @param[in] CertType Pointer to hash algrithom.\r | |
965 | @param[in] SignatureSize Size of Signature.\r | |
966 | \r | |
967 | @return TRUE Found the signature in the variable database.\r | |
968 | @return FALSE Not found the signature in the variable database.\r | |
969 | \r | |
970 | **/\r | |
971 | BOOLEAN\r | |
972 | IsSignatureFoundInDatabase (\r | |
973 | IN CHAR16 *VariableName,\r | |
45bf2c47 | 974 | IN UINT8 *Signature,\r |
0c18794e | 975 | IN EFI_GUID *CertType,\r |
976 | IN UINTN SignatureSize\r | |
977 | )\r | |
978 | {\r | |
979 | EFI_STATUS Status;\r | |
980 | EFI_SIGNATURE_LIST *CertList;\r | |
981 | EFI_SIGNATURE_DATA *Cert;\r | |
982 | UINTN DataSize;\r | |
983 | UINT8 *Data;\r | |
984 | UINTN Index;\r | |
985 | UINTN CertCount;\r | |
986 | BOOLEAN IsFound;\r | |
20333c6d | 987 | \r |
0c18794e | 988 | //\r |
989 | // Read signature database variable.\r | |
990 | //\r | |
991 | IsFound = FALSE;\r | |
992 | Data = NULL;\r | |
993 | DataSize = 0;\r | |
994 | Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);\r | |
995 | if (Status != EFI_BUFFER_TOO_SMALL) {\r | |
996 | return FALSE;\r | |
997 | }\r | |
998 | \r | |
999 | Data = (UINT8 *) AllocateZeroPool (DataSize);\r | |
570b3d1a | 1000 | if (Data == NULL) {\r |
1001 | return FALSE;\r | |
1002 | }\r | |
0c18794e | 1003 | \r |
1004 | Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, Data);\r | |
1005 | if (EFI_ERROR (Status)) {\r | |
1006 | goto Done;\r | |
1007 | }\r | |
1008 | //\r | |
1009 | // Enumerate all signature data in SigDB to check if executable's signature exists.\r | |
1010 | //\r | |
1011 | CertList = (EFI_SIGNATURE_LIST *) Data;\r | |
1012 | while ((DataSize > 0) && (DataSize >= CertList->SignatureListSize)) {\r | |
7403ff5b | 1013 | CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r |
0c18794e | 1014 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r |
1015 | if ((CertList->SignatureSize == sizeof(EFI_SIGNATURE_DATA) - 1 + SignatureSize) && (CompareGuid(&CertList->SignatureType, CertType))) {\r | |
1016 | for (Index = 0; Index < CertCount; Index++) {\r | |
1017 | if (CompareMem (Cert->SignatureData, Signature, SignatureSize) == 0) {\r | |
1018 | //\r | |
1019 | // Find the signature in database.\r | |
1020 | //\r | |
1021 | IsFound = TRUE;\r | |
c1d93242 | 1022 | SecureBootHook (VariableName, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, Cert);\r |
0c18794e | 1023 | break;\r |
1024 | }\r | |
1025 | \r | |
1026 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);\r | |
1027 | }\r | |
1028 | \r | |
1029 | if (IsFound) {\r | |
1030 | break;\r | |
1031 | }\r | |
1032 | }\r | |
1033 | \r | |
1034 | DataSize -= CertList->SignatureListSize;\r | |
1035 | CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r | |
1036 | }\r | |
1037 | \r | |
1038 | Done:\r | |
1039 | if (Data != NULL) {\r | |
1040 | FreePool (Data);\r | |
1041 | }\r | |
1042 | \r | |
1043 | return IsFound;\r | |
1044 | }\r | |
1045 | \r | |
1046 | /**\r | |
20333c6d | 1047 | Check whether the timestamp is valid by comparing the signing time and the revocation time.\r |
0c18794e | 1048 | \r |
20333c6d QL |
1049 | @param SigningTime A pointer to the signing time.\r |
1050 | @param RevocationTime A pointer to the revocation time.\r | |
45bf2c47 | 1051 | \r |
20333c6d QL |
1052 | @retval TRUE The SigningTime is not later than the RevocationTime.\r |
1053 | @retval FALSE The SigningTime is later than the RevocationTime.\r | |
0c18794e | 1054 | \r |
1055 | **/\r | |
45bf2c47 | 1056 | BOOLEAN\r |
20333c6d QL |
1057 | IsValidSignatureByTimestamp (\r |
1058 | IN EFI_TIME *SigningTime,\r | |
1059 | IN EFI_TIME *RevocationTime\r | |
1060 | )\r | |
1061 | {\r | |
1062 | if (SigningTime->Year != RevocationTime->Year) {\r | |
1063 | return (BOOLEAN) (SigningTime->Year < RevocationTime->Year);\r | |
1064 | } else if (SigningTime->Month != RevocationTime->Month) {\r | |
1065 | return (BOOLEAN) (SigningTime->Month < RevocationTime->Month);\r | |
1066 | } else if (SigningTime->Day != RevocationTime->Day) {\r | |
1067 | return (BOOLEAN) (SigningTime->Day < RevocationTime->Day);\r | |
1068 | } else if (SigningTime->Hour != RevocationTime->Hour) {\r | |
1069 | return (BOOLEAN) (SigningTime->Hour < RevocationTime->Hour);\r | |
1070 | } else if (SigningTime->Minute != RevocationTime->Minute) {\r | |
1071 | return (BOOLEAN) (SigningTime->Minute < RevocationTime->Minute);\r | |
1072 | }\r | |
1073 | \r | |
1074 | return (BOOLEAN) (SigningTime->Second <= RevocationTime->Second);\r | |
1075 | }\r | |
1076 | \r | |
1077 | /**\r | |
1078 | Check if the given time value is zero.\r | |
1079 | \r | |
1080 | @param[in] Time Pointer of a time value.\r | |
1081 | \r | |
1082 | @retval TRUE The Time is Zero.\r | |
1083 | @retval FALSE The Time is not Zero.\r | |
1084 | \r | |
1085 | **/\r | |
1086 | BOOLEAN\r | |
1087 | IsTimeZero (\r | |
1088 | IN EFI_TIME *Time\r | |
1089 | )\r | |
1090 | {\r | |
1091 | if ((Time->Year == 0) && (Time->Month == 0) && (Time->Day == 0) &&\r | |
1092 | (Time->Hour == 0) && (Time->Minute == 0) && (Time->Second == 0)) {\r | |
1093 | return TRUE;\r | |
1094 | }\r | |
1095 | \r | |
1096 | return FALSE;\r | |
1097 | }\r | |
1098 | \r | |
1099 | /**\r | |
1100 | Check whether the timestamp signature is valid and the signing time is also earlier than \r | |
1101 | the revocation time.\r | |
1102 | \r | |
1103 | @param[in] AuthData Pointer to the Authenticode signature retrieved from signed image.\r | |
1104 | @param[in] AuthDataSize Size of the Authenticode signature in bytes.\r | |
1105 | @param[in] RevocationTime The time that the certificate was revoked.\r | |
1106 | \r | |
1107 | @retval TRUE Timestamp signature is valid and signing time is no later than the \r | |
1108 | revocation time.\r | |
1109 | @retval FALSE Timestamp signature is not valid or the signing time is later than the\r | |
1110 | revocation time.\r | |
1111 | \r | |
1112 | **/\r | |
1113 | BOOLEAN\r | |
1114 | PassTimestampCheck (\r | |
1115 | IN UINT8 *AuthData,\r | |
1116 | IN UINTN AuthDataSize,\r | |
1117 | IN EFI_TIME *RevocationTime\r | |
1118 | )\r | |
1119 | {\r | |
1120 | EFI_STATUS Status;\r | |
1121 | BOOLEAN VerifyStatus;\r | |
1122 | EFI_SIGNATURE_LIST *CertList;\r | |
1123 | EFI_SIGNATURE_DATA *Cert;\r | |
1124 | UINT8 *DbtData;\r | |
1125 | UINTN DbtDataSize;\r | |
1126 | UINT8 *RootCert;\r | |
1127 | UINTN RootCertSize;\r | |
1128 | UINTN Index;\r | |
1129 | UINTN CertCount;\r | |
1130 | EFI_TIME SigningTime;\r | |
1131 | \r | |
1132 | //\r | |
1133 | // Variable Initialization\r | |
1134 | //\r | |
1135 | VerifyStatus = FALSE;\r | |
1136 | DbtData = NULL;\r | |
1137 | CertList = NULL;\r | |
1138 | Cert = NULL;\r | |
1139 | RootCert = NULL;\r | |
1140 | RootCertSize = 0;\r | |
1141 | \r | |
1142 | //\r | |
1143 | // If RevocationTime is zero, the certificate shall be considered to always be revoked.\r | |
1144 | //\r | |
1145 | if (IsTimeZero (RevocationTime)) {\r | |
1146 | return FALSE;\r | |
1147 | }\r | |
1148 | \r | |
1149 | //\r | |
1150 | // RevocationTime is non-zero, the certificate should be considered to be revoked from that time and onwards.\r | |
1151 | // Using the dbt to get the trusted TSA certificates.\r | |
1152 | //\r | |
1153 | DbtDataSize = 0;\r | |
1154 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE2, &gEfiImageSecurityDatabaseGuid, NULL, &DbtDataSize, NULL);\r | |
7e0699c0 QL |
1155 | if (Status != EFI_BUFFER_TOO_SMALL) {\r |
1156 | goto Done;\r | |
1157 | }\r | |
1158 | DbtData = (UINT8 *) AllocateZeroPool (DbtDataSize);\r | |
1159 | if (DbtData == NULL) {\r | |
1160 | goto Done;\r | |
1161 | }\r | |
1162 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE2, &gEfiImageSecurityDatabaseGuid, NULL, &DbtDataSize, (VOID *) DbtData);\r | |
1163 | if (EFI_ERROR (Status)) {\r | |
1164 | goto Done;\r | |
20333c6d QL |
1165 | }\r |
1166 | \r | |
1167 | CertList = (EFI_SIGNATURE_LIST *) DbtData;\r | |
1168 | while ((DbtDataSize > 0) && (DbtDataSize >= CertList->SignatureListSize)) {\r | |
1169 | if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {\r | |
1170 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r | |
1171 | CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r | |
1172 | for (Index = 0; Index < CertCount; Index++) {\r | |
1173 | //\r | |
1174 | // Iterate each Signature Data Node within this CertList for verify.\r | |
1175 | //\r | |
1176 | RootCert = Cert->SignatureData;\r | |
1177 | RootCertSize = CertList->SignatureSize - sizeof (EFI_GUID);\r | |
1178 | //\r | |
1179 | // Get the signing time if the timestamp signature is valid.\r | |
1180 | //\r | |
1181 | if (ImageTimestampVerify (AuthData, AuthDataSize, RootCert, RootCertSize, &SigningTime)) {\r | |
1182 | //\r | |
1183 | // The signer signature is valid only when the signing time is earlier than revocation time.\r | |
1184 | //\r | |
1185 | if (IsValidSignatureByTimestamp (&SigningTime, RevocationTime)) {\r | |
1186 | VerifyStatus = TRUE;\r | |
1187 | goto Done;\r | |
1188 | }\r | |
1189 | }\r | |
1190 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);\r | |
1191 | }\r | |
1192 | }\r | |
1193 | DbtDataSize -= CertList->SignatureListSize;\r | |
1194 | CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r | |
1195 | }\r | |
1196 | \r | |
1197 | Done:\r | |
1198 | if (DbtData != NULL) {\r | |
1199 | FreePool (DbtData);\r | |
1200 | }\r | |
1201 | \r | |
1202 | return VerifyStatus;\r | |
1203 | }\r | |
1204 | \r | |
1205 | /**\r | |
1206 | Check whether the image signature is forbidden by the forbidden database (dbx).\r | |
1207 | The image is forbidden to load if any certificates for signing are revoked before signing time.\r | |
1208 | \r | |
560ac77e ZC |
1209 | @param[in] AuthData Pointer to the Authenticode signature retrieved from the signed image.\r |
1210 | @param[in] AuthDataSize Size of the Authenticode signature in bytes.\r | |
20333c6d QL |
1211 | \r |
1212 | @retval TRUE Image is forbidden by dbx.\r | |
1213 | @retval FALSE Image is not forbidden by dbx.\r | |
1214 | \r | |
1215 | **/\r | |
1216 | BOOLEAN\r | |
560ac77e ZC |
1217 | IsForbiddenByDbx ( \r |
1218 | IN UINT8 *AuthData,\r | |
1219 | IN UINTN AuthDataSize \r | |
20333c6d QL |
1220 | )\r |
1221 | {\r | |
1222 | EFI_STATUS Status;\r | |
1223 | BOOLEAN IsForbidden;\r | |
1224 | UINT8 *Data;\r | |
1225 | UINTN DataSize;\r | |
27c93c06 LQ |
1226 | EFI_SIGNATURE_LIST *CertList;\r |
1227 | UINTN CertListSize;\r | |
1228 | EFI_SIGNATURE_DATA *CertData;\r | |
1229 | UINT8 *RootCert;\r | |
1230 | UINTN RootCertSize;\r | |
1231 | UINTN CertCount;\r | |
20333c6d QL |
1232 | UINTN Index;\r |
1233 | UINT8 *CertBuffer;\r | |
1234 | UINTN BufferLength;\r | |
1235 | UINT8 *TrustedCert;\r | |
1236 | UINTN TrustedCertLength;\r | |
1237 | UINT8 CertNumber;\r | |
1238 | UINT8 *CertPtr;\r | |
1239 | UINT8 *Cert;\r | |
1240 | UINTN CertSize;\r | |
1241 | EFI_TIME RevocationTime;\r | |
20333c6d QL |
1242 | //\r |
1243 | // Variable Initialization\r | |
1244 | //\r | |
1245 | IsForbidden = FALSE;\r | |
1246 | Data = NULL;\r | |
27c93c06 LQ |
1247 | CertList = NULL;\r |
1248 | CertData = NULL;\r | |
1249 | RootCert = NULL;\r | |
1250 | RootCertSize = 0;\r | |
20333c6d QL |
1251 | Cert = NULL;\r |
1252 | CertBuffer = NULL;\r | |
1253 | BufferLength = 0;\r | |
1254 | TrustedCert = NULL;\r | |
1255 | TrustedCertLength = 0;\r | |
1256 | \r | |
1257 | //\r | |
1258 | // The image will not be forbidden if dbx can't be got.\r | |
1259 | //\r | |
1260 | DataSize = 0;\r | |
1261 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);\r | |
7e0699c0 QL |
1262 | if (Status != EFI_BUFFER_TOO_SMALL) {\r |
1263 | return IsForbidden;\r | |
20333c6d | 1264 | }\r |
7e0699c0 QL |
1265 | Data = (UINT8 *) AllocateZeroPool (DataSize);\r |
1266 | if (Data == NULL) {\r | |
1267 | return IsForbidden;\r | |
1268 | }\r | |
1269 | \r | |
1270 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, (VOID *) Data);\r | |
20333c6d QL |
1271 | if (EFI_ERROR (Status)) {\r |
1272 | return IsForbidden;\r | |
1273 | }\r | |
1274 | \r | |
27c93c06 LQ |
1275 | //\r |
1276 | // Verify image signature with RAW X509 certificates in DBX database.\r | |
1277 | // If passed, the image will be forbidden.\r | |
1278 | //\r | |
1279 | CertList = (EFI_SIGNATURE_LIST *) Data;\r | |
1280 | CertListSize = DataSize;\r | |
1281 | while ((CertListSize > 0) && (CertListSize >= CertList->SignatureListSize)) {\r | |
1282 | if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {\r | |
1283 | CertData = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r | |
1284 | CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r | |
1285 | \r | |
1286 | for (Index = 0; Index < CertCount; Index++) {\r | |
1287 | //\r | |
1288 | // Iterate each Signature Data Node within this CertList for verify.\r | |
1289 | //\r | |
1290 | RootCert = CertData->SignatureData;\r | |
1291 | RootCertSize = CertList->SignatureSize - sizeof (EFI_GUID);\r | |
1292 | \r | |
1293 | //\r | |
1294 | // Call AuthenticodeVerify library to Verify Authenticode struct.\r | |
1295 | //\r | |
1296 | IsForbidden = AuthenticodeVerify (\r | |
1297 | AuthData,\r | |
1298 | AuthDataSize,\r | |
1299 | RootCert,\r | |
1300 | RootCertSize,\r | |
1301 | mImageDigest,\r | |
1302 | mImageDigestSize\r | |
1303 | );\r | |
1304 | if (IsForbidden) {\r | |
d863e127 | 1305 | SecureBootHook (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, CertData);\r |
27c93c06 LQ |
1306 | goto Done;\r |
1307 | }\r | |
1308 | \r | |
1309 | CertData = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertData + CertList->SignatureSize);\r | |
1310 | }\r | |
1311 | }\r | |
1312 | \r | |
1313 | CertListSize -= CertList->SignatureListSize;\r | |
1314 | CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r | |
1315 | }\r | |
1316 | \r | |
1317 | //\r | |
1318 | // Check X.509 Certificate Hash & Possible Timestamp.\r | |
1319 | //\r | |
1320 | \r | |
20333c6d QL |
1321 | //\r |
1322 | // Retrieve the certificate stack from AuthData\r | |
1323 | // The output CertStack format will be:\r | |
1324 | // UINT8 CertNumber;\r | |
1325 | // UINT32 Cert1Length;\r | |
1326 | // UINT8 Cert1[];\r | |
1327 | // UINT32 Cert2Length;\r | |
1328 | // UINT8 Cert2[];\r | |
1329 | // ...\r | |
1330 | // UINT32 CertnLength;\r | |
1331 | // UINT8 Certn[];\r | |
1332 | //\r | |
1333 | Pkcs7GetSigners (AuthData, AuthDataSize, &CertBuffer, &BufferLength, &TrustedCert, &TrustedCertLength);\r | |
7e0699c0 | 1334 | if ((BufferLength == 0) || (CertBuffer == NULL)) {\r |
20333c6d QL |
1335 | IsForbidden = TRUE;\r |
1336 | goto Done;\r | |
1337 | }\r | |
1338 | \r | |
1339 | //\r | |
27c93c06 | 1340 | // Check if any hash of certificates embedded in AuthData is in the forbidden database.\r |
20333c6d QL |
1341 | //\r |
1342 | CertNumber = (UINT8) (*CertBuffer);\r | |
1343 | CertPtr = CertBuffer + 1;\r | |
1344 | for (Index = 0; Index < CertNumber; Index++) {\r | |
1345 | CertSize = (UINTN) ReadUnaligned32 ((UINT32 *)CertPtr);\r | |
1346 | Cert = (UINT8 *)CertPtr + sizeof (UINT32);\r | |
91422384 ZC |
1347 | //\r |
1348 | // Advance CertPtr to the next cert in image signer's cert list\r | |
1349 | //\r | |
1350 | CertPtr = CertPtr + sizeof (UINT32) + CertSize;\r | |
20333c6d QL |
1351 | \r |
1352 | if (IsCertHashFoundInDatabase (Cert, CertSize, (EFI_SIGNATURE_LIST *)Data, DataSize, &RevocationTime)) {\r | |
1353 | //\r | |
1354 | // Check the timestamp signature and signing time to determine if the image can be trusted.\r | |
1355 | //\r | |
1356 | IsForbidden = TRUE;\r | |
1357 | if (PassTimestampCheck (AuthData, AuthDataSize, &RevocationTime)) {\r | |
1358 | IsForbidden = FALSE;\r | |
91422384 ZC |
1359 | //\r |
1360 | // Pass DBT check. Continue to check other certs in image signer's cert list against DBX, DBT\r | |
1361 | //\r | |
1362 | continue;\r | |
20333c6d QL |
1363 | }\r |
1364 | goto Done;\r | |
1365 | }\r | |
1366 | \r | |
20333c6d QL |
1367 | }\r |
1368 | \r | |
1369 | Done:\r | |
1370 | if (Data != NULL) {\r | |
1371 | FreePool (Data);\r | |
1372 | }\r | |
1373 | \r | |
1374 | Pkcs7FreeSigners (CertBuffer);\r | |
1375 | Pkcs7FreeSigners (TrustedCert);\r | |
1376 | \r | |
1377 | return IsForbidden;\r | |
1378 | }\r | |
1379 | \r | |
4fc08e8d | 1380 | \r |
20333c6d QL |
1381 | /**\r |
1382 | Check whether the image signature can be verified by the trusted certificates in DB database.\r | |
1383 | \r | |
560ac77e ZC |
1384 | @param[in] AuthData Pointer to the Authenticode signature retrieved from signed image.\r |
1385 | @param[in] AuthDataSize Size of the Authenticode signature in bytes.\r | |
20333c6d QL |
1386 | \r |
1387 | @retval TRUE Image passed verification using certificate in db.\r | |
1388 | @retval FALSE Image didn't pass verification using certificate in db.\r | |
1389 | \r | |
1390 | **/\r | |
1391 | BOOLEAN\r | |
1392 | IsAllowedByDb (\r | |
560ac77e ZC |
1393 | IN UINT8 *AuthData,\r |
1394 | IN UINTN AuthDataSize\r | |
0c18794e | 1395 | )\r |
1396 | {\r | |
1397 | EFI_STATUS Status;\r | |
1398 | BOOLEAN VerifyStatus;\r | |
0c18794e | 1399 | EFI_SIGNATURE_LIST *CertList;\r |
4fc08e8d | 1400 | EFI_SIGNATURE_DATA *CertData;\r |
0c18794e | 1401 | UINTN DataSize;\r |
45bf2c47 | 1402 | UINT8 *Data;\r |
0c18794e | 1403 | UINT8 *RootCert;\r |
1404 | UINTN RootCertSize;\r | |
1405 | UINTN Index;\r | |
1406 | UINTN CertCount;\r | |
27c93c06 LQ |
1407 | UINTN DbxDataSize;\r |
1408 | UINT8 *DbxData;\r | |
1409 | EFI_TIME RevocationTime;\r | |
0c18794e | 1410 | \r |
4fc08e8d CZ |
1411 | Data = NULL;\r |
1412 | CertList = NULL;\r | |
1413 | CertData = NULL;\r | |
1414 | RootCert = NULL;\r | |
1415 | DbxData = NULL;\r | |
1416 | RootCertSize = 0;\r | |
1417 | VerifyStatus = FALSE;\r | |
0c18794e | 1418 | \r |
0c18794e | 1419 | DataSize = 0;\r |
20333c6d | 1420 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);\r |
0c18794e | 1421 | if (Status == EFI_BUFFER_TOO_SMALL) {\r |
45bf2c47 | 1422 | Data = (UINT8 *) AllocateZeroPool (DataSize);\r |
1423 | if (Data == NULL) {\r | |
1424 | return VerifyStatus;\r | |
570b3d1a | 1425 | }\r |
0c18794e | 1426 | \r |
20333c6d | 1427 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, (VOID *) Data);\r |
0c18794e | 1428 | if (EFI_ERROR (Status)) {\r |
1429 | goto Done;\r | |
1430 | }\r | |
45bf2c47 | 1431 | \r |
1432 | //\r | |
1433 | // Find X509 certificate in Signature List to verify the signature in pkcs7 signed data.\r | |
0c18794e | 1434 | //\r |
45bf2c47 | 1435 | CertList = (EFI_SIGNATURE_LIST *) Data;\r |
0c18794e | 1436 | while ((DataSize > 0) && (DataSize >= CertList->SignatureListSize)) {\r |
1437 | if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {\r | |
4fc08e8d CZ |
1438 | CertData = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r |
1439 | CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r | |
20333c6d | 1440 | \r |
0c18794e | 1441 | for (Index = 0; Index < CertCount; Index++) {\r |
1442 | //\r | |
45bf2c47 | 1443 | // Iterate each Signature Data Node within this CertList for verify.\r |
1444 | //\r | |
4fc08e8d | 1445 | RootCert = CertData->SignatureData;\r |
20333c6d | 1446 | RootCertSize = CertList->SignatureSize - sizeof (EFI_GUID);\r |
45bf2c47 | 1447 | \r |
0c18794e | 1448 | //\r |
45bf2c47 | 1449 | // Call AuthenticodeVerify library to Verify Authenticode struct.\r |
0c18794e | 1450 | //\r |
1451 | VerifyStatus = AuthenticodeVerify (\r | |
f6f9031f | 1452 | AuthData,\r |
1453 | AuthDataSize,\r | |
0c18794e | 1454 | RootCert,\r |
1455 | RootCertSize,\r | |
1456 | mImageDigest,\r | |
1457 | mImageDigestSize\r | |
1458 | );\r | |
0c18794e | 1459 | if (VerifyStatus) {\r |
27c93c06 LQ |
1460 | //\r |
1461 | // Here We still need to check if this RootCert's Hash is revoked\r | |
1462 | //\r | |
1463 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DbxDataSize, NULL);\r | |
1464 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
1465 | goto Done;\r | |
1466 | }\r | |
1ca3a099 | 1467 | DbxData = (UINT8 *) AllocateZeroPool (DbxDataSize);\r |
27c93c06 LQ |
1468 | if (DbxData == NULL) {\r |
1469 | goto Done;\r | |
1470 | }\r | |
1471 | \r | |
1472 | Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DbxDataSize, (VOID *) DbxData);\r | |
1473 | if (EFI_ERROR (Status)) {\r | |
1474 | goto Done;\r | |
1475 | }\r | |
1476 | \r | |
1477 | if (IsCertHashFoundInDatabase (RootCert, RootCertSize, (EFI_SIGNATURE_LIST *)DbxData, DbxDataSize, &RevocationTime)) {\r | |
1478 | //\r | |
1479 | // Check the timestamp signature and signing time to determine if the image can be trusted.\r | |
1480 | //\r | |
1481 | VerifyStatus = PassTimestampCheck (AuthData, AuthDataSize, &RevocationTime);\r | |
1482 | }\r | |
1483 | \r | |
0c18794e | 1484 | goto Done;\r |
1485 | }\r | |
20333c6d | 1486 | \r |
4fc08e8d | 1487 | CertData = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertData + CertList->SignatureSize);\r |
45bf2c47 | 1488 | }\r |
0c18794e | 1489 | }\r |
20333c6d | 1490 | \r |
0c18794e | 1491 | DataSize -= CertList->SignatureListSize;\r |
1492 | CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r | |
1493 | }\r | |
1494 | }\r | |
1495 | \r | |
45bf2c47 | 1496 | Done:\r |
4fc08e8d | 1497 | \r |
27c93c06 | 1498 | if (VerifyStatus) {\r |
4fc08e8d | 1499 | SecureBootHook (EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, CertData);\r |
27c93c06 LQ |
1500 | }\r |
1501 | \r | |
45bf2c47 | 1502 | if (Data != NULL) {\r |
1503 | FreePool (Data);\r | |
1504 | }\r | |
27c93c06 LQ |
1505 | if (DbxData != NULL) {\r |
1506 | FreePool (DbxData);\r | |
1507 | }\r | |
0c18794e | 1508 | \r |
45bf2c47 | 1509 | return VerifyStatus;\r |
1510 | }\r | |
0c18794e | 1511 | \r |
0c18794e | 1512 | /**\r |
1513 | Provide verification service for signed images, which include both signature validation\r | |
45bf2c47 | 1514 | and platform policy control. For signature types, both UEFI WIN_CERTIFICATE_UEFI_GUID and\r |
0c18794e | 1515 | MSFT Authenticode type signatures are supported.\r |
0c18794e | 1516 | \r |
45bf2c47 | 1517 | In this implementation, only verify external executables when in USER MODE.\r |
1518 | Executables from FV is bypass, so pass in AuthenticationStatus is ignored.\r | |
1519 | \r | |
6de4c35f | 1520 | The image verification policy is:\r |
50fe73a1 | 1521 | If the image is signed,\r |
6de4c35f | 1522 | At least one valid signature or at least one hash value of the image must match a record\r |
1523 | in the security database "db", and no valid signature nor any hash value of the image may\r | |
1524 | be reflected in the security database "dbx".\r | |
50fe73a1 | 1525 | Otherwise, the image is not signed,\r |
6de4c35f | 1526 | The SHA256 hash value of the image must match a record in the security database "db", and\r |
1527 | not be reflected in the security data base "dbx".\r | |
45bf2c47 | 1528 | \r |
dc204d5a JY |
1529 | Caution: This function may receive untrusted input.\r |
1530 | PE/COFF image is external input, so this function will validate its data structure\r | |
1531 | within this image buffer before use.\r | |
1532 | \r | |
45bf2c47 | 1533 | @param[in] AuthenticationStatus\r |
0c18794e | 1534 | This is the authentication status returned from the security\r |
1535 | measurement services for the input file.\r | |
1536 | @param[in] File This is a pointer to the device path of the file that is\r | |
1537 | being dispatched. This will optionally be used for logging.\r | |
1538 | @param[in] FileBuffer File buffer matches the input file device path.\r | |
1539 | @param[in] FileSize Size of File buffer matches the input file device path.\r | |
5db28a67 LG |
1540 | @param[in] BootPolicy A boot policy that was used to call LoadImage() UEFI service.\r |
1541 | \r | |
1542 | @retval EFI_SUCCESS The file specified by DevicePath and non-NULL\r | |
1543 | FileBuffer did authenticate, and the platform policy dictates\r | |
1544 | that the DXE Foundation may use the file.\r | |
1545 | @retval EFI_SUCCESS The device path specified by NULL device path DevicePath\r | |
1546 | and non-NULL FileBuffer did authenticate, and the platform\r | |
1547 | policy dictates that the DXE Foundation may execute the image in\r | |
1548 | FileBuffer.\r | |
570b3d1a | 1549 | @retval EFI_OUT_RESOURCE Fail to allocate memory.\r |
0c18794e | 1550 | @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r |
1551 | the platform policy dictates that File should be placed\r | |
5db28a67 LG |
1552 | in the untrusted state. The image has been added to the file\r |
1553 | execution table.\r | |
1554 | @retval EFI_ACCESS_DENIED The file specified by File and FileBuffer did not\r | |
1555 | authenticate, and the platform policy dictates that the DXE\r | |
1556 | Foundation many not use File.\r | |
0c18794e | 1557 | \r |
1558 | **/\r | |
1559 | EFI_STATUS\r | |
1560 | EFIAPI\r | |
1561 | DxeImageVerificationHandler (\r | |
1562 | IN UINT32 AuthenticationStatus,\r | |
1563 | IN CONST EFI_DEVICE_PATH_PROTOCOL *File,\r | |
1564 | IN VOID *FileBuffer,\r | |
5db28a67 LG |
1565 | IN UINTN FileSize,\r |
1566 | IN BOOLEAN BootPolicy\r | |
0c18794e | 1567 | )\r |
0c18794e | 1568 | {\r |
551d8081 | 1569 | EFI_STATUS Status;\r |
1570 | UINT16 Magic;\r | |
1571 | EFI_IMAGE_DOS_HEADER *DosHdr;\r | |
1572 | EFI_STATUS VerifyStatus;\r | |
551d8081 | 1573 | EFI_SIGNATURE_LIST *SignatureList;\r |
1574 | UINTN SignatureListSize;\r | |
1575 | EFI_SIGNATURE_DATA *Signature;\r | |
1576 | EFI_IMAGE_EXECUTION_ACTION Action;\r | |
1577 | WIN_CERTIFICATE *WinCertificate;\r | |
1578 | UINT32 Policy;\r | |
560ac77e | 1579 | UINT8 *SecureBoot;\r |
551d8081 | 1580 | PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r |
1581 | UINT32 NumberOfRvaAndSizes;\r | |
f6f9031f | 1582 | WIN_CERTIFICATE_EFI_PKCS *PkcsCertData;\r |
1583 | WIN_CERTIFICATE_UEFI_GUID *WinCertUefiGuid;\r | |
1584 | UINT8 *AuthData;\r | |
1585 | UINTN AuthDataSize;\r | |
1586 | EFI_IMAGE_DATA_DIRECTORY *SecDataDir;\r | |
6de4c35f | 1587 | UINT32 OffSet;\r |
213cc100 | 1588 | CHAR16 *NameStr;\r |
0c18794e | 1589 | \r |
0c18794e | 1590 | SignatureList = NULL;\r |
1591 | SignatureListSize = 0;\r | |
1592 | WinCertificate = NULL;\r | |
f6f9031f | 1593 | SecDataDir = NULL;\r |
1594 | PkcsCertData = NULL;\r | |
0c18794e | 1595 | Action = EFI_IMAGE_EXECUTION_AUTH_UNTESTED;\r |
1596 | Status = EFI_ACCESS_DENIED;\r | |
6de4c35f | 1597 | VerifyStatus = EFI_ACCESS_DENIED;\r |
1598 | \r | |
4fc08e8d | 1599 | \r |
0c18794e | 1600 | //\r |
1601 | // Check the image type and get policy setting.\r | |
1602 | //\r | |
1603 | switch (GetImageType (File)) {\r | |
45bf2c47 | 1604 | \r |
0c18794e | 1605 | case IMAGE_FROM_FV:\r |
1606 | Policy = ALWAYS_EXECUTE;\r | |
1607 | break;\r | |
1608 | \r | |
1609 | case IMAGE_FROM_OPTION_ROM:\r | |
1610 | Policy = PcdGet32 (PcdOptionRomImageVerificationPolicy);\r | |
1611 | break;\r | |
1612 | \r | |
1613 | case IMAGE_FROM_REMOVABLE_MEDIA:\r | |
1614 | Policy = PcdGet32 (PcdRemovableMediaImageVerificationPolicy);\r | |
1615 | break;\r | |
1616 | \r | |
1617 | case IMAGE_FROM_FIXED_MEDIA:\r | |
1618 | Policy = PcdGet32 (PcdFixedMediaImageVerificationPolicy);\r | |
1619 | break;\r | |
1620 | \r | |
1621 | default:\r | |
45bf2c47 | 1622 | Policy = DENY_EXECUTE_ON_SECURITY_VIOLATION;\r |
0c18794e | 1623 | break;\r |
1624 | }\r | |
1625 | //\r | |
1626 | // If policy is always/never execute, return directly.\r | |
1627 | //\r | |
1628 | if (Policy == ALWAYS_EXECUTE) {\r | |
1629 | return EFI_SUCCESS;\r | |
1630 | } else if (Policy == NEVER_EXECUTE) {\r | |
1631 | return EFI_ACCESS_DENIED;\r | |
1632 | }\r | |
beda2356 | 1633 | \r |
db44ea6c | 1634 | //\r |
20333c6d | 1635 | // The policy QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION\r |
68fc0c73 | 1636 | // violates the UEFI spec and has been removed.\r |
db44ea6c | 1637 | //\r |
68fc0c73 FS |
1638 | ASSERT (Policy != QUERY_USER_ON_SECURITY_VIOLATION && Policy != ALLOW_EXECUTE_ON_SECURITY_VIOLATION);\r |
1639 | if (Policy == QUERY_USER_ON_SECURITY_VIOLATION || Policy == ALLOW_EXECUTE_ON_SECURITY_VIOLATION) {\r | |
db44ea6c FS |
1640 | CpuDeadLoop ();\r |
1641 | }\r | |
1642 | \r | |
560ac77e | 1643 | GetEfiGlobalVariable2 (EFI_SECURE_BOOT_MODE_NAME, (VOID**)&SecureBoot, NULL);\r |
beda2356 | 1644 | //\r |
8f8ca22e | 1645 | // Skip verification if SecureBoot variable doesn't exist.\r |
beda2356 | 1646 | //\r |
560ac77e | 1647 | if (SecureBoot == NULL) {\r |
beda2356 | 1648 | return EFI_SUCCESS;\r |
1649 | }\r | |
1650 | \r | |
1651 | //\r | |
4fc08e8d | 1652 | // Skip verification if SecureBoot is disabled but not AuditMode\r |
beda2356 | 1653 | //\r |
560ac77e ZC |
1654 | if (*SecureBoot == SECURE_BOOT_MODE_DISABLE) {\r |
1655 | FreePool (SecureBoot);\r | |
beda2356 | 1656 | return EFI_SUCCESS;\r |
45bf2c47 | 1657 | }\r |
560ac77e | 1658 | FreePool (SecureBoot);\r |
551d8081 | 1659 | \r |
0c18794e | 1660 | //\r |
1661 | // Read the Dos header.\r | |
1662 | //\r | |
570b3d1a | 1663 | if (FileBuffer == NULL) {\r |
570b3d1a | 1664 | return EFI_INVALID_PARAMETER;\r |
1665 | }\r | |
551d8081 | 1666 | \r |
0c18794e | 1667 | mImageBase = (UINT8 *) FileBuffer;\r |
1668 | mImageSize = FileSize;\r | |
28186d45 ED |
1669 | \r |
1670 | ZeroMem (&ImageContext, sizeof (ImageContext));\r | |
1671 | ImageContext.Handle = (VOID *) FileBuffer;\r | |
e0192326 | 1672 | ImageContext.ImageRead = (PE_COFF_LOADER_READ_FILE) DxeImageVerificationLibImageRead;\r |
28186d45 ED |
1673 | \r |
1674 | //\r | |
1675 | // Get information about the image being loaded\r | |
1676 | //\r | |
1677 | Status = PeCoffLoaderGetImageInfo (&ImageContext);\r | |
1678 | if (EFI_ERROR (Status)) {\r | |
1679 | //\r | |
1680 | // The information can't be got from the invalid PeImage\r | |
1681 | //\r | |
1682 | goto Done;\r | |
1683 | }\r | |
1684 | \r | |
badd40f9 | 1685 | Status = EFI_ACCESS_DENIED;\r |
1686 | \r | |
1687 | DosHdr = (EFI_IMAGE_DOS_HEADER *) mImageBase;\r | |
0c18794e | 1688 | if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r |
1689 | //\r | |
45bf2c47 | 1690 | // DOS image header is present,\r |
0c18794e | 1691 | // so read the PE header after the DOS image header.\r |
1692 | //\r | |
1693 | mPeCoffHeaderOffset = DosHdr->e_lfanew;\r | |
1694 | } else {\r | |
1695 | mPeCoffHeaderOffset = 0;\r | |
1696 | }\r | |
1697 | //\r | |
1698 | // Check PE/COFF image.\r | |
1699 | //\r | |
1700 | mNtHeader.Pe32 = (EFI_IMAGE_NT_HEADERS32 *) (mImageBase + mPeCoffHeaderOffset);\r | |
1701 | if (mNtHeader.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {\r | |
1702 | //\r | |
1703 | // It is not a valid Pe/Coff file.\r | |
1704 | //\r | |
551d8081 | 1705 | goto Done;\r |
0c18794e | 1706 | }\r |
1707 | \r | |
de2447dd | 1708 | if (mNtHeader.Pe32->FileHeader.Machine == IMAGE_FILE_MACHINE_IA64 && mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
1709 | //\r | |
20333c6d QL |
1710 | // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value\r |
1711 | // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the\r | |
de2447dd | 1712 | // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC\r |
1713 | // then override the magic value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC\r | |
1714 | //\r | |
1715 | Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;\r | |
1716 | } else {\r | |
1717 | //\r | |
1718 | // Get the magic value from the PE/COFF Optional Header\r | |
1719 | //\r | |
1720 | Magic = mNtHeader.Pe32->OptionalHeader.Magic;\r | |
1721 | }\r | |
20333c6d | 1722 | \r |
0c18794e | 1723 | if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r |
1724 | //\r | |
1725 | // Use PE32 offset.\r | |
1726 | //\r | |
551d8081 | 1727 | NumberOfRvaAndSizes = mNtHeader.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r |
1728 | if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_SECURITY) {\r | |
f6f9031f | 1729 | SecDataDir = (EFI_IMAGE_DATA_DIRECTORY *) &mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY];\r |
20333c6d | 1730 | }\r |
570b3d1a | 1731 | } else {\r |
1732 | //\r | |
551d8081 | 1733 | // Use PE32+ offset.\r |
570b3d1a | 1734 | //\r |
551d8081 | 1735 | NumberOfRvaAndSizes = mNtHeader.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r |
1736 | if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_SECURITY) {\r | |
f6f9031f | 1737 | SecDataDir = (EFI_IMAGE_DATA_DIRECTORY *) &mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY];\r |
551d8081 | 1738 | }\r |
0c18794e | 1739 | }\r |
1740 | \r | |
6de4c35f | 1741 | //\r |
1742 | // Start Image Validation.\r | |
1743 | //\r | |
1744 | if (SecDataDir == NULL || SecDataDir->Size == 0) {\r | |
0c18794e | 1745 | //\r |
20333c6d | 1746 | // This image is not signed. The SHA256 hash value of the image must match a record in the security database "db",\r |
6de4c35f | 1747 | // and not be reflected in the security data base "dbx".\r |
0c18794e | 1748 | //\r |
45bf2c47 | 1749 | if (!HashPeImage (HASHALG_SHA256)) {\r |
1750 | goto Done;\r | |
1751 | }\r | |
1752 | \r | |
1753 | if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE1, mImageDigest, &mCertType, mImageDigestSize)) {\r | |
1754 | //\r | |
1755 | // Image Hash is in forbidden database (DBX).\r | |
1756 | //\r | |
45bf2c47 | 1757 | goto Done;\r |
1758 | }\r | |
1759 | \r | |
1760 | if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE, mImageDigest, &mCertType, mImageDigestSize)) {\r | |
1761 | //\r | |
1762 | // Image Hash is in allowed database (DB).\r | |
1763 | //\r | |
1764 | return EFI_SUCCESS;\r | |
1765 | }\r | |
1766 | \r | |
1767 | //\r | |
1768 | // Image Hash is not found in both forbidden and allowed database.\r | |
1769 | //\r | |
45bf2c47 | 1770 | goto Done;\r |
0c18794e | 1771 | }\r |
45bf2c47 | 1772 | \r |
0c18794e | 1773 | //\r |
20333c6d | 1774 | // Verify the signature of the image, multiple signatures are allowed as per PE/COFF Section 4.7\r |
6de4c35f | 1775 | // "Attribute Certificate Table".\r |
1776 | // The first certificate starts at offset (SecDataDir->VirtualAddress) from the start of the file.\r | |
0c18794e | 1777 | //\r |
6de4c35f | 1778 | for (OffSet = SecDataDir->VirtualAddress;\r |
1779 | OffSet < (SecDataDir->VirtualAddress + SecDataDir->Size);\r | |
2bf41ed7 | 1780 | OffSet += (WinCertificate->dwLength + ALIGN_SIZE (WinCertificate->dwLength))) {\r |
6de4c35f | 1781 | WinCertificate = (WIN_CERTIFICATE *) (mImageBase + OffSet);\r |
1782 | if ((SecDataDir->VirtualAddress + SecDataDir->Size - OffSet) <= sizeof (WIN_CERTIFICATE) ||\r | |
1783 | (SecDataDir->VirtualAddress + SecDataDir->Size - OffSet) < WinCertificate->dwLength) {\r | |
1784 | break;\r | |
1785 | }\r | |
20333c6d | 1786 | \r |
0c18794e | 1787 | //\r |
6de4c35f | 1788 | // Verify the image's Authenticode signature, only DER-encoded PKCS#7 signed data is supported.\r |
0c18794e | 1789 | //\r |
6de4c35f | 1790 | if (WinCertificate->wCertificateType == WIN_CERT_TYPE_PKCS_SIGNED_DATA) {\r |
1791 | //\r | |
20333c6d | 1792 | // The certificate is formatted as WIN_CERTIFICATE_EFI_PKCS which is described in the\r |
6de4c35f | 1793 | // Authenticode specification.\r |
1794 | //\r | |
1795 | PkcsCertData = (WIN_CERTIFICATE_EFI_PKCS *) WinCertificate;\r | |
1796 | if (PkcsCertData->Hdr.dwLength <= sizeof (PkcsCertData->Hdr)) {\r | |
1797 | break;\r | |
1798 | }\r | |
1799 | AuthData = PkcsCertData->CertData;\r | |
1800 | AuthDataSize = PkcsCertData->Hdr.dwLength - sizeof(PkcsCertData->Hdr);\r | |
1801 | } else if (WinCertificate->wCertificateType == WIN_CERT_TYPE_EFI_GUID) {\r | |
1802 | //\r | |
1803 | // The certificate is formatted as WIN_CERTIFICATE_UEFI_GUID which is described in UEFI Spec.\r | |
1804 | //\r | |
1805 | WinCertUefiGuid = (WIN_CERTIFICATE_UEFI_GUID *) WinCertificate;\r | |
1806 | if (WinCertUefiGuid->Hdr.dwLength <= OFFSET_OF(WIN_CERTIFICATE_UEFI_GUID, CertData)) {\r | |
1807 | break;\r | |
1808 | }\r | |
1809 | if (!CompareGuid (&WinCertUefiGuid->CertType, &gEfiCertPkcs7Guid)) {\r | |
1810 | continue;\r | |
1811 | }\r | |
1812 | AuthData = WinCertUefiGuid->CertData;\r | |
1813 | AuthDataSize = WinCertUefiGuid->Hdr.dwLength - OFFSET_OF(WIN_CERTIFICATE_UEFI_GUID, CertData);\r | |
1814 | } else {\r | |
1815 | if (WinCertificate->dwLength < sizeof (WIN_CERTIFICATE)) {\r | |
1816 | break;\r | |
1817 | }\r | |
1818 | continue;\r | |
84bce75b | 1819 | }\r |
6de4c35f | 1820 | \r |
f6f9031f | 1821 | Status = HashPeImageByType (AuthData, AuthDataSize);\r |
45bf2c47 | 1822 | if (EFI_ERROR (Status)) {\r |
6de4c35f | 1823 | continue;\r |
0c18794e | 1824 | }\r |
20333c6d | 1825 | \r |
f6f9031f | 1826 | //\r |
6de4c35f | 1827 | // Check the digital signature against the revoked certificate in forbidden database (dbx).\r |
f6f9031f | 1828 | //\r |
560ac77e | 1829 | if (IsForbiddenByDbx (AuthData, AuthDataSize)) {\r |
6de4c35f | 1830 | Action = EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED;\r |
1831 | VerifyStatus = EFI_ACCESS_DENIED;\r | |
1832 | break;\r | |
f6f9031f | 1833 | }\r |
0c18794e | 1834 | \r |
1835 | //\r | |
6de4c35f | 1836 | // Check the digital signature against the valid certificate in allowed database (db).\r |
0c18794e | 1837 | //\r |
6de4c35f | 1838 | if (EFI_ERROR (VerifyStatus)) {\r |
560ac77e | 1839 | if (IsAllowedByDb (AuthData, AuthDataSize)) {\r |
6de4c35f | 1840 | VerifyStatus = EFI_SUCCESS;\r |
1841 | }\r | |
0c18794e | 1842 | }\r |
6de4c35f | 1843 | \r |
0c18794e | 1844 | //\r |
6de4c35f | 1845 | // Check the image's hash value.\r |
0c18794e | 1846 | //\r |
6de4c35f | 1847 | if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE1, mImageDigest, &mCertType, mImageDigestSize)) {\r |
1848 | Action = EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND;\r | |
1849 | VerifyStatus = EFI_ACCESS_DENIED;\r | |
1850 | break;\r | |
1851 | } else if (EFI_ERROR (VerifyStatus)) {\r | |
1852 | if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE, mImageDigest, &mCertType, mImageDigestSize)) {\r | |
1853 | VerifyStatus = EFI_SUCCESS;\r | |
1854 | }\r | |
45bf2c47 | 1855 | }\r |
50fe73a1 | 1856 | }\r |
1857 | \r | |
6de4c35f | 1858 | if (OffSet != (SecDataDir->VirtualAddress + SecDataDir->Size)) {\r |
0c18794e | 1859 | //\r |
6de4c35f | 1860 | // The Size in Certificate Table or the attribute certicate table is corrupted.\r |
0c18794e | 1861 | //\r |
6de4c35f | 1862 | VerifyStatus = EFI_ACCESS_DENIED;\r |
1863 | }\r | |
20333c6d | 1864 | \r |
6de4c35f | 1865 | if (!EFI_ERROR (VerifyStatus)) {\r |
1866 | return EFI_SUCCESS;\r | |
1867 | } else {\r | |
1868 | Status = EFI_ACCESS_DENIED;\r | |
1869 | if (Action == EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED || Action == EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND) {\r | |
1870 | //\r | |
1871 | // Get image hash value as executable's signature.\r | |
1872 | //\r | |
1873 | SignatureListSize = sizeof (EFI_SIGNATURE_LIST) + sizeof (EFI_SIGNATURE_DATA) - 1 + mImageDigestSize;\r | |
1874 | SignatureList = (EFI_SIGNATURE_LIST *) AllocateZeroPool (SignatureListSize);\r | |
1875 | if (SignatureList == NULL) {\r | |
1876 | Status = EFI_OUT_OF_RESOURCES;\r | |
1877 | goto Done;\r | |
1878 | }\r | |
1879 | SignatureList->SignatureHeaderSize = 0;\r | |
1880 | SignatureList->SignatureListSize = (UINT32) SignatureListSize;\r | |
13a220a9 | 1881 | SignatureList->SignatureSize = (UINT32) (sizeof (EFI_SIGNATURE_DATA) - 1 + mImageDigestSize);\r |
6de4c35f | 1882 | CopyMem (&SignatureList->SignatureType, &mCertType, sizeof (EFI_GUID));\r |
1883 | Signature = (EFI_SIGNATURE_DATA *) ((UINT8 *) SignatureList + sizeof (EFI_SIGNATURE_LIST));\r | |
1884 | CopyMem (Signature->SignatureData, mImageDigest, mImageDigestSize);\r | |
50fe73a1 | 1885 | }\r |
0c18794e | 1886 | }\r |
1887 | \r | |
1888 | Done:\r | |
1889 | if (Status != EFI_SUCCESS) {\r | |
1890 | //\r | |
1891 | // Policy decides to defer or reject the image; add its information in image executable information table.\r | |
1892 | //\r | |
213cc100 DG |
1893 | NameStr = ConvertDevicePathToText (File, FALSE, TRUE);\r |
1894 | AddImageExeInfo (Action, NameStr, File, SignatureList, SignatureListSize);\r | |
1895 | if (NameStr != NULL) {\r | |
1896 | DEBUG((EFI_D_INFO, "The image doesn't pass verification: %s\n", NameStr));\r | |
1897 | FreePool(NameStr);\r | |
1898 | }\r | |
5db28a67 | 1899 | Status = EFI_SECURITY_VIOLATION;\r |
0c18794e | 1900 | }\r |
1901 | \r | |
1902 | if (SignatureList != NULL) {\r | |
1903 | FreePool (SignatureList);\r | |
1904 | }\r | |
1905 | \r | |
0c18794e | 1906 | return Status;\r |
1907 | }\r | |
1908 | \r | |
ffccb935 DG |
1909 | /**\r |
1910 | On Ready To Boot Services Event notification handler.\r | |
1911 | \r | |
1912 | Add the image execution information table if it is not in system configuration table.\r | |
1913 | \r | |
1914 | @param[in] Event Event whose notification function is being invoked\r | |
1915 | @param[in] Context Pointer to the notification function's context\r | |
1916 | \r | |
1917 | **/\r | |
1918 | VOID\r | |
1919 | EFIAPI\r | |
1920 | OnReadyToBoot (\r | |
1921 | IN EFI_EVENT Event,\r | |
1922 | IN VOID *Context\r | |
1923 | )\r | |
1924 | {\r | |
1925 | EFI_IMAGE_EXECUTION_INFO_TABLE *ImageExeInfoTable;\r | |
1926 | UINTN ImageExeInfoTableSize;\r | |
1927 | \r | |
1928 | EfiGetSystemConfigurationTable (&gEfiImageSecurityDatabaseGuid, (VOID **) &ImageExeInfoTable);\r | |
1929 | if (ImageExeInfoTable != NULL) {\r | |
1930 | return;\r | |
1931 | }\r | |
1932 | \r | |
1933 | ImageExeInfoTableSize = sizeof (EFI_IMAGE_EXECUTION_INFO_TABLE);\r | |
1934 | ImageExeInfoTable = (EFI_IMAGE_EXECUTION_INFO_TABLE *) AllocateRuntimePool (ImageExeInfoTableSize);\r | |
1935 | if (ImageExeInfoTable == NULL) {\r | |
1936 | return ;\r | |
1937 | }\r | |
1938 | \r | |
20333c6d | 1939 | ImageExeInfoTable->NumberOfImages = 0;\r |
ffccb935 DG |
1940 | gBS->InstallConfigurationTable (&gEfiImageSecurityDatabaseGuid, (VOID *) ImageExeInfoTable);\r |
1941 | \r | |
1942 | }\r | |
1943 | \r | |
0c18794e | 1944 | /**\r |
1945 | Register security measurement handler.\r | |
1946 | \r | |
1947 | @param ImageHandle ImageHandle of the loaded driver.\r | |
1948 | @param SystemTable Pointer to the EFI System Table.\r | |
1949 | \r | |
1950 | @retval EFI_SUCCESS The handlers were registered successfully.\r | |
1951 | **/\r | |
1952 | EFI_STATUS\r | |
1953 | EFIAPI\r | |
1954 | DxeImageVerificationLibConstructor (\r | |
1955 | IN EFI_HANDLE ImageHandle,\r | |
1956 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1957 | )\r | |
1958 | {\r | |
ffccb935 DG |
1959 | EFI_EVENT Event;\r |
1960 | \r | |
1961 | //\r | |
1962 | // Register the event to publish the image execution table.\r | |
1963 | //\r | |
1964 | EfiCreateEventReadyToBootEx (\r | |
1965 | TPL_CALLBACK,\r | |
20333c6d QL |
1966 | OnReadyToBoot,\r |
1967 | NULL,\r | |
ffccb935 | 1968 | &Event\r |
20333c6d | 1969 | );\r |
ffccb935 | 1970 | \r |
5db28a67 | 1971 | return RegisterSecurity2Handler (\r |
0c18794e | 1972 | DxeImageVerificationHandler,\r |
1973 | EFI_AUTH_OPERATION_VERIFY_IMAGE | EFI_AUTH_OPERATION_IMAGE_REQUIRED\r | |
45bf2c47 | 1974 | );\r |
0c18794e | 1975 | }\r |