7094d523b524e8b461c11e042b843f4b236df6c2
[mirror_edk2.git] / SecurityPkg / Include / Guid / AuthenticatedVariableFormat.h
1 /** @file
2 The variable data structures are related to EDKII-specific
3 implementation of UEFI authenticated variables.
4 AuthenticatedVariableFormat.h defines variable data headers
5 and variable storage region headers that has been moved to
6 VariableFormat.h.
7
8 Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
13
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16
17 **/
18
19 #ifndef __AUTHENTICATED_VARIABLE_FORMAT_H__
20 #define __AUTHENTICATED_VARIABLE_FORMAT_H__
21
22 #include <Guid/VariableFormat.h>
23
24 #define EFI_SECURE_BOOT_ENABLE_DISABLE \
25 { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
26
27 extern EFI_GUID gEfiSecureBootEnableDisableGuid;
28 extern EFI_GUID gEfiCertDbGuid;
29 extern EFI_GUID gEfiCustomModeEnableGuid;
30 extern EFI_GUID gEfiVendorKeysNvGuid;
31 extern EFI_GUID gEdkiiSecureBootModeGuid;
32
33 ///
34 /// "SecureBootEnable" variable for the Secure Boot feature enable/disable.
35 /// This variable is used for allowing a physically present user to disable
36 /// Secure Boot via firmware setup without the possession of PKpriv.
37 ///
38 /// GUID: gEfiSecureBootEnableDisableGuid
39 ///
40 /// Format: UINT8
41 ///
42 #define EFI_SECURE_BOOT_ENABLE_NAME L"SecureBootEnable"
43 #define SECURE_BOOT_ENABLE 1
44 #define SECURE_BOOT_DISABLE 0
45
46 ///
47 /// "CustomMode" variable for two Secure Boot modes feature: "Custom" and "Standard".
48 /// Standard Secure Boot mode is the default mode as UEFI Spec's description.
49 /// Custom Secure Boot mode allows for more flexibility as specified in the following:
50 /// Can enroll or delete PK without existing PK's private key.
51 /// Can enroll or delete KEK without existing PK's private key.
52 /// Can enroll or delete signature from DB/DBX without KEK's private key.
53 ///
54 /// GUID: gEfiCustomModeEnableGuid
55 ///
56 /// Format: UINT8
57 ///
58 #define EFI_CUSTOM_MODE_NAME L"CustomMode"
59 #define CUSTOM_SECURE_BOOT_MODE 1
60 #define STANDARD_SECURE_BOOT_MODE 0
61
62 ///
63 /// "VendorKeysNv" variable to record the out of band secure boot keys modification.
64 /// This variable is a read-only NV varaible that indicates whether someone other than
65 /// the platform vendor has used a mechanism not defined by the UEFI Specification to
66 /// transition the system to setup mode or to update secure boot keys.
67 ///
68 /// GUID: gEfiVendorKeysNvGuid
69 ///
70 /// Format: UINT8
71 ///
72 #define EFI_VENDOR_KEYS_NV_VARIABLE_NAME L"VendorKeysNv"
73 #define VENDOR_KEYS_VALID 1
74 #define VENDOR_KEYS_MODIFIED 0
75
76 #endif // __AUTHENTICATED_VARIABLE_FORMAT_H__