]> git.proxmox.com Git - mirror_edk2.git/blob - SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
SecurityPkg/TPM2: Move GetDigestListSize() to Tpm2CommandLib
[mirror_edk2.git] / SecurityPkg / Tcg / Tcg2Dxe / Tcg2Dxe.c
1 /** @file
2 This module implements Tcg2 Protocol.
3
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include <PiDxe.h>
17 #include <IndustryStandard/Acpi.h>
18 #include <IndustryStandard/PeImage.h>
19 #include <IndustryStandard/TcpaAcpi.h>
20
21 #include <Guid/GlobalVariable.h>
22 #include <Guid/HobList.h>
23 #include <Guid/TcgEventHob.h>
24 #include <Guid/EventGroup.h>
25 #include <Guid/EventExitBootServiceFailed.h>
26 #include <Guid/ImageAuthentication.h>
27 #include <Guid/TpmInstance.h>
28
29 #include <Protocol/DevicePath.h>
30 #include <Protocol/MpService.h>
31 #include <Protocol/VariableWrite.h>
32 #include <Protocol/Tcg2Protocol.h>
33 #include <Protocol/TrEEProtocol.h>
34
35 #include <Library/DebugLib.h>
36 #include <Library/BaseMemoryLib.h>
37 #include <Library/UefiRuntimeServicesTableLib.h>
38 #include <Library/UefiDriverEntryPoint.h>
39 #include <Library/HobLib.h>
40 #include <Library/UefiBootServicesTableLib.h>
41 #include <Library/BaseLib.h>
42 #include <Library/MemoryAllocationLib.h>
43 #include <Library/PrintLib.h>
44 #include <Library/Tpm2CommandLib.h>
45 #include <Library/PcdLib.h>
46 #include <Library/UefiLib.h>
47 #include <Library/Tpm2DeviceLib.h>
48 #include <Library/HashLib.h>
49 #include <Library/PerformanceLib.h>
50 #include <Library/ReportStatusCodeLib.h>
51 #include <Library/Tcg2PhysicalPresenceLib.h>
52
53 #define PERF_ID_TCG2_DXE 0x3120
54
55 typedef struct {
56 CHAR16 *VariableName;
57 EFI_GUID *VendorGuid;
58 } VARIABLE_TYPE;
59
60 #define TCG2_DEFAULT_MAX_COMMAND_SIZE 0x1000
61 #define TCG2_DEFAULT_MAX_RESPONSE_SIZE 0x1000
62
63 typedef struct {
64 EFI_GUID *EventGuid;
65 EFI_TCG2_EVENT_LOG_FORMAT LogFormat;
66 } TCG2_EVENT_INFO_STRUCT;
67
68 TCG2_EVENT_INFO_STRUCT mTcg2EventInfo[] = {
69 {&gTcgEventEntryHobGuid, EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2},
70 {&gTcgEvent2EntryHobGuid, EFI_TCG2_EVENT_LOG_FORMAT_TCG_2},
71 };
72
73 #define TCG_EVENT_LOG_AREA_COUNT_MAX 2
74
75 typedef struct {
76 EFI_TCG2_EVENT_LOG_FORMAT EventLogFormat;
77 EFI_PHYSICAL_ADDRESS Lasa;
78 UINT64 Laml;
79 UINTN EventLogSize;
80 UINT8 *LastEvent;
81 BOOLEAN EventLogStarted;
82 BOOLEAN EventLogTruncated;
83 } TCG_EVENT_LOG_AREA_STRUCT;
84
85 typedef struct _TCG_DXE_DATA {
86 EFI_TCG2_BOOT_SERVICE_CAPABILITY BsCap;
87 TCG_EVENT_LOG_AREA_STRUCT EventLogAreaStruct[TCG_EVENT_LOG_AREA_COUNT_MAX];
88 BOOLEAN GetEventLogCalled[TCG_EVENT_LOG_AREA_COUNT_MAX];
89 TCG_EVENT_LOG_AREA_STRUCT FinalEventLogAreaStruct[TCG_EVENT_LOG_AREA_COUNT_MAX];
90 EFI_TCG2_FINAL_EVENTS_TABLE *FinalEventsTable[TCG_EVENT_LOG_AREA_COUNT_MAX];
91 } TCG_DXE_DATA;
92
93 TCG_DXE_DATA mTcgDxeData = {
94 {
95 sizeof (EFI_TCG2_BOOT_SERVICE_CAPABILITY), // Size
96 { 1, 1 }, // StructureVersion
97 { 1, 1 }, // ProtocolVersion
98 EFI_TCG2_BOOT_HASH_ALG_SHA1, // HashAlgorithmBitmap
99 EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2, // SupportedEventLogs
100 TRUE, // TPMPresentFlag
101 TCG2_DEFAULT_MAX_COMMAND_SIZE, // MaxCommandSize
102 TCG2_DEFAULT_MAX_RESPONSE_SIZE, // MaxResponseSize
103 0, // ManufacturerID
104 0, // NumberOfPCRBanks
105 0, // ActivePcrBanks
106 },
107 };
108
109 UINTN mBootAttempts = 0;
110 CHAR16 mBootVarName[] = L"BootOrder";
111
112 VARIABLE_TYPE mVariableType[] = {
113 {EFI_SECURE_BOOT_MODE_NAME, &gEfiGlobalVariableGuid},
114 {EFI_PLATFORM_KEY_NAME, &gEfiGlobalVariableGuid},
115 {EFI_KEY_EXCHANGE_KEY_NAME, &gEfiGlobalVariableGuid},
116 {EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid},
117 {EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid},
118 };
119
120 EFI_HANDLE mImageHandle;
121
122 /**
123 Measure PE image into TPM log based on the authenticode image hashing in
124 PE/COFF Specification 8.0 Appendix A.
125
126 Caution: This function may receive untrusted input.
127 PE/COFF image is external input, so this function will validate its data structure
128 within this image buffer before use.
129
130 Notes: PE/COFF image is checked by BasePeCoffLib PeCoffLoaderGetImageInfo().
131
132 @param[in] PCRIndex TPM PCR index
133 @param[in] ImageAddress Start address of image buffer.
134 @param[in] ImageSize Image size
135 @param[out] DigestList Digeest list of this image.
136
137 @retval EFI_SUCCESS Successfully measure image.
138 @retval EFI_OUT_OF_RESOURCES No enough resource to measure image.
139 @retval other error value
140 **/
141 EFI_STATUS
142 MeasurePeImageAndExtend (
143 IN UINT32 PCRIndex,
144 IN EFI_PHYSICAL_ADDRESS ImageAddress,
145 IN UINTN ImageSize,
146 OUT TPML_DIGEST_VALUES *DigestList
147 );
148
149 /**
150
151 This function dump raw data.
152
153 @param Data raw data
154 @param Size raw data size
155
156 **/
157 VOID
158 InternalDumpData (
159 IN UINT8 *Data,
160 IN UINTN Size
161 )
162 {
163 UINTN Index;
164 for (Index = 0; Index < Size; Index++) {
165 DEBUG ((EFI_D_INFO, "%02x", (UINTN)Data[Index]));
166 }
167 }
168
169 /**
170
171 This function dump raw data with colume format.
172
173 @param Data raw data
174 @param Size raw data size
175
176 **/
177 VOID
178 InternalDumpHex (
179 IN UINT8 *Data,
180 IN UINTN Size
181 )
182 {
183 UINTN Index;
184 UINTN Count;
185 UINTN Left;
186
187 #define COLUME_SIZE (16 * 2)
188
189 Count = Size / COLUME_SIZE;
190 Left = Size % COLUME_SIZE;
191 for (Index = 0; Index < Count; Index++) {
192 DEBUG ((EFI_D_INFO, "%04x: ", Index * COLUME_SIZE));
193 InternalDumpData (Data + Index * COLUME_SIZE, COLUME_SIZE);
194 DEBUG ((EFI_D_INFO, "\n"));
195 }
196
197 if (Left != 0) {
198 DEBUG ((EFI_D_INFO, "%04x: ", Index * COLUME_SIZE));
199 InternalDumpData (Data + Index * COLUME_SIZE, Left);
200 DEBUG ((EFI_D_INFO, "\n"));
201 }
202 }
203
204 /**
205 Get All processors EFI_CPU_LOCATION in system. LocationBuf is allocated inside the function
206 Caller is responsible to free LocationBuf.
207
208 @param[out] LocationBuf Returns Processor Location Buffer.
209 @param[out] Num Returns processor number.
210
211 @retval EFI_SUCCESS Operation completed successfully.
212 @retval EFI_UNSUPPORTED MpService protocol not found.
213
214 **/
215 EFI_STATUS
216 GetProcessorsCpuLocation (
217 OUT EFI_CPU_PHYSICAL_LOCATION **LocationBuf,
218 OUT UINTN *Num
219 )
220 {
221 EFI_STATUS Status;
222 EFI_MP_SERVICES_PROTOCOL *MpProtocol;
223 UINTN ProcessorNum;
224 UINTN EnabledProcessorNum;
225 EFI_PROCESSOR_INFORMATION ProcessorInfo;
226 EFI_CPU_PHYSICAL_LOCATION *ProcessorLocBuf;
227 UINTN Index;
228
229 Status = gBS->LocateProtocol (&gEfiMpServiceProtocolGuid, NULL, (VOID **) &MpProtocol);
230 if (EFI_ERROR (Status)) {
231 //
232 // MP protocol is not installed
233 //
234 return EFI_UNSUPPORTED;
235 }
236
237 Status = MpProtocol->GetNumberOfProcessors(
238 MpProtocol,
239 &ProcessorNum,
240 &EnabledProcessorNum
241 );
242 if (EFI_ERROR(Status)){
243 return Status;
244 }
245
246 Status = gBS->AllocatePool(
247 EfiBootServicesData,
248 sizeof(EFI_CPU_PHYSICAL_LOCATION) * ProcessorNum,
249 (VOID **) &ProcessorLocBuf
250 );
251 if (EFI_ERROR(Status)){
252 return Status;
253 }
254
255 //
256 // Get each processor Location info
257 //
258 for (Index = 0; Index < ProcessorNum; Index++) {
259 Status = MpProtocol->GetProcessorInfo(
260 MpProtocol,
261 Index,
262 &ProcessorInfo
263 );
264 if (EFI_ERROR(Status)){
265 FreePool(ProcessorLocBuf);
266 return Status;
267 }
268
269 //
270 // Get all Processor Location info & measure
271 //
272 CopyMem(
273 &ProcessorLocBuf[Index],
274 &ProcessorInfo.Location,
275 sizeof(EFI_CPU_PHYSICAL_LOCATION)
276 );
277 }
278
279 *LocationBuf = ProcessorLocBuf;
280 *Num = ProcessorNum;
281
282 return Status;
283 }
284
285 /**
286 The EFI_TCG2_PROTOCOL GetCapability function call provides protocol
287 capability information and state information.
288
289 @param[in] This Indicates the calling context
290 @param[in, out] ProtocolCapability The caller allocates memory for a EFI_TCG2_BOOT_SERVICE_CAPABILITY
291 structure and sets the size field to the size of the structure allocated.
292 The callee fills in the fields with the EFI protocol capability information
293 and the current EFI TCG2 state information up to the number of fields which
294 fit within the size of the structure passed in.
295
296 @retval EFI_SUCCESS Operation completed successfully.
297 @retval EFI_DEVICE_ERROR The command was unsuccessful.
298 The ProtocolCapability variable will not be populated.
299 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
300 The ProtocolCapability variable will not be populated.
301 @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too small to hold the full response.
302 It will be partially populated (required Size field will be set).
303 **/
304 EFI_STATUS
305 EFIAPI
306 Tcg2GetCapability (
307 IN EFI_TCG2_PROTOCOL *This,
308 IN OUT EFI_TCG2_BOOT_SERVICE_CAPABILITY *ProtocolCapability
309 )
310 {
311 DEBUG ((DEBUG_VERBOSE, "Tcg2GetCapability ...\n"));
312
313 if ((This == NULL) || (ProtocolCapability == NULL)) {
314 return EFI_INVALID_PARAMETER;
315 }
316
317 DEBUG ((DEBUG_VERBOSE, "Size - 0x%x\n", ProtocolCapability->Size));
318 DEBUG ((DEBUG_VERBOSE, " 1.1 - 0x%x, 1.0 - 0x%x\n", sizeof(EFI_TCG2_BOOT_SERVICE_CAPABILITY), sizeof(TREE_BOOT_SERVICE_CAPABILITY_1_0)));
319
320 if (ProtocolCapability->Size < mTcgDxeData.BsCap.Size) {
321 //
322 // Handle the case that firmware support 1.1 but OS only support 1.0.
323 //
324 if ((mTcgDxeData.BsCap.ProtocolVersion.Major > 0x01) ||
325 ((mTcgDxeData.BsCap.ProtocolVersion.Major == 0x01) && ((mTcgDxeData.BsCap.ProtocolVersion.Minor > 0x00)))) {
326 if (ProtocolCapability->Size >= sizeof(TREE_BOOT_SERVICE_CAPABILITY_1_0)) {
327 CopyMem (ProtocolCapability, &mTcgDxeData.BsCap, sizeof(TREE_BOOT_SERVICE_CAPABILITY_1_0));
328 ProtocolCapability->Size = sizeof(TREE_BOOT_SERVICE_CAPABILITY_1_0);
329 ProtocolCapability->StructureVersion.Major = 1;
330 ProtocolCapability->StructureVersion.Minor = 0;
331 ProtocolCapability->ProtocolVersion.Major = 1;
332 ProtocolCapability->ProtocolVersion.Minor = 0;
333 DEBUG ((EFI_D_ERROR, "TreeGetCapability (Compatible) - %r\n", EFI_SUCCESS));
334 return EFI_SUCCESS;
335 }
336 }
337 ProtocolCapability->Size = mTcgDxeData.BsCap.Size;
338 return EFI_BUFFER_TOO_SMALL;
339 }
340
341 CopyMem (ProtocolCapability, &mTcgDxeData.BsCap, mTcgDxeData.BsCap.Size);
342 DEBUG ((DEBUG_VERBOSE, "Tcg2GetCapability - %r\n", EFI_SUCCESS));
343 return EFI_SUCCESS;
344 }
345
346 /**
347 This function dump PCR event.
348
349 @param[in] EventHdr TCG PCR event structure.
350 **/
351 VOID
352 DumpEvent (
353 IN TCG_PCR_EVENT_HDR *EventHdr
354 )
355 {
356 UINTN Index;
357
358 DEBUG ((EFI_D_INFO, " Event:\n"));
359 DEBUG ((EFI_D_INFO, " PCRIndex - %d\n", EventHdr->PCRIndex));
360 DEBUG ((EFI_D_INFO, " EventType - 0x%08x\n", EventHdr->EventType));
361 DEBUG ((EFI_D_INFO, " Digest - "));
362 for (Index = 0; Index < sizeof(TCG_DIGEST); Index++) {
363 DEBUG ((EFI_D_INFO, "%02x ", EventHdr->Digest.digest[Index]));
364 }
365 DEBUG ((EFI_D_INFO, "\n"));
366 DEBUG ((EFI_D_INFO, " EventSize - 0x%08x\n", EventHdr->EventSize));
367 InternalDumpHex ((UINT8 *)(EventHdr + 1), EventHdr->EventSize);
368 }
369
370 /**
371 This function dump TCG_EfiSpecIDEventStruct.
372
373 @param[in] TcgEfiSpecIdEventStruct A pointer to TCG_EfiSpecIDEventStruct.
374 **/
375 VOID
376 DumpTcgEfiSpecIdEventStruct (
377 IN TCG_EfiSpecIDEventStruct *TcgEfiSpecIdEventStruct
378 )
379 {
380 TCG_EfiSpecIdEventAlgorithmSize *DigestSize;
381 UINTN Index;
382 UINT8 *VendorInfoSize;
383 UINT8 *VendorInfo;
384 UINT32 NumberOfAlgorithms;
385
386 DEBUG ((EFI_D_INFO, " TCG_EfiSpecIDEventStruct:\n"));
387 DEBUG ((EFI_D_INFO, " signature - '"));
388 for (Index = 0; Index < sizeof(TcgEfiSpecIdEventStruct->signature); Index++) {
389 DEBUG ((EFI_D_INFO, "%c", TcgEfiSpecIdEventStruct->signature[Index]));
390 }
391 DEBUG ((EFI_D_INFO, "'\n"));
392 DEBUG ((EFI_D_INFO, " platformClass - 0x%08x\n", TcgEfiSpecIdEventStruct->platformClass));
393 DEBUG ((EFI_D_INFO, " specVersion - %d.%d%d\n", TcgEfiSpecIdEventStruct->specVersionMajor, TcgEfiSpecIdEventStruct->specVersionMinor, TcgEfiSpecIdEventStruct->specErrata));
394 DEBUG ((EFI_D_INFO, " uintnSize - 0x%02x\n", TcgEfiSpecIdEventStruct->uintnSize));
395
396 CopyMem (&NumberOfAlgorithms, TcgEfiSpecIdEventStruct + 1, sizeof(NumberOfAlgorithms));
397 DEBUG ((EFI_D_INFO, " NumberOfAlgorithms - 0x%08x\n", NumberOfAlgorithms));
398
399 DigestSize = (TCG_EfiSpecIdEventAlgorithmSize *)((UINT8 *)TcgEfiSpecIdEventStruct + sizeof(*TcgEfiSpecIdEventStruct) + sizeof(NumberOfAlgorithms));
400 for (Index = 0; Index < NumberOfAlgorithms; Index++) {
401 DEBUG ((EFI_D_INFO, " digest(%d)\n", Index));
402 DEBUG ((EFI_D_INFO, " algorithmId - 0x%04x\n", DigestSize[Index].algorithmId));
403 DEBUG ((EFI_D_INFO, " digestSize - 0x%04x\n", DigestSize[Index].digestSize));
404 }
405 VendorInfoSize = (UINT8 *)&DigestSize[NumberOfAlgorithms];
406 DEBUG ((EFI_D_INFO, " VendorInfoSize - 0x%02x\n", *VendorInfoSize));
407 VendorInfo = VendorInfoSize + 1;
408 DEBUG ((EFI_D_INFO, " VendorInfo - "));
409 for (Index = 0; Index < *VendorInfoSize; Index++) {
410 DEBUG ((EFI_D_INFO, "%02x ", VendorInfo[Index]));
411 }
412 DEBUG ((EFI_D_INFO, "\n"));
413 }
414
415 /**
416 This function get size of TCG_EfiSpecIDEventStruct.
417
418 @param[in] TcgEfiSpecIdEventStruct A pointer to TCG_EfiSpecIDEventStruct.
419 **/
420 UINTN
421 GetTcgEfiSpecIdEventStructSize (
422 IN TCG_EfiSpecIDEventStruct *TcgEfiSpecIdEventStruct
423 )
424 {
425 TCG_EfiSpecIdEventAlgorithmSize *DigestSize;
426 UINT8 *VendorInfoSize;
427 UINT32 NumberOfAlgorithms;
428
429 CopyMem (&NumberOfAlgorithms, TcgEfiSpecIdEventStruct + 1, sizeof(NumberOfAlgorithms));
430
431 DigestSize = (TCG_EfiSpecIdEventAlgorithmSize *)((UINT8 *)TcgEfiSpecIdEventStruct + sizeof(*TcgEfiSpecIdEventStruct) + sizeof(NumberOfAlgorithms));
432 VendorInfoSize = (UINT8 *)&DigestSize[NumberOfAlgorithms];
433 return sizeof(TCG_EfiSpecIDEventStruct) + sizeof(UINT32) + (NumberOfAlgorithms * sizeof(TCG_EfiSpecIdEventAlgorithmSize)) + sizeof(UINT8) + (*VendorInfoSize);
434 }
435
436 /**
437 This function dump PCR event 2.
438
439 @param[in] TcgPcrEvent2 TCG PCR event 2 structure.
440 **/
441 VOID
442 DumpEvent2 (
443 IN TCG_PCR_EVENT2 *TcgPcrEvent2
444 )
445 {
446 UINTN Index;
447 UINT32 DigestIndex;
448 UINT32 DigestCount;
449 TPMI_ALG_HASH HashAlgo;
450 UINT32 DigestSize;
451 UINT8 *DigestBuffer;
452 UINT32 EventSize;
453 UINT8 *EventBuffer;
454
455 DEBUG ((EFI_D_INFO, " Event:\n"));
456 DEBUG ((EFI_D_INFO, " PCRIndex - %d\n", TcgPcrEvent2->PCRIndex));
457 DEBUG ((EFI_D_INFO, " EventType - 0x%08x\n", TcgPcrEvent2->EventType));
458
459 DEBUG ((EFI_D_INFO, " DigestCount: 0x%08x\n", TcgPcrEvent2->Digest.count));
460
461 DigestCount = TcgPcrEvent2->Digest.count;
462 HashAlgo = TcgPcrEvent2->Digest.digests[0].hashAlg;
463 DigestBuffer = (UINT8 *)&TcgPcrEvent2->Digest.digests[0].digest;
464 for (DigestIndex = 0; DigestIndex < DigestCount; DigestIndex++) {
465 DEBUG ((EFI_D_INFO, " HashAlgo : 0x%04x\n", HashAlgo));
466 DEBUG ((EFI_D_INFO, " Digest(%d): ", DigestIndex));
467 DigestSize = GetHashSizeFromAlgo (HashAlgo);
468 for (Index = 0; Index < DigestSize; Index++) {
469 DEBUG ((EFI_D_INFO, "%02x ", DigestBuffer[Index]));
470 }
471 DEBUG ((EFI_D_INFO, "\n"));
472 //
473 // Prepare next
474 //
475 CopyMem (&HashAlgo, DigestBuffer + DigestSize, sizeof(TPMI_ALG_HASH));
476 DigestBuffer = DigestBuffer + DigestSize + sizeof(TPMI_ALG_HASH);
477 }
478 DEBUG ((EFI_D_INFO, "\n"));
479 DigestBuffer = DigestBuffer - sizeof(TPMI_ALG_HASH);
480
481 CopyMem (&EventSize, DigestBuffer, sizeof(TcgPcrEvent2->EventSize));
482 DEBUG ((EFI_D_INFO, " EventSize - 0x%08x\n", EventSize));
483 EventBuffer = DigestBuffer + sizeof(TcgPcrEvent2->EventSize);
484 InternalDumpHex (EventBuffer, EventSize);
485 }
486
487 /**
488 This function returns size of TCG PCR event 2.
489
490 @param[in] TcgPcrEvent2 TCG PCR event 2 structure.
491
492 @return size of TCG PCR event 2.
493 **/
494 UINTN
495 GetPcrEvent2Size (
496 IN TCG_PCR_EVENT2 *TcgPcrEvent2
497 )
498 {
499 UINT32 DigestIndex;
500 UINT32 DigestCount;
501 TPMI_ALG_HASH HashAlgo;
502 UINT32 DigestSize;
503 UINT8 *DigestBuffer;
504 UINT32 EventSize;
505 UINT8 *EventBuffer;
506
507 DigestCount = TcgPcrEvent2->Digest.count;
508 HashAlgo = TcgPcrEvent2->Digest.digests[0].hashAlg;
509 DigestBuffer = (UINT8 *)&TcgPcrEvent2->Digest.digests[0].digest;
510 for (DigestIndex = 0; DigestIndex < DigestCount; DigestIndex++) {
511 DigestSize = GetHashSizeFromAlgo (HashAlgo);
512 //
513 // Prepare next
514 //
515 CopyMem (&HashAlgo, DigestBuffer + DigestSize, sizeof(TPMI_ALG_HASH));
516 DigestBuffer = DigestBuffer + DigestSize + sizeof(TPMI_ALG_HASH);
517 }
518 DigestBuffer = DigestBuffer - sizeof(TPMI_ALG_HASH);
519
520 CopyMem (&EventSize, DigestBuffer, sizeof(TcgPcrEvent2->EventSize));
521 EventBuffer = DigestBuffer + sizeof(TcgPcrEvent2->EventSize);
522
523 return (UINTN)EventBuffer + EventSize - (UINTN)TcgPcrEvent2;
524 }
525
526 /**
527 This function dump event log.
528
529 @param[in] EventLogFormat The type of the event log for which the information is requested.
530 @param[in] EventLogLocation A pointer to the memory address of the event log.
531 @param[in] EventLogLastEntry If the Event Log contains more than one entry, this is a pointer to the
532 address of the start of the last entry in the event log in memory.
533 @param[in] FinalEventsTable A pointer to the memory address of the final event table.
534 **/
535 VOID
536 DumpEventLog (
537 IN EFI_TCG2_EVENT_LOG_FORMAT EventLogFormat,
538 IN EFI_PHYSICAL_ADDRESS EventLogLocation,
539 IN EFI_PHYSICAL_ADDRESS EventLogLastEntry,
540 IN EFI_TCG2_FINAL_EVENTS_TABLE *FinalEventsTable
541 )
542 {
543 TCG_PCR_EVENT_HDR *EventHdr;
544 TCG_PCR_EVENT2 *TcgPcrEvent2;
545 TCG_EfiSpecIDEventStruct *TcgEfiSpecIdEventStruct;
546 UINTN NumberOfEvents;
547
548 DEBUG ((EFI_D_INFO, "EventLogFormat: (0x%x)\n", EventLogFormat));
549
550 switch (EventLogFormat) {
551 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2:
552 EventHdr = (TCG_PCR_EVENT_HDR *)(UINTN)EventLogLocation;
553 while ((UINTN)EventHdr <= EventLogLastEntry) {
554 DumpEvent (EventHdr);
555 EventHdr = (TCG_PCR_EVENT_HDR *)((UINTN)EventHdr + sizeof(TCG_PCR_EVENT_HDR) + EventHdr->EventSize);
556 }
557 if (FinalEventsTable == NULL) {
558 DEBUG ((EFI_D_INFO, "FinalEventsTable: NOT FOUND\n"));
559 } else {
560 DEBUG ((EFI_D_INFO, "FinalEventsTable: (0x%x)\n", FinalEventsTable));
561 DEBUG ((EFI_D_INFO, " Version: (0x%x)\n", FinalEventsTable->Version));
562 DEBUG ((EFI_D_INFO, " NumberOfEvents: (0x%x)\n", FinalEventsTable->NumberOfEvents));
563
564 EventHdr = (TCG_PCR_EVENT_HDR *)(UINTN)(FinalEventsTable + 1);
565 for (NumberOfEvents = 0; NumberOfEvents < FinalEventsTable->NumberOfEvents; NumberOfEvents++) {
566 DumpEvent (EventHdr);
567 EventHdr = (TCG_PCR_EVENT_HDR *)((UINTN)EventHdr + sizeof(TCG_PCR_EVENT_HDR) + EventHdr->EventSize);
568 }
569 }
570 break;
571 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_2:
572 //
573 // Dump first event
574 //
575 EventHdr = (TCG_PCR_EVENT_HDR *)(UINTN)EventLogLocation;
576 DumpEvent (EventHdr);
577
578 TcgEfiSpecIdEventStruct = (TCG_EfiSpecIDEventStruct *)(EventHdr + 1);
579 DumpTcgEfiSpecIdEventStruct (TcgEfiSpecIdEventStruct);
580
581 TcgPcrEvent2 = (TCG_PCR_EVENT2 *)((UINTN)TcgEfiSpecIdEventStruct + GetTcgEfiSpecIdEventStructSize (TcgEfiSpecIdEventStruct));
582 while ((UINTN)TcgPcrEvent2 <= EventLogLastEntry) {
583 DumpEvent2 (TcgPcrEvent2);
584 TcgPcrEvent2 = (TCG_PCR_EVENT2 *)((UINTN)TcgPcrEvent2 + GetPcrEvent2Size (TcgPcrEvent2));
585 }
586
587 if (FinalEventsTable == NULL) {
588 DEBUG ((EFI_D_INFO, "FinalEventsTable: NOT FOUND\n"));
589 } else {
590 DEBUG ((EFI_D_INFO, "FinalEventsTable: (0x%x)\n", FinalEventsTable));
591 DEBUG ((EFI_D_INFO, " Version: (0x%x)\n", FinalEventsTable->Version));
592 DEBUG ((EFI_D_INFO, " NumberOfEvents: (0x%x)\n", FinalEventsTable->NumberOfEvents));
593
594 TcgPcrEvent2 = (TCG_PCR_EVENT2 *)(UINTN)(FinalEventsTable + 1);
595 for (NumberOfEvents = 0; NumberOfEvents < FinalEventsTable->NumberOfEvents; NumberOfEvents++) {
596 DumpEvent2 (TcgPcrEvent2);
597 TcgPcrEvent2 = (TCG_PCR_EVENT2 *)((UINTN)TcgPcrEvent2 + GetPcrEvent2Size (TcgPcrEvent2));
598 }
599 }
600 break;
601 }
602
603 return ;
604 }
605
606 /**
607 The EFI_TCG2_PROTOCOL Get Event Log function call allows a caller to
608 retrieve the address of a given event log and its last entry.
609
610 @param[in] This Indicates the calling context
611 @param[in] EventLogFormat The type of the event log for which the information is requested.
612 @param[out] EventLogLocation A pointer to the memory address of the event log.
613 @param[out] EventLogLastEntry If the Event Log contains more than one entry, this is a pointer to the
614 address of the start of the last entry in the event log in memory.
615 @param[out] EventLogTruncated If the Event Log is missing at least one entry because an event would
616 have exceeded the area allocated for events, this value is set to TRUE.
617 Otherwise, the value will be FALSE and the Event Log will be complete.
618
619 @retval EFI_SUCCESS Operation completed successfully.
620 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect
621 (e.g. asking for an event log whose format is not supported).
622 **/
623 EFI_STATUS
624 EFIAPI
625 Tcg2GetEventLog (
626 IN EFI_TCG2_PROTOCOL *This,
627 IN EFI_TCG2_EVENT_LOG_FORMAT EventLogFormat,
628 OUT EFI_PHYSICAL_ADDRESS *EventLogLocation,
629 OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry,
630 OUT BOOLEAN *EventLogTruncated
631 )
632 {
633 UINTN Index;
634
635 DEBUG ((EFI_D_INFO, "Tcg2GetEventLog ... (0x%x)\n", EventLogFormat));
636
637 if (This == NULL) {
638 return EFI_INVALID_PARAMETER;
639 }
640
641 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
642 if (EventLogFormat == mTcg2EventInfo[Index].LogFormat) {
643 break;
644 }
645 }
646
647 if (Index == sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0])) {
648 return EFI_INVALID_PARAMETER;
649 }
650
651 if ((mTcg2EventInfo[Index].LogFormat & mTcgDxeData.BsCap.SupportedEventLogs) == 0) {
652 return EFI_INVALID_PARAMETER;
653 }
654
655 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
656 if (EventLogLocation != NULL) {
657 *EventLogLocation = 0;
658 }
659 if (EventLogLastEntry != NULL) {
660 *EventLogLastEntry = 0;
661 }
662 if (EventLogTruncated != NULL) {
663 *EventLogTruncated = FALSE;
664 }
665 return EFI_SUCCESS;
666 }
667
668 if (EventLogLocation != NULL) {
669 *EventLogLocation = mTcgDxeData.EventLogAreaStruct[Index].Lasa;
670 DEBUG ((EFI_D_INFO, "Tcg2GetEventLog (EventLogLocation - %x)\n", *EventLogLocation));
671 }
672
673 if (EventLogLastEntry != NULL) {
674 if (!mTcgDxeData.EventLogAreaStruct[Index].EventLogStarted) {
675 *EventLogLastEntry = (EFI_PHYSICAL_ADDRESS)(UINTN)0;
676 } else {
677 *EventLogLastEntry = (EFI_PHYSICAL_ADDRESS)(UINTN)mTcgDxeData.EventLogAreaStruct[Index].LastEvent;
678 }
679 DEBUG ((EFI_D_INFO, "Tcg2GetEventLog (EventLogLastEntry - %x)\n", *EventLogLastEntry));
680 }
681
682 if (EventLogTruncated != NULL) {
683 *EventLogTruncated = mTcgDxeData.EventLogAreaStruct[Index].EventLogTruncated;
684 DEBUG ((EFI_D_INFO, "Tcg2GetEventLog (EventLogTruncated - %x)\n", *EventLogTruncated));
685 }
686
687 DEBUG ((EFI_D_INFO, "Tcg2GetEventLog - %r\n", EFI_SUCCESS));
688
689 // Dump Event Log for debug purpose
690 if ((EventLogLocation != NULL) && (EventLogLastEntry != NULL)) {
691 DumpEventLog (EventLogFormat, *EventLogLocation, *EventLogLastEntry, mTcgDxeData.FinalEventsTable[Index]);
692 }
693
694 //
695 // All events generated after the invocation of EFI_TCG2_GET_EVENT_LOG SHALL be stored
696 // in an instance of an EFI_CONFIGURATION_TABLE named by the VendorGuid of EFI_TCG2_FINAL_EVENTS_TABLE_GUID.
697 //
698 mTcgDxeData.GetEventLogCalled[Index] = TRUE;
699
700 return EFI_SUCCESS;
701 }
702
703 /**
704 Add a new entry to the Event Log.
705
706 @param[in, out] EventLogPtr Pointer to the Event Log data.
707 @param[in, out] LogSize Size of the Event Log.
708 @param[in] MaxSize Maximum size of the Event Log.
709 @param[in] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR/TCG_PCR_EVENT_EX data structure.
710 @param[in] NewEventHdrSize New event header size.
711 @param[in] NewEventData Pointer to the new event data.
712 @param[in] NewEventSize New event data size.
713
714 @retval EFI_SUCCESS The new event log entry was added.
715 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
716
717 **/
718 EFI_STATUS
719 TcgCommLogEvent (
720 IN OUT UINT8 **EventLogPtr,
721 IN OUT UINTN *LogSize,
722 IN UINTN MaxSize,
723 IN VOID *NewEventHdr,
724 IN UINT32 NewEventHdrSize,
725 IN UINT8 *NewEventData,
726 IN UINT32 NewEventSize
727 )
728 {
729 UINTN NewLogSize;
730
731 if (NewEventSize > MAX_ADDRESS - NewEventHdrSize) {
732 return EFI_OUT_OF_RESOURCES;
733 }
734
735 NewLogSize = NewEventHdrSize + NewEventSize;
736
737 if (NewLogSize > MAX_ADDRESS - *LogSize) {
738 return EFI_OUT_OF_RESOURCES;
739 }
740
741 if (NewLogSize + *LogSize > MaxSize) {
742 DEBUG ((EFI_D_INFO, " MaxSize - 0x%x\n", MaxSize));
743 DEBUG ((EFI_D_INFO, " NewLogSize - 0x%x\n", NewLogSize));
744 DEBUG ((EFI_D_INFO, " LogSize - 0x%x\n", *LogSize));
745 DEBUG ((EFI_D_INFO, "TcgCommLogEvent - %r\n", EFI_OUT_OF_RESOURCES));
746 return EFI_OUT_OF_RESOURCES;
747 }
748
749 *EventLogPtr += *LogSize;
750 *LogSize += NewLogSize;
751 CopyMem (*EventLogPtr, NewEventHdr, NewEventHdrSize);
752 CopyMem (
753 *EventLogPtr + NewEventHdrSize,
754 NewEventData,
755 NewEventSize
756 );
757 return EFI_SUCCESS;
758 }
759
760 /**
761 Add a new entry to the Event Log.
762
763 @param[in] EventLogFormat The type of the event log for which the information is requested.
764 @param[in] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR/TCG_PCR_EVENT_EX data structure.
765 @param[in] NewEventHdrSize New event header size.
766 @param[in] NewEventData Pointer to the new event data.
767 @param[in] NewEventSize New event data size.
768
769 @retval EFI_SUCCESS The new event log entry was added.
770 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
771
772 **/
773 EFI_STATUS
774 TcgDxeLogEvent (
775 IN EFI_TCG2_EVENT_LOG_FORMAT EventLogFormat,
776 IN VOID *NewEventHdr,
777 IN UINT32 NewEventHdrSize,
778 IN UINT8 *NewEventData,
779 IN UINT32 NewEventSize
780 )
781 {
782 EFI_STATUS Status;
783 UINTN Index;
784 TCG_EVENT_LOG_AREA_STRUCT *EventLogAreaStruct;
785
786 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
787 if (EventLogFormat == mTcg2EventInfo[Index].LogFormat) {
788 break;
789 }
790 }
791
792 if (Index == sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0])) {
793 return EFI_INVALID_PARAMETER;
794 }
795
796 //
797 // Record to normal event log
798 //
799 EventLogAreaStruct = &mTcgDxeData.EventLogAreaStruct[Index];
800
801 if (EventLogAreaStruct->EventLogTruncated) {
802 return EFI_VOLUME_FULL;
803 }
804
805 EventLogAreaStruct->LastEvent = (UINT8*)(UINTN)EventLogAreaStruct->Lasa;
806 Status = TcgCommLogEvent (
807 &EventLogAreaStruct->LastEvent,
808 &EventLogAreaStruct->EventLogSize,
809 (UINTN)EventLogAreaStruct->Laml,
810 NewEventHdr,
811 NewEventHdrSize,
812 NewEventData,
813 NewEventSize
814 );
815
816 if (Status == EFI_OUT_OF_RESOURCES) {
817 EventLogAreaStruct->EventLogTruncated = TRUE;
818 return EFI_VOLUME_FULL;
819 } else if (Status == EFI_SUCCESS) {
820 EventLogAreaStruct->EventLogStarted = TRUE;
821 }
822
823 //
824 // If GetEventLog is called, record to FinalEventsTable, too.
825 //
826 if (mTcgDxeData.GetEventLogCalled[Index]) {
827 if (mTcgDxeData.FinalEventsTable[Index] == NULL) {
828 //
829 // no need for FinalEventsTable
830 //
831 return EFI_SUCCESS;
832 }
833 EventLogAreaStruct = &mTcgDxeData.FinalEventLogAreaStruct[Index];
834
835 if (EventLogAreaStruct->EventLogTruncated) {
836 return EFI_VOLUME_FULL;
837 }
838
839 EventLogAreaStruct->LastEvent = (UINT8*)(UINTN)EventLogAreaStruct->Lasa;
840 Status = TcgCommLogEvent (
841 &EventLogAreaStruct->LastEvent,
842 &EventLogAreaStruct->EventLogSize,
843 (UINTN)EventLogAreaStruct->Laml,
844 NewEventHdr,
845 NewEventHdrSize,
846 NewEventData,
847 NewEventSize
848 );
849 if (Status == EFI_OUT_OF_RESOURCES) {
850 EventLogAreaStruct->EventLogTruncated = TRUE;
851 return EFI_VOLUME_FULL;
852 } else if (Status == EFI_SUCCESS) {
853 EventLogAreaStruct->EventLogStarted = TRUE;
854 //
855 // Increase the NumberOfEvents in FinalEventsTable
856 //
857 (mTcgDxeData.FinalEventsTable[Index])->NumberOfEvents ++;
858 DEBUG ((EFI_D_INFO, "FinalEventsTable->NumberOfEvents - 0x%x\n", (mTcgDxeData.FinalEventsTable[Index])->NumberOfEvents));
859 DEBUG ((EFI_D_INFO, " Size - 0x%x\n", (UINTN)EventLogAreaStruct->LastEvent - (UINTN)mTcgDxeData.FinalEventsTable[Index]));
860 }
861 }
862
863 return Status;
864 }
865
866 /**
867 Get TPML_DIGEST_VALUES compact binary buffer size.
868
869 @param[in] DigestListBin TPML_DIGEST_VALUES compact binary buffer.
870
871 @return TPML_DIGEST_VALUES compact binary buffer size.
872 **/
873 UINT32
874 GetDigestListBinSize (
875 IN VOID *DigestListBin
876 )
877 {
878 UINTN Index;
879 UINT16 DigestSize;
880 UINT32 TotalSize;
881 UINT32 Count;
882 TPMI_ALG_HASH HashAlg;
883
884 Count = ReadUnaligned32 (DigestListBin);
885 TotalSize = sizeof(Count);
886 DigestListBin = (UINT8 *)DigestListBin + sizeof(Count);
887 for (Index = 0; Index < Count; Index++) {
888 HashAlg = ReadUnaligned16 (DigestListBin);
889 TotalSize += sizeof(HashAlg);
890 DigestListBin = (UINT8 *)DigestListBin + sizeof(HashAlg);
891
892 DigestSize = GetHashSizeFromAlgo (HashAlg);
893 TotalSize += DigestSize;
894 DigestListBin = (UINT8 *)DigestListBin + DigestSize;
895 }
896
897 return TotalSize;
898 }
899
900 /**
901 Return if hash alg is supported in TPM PCR bank.
902
903 @param HashAlg Hash algorithm to be checked.
904
905 @retval TRUE Hash algorithm is supported.
906 @retval FALSE Hash algorithm is not supported.
907 **/
908 BOOLEAN
909 IsHashAlgSupportedInPcrBank (
910 IN TPMI_ALG_HASH HashAlg
911 )
912 {
913 switch (HashAlg) {
914 case TPM_ALG_SHA1:
915 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA1) != 0) {
916 return TRUE;
917 }
918 break;
919 case TPM_ALG_SHA256:
920 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA256) != 0) {
921 return TRUE;
922 }
923 break;
924 case TPM_ALG_SHA384:
925 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA384) != 0) {
926 return TRUE;
927 }
928 break;
929 case TPM_ALG_SHA512:
930 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA512) != 0) {
931 return TRUE;
932 }
933 break;
934 case TPM_ALG_SM3_256:
935 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SM3_256) != 0) {
936 return TRUE;
937 }
938 break;
939 }
940
941 return FALSE;
942 }
943
944 /**
945 Copy TPML_DIGEST_VALUES into a buffer
946
947 @param[in,out] Buffer Buffer to hold TPML_DIGEST_VALUES.
948 @param[in] DigestList TPML_DIGEST_VALUES to be copied.
949
950 @return The end of buffer to hold TPML_DIGEST_VALUES.
951 **/
952 VOID *
953 CopyDigestListToBuffer (
954 IN OUT VOID *Buffer,
955 IN TPML_DIGEST_VALUES *DigestList
956 )
957 {
958 UINTN Index;
959 UINT16 DigestSize;
960
961 CopyMem (Buffer, &DigestList->count, sizeof(DigestList->count));
962 Buffer = (UINT8 *)Buffer + sizeof(DigestList->count);
963 for (Index = 0; Index < DigestList->count; Index++) {
964 if (!IsHashAlgSupportedInPcrBank (DigestList->digests[Index].hashAlg)) {
965 DEBUG ((EFI_D_ERROR, "WARNING: TPM2 Event log has HashAlg unsupported by PCR bank (0x%x)\n", DigestList->digests[Index].hashAlg));
966 continue;
967 }
968 CopyMem (Buffer, &DigestList->digests[Index].hashAlg, sizeof(DigestList->digests[Index].hashAlg));
969 Buffer = (UINT8 *)Buffer + sizeof(DigestList->digests[Index].hashAlg);
970 DigestSize = GetHashSizeFromAlgo (DigestList->digests[Index].hashAlg);
971 CopyMem (Buffer, &DigestList->digests[Index].digest, DigestSize);
972 Buffer = (UINT8 *)Buffer + DigestSize;
973 }
974
975 return Buffer;
976 }
977
978 /**
979 Add a new entry to the Event Log.
980
981 @param[in] DigestList A list of digest.
982 @param[in,out] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR data structure.
983 @param[in] NewEventData Pointer to the new event data.
984
985 @retval EFI_SUCCESS The new event log entry was added.
986 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
987 **/
988 EFI_STATUS
989 TcgDxeLogHashEvent (
990 IN TPML_DIGEST_VALUES *DigestList,
991 IN OUT TCG_PCR_EVENT_HDR *NewEventHdr,
992 IN UINT8 *NewEventData
993 )
994 {
995 EFI_STATUS Status;
996 EFI_TPL OldTpl;
997 UINTN Index;
998 EFI_STATUS RetStatus;
999 TCG_PCR_EVENT2 TcgPcrEvent2;
1000 UINT8 *DigestBuffer;
1001
1002 DEBUG ((EFI_D_INFO, "SupportedEventLogs - 0x%08x\n", mTcgDxeData.BsCap.SupportedEventLogs));
1003
1004 RetStatus = EFI_SUCCESS;
1005 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1006 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1007 DEBUG ((EFI_D_INFO, " LogFormat - 0x%08x\n", mTcg2EventInfo[Index].LogFormat));
1008 switch (mTcg2EventInfo[Index].LogFormat) {
1009 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2:
1010 Status = GetDigestFromDigestList (TPM_ALG_SHA1, DigestList, &NewEventHdr->Digest);
1011 if (!EFI_ERROR (Status)) {
1012 //
1013 // Enter critical region
1014 //
1015 OldTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);
1016 Status = TcgDxeLogEvent (
1017 mTcg2EventInfo[Index].LogFormat,
1018 NewEventHdr,
1019 sizeof(TCG_PCR_EVENT_HDR),
1020 NewEventData,
1021 NewEventHdr->EventSize
1022 );
1023 if (Status != EFI_SUCCESS) {
1024 RetStatus = Status;
1025 }
1026 gBS->RestoreTPL (OldTpl);
1027 //
1028 // Exit critical region
1029 //
1030 }
1031 break;
1032 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_2:
1033 ZeroMem (&TcgPcrEvent2, sizeof(TcgPcrEvent2));
1034 TcgPcrEvent2.PCRIndex = NewEventHdr->PCRIndex;
1035 TcgPcrEvent2.EventType = NewEventHdr->EventType;
1036 DigestBuffer = (UINT8 *)&TcgPcrEvent2.Digest;
1037 DigestBuffer = CopyDigestListToBuffer (DigestBuffer, DigestList);
1038 CopyMem (DigestBuffer, &NewEventHdr->EventSize, sizeof(NewEventHdr->EventSize));
1039 DigestBuffer = DigestBuffer + sizeof(NewEventHdr->EventSize);
1040
1041 //
1042 // Enter critical region
1043 //
1044 OldTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);
1045 Status = TcgDxeLogEvent (
1046 mTcg2EventInfo[Index].LogFormat,
1047 &TcgPcrEvent2,
1048 sizeof(TcgPcrEvent2.PCRIndex) + sizeof(TcgPcrEvent2.EventType) + GetDigestListSize (DigestList) + sizeof(TcgPcrEvent2.EventSize),
1049 NewEventData,
1050 NewEventHdr->EventSize
1051 );
1052 if (Status != EFI_SUCCESS) {
1053 RetStatus = Status;
1054 }
1055 gBS->RestoreTPL (OldTpl);
1056 //
1057 // Exit critical region
1058 //
1059 break;
1060 }
1061 }
1062 }
1063
1064 return RetStatus;
1065 }
1066
1067 /**
1068 Do a hash operation on a data buffer, extend a specific TPM PCR with the hash result,
1069 and add an entry to the Event Log.
1070
1071 @param[in] Flags Bitmap providing additional information.
1072 @param[in] HashData Physical address of the start of the data buffer
1073 to be hashed, extended, and logged.
1074 @param[in] HashDataLen The length, in bytes, of the buffer referenced by HashData
1075 @param[in, out] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR data structure.
1076 @param[in] NewEventData Pointer to the new event data.
1077
1078 @retval EFI_SUCCESS Operation completed successfully.
1079 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
1080 @retval EFI_DEVICE_ERROR The command was unsuccessful.
1081
1082 **/
1083 EFI_STATUS
1084 TcgDxeHashLogExtendEvent (
1085 IN UINT64 Flags,
1086 IN UINT8 *HashData,
1087 IN UINT64 HashDataLen,
1088 IN OUT TCG_PCR_EVENT_HDR *NewEventHdr,
1089 IN UINT8 *NewEventData
1090 )
1091 {
1092 EFI_STATUS Status;
1093 TPML_DIGEST_VALUES DigestList;
1094
1095 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
1096 return EFI_DEVICE_ERROR;
1097 }
1098
1099 Status = HashAndExtend (
1100 NewEventHdr->PCRIndex,
1101 HashData,
1102 (UINTN)HashDataLen,
1103 &DigestList
1104 );
1105 if (!EFI_ERROR (Status)) {
1106 if ((Flags & EFI_TCG2_EXTEND_ONLY) == 0) {
1107 Status = TcgDxeLogHashEvent (&DigestList, NewEventHdr, NewEventData);
1108 }
1109 }
1110
1111 if (Status == EFI_DEVICE_ERROR) {
1112 DEBUG ((EFI_D_ERROR, "TcgDxeHashLogExtendEvent - %r. Disable TPM.\n", Status));
1113 mTcgDxeData.BsCap.TPMPresentFlag = FALSE;
1114 REPORT_STATUS_CODE (
1115 EFI_ERROR_CODE | EFI_ERROR_MINOR,
1116 (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)
1117 );
1118 }
1119
1120 return Status;
1121 }
1122
1123 /**
1124 The EFI_TCG2_PROTOCOL HashLogExtendEvent function call provides callers with
1125 an opportunity to extend and optionally log events without requiring
1126 knowledge of actual TPM commands.
1127 The extend operation will occur even if this function cannot create an event
1128 log entry (e.g. due to the event log being full).
1129
1130 @param[in] This Indicates the calling context
1131 @param[in] Flags Bitmap providing additional information.
1132 @param[in] DataToHash Physical address of the start of the data buffer to be hashed.
1133 @param[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash.
1134 @param[in] Event Pointer to data buffer containing information about the event.
1135
1136 @retval EFI_SUCCESS Operation completed successfully.
1137 @retval EFI_DEVICE_ERROR The command was unsuccessful.
1138 @retval EFI_VOLUME_FULL The extend operation occurred, but the event could not be written to one or more event logs.
1139 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1140 @retval EFI_UNSUPPORTED The PE/COFF image type is not supported.
1141 **/
1142 EFI_STATUS
1143 EFIAPI
1144 Tcg2HashLogExtendEvent (
1145 IN EFI_TCG2_PROTOCOL *This,
1146 IN UINT64 Flags,
1147 IN EFI_PHYSICAL_ADDRESS DataToHash,
1148 IN UINT64 DataToHashLen,
1149 IN EFI_TCG2_EVENT *Event
1150 )
1151 {
1152 EFI_STATUS Status;
1153 TCG_PCR_EVENT_HDR NewEventHdr;
1154 TPML_DIGEST_VALUES DigestList;
1155
1156 DEBUG ((DEBUG_VERBOSE, "Tcg2HashLogExtendEvent ...\n"));
1157
1158 if ((This == NULL) || (DataToHash == 0) || (Event == NULL)) {
1159 return EFI_INVALID_PARAMETER;
1160 }
1161
1162 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
1163 return EFI_DEVICE_ERROR;
1164 }
1165
1166 if (Event->Size < Event->Header.HeaderSize + sizeof(UINT32)) {
1167 return EFI_INVALID_PARAMETER;
1168 }
1169
1170 if (Event->Header.PCRIndex > MAX_PCR_INDEX) {
1171 return EFI_INVALID_PARAMETER;
1172 }
1173
1174 NewEventHdr.PCRIndex = Event->Header.PCRIndex;
1175 NewEventHdr.EventType = Event->Header.EventType;
1176 NewEventHdr.EventSize = Event->Size - sizeof(UINT32) - Event->Header.HeaderSize;
1177 if ((Flags & PE_COFF_IMAGE) != 0) {
1178 Status = MeasurePeImageAndExtend (
1179 NewEventHdr.PCRIndex,
1180 DataToHash,
1181 (UINTN)DataToHashLen,
1182 &DigestList
1183 );
1184 if (!EFI_ERROR (Status)) {
1185 if ((Flags & EFI_TCG2_EXTEND_ONLY) == 0) {
1186 Status = TcgDxeLogHashEvent (&DigestList, &NewEventHdr, Event->Event);
1187 }
1188 }
1189 if (Status == EFI_DEVICE_ERROR) {
1190 DEBUG ((EFI_D_ERROR, "MeasurePeImageAndExtend - %r. Disable TPM.\n", Status));
1191 mTcgDxeData.BsCap.TPMPresentFlag = FALSE;
1192 REPORT_STATUS_CODE (
1193 EFI_ERROR_CODE | EFI_ERROR_MINOR,
1194 (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)
1195 );
1196 }
1197 } else {
1198 Status = TcgDxeHashLogExtendEvent (
1199 Flags,
1200 (UINT8 *) (UINTN) DataToHash,
1201 DataToHashLen,
1202 &NewEventHdr,
1203 Event->Event
1204 );
1205 }
1206 DEBUG ((DEBUG_VERBOSE, "Tcg2HashLogExtendEvent - %r\n", Status));
1207 return Status;
1208 }
1209
1210 /**
1211 This service enables the sending of commands to the TPM.
1212
1213 @param[in] This Indicates the calling context
1214 @param[in] InputParameterBlockSize Size of the TPM input parameter block.
1215 @param[in] InputParameterBlock Pointer to the TPM input parameter block.
1216 @param[in] OutputParameterBlockSize Size of the TPM output parameter block.
1217 @param[in] OutputParameterBlock Pointer to the TPM output parameter block.
1218
1219 @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.
1220 @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.
1221 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1222 @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small.
1223 **/
1224 EFI_STATUS
1225 EFIAPI
1226 Tcg2SubmitCommand (
1227 IN EFI_TCG2_PROTOCOL *This,
1228 IN UINT32 InputParameterBlockSize,
1229 IN UINT8 *InputParameterBlock,
1230 IN UINT32 OutputParameterBlockSize,
1231 IN UINT8 *OutputParameterBlock
1232 )
1233 {
1234 EFI_STATUS Status;
1235
1236 DEBUG ((EFI_D_INFO, "Tcg2SubmitCommand ...\n"));
1237
1238 if ((This == NULL) ||
1239 (InputParameterBlockSize == 0) || (InputParameterBlock == NULL) ||
1240 (OutputParameterBlockSize == 0) || (OutputParameterBlock == NULL)) {
1241 return EFI_INVALID_PARAMETER;
1242 }
1243
1244 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
1245 return EFI_DEVICE_ERROR;
1246 }
1247
1248 if (InputParameterBlockSize > mTcgDxeData.BsCap.MaxCommandSize) {
1249 return EFI_INVALID_PARAMETER;
1250 }
1251 if (OutputParameterBlockSize > mTcgDxeData.BsCap.MaxResponseSize) {
1252 return EFI_INVALID_PARAMETER;
1253 }
1254
1255 Status = Tpm2SubmitCommand (
1256 InputParameterBlockSize,
1257 InputParameterBlock,
1258 &OutputParameterBlockSize,
1259 OutputParameterBlock
1260 );
1261 DEBUG ((EFI_D_INFO, "Tcg2SubmitCommand - %r\n", Status));
1262 return Status;
1263 }
1264
1265 /**
1266 This service returns the currently active PCR banks.
1267
1268 @param[in] This Indicates the calling context
1269 @param[out] ActivePcrBanks Pointer to the variable receiving the bitmap of currently active PCR banks.
1270
1271 @retval EFI_SUCCESS The bitmap of active PCR banks was stored in the ActivePcrBanks parameter.
1272 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1273 **/
1274 EFI_STATUS
1275 EFIAPI
1276 Tcg2GetActivePCRBanks (
1277 IN EFI_TCG2_PROTOCOL *This,
1278 OUT UINT32 *ActivePcrBanks
1279 )
1280 {
1281 if (ActivePcrBanks == NULL) {
1282 return EFI_INVALID_PARAMETER;
1283 }
1284 *ActivePcrBanks = mTcgDxeData.BsCap.ActivePcrBanks;
1285 return EFI_SUCCESS;
1286 }
1287
1288 /**
1289 This service sets the currently active PCR banks.
1290
1291 @param[in] This Indicates the calling context
1292 @param[in] ActivePcrBanks Bitmap of the requested active PCR banks. At least one bit SHALL be set.
1293
1294 @retval EFI_SUCCESS The bitmap in ActivePcrBank parameter is already active.
1295 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1296 **/
1297 EFI_STATUS
1298 EFIAPI
1299 Tcg2SetActivePCRBanks (
1300 IN EFI_TCG2_PROTOCOL *This,
1301 IN UINT32 ActivePcrBanks
1302 )
1303 {
1304 EFI_STATUS Status;
1305 UINT32 ReturnCode;
1306
1307 DEBUG ((EFI_D_INFO, "Tcg2SetActivePCRBanks ... (0x%x)\n", ActivePcrBanks));
1308
1309 if (ActivePcrBanks == 0) {
1310 return EFI_INVALID_PARAMETER;
1311 }
1312 if ((ActivePcrBanks & (~mTcgDxeData.BsCap.HashAlgorithmBitmap)) != 0) {
1313 return EFI_INVALID_PARAMETER;
1314 }
1315 if (ActivePcrBanks == mTcgDxeData.BsCap.ActivePcrBanks) {
1316 //
1317 // Need clear previous SET_PCR_BANKS setting
1318 //
1319 ReturnCode = Tcg2PhysicalPresenceLibSubmitRequestToPreOSFunction (TCG2_PHYSICAL_PRESENCE_NO_ACTION, 0);
1320 } else {
1321 ReturnCode = Tcg2PhysicalPresenceLibSubmitRequestToPreOSFunction (TCG2_PHYSICAL_PRESENCE_SET_PCR_BANKS, ActivePcrBanks);
1322 }
1323
1324 if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS) {
1325 Status = EFI_SUCCESS;
1326 } else if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE) {
1327 Status = EFI_OUT_OF_RESOURCES;
1328 } else if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED) {
1329 Status = EFI_UNSUPPORTED;
1330 } else {
1331 Status = EFI_DEVICE_ERROR;
1332 }
1333
1334 DEBUG ((EFI_D_INFO, "Tcg2SetActivePCRBanks - %r\n", Status));
1335
1336 return Status;
1337 }
1338
1339 /**
1340 This service retrieves the result of a previous invocation of SetActivePcrBanks.
1341
1342 @param[in] This Indicates the calling context
1343 @param[out] OperationPresent Non-zero value to indicate a SetActivePcrBank operation was invoked during the last boot.
1344 @param[out] Response The response from the SetActivePcrBank request.
1345
1346 @retval EFI_SUCCESS The result value could be returned.
1347 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1348 **/
1349 EFI_STATUS
1350 EFIAPI
1351 Tcg2GetResultOfSetActivePcrBanks (
1352 IN EFI_TCG2_PROTOCOL *This,
1353 OUT UINT32 *OperationPresent,
1354 OUT UINT32 *Response
1355 )
1356 {
1357 UINT32 ReturnCode;
1358
1359 if ((OperationPresent == NULL) || (Response == NULL)) {
1360 return EFI_INVALID_PARAMETER;
1361 }
1362
1363 ReturnCode = Tcg2PhysicalPresenceLibReturnOperationResponseToOsFunction (OperationPresent, Response);
1364 if (ReturnCode == TCG_PP_RETURN_TPM_OPERATION_RESPONSE_SUCCESS) {
1365 return EFI_SUCCESS;
1366 } else {
1367 return EFI_UNSUPPORTED;
1368 }
1369 }
1370
1371 EFI_TCG2_PROTOCOL mTcg2Protocol = {
1372 Tcg2GetCapability,
1373 Tcg2GetEventLog,
1374 Tcg2HashLogExtendEvent,
1375 Tcg2SubmitCommand,
1376 Tcg2GetActivePCRBanks,
1377 Tcg2SetActivePCRBanks,
1378 Tcg2GetResultOfSetActivePcrBanks,
1379 };
1380
1381 /**
1382 Initialize the Event Log and log events passed from the PEI phase.
1383
1384 @retval EFI_SUCCESS Operation completed successfully.
1385 @retval EFI_OUT_OF_RESOURCES Out of memory.
1386
1387 **/
1388 EFI_STATUS
1389 SetupEventLog (
1390 VOID
1391 )
1392 {
1393 EFI_STATUS Status;
1394 VOID *TcgEvent;
1395 EFI_PEI_HOB_POINTERS GuidHob;
1396 EFI_PHYSICAL_ADDRESS Lasa;
1397 UINTN Index;
1398 UINT32 DigestListBinSize;
1399 UINT32 EventSize;
1400 TCG_EfiSpecIDEventStruct *TcgEfiSpecIdEventStruct;
1401 UINT8 TempBuf[sizeof(TCG_EfiSpecIDEventStruct) + sizeof(UINT32) + (HASH_COUNT * sizeof(TCG_EfiSpecIdEventAlgorithmSize)) + sizeof(UINT8)];
1402 TCG_PCR_EVENT_HDR FirstPcrEvent;
1403 TCG_EfiSpecIdEventAlgorithmSize *DigestSize;
1404 TCG_EfiSpecIdEventAlgorithmSize *TempDigestSize;
1405 UINT8 *VendorInfoSize;
1406 UINT32 NumberOfAlgorithms;
1407
1408 DEBUG ((EFI_D_INFO, "SetupEventLog\n"));
1409
1410 //
1411 // 1. Create Log Area
1412 //
1413 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1414 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1415 mTcgDxeData.EventLogAreaStruct[Index].EventLogFormat = mTcg2EventInfo[Index].LogFormat;
1416 Lasa = (EFI_PHYSICAL_ADDRESS) (SIZE_4GB - 1);
1417 Status = gBS->AllocatePages (
1418 AllocateMaxAddress,
1419 EfiBootServicesData,
1420 EFI_SIZE_TO_PAGES (PcdGet32 (PcdTcgLogAreaMinLen)),
1421 &Lasa
1422 );
1423 if (EFI_ERROR (Status)) {
1424 return Status;
1425 }
1426 mTcgDxeData.EventLogAreaStruct[Index].Lasa = Lasa;
1427 mTcgDxeData.EventLogAreaStruct[Index].Laml = PcdGet32 (PcdTcgLogAreaMinLen);
1428 //
1429 // To initialize them as 0xFF is recommended
1430 // because the OS can know the last entry for that.
1431 //
1432 SetMem ((VOID *)(UINTN)Lasa, PcdGet32 (PcdTcgLogAreaMinLen), 0xFF);
1433 //
1434 // Create first entry for Log Header Entry Data
1435 //
1436 if (mTcg2EventInfo[Index].LogFormat != EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2) {
1437 //
1438 // TcgEfiSpecIdEventStruct
1439 //
1440 TcgEfiSpecIdEventStruct = (TCG_EfiSpecIDEventStruct *)TempBuf;
1441 CopyMem (TcgEfiSpecIdEventStruct->signature, TCG_EfiSpecIDEventStruct_SIGNATURE_03, sizeof(TcgEfiSpecIdEventStruct->signature));
1442 TcgEfiSpecIdEventStruct->platformClass = PcdGet8 (PcdTpmPlatformClass);
1443 TcgEfiSpecIdEventStruct->specVersionMajor = TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM2;
1444 TcgEfiSpecIdEventStruct->specVersionMinor = TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM2;
1445 TcgEfiSpecIdEventStruct->specErrata = TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2;
1446 TcgEfiSpecIdEventStruct->uintnSize = sizeof(UINTN)/sizeof(UINT32);
1447 NumberOfAlgorithms = 0;
1448 DigestSize = (TCG_EfiSpecIdEventAlgorithmSize *)((UINT8 *)TcgEfiSpecIdEventStruct + sizeof(*TcgEfiSpecIdEventStruct) + sizeof(NumberOfAlgorithms));
1449 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA1) != 0) {
1450 TempDigestSize = DigestSize;
1451 TempDigestSize += NumberOfAlgorithms;
1452 TempDigestSize->algorithmId = TPM_ALG_SHA1;
1453 TempDigestSize->digestSize = SHA1_DIGEST_SIZE;
1454 NumberOfAlgorithms++;
1455 }
1456 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA256) != 0) {
1457 TempDigestSize = DigestSize;
1458 TempDigestSize += NumberOfAlgorithms;
1459 TempDigestSize->algorithmId = TPM_ALG_SHA256;
1460 TempDigestSize->digestSize = SHA256_DIGEST_SIZE;
1461 NumberOfAlgorithms++;
1462 }
1463 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA384) != 0) {
1464 TempDigestSize = DigestSize;
1465 TempDigestSize += NumberOfAlgorithms;
1466 TempDigestSize->algorithmId = TPM_ALG_SHA384;
1467 TempDigestSize->digestSize = SHA384_DIGEST_SIZE;
1468 NumberOfAlgorithms++;
1469 }
1470 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA512) != 0) {
1471 TempDigestSize = DigestSize;
1472 TempDigestSize += NumberOfAlgorithms;
1473 TempDigestSize->algorithmId = TPM_ALG_SHA512;
1474 TempDigestSize->digestSize = SHA512_DIGEST_SIZE;
1475 NumberOfAlgorithms++;
1476 }
1477 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SM3_256) != 0) {
1478 TempDigestSize = DigestSize;
1479 TempDigestSize += NumberOfAlgorithms;
1480 TempDigestSize->algorithmId = TPM_ALG_SM3_256;
1481 TempDigestSize->digestSize = SM3_256_DIGEST_SIZE;
1482 NumberOfAlgorithms++;
1483 }
1484 CopyMem (TcgEfiSpecIdEventStruct + 1, &NumberOfAlgorithms, sizeof(NumberOfAlgorithms));
1485 TempDigestSize = DigestSize;
1486 TempDigestSize += NumberOfAlgorithms;
1487 VendorInfoSize = (UINT8 *)TempDigestSize;
1488 *VendorInfoSize = 0;
1489
1490 //
1491 // FirstPcrEvent
1492 //
1493 FirstPcrEvent.PCRIndex = 0;
1494 FirstPcrEvent.EventType = EV_NO_ACTION;
1495 ZeroMem (&FirstPcrEvent.Digest, sizeof(FirstPcrEvent.Digest));
1496 FirstPcrEvent.EventSize = (UINT32)GetTcgEfiSpecIdEventStructSize (TcgEfiSpecIdEventStruct);
1497
1498 //
1499 // Record
1500 //
1501 Status = TcgDxeLogEvent (
1502 mTcg2EventInfo[Index].LogFormat,
1503 &FirstPcrEvent,
1504 sizeof(FirstPcrEvent),
1505 (UINT8 *)TcgEfiSpecIdEventStruct,
1506 FirstPcrEvent.EventSize
1507 );
1508 }
1509 }
1510 }
1511
1512 //
1513 // 2. Create Final Log Area
1514 //
1515 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1516 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1517 if (mTcg2EventInfo[Index].LogFormat == EFI_TCG2_EVENT_LOG_FORMAT_TCG_2) {
1518 Lasa = (EFI_PHYSICAL_ADDRESS) (SIZE_4GB - 1);
1519 Status = gBS->AllocatePages (
1520 AllocateMaxAddress,
1521 EfiACPIMemoryNVS,
1522 EFI_SIZE_TO_PAGES (PcdGet32 (PcdTcg2FinalLogAreaLen)),
1523 &Lasa
1524 );
1525 if (EFI_ERROR (Status)) {
1526 return Status;
1527 }
1528 SetMem ((VOID *)(UINTN)Lasa, PcdGet32 (PcdTcg2FinalLogAreaLen), 0xFF);
1529
1530 //
1531 // Initialize
1532 //
1533 mTcgDxeData.FinalEventsTable[Index] = (VOID *)(UINTN)Lasa;
1534 (mTcgDxeData.FinalEventsTable[Index])->Version = EFI_TCG2_FINAL_EVENTS_TABLE_VERSION;
1535 (mTcgDxeData.FinalEventsTable[Index])->NumberOfEvents = 0;
1536
1537 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogFormat = mTcg2EventInfo[Index].LogFormat;
1538 mTcgDxeData.FinalEventLogAreaStruct[Index].Lasa = Lasa + sizeof(EFI_TCG2_FINAL_EVENTS_TABLE);
1539 mTcgDxeData.FinalEventLogAreaStruct[Index].Laml = PcdGet32 (PcdTcg2FinalLogAreaLen) - sizeof(EFI_TCG2_FINAL_EVENTS_TABLE);
1540 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogSize = 0;
1541 mTcgDxeData.FinalEventLogAreaStruct[Index].LastEvent = (VOID *)(UINTN)mTcgDxeData.FinalEventLogAreaStruct[Index].Lasa;
1542 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogStarted = FALSE;
1543 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogTruncated = FALSE;
1544
1545 //
1546 // Install to configuration table for EFI_TCG2_EVENT_LOG_FORMAT_TCG_2
1547 //
1548 Status = gBS->InstallConfigurationTable (&gEfiTcg2FinalEventsTableGuid, (VOID *)mTcgDxeData.FinalEventsTable[Index]);
1549 if (EFI_ERROR (Status)) {
1550 return Status;
1551 }
1552 } else {
1553 //
1554 // No need to handle EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2
1555 //
1556 mTcgDxeData.FinalEventsTable[Index] = NULL;
1557 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogFormat = mTcg2EventInfo[Index].LogFormat;
1558 mTcgDxeData.FinalEventLogAreaStruct[Index].Lasa = 0;
1559 mTcgDxeData.FinalEventLogAreaStruct[Index].Laml = 0;
1560 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogSize = 0;
1561 mTcgDxeData.FinalEventLogAreaStruct[Index].LastEvent = 0;
1562 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogStarted = FALSE;
1563 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogTruncated = FALSE;
1564 }
1565 }
1566 }
1567
1568 //
1569 // 3. Sync data from PEI to DXE
1570 //
1571 Status = EFI_SUCCESS;
1572 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1573 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1574 GuidHob.Raw = GetHobList ();
1575 Status = EFI_SUCCESS;
1576 while (!EFI_ERROR (Status) &&
1577 (GuidHob.Raw = GetNextGuidHob (mTcg2EventInfo[Index].EventGuid, GuidHob.Raw)) != NULL) {
1578 TcgEvent = GET_GUID_HOB_DATA (GuidHob.Guid);
1579 GuidHob.Raw = GET_NEXT_HOB (GuidHob);
1580 switch (mTcg2EventInfo[Index].LogFormat) {
1581 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2:
1582 Status = TcgDxeLogEvent (
1583 mTcg2EventInfo[Index].LogFormat,
1584 TcgEvent,
1585 sizeof(TCG_PCR_EVENT_HDR),
1586 ((TCG_PCR_EVENT*)TcgEvent)->Event,
1587 ((TCG_PCR_EVENT_HDR*)TcgEvent)->EventSize
1588 );
1589 break;
1590 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_2:
1591 DigestListBinSize = GetDigestListBinSize ((UINT8 *)TcgEvent + sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE));
1592 CopyMem (&EventSize, (UINT8 *)TcgEvent + sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE) + DigestListBinSize, sizeof(UINT32));
1593 Status = TcgDxeLogEvent (
1594 mTcg2EventInfo[Index].LogFormat,
1595 TcgEvent,
1596 sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE) + DigestListBinSize + sizeof(UINT32),
1597 (UINT8 *)TcgEvent + sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE) + DigestListBinSize + sizeof(UINT32),
1598 EventSize
1599 );
1600 break;
1601 }
1602 }
1603 }
1604 }
1605
1606 return Status;
1607 }
1608
1609 /**
1610 Measure and log an action string, and extend the measurement result into PCR[5].
1611
1612 @param[in] String A specific string that indicates an Action event.
1613
1614 @retval EFI_SUCCESS Operation completed successfully.
1615 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1616
1617 **/
1618 EFI_STATUS
1619 TcgMeasureAction (
1620 IN CHAR8 *String
1621 )
1622 {
1623 TCG_PCR_EVENT_HDR TcgEvent;
1624
1625 TcgEvent.PCRIndex = 5;
1626 TcgEvent.EventType = EV_EFI_ACTION;
1627 TcgEvent.EventSize = (UINT32)AsciiStrLen (String);
1628 return TcgDxeHashLogExtendEvent (
1629 0,
1630 (UINT8*)String,
1631 TcgEvent.EventSize,
1632 &TcgEvent,
1633 (UINT8 *) String
1634 );
1635 }
1636
1637 /**
1638 Measure and log EFI handoff tables, and extend the measurement result into PCR[1].
1639
1640 @retval EFI_SUCCESS Operation completed successfully.
1641 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1642
1643 **/
1644 EFI_STATUS
1645 MeasureHandoffTables (
1646 VOID
1647 )
1648 {
1649 EFI_STATUS Status;
1650 TCG_PCR_EVENT_HDR TcgEvent;
1651 EFI_HANDOFF_TABLE_POINTERS HandoffTables;
1652 UINTN ProcessorNum;
1653 EFI_CPU_PHYSICAL_LOCATION *ProcessorLocBuf;
1654
1655 ProcessorLocBuf = NULL;
1656 Status = EFI_SUCCESS;
1657
1658 if (PcdGet8 (PcdTpmPlatformClass) == TCG_PLATFORM_TYPE_SERVER) {
1659 //
1660 // Tcg Server spec.
1661 // Measure each processor EFI_CPU_PHYSICAL_LOCATION with EV_TABLE_OF_DEVICES to PCR[1]
1662 //
1663 Status = GetProcessorsCpuLocation(&ProcessorLocBuf, &ProcessorNum);
1664
1665 if (!EFI_ERROR(Status)){
1666 TcgEvent.PCRIndex = 1;
1667 TcgEvent.EventType = EV_TABLE_OF_DEVICES;
1668 TcgEvent.EventSize = sizeof (HandoffTables);
1669
1670 HandoffTables.NumberOfTables = 1;
1671 HandoffTables.TableEntry[0].VendorGuid = gEfiMpServiceProtocolGuid;
1672 HandoffTables.TableEntry[0].VendorTable = ProcessorLocBuf;
1673
1674 Status = TcgDxeHashLogExtendEvent (
1675 0,
1676 (UINT8*)(UINTN)ProcessorLocBuf,
1677 sizeof(EFI_CPU_PHYSICAL_LOCATION) * ProcessorNum,
1678 &TcgEvent,
1679 (UINT8*)&HandoffTables
1680 );
1681
1682 FreePool(ProcessorLocBuf);
1683 }
1684 }
1685
1686 return Status;
1687 }
1688
1689 /**
1690 Measure and log Separator event, and extend the measurement result into a specific PCR.
1691
1692 @param[in] PCRIndex PCR index.
1693
1694 @retval EFI_SUCCESS Operation completed successfully.
1695 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1696
1697 **/
1698 EFI_STATUS
1699 MeasureSeparatorEvent (
1700 IN TPM_PCRINDEX PCRIndex
1701 )
1702 {
1703 TCG_PCR_EVENT_HDR TcgEvent;
1704 UINT32 EventData;
1705
1706 DEBUG ((EFI_D_INFO, "MeasureSeparatorEvent Pcr - %x\n", PCRIndex));
1707
1708 EventData = 0;
1709 TcgEvent.PCRIndex = PCRIndex;
1710 TcgEvent.EventType = EV_SEPARATOR;
1711 TcgEvent.EventSize = (UINT32)sizeof (EventData);
1712 return TcgDxeHashLogExtendEvent (
1713 0,
1714 (UINT8 *)&EventData,
1715 sizeof (EventData),
1716 &TcgEvent,
1717 (UINT8 *)&EventData
1718 );
1719 }
1720
1721 /**
1722 Measure and log an EFI variable, and extend the measurement result into a specific PCR.
1723
1724 @param[in] PCRIndex PCR Index.
1725 @param[in] EventType Event type.
1726 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1727 @param[in] VendorGuid A unique identifier for the vendor.
1728 @param[in] VarData The content of the variable data.
1729 @param[in] VarSize The size of the variable data.
1730
1731 @retval EFI_SUCCESS Operation completed successfully.
1732 @retval EFI_OUT_OF_RESOURCES Out of memory.
1733 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1734
1735 **/
1736 EFI_STATUS
1737 MeasureVariable (
1738 IN TPM_PCRINDEX PCRIndex,
1739 IN TCG_EVENTTYPE EventType,
1740 IN CHAR16 *VarName,
1741 IN EFI_GUID *VendorGuid,
1742 IN VOID *VarData,
1743 IN UINTN VarSize
1744 )
1745 {
1746 EFI_STATUS Status;
1747 TCG_PCR_EVENT_HDR TcgEvent;
1748 UINTN VarNameLength;
1749 EFI_VARIABLE_DATA_TREE *VarLog;
1750
1751 DEBUG ((EFI_D_INFO, "Tcg2Dxe: MeasureVariable (Pcr - %x, EventType - %x, ", (UINTN)PCRIndex, (UINTN)EventType));
1752 DEBUG ((EFI_D_INFO, "VariableName - %s, VendorGuid - %g)\n", VarName, VendorGuid));
1753
1754 VarNameLength = StrLen (VarName);
1755 TcgEvent.PCRIndex = PCRIndex;
1756 TcgEvent.EventType = EventType;
1757
1758 TcgEvent.EventSize = (UINT32)(sizeof (*VarLog) + VarNameLength * sizeof (*VarName) + VarSize
1759 - sizeof (VarLog->UnicodeName) - sizeof (VarLog->VariableData));
1760
1761 VarLog = (EFI_VARIABLE_DATA_TREE *)AllocatePool (TcgEvent.EventSize);
1762 if (VarLog == NULL) {
1763 return EFI_OUT_OF_RESOURCES;
1764 }
1765
1766 VarLog->VariableName = *VendorGuid;
1767 VarLog->UnicodeNameLength = VarNameLength;
1768 VarLog->VariableDataLength = VarSize;
1769 CopyMem (
1770 VarLog->UnicodeName,
1771 VarName,
1772 VarNameLength * sizeof (*VarName)
1773 );
1774 if (VarSize != 0 && VarData != NULL) {
1775 CopyMem (
1776 (CHAR16 *)VarLog->UnicodeName + VarNameLength,
1777 VarData,
1778 VarSize
1779 );
1780 }
1781
1782 if (EventType == EV_EFI_VARIABLE_DRIVER_CONFIG) {
1783 //
1784 // Digest is the event data (EFI_VARIABLE_DATA)
1785 //
1786 Status = TcgDxeHashLogExtendEvent (
1787 0,
1788 (UINT8*)VarLog,
1789 TcgEvent.EventSize,
1790 &TcgEvent,
1791 (UINT8*)VarLog
1792 );
1793 } else {
1794 Status = TcgDxeHashLogExtendEvent (
1795 0,
1796 (UINT8*)VarData,
1797 VarSize,
1798 &TcgEvent,
1799 (UINT8*)VarLog
1800 );
1801 }
1802 FreePool (VarLog);
1803 return Status;
1804 }
1805
1806 /**
1807 Read then Measure and log an EFI variable, and extend the measurement result into a specific PCR.
1808
1809 @param[in] PCRIndex PCR Index.
1810 @param[in] EventType Event type.
1811 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1812 @param[in] VendorGuid A unique identifier for the vendor.
1813 @param[out] VarSize The size of the variable data.
1814 @param[out] VarData Pointer to the content of the variable.
1815
1816 @retval EFI_SUCCESS Operation completed successfully.
1817 @retval EFI_OUT_OF_RESOURCES Out of memory.
1818 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1819
1820 **/
1821 EFI_STATUS
1822 ReadAndMeasureVariable (
1823 IN TPM_PCRINDEX PCRIndex,
1824 IN TCG_EVENTTYPE EventType,
1825 IN CHAR16 *VarName,
1826 IN EFI_GUID *VendorGuid,
1827 OUT UINTN *VarSize,
1828 OUT VOID **VarData
1829 )
1830 {
1831 EFI_STATUS Status;
1832
1833 Status = GetVariable2 (VarName, VendorGuid, VarData, VarSize);
1834 if (EventType == EV_EFI_VARIABLE_DRIVER_CONFIG) {
1835 if (EFI_ERROR (Status)) {
1836 //
1837 // It is valid case, so we need handle it.
1838 //
1839 *VarData = NULL;
1840 *VarSize = 0;
1841 }
1842 } else {
1843 //
1844 // if status error, VarData is freed and set NULL by GetVariable2
1845 //
1846 if (EFI_ERROR (Status)) {
1847 return EFI_NOT_FOUND;
1848 }
1849 }
1850
1851 Status = MeasureVariable (
1852 PCRIndex,
1853 EventType,
1854 VarName,
1855 VendorGuid,
1856 *VarData,
1857 *VarSize
1858 );
1859 return Status;
1860 }
1861
1862 /**
1863 Read then Measure and log an EFI boot variable, and extend the measurement result into PCR[5].
1864
1865 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1866 @param[in] VendorGuid A unique identifier for the vendor.
1867 @param[out] VarSize The size of the variable data.
1868 @param[out] VarData Pointer to the content of the variable.
1869
1870 @retval EFI_SUCCESS Operation completed successfully.
1871 @retval EFI_OUT_OF_RESOURCES Out of memory.
1872 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1873
1874 **/
1875 EFI_STATUS
1876 ReadAndMeasureBootVariable (
1877 IN CHAR16 *VarName,
1878 IN EFI_GUID *VendorGuid,
1879 OUT UINTN *VarSize,
1880 OUT VOID **VarData
1881 )
1882 {
1883 return ReadAndMeasureVariable (
1884 5,
1885 EV_EFI_VARIABLE_BOOT,
1886 VarName,
1887 VendorGuid,
1888 VarSize,
1889 VarData
1890 );
1891 }
1892
1893 /**
1894 Read then Measure and log an EFI Secure variable, and extend the measurement result into PCR[7].
1895
1896 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1897 @param[in] VendorGuid A unique identifier for the vendor.
1898 @param[out] VarSize The size of the variable data.
1899 @param[out] VarData Pointer to the content of the variable.
1900
1901 @retval EFI_SUCCESS Operation completed successfully.
1902 @retval EFI_OUT_OF_RESOURCES Out of memory.
1903 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1904
1905 **/
1906 EFI_STATUS
1907 ReadAndMeasureSecureVariable (
1908 IN CHAR16 *VarName,
1909 IN EFI_GUID *VendorGuid,
1910 OUT UINTN *VarSize,
1911 OUT VOID **VarData
1912 )
1913 {
1914 return ReadAndMeasureVariable (
1915 7,
1916 EV_EFI_VARIABLE_DRIVER_CONFIG,
1917 VarName,
1918 VendorGuid,
1919 VarSize,
1920 VarData
1921 );
1922 }
1923
1924 /**
1925 Measure and log all EFI boot variables, and extend the measurement result into a specific PCR.
1926
1927 The EFI boot variables are BootOrder and Boot#### variables.
1928
1929 @retval EFI_SUCCESS Operation completed successfully.
1930 @retval EFI_OUT_OF_RESOURCES Out of memory.
1931 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1932
1933 **/
1934 EFI_STATUS
1935 MeasureAllBootVariables (
1936 VOID
1937 )
1938 {
1939 EFI_STATUS Status;
1940 UINT16 *BootOrder;
1941 UINTN BootCount;
1942 UINTN Index;
1943 VOID *BootVarData;
1944 UINTN Size;
1945
1946 Status = ReadAndMeasureBootVariable (
1947 mBootVarName,
1948 &gEfiGlobalVariableGuid,
1949 &BootCount,
1950 (VOID **) &BootOrder
1951 );
1952 if (Status == EFI_NOT_FOUND || BootOrder == NULL) {
1953 return EFI_SUCCESS;
1954 }
1955
1956 if (EFI_ERROR (Status)) {
1957 //
1958 // BootOrder can't be NULL if status is not EFI_NOT_FOUND
1959 //
1960 FreePool (BootOrder);
1961 return Status;
1962 }
1963
1964 BootCount /= sizeof (*BootOrder);
1965 for (Index = 0; Index < BootCount; Index++) {
1966 UnicodeSPrint (mBootVarName, sizeof (mBootVarName), L"Boot%04x", BootOrder[Index]);
1967 Status = ReadAndMeasureBootVariable (
1968 mBootVarName,
1969 &gEfiGlobalVariableGuid,
1970 &Size,
1971 &BootVarData
1972 );
1973 if (!EFI_ERROR (Status)) {
1974 FreePool (BootVarData);
1975 }
1976 }
1977
1978 FreePool (BootOrder);
1979 return EFI_SUCCESS;
1980 }
1981
1982 /**
1983 Measure and log all EFI Secure variables, and extend the measurement result into a specific PCR.
1984
1985 The EFI boot variables are BootOrder and Boot#### variables.
1986
1987 @retval EFI_SUCCESS Operation completed successfully.
1988 @retval EFI_OUT_OF_RESOURCES Out of memory.
1989 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1990
1991 **/
1992 EFI_STATUS
1993 MeasureAllSecureVariables (
1994 VOID
1995 )
1996 {
1997 EFI_STATUS Status;
1998 VOID *Data;
1999 UINTN DataSize;
2000 UINTN Index;
2001
2002 Status = EFI_NOT_FOUND;
2003 for (Index = 0; Index < sizeof(mVariableType)/sizeof(mVariableType[0]); Index++) {
2004 Status = ReadAndMeasureSecureVariable (
2005 mVariableType[Index].VariableName,
2006 mVariableType[Index].VendorGuid,
2007 &DataSize,
2008 &Data
2009 );
2010 if (!EFI_ERROR (Status)) {
2011 if (Data != NULL) {
2012 FreePool (Data);
2013 }
2014 }
2015 }
2016
2017 return EFI_SUCCESS;
2018 }
2019
2020 /**
2021 Measure and log launch of FirmwareDebugger, and extend the measurement result into a specific PCR.
2022
2023 @retval EFI_SUCCESS Operation completed successfully.
2024 @retval EFI_OUT_OF_RESOURCES Out of memory.
2025 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
2026
2027 **/
2028 EFI_STATUS
2029 MeasureLaunchOfFirmwareDebugger (
2030 VOID
2031 )
2032 {
2033 TCG_PCR_EVENT_HDR TcgEvent;
2034
2035 TcgEvent.PCRIndex = 7;
2036 TcgEvent.EventType = EV_EFI_ACTION;
2037 TcgEvent.EventSize = sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1;
2038 return TcgDxeHashLogExtendEvent (
2039 0,
2040 (UINT8 *)FIRMWARE_DEBUGGER_EVENT_STRING,
2041 sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1,
2042 &TcgEvent,
2043 (UINT8 *)FIRMWARE_DEBUGGER_EVENT_STRING
2044 );
2045 }
2046
2047 /**
2048 Measure and log all Secure Boot Policy, and extend the measurement result into a specific PCR.
2049
2050 Platform firmware adhering to the policy must therefore measure the following values into PCR[7]: (in order listed)
2051 - The contents of the SecureBoot variable
2052 - The contents of the PK variable
2053 - The contents of the KEK variable
2054 - The contents of the EFI_IMAGE_SECURITY_DATABASE variable
2055 - The contents of the EFI_IMAGE_SECURITY_DATABASE1 variable
2056 - Separator
2057 - Entries in the EFI_IMAGE_SECURITY_DATABASE that are used to validate EFI Drivers or EFI Boot Applications in the boot path
2058
2059 NOTE: Because of the above, UEFI variables PK, KEK, EFI_IMAGE_SECURITY_DATABASE,
2060 EFI_IMAGE_SECURITY_DATABASE1 and SecureBoot SHALL NOT be measured into PCR[3].
2061
2062 @param[in] Event Event whose notification function is being invoked
2063 @param[in] Context Pointer to the notification function's context
2064 **/
2065 VOID
2066 EFIAPI
2067 MeasureSecureBootPolicy (
2068 IN EFI_EVENT Event,
2069 IN VOID *Context
2070 )
2071 {
2072 EFI_STATUS Status;
2073 VOID *Protocol;
2074
2075 Status = gBS->LocateProtocol (&gEfiVariableWriteArchProtocolGuid, NULL, (VOID **)&Protocol);
2076 if (EFI_ERROR (Status)) {
2077 return;
2078 }
2079
2080 if (PcdGetBool (PcdFirmwareDebuggerInitialized)) {
2081 Status = MeasureLaunchOfFirmwareDebugger ();
2082 DEBUG ((EFI_D_INFO, "MeasureLaunchOfFirmwareDebugger - %r\n", Status));
2083 }
2084
2085 Status = MeasureAllSecureVariables ();
2086 DEBUG ((EFI_D_INFO, "MeasureAllSecureVariables - %r\n", Status));
2087
2088 //
2089 // We need measure Separator(7) here, because this event must be between SecureBootPolicy (Configure)
2090 // and ImageVerification (Authority)
2091 // There might be a case that we need measure UEFI image from DriverOrder, besides BootOrder. So
2092 // the Authority measurement happen before ReadToBoot event.
2093 //
2094 Status = MeasureSeparatorEvent (7);
2095 DEBUG ((EFI_D_INFO, "MeasureSeparatorEvent - %r\n", Status));
2096 return ;
2097 }
2098
2099 /**
2100 Ready to Boot Event notification handler.
2101
2102 Sequence of OS boot events is measured in this event notification handler.
2103
2104 @param[in] Event Event whose notification function is being invoked
2105 @param[in] Context Pointer to the notification function's context
2106
2107 **/
2108 VOID
2109 EFIAPI
2110 OnReadyToBoot (
2111 IN EFI_EVENT Event,
2112 IN VOID *Context
2113 )
2114 {
2115 EFI_STATUS Status;
2116 TPM_PCRINDEX PcrIndex;
2117
2118 PERF_START_EX (mImageHandle, "EventRec", "Tcg2Dxe", 0, PERF_ID_TCG2_DXE);
2119 if (mBootAttempts == 0) {
2120
2121 //
2122 // Measure handoff tables.
2123 //
2124 Status = MeasureHandoffTables ();
2125 if (EFI_ERROR (Status)) {
2126 DEBUG ((EFI_D_ERROR, "HOBs not Measured. Error!\n"));
2127 }
2128
2129 //
2130 // Measure BootOrder & Boot#### variables.
2131 //
2132 Status = MeasureAllBootVariables ();
2133 if (EFI_ERROR (Status)) {
2134 DEBUG ((EFI_D_ERROR, "Boot Variables not Measured. Error!\n"));
2135 }
2136
2137 //
2138 // 1. This is the first boot attempt.
2139 //
2140 Status = TcgMeasureAction (
2141 EFI_CALLING_EFI_APPLICATION
2142 );
2143 if (EFI_ERROR (Status)) {
2144 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_CALLING_EFI_APPLICATION));
2145 }
2146
2147 //
2148 // 2. Draw a line between pre-boot env and entering post-boot env.
2149 // PCR[7] is already done.
2150 //
2151 for (PcrIndex = 0; PcrIndex < 7; PcrIndex++) {
2152 Status = MeasureSeparatorEvent (PcrIndex);
2153 if (EFI_ERROR (Status)) {
2154 DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n"));
2155 }
2156 }
2157
2158 //
2159 // 3. Measure GPT. It would be done in SAP driver.
2160 //
2161
2162 //
2163 // 4. Measure PE/COFF OS loader. It would be done in SAP driver.
2164 //
2165
2166 //
2167 // 5. Read & Measure variable. BootOrder already measured.
2168 //
2169 } else {
2170 //
2171 // 6. Not first attempt, meaning a return from last attempt
2172 //
2173 Status = TcgMeasureAction (
2174 EFI_RETURNING_FROM_EFI_APPLICATOIN
2175 );
2176 if (EFI_ERROR (Status)) {
2177 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_RETURNING_FROM_EFI_APPLICATOIN));
2178 }
2179 }
2180
2181 DEBUG ((EFI_D_INFO, "TPM2 Tcg2Dxe Measure Data when ReadyToBoot\n"));
2182 //
2183 // Increase boot attempt counter.
2184 //
2185 mBootAttempts++;
2186 PERF_END_EX (mImageHandle, "EventRec", "Tcg2Dxe", 0, PERF_ID_TCG2_DXE + 1);
2187 }
2188
2189 /**
2190 Exit Boot Services Event notification handler.
2191
2192 Measure invocation and success of ExitBootServices.
2193
2194 @param[in] Event Event whose notification function is being invoked
2195 @param[in] Context Pointer to the notification function's context
2196
2197 **/
2198 VOID
2199 EFIAPI
2200 OnExitBootServices (
2201 IN EFI_EVENT Event,
2202 IN VOID *Context
2203 )
2204 {
2205 EFI_STATUS Status;
2206
2207 //
2208 // Measure invocation of ExitBootServices,
2209 //
2210 Status = TcgMeasureAction (
2211 EFI_EXIT_BOOT_SERVICES_INVOCATION
2212 );
2213 if (EFI_ERROR (Status)) {
2214 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_EXIT_BOOT_SERVICES_INVOCATION));
2215 }
2216
2217 //
2218 // Measure success of ExitBootServices
2219 //
2220 Status = TcgMeasureAction (
2221 EFI_EXIT_BOOT_SERVICES_SUCCEEDED
2222 );
2223 if (EFI_ERROR (Status)) {
2224 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_EXIT_BOOT_SERVICES_SUCCEEDED));
2225 }
2226 }
2227
2228 /**
2229 Exit Boot Services Failed Event notification handler.
2230
2231 Measure Failure of ExitBootServices.
2232
2233 @param[in] Event Event whose notification function is being invoked
2234 @param[in] Context Pointer to the notification function's context
2235
2236 **/
2237 VOID
2238 EFIAPI
2239 OnExitBootServicesFailed (
2240 IN EFI_EVENT Event,
2241 IN VOID *Context
2242 )
2243 {
2244 EFI_STATUS Status;
2245
2246 //
2247 // Measure Failure of ExitBootServices,
2248 //
2249 Status = TcgMeasureAction (
2250 EFI_EXIT_BOOT_SERVICES_FAILED
2251 );
2252 if (EFI_ERROR (Status)) {
2253 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_EXIT_BOOT_SERVICES_FAILED));
2254 }
2255
2256 }
2257
2258 /**
2259 The function install Tcg2 protocol.
2260
2261 @retval EFI_SUCCESS Tcg2 protocol is installed.
2262 @retval other Some error occurs.
2263 **/
2264 EFI_STATUS
2265 InstallTcg2 (
2266 VOID
2267 )
2268 {
2269 EFI_STATUS Status;
2270 EFI_HANDLE Handle;
2271
2272 Handle = NULL;
2273 Status = gBS->InstallMultipleProtocolInterfaces (
2274 &Handle,
2275 &gEfiTcg2ProtocolGuid,
2276 &mTcg2Protocol,
2277 NULL
2278 );
2279 return Status;
2280 }
2281
2282 /**
2283 The driver's entry point. It publishes EFI Tcg2 Protocol.
2284
2285 @param[in] ImageHandle The firmware allocated handle for the EFI image.
2286 @param[in] SystemTable A pointer to the EFI System Table.
2287
2288 @retval EFI_SUCCESS The entry point is executed successfully.
2289 @retval other Some error occurs when executing this entry point.
2290 **/
2291 EFI_STATUS
2292 EFIAPI
2293 DriverEntry (
2294 IN EFI_HANDLE ImageHandle,
2295 IN EFI_SYSTEM_TABLE *SystemTable
2296 )
2297 {
2298 EFI_STATUS Status;
2299 EFI_EVENT Event;
2300 VOID *Registration;
2301 UINT32 MaxCommandSize;
2302 UINT32 MaxResponseSize;
2303 TPML_PCR_SELECTION Pcrs;
2304 UINTN Index;
2305 EFI_TCG2_EVENT_ALGORITHM_BITMAP TpmHashAlgorithmBitmap;
2306 UINT32 ActivePCRBanks;
2307 UINT32 NumberOfPCRBanks;
2308
2309 mImageHandle = ImageHandle;
2310
2311 if (CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &gEfiTpmDeviceInstanceNoneGuid) ||
2312 CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &gEfiTpmDeviceInstanceTpm12Guid)){
2313 DEBUG ((EFI_D_ERROR, "No TPM2 instance required!\n"));
2314 return EFI_UNSUPPORTED;
2315 }
2316
2317 if (GetFirstGuidHob (&gTpmErrorHobGuid) != NULL) {
2318 DEBUG ((EFI_D_ERROR, "TPM2 error!\n"));
2319 return EFI_DEVICE_ERROR;
2320 }
2321
2322 Status = Tpm2RequestUseTpm ();
2323 if (EFI_ERROR (Status)) {
2324 DEBUG ((EFI_D_ERROR, "TPM2 not detected!\n"));
2325 return Status;
2326 }
2327
2328 //
2329 // Fill information
2330 //
2331 ASSERT (TCG_EVENT_LOG_AREA_COUNT_MAX == sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]));
2332
2333 mTcgDxeData.BsCap.Size = sizeof(EFI_TCG2_BOOT_SERVICE_CAPABILITY);
2334 mTcgDxeData.BsCap.ProtocolVersion.Major = 1;
2335 mTcgDxeData.BsCap.ProtocolVersion.Minor = 1;
2336 mTcgDxeData.BsCap.StructureVersion.Major = 1;
2337 mTcgDxeData.BsCap.StructureVersion.Minor = 1;
2338
2339 DEBUG ((EFI_D_INFO, "Tcg2.ProtocolVersion - %02x.%02x\n", mTcgDxeData.BsCap.ProtocolVersion.Major, mTcgDxeData.BsCap.ProtocolVersion.Minor));
2340 DEBUG ((EFI_D_INFO, "Tcg2.StructureVersion - %02x.%02x\n", mTcgDxeData.BsCap.StructureVersion.Major, mTcgDxeData.BsCap.StructureVersion.Minor));
2341
2342 Status = Tpm2GetCapabilityManufactureID (&mTcgDxeData.BsCap.ManufacturerID);
2343 if (EFI_ERROR (Status)) {
2344 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityManufactureID fail!\n"));
2345 } else {
2346 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityManufactureID - %08x\n", mTcgDxeData.BsCap.ManufacturerID));
2347 }
2348
2349 DEBUG_CODE (
2350 UINT32 FirmwareVersion1;
2351 UINT32 FirmwareVersion2;
2352
2353 Status = Tpm2GetCapabilityFirmwareVersion (&FirmwareVersion1, &FirmwareVersion2);
2354 if (EFI_ERROR (Status)) {
2355 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityFirmwareVersion fail!\n"));
2356 } else {
2357 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityFirmwareVersion - %08x %08x\n", FirmwareVersion1, FirmwareVersion2));
2358 }
2359 );
2360
2361 Status = Tpm2GetCapabilityMaxCommandResponseSize (&MaxCommandSize, &MaxResponseSize);
2362 if (EFI_ERROR (Status)) {
2363 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityMaxCommandResponseSize fail!\n"));
2364 } else {
2365 mTcgDxeData.BsCap.MaxCommandSize = (UINT16)MaxCommandSize;
2366 mTcgDxeData.BsCap.MaxResponseSize = (UINT16)MaxResponseSize;
2367 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityMaxCommandResponseSize - %08x, %08x\n", MaxCommandSize, MaxResponseSize));
2368 }
2369
2370 //
2371 // Get supported PCR and current Active PCRs
2372 //
2373 Status = Tpm2GetCapabilityPcrs (&Pcrs);
2374 if (EFI_ERROR (Status)) {
2375 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityPcrs fail!\n"));
2376 TpmHashAlgorithmBitmap = EFI_TCG2_BOOT_HASH_ALG_SHA1;
2377 ActivePCRBanks = EFI_TCG2_BOOT_HASH_ALG_SHA1;
2378 } else {
2379 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityPcrs Count - %08x\n", Pcrs.count));
2380 TpmHashAlgorithmBitmap = 0;
2381 ActivePCRBanks = 0;
2382 for (Index = 0; Index < Pcrs.count; Index++) {
2383 DEBUG ((EFI_D_INFO, "hash - %x\n", Pcrs.pcrSelections[Index].hash));
2384 switch (Pcrs.pcrSelections[Index].hash) {
2385 case TPM_ALG_SHA1:
2386 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA1;
2387 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2388 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA1;
2389 }
2390 break;
2391 case TPM_ALG_SHA256:
2392 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA256;
2393 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2394 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA256;
2395 }
2396 break;
2397 case TPM_ALG_SHA384:
2398 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA384;
2399 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2400 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA384;
2401 }
2402 break;
2403 case TPM_ALG_SHA512:
2404 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA512;
2405 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2406 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA512;
2407 }
2408 break;
2409 case TPM_ALG_SM3_256:
2410 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SM3_256;
2411 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2412 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SM3_256;
2413 }
2414 break;
2415 }
2416 }
2417 }
2418 mTcgDxeData.BsCap.HashAlgorithmBitmap = TpmHashAlgorithmBitmap & PcdGet32 (PcdTcg2HashAlgorithmBitmap);
2419 mTcgDxeData.BsCap.ActivePcrBanks = ActivePCRBanks & PcdGet32 (PcdTcg2HashAlgorithmBitmap);
2420
2421 //
2422 // Need calculate NumberOfPCRBanks here, because HashAlgorithmBitmap might be removed by PCD.
2423 //
2424 NumberOfPCRBanks = 0;
2425 for (Index = 0; Index < 32; Index++) {
2426 if ((mTcgDxeData.BsCap.HashAlgorithmBitmap & (1u << Index)) != 0) {
2427 NumberOfPCRBanks++;
2428 }
2429 }
2430
2431 if (PcdGet32 (PcdTcg2NumberOfPCRBanks) == 0) {
2432 mTcgDxeData.BsCap.NumberOfPCRBanks = NumberOfPCRBanks;
2433 } else {
2434 mTcgDxeData.BsCap.NumberOfPCRBanks = PcdGet32 (PcdTcg2NumberOfPCRBanks);
2435 if (PcdGet32 (PcdTcg2NumberOfPCRBanks) > NumberOfPCRBanks) {
2436 DEBUG ((EFI_D_ERROR, "ERROR: PcdTcg2NumberOfPCRBanks(0x%x) > NumberOfPCRBanks(0x%x)\n", PcdGet32 (PcdTcg2NumberOfPCRBanks), NumberOfPCRBanks));
2437 mTcgDxeData.BsCap.NumberOfPCRBanks = NumberOfPCRBanks;
2438 }
2439 }
2440
2441 mTcgDxeData.BsCap.SupportedEventLogs = EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2 | EFI_TCG2_EVENT_LOG_FORMAT_TCG_2;
2442 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA1) == 0) {
2443 //
2444 // No need to expose TCG1.2 event log if SHA1 bank does not exist.
2445 //
2446 mTcgDxeData.BsCap.SupportedEventLogs &= ~EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2;
2447 }
2448
2449 DEBUG ((EFI_D_INFO, "Tcg2.SupportedEventLogs - 0x%08x\n", mTcgDxeData.BsCap.SupportedEventLogs));
2450 DEBUG ((EFI_D_INFO, "Tcg2.HashAlgorithmBitmap - 0x%08x\n", mTcgDxeData.BsCap.HashAlgorithmBitmap));
2451 DEBUG ((EFI_D_INFO, "Tcg2.NumberOfPCRBanks - 0x%08x\n", mTcgDxeData.BsCap.NumberOfPCRBanks));
2452 DEBUG ((EFI_D_INFO, "Tcg2.ActivePcrBanks - 0x%08x\n", mTcgDxeData.BsCap.ActivePcrBanks));
2453
2454 if (mTcgDxeData.BsCap.TPMPresentFlag) {
2455 //
2456 // Setup the log area and copy event log from hob list to it
2457 //
2458 Status = SetupEventLog ();
2459 ASSERT_EFI_ERROR (Status);
2460
2461 //
2462 // Measure handoff tables, Boot#### variables etc.
2463 //
2464 Status = EfiCreateEventReadyToBootEx (
2465 TPL_CALLBACK,
2466 OnReadyToBoot,
2467 NULL,
2468 &Event
2469 );
2470
2471 Status = gBS->CreateEventEx (
2472 EVT_NOTIFY_SIGNAL,
2473 TPL_NOTIFY,
2474 OnExitBootServices,
2475 NULL,
2476 &gEfiEventExitBootServicesGuid,
2477 &Event
2478 );
2479
2480 //
2481 // Measure Exit Boot Service failed
2482 //
2483 Status = gBS->CreateEventEx (
2484 EVT_NOTIFY_SIGNAL,
2485 TPL_NOTIFY,
2486 OnExitBootServicesFailed,
2487 NULL,
2488 &gEventExitBootServicesFailedGuid,
2489 &Event
2490 );
2491
2492 //
2493 // Create event callback, because we need access variable on SecureBootPolicyVariable
2494 // We should use VariableWriteArch instead of VariableArch, because Variable driver
2495 // may update SecureBoot value based on last setting.
2496 //
2497 EfiCreateProtocolNotifyEvent (&gEfiVariableWriteArchProtocolGuid, TPL_CALLBACK, MeasureSecureBootPolicy, NULL, &Registration);
2498 }
2499
2500 //
2501 // Install Tcg2Protocol
2502 //
2503 Status = InstallTcg2 ();
2504 DEBUG ((EFI_D_INFO, "InstallTcg2 - %r\n", Status));
2505
2506 return Status;
2507 }
EFI Development Kit II mirror for PVE