com.google.crypto.tink.subtle

Class EngineFactory<T_WRAPPER extends EngineWrapper<T_ENGINE>,T_ENGINE>

java.lang.Object

com.google.crypto.tink.subtle.EngineFactory<T_WRAPPER,T_ENGINE>

public final class EngineFactory<T_WRAPPER extends EngineWrapper<T_ENGINE>,T_ENGINE>
extends Object

A factory that returns JCE engines, using pre-specified j.security.Providers.

This class contains a lot of static factories and static functions returning factories: these allow customization and hide the typing complexity in this class. To use this class, import it, and replace your Cipher.getInstance(...) with EngineFactory.CIPHER.getInstance(...).

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static EngineFactory<EngineWrapper.TCipher,Cipher>	CIPHER
static EngineFactory<EngineWrapper.TKeyAgreement,KeyAgreement>	KEY_AGREEMENT
static EngineFactory<EngineWrapper.TKeyFactory,KeyFactory>	KEY_FACTORY
static EngineFactory<EngineWrapper.TKeyPairGenerator,KeyPairGenerator>	KEY_PAIR_GENERATOR
static EngineFactory<EngineWrapper.TMac,Mac>	MAC
static EngineFactory<EngineWrapper.TMessageDigest,MessageDigest>	MESSAGE_DIGEST
static EngineFactory<EngineWrapper.TSignature,Signature>	SIGNATURE

Constructor Summary

Constructors

Constructor and Description
EngineFactory(T_WRAPPER instanceBuilder)
EngineFactory(T_WRAPPER instanceBuilder, List<Provider> policy)
EngineFactory(T_WRAPPER instanceBuilder, List<Provider> policy, boolean letFallback)

Method Summary

Modifier and Type	Method and Description
static EngineFactory<EngineWrapper.TCipher,Cipher>	getCustomCipherProvider(boolean letFallbackToDefault, String... providerNames)
static EngineFactory<EngineWrapper.TKeyAgreement,KeyAgreement>	getCustomKeyAgreementProvider(boolean letFallbackToDefault, String... providerNames)
static EngineFactory<EngineWrapper.TKeyFactory,KeyFactory>	getCustomKeyFactoryProvider(boolean letFallbackToDefault, String... providerNames)
static EngineFactory<EngineWrapper.TKeyPairGenerator,KeyPairGenerator>	getCustomKeyPairGeneratorProvider(boolean letFallbackToDefault, String... providerNames)
static EngineFactory<EngineWrapper.TMac,Mac>	getCustomMacProvider(boolean letFallbackToDefault, String... providerNames)
static EngineFactory<EngineWrapper.TMessageDigest,MessageDigest>	getCustomMessageDigestProvider(boolean letFallbackToDefault, String... providerNames)
static EngineFactory<EngineWrapper.TSignature,Signature>	getCustomSignatureProvider(boolean letFallbackToDefault, String... providerNames)
T_ENGINE	getInstance(String algorithm)
static List<Provider>	toProviderList(String... providerNames) Helper function to get a list of Providers from names.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CIPHER

public static final EngineFactory<EngineWrapper.TCipher,Cipher> CIPHER

MAC

public static final EngineFactory<EngineWrapper.TMac,Mac> MAC

SIGNATURE

public static final EngineFactory<EngineWrapper.TSignature,Signature> SIGNATURE

MESSAGE_DIGEST

public static final EngineFactory<EngineWrapper.TMessageDigest,MessageDigest> MESSAGE_DIGEST

KEY_AGREEMENT

public static final EngineFactory<EngineWrapper.TKeyAgreement,KeyAgreement> KEY_AGREEMENT

KEY_PAIR_GENERATOR

public static final EngineFactory<EngineWrapper.TKeyPairGenerator,KeyPairGenerator> KEY_PAIR_GENERATOR

KEY_FACTORY

public static final EngineFactory<EngineWrapper.TKeyFactory,KeyFactory> KEY_FACTORY

Constructor Detail

EngineFactory

public EngineFactory(T_WRAPPER instanceBuilder)

EngineFactory

public EngineFactory(T_WRAPPER instanceBuilder,
                     List<Provider> policy)

EngineFactory

public EngineFactory(T_WRAPPER instanceBuilder,
                     List<Provider> policy,
                     boolean letFallback)

Method Detail

getCustomCipherProvider

public static final EngineFactory<EngineWrapper.TCipher,Cipher> getCustomCipherProvider(boolean letFallbackToDefault,
                                                                                        String... providerNames)

getCustomMacProvider

public static final EngineFactory<EngineWrapper.TMac,Mac> getCustomMacProvider(boolean letFallbackToDefault,
                                                                               String... providerNames)

getCustomSignatureProvider

public static final EngineFactory<EngineWrapper.TSignature,Signature> getCustomSignatureProvider(boolean letFallbackToDefault,
                                                                                                 String... providerNames)

getCustomMessageDigestProvider

public static final EngineFactory<EngineWrapper.TMessageDigest,MessageDigest> getCustomMessageDigestProvider(boolean letFallbackToDefault,
                                                                                                             String... providerNames)

getCustomKeyAgreementProvider

public static final EngineFactory<EngineWrapper.TKeyAgreement,KeyAgreement> getCustomKeyAgreementProvider(boolean letFallbackToDefault,
                                                                                                          String... providerNames)

getCustomKeyPairGeneratorProvider

public static final EngineFactory<EngineWrapper.TKeyPairGenerator,KeyPairGenerator> getCustomKeyPairGeneratorProvider(boolean letFallbackToDefault,
                                                                                                                      String... providerNames)

getCustomKeyFactoryProvider

public static final EngineFactory<EngineWrapper.TKeyFactory,KeyFactory> getCustomKeyFactoryProvider(boolean letFallbackToDefault,
                                                                                                    String... providerNames)

toProviderList

public static List<Provider> toProviderList(String... providerNames)

Helper function to get a list of Providers from names.

getInstance

public T_ENGINE getInstance(String algorithm)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException