SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigNvData.h

   1 /** @file
   2   Header file for NV data structure definition.
   3
   4 Copyright (c) 2011 - 2017, 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 #ifndef __SECUREBOOT_CONFIG_NV_DATA_H__
  16 #define __SECUREBOOT_CONFIG_NV_DATA_H__
  17
  18 #include <Guid/HiiPlatformSetupFormset.h>
  19 #include <Guid/SecureBootConfigHii.h>
  20
  21 //
  22 // Used by VFR for form or button identification
  23 //
  24 #define SECUREBOOT_CONFIGURATION_VARSTORE_ID  0x0001
  25 #define SECUREBOOT_CONFIGURATION_FORM_ID      0x01
  26 #define FORMID_SECURE_BOOT_OPTION_FORM        0x02
  27 #define FORMID_SECURE_BOOT_PK_OPTION_FORM     0x03
  28 #define FORMID_SECURE_BOOT_KEK_OPTION_FORM    0x04
  29 #define FORMID_SECURE_BOOT_DB_OPTION_FORM     0x05
  30 #define FORMID_SECURE_BOOT_DBX_OPTION_FORM    0x06
  31 #define FORMID_ENROLL_PK_FORM                 0x07
  32 #define SECUREBOOT_ADD_PK_FILE_FORM_ID        0x08
  33 #define FORMID_ENROLL_KEK_FORM                0x09
  34 #define FORMID_DELETE_KEK_FORM                0x0a
  35 #define SECUREBOOT_ENROLL_SIGNATURE_TO_DB     0x0b
  36 #define SECUREBOOT_DELETE_SIGNATURE_FROM_DB   0x0c
  37 #define SECUREBOOT_ENROLL_SIGNATURE_TO_DBX    0x0d
  38 #define FORMID_SECURE_BOOT_DBT_OPTION_FORM    0x14
  39 #define SECUREBOOT_ENROLL_SIGNATURE_TO_DBT    0x15
  40 #define SECUREBOOT_DELETE_SIGNATURE_FROM_DBT  0x16
  41 #define SECUREBOOT_DELETE_SIGNATURE_LIST_FORM 0x17
  42 #define SECUREBOOT_DELETE_SIGNATURE_DATA_FORM 0x18
  43
  44 #define SECURE_BOOT_MODE_CUSTOM               0x01
  45 #define SECURE_BOOT_MODE_STANDARD             0x00
  46
  47 #define KEY_SECURE_BOOT_ENABLE                0x1000
  48 #define KEY_SECURE_BOOT_MODE                  0x1001
  49 #define KEY_VALUE_SAVE_AND_EXIT_DB            0x1002
  50 #define KEY_VALUE_NO_SAVE_AND_EXIT_DB         0x1003
  51 #define KEY_VALUE_SAVE_AND_EXIT_PK            0x1004
  52 #define KEY_VALUE_NO_SAVE_AND_EXIT_PK         0x1005
  53 #define KEY_VALUE_SAVE_AND_EXIT_KEK           0x1008
  54 #define KEY_VALUE_NO_SAVE_AND_EXIT_KEK        0x1009
  55 #define KEY_VALUE_SAVE_AND_EXIT_DBX           0x100a
  56 #define KEY_VALUE_NO_SAVE_AND_EXIT_DBX        0x100b
  57 #define KEY_HIDE_SECURE_BOOT                  0x100c
  58 #define KEY_VALUE_SAVE_AND_EXIT_DBT           0x100d
  59 #define KEY_VALUE_NO_SAVE_AND_EXIT_DBT        0x100e
  60
  61 #define KEY_VALUE_FROM_DBX_TO_LIST_FORM       0x100f
  62
  63 #define KEY_SECURE_BOOT_OPTION                0x1100
  64 #define KEY_SECURE_BOOT_PK_OPTION             0x1101
  65 #define KEY_SECURE_BOOT_KEK_OPTION            0x1102
  66 #define KEY_SECURE_BOOT_DB_OPTION             0x1103
  67 #define KEY_SECURE_BOOT_DBX_OPTION            0x1104
  68 #define KEY_SECURE_BOOT_DELETE_PK             0x1105
  69 #define KEY_ENROLL_PK                         0x1106
  70 #define KEY_ENROLL_KEK                        0x1107
  71 #define KEY_DELETE_KEK                        0x1108
  72 #define KEY_SECURE_BOOT_KEK_GUID              0x110a
  73 #define KEY_SECURE_BOOT_SIGNATURE_GUID_DB     0x110b
  74 #define KEY_SECURE_BOOT_SIGNATURE_GUID_DBX    0x110c
  75 #define KEY_SECURE_BOOT_DBT_OPTION            0x110d
  76 #define KEY_SECURE_BOOT_SIGNATURE_GUID_DBT    0x110e
  77 #define KEY_SECURE_BOOT_DELETE_ALL_LIST       0x110f
  78 #define KEY_SECURE_BOOT_DELETE_ALL_DATA       0x1110
  79 #define KEY_SECURE_BOOT_DELETE_CHECK_DATA     0x1111
  80
  81 #define LABEL_KEK_DELETE                      0x1200
  82 #define LABEL_DB_DELETE                       0x1201
  83 #define LABEL_SIGNATURE_LIST_START            0x1202
  84 #define LABEL_DBT_DELETE                      0x1203
  85 #define LABEL_SIGNATURE_DATA_START            0x1204
  86 #define LABEL_DELETE_ALL_LIST_BUTTON          0x1300
  87 #define LABEL_END                             0xffff
  88
  89 #define SECURE_BOOT_MAX_ATTEMPTS_NUM          255
  90
  91 #define CONFIG_OPTION_OFFSET                  0x2000
  92
  93 #define OPTION_CONFIG_QUESTION_ID             0x2000
  94 #define OPTION_CONFIG_RANGE                   0x1000
  95
  96 //
  97 // Question ID 0x2000 ~ 0x2FFF is for KEK
  98 //
  99 #define OPTION_DEL_KEK_QUESTION_ID            0x2000
 100 //
 101 // Question ID 0x3000 ~ 0x3FFF is for DB
 102 //
 103 #define OPTION_DEL_DB_QUESTION_ID             0x3000
 104 //
 105 // Question ID 0x4000 ~ 0x4FFF is for signature list.
 106 //
 107 #define OPTION_SIGNATURE_LIST_QUESTION_ID     0X4000
 108 //
 109 // Question ID 0x6000 ~ 0x6FFF is for signature data.
 110 //
 111 #define OPTION_SIGNATURE_DATA_QUESTION_ID     0x6000
 112
 113 //
 114 // Question ID 0x5000 ~ 0x5FFF is for DBT
 115 //
 116 #define OPTION_DEL_DBT_QUESTION_ID            0x5000
 117
 118 #define SECURE_BOOT_GUID_SIZE                 36
 119 #define SECURE_BOOT_GUID_STORAGE_SIZE         37
 120
 121 #define UNKNOWN_FILE_TYPE                     0
 122 #define X509_CERT_FILE_TYPE                   1
 123 #define PE_IMAGE_FILE_TYPE                    2
 124 #define AUTHENTICATION_2_FILE_TYPE            3
 125
 126 //
 127 // Nv Data structure referenced by IFR
 128 //
 129 typedef struct {
 130   BOOLEAN AttemptSecureBoot;   // Attempt to enable/disable Secure Boot
 131   BOOLEAN HideSecureBoot;      // Hiden Attempt Secure Boot
 132   CHAR16  SignatureGuid[SECURE_BOOT_GUID_STORAGE_SIZE];
 133   BOOLEAN PhysicalPresent;     // If a Physical Present User
 134   UINT8   SecureBootMode;      // Secure Boot Mode: Standard Or Custom
 135   BOOLEAN DeletePk;
 136   BOOLEAN HasPk;               // If Pk is existed it is true
 137   BOOLEAN AlwaysRevocation;    // If the certificate is always revoked. Revocation time is hidden
 138   UINT8   CertificateFormat;   // The type of the certificate
 139   EFI_HII_DATE RevocationDate; // The revocation date of the certificate
 140   EFI_HII_TIME RevocationTime; // The revocation time of the certificate
 141   UINT8   FileEnrollType;      // File type of sigunature enroll
 142   UINT32  ListCount;           // The count of signature list.
 143   UINT32  CheckedDataCount;    // The count of checked signature data.
 144 } SECUREBOOT_CONFIGURATION;
 145
 146 #endif