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

/*
 * Copyright (C) 2021 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;

/**
 * A {@code DigestSupplier} provides access to the result of a cryptographic digest algorithm, such as a
 * Message Digest, MAC, Signature, or Authentication Tag.
 *
 * @since 0.12.0
 */
public interface DigestSupplier {

    /**
     * Returns a cryptographic digest result, such as a Message Digest, MAC, Signature, or Authentication Tag
     * depending on the cryptographic algorithm that produced it.
     *
     * @return a cryptographic digest result, such as a Message Digest, MAC, Signature, or Authentication Tag
     * * depending on the cryptographic algorithm that produced it.
     */
    byte[] getDigest();

}