SecurityPkg/Include/Library/PlatformSecureLib.h

   1 /** @file
   2   Provides a secure platform-specific method to detect physically present user.
   3
   4 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __PLATFORM_SECURE_LIB_H__
  10 #define __PLATFORM_SECURE_LIB_H__
  11
  12
  13 /**
  14
  15   This function provides a platform-specific method to detect whether the platform
  16   is operating by a physically present user.
  17
  18   Programmatic changing of platform security policy (such as disable Secure Boot,
  19   or switch between Standard/Custom Secure Boot mode) MUST NOT be possible during
  20   Boot Services or after exiting EFI Boot Services. Only a physically present user
  21   is allowed to perform these operations.
  22
  23   NOTE THAT: This function cannot depend on any EFI Variable Service since they are
  24   not available when this function is called in AuthenticateVariable driver.
  25
  26   @retval  TRUE       The platform is operated by a physically present user.
  27   @retval  FALSE      The platform is NOT operated by a physically present user.
  28
  29 **/
  30 BOOLEAN
  31 EFIAPI
  32 UserPhysicalPresent (
  33   VOID
  34   );
  35
  36 #endif