Class CoreGoogleAuthenticatorMultifactorProperties
java.lang.Object
org.apereo.cas.configuration.model.support.mfa.gauth.CoreGoogleAuthenticatorMultifactorProperties
- All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-gauth")
public class CoreGoogleAuthenticatorMultifactorProperties
extends Object
implements Serializable
- Since:
- 5.2.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Length of the generated code.Issuer used in the barcode when dealing with device registration events.getLabel()
Label used in the barcode when dealing with device registration events.Scratch code settings.long
The expiration time of the generated code in seconds.int
Since TOTP passwords are time-based, it is essential that the clock of both the server and the client are synchronised within the tolerance defined here as the window size.boolean
When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.boolean
Indicates whether this provider should support trusted devices.setCodeDigits
(int codeDigits) Length of the generated code.Issuer used in the barcode when dealing with device registration events.Label used in the barcode when dealing with device registration events.setMultipleDeviceRegistrationEnabled
(boolean multipleDeviceRegistrationEnabled) When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.Scratch code settings.setTimeStepSize
(long timeStepSize) The expiration time of the generated code in seconds.setTrustedDeviceEnabled
(boolean trustedDeviceEnabled) Indicates whether this provider should support trusted devices.setWindowSize
(int windowSize) Since TOTP passwords are time-based, it is essential that the clock of both the server and the client are synchronised within the tolerance defined here as the window size.
-
Constructor Details
-
CoreGoogleAuthenticatorMultifactorProperties
public CoreGoogleAuthenticatorMultifactorProperties()
-
-
Method Details
-
getIssuer
Issuer used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS. -
getLabel
Label used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS. -
getCodeDigits
public int getCodeDigits()Length of the generated code. -
getTimeStepSize
public long getTimeStepSize()The expiration time of the generated code in seconds. -
getWindowSize
public int getWindowSize()Since TOTP passwords are time-based, it is essential that the clock of both the server and the client are synchronised within the tolerance defined here as the window size. -
isMultipleDeviceRegistrationEnabled
public boolean isMultipleDeviceRegistrationEnabled()When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically. -
isTrustedDeviceEnabled
public boolean isTrustedDeviceEnabled()Indicates whether this provider should support trusted devices. -
getScratchCodes
Scratch code settings. -
setIssuer
Issuer used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.- Returns:
this
.
-
setLabel
Label used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.- Returns:
this
.
-
setCodeDigits
Length of the generated code.- Returns:
this
.
-
setTimeStepSize
The expiration time of the generated code in seconds.- Returns:
this
.
-
setWindowSize
Since TOTP passwords are time-based, it is essential that the clock of both the server and the client are synchronised within the tolerance defined here as the window size.- Returns:
this
.
-
setMultipleDeviceRegistrationEnabled
public CoreGoogleAuthenticatorMultifactorProperties setMultipleDeviceRegistrationEnabled(boolean multipleDeviceRegistrationEnabled) When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.- Returns:
this
.
-
setTrustedDeviceEnabled
public CoreGoogleAuthenticatorMultifactorProperties setTrustedDeviceEnabled(boolean trustedDeviceEnabled) Indicates whether this provider should support trusted devices.- Returns:
this
.
-
setScratchCodes
public CoreGoogleAuthenticatorMultifactorProperties setScratchCodes(GoogleAuthenticatorMultifactorScratchCodeProperties scratchCodes) Scratch code settings.- Returns:
this
.
-