]>
Commit | Line | Data |
---|---|---|
a6811666 SZ |
1 | /** @file\r |
2 | Implement authentication services for the authenticated variables.\r | |
3 | \r | |
4 | Caution: This module requires additional review when modified.\r | |
5 | This driver will have external input - variable data. It may be input in SMM mode.\r | |
6 | This external input must be validated carefully to avoid security issue like\r | |
7 | buffer overflow, integer overflow.\r | |
8 | Variable attribute should also be checked to avoid authentication bypass.\r | |
9 | The whole SMM authentication variable design relies on the integrity of flash part and SMM.\r | |
10 | which is assumed to be protected by platform. All variable code and metadata in flash/SMM Memory\r | |
11 | may not be modified without authorization. If platform fails to protect these resources,\r | |
12 | the authentication service provided in this driver will be broken, and the behavior is undefined.\r | |
13 | \r | |
14 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
15 | This program and the accompanying materials\r | |
16 | are licensed and made available under the terms and conditions of the BSD License\r | |
17 | which accompanies this distribution. The full text of the license may be found at\r | |
18 | http://opensource.org/licenses/bsd-license.php\r | |
19 | \r | |
20 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
21 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
22 | \r | |
23 | **/\r | |
24 | \r | |
25 | #include "AuthServiceInternal.h"\r | |
26 | \r | |
27 | ///\r | |
28 | /// Global database array for scratch\r | |
29 | ///\r | |
30 | UINT8 *mPubKeyStore;\r | |
31 | UINT32 mPubKeyNumber;\r | |
32 | UINT32 mMaxKeyNumber;\r | |
33 | UINT32 mMaxKeyDbSize;\r | |
34 | UINT8 *mCertDbStore;\r | |
35 | UINT32 mMaxCertDbSize;\r | |
a6811666 SZ |
36 | UINT8 mVendorKeyState;\r |
37 | \r | |
38 | EFI_GUID mSignatureSupport[] = {EFI_CERT_SHA1_GUID, EFI_CERT_SHA256_GUID, EFI_CERT_RSA2048_GUID, EFI_CERT_X509_GUID};\r | |
39 | \r | |
40 | //\r | |
41 | // Hash context pointer\r | |
42 | //\r | |
43 | VOID *mHashCtx = NULL;\r | |
44 | \r | |
45 | VARIABLE_ENTRY_PROPERTY mAuthVarEntry[] = {\r | |
46 | {\r | |
47 | &gEfiSecureBootEnableDisableGuid,\r | |
48 | EFI_SECURE_BOOT_ENABLE_NAME,\r | |
49 | {\r | |
50 | VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r | |
51 | 0,\r | |
52 | VARIABLE_ATTRIBUTE_NV_BS,\r | |
53 | sizeof (UINT8),\r | |
54 | sizeof (UINT8)\r | |
55 | }\r | |
56 | },\r | |
57 | {\r | |
58 | &gEfiCustomModeEnableGuid,\r | |
59 | EFI_CUSTOM_MODE_NAME,\r | |
60 | {\r | |
61 | VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r | |
62 | 0,\r | |
63 | VARIABLE_ATTRIBUTE_NV_BS,\r | |
64 | sizeof (UINT8),\r | |
65 | sizeof (UINT8)\r | |
66 | }\r | |
67 | },\r | |
68 | {\r | |
69 | &gEfiVendorKeysNvGuid,\r | |
70 | EFI_VENDOR_KEYS_NV_VARIABLE_NAME,\r | |
71 | {\r | |
72 | VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r | |
73 | VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r | |
74 | VARIABLE_ATTRIBUTE_NV_BS_RT_AT,\r | |
75 | sizeof (UINT8),\r | |
76 | sizeof (UINT8)\r | |
77 | }\r | |
78 | },\r | |
79 | {\r | |
80 | &gEfiAuthenticatedVariableGuid,\r | |
81 | AUTHVAR_KEYDB_NAME,\r | |
82 | {\r | |
83 | VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r | |
84 | VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r | |
85 | VARIABLE_ATTRIBUTE_NV_BS_RT_AW,\r | |
86 | sizeof (UINT8),\r | |
87 | MAX_UINTN\r | |
88 | }\r | |
89 | },\r | |
90 | {\r | |
91 | &gEfiCertDbGuid,\r | |
92 | EFI_CERT_DB_NAME,\r | |
93 | {\r | |
94 | VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r | |
95 | VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r | |
96 | VARIABLE_ATTRIBUTE_NV_BS_RT_AT,\r | |
97 | sizeof (UINT32),\r | |
98 | MAX_UINTN\r | |
99 | }\r | |
100 | },\r | |
4fc08e8d CZ |
101 | {\r |
102 | &gEdkiiSecureBootModeGuid,\r | |
103 | L"SecureBootMode",\r | |
104 | {\r | |
105 | VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r | |
106 | VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r | |
107 | VARIABLE_ATTRIBUTE_NV_BS_RT,\r | |
108 | sizeof (UINT8),\r | |
109 | sizeof (UINT8)\r | |
110 | }\r | |
111 | }\r | |
a6811666 SZ |
112 | };\r |
113 | \r | |
f18b2162 | 114 | VOID **mAuthVarAddressPointer[10];\r |
a6811666 SZ |
115 | \r |
116 | AUTH_VAR_LIB_CONTEXT_IN *mAuthVarLibContextIn = NULL;\r | |
117 | \r | |
118 | /**\r | |
119 | Initialization for authenticated varibale services.\r | |
120 | If this initialization returns error status, other APIs will not work\r | |
121 | and expect to be not called then.\r | |
122 | \r | |
123 | @param[in] AuthVarLibContextIn Pointer to input auth variable lib context.\r | |
124 | @param[out] AuthVarLibContextOut Pointer to output auth variable lib context.\r | |
125 | \r | |
126 | @retval EFI_SUCCESS Function successfully executed.\r | |
127 | @retval EFI_INVALID_PARAMETER If AuthVarLibContextIn == NULL or AuthVarLibContextOut == NULL.\r | |
128 | @retval EFI_OUT_OF_RESOURCES Fail to allocate enough resource.\r | |
129 | @retval EFI_UNSUPPORTED Unsupported to process authenticated variable.\r | |
130 | \r | |
131 | **/\r | |
132 | EFI_STATUS\r | |
133 | EFIAPI\r | |
134 | AuthVariableLibInitialize (\r | |
135 | IN AUTH_VAR_LIB_CONTEXT_IN *AuthVarLibContextIn,\r | |
136 | OUT AUTH_VAR_LIB_CONTEXT_OUT *AuthVarLibContextOut\r | |
137 | )\r | |
138 | {\r | |
139 | EFI_STATUS Status;\r | |
140 | UINT8 VarValue;\r | |
141 | UINT32 VarAttr;\r | |
142 | UINT8 *Data;\r | |
143 | UINTN DataSize;\r | |
144 | UINTN CtxSize;\r | |
a6811666 SZ |
145 | UINT8 CustomMode;\r |
146 | UINT32 ListSize;\r | |
147 | \r | |
148 | if ((AuthVarLibContextIn == NULL) || (AuthVarLibContextOut == NULL)) {\r | |
149 | return EFI_INVALID_PARAMETER;\r | |
150 | }\r | |
151 | \r | |
152 | mAuthVarLibContextIn = AuthVarLibContextIn;\r | |
153 | \r | |
154 | //\r | |
155 | // Initialize hash context.\r | |
156 | //\r | |
157 | CtxSize = Sha256GetContextSize ();\r | |
158 | mHashCtx = AllocateRuntimePool (CtxSize);\r | |
159 | if (mHashCtx == NULL) {\r | |
160 | return EFI_OUT_OF_RESOURCES;\r | |
161 | }\r | |
162 | \r | |
163 | //\r | |
164 | // Reserve runtime buffer for public key database. The size excludes variable header and name size.\r | |
165 | //\r | |
166 | mMaxKeyDbSize = (UINT32) (mAuthVarLibContextIn->MaxAuthVariableSize - sizeof (AUTHVAR_KEYDB_NAME));\r | |
167 | mMaxKeyNumber = mMaxKeyDbSize / sizeof (AUTHVAR_KEY_DB_DATA);\r | |
168 | mPubKeyStore = AllocateRuntimePool (mMaxKeyDbSize);\r | |
169 | if (mPubKeyStore == NULL) {\r | |
170 | return EFI_OUT_OF_RESOURCES;\r | |
171 | }\r | |
172 | \r | |
173 | //\r | |
174 | // Reserve runtime buffer for certificate database. The size excludes variable header and name size.\r | |
175 | //\r | |
176 | mMaxCertDbSize = (UINT32) (mAuthVarLibContextIn->MaxAuthVariableSize - sizeof (EFI_CERT_DB_NAME));\r | |
177 | mCertDbStore = AllocateRuntimePool (mMaxCertDbSize);\r | |
178 | if (mCertDbStore == NULL) {\r | |
179 | return EFI_OUT_OF_RESOURCES;\r | |
180 | }\r | |
181 | \r | |
182 | //\r | |
183 | // Check "AuthVarKeyDatabase" variable's existence.\r | |
184 | // If it doesn't exist, create a new one with initial value of 0 and EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r | |
185 | //\r | |
186 | Status = AuthServiceInternalFindVariable (\r | |
187 | AUTHVAR_KEYDB_NAME,\r | |
188 | &gEfiAuthenticatedVariableGuid,\r | |
189 | (VOID **) &Data,\r | |
190 | &DataSize\r | |
191 | );\r | |
192 | if (EFI_ERROR (Status)) {\r | |
193 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS;\r | |
194 | VarValue = 0;\r | |
195 | mPubKeyNumber = 0;\r | |
196 | Status = AuthServiceInternalUpdateVariable (\r | |
197 | AUTHVAR_KEYDB_NAME,\r | |
198 | &gEfiAuthenticatedVariableGuid,\r | |
199 | &VarValue,\r | |
200 | sizeof(UINT8),\r | |
201 | VarAttr\r | |
202 | );\r | |
203 | if (EFI_ERROR (Status)) {\r | |
204 | return Status;\r | |
205 | }\r | |
206 | } else {\r | |
207 | //\r | |
208 | // Load database in global variable for cache.\r | |
209 | //\r | |
210 | ASSERT ((DataSize != 0) && (Data != NULL));\r | |
211 | //\r | |
212 | // "AuthVarKeyDatabase" is an internal variable. Its DataSize is always ensured not to exceed mPubKeyStore buffer size(See definition before)\r | |
213 | // Therefore, there is no memory overflow in underlying CopyMem.\r | |
214 | //\r | |
215 | CopyMem (mPubKeyStore, (UINT8 *) Data, DataSize);\r | |
216 | mPubKeyNumber = (UINT32) (DataSize / sizeof (AUTHVAR_KEY_DB_DATA));\r | |
217 | }\r | |
218 | \r | |
a6811666 | 219 | //\r |
4fc08e8d | 220 | // Init Secure Boot variables\r |
a6811666 | 221 | //\r |
4fc08e8d CZ |
222 | Status = InitSecureBootVariables ();\r |
223 | \r | |
a6811666 SZ |
224 | \r |
225 | //\r | |
226 | // Create "SignatureSupport" variable with BS+RT attribute set.\r | |
227 | //\r | |
228 | Status = AuthServiceInternalUpdateVariable (\r | |
229 | EFI_SIGNATURE_SUPPORT_NAME,\r | |
230 | &gEfiGlobalVariableGuid,\r | |
231 | mSignatureSupport,\r | |
232 | sizeof(mSignatureSupport),\r | |
233 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS\r | |
234 | );\r | |
235 | if (EFI_ERROR (Status)) {\r | |
236 | return Status;\r | |
237 | }\r | |
238 | \r | |
a6811666 SZ |
239 | //\r |
240 | // Initialize "CustomMode" in STANDARD_SECURE_BOOT_MODE state.\r | |
241 | //\r | |
242 | CustomMode = STANDARD_SECURE_BOOT_MODE;\r | |
243 | Status = AuthServiceInternalUpdateVariable (\r | |
244 | EFI_CUSTOM_MODE_NAME,\r | |
245 | &gEfiCustomModeEnableGuid,\r | |
246 | &CustomMode,\r | |
247 | sizeof (UINT8),\r | |
248 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS\r | |
249 | );\r | |
250 | if (EFI_ERROR (Status)) {\r | |
251 | return Status;\r | |
252 | }\r | |
253 | \r | |
254 | DEBUG ((EFI_D_INFO, "Variable %s is %x\n", EFI_CUSTOM_MODE_NAME, CustomMode));\r | |
255 | \r | |
256 | //\r | |
257 | // Check "certdb" variable's existence.\r | |
258 | // If it doesn't exist, then create a new one with\r | |
259 | // EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.\r | |
260 | //\r | |
261 | Status = AuthServiceInternalFindVariable (\r | |
262 | EFI_CERT_DB_NAME,\r | |
263 | &gEfiCertDbGuid,\r | |
264 | (VOID **) &Data,\r | |
265 | &DataSize\r | |
266 | );\r | |
267 | if (EFI_ERROR (Status)) {\r | |
268 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r | |
269 | ListSize = sizeof (UINT32);\r | |
270 | Status = AuthServiceInternalUpdateVariable (\r | |
271 | EFI_CERT_DB_NAME,\r | |
272 | &gEfiCertDbGuid,\r | |
273 | &ListSize,\r | |
274 | sizeof (UINT32),\r | |
275 | VarAttr\r | |
276 | );\r | |
277 | if (EFI_ERROR (Status)) {\r | |
278 | return Status;\r | |
279 | }\r | |
64b6a3ff CZ |
280 | } else {\r |
281 | //\r | |
282 | // Clean up Certs to make certDB & Time based auth variable consistent\r | |
283 | //\r | |
284 | Status = CleanCertsFromDb();\r | |
285 | if (EFI_ERROR (Status)) {\r | |
f3964772 | 286 | DEBUG ((EFI_D_ERROR, "Clean up CertDB fail! Status %x\n", Status));\r |
64b6a3ff CZ |
287 | return Status;\r |
288 | }\r | |
a6811666 SZ |
289 | }\r |
290 | \r | |
291 | //\r | |
292 | // Check "VendorKeysNv" variable's existence and create "VendorKeys" variable accordingly.\r | |
293 | //\r | |
294 | Status = AuthServiceInternalFindVariable (EFI_VENDOR_KEYS_NV_VARIABLE_NAME, &gEfiVendorKeysNvGuid, (VOID **) &Data, &DataSize);\r | |
295 | if (!EFI_ERROR (Status)) {\r | |
296 | mVendorKeyState = *(UINT8 *)Data;\r | |
297 | } else {\r | |
298 | //\r | |
299 | // "VendorKeysNv" not exist, initialize it in VENDOR_KEYS_VALID state.\r | |
300 | //\r | |
301 | mVendorKeyState = VENDOR_KEYS_VALID;\r | |
302 | Status = AuthServiceInternalUpdateVariable (\r | |
303 | EFI_VENDOR_KEYS_NV_VARIABLE_NAME,\r | |
304 | &gEfiVendorKeysNvGuid,\r | |
305 | &mVendorKeyState,\r | |
306 | sizeof (UINT8),\r | |
307 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\r | |
308 | );\r | |
309 | if (EFI_ERROR (Status)) {\r | |
310 | return Status;\r | |
311 | }\r | |
312 | }\r | |
313 | \r | |
314 | //\r | |
315 | // Create "VendorKeys" variable with BS+RT attribute set.\r | |
316 | //\r | |
317 | Status = AuthServiceInternalUpdateVariable (\r | |
318 | EFI_VENDOR_KEYS_VARIABLE_NAME,\r | |
319 | &gEfiGlobalVariableGuid,\r | |
320 | &mVendorKeyState,\r | |
321 | sizeof (UINT8),\r | |
322 | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS\r | |
323 | );\r | |
324 | if (EFI_ERROR (Status)) {\r | |
325 | return Status;\r | |
326 | }\r | |
327 | \r | |
328 | DEBUG ((EFI_D_INFO, "Variable %s is %x\n", EFI_VENDOR_KEYS_VARIABLE_NAME, mVendorKeyState));\r | |
329 | \r | |
330 | AuthVarLibContextOut->StructVersion = AUTH_VAR_LIB_CONTEXT_OUT_STRUCT_VERSION;\r | |
331 | AuthVarLibContextOut->StructSize = sizeof (AUTH_VAR_LIB_CONTEXT_OUT);\r | |
332 | AuthVarLibContextOut->AuthVarEntry = mAuthVarEntry;\r | |
333 | AuthVarLibContextOut->AuthVarEntryCount = sizeof (mAuthVarEntry) / sizeof (mAuthVarEntry[0]);\r | |
f18b2162 SZ |
334 | mAuthVarAddressPointer[0] = (VOID **) &mPubKeyStore;\r |
335 | mAuthVarAddressPointer[1] = (VOID **) &mCertDbStore;\r | |
336 | mAuthVarAddressPointer[2] = (VOID **) &mHashCtx;\r | |
337 | mAuthVarAddressPointer[3] = (VOID **) &mAuthVarLibContextIn;\r | |
338 | mAuthVarAddressPointer[4] = (VOID **) &(mAuthVarLibContextIn->FindVariable),\r | |
339 | mAuthVarAddressPointer[5] = (VOID **) &(mAuthVarLibContextIn->FindNextVariable),\r | |
340 | mAuthVarAddressPointer[6] = (VOID **) &(mAuthVarLibContextIn->UpdateVariable),\r | |
341 | mAuthVarAddressPointer[7] = (VOID **) &(mAuthVarLibContextIn->GetScratchBuffer),\r | |
342 | mAuthVarAddressPointer[8] = (VOID **) &(mAuthVarLibContextIn->CheckRemainingSpaceForConsistency),\r | |
343 | mAuthVarAddressPointer[9] = (VOID **) &(mAuthVarLibContextIn->AtRuntime),\r | |
344 | AuthVarLibContextOut->AddressPointer = mAuthVarAddressPointer;\r | |
345 | AuthVarLibContextOut->AddressPointerCount = sizeof (mAuthVarAddressPointer) / sizeof (mAuthVarAddressPointer[0]);\r | |
a6811666 SZ |
346 | \r |
347 | return Status;\r | |
348 | }\r | |
349 | \r | |
350 | /**\r | |
351 | Process variable with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS/EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.\r | |
352 | \r | |
353 | @param[in] VariableName Name of the variable.\r | |
354 | @param[in] VendorGuid Variable vendor GUID.\r | |
355 | @param[in] Data Data pointer.\r | |
356 | @param[in] DataSize Size of Data.\r | |
357 | @param[in] Attributes Attribute value of the variable.\r | |
358 | \r | |
359 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r | |
360 | defined by the Attributes.\r | |
361 | @retval EFI_INVALID_PARAMETER Invalid parameter.\r | |
362 | @retval EFI_WRITE_PROTECTED Variable is write-protected.\r | |
363 | @retval EFI_OUT_OF_RESOURCES There is not enough resource.\r | |
364 | @retval EFI_SECURITY_VIOLATION The variable is with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r | |
365 | or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS\r | |
366 | set, but the AuthInfo does NOT pass the validation\r | |
367 | check carried out by the firmware.\r | |
368 | @retval EFI_UNSUPPORTED Unsupported to process authenticated variable.\r | |
369 | \r | |
370 | **/\r | |
371 | EFI_STATUS\r | |
372 | EFIAPI\r | |
373 | AuthVariableLibProcessVariable (\r | |
374 | IN CHAR16 *VariableName,\r | |
375 | IN EFI_GUID *VendorGuid,\r | |
376 | IN VOID *Data,\r | |
377 | IN UINTN DataSize,\r | |
378 | IN UINT32 Attributes\r | |
379 | )\r | |
380 | {\r | |
381 | EFI_STATUS Status;\r | |
382 | \r | |
4fc08e8d CZ |
383 | //\r |
384 | // Process PK, KEK, Sigdb, AuditMode, DeployedMode separately.\r | |
385 | //\r | |
a6811666 SZ |
386 | if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid) && (StrCmp (VariableName, EFI_PLATFORM_KEY_NAME) == 0)){\r |
387 | Status = ProcessVarWithPk (VariableName, VendorGuid, Data, DataSize, Attributes, TRUE);\r | |
388 | } else if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid) && (StrCmp (VariableName, EFI_KEY_EXCHANGE_KEY_NAME) == 0)) {\r | |
389 | Status = ProcessVarWithPk (VariableName, VendorGuid, Data, DataSize, Attributes, FALSE);\r | |
4fc08e8d CZ |
390 | } else if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid) \r |
391 | && (StrCmp (VariableName, EFI_AUDIT_MODE_NAME) == 0 || StrCmp (VariableName, EFI_DEPLOYED_MODE_NAME) == 0)) {\r | |
392 | Status = ProcessSecureBootModeVar(VariableName, VendorGuid, Data, DataSize, Attributes);\r | |
a6811666 SZ |
393 | } else if (CompareGuid (VendorGuid, &gEfiImageSecurityDatabaseGuid) &&\r |
394 | ((StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE) == 0) ||\r | |
395 | (StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE1) == 0) ||\r | |
396 | (StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE2) == 0)\r | |
397 | )) {\r | |
398 | Status = ProcessVarWithPk (VariableName, VendorGuid, Data, DataSize, Attributes, FALSE);\r | |
399 | if (EFI_ERROR (Status)) {\r | |
400 | Status = ProcessVarWithKek (VariableName, VendorGuid, Data, DataSize, Attributes);\r | |
401 | }\r | |
402 | } else {\r | |
403 | Status = ProcessVariable (VariableName, VendorGuid, Data, DataSize, Attributes);\r | |
404 | }\r | |
405 | \r | |
406 | return Status;\r | |
407 | }\r |