com.maverick.ssh.components.jce

Class JCEComponentManager

java.lang.Object

com.maverick.ssh.components.ComponentManager

com.maverick.ssh.components.jce.JCEComponentManager

All Implemented Interfaces:

JCEAlgorithms

public class JCEComponentManager
extends ComponentManager
implements JCEAlgorithms

A component manager for the Java runtime JCE provider. By default all algorithms will be selected from the default provider i.e no provider is specified in calls to JCE methods to create components. You can initialize a default provider to be used on all calls with the following code:

 JCEComponentManager.initializeDefaultProvider(new BouncyCastleProvider());
 

Alternatively you can also assign a specific provider for an individual algorithm, all algorithms used by the API are included as static constants in this class.

 JCEComponentManager.initializeProviderForAlgorithm(JCEComponentManager.JCE_DSA, new BouncyCastleProvider());
 

Author:

Lee David Painter

Field Summary

Fields inherited from interface com.maverick.ssh.components.jce.JCEAlgorithms

CHACHA20, CHACHA20_POLY1305, ED25519, ED448, EdDSA, JCE_3DESCBCNOPADDING, JCE_3DESCTRNOPADDING, JCE_AESCBCNOPADDING, JCE_AESCTRNOPADDING, JCE_AESGCMNOPADDING, JCE_ARCFOUR, JCE_BLOWFISHCBCNOPADDING, JCE_DESCBCNOPADDING, JCE_DH, JCE_DH_KEY_AGREEMENT, JCE_DH_KEY_FACTORY, JCE_DH_KEY_GENERATOR, JCE_DSA, JCE_ECDH, JCE_HMACMD5, JCE_HMACRIPEMD160, JCE_HMACSHA1, JCE_HMACSHA256, JCE_HMACSHA512, JCE_MD5, JCE_MD5WithRSA, JCE_RSA, JCE_RSA_CIPHER, JCE_RSANONEPKCS1PADDING, JCE_SHA1, JCE_SHA1PRNG, JCE_SHA1WithDSA, JCE_SHA1WithECDSA, JCE_SHA1WithRSA, JCE_SHA256, JCE_SHA256WithECDSA, JCE_SHA256WithRSA, JCE_SHA384, JCE_SHA384WithECDSA, JCE_SHA512, JCE_SHA512WithECDSA, JCE_SHA512WithRSA, JCE_X509

Constructor Summary

Constructors

Constructor and Description
JCEComponentManager()

Method Summary

