org.hyperledger.fabric.sdk.security.CryptoSuiteFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fabric-sdk-java Show documentation
Java SDK for Hyperledger fabric project
There is a newer version: 2.2.26
/*
 *
 *  Copyright 2016,2017 DTCC, Fujitsu Australia Software Technology, IBM - All Rights Reserved.
 *
 *  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.hyperledger.fabric.sdk.security;

import java.lang.reflect.InvocationTargetException;
import java.util.Properties;

import org.hyperledger.fabric.sdk.exception.CryptoException;
import org.hyperledger.fabric.sdk.exception.InvalidArgumentException;
import org.hyperledger.fabric.sdk.helper.Config;

/**
 * Factory to produce a set of crypto suite implementations offering differing cryptographic algorithms and strengths.
 */

public interface CryptoSuiteFactory {

    /**
     * If set as the default security provider then default crypto suite will not use explicit
     * provider
     */

    String DEFAULT_JDK_PROVIDER = "org.hyperledger.fabric.sdk.security.default_jdk_provider";

    /**
     * Produce a crypto suite by specified by these properties.
     * Properties are unique to each Crypto Suite implementation.
     *
     * @param properties
     * @return
     * @throws CryptoException
     * @throws InvalidArgumentException
     */

    CryptoSuite getCryptoSuite(Properties properties) throws CryptoException, InvalidArgumentException;

    /**
     * Return a default crypto suite
     * @return
     * @throws CryptoException
     * @throws InvalidArgumentException
     */

    CryptoSuite getCryptoSuite() throws CryptoException, InvalidArgumentException;

    /**
     * This will return the default Crypto Suite Factory implementation.
     * Can be overwritten by org.hyperledger.fabric.sdk.crypto.default_crypto_suite_factory property.
     * see {@link Config#getDefaultCryptoSuiteFactory()}
     * Classes specified by this property must implement a public static method instance that
     * returns back a single instance of this factory.
     *
     * @return A single instance of a CryptoSuiteFactory.
     * @throws ClassNotFoundException
     * @throws IllegalAccessException
     * @throws InstantiationException
     * @throws NoSuchMethodException
     * @throws InvocationTargetException
     */

    static CryptoSuiteFactory getDefault() throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException {

        return HLSDKJCryptoSuiteFactory.getDefault();

    }

}