Package org.forgerock.opendj.server.config.server

Interface Argon2PasswordStorageSchemeCfg

All Superinterfaces:
Configuration, PasswordStorageSchemeCfg
public interface Argon2PasswordStorageSchemeCfg extends PasswordStorageSchemeCfg
A server-side interface for querying Argon2 Password Storage Scheme settings.

The Argon2 Password Storage Scheme provides a mechanism for encoding user passwords using the Argon2 message digest algorithm.

  • Method Details

    • configurationClass

      Class<? extends Argon2PasswordStorageSchemeCfg> configurationClass()
      Gets the configuration class associated with this Argon2 Password Storage Scheme.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface PasswordStorageSchemeCfg
      Returns:
      Returns the configuration class associated with this Argon2 Password Storage Scheme.

    • addArgon2ChangeListener

      void addArgon2ChangeListener(ConfigurationChangeListener<Argon2PasswordStorageSchemeCfg> listener)
      Register to be notified when this Argon2 Password Storage Scheme is changed.
      Parameters:
      listener - The Argon2 Password Storage Scheme configuration change listener.

    • removeArgon2ChangeListener

      void removeArgon2ChangeListener(ConfigurationChangeListener<Argon2PasswordStorageSchemeCfg> listener)
      Deregister an existing Argon2 Password Storage Scheme configuration change listener.
      Parameters:
      listener - The Argon2 Password Storage Scheme configuration change listener.

    • getArgon2Iterations

      int getArgon2Iterations()
      Gets the "argon2-iterations" property.

      The number of iterations to perform.

      By default, changes to this setting impact only newly created and updated passwords. However, if the rehash-policy is set to always or only-increase, it causes the server to recalculate each user's password hash on their next authentication, and write the new hash to the user's entry on disk. Changing the number of iterations therefore leads to a short-term spike in CPU and disk use as the server updates each user's password when they next authenticate. Longer term, increasing this setting results in more secure passwords at the expense of much higher CPU consumption and lower throughput.

      Default value: 2

      Returns:
      Returns the value of the "argon2-iterations" property.

    • getArgon2Length

      int getArgon2Length()
      Gets the "argon2-length" property.

      The length of the produced hash.

      By default, changes to this setting impact only newly created and updated passwords. However, if the rehash-policy is set to always or only-increase, it causes the server to recalculate each user's password hash on their next authentication, and write the new hash to the user's entry on disk. Changing the length of the produced hash therefore leads to a short-term spike in CPU and disk use as the server updates each user's password when they next authenticate. Longer term, increasing this setting results in more secure passwords at the expense of much higher CPU consumption and lower throughput.

      Default value: 32

      Returns:
      Returns the value of the "argon2-length" property.

    • getArgon2Memory

      int getArgon2Memory()
      Gets the "argon2-memory" property.

      The amount of memory to use for a single hash, expressed in kibibytes.

      By default, changes to this setting impact only newly created and updated passwords. However, if the rehash-policy is set to always or only-increase, it causes the server to recalculate each user's password hash on their next authentication, and write the new hash to the user's entry on disk. Changing the amount of memory to use therefore leads to a short-term spike in CPU and disk use as the server updates each user's password when they next authenticate. Longer term, increasing this setting results in more secure passwords at the expense of longer response times and lower throughput.

      Default value: 15360

      Returns:
      Returns the value of the "argon2-memory" property.

    • getArgon2MemoryPoolSize

      int getArgon2MemoryPoolSize()
      Gets the "argon2-memory-pool-size" property.

      The amount of memory dedicated to Argon2 password hashing, expressed in kibibytes.

      This amount of memory places an upper limit on the number of argon2 password hashes which can be computed concurrently. Every bind request using argon2 password hashing will acquire memory from this pool, and release it once computation has completed. When the pool is empty, incoming bind requests using argon2 will be paused, waiting for concurrent argon2 computation to finish and return memory to the pool.

      Default value: 122880

      Returns:
      Returns the value of the "argon2-memory-pool-size" property.

    • getArgon2Parallelism

      int getArgon2Parallelism()
      Gets the "argon2-parallelism" property.

      The number of threads to use in parallel to compute a hash.

      The number of threads should not exceed twice the number of physical CPU cores that are dedicated to password hashing. By default, changes to this setting impact only newly created and updated passwords. However, if the rehash-policy is set to always or only-increase, it causes the server to recalculate each user's password hash on their next authentication, and write the new hash to the user's entry on disk. Changing the amount of parallelism to use therefore leads to a short-term spike in CPU and disk use as the server updates each user's password when they next authenticate. Longer term, increasing this setting results in more secure passwords at the expense of much higher CPU consumption and lower throughput.

      Default value: 1

      Returns:
      Returns the value of the "argon2-parallelism" property.

    • getArgon2SaltLength

      int getArgon2SaltLength()
      Gets the "argon2-salt-length" property.

      The length of the salt used during the hash.

      By default, changes to this setting impact only newly created and updated passwords.

      Default value: 16

      Returns:
      Returns the value of the "argon2-salt-length" property.

    • getArgon2Variant

      Argon2PasswordStorageSchemeCfgDefn.Argon2Variant getArgon2Variant()
      Gets the "argon2-variant" property.

      The variant of Argon2 algorithm to use (between I, D and ID).

      Argon2D maximizes resistance to GPU cracking attacks. Argon2I is optimized to resist side-channel attacks. Argon2ID is a hybrid version that combines both approaches and has stronger resistance to attacks, but it's more expensive. By default, changes to this setting impact only newly created and updated passwords. However, if the rehash-policy is set to always or only-increase, it causes the server to recalculate each user's password hash on their next authentication, and writes the new hash to the user's entry on disk. Changing the variant of Argon2 algorithm to use therefore leads to a short-term spike in CPU and disk use as the server updates each user's password when they next authenticate. Longer term, increasing this setting results in more secure passwords at the expense of much higher CPU consumption and lower throughput.

      Default value: ID

      Returns:
      Returns the value of the "argon2-variant" property.

    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Argon2 Password Storage Scheme implementation.

      Default value: org.opends.server.extensions.Argon2PasswordStorageScheme

      Specified by:
      getJavaClass in interface PasswordStorageSchemeCfg
      Returns:
      Returns the value of the "java-class" property.

    • getRehashPolicy

      Argon2PasswordStorageSchemeCfgDefn.RehashPolicy getRehashPolicy()
      Gets the "rehash-policy" property.

      Indicates whether the server should rehash passwords after the cost has been changed.

      Passwords will be rehashed when a user successfully authenticates. Note that rehashing will increase the write load on the server.

      Default value: never

      Returns:
      Returns the value of the "rehash-policy" property.