SecurityPkg/Tcg/TcgConfigDxe/TcgConfigImpl.c

   1 /** @file
   2   HII Config Access protocol implementation of TCG configuration module.
   3
   4 Copyright (c) 2011 - 2012, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "TcgConfigImpl.h"
  16
  17 CHAR16                          mTcgStorageName[] = L"TCG_CONFIGURATION";
  18
  19 TCG_CONFIG_PRIVATE_DATA         mTcgConfigPrivateDateTemplate = {
  20   TCG_CONFIG_PRIVATE_DATA_SIGNATURE,
  21   {
  22     TcgExtractConfig,
  23     TcgRouteConfig,
  24     TcgCallback
  25   }
  26 };
  27
  28 HII_VENDOR_DEVICE_PATH          mTcgHiiVendorDevicePath = {
  29   {
  30     {
  31       HARDWARE_DEVICE_PATH,
  32       HW_VENDOR_DP,
  33       {
  34         (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
  35         (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
  36       }
  37     },
  38     TCG_CONFIG_FORM_SET_GUID
  39   },
  40   {
  41     END_DEVICE_PATH_TYPE,
  42     END_ENTIRE_DEVICE_PATH_SUBTYPE,
  43     {
  44       (UINT8) (END_DEVICE_PATH_LENGTH),
  45       (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
  46     }
  47   }
  48 };
  49
  50 /**
  51   Get current state of TPM device.
  52
  53   @param[in]   TcgProtocol          Point to EFI_TCG_PROTOCOL instance.
  54   @param[out]  TpmEnable            Flag to indicate TPM is enabled or not.
  55   @param[out]  TpmActivate          Flag to indicate TPM is activated or not.
  56
  57   @retval EFI_SUCCESS               State is successfully returned.
  58   @retval EFI_DEVICE_ERROR          Failed to get TPM response.
  59   @retval Others                    Other errors as indicated.
  60
  61 **/
  62 EFI_STATUS
  63 GetTpmState (
  64   IN  EFI_TCG_PROTOCOL          *TcgProtocol,
  65   OUT BOOLEAN                   *TpmEnable,  OPTIONAL
  66   OUT BOOLEAN                   *TpmActivate OPTIONAL
  67   )
  68 {
  69   EFI_STATUS                    Status;
  70   TPM_RSP_COMMAND_HDR           *TpmRsp;
  71   UINT32                        TpmSendSize;
  72   TPM_PERMANENT_FLAGS           *TpmPermanentFlags;
  73   UINT8                         CmdBuf[64];
  74
  75   ASSERT (TcgProtocol != NULL);
  76
  77   //
  78   // Get TPM Permanent flags (TpmEnable, TpmActivate)
  79   //
  80   if ((TpmEnable != NULL) || (TpmActivate != NULL)) {
  81     TpmSendSize           = sizeof (TPM_RQU_COMMAND_HDR) + sizeof (UINT32) * 3;
  82     *(UINT16*)&CmdBuf[0]  = SwapBytes16 (TPM_TAG_RQU_COMMAND);
  83     *(UINT32*)&CmdBuf[2]  = SwapBytes32 (TpmSendSize);
  84     *(UINT32*)&CmdBuf[6]  = SwapBytes32 (TPM_ORD_GetCapability);
  85
  86     *(UINT32*)&CmdBuf[10] = SwapBytes32 (TPM_CAP_FLAG);
  87     *(UINT32*)&CmdBuf[14] = SwapBytes32 (sizeof (TPM_CAP_FLAG_PERMANENT));
  88     *(UINT32*)&CmdBuf[18] = SwapBytes32 (TPM_CAP_FLAG_PERMANENT);
  89
  90     Status = TcgProtocol->PassThroughToTpm (
  91                             TcgProtocol,
  92                             TpmSendSize,
  93                             CmdBuf,
  94                             sizeof (CmdBuf),
  95                             CmdBuf
  96                             );
  97     TpmRsp = (TPM_RSP_COMMAND_HDR *) &CmdBuf[0];
  98     if (EFI_ERROR (Status) || (TpmRsp->tag != SwapBytes16 (TPM_TAG_RSP_COMMAND)) || (TpmRsp->returnCode != 0)) {
  99       return EFI_DEVICE_ERROR;
 100     }
 101
 102     TpmPermanentFlags = (TPM_PERMANENT_FLAGS *) &CmdBuf[sizeof (TPM_RSP_COMMAND_HDR) + sizeof (UINT32)];
 103
 104     if (TpmEnable != NULL) {
 105       *TpmEnable = (BOOLEAN) !TpmPermanentFlags->disable;
 106     }
 107
 108     if (TpmActivate != NULL) {
 109       *TpmActivate = (BOOLEAN) !TpmPermanentFlags->deactivated;
 110     }
 111   }
 112
 113   return EFI_SUCCESS;
 114 }
 115
 116 /**
 117   This function allows a caller to extract the current configuration for one
 118   or more named elements from the target driver.
 119
 120   @param[in]   This              Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 121   @param[in]   Request           A null-terminated Unicode string in
 122                                  <ConfigRequest> format.
 123   @param[out]  Progress          On return, points to a character in the Request
 124                                  string. Points to the string's null terminator if
 125                                  request was successful. Points to the most recent
 126                                  '&' before the first failing name/value pair (or
 127                                  the beginning of the string if the failure is in
 128                                  the first name/value pair) if the request was not
 129                                  successful.
 130   @param[out]  Results           A null-terminated Unicode string in
 131                                  <ConfigAltResp> format which has all values filled
 132                                  in for the names in the Request string. String to
 133                                  be allocated by the called function.
 134
 135   @retval EFI_SUCCESS            The Results is filled with the requested values.
 136   @retval EFI_OUT_OF_RESOURCES   Not enough memory to store the results.
 137   @retval EFI_INVALID_PARAMETER  Request is illegal syntax, or unknown name.
 138   @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this
 139                                  driver.
 140
 141 **/
 142 EFI_STATUS
 143 EFIAPI
 144 TcgExtractConfig (
 145   IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL        *This,
 146   IN CONST EFI_STRING                            Request,
 147        OUT EFI_STRING                            *Progress,
 148        OUT EFI_STRING                            *Results
 149   )
 150 {
 151   EFI_STATUS                 Status;
 152   UINTN                      BufferSize;
 153   TCG_CONFIGURATION          Configuration;
 154   TCG_CONFIG_PRIVATE_DATA    *PrivateData;
 155   EFI_STRING                 ConfigRequestHdr;
 156   EFI_STRING                 ConfigRequest;
 157   BOOLEAN                    AllocatedRequest;
 158   UINTN                      Size;
 159   BOOLEAN                    TpmEnable;
 160   BOOLEAN                    TpmActivate;
 161   CHAR16                     State[32];
 162
 163   if (Progress == NULL || Results == NULL) {
 164     return EFI_INVALID_PARAMETER;
 165   }
 166
 167   *Progress = Request;
 168   if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gTcgConfigFormSetGuid, mTcgStorageName)) {
 169     return EFI_NOT_FOUND;
 170   }
 171
 172   ConfigRequestHdr = NULL;
 173   ConfigRequest    = NULL;
 174   AllocatedRequest = FALSE;
 175   Size             = 0;
 176
 177   PrivateData = TCG_CONFIG_PRIVATE_DATA_FROM_THIS (This);
 178
 179   //
 180   // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
 181   //
 182   ZeroMem (&Configuration, sizeof (TCG_CONFIGURATION));
 183
 184   Configuration.TpmOperation    = PHYSICAL_PRESENCE_ENABLE;
 185   Configuration.HideTpm         = (BOOLEAN) (PcdGetBool (PcdHideTpmSupport) && PcdGetBool (PcdHideTpm));
 186   //
 187   // Read the original value of HideTpm from PrivateData which won't be changed by Setup in this boot.
 188   //
 189   Configuration.OriginalHideTpm = PrivateData->HideTpm;
 190
 191   //
 192   // Display current TPM state.
 193   //
 194   if (PrivateData->TcgProtocol != NULL) {
 195     Status = GetTpmState (PrivateData->TcgProtocol, &TpmEnable, &TpmActivate);
 196     if (EFI_ERROR (Status)) {
 197       return Status;
 198     }
 199
 200     UnicodeSPrint (
 201       State,
 202       sizeof (State),
 203       L"%s, and %s",
 204       TpmEnable   ? L"Enabled"   : L"Disabled",
 205       TpmActivate ? L"Activated" : L"Deactivated"
 206       );
 207     Configuration.TpmEnable   = TpmEnable;
 208     Configuration.TpmActivate = TpmActivate;
 209
 210     HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TPM_STATE_CONTENT), State, NULL);
 211   }
 212
 213   BufferSize = sizeof (Configuration);
 214   ConfigRequest = Request;
 215   if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {
 216     //
 217     // Request has no request element, construct full request string.
 218     // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
 219     // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
 220     //
 221     ConfigRequestHdr = HiiConstructConfigHdr (&gTcgConfigFormSetGuid, mTcgStorageName, PrivateData->DriverHandle);
 222     Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);
 223     ConfigRequest = AllocateZeroPool (Size);
 224     ASSERT (ConfigRequest != NULL);
 225     AllocatedRequest = TRUE;
 226     UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64) BufferSize);
 227     FreePool (ConfigRequestHdr);
 228   }
 229
 230   Status = gHiiConfigRouting->BlockToConfig (
 231                                 gHiiConfigRouting,
 232                                 ConfigRequest,
 233                                 (UINT8 *) &Configuration,
 234                                 BufferSize,
 235                                 Results,
 236                                 Progress
 237                                 );
 238   //
 239   // Free the allocated config request string.
 240   //
 241   if (AllocatedRequest) {
 242     FreePool (ConfigRequest);
 243   }
 244   //
 245   // Set Progress string to the original request string.
 246   //
 247   if (Request == NULL) {
 248     *Progress = NULL;
 249   } else if (StrStr (Request, L"OFFSET") == NULL) {
 250     *Progress = Request + StrLen (Request);
 251   }
 252
 253   return Status;
 254 }
 255
 256 /**
 257   This function processes the results of changes in configuration.
 258
 259   @param[in]  This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 260   @param[in]  Configuration      A null-terminated Unicode string in <ConfigResp>
 261                                  format.
 262   @param[out] Progress           A pointer to a string filled in with the offset of
 263                                  the most recent '&' before the first failing
 264                                  name/value pair (or the beginning of the string if
 265                                  the failure is in the first name/value pair) or
 266                                  the terminating NULL if all was successful.
 267
 268   @retval EFI_SUCCESS            The Results is processed successfully.
 269   @retval EFI_INVALID_PARAMETER  Configuration is NULL.
 270   @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this
 271                                  driver.
 272
 273 **/
 274 EFI_STATUS
 275 EFIAPI
 276 TcgRouteConfig (
 277   IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL      *This,
 278   IN CONST EFI_STRING                          Configuration,
 279        OUT EFI_STRING                          *Progress
 280   )
 281 {
 282   EFI_STATUS                       Status;
 283   UINTN                            BufferSize;
 284   TCG_CONFIGURATION                TcgConfiguration;
 285
 286   if (Configuration == NULL || Progress == NULL) {
 287     return EFI_INVALID_PARAMETER;
 288   }
 289
 290   *Progress = Configuration;
 291   if (!HiiIsConfigHdrMatch (Configuration, &gTcgConfigFormSetGuid, mTcgStorageName)) {
 292     return EFI_NOT_FOUND;
 293   }
 294
 295   //
 296   // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
 297   //
 298   BufferSize = sizeof (TCG_CONFIGURATION);
 299   Status = gHiiConfigRouting->ConfigToBlock (
 300                                 gHiiConfigRouting,
 301                                 Configuration,
 302                                 (UINT8 *) &TcgConfiguration,
 303                                 &BufferSize,
 304                                 Progress
 305                                 );
 306   if (EFI_ERROR (Status)) {
 307     return Status;
 308   }
 309
 310   PcdSetBool (PcdHideTpm,    TcgConfiguration.HideTpm);
 311
 312   return EFI_SUCCESS;
 313 }
 314
 315 /**
 316   Save TPM request to variable space.
 317
 318   @param[in] PpRequest             Physical Presence request command.
 319
 320   @retval    EFI_SUCCESS           The operation is finished successfully.
 321   @retval    Others                Other errors as indicated.
 322
 323 **/
 324 EFI_STATUS
 325 SavePpRequest (
 326   IN UINT8                         PpRequest
 327   )
 328 {
 329   EFI_STATUS                       Status;
 330   UINTN                            DataSize;
 331   EFI_PHYSICAL_PRESENCE            PpData;
 332
 333   //
 334   // Save TPM command to variable.
 335   //
 336   DataSize = sizeof (EFI_PHYSICAL_PRESENCE);
 337   Status = gRT->GetVariable (
 338                   PHYSICAL_PRESENCE_VARIABLE,
 339                   &gEfiPhysicalPresenceGuid,
 340                   NULL,
 341                   &DataSize,
 342                   &PpData
 343                   );
 344   if (EFI_ERROR (Status)) {
 345     return Status;
 346   }
 347
 348   PpData.PPRequest = PpRequest;
 349   Status = gRT->SetVariable (
 350                   PHYSICAL_PRESENCE_VARIABLE,
 351                   &gEfiPhysicalPresenceGuid,
 352                   EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
 353                   DataSize,
 354                   &PpData
 355                   );
 356   if (EFI_ERROR(Status)) {
 357     return Status;
 358   }
 359
 360   return EFI_SUCCESS;
 361 }
 362
 363 /**
 364   This function processes the results of changes in configuration.
 365
 366   @param[in]  This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 367   @param[in]  Action             Specifies the type of action taken by the browser.
 368   @param[in]  QuestionId         A unique value which is sent to the original
 369                                  exporting driver so that it can identify the type
 370                                  of data to expect.
 371   @param[in]  Type               The type of value for the question.
 372   @param[in]  Value              A pointer to the data being sent to the original
 373                                  exporting driver.
 374   @param[out] ActionRequest      On return, points to the action requested by the
 375                                  callback function.
 376
 377   @retval EFI_SUCCESS            The callback successfully handled the action.
 378   @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the
 379                                  variable and its data.
 380   @retval EFI_DEVICE_ERROR       The variable could not be saved.
 381   @retval EFI_UNSUPPORTED        The specified Action is not supported by the
 382                                  callback.
 383
 384 **/
 385 EFI_STATUS
 386 EFIAPI
 387 TcgCallback (
 388   IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL      *This,
 389   IN     EFI_BROWSER_ACTION                    Action,
 390   IN     EFI_QUESTION_ID                       QuestionId,
 391   IN     UINT8                                 Type,
 392   IN     EFI_IFR_TYPE_VALUE                    *Value,
 393      OUT EFI_BROWSER_ACTION_REQUEST            *ActionRequest
 394   )
 395 {
 396   if ((This == NULL) || (Value == NULL) || (ActionRequest == NULL)) {
 397     return EFI_INVALID_PARAMETER;
 398   }
 399
 400   if ((Action != EFI_BROWSER_ACTION_CHANGED) || (QuestionId != KEY_TPM_ACTION)) {
 401     return EFI_UNSUPPORTED;
 402   }
 403
 404   SavePpRequest (Value->u8);
 405   *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;
 406
 407   return EFI_SUCCESS;
 408 }
 409
 410 /**
 411   This function publish the TCG configuration Form for TPM device.
 412
 413   @param[in, out]  PrivateData   Points to TCG configuration private data.
 414
 415   @retval EFI_SUCCESS            HII Form is installed for this network device.
 416   @retval EFI_OUT_OF_RESOURCES   Not enough resource for HII Form installation.
 417   @retval Others                 Other errors as indicated.
 418
 419 **/
 420 EFI_STATUS
 421 InstallTcgConfigForm (
 422   IN OUT TCG_CONFIG_PRIVATE_DATA  *PrivateData
 423   )
 424 {
 425   EFI_STATUS                      Status;
 426   EFI_HII_HANDLE                  HiiHandle;
 427   EFI_HANDLE                      DriverHandle;
 428   VOID                            *StartOpCodeHandle;
 429   VOID                            *EndOpCodeHandle;
 430   EFI_IFR_GUID_LABEL              *StartLabel;
 431   EFI_IFR_GUID_LABEL              *EndLabel;
 432
 433   EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess;
 434
 435   DriverHandle = NULL;
 436   ConfigAccess = &PrivateData->ConfigAccess;
 437   Status = gBS->InstallMultipleProtocolInterfaces (
 438                   &DriverHandle,
 439                   &gEfiDevicePathProtocolGuid,
 440                   &mTcgHiiVendorDevicePath,
 441                   &gEfiHiiConfigAccessProtocolGuid,
 442                   ConfigAccess,
 443                   NULL
 444                   );
 445   if (EFI_ERROR (Status)) {
 446     return Status;
 447   }
 448
 449   PrivateData->DriverHandle = DriverHandle;
 450
 451   //
 452   // Publish the HII package list
 453   //
 454   HiiHandle = HiiAddPackages (
 455                 &gTcgConfigFormSetGuid,
 456                 DriverHandle,
 457                 TcgConfigDxeStrings,
 458                 TcgConfigBin,
 459                 NULL
 460                 );
 461   if (HiiHandle == NULL) {
 462     gBS->UninstallMultipleProtocolInterfaces (
 463            DriverHandle,
 464            &gEfiDevicePathProtocolGuid,
 465            &mTcgHiiVendorDevicePath,
 466            &gEfiHiiConfigAccessProtocolGuid,
 467            ConfigAccess,
 468            NULL
 469            );
 470
 471     return EFI_OUT_OF_RESOURCES;
 472   }
 473
 474   PrivateData->HiiHandle = HiiHandle;
 475
 476   //
 477   // Remove the Hide TPM question from the IFR
 478   //
 479   if (!PcdGetBool (PcdHideTpmSupport)) {
 480     //
 481     // Allocate space for creation of UpdateData Buffer
 482     //
 483     StartOpCodeHandle = HiiAllocateOpCodeHandle ();
 484     ASSERT (StartOpCodeHandle != NULL);
 485
 486     EndOpCodeHandle = HiiAllocateOpCodeHandle ();
 487     ASSERT (EndOpCodeHandle != NULL);
 488
 489     //
 490     // Create Hii Extend Label OpCode as the start opcode
 491     //
 492     StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
 493     StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
 494     StartLabel->Number       = LABEL_TCG_CONFIGURATION_HIDETPM;
 495
 496     //
 497     // Create Hii Extend Label OpCode as the end opcode
 498     //
 499     EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
 500     EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
 501     EndLabel->Number       = LABEL_END;
 502
 503     HiiUpdateForm (HiiHandle, NULL, TCG_CONFIGURATION_FORM_ID, StartOpCodeHandle, EndOpCodeHandle);
 504
 505     HiiFreeOpCodeHandle (StartOpCodeHandle);
 506     HiiFreeOpCodeHandle (EndOpCodeHandle);
 507   }
 508
 509   return EFI_SUCCESS;
 510 }
 511
 512 /**
 513   This function removes TCG configuration Form.
 514
 515   @param[in, out]  PrivateData   Points to TCG configuration private data.
 516
 517 **/
 518 VOID
 519 UninstallTcgConfigForm (
 520   IN OUT TCG_CONFIG_PRIVATE_DATA    *PrivateData
 521   )
 522 {
 523   //
 524   // Uninstall HII package list
 525   //
 526   if (PrivateData->HiiHandle != NULL) {
 527     HiiRemovePackages (PrivateData->HiiHandle);
 528     PrivateData->HiiHandle = NULL;
 529   }
 530
 531   //
 532   // Uninstall HII Config Access Protocol
 533   //
 534   if (PrivateData->DriverHandle != NULL) {
 535     gBS->UninstallMultipleProtocolInterfaces (
 536            PrivateData->DriverHandle,
 537            &gEfiDevicePathProtocolGuid,
 538            &mTcgHiiVendorDevicePath,
 539            &gEfiHiiConfigAccessProtocolGuid,
 540            &PrivateData->ConfigAccess,
 541            NULL
 542            );
 543     PrivateData->DriverHandle = NULL;
 544   }
 545
 546   FreePool (PrivateData);
 547 }