Modifier and Type	Method and Description
SshDsaPrivateKey	createDsaPrivateKey(BigInteger p, BigInteger q, BigInteger g, BigInteger x, BigInteger y) Create an instance of a DSA private key.
SshDsaPublicKey	createDsaPublicKey() Create an uninitialized instance of a DSA public key
SshDsaPublicKey	createDsaPublicKey(BigInteger p, BigInteger q, BigInteger g, BigInteger y) Create an instance of a DSA public key.
SshRsaPrivateCrtKey	createRsaPrivateCrtKey(BigInteger modulus, BigInteger publicExponent, BigInteger privateExponent, BigInteger primeP, BigInteger primeQ, BigInteger crtCoefficient) Create an instance of an RSA co-effecient private key.
SshRsaPrivateCrtKey	createRsaPrivateCrtKey(BigInteger modulus, BigInteger publicExponent, BigInteger privateExponent, BigInteger primeP, BigInteger primeQ, BigInteger primeExponentP, BigInteger primeExponentQ, BigInteger crtCoefficient) Create an instance of an RSA co-efficent private key.
SshRsaPrivateKey	createRsaPrivateKey(BigInteger modulus, BigInteger privateExponent) Create an instance of an RSA private key.
SshRsaPublicKey	createRsaPublicKey(BigInteger modulus, BigInteger publicExponent, int version) Create an instance of an RSA public key.
SshRsaPublicKey	createSsh2RsaPublicKey() Create an instance of an SSH2 RSA public key.
static void	disableClientKex()
static void	disableServerKex()
static void	disableStartupTests()
SshKeyPair	generateDsaKeyPair(int bits) Generate a new DSA public/private key pair.
SshKeyPair	generateEcdsaKeyPair(int bits) Generate a new ECDSA key pair.
SshKeyPair	generateEd25519KeyPair()
SshKeyPair	generateEd448KeyPair()
SshKeyPair	generateRsaKeyPair(int bits, int version) Generate an RSA public/private pair.
static Provider	getProviderForAlgorithm(String jceAlgorithm) Get the provider for a specific algorithm.
SshSecureRandomGenerator	getRND() Get the secure random number generator.
static SecureRandom	getSecureRandom() Get the secure random implementation for the API.
static String	getSecureRandomAlgorithm() Get the algorithm used for secure random number generation.
static void	initializeDefaultProvider(Provider provider) Initialize the default JCE provider used by the API.
protected void	initializeDigestFactory(ComponentFactory<Digest> digests) Initialize the digest factory.
protected void	initializeHmacFactory(ComponentFactory<SshHmac> hmacs) Initialize the SSH2 HMAC factory.
protected void	initializeKeyExchangeFactory(ComponentFactory<SshKeyExchange> clientKeyexchanges, ComponentFactory<SshKeyExchange> serverKeyexchanges) Initialize the SSH2 key exchange factory.
static void	initializeProviderForAlgorithm(String jceAlgorithm, Provider provider) Initialize a provider for a specific algorithm.
protected void	initializePublicKeyFactory(ComponentFactory<SshPublicKey> publickeys) Initialize the public key factory.
protected void	initializeSsh1CipherFactory(ComponentFactory<SshCipher> ciphers) Initialize the SSH1 cipher factory.
protected void	initializeSsh2CipherFactory(ComponentFactory<SshCipher> ciphers) Initialize the SSH2 cipher factory.
SshKeyPair[]	loadKeystore(File keystoreFile, String alias, String storePassphrase, String keyPassphrase) Load a host key from a keystore file.
SshKeyPair[]	loadKeystore(File keystoreFile, String alias, String storePassphrase, String keyPassphrase, String storeType)
SshKeyPair[]	loadKeystore(InputStream in, String alias, String storePassphrase, String keyPassphrase) Load a keystore for use as an SSH host key.
SshKeyPair[]	loadKeystore(InputStream in, String alias, String storePassphrase, String keyPassphrase, String storeType) Load a keystore for use as an SSH host key.
static void	setSecureRandomAlgorithm(String secureRandomAlgorithm) Set the algorithm used for secure random number generation.

Methods inherited from class com.maverick.ssh.components.ComponentManager

disableAlgorithm, enableAlgorithm, getInstance, getPerContextAlgorithmPreferences, getSecurityLevel, init, isDisabled, isEnableNoneCipher, isEnableNoneMac, reset, setEnableNoneCipher, setEnableNoneMac, setInstance, setMinimumSecurityLevel, setMinimumSecurityLevel, setPerContextAlgorithmPreferences, supportedDigests, supportedDigests, supportedHMacsCS, supportedHMacsCS, supportedHMacsSC, supportedHMacsSC, supportedKeyExchanges, supportedKeyExchanges, supportedPublicKeys, supportedPublicKeys, supportedSsh1CiphersCS, supportedSsh1CiphersCS, supportedSsh1CiphersSC, supportedSsh1CiphersSC, supportedSsh2CiphersCS, supportedSsh2CiphersCS, supportedSsh2CiphersSC, supportedSsh2CiphersSC

Methods inherited from class java.lang.Object

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

Constructor Detail

JCEComponentManager

public JCEComponentManager()

Method Detail

disableStartupTests

public static void disableStartupTests()

disableServerKex

public static void disableServerKex()

disableClientKex

public static void disableClientKex()

initializeDefaultProvider

public static void initializeDefaultProvider(Provider provider)

Initialize the default JCE provider used by the API.

Parameters:

provider -

initializeProviderForAlgorithm

public static void initializeProviderForAlgorithm(String jceAlgorithm,
                                                  Provider provider)

Initialize a provider for a specific algorithm.

Parameters:

jceAlgorithm -

provider -

getSecureRandomAlgorithm

public static String getSecureRandomAlgorithm()

Get the algorithm used for secure random number generation.

Returns:

String

setSecureRandomAlgorithm

public static void setSecureRandomAlgorithm(String secureRandomAlgorithm)

Set the algorithm used for secure random number generation.

Parameters:

secureRandomAlgorithm -

getProviderForAlgorithm

public static Provider getProviderForAlgorithm(String jceAlgorithm)

Get the provider for a specific algorithm.

Parameters:

jceAlgorithm -

Returns:

Provider

getSecureRandom

