Record Class ResourceEstimate

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.credential.password.provider.ResourceEstimate
Record Components:
estimatedCpuTimeMicros - approximate wall time the verification will spend in the KDF
estimatedMemoryBytes - approximate peak memory the KDF holds at once
public record ResourceEstimate(long estimatedCpuTimeMicros, long estimatedMemoryBytes) extends Record
Coarse resource estimate produced by a PasswordHashProvider for a given parameter set.

Phase-1a providers may return zeros; the type becomes meaningful with the Phase-1b memory-hard algorithms (Argon2id, scrypt) where the KDF execution limiter uses the estimate to enforce a process-wide resource budget (CWE-400).

  • Field Details

  • Constructor Details

    • ResourceEstimate

      public ResourceEstimate(long estimatedCpuTimeMicros, long estimatedMemoryBytes)
      Creates an instance of a ResourceEstimate record class.
      Parameters:
      estimatedCpuTimeMicros - the value for the estimatedCpuTimeMicros record component
      estimatedMemoryBytes - the value for the estimatedMemoryBytes record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • estimatedCpuTimeMicros

      public long estimatedCpuTimeMicros()
      Returns the value of the estimatedCpuTimeMicros record component.
      Returns:
      the value of the estimatedCpuTimeMicros record component

    • estimatedMemoryBytes

      public long estimatedMemoryBytes()
      Returns the value of the estimatedMemoryBytes record component.
      Returns:
      the value of the estimatedMemoryBytes record component