io.jsonwebtoken.security.HashAlgorithm Maven / Gradle / Ivy

/*
 * Copyright © 2022 jsonwebtoken.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.jsonwebtoken.security;

import io.jsonwebtoken.Identifiable;

import java.io.InputStream;

/**
 * A {@link DigestAlgorithm} that computes and verifies digests without the use of a cryptographic key, such as for
 * thumbprints and digital fingerprints.
 *
 * Standard Identifier
 *
 * {@code HashAlgorithm} extends {@link Identifiable}: the value returned from
 * {@link Identifiable#getId() getId()} in all JWT standard hash algorithms will return one of the
 * "{@code Hash Name String}" values defined in the IANA
 * Named Information Hash
 * Algorithm Registry. This is to ensure the correct algorithm ID is used within other JWT-standard identifiers,
 * such as within JWK Thumbprint URIs.
 *
 * IANA Standard Implementations
 *
 * Constant definitions and utility methods for common (but not all)
 * IANA Hash
 * Algorithms are available via {@link Jwks.HASH}.
 *
 * @see Jwks.HASH
 * @since 0.12.0
 */
public interface HashAlgorithm extends DigestAlgorithm, VerifyDigestRequest> {
}