]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Variable/RuntimeDxe/VarCheck.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
MdeModulePkg Variable: Implement VarCheck PROTOCOL
[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / VarCheck.c
CommitLineData
efb01a10
SZ		 1/** @file\r
2 Implementation functions and structures for var check protocol.\r
3\r
4Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
5This program and the accompanying materials \r
6are licensed and made available under the terms and conditions of the BSD License \r
7which accompanies this distribution. The full text of the license may be found at \r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "Variable.h"\r
16#include <Library/DevicePathLib.h>\r
17\r
18extern LIST_ENTRY mLockedVariableList;\r
19extern BOOLEAN mEndOfDxe;\r
20extern BOOLEAN mEnableLocking;\r
21\r
22#define VAR_CHECK_HANDLER_TABLE_SIZE 0x8\r
23\r
24UINT32 mNumberOfHandler = 0;\r
25UINT32 mMaxNumberOfHandler = 0;\r
26VAR_CHECK_SET_VARIABLE_CHECK_HANDLER *mHandlerTable = NULL;\r
27\r
28typedef struct {\r
29 LIST_ENTRY Link;\r
30 EFI_GUID Guid;\r
31 VAR_CHECK_VARIABLE_PROPERTY VariableProperty;\r
32 //CHAR16 *Name;\r
33} VAR_CHECK_VARIABLE_ENTRY;\r
34\r
35LIST_ENTRY mVarCheckVariableList = INITIALIZE_LIST_HEAD_VARIABLE (mVarCheckVariableList);\r
36\r
37typedef\r
38EFI_STATUS\r
39(EFIAPI *INTERNAL_VAR_CHECK_FUNCTION) (\r
40 IN VAR_CHECK_VARIABLE_PROPERTY *Propery,\r
41 IN UINTN DataSize,\r
42 IN VOID *Data\r
43 );\r
44\r
45typedef struct {\r
46 CHAR16 *Name;\r
47 VAR_CHECK_VARIABLE_PROPERTY VariableProperty;\r
48 INTERNAL_VAR_CHECK_FUNCTION CheckFunction;\r
49} UEFI_DEFINED_VARIABLE_ENTRY;\r
50\r
51typedef struct _EFI_LOAD_OPTION {\r
52 UINT32 Attributes;\r
53 UINT16 FilePathListLength;\r
54//CHAR16 Description[];\r
55//EFI_DEVICE_PATH_PROTOCOL FilePathList[];\r
56//UINT8 OptionalData[];\r
57} EFI_LOAD_OPTION;\r
58\r
59/**\r
60 Internal check for load option.\r
61\r
62 @param[in] VariablePropery Pointer to variable property.\r
63 @param[in] DataSize Data size.\r
64 @param[in] Data Pointer to data buffer.\r
65\r
66 @retval EFI_SUCCESS The SetVariable check result was success.\r
67 @retval EFI_INVALID_PARAMETER The data buffer is not a valid load option.\r
68\r
69**/\r
70EFI_STATUS\r
71EFIAPI\r
72InternalVarCheckLoadOption (\r
73 IN VAR_CHECK_VARIABLE_PROPERTY *VariablePropery,\r
74 IN UINTN DataSize,\r
75 IN VOID *Data\r
76 )\r
77{\r
78 EFI_LOAD_OPTION *LoadOption;\r
79 CHAR16 *Description;\r
80 EFI_DEVICE_PATH_PROTOCOL *FilePathList;\r
81\r
82 LoadOption = (EFI_LOAD_OPTION *) Data;\r
83\r
84 //\r
85 // Check Description\r
86 //\r
87 Description = (CHAR16 *) ((UINTN) Data + sizeof (EFI_LOAD_OPTION));\r
88 while (Description < (CHAR16 *) ((UINTN) Data + DataSize)) {\r
89 if (*Description == L'\0') {\r
90 break;\r
91 }\r
92 Description++;\r
93 }\r
94 if ((UINTN) Description >= ((UINTN) Data + DataSize)) {\r
95 return EFI_INVALID_PARAMETER;\r
96 }\r
97 Description++;\r
98\r
99 //\r
100 // Check FilePathList\r
101 //\r
102 FilePathList = (EFI_DEVICE_PATH_PROTOCOL *) Description;\r
103 if ((UINTN) FilePathList > (MAX_ADDRESS - LoadOption->FilePathListLength)) {\r
104 return EFI_INVALID_PARAMETER;\r
105 }\r
106 if (((UINTN) FilePathList + LoadOption->FilePathListLength) > ((UINTN) Data + DataSize)) {\r
107 return EFI_INVALID_PARAMETER;\r
108 }\r
109 if (LoadOption->FilePathListLength < sizeof (EFI_DEVICE_PATH_PROTOCOL)) {\r
110 return EFI_INVALID_PARAMETER;\r
111 }\r
112 if (!IsDevicePathValid (FilePathList, LoadOption->FilePathListLength)) {\r
113 return EFI_INVALID_PARAMETER;\r
114 }\r
115\r
116 return EFI_SUCCESS;\r
117}\r
118\r
119/**\r
120 Internal check for key option.\r
121\r
122 @param[in] VariablePropery Pointer to variable property.\r
123 @param[in] DataSize Data size.\r
124 @param[in] Data Pointer to data buffer.\r
125\r
126 @retval EFI_SUCCESS The SetVariable check result was success.\r
127 @retval EFI_INVALID_PARAMETER The data buffer is not a valid key option.\r
128\r
129**/\r
130EFI_STATUS\r
131EFIAPI\r
132InternalVarCheckKeyOption (\r
133 IN VAR_CHECK_VARIABLE_PROPERTY *VariablePropery,\r
134 IN UINTN DataSize,\r
135 IN VOID *Data\r
136 )\r
137{\r
138 if (((DataSize - sizeof (EFI_KEY_OPTION)) % sizeof (EFI_INPUT_KEY)) != 0) {\r
139 return EFI_INVALID_PARAMETER;\r
140 }\r
141\r
142 return EFI_SUCCESS;\r
143}\r
144\r
145/**\r
146 Internal check for device path.\r
147\r
148 @param[in] VariablePropery Pointer to variable property.\r
149 @param[in] DataSize Data size.\r
150 @param[in] Data Pointer to data buffer.\r
151\r
152 @retval EFI_SUCCESS The SetVariable check result was success.\r
153 @retval EFI_INVALID_PARAMETER The data buffer is not a valid device path.\r
154\r
155**/\r
156EFI_STATUS\r
157EFIAPI\r
158InternalVarCheckDevicePath (\r
159 IN VAR_CHECK_VARIABLE_PROPERTY *VariablePropery,\r
160 IN UINTN DataSize,\r
161 IN VOID *Data\r
162 )\r
163{\r
164 if (!IsDevicePathValid ((EFI_DEVICE_PATH_PROTOCOL *) Data, DataSize)) {\r
165 return EFI_INVALID_PARAMETER;\r
166 }\r
167 return EFI_SUCCESS;\r
168}\r
169\r
170/**\r
171 Internal check for ASCII string.\r
172\r
173 @param[in] VariablePropery Pointer to variable property.\r
174 @param[in] DataSize Data size.\r
175 @param[in] Data Pointer to data buffer.\r
176\r
177 @retval EFI_SUCCESS The SetVariable check result was success.\r
178 @retval EFI_INVALID_PARAMETER The data buffer is not a Null-terminated ASCII string.\r
179\r
180**/\r
181EFI_STATUS\r
182EFIAPI\r
183InternalVarCheckAsciiString (\r
184 IN VAR_CHECK_VARIABLE_PROPERTY *VariablePropery,\r
185 IN UINTN DataSize,\r
186 IN VOID *Data\r
187 )\r
188{\r
189 CHAR8 *String;\r
190 UINTN Index;\r
191\r
192 String = (CHAR8 *) Data;\r
193 if (String[DataSize - 1] == '\0') {\r
194 return EFI_SUCCESS;\r
195 } else {\r
196 for (Index = 1; Index < DataSize && (String[DataSize - 1 - Index] != '\0'); Index++);\r
197 if (Index == DataSize) {\r
198 return EFI_INVALID_PARAMETER;\r
199 }\r
200 }\r
201 return EFI_SUCCESS;\r
202}\r
203\r
204/**\r
205 Internal check for size array.\r
206\r
207 @param[in] VariablePropery Pointer to variable property.\r
208 @param[in] DataSize Data size.\r
209 @param[in] Data Pointer to data buffer.\r
210\r
211 @retval EFI_SUCCESS The SetVariable check result was success.\r
212 @retval EFI_INVALID_PARAMETER The DataSize is not size array.\r
213\r
214**/\r
215EFI_STATUS\r
216EFIAPI\r
217InternalVarCheckSizeArray (\r
218 IN VAR_CHECK_VARIABLE_PROPERTY *VariablePropery,\r
219 IN UINTN DataSize,\r
220 IN VOID *Data\r
221 )\r
222{\r
223 if ((DataSize % VariablePropery->MinSize) != 0) {\r
224 return EFI_INVALID_PARAMETER;\r
225 }\r
226 return EFI_SUCCESS;\r
227}\r
228\r
229//\r
230// To prevent name collisions with possible future globally defined variables,\r
231// other internal firmware data variables that are not defined here must be\r
232// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or\r
233// any other GUID defined by the UEFI Specification. Implementations must\r
234// only permit the creation of variables with a UEFI Specification-defined\r
235// VendorGuid when these variables are documented in the UEFI Specification.\r
236//\r
237UEFI_DEFINED_VARIABLE_ENTRY mGlobalVariableList[] = {\r
238 {\r
239 EFI_LANG_CODES_VARIABLE_NAME,\r
240 {\r
241 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
242 0,\r
243 VARIABLE_ATTRIBUTE_BS_RT,\r
244 1,\r
245 MAX_UINTN\r
246 },\r
247 InternalVarCheckAsciiString\r
248 },\r
249 {\r
250 EFI_LANG_VARIABLE_NAME,\r
251 {\r
252 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
253 0,\r
254 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
255 1,\r
256 MAX_UINTN\r
257 },\r
258 InternalVarCheckAsciiString\r
259 },\r
260 {\r
261 EFI_TIME_OUT_VARIABLE_NAME,\r
262 {\r
263 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
264 0,\r
265 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
266 sizeof (UINT16),\r
267 sizeof (UINT16)\r
268 },\r
269 NULL\r
270 },\r
271 {\r
272 EFI_PLATFORM_LANG_CODES_VARIABLE_NAME,\r
273 {\r
274 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
275 0,\r
276 VARIABLE_ATTRIBUTE_BS_RT,\r
277 1,\r
278 MAX_UINTN\r
279 },\r
280 InternalVarCheckAsciiString\r
281 },\r
282 {\r
283 EFI_PLATFORM_LANG_VARIABLE_NAME,\r
284 {\r
285 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
286 0,\r
287 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
288 1,\r
289 MAX_UINTN\r
290 },\r
291 InternalVarCheckAsciiString\r
292 },\r
293 {\r
294 EFI_CON_IN_VARIABLE_NAME,\r
295 {\r
296 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
297 0,\r
298 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
299 sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
300 MAX_UINTN\r
301 },\r
302 InternalVarCheckDevicePath\r
303 },\r
304 {\r
305 EFI_CON_OUT_VARIABLE_NAME,\r
306 {\r
307 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
308 0,\r
309 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
310 sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
311 MAX_UINTN\r
312 },\r
313 InternalVarCheckDevicePath\r
314 },\r
315 {\r
316 EFI_ERR_OUT_VARIABLE_NAME,\r
317 {\r
318 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
319 0,\r
320 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
321 sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
322 MAX_UINTN\r
323 },\r
324 InternalVarCheckDevicePath\r
325 },\r
326 {\r
327 EFI_CON_IN_DEV_VARIABLE_NAME,\r
328 {\r
329 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
330 0,\r
331 VARIABLE_ATTRIBUTE_BS_RT,\r
332 sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
333 MAX_UINTN\r
334 },\r
335 InternalVarCheckDevicePath\r
336 },\r
337 {\r
338 EFI_CON_OUT_DEV_VARIABLE_NAME,\r
339 {\r
340 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
341 0,\r
342 VARIABLE_ATTRIBUTE_BS_RT,\r
343 sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
344 MAX_UINTN\r
345 },\r
346 InternalVarCheckDevicePath\r
347 },\r
348 {\r
349 EFI_ERR_OUT_DEV_VARIABLE_NAME,\r
350 {\r
351 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
352 0,\r
353 VARIABLE_ATTRIBUTE_BS_RT,\r
354 sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
355 MAX_UINTN\r
356 },\r
357 InternalVarCheckDevicePath\r
358 },\r
359 {\r
360 EFI_BOOT_ORDER_VARIABLE_NAME,\r
361 {\r
362 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
363 0,\r
364 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
365 sizeof (UINT16),\r
366 MAX_UINTN\r
367 },\r
368 InternalVarCheckSizeArray\r
369 },\r
370 {\r
371 EFI_BOOT_NEXT_VARIABLE_NAME,\r
372 {\r
373 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
374 0,\r
375 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
376 sizeof (UINT16),\r
377 sizeof (UINT16)\r
378 },\r
379 NULL\r
380 },\r
381 {\r
382 EFI_BOOT_CURRENT_VARIABLE_NAME,\r
383 {\r
384 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
385 0,\r
386 VARIABLE_ATTRIBUTE_BS_RT,\r
387 sizeof (UINT16),\r
388 sizeof (UINT16)\r
389 },\r
390 NULL\r
391 },\r
392 {\r
393 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME,\r
394 {\r
395 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
396 0,\r
397 VARIABLE_ATTRIBUTE_BS_RT,\r
398 sizeof (UINT32),\r
399 sizeof (UINT32)\r
400 },\r
401 NULL\r
402 },\r
403 {\r
404 EFI_DRIVER_ORDER_VARIABLE_NAME,\r
405 {\r
406 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
407 0,\r
408 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
409 sizeof (UINT16),\r
410 MAX_UINTN\r
411 },\r
412 InternalVarCheckSizeArray\r
413 },\r
414 {\r
415 EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME,\r
416 {\r
417 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
418 0,\r
419 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
420 sizeof (UINT16),\r
421 sizeof (UINT16)\r
422 },\r
423 NULL\r
424 },\r
425 {\r
426 EFI_SETUP_MODE_NAME,\r
427 {\r
428 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
429 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
430 VARIABLE_ATTRIBUTE_BS_RT,\r
431 sizeof (UINT8),\r
432 sizeof (UINT8)\r
433 },\r
434 NULL\r
435 },\r
436 {\r
437 EFI_KEY_EXCHANGE_KEY_NAME,\r
438 {\r
439 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
440 0,\r
441 VARIABLE_ATTRIBUTE_NV_BS_RT_AT,\r
442 1,\r
443 MAX_UINTN\r
444 },\r
445 NULL\r
446 },\r
447 {\r
448 EFI_PLATFORM_KEY_NAME,\r
449 {\r
450 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
451 0,\r
452 VARIABLE_ATTRIBUTE_NV_BS_RT_AT,\r
453 1,\r
454 MAX_UINTN\r
455 },\r
456 NULL\r
457 },\r
458 {\r
459 EFI_SIGNATURE_SUPPORT_NAME,\r
460 {\r
461 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
462 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
463 VARIABLE_ATTRIBUTE_BS_RT,\r
464 sizeof (EFI_GUID),\r
465 MAX_UINTN\r
466 },\r
467 InternalVarCheckSizeArray\r
468 },\r
469 {\r
470 EFI_SECURE_BOOT_MODE_NAME,\r
471 {\r
472 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
473 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
474 VARIABLE_ATTRIBUTE_BS_RT,\r
475 sizeof (UINT8),\r
476 sizeof (UINT8)\r
477 },\r
478 NULL\r
479 },\r
480 {\r
481 EFI_KEK_DEFAULT_VARIABLE_NAME,\r
482 {\r
483 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
484 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
485 VARIABLE_ATTRIBUTE_BS_RT,\r
486 1,\r
487 MAX_UINTN\r
488 },\r
489 NULL\r
490 },\r
491 {\r
492 EFI_PK_DEFAULT_VARIABLE_NAME,\r
493 {\r
494 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
495 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
496 VARIABLE_ATTRIBUTE_BS_RT,\r
497 1,\r
498 MAX_UINTN\r
499 },\r
500 NULL\r
501 },\r
502 {\r
503 EFI_DB_DEFAULT_VARIABLE_NAME,\r
504 {\r
505 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
506 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
507 VARIABLE_ATTRIBUTE_BS_RT,\r
508 1,\r
509 MAX_UINTN\r
510 },\r
511 NULL\r
512 },\r
513 {\r
514 EFI_DBX_DEFAULT_VARIABLE_NAME,\r
515 {\r
516 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
517 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
518 VARIABLE_ATTRIBUTE_BS_RT,\r
519 1,\r
520 MAX_UINTN\r
521 },\r
522 NULL\r
523 },\r
524 {\r
525 EFI_DBT_DEFAULT_VARIABLE_NAME,\r
526 {\r
527 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
528 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
529 VARIABLE_ATTRIBUTE_BS_RT,\r
530 1,\r
531 MAX_UINTN\r
532 },\r
533 NULL\r
534 },\r
535 {\r
536 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME,\r
537 {\r
538 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
539 0,\r
540 VARIABLE_ATTRIBUTE_BS_RT,\r
541 sizeof (UINT64),\r
542 sizeof (UINT64)\r
543 },\r
544 NULL\r
545 },\r
546 {\r
547 EFI_OS_INDICATIONS_VARIABLE_NAME,\r
548 {\r
549 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
550 0,\r
551 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
552 sizeof (UINT64),\r
553 sizeof (UINT64)\r
554 },\r
555 NULL\r
556 },\r
557 {\r
558 EFI_VENDOR_KEYS_VARIABLE_NAME,\r
559 {\r
560 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
561 VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
562 VARIABLE_ATTRIBUTE_BS_RT,\r
563 sizeof (UINT8),\r
564 sizeof (UINT8)\r
565 },\r
566 NULL\r
567 },\r
568};\r
569UEFI_DEFINED_VARIABLE_ENTRY mGlobalVariableList2[] = {\r
570 {\r
571 L"Boot####",\r
572 {\r
573 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
574 0,\r
575 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
576 sizeof (EFI_LOAD_OPTION),\r
577 MAX_UINTN\r
578 },\r
579 InternalVarCheckLoadOption\r
580 },\r
581 {\r
582 L"Driver####",\r
583 {\r
584 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
585 0,\r
586 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
587 sizeof (EFI_LOAD_OPTION),\r
588 MAX_UINTN\r
589 },\r
590 InternalVarCheckLoadOption\r
591 },\r
592 {\r
593 L"Key####",\r
594 {\r
595 VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
596 0,\r
597 VARIABLE_ATTRIBUTE_NV_BS_RT,\r
598 sizeof (EFI_KEY_OPTION),\r
599 sizeof (EFI_KEY_OPTION) + 3 * sizeof (EFI_INPUT_KEY)\r
600 },\r
601 InternalVarCheckKeyOption\r
602 },\r
603};\r
604\r
605/**\r
606 Get UEFI defined global variable property.\r
607 The code will check if variable guid is global variable guid first.\r
608 If yes, further check if variable name is in mGlobalVariableList or mGlobalVariableList2.\r
609\r
610 @param[in] VariableName Pointer to variable name.\r
611 @param[in] VendorGuid Variable Vendor Guid.\r
612 @param[in] WildcardMatch Try wildcard match or not.\r
613 @param[out] VariableProperty Pointer to variable property.\r
614 @param[out] VarCheckFunction Pointer to check function.\r
615\r
616 @retval EFI_SUCCESS Variable is not global variable.\r
617 @retval EFI_INVALID_PARAMETER Variable is global variable, but variable name is not in the lists.\r
618\r
619**/\r
620EFI_STATUS\r
621GetUefiDefinedVariableProperty (\r
622 IN CHAR16 *VariableName,\r
623 IN EFI_GUID *VendorGuid,\r
624 IN BOOLEAN WildcardMatch,\r
625 OUT VAR_CHECK_VARIABLE_PROPERTY **VariableProperty,\r
626 OUT INTERNAL_VAR_CHECK_FUNCTION *VarCheckFunction OPTIONAL\r
627 )\r
628{\r
629 UINTN Index;\r
630 UINTN NameLength;\r
631\r
632 if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid)) {\r
633 //\r
634 // Try list 1, exactly match.\r
635 //\r
636 for (Index = 0; Index < sizeof (mGlobalVariableList)/sizeof (mGlobalVariableList[0]); Index++) {\r
637 if (StrCmp (mGlobalVariableList[Index].Name, VariableName) == 0) {\r
638 if (VarCheckFunction != NULL) {\r
639 *VarCheckFunction = mGlobalVariableList[Index].CheckFunction;\r
640 }\r
641 *VariableProperty = &mGlobalVariableList[Index].VariableProperty;\r
642 return EFI_SUCCESS;\r
643 }\r
644 }\r
645\r
646 //\r
647 // Try list 2.\r
648 //\r
649 NameLength = StrLen (VariableName) - 4;\r
650 for (Index = 0; Index < sizeof (mGlobalVariableList2)/sizeof (mGlobalVariableList2[0]); Index++) {\r
651 if (WildcardMatch) {\r
652 if ((StrLen (VariableName) == StrLen (mGlobalVariableList2[Index].Name)) &&\r
653 (StrnCmp (mGlobalVariableList2[Index].Name, VariableName, NameLength) == 0) &&\r
654 IsHexaDecimalDigitCharacter (VariableName[NameLength]) &&\r
655 IsHexaDecimalDigitCharacter (VariableName[NameLength + 1]) &&\r
656 IsHexaDecimalDigitCharacter (VariableName[NameLength + 2]) &&\r
657 IsHexaDecimalDigitCharacter (VariableName[NameLength + 3])) {\r
658 if (VarCheckFunction != NULL) {\r
659 *VarCheckFunction = mGlobalVariableList2[Index].CheckFunction;\r
660 }\r
661 *VariableProperty = &mGlobalVariableList2[Index].VariableProperty;\r
662 return EFI_SUCCESS;\r
663 }\r
664 } else {\r
665 if (StrCmp (mGlobalVariableList2[Index].Name, VariableName) == 0) {\r
666 if (VarCheckFunction != NULL) {\r
667 *VarCheckFunction = mGlobalVariableList2[Index].CheckFunction;\r
668 }\r
669 *VariableProperty = &mGlobalVariableList2[Index].VariableProperty;\r
670 return EFI_SUCCESS;\r
671 }\r
672 }\r
673 }\r
674\r
675 //\r
676 // The variable name is not in the lists.\r
677 //\r
678 return EFI_INVALID_PARAMETER;\r
679 }\r
680\r
681 //\r
682 // It is not global variable.\r
683 //\r
684 return EFI_SUCCESS;\r
685}\r
686\r
687/**\r
688 Internal SetVariable check.\r
689\r
690 @param[in] VariableName Name of Variable to set.\r
691 @param[in] VendorGuid Variable vendor GUID.\r
692 @param[in] Attributes Attribute value of the variable.\r
693 @param[in] DataSize Size of Data to set.\r
694 @param[in] Data Data pointer.\r
695\r
696 @retval EFI_SUCCESS The SetVariable check result was success.\r
697 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID were supplied,\r
698 or the DataSize exceeds the minimum or maximum allowed,\r
699 or the Data value is not following UEFI spec for UEFI defined variables.\r
700 @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
701 @retval Others The return status from check handler.\r
702\r
703**/\r
704EFI_STATUS\r
705EFIAPI\r
706InternalVarCheckSetVariableCheck (\r
707 IN CHAR16 *VariableName,\r
708 IN EFI_GUID *VendorGuid,\r
709 IN UINT32 Attributes,\r
710 IN UINTN DataSize,\r
711 IN VOID *Data\r
712 )\r
713{\r
714 EFI_STATUS Status;\r
715 UINTN Index;\r
716 LIST_ENTRY *Link;\r
717 VAR_CHECK_VARIABLE_ENTRY *Entry;\r
718 CHAR16 *Name;\r
719 VAR_CHECK_VARIABLE_PROPERTY *Property;\r
720 INTERNAL_VAR_CHECK_FUNCTION VarCheckFunction;\r
721\r
722 if (!mEndOfDxe) {\r
723 //\r
724 // Only do check after End Of Dxe.\r
725 //\r
726 return EFI_SUCCESS;\r
727 }\r
728\r
729 Property = NULL;\r
730 Status = GetUefiDefinedVariableProperty (VariableName, VendorGuid, TRUE, &Property, &VarCheckFunction);\r
731 if (EFI_ERROR (Status)) {\r
732 DEBUG ((EFI_D_INFO, "[Variable]: Var Check UEFI defined variable fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
733 return Status;\r
734 }\r
735 if (Property == NULL) {\r
736 VarCheckFunction = NULL;\r
737 for ( Link = GetFirstNode (&mVarCheckVariableList)\r
738 ; !IsNull (&mVarCheckVariableList, Link)\r
739 ; Link = GetNextNode (&mVarCheckVariableList, Link)\r
740 ) {\r
741 Entry = BASE_CR (Link, VAR_CHECK_VARIABLE_ENTRY, Link);\r
742 Name = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
743 if (CompareGuid (&Entry->Guid, VendorGuid) && (StrCmp (Name, VariableName) == 0)) {\r
744 Property = &Entry->VariableProperty;\r
745 break;\r
746 }\r
747 }\r
748 }\r
749 if (Property != NULL) {\r
750 if (mEnableLocking && ((Property->Property & VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY) != 0)) {\r
751 DEBUG ((EFI_D_INFO, "[Variable]: Var Check ReadOnly variable fail %r - %g:%s\n", EFI_WRITE_PROTECTED, VendorGuid, VariableName));\r
752 return EFI_WRITE_PROTECTED;\r
753 }\r
754 if ((DataSize == 0) || (Attributes == 0)) {\r
755 //\r
756 // Do not check delete variable.\r
757 //\r
758 return EFI_SUCCESS;\r
759 }\r
760 if (Attributes != Property->Attributes) {\r
761 DEBUG ((EFI_D_INFO, "[Variable]: Var Check Attributes fail %r - %g:%s\n", EFI_INVALID_PARAMETER, VendorGuid, VariableName));\r
762 return EFI_INVALID_PARAMETER;\r
763 }\r
764 if ((DataSize < Property->MinSize) || (DataSize > Property->MaxSize)) {\r
765 DEBUG ((EFI_D_INFO, "[Variable]: Var Check DataSize fail %r - %g:%s\n", EFI_INVALID_PARAMETER, VendorGuid, VariableName));\r
766 return EFI_INVALID_PARAMETER;\r
767 }\r
768 if (VarCheckFunction != NULL) {\r
769 Status = VarCheckFunction (\r
770 Property,\r
771 DataSize,\r
772 Data\r
773 );\r
774 if (EFI_ERROR (Status)) {\r
775 DEBUG ((EFI_D_INFO, "[Variable]: Internal Var Check function fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
776 return Status;\r
777 }\r
778 }\r
779 }\r
780\r
781 for (Index = 0; Index < mNumberOfHandler; Index++) {\r
782 Status = mHandlerTable[Index] (\r
783 VariableName,\r
784 VendorGuid,\r
785 Attributes,\r
786 DataSize,\r
787 Data\r
788 );\r
789 if (EFI_ERROR (Status)) {\r
790 DEBUG ((EFI_D_INFO, "[Variable]: Var Check handler fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
791 return Status;\r
792 }\r
793 }\r
794 return EFI_SUCCESS;\r
795}\r
796\r
797/**\r
798 Reallocates more global memory to store the registered handler list.\r
799\r
800 @retval RETURN_SUCCESS Reallocate memory successfully.\r
801 @retval RETURN_OUT_OF_RESOURCES No enough memory to allocate.\r
802\r
803**/\r
804RETURN_STATUS\r
805EFIAPI\r
806ReallocateHandlerTable (\r
807 VOID\r
808 )\r
809{\r
810 VAR_CHECK_SET_VARIABLE_CHECK_HANDLER *HandlerTable;\r
811\r
812 //\r
813 // Reallocate memory for check handler table.\r
814 //\r
815 HandlerTable = ReallocateRuntimePool (\r
816 mMaxNumberOfHandler * sizeof (VAR_CHECK_SET_VARIABLE_CHECK_HANDLER), \r
817 (mMaxNumberOfHandler + VAR_CHECK_HANDLER_TABLE_SIZE) * sizeof (VAR_CHECK_SET_VARIABLE_CHECK_HANDLER), \r
818 mHandlerTable\r
819 );\r
820\r
821 //\r
822 // No enough resource to allocate.\r
823 //\r
824 if (HandlerTable == NULL) {\r
825 return RETURN_OUT_OF_RESOURCES;\r
826 }\r
827\r
828 mHandlerTable = HandlerTable;\r
829 //\r
830 // Increase max handler number.\r
831 //\r
832 mMaxNumberOfHandler = mMaxNumberOfHandler + VAR_CHECK_HANDLER_TABLE_SIZE;\r
833 return RETURN_SUCCESS;\r
834}\r
835\r
836/**\r
837 Register SetVariable check handler.\r
838\r
839 @param[in] Handler Pointer to check handler.\r
840\r
841 @retval EFI_SUCCESS The SetVariable check handler was registered successfully.\r
842 @retval EFI_INVALID_PARAMETER Handler is NULL.\r
843 @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
844 already been signaled.\r
845 @retval EFI_OUT_OF_RESOURCES There is not enough resource for the SetVariable check handler register request.\r
846 @retval EFI_UNSUPPORTED This interface is not implemented.\r
847 For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r
848\r
849**/\r
850EFI_STATUS\r
851EFIAPI\r
852VarCheckRegisterSetVariableCheckHandler (\r
853 IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler\r
854 )\r
855{\r
856 EFI_STATUS Status;\r
857\r
858 if (Handler == NULL) {\r
859 return EFI_INVALID_PARAMETER;\r
860 }\r
861\r
862 if (mEndOfDxe) {\r
863 return EFI_ACCESS_DENIED;\r
864 }\r
865\r
866 DEBUG ((EFI_D_INFO, "RegisterSetVariableCheckHandler - 0x%x\n", Handler));\r
867\r
868 //\r
869 // Check whether the handler list is enough to store new handler.\r
870 //\r
871 if (mNumberOfHandler == mMaxNumberOfHandler) {\r
872 //\r
873 // Allocate more resources for new handler.\r
874 //\r
875 Status = ReallocateHandlerTable();\r
876 if (EFI_ERROR (Status)) {\r
877 return Status;\r
878 }\r
879 }\r
880\r
881 //\r
882 // Register new handler into the handler list.\r
883 //\r
884 mHandlerTable[mNumberOfHandler] = Handler;\r
885 mNumberOfHandler++;\r
886\r
887 return EFI_SUCCESS;\r
888}\r
889\r
890/**\r
891 Internal variable property get.\r
892\r
893 @param[in] Name Pointer to the variable name.\r
894 @param[in] Guid Pointer to the vendor GUID.\r
895\r
896 @return Pointer to the property of variable specified by the Name and Guid.\r
897\r
898**/\r
899VAR_CHECK_VARIABLE_PROPERTY *\r
900InternalVarCheckVariablePropertyGet (\r
901 IN CHAR16 *Name,\r
902 IN EFI_GUID *Guid\r
903 )\r
904{\r
905 LIST_ENTRY *Link;\r
906 VAR_CHECK_VARIABLE_ENTRY *Entry;\r
907 CHAR16 *VariableName;\r
908 VAR_CHECK_VARIABLE_PROPERTY *Property;\r
909\r
910 Property = NULL;\r
911 GetUefiDefinedVariableProperty (Name, Guid, FALSE, &Property, NULL);\r
912 if (Property != NULL) {\r
913 return Property;\r
914 } else {\r
915 for ( Link = GetFirstNode (&mVarCheckVariableList)\r
916 ; !IsNull (&mVarCheckVariableList, Link)\r
917 ; Link = GetNextNode (&mVarCheckVariableList, Link)\r
918 ) {\r
919 Entry = BASE_CR (Link, VAR_CHECK_VARIABLE_ENTRY, Link);\r
920 VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
921 if (CompareGuid (&Entry->Guid, Guid) && (StrCmp (VariableName, Name) == 0)) {\r
922 return &Entry->VariableProperty;\r
923 }\r
924 }\r
925 }\r
926\r
927 return NULL;\r
928}\r
929\r
930/**\r
931 Variable property set.\r
932\r
933 @param[in] Name Pointer to the variable name.\r
934 @param[in] Guid Pointer to the vendor GUID.\r
935 @param[in] VariableProperty Pointer to the input variable property.\r
936\r
937 @retval EFI_SUCCESS The property of variable specified by the Name and Guid was set successfully.\r
938 @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r
939 or the fields of VariableProperty are not valid.\r
940 @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
941 already been signaled.\r
942 @retval EFI_OUT_OF_RESOURCES There is not enough resource for the variable property set request.\r
943\r
944**/\r
945EFI_STATUS\r
946EFIAPI\r
947VarCheckVariablePropertySet (\r
948 IN CHAR16 *Name,\r
949 IN EFI_GUID *Guid,\r
950 IN VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r
951 )\r
952{\r
953 EFI_STATUS Status;\r
954 VAR_CHECK_VARIABLE_ENTRY *Entry;\r
955 CHAR16 *VariableName;\r
956 VAR_CHECK_VARIABLE_PROPERTY *Property;\r
957\r
958 if (Name == NULL || Name[0] == 0 || Guid == NULL) {\r
959 return EFI_INVALID_PARAMETER;\r
960 }\r
961\r
962 if (VariableProperty == NULL) {\r
963 return EFI_INVALID_PARAMETER;\r
964 }\r
965\r
966 if (VariableProperty->Revision != VAR_CHECK_VARIABLE_PROPERTY_REVISION) {\r
967 return EFI_INVALID_PARAMETER;\r
968 }\r
969\r
970 if (mEndOfDxe) {\r
971 return EFI_ACCESS_DENIED;\r
972 }\r
973\r
974 Status = EFI_SUCCESS;\r
975\r
976 AcquireLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
977\r
978 Property = InternalVarCheckVariablePropertyGet (Name, Guid);\r
979 if (Property != NULL) {\r
980 CopyMem (Property, VariableProperty, sizeof (*VariableProperty));\r
981 } else {\r
982 Entry = AllocateRuntimeZeroPool (sizeof (*Entry) + StrSize (Name));\r
983 if (Entry == NULL) {\r
984 Status = EFI_OUT_OF_RESOURCES;\r
985 goto Done;\r
986 }\r
987 VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
988 StrnCpy (VariableName, Name, StrLen (Name));\r
989 CopyGuid (&Entry->Guid, Guid);\r
990 CopyMem (&Entry->VariableProperty, VariableProperty, sizeof (*VariableProperty));\r
991 InsertTailList (&mVarCheckVariableList, &Entry->Link);\r
992 }\r
993\r
994Done:\r
995 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
996\r
997 return Status;\r
998}\r
999\r
1000/**\r
1001 Variable property get.\r
1002\r
1003 @param[in] Name Pointer to the variable name.\r
1004 @param[in] Guid Pointer to the vendor GUID.\r
1005 @param[out] VariableProperty Pointer to the output variable property.\r
1006\r
1007 @retval EFI_SUCCESS The property of variable specified by the Name and Guid was got successfully.\r
1008 @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r
1009 @retval EFI_NOT_FOUND The property of variable specified by the Name and Guid was not found.\r
1010\r
1011**/\r
1012EFI_STATUS\r
1013EFIAPI\r
1014VarCheckVariablePropertyGet (\r
1015 IN CHAR16 *Name,\r
1016 IN EFI_GUID *Guid,\r
1017 OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r
1018 )\r
1019{\r
1020 LIST_ENTRY *Link;\r
1021 VARIABLE_ENTRY *Entry;\r
1022 CHAR16 *VariableName;\r
1023 BOOLEAN Found;\r
1024 VAR_CHECK_VARIABLE_PROPERTY *Property;\r
1025\r
1026 if (Name == NULL || Name[0] == 0 || Guid == NULL) {\r
1027 return EFI_INVALID_PARAMETER;\r
1028 }\r
1029\r
1030 if (VariableProperty == NULL) {\r
1031 return EFI_INVALID_PARAMETER;\r
1032 }\r
1033\r
1034 Found = FALSE;\r
1035\r
1036 AcquireLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
1037\r
1038 Property = InternalVarCheckVariablePropertyGet (Name, Guid);\r
1039 if (Property != NULL) {\r
1040 CopyMem (VariableProperty, Property, sizeof (*VariableProperty));\r
1041 Found = TRUE;\r
1042 }\r
1043\r
1044 for ( Link = GetFirstNode (&mLockedVariableList)\r
1045 ; !IsNull (&mLockedVariableList, Link)\r
1046 ; Link = GetNextNode (&mLockedVariableList, Link)\r
1047 ) {\r
1048 Entry = BASE_CR (Link, VARIABLE_ENTRY, Link);\r
1049 VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
1050 if (CompareGuid (&Entry->Guid, Guid) && (StrCmp (VariableName, Name) == 0)) {\r
1051 VariableProperty->Property |= VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY;\r
1052 if (!Found) {\r
1053 VariableProperty->Revision = VAR_CHECK_VARIABLE_PROPERTY_REVISION;\r
1054 Found = TRUE;\r
1055 }\r
1056 }\r
1057 }\r
1058\r
1059 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
1060\r
1061 return (Found ? EFI_SUCCESS : EFI_NOT_FOUND);\r
1062}\r
1063\r
EFI Development Kit II mirror for PVE