NAME

Kernel::WebApp::Util::TwoFactor::Base – Two-factor authentication method base class.

PUBLIC INTERFACE

has UserType

Attribute that holds to the type of user to handle.

has UserLogin

Attribute that holds the user login/username.

has UserID

Attribute that holds the user id.

has UserObject

Attribute that holds the user object (User or CustomerUser).

TwoFactorMethod()

Defines the internal TwoFactorMethod name of the two-factor authentication mechanism module.

GetLabel()

Get the label from the config for the two-factor authentication mechanism module.

GetIcon()

Get the icon from the config for the two-factor authentication mechanism module.

IsSendingTokenViaTransport()

Get the information if the token transport is possible for the two-factor authentication method.

TransportFieldValue()

Get the transport field value for the given user.

Setup()

Setup the two-factor method for the user.

DeleteSetup()

Delete setup for the two-factor method for the user.

IsSetupPossible()

Determines if user has the two-factor authentication method setup.

GetSetupErrorMessage()

Get an error message when the setup is not possible.

IsMethodSetupForUser()

Determines if user has the two-factor authentication method setup.

GetEnterVerificationCodeMessage()

Get the enter verification code message of the two-factor authentication method.

GetEnterSetupCodeMessage()

Get the enter setup code message of the two-factor authentication method.

GetRequestVerificationCodeMessage()

Get the request verification code message of the two-factor authentication method.

PRIVATE INTERFACE

has _TwoFactorMethodObject

Attribute that holds the two-factor method object (Auth or CustomerAuth).

_BuildUserObject()

The /_BuildUserObject() method will create a Kernel::System::User or CustomerUser object.

_BuildUserID()

The /_BuildUserID() method will set the UserID for the current user or customer.

_GetUserData()

The /_GetUserData() method will collect the user data for the current agent or customer user.

_BuildTwoFactorMethodObject()

The /_BuildTwoFactorMethodObject() method will create an instance of the Kernel::System::TwoFactor::/TwoFactorMethod() object.

_UserTypeUC()

Returns user type value with first character in uppercase.

    # $Self->UserType() = 'agent';
    my $Result = $Self->_UserTypeUC();
    $Result = 'Agent';