com.sshtools.common.ssh.components

Class ComponentManager

java.lang.Object

com.sshtools.common.ssh.components.ComponentManager

Direct Known Subclasses:

JCEComponentManager

public abstract class ComponentManager
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	enableCbc
protected static ComponentManager	instance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComponentManager()

Method Summary

Modifier and Type	Method and Description
abstract SshDsaPrivateKey	createDsaPrivateKey(java.math.BigInteger p, java.math.BigInteger q, java.math.BigInteger g, java.math.BigInteger x, java.math.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(java.math.BigInteger p, java.math.BigInteger q, java.math.BigInteger g, java.math.BigInteger y) Create an instance of a DSA public key.
abstract SshRsaPrivateCrtKey	createRsaPrivateCrtKey(java.math.BigInteger modulus, java.math.BigInteger publicExponent, java.math.BigInteger privateExponent, java.math.BigInteger primeP, java.math.BigInteger primeQ, java.math.BigInteger crtCoefficient) Create an instance of an RSA co-effecient private key.
abstract SshRsaPrivateCrtKey	createRsaPrivateCrtKey(java.math.BigInteger modulus, java.math.BigInteger publicExponent, java.math.BigInteger privateExponent, java.math.BigInteger primeP, java.math.BigInteger primeQ, java.math.BigInteger primeExponentP, java.math.BigInteger primeExponentQ, java.math.BigInteger crtCoefficient) Create an instance of an RSA co-efficent private key.
abstract SshRsaPrivateKey	createRsaPrivateKey(java.math.BigInteger modulus, java.math.BigInteger privateExponent) Create an instance of an RSA private key.
abstract SshRsaPublicKey	createRsaPublicKey(java.math.BigInteger modulus, java.math.BigInteger publicExponent) Create an instance of an RSA public key.
abstract SshRsaPublicKey	createSsh2RsaPublicKey() Create an instance of an SSH2 RSA public key.
void	disableAlgorithm(java.lang.String algorithm)
static void	disableCBCCiphers()
void	enableAlgorithm(java.lang.String algorithm)
static void	enableCBCCiphers()
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	generateRsaKeyPair(int bits, int version) Generate an RSA public/private pair.
static ComponentManager	getDefaultInstance()
Digest	getDigest(java.lang.String name)
static ComponentManager	getInstance() Get the installed component manager.
abstract SshSecureRandomGenerator	getRND() Get the secure random number generator.
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	initializePublicKeyFactory(ComponentFactory<SshPublicKey> publickeys) Initialize the public key factory.
protected abstract void	initializeSsh2CipherFactory(ComponentFactory<SshCipher> ciphers) Initialize the SSH2 cipher factory.
boolean	isDisabled(java.lang.String algorithm)
static boolean	isEnableNoneCipher()
static boolean	isEnableNoneMac()
<T> void	loadExternalComponents(java.lang.String componentFile, ComponentFactory<T> componentFactory)
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)
ComponentFactory<Digest>	supportedDigests() The supported digests
ComponentFactory<SshHmac>	supportedHMacsCS() The supported SSH2 Hmacs.
ComponentFactory<SshHmac>	supportedHMacsSC() The supported SSH2 Hmacs.
ComponentFactory<SshPublicKey>	supportedPublicKeys() The supported public keys
ComponentFactory<SshCipher>	supportedSsh1CiphersCS() The supported SSH1 ciphers.
ComponentFactory<SshCipher>	supportedSsh1CiphersSC() The supported SSH1 ciphers.
ComponentFactory<SshCipher>	supportedSsh2CiphersCS() The supported SSH2 ciphers.
ComponentFactory<SshCipher>	supportedSsh2CiphersSC() The supported SSH2 ciphers.

Methods inherited from class java.lang.Object

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

Field Detail

enableCbc

protected static boolean enableCbc

instance

protected static ComponentManager instance

Constructor Detail

ComponentManager

protected ComponentManager()

Method Detail

disableAlgorithm

public void disableAlgorithm(java.lang.String algorithm)

isDisabled

public boolean isDisabled(java.lang.String algorithm)

enableAlgorithm

public void enableAlgorithm(java.lang.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)

enableCBCCiphers

public static void enableCBCCiphers()

disableCBCCiphers

public static void disableCBCCiphers()

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

getDefaultInstance

public static ComponentManager getDefaultInstance()

reset

public static void reset()

init

protected void init()
             throws SshException

Throws:

SshException

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 -

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

public ComponentFactory<SshCipher> supportedSsh1CiphersSC()

The supported SSH1 ciphers.

Returns:

AbstractComponentFactory

supportedSsh1CiphersCS

public ComponentFactory<SshCipher> supportedSsh1CiphersCS()

The supported SSH1 ciphers.

Returns:

AbstractComponentFactory

supportedSsh2CiphersSC

public ComponentFactory<SshCipher> supportedSsh2CiphersSC()

The supported SSH2 ciphers.

Returns:

AbstractComponentFactory

supportedSsh2CiphersCS

public ComponentFactory<SshCipher> supportedSsh2CiphersCS()

The supported SSH2 ciphers.

Returns:

AbstractComponentFactory

supportedHMacsSC

public ComponentFactory<SshHmac> supportedHMacsSC()

The supported SSH2 Hmacs.

Returns:

AbstractComponentFactory

supportedHMacsCS

public ComponentFactory<SshHmac> supportedHMacsCS()

The supported SSH2 Hmacs.

Returns:

AbstractComponentFactory

supportedPublicKeys

public ComponentFactory<SshPublicKey> supportedPublicKeys()

The supported public keys

Returns:

AbstractComponentFactory

supportedDigests

public ComponentFactory<Digest> supportedDigests()

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

generateEd25519KeyPair

public abstract SshKeyPair generateEd25519KeyPair()
                                           throws SshException

Throws:

SshException

createRsaPublicKey

public abstract SshRsaPublicKey createRsaPublicKey(java.math.BigInteger modulus,
                                                   java.math.BigInteger publicExponent)
                                            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(java.math.BigInteger modulus,
                                                     java.math.BigInteger privateExponent)
                                              throws SshException

Create an instance of an RSA private key.

Parameters:

modulus -

privateExponent -

Returns:

SshRsaPrivateKey

Throws:

SshException

createRsaPrivateCrtKey

public abstract SshRsaPrivateCrtKey createRsaPrivateCrtKey(java.math.BigInteger modulus,
                                                           java.math.BigInteger publicExponent,
                                                           java.math.BigInteger privateExponent,
                                                           java.math.BigInteger primeP,
                                                           java.math.BigInteger primeQ,
                                                           java.math.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(java.math.BigInteger modulus,
                                                           java.math.BigInteger publicExponent,
                                                           java.math.BigInteger privateExponent,
                                                           java.math.BigInteger primeP,
                                                           java.math.BigInteger primeQ,
                                                           java.math.BigInteger primeExponentP,
                                                           java.math.BigInteger primeExponentQ,
                                                           java.math.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(java.math.BigInteger p,
                                                   java.math.BigInteger q,
                                                   java.math.BigInteger g,
                                                   java.math.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(java.math.BigInteger p,
                                                     java.math.BigInteger q,
                                                     java.math.BigInteger g,
                                                     java.math.BigInteger x,
                                                     java.math.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

getDigest

public Digest getDigest(java.lang.String name)
                 throws SshException

Throws:

SshException

loadExternalComponents

public <T> void loadExternalComponents(java.lang.String componentFile,
                                       ComponentFactory<T> componentFactory)

setMinimumSecurityLevel

public void setMinimumSecurityLevel(SecurityLevel securityLevel)
                             throws SshException

Throws:

SshException