[edk2-devel] [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The SMI to handle the user authentication should be unregister before booting to OS

Shi, Hao posted 1 patch 2 years, 7 months ago
Failed in applying to current master (apply log)
.../UserAuthenticationSmm.c                   | 39 +++++++++++++++++--
.../UserAuthenticationSmm.inf                 |  2 +
2 files changed, 38 insertions(+), 3 deletions(-)
[edk2-devel] [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The SMI to handle the user authentication should be unregister before booting to OS
Posted by Shi, Hao 2 years, 7 months ago
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3648

Register SmmExitBootServices and SmmLegacyBoot callback function to unregister this handler.

Signed-off-by: Hao Shi <hao.shi@intel.com>
Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
---
 .../UserAuthenticationSmm.c                   | 39 +++++++++++++++++--
 .../UserAuthenticationSmm.inf                 |  2 +
 2 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.c b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.c
index 07e834eb..3d66010b 100644
--- a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.c
+++ b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.c
@@ -13,6 +13,7 @@ UINTN                           mAdminPasswordTryCount = 0;
 
 BOOLEAN                         mNeedReVerify = TRUE;
 BOOLEAN                         mPasswordVerified = FALSE;
+EFI_HANDLE                      mSmmHandle = NULL;
 
 /**
   Verify if the password is correct.
@@ -612,6 +613,30 @@ EXIT:
   return EFI_SUCCESS;
 }
 
+/**
+  Performs Exit Boot Services UserAuthentication actions
+
+  @param[in] Protocol   Points to the protocol's unique identifier.
+  @param[in] Interface  Points to the interface instance.
+  @param[in] Handle     The handle on which the interface was installed.
+
+  @retval EFI_SUCCESS   Notification runs successfully.
+**/
+EFI_STATUS
+EFIAPI
+UaExitBootServices (
+  IN CONST EFI_GUID     *Protocol,
+  IN VOID               *Interface,
+  IN EFI_HANDLE         Handle
+  )
+{
+  DEBUG ((DEBUG_INFO, "Unregister User Authentication Smi\n"));
+
+  gSmst->SmiHandlerUnRegister(mSmmHandle);
+
+  return EFI_SUCCESS;
+}
+
 /**
   Main entry for this driver.
 
@@ -629,10 +654,11 @@ PasswordSmmInit (
   )
 {
   EFI_STATUS                            Status;
-  EFI_HANDLE                            SmmHandle;
   EDKII_VARIABLE_LOCK_PROTOCOL          *VariableLock;
   CHAR16                                PasswordHistoryName[sizeof(USER_AUTHENTICATION_VAR_NAME)/sizeof(CHAR16) + 5];
   UINTN                                 Index;
+  EFI_EVENT                             ExitBootServicesEvent;
+  EFI_EVENT                             LegacyBootEvent;
 
   ASSERT (PASSWORD_HASH_SIZE == SHA256_DIGEST_SIZE);
   ASSERT (PASSWORD_HISTORY_CHECK_COUNT < 0xFFFF);
@@ -657,13 +683,20 @@ PasswordSmmInit (
     ASSERT_EFI_ERROR (Status);
   }
 
-  SmmHandle = NULL;
-  Status    = gSmst->SmiHandlerRegister (SmmPasswordHandler, &gUserAuthenticationGuid, &SmmHandle);
+  Status = gSmst->SmiHandlerRegister (SmmPasswordHandler, &gUserAuthenticationGuid, &mSmmHandle);
   ASSERT_EFI_ERROR (Status);
   if (EFI_ERROR (Status)) {
     return Status;
   }
 
+  //
+  // Register for SmmExitBootServices and SmmLegacyBoot notification.
+  //
+  Status = gSmst->SmmRegisterProtocolNotify (&gEdkiiSmmExitBootServicesProtocolGuid, UaExitBootServices, &ExitBootServicesEvent);
+  ASSERT_EFI_ERROR (Status);
+  Status = gSmst->SmmRegisterProtocolNotify (&gEdkiiSmmLegacyBootProtocolGuid, UaExitBootServices, &LegacyBootEvent);
+  ASSERT_EFI_ERROR (Status);
+
   if (IsPasswordCleared()) {
     DEBUG ((DEBUG_INFO, "IsPasswordCleared\n"));
     SavePasswordToVariable (&gUserAuthenticationGuid, NULL, 0);
diff --git a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.inf b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.inf
index 0b33b194..d73a2fe2 100644
--- a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.inf
+++ b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDxeSmm/UserAuthenticationSmm.inf
@@ -48,6 +48,8 @@
 [Protocols]
   gEdkiiVariableLockProtocolGuid                ## CONSUMES
   gEfiSmmVariableProtocolGuid                   ## CONSUMES
+  gEdkiiSmmExitBootServicesProtocolGuid         ## CONSUMES
+  gEdkiiSmmLegacyBootProtocolGuid               ## CONSUMES
 
 [Depex]
   gEfiSmmVariableProtocolGuid AND gEfiVariableWriteArchProtocolGuid
-- 
2.31.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#81190): https://edk2.groups.io/g/devel/message/81190
Mute This Topic: https://groups.io/mt/85815441/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-


Re: [edk2-devel] [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The SMI to handle the user authentication should be unregister before booting to OS
Posted by Dandan Bi 2 years, 6 months ago
Reviewed-by: Dandan Bi <dandan.bi@intel.com>



Thanks,
Dandan

> -----Original Message-----
> From: Shi, Hao <hao.shi@intel.com>
> Sent: Tuesday, September 28, 2021 10:09 AM
> To: devel@edk2.groups.io
> Cc: Shi, Hao <hao.shi@intel.com>; Bi, Dandan <dandan.bi@intel.com>;
> Liming Gao <gaoliming@byosoft.com.cn>
> Subject: [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The
> SMI to handle the user authentication should be unregister before booting
> to OS
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3648
> 
> Register SmmExitBootServices and SmmLegacyBoot callback function to
> unregister this handler.
> 
> Signed-off-by: Hao Shi <hao.shi@intel.com>
> Cc: Dandan Bi <dandan.bi@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> ---
>  .../UserAuthenticationSmm.c                   | 39 +++++++++++++++++--
>  .../UserAuthenticationSmm.inf                 |  2 +
>  2 files changed, 38 insertions(+), 3 deletions(-)
> 
> diff --git
> a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> eSmm/UserAuthenticationSmm.c
> b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> eSmm/UserAuthenticationSmm.c
> index 07e834eb..3d66010b 100644
> ---
> a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> eSmm/UserAuthenticationSmm.c
> +++
> b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthentication
> +++ DxeSmm/UserAuthenticationSmm.c
> @@ -13,6 +13,7 @@ UINTN                           mAdminPasswordTryCount = 0;
> 
>  BOOLEAN                         mNeedReVerify = TRUE;
>  BOOLEAN                         mPasswordVerified = FALSE;
> +EFI_HANDLE                      mSmmHandle = NULL;
> 
>  /**
>    Verify if the password is correct.
> @@ -612,6 +613,30 @@ EXIT:
>    return EFI_SUCCESS;
>  }
> 
> +/**
> +  Performs Exit Boot Services UserAuthentication actions
> +
> +  @param[in] Protocol   Points to the protocol's unique identifier.
> +  @param[in] Interface  Points to the interface instance.
> +  @param[in] Handle     The handle on which the interface was installed.
> +
> +  @retval EFI_SUCCESS   Notification runs successfully.
> +**/
> +EFI_STATUS
> +EFIAPI
> +UaExitBootServices (
> +  IN CONST EFI_GUID     *Protocol,
> +  IN VOID               *Interface,
> +  IN EFI_HANDLE         Handle
> +  )
> +{
> +  DEBUG ((DEBUG_INFO, "Unregister User Authentication Smi\n"));
> +
> +  gSmst->SmiHandlerUnRegister(mSmmHandle);
> +
> +  return EFI_SUCCESS;
> +}
> +
>  /**
>    Main entry for this driver.
> 
> @@ -629,10 +654,11 @@ PasswordSmmInit (
>    )
>  {
>    EFI_STATUS                            Status;
> -  EFI_HANDLE                            SmmHandle;
>    EDKII_VARIABLE_LOCK_PROTOCOL          *VariableLock;
>    CHAR16
> PasswordHistoryName[sizeof(USER_AUTHENTICATION_VAR_NAME)/sizeof(
> CHAR16) + 5];
>    UINTN                                 Index;
> +  EFI_EVENT                             ExitBootServicesEvent;
> +  EFI_EVENT                             LegacyBootEvent;
> 
>    ASSERT (PASSWORD_HASH_SIZE == SHA256_DIGEST_SIZE);
>    ASSERT (PASSWORD_HISTORY_CHECK_COUNT < 0xFFFF); @@ -657,13
> +683,20 @@ PasswordSmmInit (
>      ASSERT_EFI_ERROR (Status);
>    }
> 
> -  SmmHandle = NULL;
> -  Status    = gSmst->SmiHandlerRegister (SmmPasswordHandler,
> &gUserAuthenticationGuid, &SmmHandle);
> +  Status = gSmst->SmiHandlerRegister (SmmPasswordHandler,
> + &gUserAuthenticationGuid, &mSmmHandle);
>    ASSERT_EFI_ERROR (Status);
>    if (EFI_ERROR (Status)) {
>      return Status;
>    }
> 
> +  //
> +  // Register for SmmExitBootServices and SmmLegacyBoot notification.
> +  //
> +  Status = gSmst->SmmRegisterProtocolNotify
> + (&gEdkiiSmmExitBootServicesProtocolGuid, UaExitBootServices,
> + &ExitBootServicesEvent);  ASSERT_EFI_ERROR (Status);  Status =
> + gSmst->SmmRegisterProtocolNotify (&gEdkiiSmmLegacyBootProtocolGuid,
> + UaExitBootServices, &LegacyBootEvent);  ASSERT_EFI_ERROR (Status);
> +
>    if (IsPasswordCleared()) {
>      DEBUG ((DEBUG_INFO, "IsPasswordCleared\n"));
>      SavePasswordToVariable (&gUserAuthenticationGuid, NULL, 0); diff --git
> a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> eSmm/UserAuthenticationSmm.inf
> b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> eSmm/UserAuthenticationSmm.inf
> index 0b33b194..d73a2fe2 100644
> ---
> a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> eSmm/UserAuthenticationSmm.inf
> +++
> b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthentication
> +++ DxeSmm/UserAuthenticationSmm.inf
> @@ -48,6 +48,8 @@
>  [Protocols]
>    gEdkiiVariableLockProtocolGuid                ## CONSUMES
>    gEfiSmmVariableProtocolGuid                   ## CONSUMES
> +  gEdkiiSmmExitBootServicesProtocolGuid         ## CONSUMES
> +  gEdkiiSmmLegacyBootProtocolGuid               ## CONSUMES
> 
>  [Depex]
>    gEfiSmmVariableProtocolGuid AND gEfiVariableWriteArchProtocolGuid
> --
> 2.31.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#81619): https://edk2.groups.io/g/devel/message/81619
Mute This Topic: https://groups.io/mt/85815441/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-


Re: [edk2-devel] [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The SMI to handle the user authentication should be unregister before booting to OS
Posted by Dandan Bi 2 years, 6 months ago
Patch is submitted via commit 23ca68c23dd600973e961de4368abacf4db8c5c0
https://github.com/tianocore/edk2-platforms/commit/23ca68c23dd600973e961de4368abacf4db8c5c0



Thanks,
Dandan

> -----Original Message-----
> From: Bi, Dandan
> Sent: Friday, October 8, 2021 9:44 AM
> To: Shi, Hao <hao.shi@intel.com>; devel@edk2.groups.io
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Subject: RE: [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The
> SMI to handle the user authentication should be unregister before booting to OS
> 
> Reviewed-by: Dandan Bi <dandan.bi@intel.com>
> 
> 
> 
> Thanks,
> Dandan
> 
> > -----Original Message-----
> > From: Shi, Hao <hao.shi@intel.com>
> > Sent: Tuesday, September 28, 2021 10:09 AM
> > To: devel@edk2.groups.io
> > Cc: Shi, Hao <hao.shi@intel.com>; Bi, Dandan <dandan.bi@intel.com>;
> > Liming Gao <gaoliming@byosoft.com.cn>
> > Subject: [PATCH] UserAuthFeaturePkg/UserAuthenticationDxeSmm: The SMI
> > to handle the user authentication should be unregister before booting
> > to OS
> >
> > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3648
> >
> > Register SmmExitBootServices and SmmLegacyBoot callback function to
> > unregister this handler.
> >
> > Signed-off-by: Hao Shi <hao.shi@intel.com>
> > Cc: Dandan Bi <dandan.bi@intel.com>
> > Cc: Liming Gao <gaoliming@byosoft.com.cn>
> > ---
> >  .../UserAuthenticationSmm.c                   | 39 +++++++++++++++++--
> >  .../UserAuthenticationSmm.inf                 |  2 +
> >  2 files changed, 38 insertions(+), 3 deletions(-)
> >
> > diff --git
> > a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> > eSmm/UserAuthenticationSmm.c
> > b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> > eSmm/UserAuthenticationSmm.c
> > index 07e834eb..3d66010b 100644
> > ---
> > a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> > eSmm/UserAuthenticationSmm.c
> > +++
> > b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthentication
> > +++ DxeSmm/UserAuthenticationSmm.c
> > @@ -13,6 +13,7 @@ UINTN                           mAdminPasswordTryCount = 0;
> >
> >  BOOLEAN                         mNeedReVerify = TRUE;
> >  BOOLEAN                         mPasswordVerified = FALSE;
> > +EFI_HANDLE                      mSmmHandle = NULL;
> >
> >  /**
> >    Verify if the password is correct.
> > @@ -612,6 +613,30 @@ EXIT:
> >    return EFI_SUCCESS;
> >  }
> >
> > +/**
> > +  Performs Exit Boot Services UserAuthentication actions
> > +
> > +  @param[in] Protocol   Points to the protocol's unique identifier.
> > +  @param[in] Interface  Points to the interface instance.
> > +  @param[in] Handle     The handle on which the interface was installed.
> > +
> > +  @retval EFI_SUCCESS   Notification runs successfully.
> > +**/
> > +EFI_STATUS
> > +EFIAPI
> > +UaExitBootServices (
> > +  IN CONST EFI_GUID     *Protocol,
> > +  IN VOID               *Interface,
> > +  IN EFI_HANDLE         Handle
> > +  )
> > +{
> > +  DEBUG ((DEBUG_INFO, "Unregister User Authentication Smi\n"));
> > +
> > +  gSmst->SmiHandlerUnRegister(mSmmHandle);
> > +
> > +  return EFI_SUCCESS;
> > +}
> > +
> >  /**
> >    Main entry for this driver.
> >
> > @@ -629,10 +654,11 @@ PasswordSmmInit (
> >    )
> >  {
> >    EFI_STATUS                            Status;
> > -  EFI_HANDLE                            SmmHandle;
> >    EDKII_VARIABLE_LOCK_PROTOCOL          *VariableLock;
> >    CHAR16
> > PasswordHistoryName[sizeof(USER_AUTHENTICATION_VAR_NAME)/sizeof(
> > CHAR16) + 5];
> >    UINTN                                 Index;
> > +  EFI_EVENT                             ExitBootServicesEvent;
> > +  EFI_EVENT                             LegacyBootEvent;
> >
> >    ASSERT (PASSWORD_HASH_SIZE == SHA256_DIGEST_SIZE);
> >    ASSERT (PASSWORD_HISTORY_CHECK_COUNT < 0xFFFF); @@ -657,13
> > +683,20 @@ PasswordSmmInit (
> >      ASSERT_EFI_ERROR (Status);
> >    }
> >
> > -  SmmHandle = NULL;
> > -  Status    = gSmst->SmiHandlerRegister (SmmPasswordHandler,
> > &gUserAuthenticationGuid, &SmmHandle);
> > +  Status = gSmst->SmiHandlerRegister (SmmPasswordHandler,
> > + &gUserAuthenticationGuid, &mSmmHandle);
> >    ASSERT_EFI_ERROR (Status);
> >    if (EFI_ERROR (Status)) {
> >      return Status;
> >    }
> >
> > +  //
> > +  // Register for SmmExitBootServices and SmmLegacyBoot notification.
> > +  //
> > +  Status = gSmst->SmmRegisterProtocolNotify
> > + (&gEdkiiSmmExitBootServicesProtocolGuid, UaExitBootServices,
> > + &ExitBootServicesEvent);  ASSERT_EFI_ERROR (Status);  Status =
> > + gSmst->SmmRegisterProtocolNotify (&gEdkiiSmmLegacyBootProtocolGuid,
> > + UaExitBootServices, &LegacyBootEvent);  ASSERT_EFI_ERROR (Status);
> > +
> >    if (IsPasswordCleared()) {
> >      DEBUG ((DEBUG_INFO, "IsPasswordCleared\n"));
> >      SavePasswordToVariable (&gUserAuthenticationGuid, NULL, 0); diff
> > --git
> > a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> > eSmm/UserAuthenticationSmm.inf
> > b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> > eSmm/UserAuthenticationSmm.inf
> > index 0b33b194..d73a2fe2 100644
> > ---
> > a/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthenticationDx
> > eSmm/UserAuthenticationSmm.inf
> > +++
> > b/Features/Intel/UserInterface/UserAuthFeaturePkg/UserAuthentication
> > +++ DxeSmm/UserAuthenticationSmm.inf
> > @@ -48,6 +48,8 @@
> >  [Protocols]
> >    gEdkiiVariableLockProtocolGuid                ## CONSUMES
> >    gEfiSmmVariableProtocolGuid                   ## CONSUMES
> > +  gEdkiiSmmExitBootServicesProtocolGuid         ## CONSUMES
> > +  gEdkiiSmmLegacyBootProtocolGuid               ## CONSUMES
> >
> >  [Depex]
> >    gEfiSmmVariableProtocolGuid AND gEfiVariableWriteArchProtocolGuid
> > --
> > 2.31.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#81846): https://edk2.groups.io/g/devel/message/81846
Mute This Topic: https://groups.io/mt/85815441/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-