Package com.yahoo.security.token

Record Class TokenDomain

java.lang.Object
java.lang.Record
com.yahoo.security.token.TokenDomain
public record TokenDomain(byte[] checkHashContext) extends Record

A token domain controls how token fingerprints and check-hashes are derived from a particular token. Even with identical token contents, different domain contexts are expected to produce entirely different derivations (with an extremely high probability).

Since tokens are just opaque sequences of high entropy bytes (with an arbitrary prefix), they do not by themselves provide any kind of inherent domain separation. Token domains exist to allow for explicit domain separation between different usages of tokens.

Fingerprint contexts will usually be the same across an entire deployment of a token evaluation infrastructure, in order to allow for identifying tokens "globally" across that deployment.

Access check hash contexts should be unique for each logical token evaluation audience, ensuring that access hashes from an unrelated audience (with a different context) can never be made to match, be it accidentally or deliberately.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TokenDomain(byte[] checkHashContext)
    Creates an instance of a TokenDomain record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    checkHashContext()
    Returns the value of the checkHashContext record component.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    static TokenDomain
    of(String checkHashContext)
     
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TokenDomain

      public TokenDomain(byte[] checkHashContext)
      Creates an instance of a TokenDomain record class.
      Parameters:
      checkHashContext - the value for the checkHashContext record component

  • Method Details

    • equals

      public 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 Objects::equals(Object,Object).
      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.

    • hashCode

      public 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

    • toString

      public 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

    • of

      public static TokenDomain of(String checkHashContext)

    • checkHashContext

      public byte[] checkHashContext()
      Returns the value of the checkHashContext record component.
      Returns:
      the value of the checkHashContext record component