org.apache.sshd.server.keyprovider

Class AbstractGeneratorHostKeyProvider

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.keyprovider.AbstractKeyPairProvider

org.apache.sshd.server.keyprovider.AbstractGeneratorHostKeyProvider

All Implemented Interfaces:

KeyPairProvider

Direct Known Subclasses:

SimpleGeneratorHostKeyProvider

public abstract class AbstractGeneratorHostKeyProvider
extends AbstractKeyPairProvider

Holds a single KeyPair which is generated the 1st time loadKeys() is called. If there is a file backing it up and the file exists, the key is loaded from it. Otherwise a new key pair is generated and saved (provided a path is configured and isOverwriteAllowed()

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALGORITHM
static boolean	DEFAULT_ALLOWED_TO_OVERWRITE

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.keyprovider.KeyPairProvider

ECDSA_SHA2_NISTP256, ECDSA_SHA2_NISTP384, ECDSA_SHA2_NISTP521, EMPTY_KEYPAIR_PROVIDER, SSH_DSS, SSH_RSA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGeneratorHostKeyProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract KeyPair	doReadKeyPair(String resourceKey, InputStream inputStream)
protected abstract void	doWriteKeyPair(String resourceKey, KeyPair kp, OutputStream outputStream)
protected KeyPair	generateKeyPair(String algorithm)
String	getAlgorithm()
int	getKeySize()
AlgorithmParameterSpec	getKeySpec()
Path	getPath()
boolean	isOverwriteAllowed()
Iterable<KeyPair>	loadKeys() Load available keys.
protected KeyPair	readKeyPair(Path keyPath, OpenOption... options)
void	setAlgorithm(String algorithm)
void	setFile(File file)
void	setKeySize(int keySize)
void	setKeySpec(AlgorithmParameterSpec keySpec)
void	setOverwriteAllowed(boolean overwriteAllowed)
void	setPath(Path path)
protected void	writeKeyPair(KeyPair kp, Path keyPath, OpenOption... options)

Methods inherited from class org.apache.sshd.common.keyprovider.AbstractKeyPairProvider

getKeyTypes, loadKey

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALGORITHM

public static final String DEFAULT_ALGORITHM

See Also:

Constant Field Values

DEFAULT_ALLOWED_TO_OVERWRITE

public static final boolean DEFAULT_ALLOWED_TO_OVERWRITE

See Also:

Constant Field Values

Constructor Detail

AbstractGeneratorHostKeyProvider

protected AbstractGeneratorHostKeyProvider()

Method Detail

getPath

public Path getPath()

setFile

public void setFile(File file)

setPath

public void setPath(Path path)

getAlgorithm

public String getAlgorithm()

setAlgorithm

public void setAlgorithm(String algorithm)

getKeySize

public int getKeySize()

setKeySize

public void setKeySize(int keySize)

getKeySpec

public AlgorithmParameterSpec getKeySpec()

setKeySpec

public void setKeySpec(AlgorithmParameterSpec keySpec)

isOverwriteAllowed

public boolean isOverwriteAllowed()

setOverwriteAllowed

public void setOverwriteAllowed(boolean overwriteAllowed)

loadKeys

public Iterable<KeyPair> loadKeys()

Description copied from interface: KeyPairProvider

Load available keys.

Returns:

an Iterable instance of available keys, never null

readKeyPair

protected KeyPair readKeyPair(Path keyPath,
                              OpenOption... options)
                       throws IOException,
                              GeneralSecurityException

Throws:

IOException

GeneralSecurityException

doReadKeyPair

protected abstract KeyPair doReadKeyPair(String resourceKey,
                                         InputStream inputStream)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

writeKeyPair

protected void writeKeyPair(KeyPair kp,
                            Path keyPath,
                            OpenOption... options)
                     throws IOException,
                            GeneralSecurityException

Throws:

IOException

GeneralSecurityException

doWriteKeyPair

protected abstract void doWriteKeyPair(String resourceKey,
                                       KeyPair kp,
                                       OutputStream outputStream)
                                throws IOException,
                                       GeneralSecurityException

Throws:

IOException

GeneralSecurityException

generateKeyPair

protected KeyPair generateKeyPair(String algorithm)
                           throws GeneralSecurityException

Throws:

GeneralSecurityException