AppleSecureBoot.h

Go to the documentation of this file.

 
#ifndef APPLE_SECURE_BOOT_H
#define APPLE_SECURE_BOOT_H
 
#define APPLE_SECURE_BOOT_PROTOCOL_REVISION  4U
 
#define APPLE_SECURE_BOOT_PROTOCOL_GUID  \
 { 0x24B73556, 0x2197, 0x4702,           \
   { 0x82, 0xA8, 0x3E, 0x13, 0x37, 0xDA, 0xFB, 0xF2 } }
 
typedef struct APPLE_SECURE_BOOT_PROTOCOL_ APPLE_SECURE_BOOT_PROTOCOL;
 
#define APPLE_SB_OBJ_TYPE(A, B, C, D)  \
  (UINT32)(                            \
    ((A) << 24UL)                      \
  | ((B) << 16UL)                      \
  | ((C) << 8UL)                       \
  | ((D) << 0UL)                       \
  )
 
//
// The keys are iterated in the order in which they are defined here in
// AppleBds to validate any loaded image.
//
#define APPLE_SB_OBJ_EFIBOOT        APPLE_SB_OBJ_TYPE ('e', 'f', 'i', 'b')
#define APPLE_SB_OBJ_EFIBOOT_DEBUG  APPLE_SB_OBJ_TYPE ('e', 'f', 'b', 'd')
#define APPLE_SB_OBJ_EFIBOOT_BASE   APPLE_SB_OBJ_TYPE ('e', 'f', 'b', 'b')
 
#define APPLE_SB_OBJ_MUPD  APPLE_SB_OBJ_TYPE ('m', 'u', 'p', 'd')
#define APPLE_SB_OBJ_HPMU  APPLE_SB_OBJ_TYPE ('h', 'p', 'm', 'u')
#define APPLE_SB_OBJ_THOU  APPLE_SB_OBJ_TYPE ('t', 'h', 'o', 'u')
#define APPLE_SB_OBJ_GPUU  APPLE_SB_OBJ_TYPE ('g', 'p', 'u', 'u')
#define APPLE_SB_OBJ_ETHU  APPLE_SB_OBJ_TYPE ('e', 't', 'h', 'u')
#define APPLE_SB_OBJ_SDFU  APPLE_SB_OBJ_TYPE ('s', 'd', 'f', 'u')
#define APPLE_SB_OBJ_DTHU  APPLE_SB_OBJ_TYPE ('d', 't', 'h', 'u')
 
//
// The keys are iterated in the order in which they are defined here in
// boot.efi to validate the loaded kernel image.
//
#define APPLE_SB_OBJ_KERNEL        APPLE_SB_OBJ_TYPE ('m', 'k', 'r', 'n')
#define APPLE_SB_OBJ_KERNEL_DEBUG  APPLE_SB_OBJ_TYPE ('m', 'k', 'r', 'd')
 
typedef
VOID
(EFIAPI *APPLE_SB_SET_AVAILABILITY)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN BOOLEAN                     Available
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_VERIFY_IMG4_BY_PATH)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN EFI_DEVICE_PATH_PROTOCOL    *DevicePath,
  IN UINT32                      ObjType,
  IN BOOLEAN                     SetFailureReason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_VERIFY_IMG4)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN CONST VOID                  *ImageBuffer,
  IN UINTN                       ImageSize,
  IN CONST VOID                  *ManifestBuffer,
  IN UINTN                       ManifestSize,
  IN UINT32                      ObjType,
  IN BOOLEAN                     SetFailureReason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_GET_POLICY)(
  IN  APPLE_SECURE_BOOT_PROTOCOL  *This,
  OUT UINT8                       *Policy
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_GET_FAILURE_REASON)(
  IN  APPLE_SECURE_BOOT_PROTOCOL  *This,
  OUT UINT8                       *Reason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_SET_FAILURE_REASON)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN UINT8                       Reason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_GET_KERNEL_FAILURE_REASON)(
  IN  APPLE_SECURE_BOOT_PROTOCOL  *This,
  OUT UINT8                       *Reason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_SET_KERNEL_FAILURE_REASON)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN UINT8                       Reason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_VERIFY_WINDOWS_BY_PATH)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN EFI_DEVICE_PATH_PROTOCOL    *DevicePath,
  IN BOOLEAN                     SetFailureReason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_VERIFY_WINDOWS)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN CONST VOID                  *ImageBuffer,
  IN UINTN                       ImageSize,
  IN BOOLEAN                     SetFailureReason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_GET_WINDOWS_POLICY)(
  IN  APPLE_SECURE_BOOT_PROTOCOL  *This,
  OUT UINT8                       *Policy
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_GET_WINDOWS_FAILURE_REASON)(
  IN  APPLE_SECURE_BOOT_PROTOCOL  *This,
  OUT UINT8                       *Reason
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_SB_SET_WINDOWS_FAILURE_REASON)(
  IN APPLE_SECURE_BOOT_PROTOCOL  *This,
  IN UINT8                       Reason
  );
 
struct APPLE_SECURE_BOOT_PROTOCOL_ {
  UINTN                                  Revision;
  APPLE_SB_SET_AVAILABILITY              SetAvailability;
  APPLE_SB_VERIFY_IMG4_BY_PATH           VerifyImg4ByPath;
  APPLE_SB_VERIFY_IMG4                   VerifyImg4;
  APPLE_SB_GET_POLICY                    GetPolicy;
  APPLE_SB_GET_FAILURE_REASON            GetFailureReason;
  APPLE_SB_SET_FAILURE_REASON            SetFailureReason;
  APPLE_SB_GET_KERNEL_FAILURE_REASON     GetKernelFailureReason;
  APPLE_SB_SET_KERNEL_FAILURE_REASON     SetKernelFailureReason;
  APPLE_SB_VERIFY_WINDOWS_BY_PATH        VerifyWindowsByPath;
  APPLE_SB_VERIFY_WINDOWS                VerifyWindows;
  APPLE_SB_GET_WINDOWS_POLICY            GetWindowsPolicy;
  APPLE_SB_GET_WINDOWS_FAILURE_REASON    GetWindowsFailureReason;
  APPLE_SB_SET_WINDOWS_FAILURE_REASON    SetWindowsFailureReason;
};
 
extern EFI_GUID  gAppleSecureBootProtocolGuid;
 
#endif // APPLE_SECURE_BOOT_H