Package org.apereo.cas.configuration.model.support.mfa.gauth

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
This is CoreGoogleAuthenticatorMultifactorProperties.
Since:
5.2.0
See Also:

  • Constructor Details

    • CoreGoogleAuthenticatorMultifactorProperties

      public CoreGoogleAuthenticatorMultifactorProperties()

  • Method Details

    • getIssuer

      public String getIssuer()
      Issuer used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.

    • getLabel

      public String 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

      public GoogleAuthenticatorMultifactorScratchCodeProperties getScratchCodes()
      Scratch code settings.

    • setIssuer

      public CoreGoogleAuthenticatorMultifactorProperties setIssuer(String issuer)
      Issuer used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.
      Returns:
      this.

    • setLabel

      public CoreGoogleAuthenticatorMultifactorProperties setLabel(String label)
      Label used in the barcode when dealing with device registration events. Used in the registration URL to identify CAS.
      Returns:
      this.

    • setCodeDigits

      public CoreGoogleAuthenticatorMultifactorProperties setCodeDigits(int codeDigits)
      Length of the generated code.
      Returns:
      this.

    • setTimeStepSize

      public CoreGoogleAuthenticatorMultifactorProperties setTimeStepSize(long timeStepSize)
      The expiration time of the generated code in seconds.
      Returns:
      this.

    • setWindowSize

      public CoreGoogleAuthenticatorMultifactorProperties 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.
      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.