com.yahoo.security.token.TokenFingerprint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of security-utils Show documentation
There is a newer version: 8.411.13
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.security.token;

import java.util.Arrays;
import java.util.HexFormat;

import static com.yahoo.security.ArrayUtils.hex;
import static com.yahoo.security.ArrayUtils.toUtf8Bytes;

/**
 * A token fingerprint represents an opaque sequence of bytes that is expected
 * to globally identify any particular token within a particular token domain.
 * 

 * Token fingerprints should not be used directly for access checks; use derived
 * {@link TokenCheckHash} instances for this purpose.
 * 

 * Fingerprints are printed in the common hex:hex:hex:... format, e.g.
 * 53:2e:4e:09:d5:4f:96:f4:1a:44:82:ef:f0:44:b9:a2
 * 
 */
public record TokenFingerprint(byte[] hashBytes) {

    public static final int FINGERPRINT_BITS  = 128;
    public static final int FINGERPRINT_BYTES = FINGERPRINT_BITS / 8;
    public static final byte[] FINGERPRINT_CONTEXT = toUtf8Bytes("Vespa token fingerprint");

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        TokenFingerprint that = (TokenFingerprint) o;
        // We don't consider token fingerprints secret data, so no harm in data-dependent equals()
        return Arrays.equals(hashBytes, that.hashBytes);
    }

    @Override
    public int hashCode() {
        return Arrays.hashCode(hashBytes);
    }

    public String toHexString() {
        return hex(hashBytes);
    }

    public String toDelimitedHexString() {
        return HexFormat.ofDelimiter(":").formatHex(hashBytes);
    }

    @Override
    public String toString() {
        return toDelimitedHexString();
    }

    public static TokenFingerprint of(Token token) {
        return new TokenFingerprint(token.toDerivedBytes(FINGERPRINT_BYTES, FINGERPRINT_CONTEXT));
    }

    public static TokenFingerprint ofRawBytes(byte[] hashBytes) {
        return new TokenFingerprint(Arrays.copyOf(hashBytes, hashBytes.length));
    }

    public static TokenFingerprint ofHex(String hex) {
        var format = hex.contains(":") ? HexFormat.ofDelimiter(":") : HexFormat.of();
        return ofRawBytes(format.parseHex(hex));
    }

}