Class OpenSSHKeyEncryptionContext

java.lang.Object

org.apache.sshd.common.config.keys.loader.PrivateKeyEncryptionContext

org.apache.sshd.common.config.keys.writer.openssh.OpenSSHKeyEncryptionContext

All Implemented Interfaces:

Cloneable, MutablePassword, PasswordHolder

public class OpenSSHKeyEncryptionContext
extends PrivateKeyEncryptionContext

A PrivateKeyEncryptionContext for use with a OpenSSHKeyPairResourceWriter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AES
static final int	DEFAULT_KDF_ROUNDS	Default number of bcrypt KDF rounds to apply.
private int	kdfRounds

Fields inherited from class PrivateKeyEncryptionContext

DEFAULT_CIPHER_MODE

Constructor Summary

Constructors

Constructor	Description
OpenSSHKeyEncryptionContext()

Method Summary

Modifier and Type	Method	Description
protected String	getCipherFactoryName()
String	getCipherName()
int	getKdfRounds()	Retrieves the number of KDF rounds to apply.
void	setCipherName(String value)
void	setKdfRounds(int rounds)	Sets the number of KDF rounds to apply.

Methods inherited from class PrivateKeyEncryptionContext

clone, equals, getCipherMode, getCipherType, getInitVector, getPassword, getPrivateKeyObfuscator, getRegisteredPrivateKeyObfuscator, getRegisteredPrivateKeyObfuscatorCiphers, getRegisteredPrivateKeyObfuscators, hashCode, initializeObfuscator, newPrivateKeyEncryptionContext, parseAlgorithmInfo, parseAlgorithmInfo, registerPrivateKeyObfuscator, registerPrivateKeyObfuscator, resolvePrivateKeyObfuscator, setCipherMode, setCipherType, setInitVector, setPassword, setPrivateKeyObfuscator, toString, unregisterPrivateKeyObfuscator, unregisterPrivateKeyObfuscator

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_KDF_ROUNDS

public static final int DEFAULT_KDF_ROUNDS

Default number of bcrypt KDF rounds to apply.

See Also:

• Constant Field Values

AES

public static final String AES

See Also:

• Constant Field Values

kdfRounds

private int kdfRounds

Constructor Details

OpenSSHKeyEncryptionContext

public OpenSSHKeyEncryptionContext()

Method Details

getCipherName

public String getCipherName()

Overrides:

getCipherName in class PrivateKeyEncryptionContext

setCipherName

public void setCipherName(String value)

Overrides:

setCipherName in class PrivateKeyEncryptionContext

getKdfRounds

public int getKdfRounds()

Retrieves the number of KDF rounds to apply.

Returns:

the default number of KDF rounds, >= DEFAULT_KDF_ROUNDS

setKdfRounds

public void setKdfRounds(int rounds)

Sets the number of KDF rounds to apply. If smaller than the DEFAULT_KDF_ROUNDS, set that default.

Parameters:

rounds - number of rounds to apply

getCipherFactoryName

protected String getCipherFactoryName()

Returns:

the cipher's factory name.