MFAuthenticationHelper Class

Helper for multi-factor authentication

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<MFAuthenticationHelper>
        CMS.Membership.MFAuthenticationHelper

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 12.0.0

Syntax

public class MFAuthenticationHelper : AbstractHelper<MFAuthenticationHelper>

The MFAuthenticationHelper type exposes the following members.

Constructors

	Name	Description
Public method	MFAuthenticationHelper

Properties

	Name	Description
Protected property	ClockDriftTolerance	Tolerated clock drift between client and server.
Public property Static member	DisplaySetupCode	Indicates whether the setup code is showed to the user after enabling MFA.
Protected property	HashAlgorithm	Underlying hash algorithm used by the passcode generator.
Public property Static member	IsMultiFactorAuthEnabled	Indicates whether MFA is enabled.
Public property Static member	IsMultiFactorAuthRequired	Indicates whether MFA is forced.
Protected property	PasscodeLength	Length of the passcode.

Methods

	Name	Description
Public method Static member	GetSetupCodeForUser	Returns the setup code that should be used to synchronize with the user's authenticator.
Protected method	GetSetupCodeForUserInternal	Returns the setup code that should be used to synchronize with the user's authenticator.
Public method Static member	IsMultiFactorRequiredForUser	Indicates whether MFA is required for the given user.
Protected method	IsMultiFactorRequiredForUserInternal	Indicates whether MFA is required for the given user.
Public method Static member	IsPasscodeValid	Checks whether the entered passcode is valid.
Protected method	IsPasscodeValidInternal	Checks whether the entered passcode is valid.
Public method Static member	IssuePasscode	Fires the MultiFactorAuthenticate event. Generates a new secret in case the user has none.
Protected method	IssuePasscodeInternal	Fires the MultiFactorAuthenticate event. Generates a new secret in case the user has none.
Public method Static member	ResetSecretForUser	Resets the user's current MFA information.
Protected method	ResetSecretForUserInternal	Resets the user's current MFA information.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)