com.maverick.ssh.components

Class ComponentManager

java.lang.Object

com.maverick.ssh.components.ComponentManager

Direct Known Subclasses:

JCEComponentManager

public abstract class ComponentManager
extends Object

An abstract class that manages the components used by the SSH API. All algorithm implementations are obtained through a single provider. One concrete implementation is provided, the JCEComponentManager that uses the Java runtime JCE provider(s) algorithm implementations.

Author:

Lee David Painter

Constructor Summary

Constructors

Constructor and Description
ComponentManager()

Method Summary

Modifier and Type	Method and Description
abstract SshDsaPrivateKey	createDsaPrivateKey(BigInteger p, BigInteger q, BigInteger g, BigInteger x, BigInteger y) Create an instance of a DSA private key.
abstract SshDsaPublicKey	createDsaPublicKey() Create an uninitialized instance of a DSA public key
abstract SshDsaPublicKey	createDsaPublicKey(BigInteger p, BigInteger q, BigInteger g, BigInteger y) Create an instance of a DSA public key.
abstract SshRsaPrivateCrtKey	createRsaPrivateCrtKey(BigInteger modulus, BigInteger publicExponent, BigInteger privateExponent, BigInteger primeP, BigInteger primeQ, BigInteger crtCoefficient) Create an instance of an RSA co-effecient private key.
abstract 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.
abstract SshRsaPrivateKey	createRsaPrivateKey(BigInteger modulus, BigInteger privateExponent) Create an instance of an RSA private key.
abstract SshRsaPublicKey	createRsaPublicKey(BigInteger modulus, BigInteger publicExponent, int version) Create an instance of an RSA public key.
abstract SshRsaPublicKey	createSsh2RsaPublicKey() Create an instance of an SSH2 RSA public key.
void	disableAlgorithm(String algorithm)
void	enableAlgorithm(String algorithm)
abstract SshKeyPair	generateDsaKeyPair(int bits) Generate a new DSA public/private key pair.
abstract SshKeyPair	generateEcdsaKeyPair(int bits) Generate a new ECDSA key pair.
abstract SshKeyPair	generateEd25519KeyPair()
abstract SshKeyPair	generateEd448KeyPair()
abstract SshKeyPair	generateRsaKeyPair(int bits, int version) Generate an RSA public/private pair.
static ComponentManager	getInstance() Get the installed component manager.
static boolean	getPerContextAlgorithmPreferences()
abstract SshSecureRandomGenerator	getRND() Get the secure random number generator.
SecurityLevel	getSecurityLevel()
protected void	init()
protected abstract void	initializeDigestFactory(ComponentFactory<Digest> digests) Initialize the digest factory.
protected abstract void	initializeHmacFactory(ComponentFactory<SshHmac> hmacs) Initialize the SSH2 HMAC factory.
protected abstract void	initializeKeyExchangeFactory(ComponentFactory<SshKeyExchange> clientKeyexchanges, ComponentFactory<SshKeyExchange> serverKeyexchanges) Initialize the SSH2 key exchange factory.
protected abstract void	initializePublicKeyFactory(ComponentFactory<SshPublicKey> publickeys) Initialize the public key factory.
protected abstract void	initializeSsh1CipherFactory(ComponentFactory<SshCipher> ciphers) Initialize the SSH1 cipher factory.
protected abstract void	initializeSsh2CipherFactory(ComponentFactory<SshCipher> ciphers) Initialize the SSH2 cipher factory.
boolean	isDisabled(String algorithm)
static boolean	isEnableNoneCipher()
static boolean	isEnableNoneMac()
abstract SshKeyPair[]	loadKeystore(File keystoreFile, String alias, String storePassphrase, String keyPassphrase) Load a host key from a keystore file.
abstract SshKeyPair[]	loadKeystore(File keystoreFile, String alias, String storePassphrase, String keyPassphrase, String storeType)
abstract SshKeyPair[]	loadKeystore(InputStream in, String alias, String storePassphrase, String keyPassphrase) Load a host key from a keystore InputStream.
abstract SshKeyPair[]	loadKeystore(InputStream in, String alias, String storePassphrase, String keyPassphrase, String storeType)
static void	reset()
static void	setEnableNoneCipher(boolean enableNoneCipher)
static void	setEnableNoneMac(boolean enableNoneCipher)
static void	setInstance(ComponentManager instance) Overide the installed component manager with an alternative implementation.
void	setMinimumSecurityLevel(SecurityLevel securityLevel)
void	setMinimumSecurityLevel(SecurityLevel securityLevel, boolean managedSecurity)
static void	setPerContextAlgorithmPreferences(boolean enable) Deprecated. All contexts now have a copy of the algorithm preferences and require separate configuration. Disabling this feature will cause problems especially in the case where client and server use the same JVM.
ComponentFactory<Digest>	supportedDigests() Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<Digest>	supportedDigests(boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshHmac>	supportedHMacsCS() Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshHmac>	supportedHMacsCS(boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshHmac>	supportedHMacsSC() Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshHmac>	supportedHMacsSC(boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshKeyExchange>	supportedKeyExchanges(boolean serverMode) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshKeyExchange>	supportedKeyExchanges(boolean serverMode, boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshPublicKey>	supportedPublicKeys() Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshPublicKey>	supportedPublicKeys(boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshCipher>	supportedSsh1CiphersCS() Deprecated. SSH1 will be removed in the next major release
ComponentFactory<SshCipher>	supportedSsh1CiphersCS(boolean clone) Deprecated. SSH1 will be removed in the next major release
ComponentFactory<SshCipher>	supportedSsh1CiphersSC() Deprecated. SSH1 will be removed in the next major release
ComponentFactory<SshCipher>	supportedSsh1CiphersSC(boolean clone) Deprecated. SSH1 will be removed in the next major release
ComponentFactory<SshCipher>	supportedSsh2CiphersCS() Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshCipher>	supportedSsh2CiphersCS(boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshCipher>	supportedSsh2CiphersSC() Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.
ComponentFactory<SshCipher>	supportedSsh2CiphersSC(boolean clone) Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentManager

public ComponentManager()

Method Detail

disableAlgorithm

public void disableAlgorithm(String algorithm)

isDisabled

public boolean isDisabled(String algorithm)

enableAlgorithm

public void enableAlgorithm(String algorithm)

isEnableNoneCipher

public static boolean isEnableNoneCipher()

setEnableNoneCipher

public static void setEnableNoneCipher(boolean enableNoneCipher)

isEnableNoneMac

public static boolean isEnableNoneMac()

setEnableNoneMac

public static void setEnableNoneMac(boolean enableNoneCipher)

setPerContextAlgorithmPreferences

@Deprecated
public static void setPerContextAlgorithmPreferences(boolean enable)

Deprecated. All contexts now have a copy of the algorithm preferences and require separate configuration. Disabling this feature will cause problems especially in the case where client and server use the same JVM.

Parameters:

enable -

getPerContextAlgorithmPreferences

public static boolean getPerContextAlgorithmPreferences()

getInstance

public static ComponentManager getInstance()

Get the installed component manager. Don't want to initialize this at class load time, so use a singleton instead. Initialized on the first call to getInstance.

Returns:

ComponentManager

reset

public static void reset()

init

protected void init()
             throws SshException

Throws:

SshException

initializeSsh1CipherFactory

protected abstract void initializeSsh1CipherFactory(ComponentFactory<SshCipher> ciphers)

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

Parameters:

ciphers -

initializeSsh2CipherFactory

protected abstract void initializeSsh2CipherFactory(ComponentFactory<SshCipher> ciphers)

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

Parameters:

ciphers -

initializeHmacFactory

protected abstract void initializeHmacFactory(ComponentFactory<SshHmac> hmacs)

Initialize the SSH2 HMAC factory.

Parameters:

hmacs -

initializePublicKeyFactory

protected abstract void initializePublicKeyFactory(ComponentFactory<SshPublicKey> publickeys)

Initialize the public key factory.

Parameters:

publickeys -

initializeKeyExchangeFactory

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

Initialize the SSH2 key exchange factory.

Parameters:

keyexchange -

initializeDigestFactory

protected abstract void initializeDigestFactory(ComponentFactory<Digest> digests)

Initialize the digest factory.

Parameters:

digests -

setInstance

public static void setInstance(ComponentManager instance)

Overide the installed component manager with an alternative implementation.

Parameters:

instance -

supportedSsh1CiphersSC

@Deprecated
public ComponentFactory<SshCipher> supportedSsh1CiphersSC(boolean clone)

Deprecated. SSH1 will be removed in the next major release

The supported SSH1 ciphers.

Returns:

AbstractComponentFactory

supportedSsh1CiphersSC

@Deprecated
public ComponentFactory<SshCipher> supportedSsh1CiphersSC()

Deprecated. SSH1 will be removed in the next major release

The supported SSH1 ciphers.

Returns:

supportedSsh1CiphersCS

@Deprecated
public ComponentFactory<SshCipher> supportedSsh1CiphersCS(boolean clone)

Deprecated. SSH1 will be removed in the next major release

The supported SSH1 ciphers.

Returns:

AbstractComponentFactory

supportedSsh1CiphersCS

@Deprecated
public ComponentFactory<SshCipher> supportedSsh1CiphersCS()

Deprecated. SSH1 will be removed in the next major release

The supported SSH1 ciphers.

Returns:

supportedSsh2CiphersSC

@Deprecated
public ComponentFactory<SshCipher> supportedSsh2CiphersSC(boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 ciphers.

Returns:

AbstractComponentFactory

supportedSsh2CiphersSC

@Deprecated
public ComponentFactory<SshCipher> supportedSsh2CiphersSC()

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 ciphers.

Returns:

AbstractComponentFactory

supportedSsh2CiphersCS

@Deprecated
public ComponentFactory<SshCipher> supportedSsh2CiphersCS(boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 ciphers.

Returns:

AbstractComponentFactory

supportedSsh2CiphersCS

@Deprecated
public ComponentFactory<SshCipher> supportedSsh2CiphersCS()

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 ciphers.

Returns:

AbstractComponentFactory

supportedHMacsSC

@Deprecated
public ComponentFactory<SshHmac> supportedHMacsSC(boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 Hmacs.

Returns:

AbstractComponentFactory

supportedHMacsSC

@Deprecated
public ComponentFactory<SshHmac> supportedHMacsSC()

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 Hmacs.

Returns:

AbstractComponentFactory

supportedHMacsCS

@Deprecated
public ComponentFactory<SshHmac> supportedHMacsCS(boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 Hmacs.

Returns:

AbstractComponentFactory

supportedHMacsCS

@Deprecated
public ComponentFactory<SshHmac> supportedHMacsCS()

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 Hmacs.

Returns:

AbstractComponentFactory

supportedKeyExchanges

@Deprecated
public ComponentFactory<SshKeyExchange> supportedKeyExchanges(boolean serverMode,
                                                                          boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 key exchanges.

Returns:

AbstractComponentFactory

supportedKeyExchanges

@Deprecated
public ComponentFactory<SshKeyExchange> supportedKeyExchanges(boolean serverMode)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported SSH2 key exchanges.

Returns:

AbstractComponentFactory

supportedPublicKeys

@Deprecated
public ComponentFactory<SshPublicKey> supportedPublicKeys(boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported public keys

Returns:

AbstractComponentFactory

supportedPublicKeys

@Deprecated
public ComponentFactory<SshPublicKey> supportedPublicKeys()

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported public keys

Returns:

AbstractComponentFactory

supportedDigests

@Deprecated
public ComponentFactory<Digest> supportedDigests(boolean clone)

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported digests

Returns:

AbstractComponentFactory

supportedDigests

@Deprecated
public ComponentFactory<Digest> supportedDigests()

Deprecated. Preferences should be configured on Ssh2Context or SshContext objects and not directly on the ComponentManager.

The supported digests

Returns:

AbstractComponentFactory

generateRsaKeyPair

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

Generate an RSA public/private pair.

Parameters:

bits -

version -

Returns:

SshKeyPair

Throws:

SshException

generateEcdsaKeyPair

public abstract SshKeyPair generateEcdsaKeyPair(int bits)
                                         throws SshException

Generate a new ECDSA key pair.

Parameters:

bits -

Returns:

Throws:

SshException

createRsaPublicKey

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

Create an instance of an RSA public key.

Parameters:

modulus -

publicExponent -

version -

Returns:

SshRsaPublicKey

Throws:

SshException

createSsh2RsaPublicKey

public abstract SshRsaPublicKey createSsh2RsaPublicKey()
                                                throws SshException

Create an instance of an SSH2 RSA public key.

Returns:

SshRsaPublicKey

Throws:

SshException

createRsaPrivateKey

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

Create an instance of an RSA private key.

Parameters:

modulus -

privateExponent -

Returns:

SshRsaPrivateKey

Throws:

SshException

createRsaPrivateCrtKey

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

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

Parameters:

modulus -

publicExponent -

privateExponent -

primeP -

primeQ -

crtCoefficient -

Returns:

SshRsaPrivateCrtKey

Throws:

SshException

createRsaPrivateCrtKey

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

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

Parameters:

modulus -

publicExponent -

privateExponent -

primeP -

primeQ -

primeExponentP -

primeExponentQ -

crtCoefficient -

Returns:

SshRsaPrivateCrtKey

Throws:

SshException

generateDsaKeyPair

public abstract SshKeyPair generateDsaKeyPair(int bits)
                                       throws SshException

Generate a new DSA public/private key pair.

Parameters:

bits -

Returns:

SshKeyPair

Throws:

SshException

createDsaPublicKey

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

Create an instance of a DSA public key.

Parameters:

p -

q -

g -

y -

Returns:

SshDsaPublicKey

Throws:

SshException

createDsaPublicKey

public abstract SshDsaPublicKey createDsaPublicKey()

Create an uninitialized instance of a DSA public key

Returns:

SshDsaPublicKey

createDsaPrivateKey

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

Create an instance of a DSA private key.

Parameters:

p -

q -

g -

x -

y -

Returns:

SshDsaPrivateKey

Throws:

SshException

getRND

public abstract SshSecureRandomGenerator getRND()
                                         throws SshException

Get the secure random number generator.

Returns:

SshSecureRandomGenerator

Throws:

SshException

loadKeystore

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

Load a host key from a keystore file.

Parameters:

keystoreFile -

alias -

storePassphrase -

keyPassphrase -

Throws:

IOException

loadKeystore

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

Load a host key from a keystore InputStream.

Parameters:

in -

alias -

storePassphrase -

keyPassphrase -

Throws:

IOException

loadKeystore

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

Throws:

IOException

loadKeystore

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

Throws:

IOException

generateEd25519KeyPair

public abstract SshKeyPair generateEd25519KeyPair()
                                           throws SshException

Throws:

SshException

generateEd448KeyPair

public abstract SshKeyPair generateEd448KeyPair()
                                         throws SshException

Throws:

SshException

setMinimumSecurityLevel

public void setMinimumSecurityLevel(SecurityLevel securityLevel)
                             throws SshException

Throws:

SshException

setMinimumSecurityLevel

public void setMinimumSecurityLevel(SecurityLevel securityLevel,
                                    boolean managedSecurity)
                             throws SshException

Throws:

SshException

getSecurityLevel

public SecurityLevel getSecurityLevel()