public static SecureRandom getSecureRandom()

Get the secure random implementation for the API.

Returns:

SecureRandom

Throws:

NoSuchAlgorithmException

createDsaPrivateKey

public SshDsaPrivateKey createDsaPrivateKey(BigInteger p,
                                            BigInteger q,
                                            BigInteger g,
                                            BigInteger x,
                                            BigInteger y)
                                     throws SshException

Description copied from class: ComponentManager

Create an instance of a DSA private key.

Specified by:

createDsaPrivateKey in class ComponentManager

Returns:

SshDsaPrivateKey

Throws:

SshException

createDsaPublicKey

public SshDsaPublicKey createDsaPublicKey(BigInteger p,
                                          BigInteger q,
                                          BigInteger g,
                                          BigInteger y)
                                   throws SshException

Description copied from class: ComponentManager

Create an instance of a DSA public key.

Specified by:

createDsaPublicKey in class ComponentManager

Returns:

SshDsaPublicKey

Throws:

SshException

createDsaPublicKey

public SshDsaPublicKey createDsaPublicKey()

Description copied from class: ComponentManager

Create an uninitialized instance of a DSA public key

Specified by:

createDsaPublicKey in class ComponentManager

Returns:

SshDsaPublicKey

createRsaPrivateCrtKey

public SshRsaPrivateCrtKey createRsaPrivateCrtKey(BigInteger modulus,
                                                  BigInteger publicExponent,
                                                  BigInteger privateExponent,
                                                  BigInteger primeP,
                                                  BigInteger primeQ,
                                                  BigInteger crtCoefficient)
                                           throws SshException

Description copied from class: ComponentManager

Create an instance of an RSA co-effecient private key.

Specified by:

createRsaPrivateCrtKey in class ComponentManager

Returns:

SshRsaPrivateCrtKey

Throws:

SshException

createRsaPrivateCrtKey

public SshRsaPrivateCrtKey createRsaPrivateCrtKey(BigInteger modulus,
                                                  BigInteger publicExponent,
                                                  BigInteger privateExponent,
                                                  BigInteger primeP,
                                                  BigInteger primeQ,
                                                  BigInteger primeExponentP,
                                                  BigInteger primeExponentQ,
                                                  BigInteger crtCoefficient)
                                           throws SshException

Description copied from class: ComponentManager

Create an instance of an RSA co-efficent private key.

Specified by:

createRsaPrivateCrtKey in class ComponentManager

Returns:

SshRsaPrivateCrtKey

Throws:

SshException

createRsaPrivateKey

public SshRsaPrivateKey createRsaPrivateKey(BigInteger modulus,
                                            BigInteger privateExponent)
                                     throws SshException

Description copied from class: ComponentManager

Create an instance of an RSA private key.

Specified by:

createRsaPrivateKey in class ComponentManager

Returns:

SshRsaPrivateKey

Throws:

SshException

createRsaPublicKey

public SshRsaPublicKey createRsaPublicKey(BigInteger modulus,
                                          BigInteger publicExponent,
                                          int version)
                                   throws SshException

Description copied from class: ComponentManager

Create an instance of an RSA public key.

Specified by:

createRsaPublicKey in class ComponentManager

Returns:

SshRsaPublicKey

Throws:

SshException

createSsh2RsaPublicKey

public SshRsaPublicKey createSsh2RsaPublicKey()
                                       throws SshException

Description copied from class: ComponentManager

Create an instance of an SSH2 RSA public key.

Specified by:

createSsh2RsaPublicKey in class ComponentManager

Returns:

SshRsaPublicKey

Throws:

SshException

generateDsaKeyPair

public SshKeyPair generateDsaKeyPair(int bits)
                              throws SshException

Description copied from class: ComponentManager

Generate a new DSA public/private key pair.

Specified by:

generateDsaKeyPair in class ComponentManager

Returns:

SshKeyPair

Throws:

SshException

generateRsaKeyPair

public SshKeyPair generateRsaKeyPair(int bits,
                                     int version)
                              throws SshException

Description copied from class: ComponentManager

Generate an RSA public/private pair.

Specified by:

generateRsaKeyPair in class ComponentManager

Returns:

SshKeyPair

Throws:

SshException

generateEcdsaKeyPair

public SshKeyPair generateEcdsaKeyPair(int bits)
                                throws SshException

Description copied from class: ComponentManager

Generate a new ECDSA key pair.

