To add the provider at runtime use:

import java.security.Security;
import org.bouncycastle.jce.provider.BouncyCastleProvider;

Security.addProvider(new BouncyCastleProvider());

The provider can also be configured as part of your environment via static registration by adding an entry to the java.security properties file (found in $JAVA_HOME/jre/lib/security/java.security, where $JAVA_HOME is the location of your JDK/JRE distribution). You'll find detailed instructions in the file but basically it comes down to adding a line:


   security.provider.<n>=org.bouncycastle.jce.provider.BouncyCastleProvider

Where <n> is the preference you want the provider at (1 being the most preferred).

Note

JCE algorithm names should be upper-case only so the case insensitive test for getInstance works.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	BouncyCastleProvider.JcaCryptoService

Field Summary

Modifier and Type	Field and Description
private static final String[]	ASYMMETRIC_CIPHERS
private static final String[]	ASYMMETRIC_GENERIC
private static final String	ASYMMETRIC_PACKAGE
public static final ProviderConfiguration	CONFIGURATION
private static final String	DIGEST_PACKAGE
private static final String[]	DIGESTS
private static String	info Hides java.security.Provider.info.
private static final Map<K, V>	keyInfoConverters
private static final String	KEYSTORE_PACKAGE
private static final String[]	KEYSTORES
private static final Logger	LOG
public static final String	PROVIDER_NAME
private static final Class<T>	revChkClass
private static final String	SECURE_RANDOM_PACKAGE
private static final String[]	SECURE_RANDOMS
private Map<String, Provider.Service>	serviceMap Hides java.security.Provider.serviceMap.
private static final CryptoServiceProperties[]	SYMMETRIC_CIPHERS
private static final String[]	SYMMETRIC_GENERIC
private static final String[]	SYMMETRIC_MACS
private static final String	SYMMETRIC_PACKAGE

Constructor Summary

Access	Constructor and Description
public	BouncyCastleProvider() Construct a new provider.

Method Summary

Modifier and Type	Method and Description
public void	addAlgorithm(String key, String value) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.
public void	addAlgorithm(String key, String value, Map<String, String> attributes) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.
public void	addAlgorithm(String type, ASN1ObjectIdentifier oid, String className) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.
public void	addAlgorithm(String type, ASN1ObjectIdentifier oid, String className, Map<String, String> attributes) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.
public void	addAttributes(String key, Map<String, String> attributeMap) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAttributes.
public void	addKeyInfoConverter(ASN1ObjectIdentifier oid, AsymmetricKeyInfoConverter keyInfoConverter) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addKeyInfoConverter.
private static AsymmetricKeyInfoConverter	getAsymmetricKeyInfoConverter(ASN1ObjectIdentifier algorithm)
public AsymmetricKeyInfoConverter	getKeyInfoConverter(ASN1ObjectIdentifier oid) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.getKeyInfoConverter.
public static PrivateKey	getPrivateKey(PrivateKeyInfo privateKeyInfo)
public static PublicKey	getPublicKey(SubjectPublicKeyInfo publicKeyInfo)
public final Provider.Service	getService(final String the type of `service` requested (for example, `MessageDigest`) type, final String the case-insensitive algorithm name (or alternate alias) of the service requested (for example, `SHA-1`) algorithm) Overrides java.security.Provider.getService. Get the service describing this Provider's implementation of the specified type of this algorithm or alias.
public boolean	hasAlgorithm(String type, String name) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.hasAlgorithm.
private void	loadAlgorithms(String packageName, String[] names)
private void	loadAlgorithms(String packageName, CryptoServiceProperties[] services)
private void	loadPQCKeys()
private void	loadServiceClass(String packageName, String serviceName)
private static CryptoServiceProperties	service(String name, int bitsOfSecurity)
public void	setParameter(String parameterName, Object parameter) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.setParameter.
private void	setup()

Field Detail

ASYMMETRIC_CIPHERS	back to summary
private static final String[] ASYMMETRIC_CIPHERS

ASYMMETRIC_GENERIC	back to summary
private static final String[] ASYMMETRIC_GENERIC

ASYMMETRIC_PACKAGE	back to summary
private static final String ASYMMETRIC_PACKAGE

CONFIGURATION	back to summary
public static final ProviderConfiguration CONFIGURATION

DIGEST_PACKAGE	back to summary
private static final String DIGEST_PACKAGE

DIGESTS	back to summary
private static final String[] DIGESTS

info	back to summary
private static String info Hides java.security.Provider.info.

keyInfoConverters	back to summary
private static final Map<K, V> keyInfoConverters

KEYSTORE_PACKAGE	back to summary
private static final String KEYSTORE_PACKAGE

KEYSTORES	back to summary
private static final String[] KEYSTORES

LOG	back to summary
private static final Logger LOG

PROVIDER_NAME	back to summary
public static final String PROVIDER_NAME

revChkClass	back to summary
private static final Class<T> revChkClass

SECURE_RANDOM_PACKAGE	back to summary
private static final String SECURE_RANDOM_PACKAGE

SECURE_RANDOMS	back to summary
private static final String[] SECURE_RANDOMS

serviceMap	back to summary
private Map<String, Provider.Service> serviceMap Hides java.security.Provider.serviceMap.

SYMMETRIC_CIPHERS	back to summary
private static final CryptoServiceProperties[] SYMMETRIC_CIPHERS

SYMMETRIC_GENERIC	back to summary
private static final String[] SYMMETRIC_GENERIC

SYMMETRIC_MACS	back to summary
private static final String[] SYMMETRIC_MACS

SYMMETRIC_PACKAGE	back to summary
private static final String SYMMETRIC_PACKAGE

