View Source

Usages

Multi Factor Authenticator Plugin is used by Security Enhanced Directory Manager to provide multi factor authentication feature.
Once Multi Factor Authenticator Plugin is enabled in Security Enhanced Directory Manager, a user can choose to enable it under user profile page.
A useable Multi Factor Authenticator Plugin must extend org.joget.apps.app.service.MfaAuthenticator abstract class.

Under wflow-core module
Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
A base abstract class to develop a Multi Factor Authenticator Plugin.

public String getKey();

The key to load/store multi factor authentication data from user meta table.

public String validateOtpUrl(String username);

URL to show when OTP (one-time password) is required.

public String validateOtpMessage(String username);

Message to show when OTP (one-time password) is required.

public String activateOtpUrl(String username);

URL to activate OTP (one-time password).

public String userProfileHtml(String username, HttpServletRequest request);

HTML for rendering the MFA interface to activate/deactivate the MFA

public String updateUserProfileProcessing(String username, HttpServletRequest request);

Processing after a user profile is updated to update MFA status.

public boolean isOtpRequired(String username);

Checks whether OTP is required (MFA is enabled) for a user.

public void clearOtp(String username);

Deletes the current OTP for the user.

public String loginUser (String username) throws IOException;

Login the user

public String getRedirectUrl();

Get the redirection URL after login

public String getTemplate(String template, Map model);

Method to retrieve the html template

Parameters