/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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 org.keycloak.crypto;

import org.keycloak.common.VerificationException;
import org.keycloak.provider.Provider;

public interface SignatureProvider extends Provider {

    static void checkKeyForSignature(KeyWrapper key, String algorithm, String type) throws SignatureException {
        if (!type.equals(key.getType()) || !algorithm.equals(key.getAlgorithmOrDefault())) {
            throw new SignatureException(String.format("Key with algorithm %s and type %s is incorrect for provider algorithm %s",
                    key.getAlgorithm(), key.getType(), algorithm));
        }
    }

    static void checkKeyForVerification(KeyWrapper key, String algorithm, String type) throws VerificationException {
        if (!type.equals(key.getType()) || !algorithm.equals(key.getAlgorithmOrDefault())) {
            throw new VerificationException(String.format("Key with algorithm %s and type %s is incorrect for provider algorithm %s",
                    key.getAlgorithm(), key.getType(), algorithm));
        }
    }

    SignatureSignerContext signer() throws SignatureException;

    SignatureSignerContext signer(KeyWrapper key) throws SignatureException;

    SignatureVerifierContext verifier(String kid) throws VerificationException;

    SignatureVerifierContext verifier(KeyWrapper key) throws VerificationException;

    boolean isAsymmetricAlgorithm();

    @Override
    default void close() {
    }

}