Record Class CredentialVerificationSucceeded

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.audit.CredentialVerificationSucceeded
Record Components:
timestamp - UTC creation time
username - username supplied by the attempt
clientAddress - remote client address, or null
algorithm - algorithm recorded in the verified envelope
providerId - provider id recorded in the verified envelope
policyVersion - policy version recorded in the verified envelope
pepperKeyIdPresent - true when the verified envelope had a pepper key id; the value itself is never recorded
rehashRequired - whether the rehash engine flagged this envelope for transparent upgrade
All Implemented Interfaces:
AuditEvent
public record CredentialVerificationSucceeded(Instant timestamp, String username, String clientAddress, String algorithm, String providerId, int policyVersion, boolean pepperKeyIdPresent, boolean rehashRequired) extends Record implements AuditEvent
Successful password verification, recorded by the credential audit publisher so audit sinks see the same outcome the LoginAttemptPolicy recorded.

The event carries only metadata that an operator can publicly observe (algorithm, provider id, policy version, pepper presence). Salt, derived key material and the pepper key value itself never appear here (CWE-209 / CWE-522).

  • Constructor Details

    • CredentialVerificationSucceeded

      public CredentialVerificationSucceeded(Instant timestamp, String username, String clientAddress, String algorithm, String providerId, int policyVersion, boolean pepperKeyIdPresent, boolean rehashRequired)
      Creates an instance of a CredentialVerificationSucceeded record class.
      Parameters:
      timestamp - the value for the timestamp record component
      username - the value for the username record component
      clientAddress - the value for the clientAddress record component
      algorithm - the value for the algorithm record component
      providerId - the value for the providerId record component
      policyVersion - the value for the policyVersion record component
      pepperKeyIdPresent - the value for the pepperKeyIdPresent record component
      rehashRequired - the value for the rehashRequired 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface AuditEvent
      Returns:
      the value of the timestamp record component

    • username

      public String username()
      Returns the value of the username record component.
      Returns:
      the value of the username record component

    • clientAddress

      public String clientAddress()
      Returns the value of the clientAddress record component.
      Returns:
      the value of the clientAddress record component

    • algorithm

      public String algorithm()
      Returns the value of the algorithm record component.
      Returns:
      the value of the algorithm record component

    • providerId

      public String providerId()
      Returns the value of the providerId record component.
      Returns:
      the value of the providerId record component

    • policyVersion

      public int policyVersion()
      Returns the value of the policyVersion record component.
      Returns:
      the value of the policyVersion record component

    • pepperKeyIdPresent

      public boolean pepperKeyIdPresent()
      Returns the value of the pepperKeyIdPresent record component.
      Returns:
      the value of the pepperKeyIdPresent record component

    • rehashRequired

      public boolean rehashRequired()
      Returns the value of the rehashRequired record component.
      Returns:
      the value of the rehashRequired record component