Package org.opencms.security.twofactor

Class CmsTwoFactorAuthenticationConfig

java.lang.Object

org.opencms.security.twofactor.CmsTwoFactorAuthenticationConfig

public class CmsTwoFactorAuthenticationConfig
extends Object

Represents the configuration for the two-factor authentication feature.

Constructor Summary

Constructors

Constructor	Description
CmsTwoFactorAuthenticationConfig(org.dom4j.Element element)	Creates a new configuration from the given XML configuration element.

Method Summary

Modifier and Type	Method	Description
org.dom4j.Element	getConfigElement()	Gets the configuration element.
String	getIssuer()	Gets the issuer (encoded in generated QR codes and displayed by authenticator apps).
CmsTwoFactorAuthenticationUserPolicy	getPolicy()	Gets the policy which controls which users should use two-factor authentication.
String	getSecret()	Gets the secret key which is used to encrypt/decrypt two-factor authentication information stored in the user's additional infos.
String	getSetupMessage()	Gets the setup message.
boolean	isEnabled()	Checks if two-factor authentication is enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsTwoFactorAuthenticationConfig

public CmsTwoFactorAuthenticationConfig(org.dom4j.Element element)

Creates a new configuration from the given XML configuration element.

Parameters:

element - the element from which to read the configuration

Method Details

getConfigElement

public org.dom4j.Element getConfigElement()

Gets the configuration element.

Returns:

the configuration element

getIssuer

public String getIssuer()

Gets the issuer (encoded in generated QR codes and displayed by authenticator apps).

Returns:

the issuer

getPolicy

public CmsTwoFactorAuthenticationUserPolicy getPolicy()

Gets the policy which controls which users should use two-factor authentication.

Returns:

the user policy

getSecret

public String getSecret()

Gets the secret key which is used to encrypt/decrypt two-factor authentication information stored in the user's additional infos.

Returns:

the secret key

getSetupMessage

public String getSetupMessage()

Gets the setup message.

Returns:

the setup message

isEnabled

public boolean isEnabled()

Checks if two-factor authentication is enabled.

If it is disabled, users can just log in with user name and password.

Returns:

true if 2FA is enabled