Constructor Detail

BouncyCastleProvider	back to summary
public BouncyCastleProvider() Construct a new provider. This should only be required when using runtime registration of the provider using the `Security.addProvider()` mechanism.

Method Detail

addAlgorithm	back to summary
public void addAlgorithm(String key, String value) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.

addAlgorithm	back to summary
public void addAlgorithm(String key, String value, Map<String, String> attributes) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.

addAlgorithm	back to summary
public void addAlgorithm(String type, ASN1ObjectIdentifier oid, String className) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.

addAlgorithm	back to summary
public void addAlgorithm(String type, ASN1ObjectIdentifier oid, String className, Map<String, String> attributes) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAlgorithm.

addAttributes	back to summary
public void addAttributes(String key, Map<String, String> attributeMap) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addAttributes.

addKeyInfoConverter	back to summary
public void addKeyInfoConverter(ASN1ObjectIdentifier oid, AsymmetricKeyInfoConverter keyInfoConverter) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.addKeyInfoConverter.

getAsymmetricKeyInfoConverter	back to summary
private static AsymmetricKeyInfoConverter getAsymmetricKeyInfoConverter(ASN1ObjectIdentifier algorithm)

getKeyInfoConverter	back to summary
public AsymmetricKeyInfoConverter getKeyInfoConverter(ASN1ObjectIdentifier oid) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.getKeyInfoConverter.

getPrivateKey	back to summary
public static PrivateKey getPrivateKey(PrivateKeyInfo privateKeyInfo) throws IOException

getPublicKey	back to summary
public static PublicKey getPublicKey(SubjectPublicKeyInfo publicKeyInfo) throws IOException

getService back to summary

getService	back to summary
public final Provider.Service getService(final String type, final String algorithm) Overrides java.security.Provider.getService. Doc from java.security.Provider.getService. Get the service describing this Provider's implementation of the specified type of this algorithm or alias. If no such implementation exists, this method returns `null`. If there are two matching services, one added to this provider using `putService()` and one added via `put()`, the service added via `putService()` is returned. Parameters type:String the type of `service` requested (for example, `MessageDigest`) algorithm:String the case-insensitive algorithm name (or alternate alias) of the service requested (for example, `SHA-1`) Returns:Provider.Service the service describing this Provider's matching service or `null` if no such service exists

public final Provider.Service getService(final String type, final String algorithm)

Overrides java.security.Provider.getService.

Doc from java.security.Provider.getService.

Get the service describing this Provider's implementation of the specified type of this algorithm or alias. If no such implementation exists, this method returns null. If there are two matching services, one added to this provider using putService() and one added via put(), the service added via putService() is returned.

Parameters

type:String: the type of service requested (for example, MessageDigest)
algorithm:String: the case-insensitive algorithm name (or alternate alias) of the service requested (for example, SHA-1)

Returns:Provider.Service

the service describing this Provider's matching service or null if no such service exists

hasAlgorithm	back to summary
public boolean hasAlgorithm(String type, String name) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.hasAlgorithm.

loadAlgorithms	back to summary
private void loadAlgorithms(String packageName, String[] names)

loadAlgorithms	back to summary
private void loadAlgorithms(String packageName, CryptoServiceProperties[] services)

loadPQCKeys	back to summary
private void loadPQCKeys()

loadServiceClass	back to summary
private void loadServiceClass(String packageName, String serviceName)

service	back to summary
private static CryptoServiceProperties service(String name, int bitsOfSecurity)

setParameter	back to summary
public void setParameter(String parameterName, Object parameter) Implements org.bouncycastle.jcajce.provider.config.ConfigurableProvider.setParameter.

setup	back to summary
private void setup()

org.bouncycastle.jce.provider back to summary

private Class BouncyCastleProvider.JcaCryptoService

Class Inheritance

extends Object
implements CryptoServiceProperties

java.lang.Object
org.bouncycastle.jce.provider.BouncyCastleProvider.JcaCryptoService

All Implemented Interfaces

org.bouncycastle.crypto.CryptoServiceProperties

Field Summary

Modifier and Type	Field and Description
private final int	bitsOfSecurity
private final String	name

Constructor Summary

Access	Constructor and Description
pack-priv	JcaCryptoService(String name, int bitsOfSecurity)

Method Summary

Modifier and Type	Method and Description
public int	bitsOfSecurity() Implements org.bouncycastle.crypto.CryptoServiceProperties.bitsOfSecurity.
public Object	getParams() Implements org.bouncycastle.crypto.CryptoServiceProperties.getParams.
public CryptoServicePurpose	getPurpose() Implements org.bouncycastle.crypto.CryptoServiceProperties.getPurpose.
public String	getServiceName() Implements org.bouncycastle.crypto.CryptoServiceProperties.getServiceName.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bitsOfSecurity	back to summary
private final int bitsOfSecurity

name	back to summary
private final String name

Constructor Detail

JcaCryptoService	back to summary
pack-priv JcaCryptoService(String name, int bitsOfSecurity)

Method Detail

bitsOfSecurity	back to summary
public int bitsOfSecurity() Implements org.bouncycastle.crypto.CryptoServiceProperties.bitsOfSecurity.

getParams	back to summary
public Object getParams() Implements org.bouncycastle.crypto.CryptoServiceProperties.getParams.

getPurpose	back to summary
public CryptoServicePurpose getPurpose() Implements org.bouncycastle.crypto.CryptoServiceProperties.getPurpose.

getServiceName	back to summary
public String getServiceName() Implements org.bouncycastle.crypto.CryptoServiceProperties.getServiceName.

public final Class BouncyCastleProvider

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BouncyCastleProvider.JcaCryptoService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail