Add comment for modules which have external input.

signed-off-by: jiewen.yao@intel.com
reviewed-by: guo.dong@intel.com
reviewed-by: ting.ye@intel.com
reviewed-by: liming.gao@intel.com
reviewed-by: elvin.li@intel.com



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13446 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 27 insertions, 0 deletions

diff --git a/SecurityPkg/VariableAuthenticated/RuntimeDxe/AuthService.h b/SecurityPkg/VariableAuthenticated/RuntimeDxe/AuthService.h
index 4419c91744..7eb2a9d23c 100644
--- a/SecurityPkg/VariableAuthenticated/RuntimeDxe/AuthService.h
+++ b/SecurityPkg/VariableAuthenticated/RuntimeDxe/AuthService.h
@@ -76,6 +76,13 @@ typedef struct {
 /**

   Process variable with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS/EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.

 

+  Caution: This function may receive untrusted input.

+  This function may be invoked in SMM mode, and datasize and data are external input.

+  This function will do basic validation, before parse the data.

+  This function will parse the authentication carefully to avoid security issues, like

+  buffer overflow, integer overflow.

+  This function will check attribute carefully to avoid authentication bypass.

+

   @param[in]  VariableName                Name of Variable to be found.

   @param[in]  VendorGuid                  Variable vendor GUID.

 

@@ -162,6 +169,13 @@ CheckSignatureListFormat(
 /**

   Process variable with platform key for verification.

 

+  Caution: This function may receive untrusted input.

+  This function may be invoked in SMM mode, and datasize and data are external input.

+  This function will do basic validation, before parse the data.

+  This function will parse the authentication carefully to avoid security issues, like

+  buffer overflow, integer overflow.

+  This function will check attribute carefully to avoid authentication bypass.

+

   @param[in]  VariableName                Name of Variable to be found.

   @param[in]  VendorGuid                  Variable vendor GUID.

   @param[in]  Data                        Data pointer.

@@ -191,6 +205,13 @@ ProcessVarWithPk (
 /**

   Process variable with key exchange key for verification.

 

+  Caution: This function may receive untrusted input.

+  This function may be invoked in SMM mode, and datasize and data are external input.

+  This function will do basic validation, before parse the data.

+  This function will parse the authentication carefully to avoid security issues, like

+  buffer overflow, integer overflow.

+  This function will check attribute carefully to avoid authentication bypass.

+

   @param[in]  VariableName                Name of Variable to be found.

   @param[in]  VendorGuid                  Variable vendor GUID.

   @param[in]  Data                        Data pointer.

@@ -257,6 +278,12 @@ CompareTimeStamp (
 /**

   Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set

 

+  Caution: This function may receive untrusted input.

+  This function may be invoked in SMM mode, and datasize and data are external input.

+  This function will do basic validation, before parse the data.

+  This function will parse the authentication carefully to avoid security issues, like

+  buffer overflow, integer overflow.

+

   @param[in]  VariableName                Name of Variable to be found.

   @param[in]  VendorGuid                  Variable vendor GUID.

   @param[in]  Data                        Data pointer.