Specified by:

generateEcdsaKeyPair in class ComponentManager

Returns:

Throws:

SshException

getRND

public SshSecureRandomGenerator getRND()
                                throws SshException

Description copied from class: ComponentManager

Get the secure random number generator.

Specified by:

getRND in class ComponentManager

Returns:

SshSecureRandomGenerator

Throws:

SshException

initializeDigestFactory

protected void initializeDigestFactory(ComponentFactory<Digest> digests)

Description copied from class: ComponentManager

Initialize the digest factory.

Specified by:

initializeDigestFactory in class ComponentManager

initializeHmacFactory

protected void initializeHmacFactory(ComponentFactory<SshHmac> hmacs)

Description copied from class: ComponentManager

Initialize the SSH2 HMAC factory.

Specified by:

initializeHmacFactory in class ComponentManager

initializeKeyExchangeFactory

protected void initializeKeyExchangeFactory(ComponentFactory<SshKeyExchange> clientKeyexchanges,
                                            ComponentFactory<SshKeyExchange> serverKeyexchanges)

Description copied from class: ComponentManager

Initialize the SSH2 key exchange factory.

Specified by:

initializeKeyExchangeFactory in class ComponentManager

initializePublicKeyFactory

protected void initializePublicKeyFactory(ComponentFactory<SshPublicKey> publickeys)

Description copied from class: ComponentManager

Initialize the public key factory.

Specified by:

initializePublicKeyFactory in class ComponentManager

initializeSsh1CipherFactory

protected void initializeSsh1CipherFactory(ComponentFactory<SshCipher> ciphers)

Description copied from class: ComponentManager

Initialize the SSH1 cipher factory. These ciphers are exclusively used by the SSH1 implementation.

Specified by:

initializeSsh1CipherFactory in class ComponentManager

initializeSsh2CipherFactory

protected void initializeSsh2CipherFactory(ComponentFactory<SshCipher> ciphers)

Description copied from class: ComponentManager

Initialize the SSH2 cipher factory. These ciphers are exclusively used by the SSH2 implementation.

Specified by:

initializeSsh2CipherFactory in class ComponentManager

loadKeystore

public SshKeyPair[] loadKeystore(InputStream in,
                                 String alias,
                                 String storePassphrase,
                                 String keyPassphrase)
                          throws IOException

Load a keystore for use as an SSH host key. This will create a public key using the X509V3_SIGN_RSA and X509V3_SIGN_RSA_SHA1 host key types. DSA keys are currently not supported.

Specified by:

loadKeystore in class ComponentManager

Parameters:

keystoreFile - path to the keystore file

alias - the alias of the key in the keystore

storePassphrase - the passphrase of the keystore

keyPassphrase - the passphrase of the key

Throws:

IOException

loadKeystore

public SshKeyPair[] loadKeystore(InputStream in,
                                 String alias,
                                 String storePassphrase,
                                 String keyPassphrase,
                                 String storeType)
                          throws IOException

Load a keystore for use as an SSH host key. This will create a public key using the X509V3_SIGN_RSA and X509V3_SIGN_RSA_SHA1 host key types. DSA keys are currently not supported.

Specified by:

loadKeystore in class ComponentManager

Parameters:

keystoreFile - path to the keystore file

alias - the alias of the key in the keystore

storePassphrase - the passphrase of the keystore

keyPassphrase - the passphrase of the key

Throws:

IOException

loadKeystore

public SshKeyPair[] loadKeystore(File keystoreFile,
                                 String alias,
                                 String storePassphrase,
                                 String keyPassphrase)
                          throws IOException

Description copied from class: ComponentManager

Load a host key from a keystore file.

Specified by:

loadKeystore in class ComponentManager

Throws:

IOException

loadKeystore

public SshKeyPair[] loadKeystore(File keystoreFile,
                                 String alias,
                                 String storePassphrase,
                                 String keyPassphrase,
                                 String storeType)
                          throws IOException

Specified by:

loadKeystore in class ComponentManager

Throws:

IOException

generateEd25519KeyPair

public SshKeyPair generateEd25519KeyPair()
                                  throws SshException

Specified by:

generateEd25519KeyPair in class ComponentManager

Throws:

SshException

generateEd448KeyPair

public SshKeyPair generateEd448KeyPair()
                                throws SshException

Specified by:

generateEd448KeyPair in class ComponentManager

Throws:

SshException