/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.nifi.web.security.saml2.registration;

import org.springframework.security.saml2.core.Saml2X509Credential;

import java.security.KeyStore;
import java.util.Collection;

/**
 * SAML2 Credentials Provider translates Certificate and Key entries to SAML2 X.509 Credentials
 */
public interface Saml2CredentialProvider {
    /**
     * Get SAML2 X.509 Credentials from Key Store entries
     *
     * @param keyStore Key Store containing credentials
     * @param keyPassword Optional key password for loading Private Keys
     * @return Collection of SAML2 Credentials
     */
    Collection<Saml2X509Credential> getCredentials(KeyStore keyStore, char[] keyPassword);
}
