CmsTwoFactorAuthenticationConfig (OpenCms Core API, version 17.0)

java.lang.Object
- org.opencms.security.twofactor.CmsTwoFactorAuthenticationConfig

public class CmsTwoFactorAuthenticationConfig
extends java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.dom4j.Element`	`getConfigElement()`	Gets the configuration element.
`java.lang.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.
`java.lang.String`	`getSecret()`	Gets the secret key which is used to encrypt/decrypt two-factor authentication information stored in the user's additional infos.
`java.lang.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 Detail
  - 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 Detail
  - getConfigElement
```
public org.dom4j.Element getConfigElement()
```
    Gets the configuration element.
    
    Returns:
    
    the configuration element
  - getIssuer
```
public java.lang.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 java.lang.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 java.lang.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