]> 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 GetDigestFromDigestList() 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 data size.
868
869 @param[in] DigestList TPML_DIGEST_VALUES data.
870
871 @return TPML_DIGEST_VALUES data size.
872 **/
873 UINT32
874 GetDigestListSize (
875 IN TPML_DIGEST_VALUES *DigestList
876 )
877 {
878 UINTN Index;
879 UINT16 DigestSize;
880 UINT32 TotalSize;
881
882 TotalSize = sizeof(DigestList->count);
883 for (Index = 0; Index < DigestList->count; Index++) {
884 DigestSize = GetHashSizeFromAlgo (DigestList->digests[Index].hashAlg);
885 TotalSize += sizeof(DigestList->digests[Index].hashAlg) + DigestSize;
886 }
887
888 return TotalSize;
889 }
890
891 /**
892 Get TPML_DIGEST_VALUES compact binary buffer size.
893
894 @param[in] DigestListBin TPML_DIGEST_VALUES compact binary buffer.
895
896 @return TPML_DIGEST_VALUES compact binary buffer size.
897 **/
898 UINT32
899 GetDigestListBinSize (
900 IN VOID *DigestListBin
901 )
902 {
903 UINTN Index;
904 UINT16 DigestSize;
905 UINT32 TotalSize;
906 UINT32 Count;
907 TPMI_ALG_HASH HashAlg;
908
909 Count = ReadUnaligned32 (DigestListBin);
910 TotalSize = sizeof(Count);
911 DigestListBin = (UINT8 *)DigestListBin + sizeof(Count);
912 for (Index = 0; Index < Count; Index++) {
913 HashAlg = ReadUnaligned16 (DigestListBin);
914 TotalSize += sizeof(HashAlg);
915 DigestListBin = (UINT8 *)DigestListBin + sizeof(HashAlg);
916
917 DigestSize = GetHashSizeFromAlgo (HashAlg);
918 TotalSize += DigestSize;
919 DigestListBin = (UINT8 *)DigestListBin + DigestSize;
920 }
921
922 return TotalSize;
923 }
924
925 /**
926 Return if hash alg is supported in TPM PCR bank.
927
928 @param HashAlg Hash algorithm to be checked.
929
930 @retval TRUE Hash algorithm is supported.
931 @retval FALSE Hash algorithm is not supported.
932 **/
933 BOOLEAN
934 IsHashAlgSupportedInPcrBank (
935 IN TPMI_ALG_HASH HashAlg
936 )
937 {
938 switch (HashAlg) {
939 case TPM_ALG_SHA1:
940 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA1) != 0) {
941 return TRUE;
942 }
943 break;
944 case TPM_ALG_SHA256:
945 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA256) != 0) {
946 return TRUE;
947 }
948 break;
949 case TPM_ALG_SHA384:
950 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA384) != 0) {
951 return TRUE;
952 }
953 break;
954 case TPM_ALG_SHA512:
955 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA512) != 0) {
956 return TRUE;
957 }
958 break;
959 case TPM_ALG_SM3_256:
960 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SM3_256) != 0) {
961 return TRUE;
962 }
963 break;
964 }
965
966 return FALSE;
967 }
968
969 /**
970 Copy TPML_DIGEST_VALUES into a buffer
971
972 @param[in,out] Buffer Buffer to hold TPML_DIGEST_VALUES.
973 @param[in] DigestList TPML_DIGEST_VALUES to be copied.
974
975 @return The end of buffer to hold TPML_DIGEST_VALUES.
976 **/
977 VOID *
978 CopyDigestListToBuffer (
979 IN OUT VOID *Buffer,
980 IN TPML_DIGEST_VALUES *DigestList
981 )
982 {
983 UINTN Index;
984 UINT16 DigestSize;
985
986 CopyMem (Buffer, &DigestList->count, sizeof(DigestList->count));
987 Buffer = (UINT8 *)Buffer + sizeof(DigestList->count);
988 for (Index = 0; Index < DigestList->count; Index++) {
989 if (!IsHashAlgSupportedInPcrBank (DigestList->digests[Index].hashAlg)) {
990 DEBUG ((EFI_D_ERROR, "WARNING: TPM2 Event log has HashAlg unsupported by PCR bank (0x%x)\n", DigestList->digests[Index].hashAlg));
991 continue;
992 }
993 CopyMem (Buffer, &DigestList->digests[Index].hashAlg, sizeof(DigestList->digests[Index].hashAlg));
994 Buffer = (UINT8 *)Buffer + sizeof(DigestList->digests[Index].hashAlg);
995 DigestSize = GetHashSizeFromAlgo (DigestList->digests[Index].hashAlg);
996 CopyMem (Buffer, &DigestList->digests[Index].digest, DigestSize);
997 Buffer = (UINT8 *)Buffer + DigestSize;
998 }
999
1000 return Buffer;
1001 }
1002
1003 /**
1004 Add a new entry to the Event Log.
1005
1006 @param[in] DigestList A list of digest.
1007 @param[in,out] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR data structure.
1008 @param[in] NewEventData Pointer to the new event data.
1009
1010 @retval EFI_SUCCESS The new event log entry was added.
1011 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
1012 **/
1013 EFI_STATUS
1014 TcgDxeLogHashEvent (
1015 IN TPML_DIGEST_VALUES *DigestList,
1016 IN OUT TCG_PCR_EVENT_HDR *NewEventHdr,
1017 IN UINT8 *NewEventData
1018 )
1019 {
1020 EFI_STATUS Status;
1021 EFI_TPL OldTpl;
1022 UINTN Index;
1023 EFI_STATUS RetStatus;
1024 TCG_PCR_EVENT2 TcgPcrEvent2;
1025 UINT8 *DigestBuffer;
1026
1027 DEBUG ((EFI_D_INFO, "SupportedEventLogs - 0x%08x\n", mTcgDxeData.BsCap.SupportedEventLogs));
1028
1029 RetStatus = EFI_SUCCESS;
1030 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1031 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1032 DEBUG ((EFI_D_INFO, " LogFormat - 0x%08x\n", mTcg2EventInfo[Index].LogFormat));
1033 switch (mTcg2EventInfo[Index].LogFormat) {
1034 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2:
1035 Status = GetDigestFromDigestList (TPM_ALG_SHA1, DigestList, &NewEventHdr->Digest);
1036 if (!EFI_ERROR (Status)) {
1037 //
1038 // Enter critical region
1039 //
1040 OldTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);
1041 Status = TcgDxeLogEvent (
1042 mTcg2EventInfo[Index].LogFormat,
1043 NewEventHdr,
1044 sizeof(TCG_PCR_EVENT_HDR),
1045 NewEventData,
1046 NewEventHdr->EventSize
1047 );
1048 if (Status != EFI_SUCCESS) {
1049 RetStatus = Status;
1050 }
1051 gBS->RestoreTPL (OldTpl);
1052 //
1053 // Exit critical region
1054 //
1055 }
1056 break;
1057 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_2:
1058 ZeroMem (&TcgPcrEvent2, sizeof(TcgPcrEvent2));
1059 TcgPcrEvent2.PCRIndex = NewEventHdr->PCRIndex;
1060 TcgPcrEvent2.EventType = NewEventHdr->EventType;
1061 DigestBuffer = (UINT8 *)&TcgPcrEvent2.Digest;
1062 DigestBuffer = CopyDigestListToBuffer (DigestBuffer, DigestList);
1063 CopyMem (DigestBuffer, &NewEventHdr->EventSize, sizeof(NewEventHdr->EventSize));
1064 DigestBuffer = DigestBuffer + sizeof(NewEventHdr->EventSize);
1065
1066 //
1067 // Enter critical region
1068 //
1069 OldTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);
1070 Status = TcgDxeLogEvent (
1071 mTcg2EventInfo[Index].LogFormat,
1072 &TcgPcrEvent2,
1073 sizeof(TcgPcrEvent2.PCRIndex) + sizeof(TcgPcrEvent2.EventType) + GetDigestListSize (DigestList) + sizeof(TcgPcrEvent2.EventSize),
1074 NewEventData,
1075 NewEventHdr->EventSize
1076 );
1077 if (Status != EFI_SUCCESS) {
1078 RetStatus = Status;
1079 }
1080 gBS->RestoreTPL (OldTpl);
1081 //
1082 // Exit critical region
1083 //
1084 break;
1085 }
1086 }
1087 }
1088
1089 return RetStatus;
1090 }
1091
1092 /**
1093 Do a hash operation on a data buffer, extend a specific TPM PCR with the hash result,
1094 and add an entry to the Event Log.
1095
1096 @param[in] Flags Bitmap providing additional information.
1097 @param[in] HashData Physical address of the start of the data buffer
1098 to be hashed, extended, and logged.
1099 @param[in] HashDataLen The length, in bytes, of the buffer referenced by HashData
1100 @param[in, out] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR data structure.
1101 @param[in] NewEventData Pointer to the new event data.
1102
1103 @retval EFI_SUCCESS Operation completed successfully.
1104 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
1105 @retval EFI_DEVICE_ERROR The command was unsuccessful.
1106
1107 **/
1108 EFI_STATUS
1109 TcgDxeHashLogExtendEvent (
1110 IN UINT64 Flags,
1111 IN UINT8 *HashData,
1112 IN UINT64 HashDataLen,
1113 IN OUT TCG_PCR_EVENT_HDR *NewEventHdr,
1114 IN UINT8 *NewEventData
1115 )
1116 {
1117 EFI_STATUS Status;
1118 TPML_DIGEST_VALUES DigestList;
1119
1120 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
1121 return EFI_DEVICE_ERROR;
1122 }
1123
1124 Status = HashAndExtend (
1125 NewEventHdr->PCRIndex,
1126 HashData,
1127 (UINTN)HashDataLen,
1128 &DigestList
1129 );
1130 if (!EFI_ERROR (Status)) {
1131 if ((Flags & EFI_TCG2_EXTEND_ONLY) == 0) {
1132 Status = TcgDxeLogHashEvent (&DigestList, NewEventHdr, NewEventData);
1133 }
1134 }
1135
1136 if (Status == EFI_DEVICE_ERROR) {
1137 DEBUG ((EFI_D_ERROR, "TcgDxeHashLogExtendEvent - %r. Disable TPM.\n", Status));
1138 mTcgDxeData.BsCap.TPMPresentFlag = FALSE;
1139 REPORT_STATUS_CODE (
1140 EFI_ERROR_CODE | EFI_ERROR_MINOR,
1141 (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)
1142 );
1143 }
1144
1145 return Status;
1146 }
1147
1148 /**
1149 The EFI_TCG2_PROTOCOL HashLogExtendEvent function call provides callers with
1150 an opportunity to extend and optionally log events without requiring
1151 knowledge of actual TPM commands.
1152 The extend operation will occur even if this function cannot create an event
1153 log entry (e.g. due to the event log being full).
1154
1155 @param[in] This Indicates the calling context
1156 @param[in] Flags Bitmap providing additional information.
1157 @param[in] DataToHash Physical address of the start of the data buffer to be hashed.
1158 @param[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash.
1159 @param[in] Event Pointer to data buffer containing information about the event.
1160
1161 @retval EFI_SUCCESS Operation completed successfully.
1162 @retval EFI_DEVICE_ERROR The command was unsuccessful.
1163 @retval EFI_VOLUME_FULL The extend operation occurred, but the event could not be written to one or more event logs.
1164 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1165 @retval EFI_UNSUPPORTED The PE/COFF image type is not supported.
1166 **/
1167 EFI_STATUS
1168 EFIAPI
1169 Tcg2HashLogExtendEvent (
1170 IN EFI_TCG2_PROTOCOL *This,
1171 IN UINT64 Flags,
1172 IN EFI_PHYSICAL_ADDRESS DataToHash,
1173 IN UINT64 DataToHashLen,
1174 IN EFI_TCG2_EVENT *Event
1175 )
1176 {
1177 EFI_STATUS Status;
1178 TCG_PCR_EVENT_HDR NewEventHdr;
1179 TPML_DIGEST_VALUES DigestList;
1180
1181 DEBUG ((DEBUG_VERBOSE, "Tcg2HashLogExtendEvent ...\n"));
1182
1183 if ((This == NULL) || (DataToHash == 0) || (Event == NULL)) {
1184 return EFI_INVALID_PARAMETER;
1185 }
1186
1187 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
1188 return EFI_DEVICE_ERROR;
1189 }
1190
1191 if (Event->Size < Event->Header.HeaderSize + sizeof(UINT32)) {
1192 return EFI_INVALID_PARAMETER;
1193 }
1194
1195 if (Event->Header.PCRIndex > MAX_PCR_INDEX) {
1196 return EFI_INVALID_PARAMETER;
1197 }
1198
1199 NewEventHdr.PCRIndex = Event->Header.PCRIndex;
1200 NewEventHdr.EventType = Event->Header.EventType;
1201 NewEventHdr.EventSize = Event->Size - sizeof(UINT32) - Event->Header.HeaderSize;
1202 if ((Flags & PE_COFF_IMAGE) != 0) {
1203 Status = MeasurePeImageAndExtend (
1204 NewEventHdr.PCRIndex,
1205 DataToHash,
1206 (UINTN)DataToHashLen,
1207 &DigestList
1208 );
1209 if (!EFI_ERROR (Status)) {
1210 if ((Flags & EFI_TCG2_EXTEND_ONLY) == 0) {
1211 Status = TcgDxeLogHashEvent (&DigestList, &NewEventHdr, Event->Event);
1212 }
1213 }
1214 if (Status == EFI_DEVICE_ERROR) {
1215 DEBUG ((EFI_D_ERROR, "MeasurePeImageAndExtend - %r. Disable TPM.\n", Status));
1216 mTcgDxeData.BsCap.TPMPresentFlag = FALSE;
1217 REPORT_STATUS_CODE (
1218 EFI_ERROR_CODE | EFI_ERROR_MINOR,
1219 (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)
1220 );
1221 }
1222 } else {
1223 Status = TcgDxeHashLogExtendEvent (
1224 Flags,
1225 (UINT8 *) (UINTN) DataToHash,
1226 DataToHashLen,
1227 &NewEventHdr,
1228 Event->Event
1229 );
1230 }
1231 DEBUG ((DEBUG_VERBOSE, "Tcg2HashLogExtendEvent - %r\n", Status));
1232 return Status;
1233 }
1234
1235 /**
1236 This service enables the sending of commands to the TPM.
1237
1238 @param[in] This Indicates the calling context
1239 @param[in] InputParameterBlockSize Size of the TPM input parameter block.
1240 @param[in] InputParameterBlock Pointer to the TPM input parameter block.
1241 @param[in] OutputParameterBlockSize Size of the TPM output parameter block.
1242 @param[in] OutputParameterBlock Pointer to the TPM output parameter block.
1243
1244 @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.
1245 @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.
1246 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1247 @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small.
1248 **/
1249 EFI_STATUS
1250 EFIAPI
1251 Tcg2SubmitCommand (
1252 IN EFI_TCG2_PROTOCOL *This,
1253 IN UINT32 InputParameterBlockSize,
1254 IN UINT8 *InputParameterBlock,
1255 IN UINT32 OutputParameterBlockSize,
1256 IN UINT8 *OutputParameterBlock
1257 )
1258 {
1259 EFI_STATUS Status;
1260
1261 DEBUG ((EFI_D_INFO, "Tcg2SubmitCommand ...\n"));
1262
1263 if ((This == NULL) ||
1264 (InputParameterBlockSize == 0) || (InputParameterBlock == NULL) ||
1265 (OutputParameterBlockSize == 0) || (OutputParameterBlock == NULL)) {
1266 return EFI_INVALID_PARAMETER;
1267 }
1268
1269 if (!mTcgDxeData.BsCap.TPMPresentFlag) {
1270 return EFI_DEVICE_ERROR;
1271 }
1272
1273 if (InputParameterBlockSize > mTcgDxeData.BsCap.MaxCommandSize) {
1274 return EFI_INVALID_PARAMETER;
1275 }
1276 if (OutputParameterBlockSize > mTcgDxeData.BsCap.MaxResponseSize) {
1277 return EFI_INVALID_PARAMETER;
1278 }
1279
1280 Status = Tpm2SubmitCommand (
1281 InputParameterBlockSize,
1282 InputParameterBlock,
1283 &OutputParameterBlockSize,
1284 OutputParameterBlock
1285 );
1286 DEBUG ((EFI_D_INFO, "Tcg2SubmitCommand - %r\n", Status));
1287 return Status;
1288 }
1289
1290 /**
1291 This service returns the currently active PCR banks.
1292
1293 @param[in] This Indicates the calling context
1294 @param[out] ActivePcrBanks Pointer to the variable receiving the bitmap of currently active PCR banks.
1295
1296 @retval EFI_SUCCESS The bitmap of active PCR banks was stored in the ActivePcrBanks parameter.
1297 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1298 **/
1299 EFI_STATUS
1300 EFIAPI
1301 Tcg2GetActivePCRBanks (
1302 IN EFI_TCG2_PROTOCOL *This,
1303 OUT UINT32 *ActivePcrBanks
1304 )
1305 {
1306 if (ActivePcrBanks == NULL) {
1307 return EFI_INVALID_PARAMETER;
1308 }
1309 *ActivePcrBanks = mTcgDxeData.BsCap.ActivePcrBanks;
1310 return EFI_SUCCESS;
1311 }
1312
1313 /**
1314 This service sets the currently active PCR banks.
1315
1316 @param[in] This Indicates the calling context
1317 @param[in] ActivePcrBanks Bitmap of the requested active PCR banks. At least one bit SHALL be set.
1318
1319 @retval EFI_SUCCESS The bitmap in ActivePcrBank parameter is already active.
1320 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1321 **/
1322 EFI_STATUS
1323 EFIAPI
1324 Tcg2SetActivePCRBanks (
1325 IN EFI_TCG2_PROTOCOL *This,
1326 IN UINT32 ActivePcrBanks
1327 )
1328 {
1329 EFI_STATUS Status;
1330 UINT32 ReturnCode;
1331
1332 DEBUG ((EFI_D_INFO, "Tcg2SetActivePCRBanks ... (0x%x)\n", ActivePcrBanks));
1333
1334 if (ActivePcrBanks == 0) {
1335 return EFI_INVALID_PARAMETER;
1336 }
1337 if ((ActivePcrBanks & (~mTcgDxeData.BsCap.HashAlgorithmBitmap)) != 0) {
1338 return EFI_INVALID_PARAMETER;
1339 }
1340 if (ActivePcrBanks == mTcgDxeData.BsCap.ActivePcrBanks) {
1341 //
1342 // Need clear previous SET_PCR_BANKS setting
1343 //
1344 ReturnCode = Tcg2PhysicalPresenceLibSubmitRequestToPreOSFunction (TCG2_PHYSICAL_PRESENCE_NO_ACTION, 0);
1345 } else {
1346 ReturnCode = Tcg2PhysicalPresenceLibSubmitRequestToPreOSFunction (TCG2_PHYSICAL_PRESENCE_SET_PCR_BANKS, ActivePcrBanks);
1347 }
1348
1349 if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS) {
1350 Status = EFI_SUCCESS;
1351 } else if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE) {
1352 Status = EFI_OUT_OF_RESOURCES;
1353 } else if (ReturnCode == TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED) {
1354 Status = EFI_UNSUPPORTED;
1355 } else {
1356 Status = EFI_DEVICE_ERROR;
1357 }
1358
1359 DEBUG ((EFI_D_INFO, "Tcg2SetActivePCRBanks - %r\n", Status));
1360
1361 return Status;
1362 }
1363
1364 /**
1365 This service retrieves the result of a previous invocation of SetActivePcrBanks.
1366
1367 @param[in] This Indicates the calling context
1368 @param[out] OperationPresent Non-zero value to indicate a SetActivePcrBank operation was invoked during the last boot.
1369 @param[out] Response The response from the SetActivePcrBank request.
1370
1371 @retval EFI_SUCCESS The result value could be returned.
1372 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
1373 **/
1374 EFI_STATUS
1375 EFIAPI
1376 Tcg2GetResultOfSetActivePcrBanks (
1377 IN EFI_TCG2_PROTOCOL *This,
1378 OUT UINT32 *OperationPresent,
1379 OUT UINT32 *Response
1380 )
1381 {
1382 UINT32 ReturnCode;
1383
1384 if ((OperationPresent == NULL) || (Response == NULL)) {
1385 return EFI_INVALID_PARAMETER;
1386 }
1387
1388 ReturnCode = Tcg2PhysicalPresenceLibReturnOperationResponseToOsFunction (OperationPresent, Response);
1389 if (ReturnCode == TCG_PP_RETURN_TPM_OPERATION_RESPONSE_SUCCESS) {
1390 return EFI_SUCCESS;
1391 } else {
1392 return EFI_UNSUPPORTED;
1393 }
1394 }
1395
1396 EFI_TCG2_PROTOCOL mTcg2Protocol = {
1397 Tcg2GetCapability,
1398 Tcg2GetEventLog,
1399 Tcg2HashLogExtendEvent,
1400 Tcg2SubmitCommand,
1401 Tcg2GetActivePCRBanks,
1402 Tcg2SetActivePCRBanks,
1403 Tcg2GetResultOfSetActivePcrBanks,
1404 };
1405
1406 /**
1407 Initialize the Event Log and log events passed from the PEI phase.
1408
1409 @retval EFI_SUCCESS Operation completed successfully.
1410 @retval EFI_OUT_OF_RESOURCES Out of memory.
1411
1412 **/
1413 EFI_STATUS
1414 SetupEventLog (
1415 VOID
1416 )
1417 {
1418 EFI_STATUS Status;
1419 VOID *TcgEvent;
1420 EFI_PEI_HOB_POINTERS GuidHob;
1421 EFI_PHYSICAL_ADDRESS Lasa;
1422 UINTN Index;
1423 UINT32 DigestListBinSize;
1424 UINT32 EventSize;
1425 TCG_EfiSpecIDEventStruct *TcgEfiSpecIdEventStruct;
1426 UINT8 TempBuf[sizeof(TCG_EfiSpecIDEventStruct) + sizeof(UINT32) + (HASH_COUNT * sizeof(TCG_EfiSpecIdEventAlgorithmSize)) + sizeof(UINT8)];
1427 TCG_PCR_EVENT_HDR FirstPcrEvent;
1428 TCG_EfiSpecIdEventAlgorithmSize *DigestSize;
1429 TCG_EfiSpecIdEventAlgorithmSize *TempDigestSize;
1430 UINT8 *VendorInfoSize;
1431 UINT32 NumberOfAlgorithms;
1432
1433 DEBUG ((EFI_D_INFO, "SetupEventLog\n"));
1434
1435 //
1436 // 1. Create Log Area
1437 //
1438 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1439 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1440 mTcgDxeData.EventLogAreaStruct[Index].EventLogFormat = mTcg2EventInfo[Index].LogFormat;
1441 Lasa = (EFI_PHYSICAL_ADDRESS) (SIZE_4GB - 1);
1442 Status = gBS->AllocatePages (
1443 AllocateMaxAddress,
1444 EfiBootServicesData,
1445 EFI_SIZE_TO_PAGES (PcdGet32 (PcdTcgLogAreaMinLen)),
1446 &Lasa
1447 );
1448 if (EFI_ERROR (Status)) {
1449 return Status;
1450 }
1451 mTcgDxeData.EventLogAreaStruct[Index].Lasa = Lasa;
1452 mTcgDxeData.EventLogAreaStruct[Index].Laml = PcdGet32 (PcdTcgLogAreaMinLen);
1453 //
1454 // To initialize them as 0xFF is recommended
1455 // because the OS can know the last entry for that.
1456 //
1457 SetMem ((VOID *)(UINTN)Lasa, PcdGet32 (PcdTcgLogAreaMinLen), 0xFF);
1458 //
1459 // Create first entry for Log Header Entry Data
1460 //
1461 if (mTcg2EventInfo[Index].LogFormat != EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2) {
1462 //
1463 // TcgEfiSpecIdEventStruct
1464 //
1465 TcgEfiSpecIdEventStruct = (TCG_EfiSpecIDEventStruct *)TempBuf;
1466 CopyMem (TcgEfiSpecIdEventStruct->signature, TCG_EfiSpecIDEventStruct_SIGNATURE_03, sizeof(TcgEfiSpecIdEventStruct->signature));
1467 TcgEfiSpecIdEventStruct->platformClass = PcdGet8 (PcdTpmPlatformClass);
1468 TcgEfiSpecIdEventStruct->specVersionMajor = TCG_EfiSpecIDEventStruct_SPEC_VERSION_MAJOR_TPM2;
1469 TcgEfiSpecIdEventStruct->specVersionMinor = TCG_EfiSpecIDEventStruct_SPEC_VERSION_MINOR_TPM2;
1470 TcgEfiSpecIdEventStruct->specErrata = TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2;
1471 TcgEfiSpecIdEventStruct->uintnSize = sizeof(UINTN)/sizeof(UINT32);
1472 NumberOfAlgorithms = 0;
1473 DigestSize = (TCG_EfiSpecIdEventAlgorithmSize *)((UINT8 *)TcgEfiSpecIdEventStruct + sizeof(*TcgEfiSpecIdEventStruct) + sizeof(NumberOfAlgorithms));
1474 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA1) != 0) {
1475 TempDigestSize = DigestSize;
1476 TempDigestSize += NumberOfAlgorithms;
1477 TempDigestSize->algorithmId = TPM_ALG_SHA1;
1478 TempDigestSize->digestSize = SHA1_DIGEST_SIZE;
1479 NumberOfAlgorithms++;
1480 }
1481 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA256) != 0) {
1482 TempDigestSize = DigestSize;
1483 TempDigestSize += NumberOfAlgorithms;
1484 TempDigestSize->algorithmId = TPM_ALG_SHA256;
1485 TempDigestSize->digestSize = SHA256_DIGEST_SIZE;
1486 NumberOfAlgorithms++;
1487 }
1488 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA384) != 0) {
1489 TempDigestSize = DigestSize;
1490 TempDigestSize += NumberOfAlgorithms;
1491 TempDigestSize->algorithmId = TPM_ALG_SHA384;
1492 TempDigestSize->digestSize = SHA384_DIGEST_SIZE;
1493 NumberOfAlgorithms++;
1494 }
1495 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA512) != 0) {
1496 TempDigestSize = DigestSize;
1497 TempDigestSize += NumberOfAlgorithms;
1498 TempDigestSize->algorithmId = TPM_ALG_SHA512;
1499 TempDigestSize->digestSize = SHA512_DIGEST_SIZE;
1500 NumberOfAlgorithms++;
1501 }
1502 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SM3_256) != 0) {
1503 TempDigestSize = DigestSize;
1504 TempDigestSize += NumberOfAlgorithms;
1505 TempDigestSize->algorithmId = TPM_ALG_SM3_256;
1506 TempDigestSize->digestSize = SM3_256_DIGEST_SIZE;
1507 NumberOfAlgorithms++;
1508 }
1509 CopyMem (TcgEfiSpecIdEventStruct + 1, &NumberOfAlgorithms, sizeof(NumberOfAlgorithms));
1510 TempDigestSize = DigestSize;
1511 TempDigestSize += NumberOfAlgorithms;
1512 VendorInfoSize = (UINT8 *)TempDigestSize;
1513 *VendorInfoSize = 0;
1514
1515 //
1516 // FirstPcrEvent
1517 //
1518 FirstPcrEvent.PCRIndex = 0;
1519 FirstPcrEvent.EventType = EV_NO_ACTION;
1520 ZeroMem (&FirstPcrEvent.Digest, sizeof(FirstPcrEvent.Digest));
1521 FirstPcrEvent.EventSize = (UINT32)GetTcgEfiSpecIdEventStructSize (TcgEfiSpecIdEventStruct);
1522
1523 //
1524 // Record
1525 //
1526 Status = TcgDxeLogEvent (
1527 mTcg2EventInfo[Index].LogFormat,
1528 &FirstPcrEvent,
1529 sizeof(FirstPcrEvent),
1530 (UINT8 *)TcgEfiSpecIdEventStruct,
1531 FirstPcrEvent.EventSize
1532 );
1533 }
1534 }
1535 }
1536
1537 //
1538 // 2. Create Final Log Area
1539 //
1540 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1541 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1542 if (mTcg2EventInfo[Index].LogFormat == EFI_TCG2_EVENT_LOG_FORMAT_TCG_2) {
1543 Lasa = (EFI_PHYSICAL_ADDRESS) (SIZE_4GB - 1);
1544 Status = gBS->AllocatePages (
1545 AllocateMaxAddress,
1546 EfiACPIMemoryNVS,
1547 EFI_SIZE_TO_PAGES (PcdGet32 (PcdTcg2FinalLogAreaLen)),
1548 &Lasa
1549 );
1550 if (EFI_ERROR (Status)) {
1551 return Status;
1552 }
1553 SetMem ((VOID *)(UINTN)Lasa, PcdGet32 (PcdTcg2FinalLogAreaLen), 0xFF);
1554
1555 //
1556 // Initialize
1557 //
1558 mTcgDxeData.FinalEventsTable[Index] = (VOID *)(UINTN)Lasa;
1559 (mTcgDxeData.FinalEventsTable[Index])->Version = EFI_TCG2_FINAL_EVENTS_TABLE_VERSION;
1560 (mTcgDxeData.FinalEventsTable[Index])->NumberOfEvents = 0;
1561
1562 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogFormat = mTcg2EventInfo[Index].LogFormat;
1563 mTcgDxeData.FinalEventLogAreaStruct[Index].Lasa = Lasa + sizeof(EFI_TCG2_FINAL_EVENTS_TABLE);
1564 mTcgDxeData.FinalEventLogAreaStruct[Index].Laml = PcdGet32 (PcdTcg2FinalLogAreaLen) - sizeof(EFI_TCG2_FINAL_EVENTS_TABLE);
1565 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogSize = 0;
1566 mTcgDxeData.FinalEventLogAreaStruct[Index].LastEvent = (VOID *)(UINTN)mTcgDxeData.FinalEventLogAreaStruct[Index].Lasa;
1567 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogStarted = FALSE;
1568 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogTruncated = FALSE;
1569
1570 //
1571 // Install to configuration table for EFI_TCG2_EVENT_LOG_FORMAT_TCG_2
1572 //
1573 Status = gBS->InstallConfigurationTable (&gEfiTcg2FinalEventsTableGuid, (VOID *)mTcgDxeData.FinalEventsTable[Index]);
1574 if (EFI_ERROR (Status)) {
1575 return Status;
1576 }
1577 } else {
1578 //
1579 // No need to handle EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2
1580 //
1581 mTcgDxeData.FinalEventsTable[Index] = NULL;
1582 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogFormat = mTcg2EventInfo[Index].LogFormat;
1583 mTcgDxeData.FinalEventLogAreaStruct[Index].Lasa = 0;
1584 mTcgDxeData.FinalEventLogAreaStruct[Index].Laml = 0;
1585 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogSize = 0;
1586 mTcgDxeData.FinalEventLogAreaStruct[Index].LastEvent = 0;
1587 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogStarted = FALSE;
1588 mTcgDxeData.FinalEventLogAreaStruct[Index].EventLogTruncated = FALSE;
1589 }
1590 }
1591 }
1592
1593 //
1594 // 3. Sync data from PEI to DXE
1595 //
1596 Status = EFI_SUCCESS;
1597 for (Index = 0; Index < sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]); Index++) {
1598 if ((mTcgDxeData.BsCap.SupportedEventLogs & mTcg2EventInfo[Index].LogFormat) != 0) {
1599 GuidHob.Raw = GetHobList ();
1600 Status = EFI_SUCCESS;
1601 while (!EFI_ERROR (Status) &&
1602 (GuidHob.Raw = GetNextGuidHob (mTcg2EventInfo[Index].EventGuid, GuidHob.Raw)) != NULL) {
1603 TcgEvent = GET_GUID_HOB_DATA (GuidHob.Guid);
1604 GuidHob.Raw = GET_NEXT_HOB (GuidHob);
1605 switch (mTcg2EventInfo[Index].LogFormat) {
1606 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2:
1607 Status = TcgDxeLogEvent (
1608 mTcg2EventInfo[Index].LogFormat,
1609 TcgEvent,
1610 sizeof(TCG_PCR_EVENT_HDR),
1611 ((TCG_PCR_EVENT*)TcgEvent)->Event,
1612 ((TCG_PCR_EVENT_HDR*)TcgEvent)->EventSize
1613 );
1614 break;
1615 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_2:
1616 DigestListBinSize = GetDigestListBinSize ((UINT8 *)TcgEvent + sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE));
1617 CopyMem (&EventSize, (UINT8 *)TcgEvent + sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE) + DigestListBinSize, sizeof(UINT32));
1618 Status = TcgDxeLogEvent (
1619 mTcg2EventInfo[Index].LogFormat,
1620 TcgEvent,
1621 sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE) + DigestListBinSize + sizeof(UINT32),
1622 (UINT8 *)TcgEvent + sizeof(TCG_PCRINDEX) + sizeof(TCG_EVENTTYPE) + DigestListBinSize + sizeof(UINT32),
1623 EventSize
1624 );
1625 break;
1626 }
1627 }
1628 }
1629 }
1630
1631 return Status;
1632 }
1633
1634 /**
1635 Measure and log an action string, and extend the measurement result into PCR[5].
1636
1637 @param[in] String A specific string that indicates an Action event.
1638
1639 @retval EFI_SUCCESS Operation completed successfully.
1640 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1641
1642 **/
1643 EFI_STATUS
1644 TcgMeasureAction (
1645 IN CHAR8 *String
1646 )
1647 {
1648 TCG_PCR_EVENT_HDR TcgEvent;
1649
1650 TcgEvent.PCRIndex = 5;
1651 TcgEvent.EventType = EV_EFI_ACTION;
1652 TcgEvent.EventSize = (UINT32)AsciiStrLen (String);
1653 return TcgDxeHashLogExtendEvent (
1654 0,
1655 (UINT8*)String,
1656 TcgEvent.EventSize,
1657 &TcgEvent,
1658 (UINT8 *) String
1659 );
1660 }
1661
1662 /**
1663 Measure and log EFI handoff tables, and extend the measurement result into PCR[1].
1664
1665 @retval EFI_SUCCESS Operation completed successfully.
1666 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1667
1668 **/
1669 EFI_STATUS
1670 MeasureHandoffTables (
1671 VOID
1672 )
1673 {
1674 EFI_STATUS Status;
1675 TCG_PCR_EVENT_HDR TcgEvent;
1676 EFI_HANDOFF_TABLE_POINTERS HandoffTables;
1677 UINTN ProcessorNum;
1678 EFI_CPU_PHYSICAL_LOCATION *ProcessorLocBuf;
1679
1680 ProcessorLocBuf = NULL;
1681 Status = EFI_SUCCESS;
1682
1683 if (PcdGet8 (PcdTpmPlatformClass) == TCG_PLATFORM_TYPE_SERVER) {
1684 //
1685 // Tcg Server spec.
1686 // Measure each processor EFI_CPU_PHYSICAL_LOCATION with EV_TABLE_OF_DEVICES to PCR[1]
1687 //
1688 Status = GetProcessorsCpuLocation(&ProcessorLocBuf, &ProcessorNum);
1689
1690 if (!EFI_ERROR(Status)){
1691 TcgEvent.PCRIndex = 1;
1692 TcgEvent.EventType = EV_TABLE_OF_DEVICES;
1693 TcgEvent.EventSize = sizeof (HandoffTables);
1694
1695 HandoffTables.NumberOfTables = 1;
1696 HandoffTables.TableEntry[0].VendorGuid = gEfiMpServiceProtocolGuid;
1697 HandoffTables.TableEntry[0].VendorTable = ProcessorLocBuf;
1698
1699 Status = TcgDxeHashLogExtendEvent (
1700 0,
1701 (UINT8*)(UINTN)ProcessorLocBuf,
1702 sizeof(EFI_CPU_PHYSICAL_LOCATION) * ProcessorNum,
1703 &TcgEvent,
1704 (UINT8*)&HandoffTables
1705 );
1706
1707 FreePool(ProcessorLocBuf);
1708 }
1709 }
1710
1711 return Status;
1712 }
1713
1714 /**
1715 Measure and log Separator event, and extend the measurement result into a specific PCR.
1716
1717 @param[in] PCRIndex PCR index.
1718
1719 @retval EFI_SUCCESS Operation completed successfully.
1720 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1721
1722 **/
1723 EFI_STATUS
1724 MeasureSeparatorEvent (
1725 IN TPM_PCRINDEX PCRIndex
1726 )
1727 {
1728 TCG_PCR_EVENT_HDR TcgEvent;
1729 UINT32 EventData;
1730
1731 DEBUG ((EFI_D_INFO, "MeasureSeparatorEvent Pcr - %x\n", PCRIndex));
1732
1733 EventData = 0;
1734 TcgEvent.PCRIndex = PCRIndex;
1735 TcgEvent.EventType = EV_SEPARATOR;
1736 TcgEvent.EventSize = (UINT32)sizeof (EventData);
1737 return TcgDxeHashLogExtendEvent (
1738 0,
1739 (UINT8 *)&EventData,
1740 sizeof (EventData),
1741 &TcgEvent,
1742 (UINT8 *)&EventData
1743 );
1744 }
1745
1746 /**
1747 Measure and log an EFI variable, and extend the measurement result into a specific PCR.
1748
1749 @param[in] PCRIndex PCR Index.
1750 @param[in] EventType Event type.
1751 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1752 @param[in] VendorGuid A unique identifier for the vendor.
1753 @param[in] VarData The content of the variable data.
1754 @param[in] VarSize The size of the variable data.
1755
1756 @retval EFI_SUCCESS Operation completed successfully.
1757 @retval EFI_OUT_OF_RESOURCES Out of memory.
1758 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1759
1760 **/
1761 EFI_STATUS
1762 MeasureVariable (
1763 IN TPM_PCRINDEX PCRIndex,
1764 IN TCG_EVENTTYPE EventType,
1765 IN CHAR16 *VarName,
1766 IN EFI_GUID *VendorGuid,
1767 IN VOID *VarData,
1768 IN UINTN VarSize
1769 )
1770 {
1771 EFI_STATUS Status;
1772 TCG_PCR_EVENT_HDR TcgEvent;
1773 UINTN VarNameLength;
1774 EFI_VARIABLE_DATA_TREE *VarLog;
1775
1776 DEBUG ((EFI_D_INFO, "Tcg2Dxe: MeasureVariable (Pcr - %x, EventType - %x, ", (UINTN)PCRIndex, (UINTN)EventType));
1777 DEBUG ((EFI_D_INFO, "VariableName - %s, VendorGuid - %g)\n", VarName, VendorGuid));
1778
1779 VarNameLength = StrLen (VarName);
1780 TcgEvent.PCRIndex = PCRIndex;
1781 TcgEvent.EventType = EventType;
1782
1783 TcgEvent.EventSize = (UINT32)(sizeof (*VarLog) + VarNameLength * sizeof (*VarName) + VarSize
1784 - sizeof (VarLog->UnicodeName) - sizeof (VarLog->VariableData));
1785
1786 VarLog = (EFI_VARIABLE_DATA_TREE *)AllocatePool (TcgEvent.EventSize);
1787 if (VarLog == NULL) {
1788 return EFI_OUT_OF_RESOURCES;
1789 }
1790
1791 VarLog->VariableName = *VendorGuid;
1792 VarLog->UnicodeNameLength = VarNameLength;
1793 VarLog->VariableDataLength = VarSize;
1794 CopyMem (
1795 VarLog->UnicodeName,
1796 VarName,
1797 VarNameLength * sizeof (*VarName)
1798 );
1799 if (VarSize != 0 && VarData != NULL) {
1800 CopyMem (
1801 (CHAR16 *)VarLog->UnicodeName + VarNameLength,
1802 VarData,
1803 VarSize
1804 );
1805 }
1806
1807 if (EventType == EV_EFI_VARIABLE_DRIVER_CONFIG) {
1808 //
1809 // Digest is the event data (EFI_VARIABLE_DATA)
1810 //
1811 Status = TcgDxeHashLogExtendEvent (
1812 0,
1813 (UINT8*)VarLog,
1814 TcgEvent.EventSize,
1815 &TcgEvent,
1816 (UINT8*)VarLog
1817 );
1818 } else {
1819 Status = TcgDxeHashLogExtendEvent (
1820 0,
1821 (UINT8*)VarData,
1822 VarSize,
1823 &TcgEvent,
1824 (UINT8*)VarLog
1825 );
1826 }
1827 FreePool (VarLog);
1828 return Status;
1829 }
1830
1831 /**
1832 Read then Measure and log an EFI variable, and extend the measurement result into a specific PCR.
1833
1834 @param[in] PCRIndex PCR Index.
1835 @param[in] EventType Event type.
1836 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1837 @param[in] VendorGuid A unique identifier for the vendor.
1838 @param[out] VarSize The size of the variable data.
1839 @param[out] VarData Pointer to the content of the variable.
1840
1841 @retval EFI_SUCCESS Operation completed successfully.
1842 @retval EFI_OUT_OF_RESOURCES Out of memory.
1843 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1844
1845 **/
1846 EFI_STATUS
1847 ReadAndMeasureVariable (
1848 IN TPM_PCRINDEX PCRIndex,
1849 IN TCG_EVENTTYPE EventType,
1850 IN CHAR16 *VarName,
1851 IN EFI_GUID *VendorGuid,
1852 OUT UINTN *VarSize,
1853 OUT VOID **VarData
1854 )
1855 {
1856 EFI_STATUS Status;
1857
1858 Status = GetVariable2 (VarName, VendorGuid, VarData, VarSize);
1859 if (EventType == EV_EFI_VARIABLE_DRIVER_CONFIG) {
1860 if (EFI_ERROR (Status)) {
1861 //
1862 // It is valid case, so we need handle it.
1863 //
1864 *VarData = NULL;
1865 *VarSize = 0;
1866 }
1867 } else {
1868 //
1869 // if status error, VarData is freed and set NULL by GetVariable2
1870 //
1871 if (EFI_ERROR (Status)) {
1872 return EFI_NOT_FOUND;
1873 }
1874 }
1875
1876 Status = MeasureVariable (
1877 PCRIndex,
1878 EventType,
1879 VarName,
1880 VendorGuid,
1881 *VarData,
1882 *VarSize
1883 );
1884 return Status;
1885 }
1886
1887 /**
1888 Read then Measure and log an EFI boot variable, and extend the measurement result into PCR[5].
1889
1890 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1891 @param[in] VendorGuid A unique identifier for the vendor.
1892 @param[out] VarSize The size of the variable data.
1893 @param[out] VarData Pointer to the content of the variable.
1894
1895 @retval EFI_SUCCESS Operation completed successfully.
1896 @retval EFI_OUT_OF_RESOURCES Out of memory.
1897 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1898
1899 **/
1900 EFI_STATUS
1901 ReadAndMeasureBootVariable (
1902 IN CHAR16 *VarName,
1903 IN EFI_GUID *VendorGuid,
1904 OUT UINTN *VarSize,
1905 OUT VOID **VarData
1906 )
1907 {
1908 return ReadAndMeasureVariable (
1909 5,
1910 EV_EFI_VARIABLE_BOOT,
1911 VarName,
1912 VendorGuid,
1913 VarSize,
1914 VarData
1915 );
1916 }
1917
1918 /**
1919 Read then Measure and log an EFI Secure variable, and extend the measurement result into PCR[7].
1920
1921 @param[in] VarName A Null-terminated string that is the name of the vendor's variable.
1922 @param[in] VendorGuid A unique identifier for the vendor.
1923 @param[out] VarSize The size of the variable data.
1924 @param[out] VarData Pointer to the content of the variable.
1925
1926 @retval EFI_SUCCESS Operation completed successfully.
1927 @retval EFI_OUT_OF_RESOURCES Out of memory.
1928 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1929
1930 **/
1931 EFI_STATUS
1932 ReadAndMeasureSecureVariable (
1933 IN CHAR16 *VarName,
1934 IN EFI_GUID *VendorGuid,
1935 OUT UINTN *VarSize,
1936 OUT VOID **VarData
1937 )
1938 {
1939 return ReadAndMeasureVariable (
1940 7,
1941 EV_EFI_VARIABLE_DRIVER_CONFIG,
1942 VarName,
1943 VendorGuid,
1944 VarSize,
1945 VarData
1946 );
1947 }
1948
1949 /**
1950 Measure and log all EFI boot variables, and extend the measurement result into a specific PCR.
1951
1952 The EFI boot variables are BootOrder and Boot#### variables.
1953
1954 @retval EFI_SUCCESS Operation completed successfully.
1955 @retval EFI_OUT_OF_RESOURCES Out of memory.
1956 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
1957
1958 **/
1959 EFI_STATUS
1960 MeasureAllBootVariables (
1961 VOID
1962 )
1963 {
1964 EFI_STATUS Status;
1965 UINT16 *BootOrder;
1966 UINTN BootCount;
1967 UINTN Index;
1968 VOID *BootVarData;
1969 UINTN Size;
1970
1971 Status = ReadAndMeasureBootVariable (
1972 mBootVarName,
1973 &gEfiGlobalVariableGuid,
1974 &BootCount,
1975 (VOID **) &BootOrder
1976 );
1977 if (Status == EFI_NOT_FOUND || BootOrder == NULL) {
1978 return EFI_SUCCESS;
1979 }
1980
1981 if (EFI_ERROR (Status)) {
1982 //
1983 // BootOrder can't be NULL if status is not EFI_NOT_FOUND
1984 //
1985 FreePool (BootOrder);
1986 return Status;
1987 }
1988
1989 BootCount /= sizeof (*BootOrder);
1990 for (Index = 0; Index < BootCount; Index++) {
1991 UnicodeSPrint (mBootVarName, sizeof (mBootVarName), L"Boot%04x", BootOrder[Index]);
1992 Status = ReadAndMeasureBootVariable (
1993 mBootVarName,
1994 &gEfiGlobalVariableGuid,
1995 &Size,
1996 &BootVarData
1997 );
1998 if (!EFI_ERROR (Status)) {
1999 FreePool (BootVarData);
2000 }
2001 }
2002
2003 FreePool (BootOrder);
2004 return EFI_SUCCESS;
2005 }
2006
2007 /**
2008 Measure and log all EFI Secure variables, and extend the measurement result into a specific PCR.
2009
2010 The EFI boot variables are BootOrder and Boot#### variables.
2011
2012 @retval EFI_SUCCESS Operation completed successfully.
2013 @retval EFI_OUT_OF_RESOURCES Out of memory.
2014 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
2015
2016 **/
2017 EFI_STATUS
2018 MeasureAllSecureVariables (
2019 VOID
2020 )
2021 {
2022 EFI_STATUS Status;
2023 VOID *Data;
2024 UINTN DataSize;
2025 UINTN Index;
2026
2027 Status = EFI_NOT_FOUND;
2028 for (Index = 0; Index < sizeof(mVariableType)/sizeof(mVariableType[0]); Index++) {
2029 Status = ReadAndMeasureSecureVariable (
2030 mVariableType[Index].VariableName,
2031 mVariableType[Index].VendorGuid,
2032 &DataSize,
2033 &Data
2034 );
2035 if (!EFI_ERROR (Status)) {
2036 if (Data != NULL) {
2037 FreePool (Data);
2038 }
2039 }
2040 }
2041
2042 return EFI_SUCCESS;
2043 }
2044
2045 /**
2046 Measure and log launch of FirmwareDebugger, and extend the measurement result into a specific PCR.
2047
2048 @retval EFI_SUCCESS Operation completed successfully.
2049 @retval EFI_OUT_OF_RESOURCES Out of memory.
2050 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
2051
2052 **/
2053 EFI_STATUS
2054 MeasureLaunchOfFirmwareDebugger (
2055 VOID
2056 )
2057 {
2058 TCG_PCR_EVENT_HDR TcgEvent;
2059
2060 TcgEvent.PCRIndex = 7;
2061 TcgEvent.EventType = EV_EFI_ACTION;
2062 TcgEvent.EventSize = sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1;
2063 return TcgDxeHashLogExtendEvent (
2064 0,
2065 (UINT8 *)FIRMWARE_DEBUGGER_EVENT_STRING,
2066 sizeof(FIRMWARE_DEBUGGER_EVENT_STRING) - 1,
2067 &TcgEvent,
2068 (UINT8 *)FIRMWARE_DEBUGGER_EVENT_STRING
2069 );
2070 }
2071
2072 /**
2073 Measure and log all Secure Boot Policy, and extend the measurement result into a specific PCR.
2074
2075 Platform firmware adhering to the policy must therefore measure the following values into PCR[7]: (in order listed)
2076 - The contents of the SecureBoot variable
2077 - The contents of the PK variable
2078 - The contents of the KEK variable
2079 - The contents of the EFI_IMAGE_SECURITY_DATABASE variable
2080 - The contents of the EFI_IMAGE_SECURITY_DATABASE1 variable
2081 - Separator
2082 - Entries in the EFI_IMAGE_SECURITY_DATABASE that are used to validate EFI Drivers or EFI Boot Applications in the boot path
2083
2084 NOTE: Because of the above, UEFI variables PK, KEK, EFI_IMAGE_SECURITY_DATABASE,
2085 EFI_IMAGE_SECURITY_DATABASE1 and SecureBoot SHALL NOT be measured into PCR[3].
2086
2087 @param[in] Event Event whose notification function is being invoked
2088 @param[in] Context Pointer to the notification function's context
2089 **/
2090 VOID
2091 EFIAPI
2092 MeasureSecureBootPolicy (
2093 IN EFI_EVENT Event,
2094 IN VOID *Context
2095 )
2096 {
2097 EFI_STATUS Status;
2098 VOID *Protocol;
2099
2100 Status = gBS->LocateProtocol (&gEfiVariableWriteArchProtocolGuid, NULL, (VOID **)&Protocol);
2101 if (EFI_ERROR (Status)) {
2102 return;
2103 }
2104
2105 if (PcdGetBool (PcdFirmwareDebuggerInitialized)) {
2106 Status = MeasureLaunchOfFirmwareDebugger ();
2107 DEBUG ((EFI_D_INFO, "MeasureLaunchOfFirmwareDebugger - %r\n", Status));
2108 }
2109
2110 Status = MeasureAllSecureVariables ();
2111 DEBUG ((EFI_D_INFO, "MeasureAllSecureVariables - %r\n", Status));
2112
2113 //
2114 // We need measure Separator(7) here, because this event must be between SecureBootPolicy (Configure)
2115 // and ImageVerification (Authority)
2116 // There might be a case that we need measure UEFI image from DriverOrder, besides BootOrder. So
2117 // the Authority measurement happen before ReadToBoot event.
2118 //
2119 Status = MeasureSeparatorEvent (7);
2120 DEBUG ((EFI_D_INFO, "MeasureSeparatorEvent - %r\n", Status));
2121 return ;
2122 }
2123
2124 /**
2125 Ready to Boot Event notification handler.
2126
2127 Sequence of OS boot events is measured in this event notification handler.
2128
2129 @param[in] Event Event whose notification function is being invoked
2130 @param[in] Context Pointer to the notification function's context
2131
2132 **/
2133 VOID
2134 EFIAPI
2135 OnReadyToBoot (
2136 IN EFI_EVENT Event,
2137 IN VOID *Context
2138 )
2139 {
2140 EFI_STATUS Status;
2141 TPM_PCRINDEX PcrIndex;
2142
2143 PERF_START_EX (mImageHandle, "EventRec", "Tcg2Dxe", 0, PERF_ID_TCG2_DXE);
2144 if (mBootAttempts == 0) {
2145
2146 //
2147 // Measure handoff tables.
2148 //
2149 Status = MeasureHandoffTables ();
2150 if (EFI_ERROR (Status)) {
2151 DEBUG ((EFI_D_ERROR, "HOBs not Measured. Error!\n"));
2152 }
2153
2154 //
2155 // Measure BootOrder & Boot#### variables.
2156 //
2157 Status = MeasureAllBootVariables ();
2158 if (EFI_ERROR (Status)) {
2159 DEBUG ((EFI_D_ERROR, "Boot Variables not Measured. Error!\n"));
2160 }
2161
2162 //
2163 // 1. This is the first boot attempt.
2164 //
2165 Status = TcgMeasureAction (
2166 EFI_CALLING_EFI_APPLICATION
2167 );
2168 if (EFI_ERROR (Status)) {
2169 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_CALLING_EFI_APPLICATION));
2170 }
2171
2172 //
2173 // 2. Draw a line between pre-boot env and entering post-boot env.
2174 // PCR[7] is already done.
2175 //
2176 for (PcrIndex = 0; PcrIndex < 7; PcrIndex++) {
2177 Status = MeasureSeparatorEvent (PcrIndex);
2178 if (EFI_ERROR (Status)) {
2179 DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n"));
2180 }
2181 }
2182
2183 //
2184 // 3. Measure GPT. It would be done in SAP driver.
2185 //
2186
2187 //
2188 // 4. Measure PE/COFF OS loader. It would be done in SAP driver.
2189 //
2190
2191 //
2192 // 5. Read & Measure variable. BootOrder already measured.
2193 //
2194 } else {
2195 //
2196 // 6. Not first attempt, meaning a return from last attempt
2197 //
2198 Status = TcgMeasureAction (
2199 EFI_RETURNING_FROM_EFI_APPLICATOIN
2200 );
2201 if (EFI_ERROR (Status)) {
2202 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_RETURNING_FROM_EFI_APPLICATOIN));
2203 }
2204 }
2205
2206 DEBUG ((EFI_D_INFO, "TPM2 Tcg2Dxe Measure Data when ReadyToBoot\n"));
2207 //
2208 // Increase boot attempt counter.
2209 //
2210 mBootAttempts++;
2211 PERF_END_EX (mImageHandle, "EventRec", "Tcg2Dxe", 0, PERF_ID_TCG2_DXE + 1);
2212 }
2213
2214 /**
2215 Exit Boot Services Event notification handler.
2216
2217 Measure invocation and success of ExitBootServices.
2218
2219 @param[in] Event Event whose notification function is being invoked
2220 @param[in] Context Pointer to the notification function's context
2221
2222 **/
2223 VOID
2224 EFIAPI
2225 OnExitBootServices (
2226 IN EFI_EVENT Event,
2227 IN VOID *Context
2228 )
2229 {
2230 EFI_STATUS Status;
2231
2232 //
2233 // Measure invocation of ExitBootServices,
2234 //
2235 Status = TcgMeasureAction (
2236 EFI_EXIT_BOOT_SERVICES_INVOCATION
2237 );
2238 if (EFI_ERROR (Status)) {
2239 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_EXIT_BOOT_SERVICES_INVOCATION));
2240 }
2241
2242 //
2243 // Measure success of ExitBootServices
2244 //
2245 Status = TcgMeasureAction (
2246 EFI_EXIT_BOOT_SERVICES_SUCCEEDED
2247 );
2248 if (EFI_ERROR (Status)) {
2249 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_EXIT_BOOT_SERVICES_SUCCEEDED));
2250 }
2251 }
2252
2253 /**
2254 Exit Boot Services Failed Event notification handler.
2255
2256 Measure Failure of ExitBootServices.
2257
2258 @param[in] Event Event whose notification function is being invoked
2259 @param[in] Context Pointer to the notification function's context
2260
2261 **/
2262 VOID
2263 EFIAPI
2264 OnExitBootServicesFailed (
2265 IN EFI_EVENT Event,
2266 IN VOID *Context
2267 )
2268 {
2269 EFI_STATUS Status;
2270
2271 //
2272 // Measure Failure of ExitBootServices,
2273 //
2274 Status = TcgMeasureAction (
2275 EFI_EXIT_BOOT_SERVICES_FAILED
2276 );
2277 if (EFI_ERROR (Status)) {
2278 DEBUG ((EFI_D_ERROR, "%a not Measured. Error!\n", EFI_EXIT_BOOT_SERVICES_FAILED));
2279 }
2280
2281 }
2282
2283 /**
2284 The function install Tcg2 protocol.
2285
2286 @retval EFI_SUCCESS Tcg2 protocol is installed.
2287 @retval other Some error occurs.
2288 **/
2289 EFI_STATUS
2290 InstallTcg2 (
2291 VOID
2292 )
2293 {
2294 EFI_STATUS Status;
2295 EFI_HANDLE Handle;
2296
2297 Handle = NULL;
2298 Status = gBS->InstallMultipleProtocolInterfaces (
2299 &Handle,
2300 &gEfiTcg2ProtocolGuid,
2301 &mTcg2Protocol,
2302 NULL
2303 );
2304 return Status;
2305 }
2306
2307 /**
2308 The driver's entry point. It publishes EFI Tcg2 Protocol.
2309
2310 @param[in] ImageHandle The firmware allocated handle for the EFI image.
2311 @param[in] SystemTable A pointer to the EFI System Table.
2312
2313 @retval EFI_SUCCESS The entry point is executed successfully.
2314 @retval other Some error occurs when executing this entry point.
2315 **/
2316 EFI_STATUS
2317 EFIAPI
2318 DriverEntry (
2319 IN EFI_HANDLE ImageHandle,
2320 IN EFI_SYSTEM_TABLE *SystemTable
2321 )
2322 {
2323 EFI_STATUS Status;
2324 EFI_EVENT Event;
2325 VOID *Registration;
2326 UINT32 MaxCommandSize;
2327 UINT32 MaxResponseSize;
2328 TPML_PCR_SELECTION Pcrs;
2329 UINTN Index;
2330 EFI_TCG2_EVENT_ALGORITHM_BITMAP TpmHashAlgorithmBitmap;
2331 UINT32 ActivePCRBanks;
2332 UINT32 NumberOfPCRBanks;
2333
2334 mImageHandle = ImageHandle;
2335
2336 if (CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &gEfiTpmDeviceInstanceNoneGuid) ||
2337 CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &gEfiTpmDeviceInstanceTpm12Guid)){
2338 DEBUG ((EFI_D_ERROR, "No TPM2 instance required!\n"));
2339 return EFI_UNSUPPORTED;
2340 }
2341
2342 if (GetFirstGuidHob (&gTpmErrorHobGuid) != NULL) {
2343 DEBUG ((EFI_D_ERROR, "TPM2 error!\n"));
2344 return EFI_DEVICE_ERROR;
2345 }
2346
2347 Status = Tpm2RequestUseTpm ();
2348 if (EFI_ERROR (Status)) {
2349 DEBUG ((EFI_D_ERROR, "TPM2 not detected!\n"));
2350 return Status;
2351 }
2352
2353 //
2354 // Fill information
2355 //
2356 ASSERT (TCG_EVENT_LOG_AREA_COUNT_MAX == sizeof(mTcg2EventInfo)/sizeof(mTcg2EventInfo[0]));
2357
2358 mTcgDxeData.BsCap.Size = sizeof(EFI_TCG2_BOOT_SERVICE_CAPABILITY);
2359 mTcgDxeData.BsCap.ProtocolVersion.Major = 1;
2360 mTcgDxeData.BsCap.ProtocolVersion.Minor = 1;
2361 mTcgDxeData.BsCap.StructureVersion.Major = 1;
2362 mTcgDxeData.BsCap.StructureVersion.Minor = 1;
2363
2364 DEBUG ((EFI_D_INFO, "Tcg2.ProtocolVersion - %02x.%02x\n", mTcgDxeData.BsCap.ProtocolVersion.Major, mTcgDxeData.BsCap.ProtocolVersion.Minor));
2365 DEBUG ((EFI_D_INFO, "Tcg2.StructureVersion - %02x.%02x\n", mTcgDxeData.BsCap.StructureVersion.Major, mTcgDxeData.BsCap.StructureVersion.Minor));
2366
2367 Status = Tpm2GetCapabilityManufactureID (&mTcgDxeData.BsCap.ManufacturerID);
2368 if (EFI_ERROR (Status)) {
2369 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityManufactureID fail!\n"));
2370 } else {
2371 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityManufactureID - %08x\n", mTcgDxeData.BsCap.ManufacturerID));
2372 }
2373
2374 DEBUG_CODE (
2375 UINT32 FirmwareVersion1;
2376 UINT32 FirmwareVersion2;
2377
2378 Status = Tpm2GetCapabilityFirmwareVersion (&FirmwareVersion1, &FirmwareVersion2);
2379 if (EFI_ERROR (Status)) {
2380 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityFirmwareVersion fail!\n"));
2381 } else {
2382 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityFirmwareVersion - %08x %08x\n", FirmwareVersion1, FirmwareVersion2));
2383 }
2384 );
2385
2386 Status = Tpm2GetCapabilityMaxCommandResponseSize (&MaxCommandSize, &MaxResponseSize);
2387 if (EFI_ERROR (Status)) {
2388 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityMaxCommandResponseSize fail!\n"));
2389 } else {
2390 mTcgDxeData.BsCap.MaxCommandSize = (UINT16)MaxCommandSize;
2391 mTcgDxeData.BsCap.MaxResponseSize = (UINT16)MaxResponseSize;
2392 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityMaxCommandResponseSize - %08x, %08x\n", MaxCommandSize, MaxResponseSize));
2393 }
2394
2395 //
2396 // Get supported PCR and current Active PCRs
2397 //
2398 Status = Tpm2GetCapabilityPcrs (&Pcrs);
2399 if (EFI_ERROR (Status)) {
2400 DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityPcrs fail!\n"));
2401 TpmHashAlgorithmBitmap = EFI_TCG2_BOOT_HASH_ALG_SHA1;
2402 ActivePCRBanks = EFI_TCG2_BOOT_HASH_ALG_SHA1;
2403 } else {
2404 DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityPcrs Count - %08x\n", Pcrs.count));
2405 TpmHashAlgorithmBitmap = 0;
2406 ActivePCRBanks = 0;
2407 for (Index = 0; Index < Pcrs.count; Index++) {
2408 DEBUG ((EFI_D_INFO, "hash - %x\n", Pcrs.pcrSelections[Index].hash));
2409 switch (Pcrs.pcrSelections[Index].hash) {
2410 case TPM_ALG_SHA1:
2411 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA1;
2412 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2413 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA1;
2414 }
2415 break;
2416 case TPM_ALG_SHA256:
2417 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA256;
2418 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2419 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA256;
2420 }
2421 break;
2422 case TPM_ALG_SHA384:
2423 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA384;
2424 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2425 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA384;
2426 }
2427 break;
2428 case TPM_ALG_SHA512:
2429 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SHA512;
2430 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2431 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SHA512;
2432 }
2433 break;
2434 case TPM_ALG_SM3_256:
2435 TpmHashAlgorithmBitmap |= EFI_TCG2_BOOT_HASH_ALG_SM3_256;
2436 if (!IsZeroBuffer (Pcrs.pcrSelections[Index].pcrSelect, Pcrs.pcrSelections[Index].sizeofSelect)) {
2437 ActivePCRBanks |= EFI_TCG2_BOOT_HASH_ALG_SM3_256;
2438 }
2439 break;
2440 }
2441 }
2442 }
2443 mTcgDxeData.BsCap.HashAlgorithmBitmap = TpmHashAlgorithmBitmap & PcdGet32 (PcdTcg2HashAlgorithmBitmap);
2444 mTcgDxeData.BsCap.ActivePcrBanks = ActivePCRBanks & PcdGet32 (PcdTcg2HashAlgorithmBitmap);
2445
2446 //
2447 // Need calculate NumberOfPCRBanks here, because HashAlgorithmBitmap might be removed by PCD.
2448 //
2449 NumberOfPCRBanks = 0;
2450 for (Index = 0; Index < 32; Index++) {
2451 if ((mTcgDxeData.BsCap.HashAlgorithmBitmap & (1u << Index)) != 0) {
2452 NumberOfPCRBanks++;
2453 }
2454 }
2455
2456 if (PcdGet32 (PcdTcg2NumberOfPCRBanks) == 0) {
2457 mTcgDxeData.BsCap.NumberOfPCRBanks = NumberOfPCRBanks;
2458 } else {
2459 mTcgDxeData.BsCap.NumberOfPCRBanks = PcdGet32 (PcdTcg2NumberOfPCRBanks);
2460 if (PcdGet32 (PcdTcg2NumberOfPCRBanks) > NumberOfPCRBanks) {
2461 DEBUG ((EFI_D_ERROR, "ERROR: PcdTcg2NumberOfPCRBanks(0x%x) > NumberOfPCRBanks(0x%x)\n", PcdGet32 (PcdTcg2NumberOfPCRBanks), NumberOfPCRBanks));
2462 mTcgDxeData.BsCap.NumberOfPCRBanks = NumberOfPCRBanks;
2463 }
2464 }
2465
2466 mTcgDxeData.BsCap.SupportedEventLogs = EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2 | EFI_TCG2_EVENT_LOG_FORMAT_TCG_2;
2467 if ((mTcgDxeData.BsCap.ActivePcrBanks & EFI_TCG2_BOOT_HASH_ALG_SHA1) == 0) {
2468 //
2469 // No need to expose TCG1.2 event log if SHA1 bank does not exist.
2470 //
2471 mTcgDxeData.BsCap.SupportedEventLogs &= ~EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2;
2472 }
2473
2474 DEBUG ((EFI_D_INFO, "Tcg2.SupportedEventLogs - 0x%08x\n", mTcgDxeData.BsCap.SupportedEventLogs));
2475 DEBUG ((EFI_D_INFO, "Tcg2.HashAlgorithmBitmap - 0x%08x\n", mTcgDxeData.BsCap.HashAlgorithmBitmap));
2476 DEBUG ((EFI_D_INFO, "Tcg2.NumberOfPCRBanks - 0x%08x\n", mTcgDxeData.BsCap.NumberOfPCRBanks));
2477 DEBUG ((EFI_D_INFO, "Tcg2.ActivePcrBanks - 0x%08x\n", mTcgDxeData.BsCap.ActivePcrBanks));
2478
2479 if (mTcgDxeData.BsCap.TPMPresentFlag) {
2480 //
2481 // Setup the log area and copy event log from hob list to it
2482 //
2483 Status = SetupEventLog ();
2484 ASSERT_EFI_ERROR (Status);
2485
2486 //
2487 // Measure handoff tables, Boot#### variables etc.
2488 //
2489 Status = EfiCreateEventReadyToBootEx (
2490 TPL_CALLBACK,
2491 OnReadyToBoot,
2492 NULL,
2493 &Event
2494 );
2495
2496 Status = gBS->CreateEventEx (
2497 EVT_NOTIFY_SIGNAL,
2498 TPL_NOTIFY,
2499 OnExitBootServices,
2500 NULL,
2501 &gEfiEventExitBootServicesGuid,
2502 &Event
2503 );
2504
2505 //
2506 // Measure Exit Boot Service failed
2507 //
2508 Status = gBS->CreateEventEx (
2509 EVT_NOTIFY_SIGNAL,
2510 TPL_NOTIFY,
2511 OnExitBootServicesFailed,
2512 NULL,
2513 &gEventExitBootServicesFailedGuid,
2514 &Event
2515 );
2516
2517 //
2518 // Create event callback, because we need access variable on SecureBootPolicyVariable
2519 // We should use VariableWriteArch instead of VariableArch, because Variable driver
2520 // may update SecureBoot value based on last setting.
2521 //
2522 EfiCreateProtocolNotifyEvent (&gEfiVariableWriteArchProtocolGuid, TPL_CALLBACK, MeasureSecureBootPolicy, NULL, &Registration);
2523 }
2524
2525 //
2526 // Install Tcg2Protocol
2527 //
2528 Status = InstallTcg2 ();
2529 DEBUG ((EFI_D_INFO, "InstallTcg2 - %r\n", Status));
2530
2531 return Status;
2532 }
EFI Development Kit II mirror for PVE