com.mindbright.ssh

Class SSHPropertyHandler

java.lang.Object

com.mindbright.ssh.SSHPropertyHandler

All Implemented Interfaces:

ProxyAuthenticator, SSHAuthenticator, SSHClientUser

public final class SSHPropertyHandler
extends java.lang.Object
implements SSHClientUser, SSHAuthenticator, ProxyAuthenticator

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	ciphAlgsSort
protected java.lang.String	currentAlias
protected java.lang.String	currentPropsFile
static java.lang.String	def_ciphAlgsSort
static java.lang.String	def_hostKeyAlgs
static java.lang.String	DEF_IDFILE
static java.lang.String	def_macAlgs
static java.lang.String[][]	defaultPropDesc
static java.util.Properties	defaultProperties
static java.util.Hashtable<java.lang.String,java.lang.String>	defaultPropNames
java.lang.String	hostKeyAlgs
java.util.Properties	initTermProps
java.lang.String	macAlgs
static java.util.Hashtable<java.lang.String,java.lang.String>	oldPropNames
static int	PROP_NAME
static int	PROP_VALUE
static java.lang.String	PROPS_FILE_EXT
protected boolean	propsChanged

Constructor Summary

Constructors

Constructor and Description
SSHPropertyHandler()
SSHPropertyHandler(java.util.Properties initProps, boolean setAsDefault)
SSHPropertyHandler(SSHPropertyHandler clone)

Method Summary

Methods

Modifier and Type	Method and Description
void	activateProperties()
void	addLocalPortForward(java.lang.String fwdSpec, boolean commit)
void	addRemotePortForward(java.lang.String fwdSpec, boolean commit)
java.lang.String[]	availableAliases()
static java.lang.String	backwardCompatProp(java.lang.String key)
void	checkSave()
boolean	emptyPropertyPassword()
void	eraseProperty(java.lang.String key)
static SSHPropertyHandler	fromFile(java.lang.String fileName, java.lang.String password)
java.lang.String	getAlias()
int	getAliveInterval() Get alive interval (0 = do not send keepalive packets)
int[]	getAuthTypes(SSHClientUser origin)
java.lang.String	getChallengeResponse(SSHClientUser origin, java.lang.String challenge)
int	getCipher(SSHClientUser origin)
int	getCompressionLevel() Get desired level of compression
int	getConnectTimeout() Timeout when connecting to server (in seconds)
java.lang.String	getDefaultProperty(java.lang.String key)
java.lang.String	getDisplay() Get the display for X11 forwardings
int	getHelloTimeout() Timeout when waiting for initial greeting from server (in seconds)
SSHRSAKeyFile	getIdentityFile(SSHClientUser origin)
java.lang.String	getIdentityPassword(SSHClientUser origin)
java.lang.String	getIdentityPassword(java.lang.String prompt)
java.util.Properties	getInitTerminalProperties()
SSHInteractor	getInteractor() Get interactor which should handle the authentication phase
int	getKexTimeout() Timeout of key exchange (in seconds)
int	getMaxPacketSz() get maximum packet size (0 = no limit)
java.lang.String	getPassword(SSHClientUser origin)
java.util.Properties	getProperties()
java.lang.String	getProperty(java.lang.String key)
boolean	getPropertyB(java.lang.String key)
int	getPropertyI(java.lang.String key)
NetworkConnection	getProxyConnection() Return a connection to the server.
java.lang.String	getProxyPassword(java.lang.String type, java.lang.String challenge)
java.lang.String	getProxyUsername(java.lang.String type, java.lang.String challenge)
java.lang.String	getSrvHost() Get host to connect to
int	getSrvPort() Get port number to connect to
java.lang.String	getSSHHomeDir()
TerminalWindow	getTerminal()
java.lang.String	getUsername(SSHClientUser origin)
boolean	hasHomeDir()
boolean	isAbsolutFile(java.lang.String fileName)
boolean	isAlias(java.lang.String alias)
static boolean	isProperty(java.lang.String key)
boolean	isReadOnly()
void	loadAbsoluteFile(java.lang.String fileName, boolean promptPwd)
void	loadAliasFile(java.lang.String alias, boolean promptPwd)
void	mergeProperties(java.util.Properties newProps)
void	passivateProperties()
java.io.ByteArrayOutputStream	readResource(java.lang.String name)
void	removeLocalTunnelAt(int idx, boolean kill)
void	removeRemoteTunnelAt(int idx)
void	resetProperty(java.lang.String key)
void	resetToDefaults()
void	saveAsCurrentFile(java.lang.String fileName)
void	saveCurrentFile()
void	setAlias(java.lang.String alias)
static void	setAsDefault(java.util.Properties props)
void	setAutoLoadProps(boolean value)
void	setAutoSaveProps(boolean value)
void	setClient(SSHInteractiveClient client)
void	setDefaultProperty(java.lang.String key, java.lang.String value)
void	setInteractor(SSHInteractor interactor)
void	setProperties(java.util.Properties newProps)
void	setProperty(java.lang.String key, boolean value)
void	setProperty(java.lang.String key, int value)
void	setProperty(java.lang.String key, java.lang.String value)
void	setPropertyPassword(java.lang.String password)
void	setReadOnly(boolean value)
void	setSavePasswords(boolean value)
boolean	setSSHHomeDir(java.lang.String sshHomeDir)
boolean	verifyKnownHosts(java.security.interfaces.RSAPublicKey hostPub)
boolean	verifyKnownSSH2Hosts(SSHInteractiveClient cli, SSH2Signature serverHostKey)
boolean	wantPTY() Return true if we need a PTY on the server
boolean	wantSave()
boolean	wantX11Forward() Return true if X11 forwarding is desired

Methods inherited from class java.lang.Object

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

Field Detail

PROP_NAME

public static final int PROP_NAME

See Also:

Constant Field Values

PROP_VALUE

public static final int PROP_VALUE

See Also:

Constant Field Values

PROPS_FILE_EXT

public static final java.lang.String PROPS_FILE_EXT

See Also:

Constant Field Values

DEF_IDFILE

public static final java.lang.String DEF_IDFILE

See Also:

Constant Field Values

def_hostKeyAlgs

public static final java.lang.String def_hostKeyAlgs

See Also:

Constant Field Values

def_macAlgs

public static final java.lang.String def_macAlgs

See Also:

Constant Field Values

def_ciphAlgsSort

public static final java.lang.String def_ciphAlgsSort

See Also:

Constant Field Values

hostKeyAlgs

public java.lang.String hostKeyAlgs

macAlgs

public java.lang.String macAlgs

ciphAlgsSort

public java.lang.String ciphAlgsSort

defaultProperties

public static final java.util.Properties defaultProperties

defaultPropNames

public static final java.util.Hashtable<java.lang.String,java.lang.String> defaultPropNames

oldPropNames

public static final java.util.Hashtable<java.lang.String,java.lang.String> oldPropNames

defaultPropDesc

public static final java.lang.String[][] defaultPropDesc

currentPropsFile

protected java.lang.String currentPropsFile

currentAlias

protected java.lang.String currentAlias

initTermProps

public java.util.Properties initTermProps

propsChanged

protected boolean propsChanged

Constructor Detail

SSHPropertyHandler

public SSHPropertyHandler()

SSHPropertyHandler

public SSHPropertyHandler(java.util.Properties initProps,
                  boolean setAsDefault)

SSHPropertyHandler

public SSHPropertyHandler(SSHPropertyHandler clone)

Method Detail

backwardCompatProp

public static java.lang.String backwardCompatProp(java.lang.String key)

setAsDefault

public static void setAsDefault(java.util.Properties props)

fromFile

public static SSHPropertyHandler fromFile(java.lang.String fileName,
                          java.lang.String password)
                                   throws java.io.IOException

Throws:

java.io.IOException

setInteractor

public void setInteractor(SSHInteractor interactor)

setClient

public void setClient(SSHInteractiveClient client)

setAutoLoadProps

public void setAutoLoadProps(boolean value)

setAutoSaveProps

public void setAutoSaveProps(boolean value)

setSavePasswords

public void setSavePasswords(boolean value)

setReadOnly

public void setReadOnly(boolean value)

isReadOnly

public boolean isReadOnly()

setPropertyPassword

public void setPropertyPassword(java.lang.String password)

emptyPropertyPassword

public boolean emptyPropertyPassword()

setSSHHomeDir

public boolean setSSHHomeDir(java.lang.String sshHomeDir)

getSSHHomeDir

public java.lang.String getSSHHomeDir()

hasHomeDir

public boolean hasHomeDir()

resetToDefaults

public void resetToDefaults()

isProperty

public static boolean isProperty(java.lang.String key)

getProperty

public java.lang.String getProperty(java.lang.String key)

getPropertyB

public boolean getPropertyB(java.lang.String key)

getPropertyI

public int getPropertyI(java.lang.String key)

getDefaultProperty

public java.lang.String getDefaultProperty(java.lang.String key)

setDefaultProperty

public void setDefaultProperty(java.lang.String key,
                      java.lang.String value)

resetProperty

public void resetProperty(java.lang.String key)

eraseProperty

public void eraseProperty(java.lang.String key)

setProperty

public void setProperty(java.lang.String key,
               boolean value)
                 throws java.lang.IllegalArgumentException,
                        java.util.NoSuchElementException

Throws:

java.lang.IllegalArgumentException

java.util.NoSuchElementException

setProperty

public void setProperty(java.lang.String key,
               int value)
                 throws java.lang.IllegalArgumentException,
                        java.util.NoSuchElementException

Throws:

java.lang.IllegalArgumentException

java.util.NoSuchElementException

setProperty

public void setProperty(java.lang.String key,
               java.lang.String value)
                 throws java.lang.IllegalArgumentException,
                        java.util.NoSuchElementException

Throws:

java.lang.IllegalArgumentException

java.util.NoSuchElementException

setProperties

public void setProperties(java.util.Properties newProps)
                   throws java.lang.IllegalArgumentException,
                          java.util.NoSuchElementException

Throws:

java.lang.IllegalArgumentException

java.util.NoSuchElementException

getProperties

public java.util.Properties getProperties()

mergeProperties

public void mergeProperties(java.util.Properties newProps)
                     throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getInitTerminalProperties

public java.util.Properties getInitTerminalProperties()

activateProperties

public void activateProperties()

passivateProperties

public void passivateProperties()

wantSave

public boolean wantSave()

checkSave

public final void checkSave()
                     throws java.io.IOException

Throws:

java.io.IOException

saveCurrentFile

public void saveCurrentFile()
                     throws java.io.IOException

Throws:

java.io.IOException

saveAsCurrentFile

public void saveAsCurrentFile(java.lang.String fileName)
                       throws java.io.IOException

Throws:

java.io.IOException

loadAbsoluteFile

public void loadAbsoluteFile(java.lang.String fileName,
                    boolean promptPwd)
                      throws java.io.IOException

Throws:

java.io.IOException

setAlias

public void setAlias(java.lang.String alias)

getAlias

public java.lang.String getAlias()

loadAliasFile

public void loadAliasFile(java.lang.String alias,
                 boolean promptPwd)
                   throws java.io.IOException

Throws:

java.io.IOException

availableAliases

public java.lang.String[] availableAliases()

isAlias

public boolean isAlias(java.lang.String alias)

isAbsolutFile

public boolean isAbsolutFile(java.lang.String fileName)

getTerminal

public TerminalWindow getTerminal()

removeLocalTunnelAt

public void removeLocalTunnelAt(int idx,
                       boolean kill)

removeRemoteTunnelAt

public void removeRemoteTunnelAt(int idx)

addLocalPortForward

public void addLocalPortForward(java.lang.String fwdSpec,
                       boolean commit)
                         throws java.lang.IllegalArgumentException,
                                java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.io.IOException

addRemotePortForward

public void addRemotePortForward(java.lang.String fwdSpec,
                        boolean commit)
                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getUsername

public java.lang.String getUsername(SSHClientUser origin)
                             throws java.io.IOException

Specified by:

getUsername in interface SSHAuthenticator

Throws:

java.io.IOException

getPassword

public java.lang.String getPassword(SSHClientUser origin)
                             throws java.io.IOException

Specified by:

getPassword in interface SSHAuthenticator

Throws:

java.io.IOException

getChallengeResponse

public java.lang.String getChallengeResponse(SSHClientUser origin,
                                    java.lang.String challenge)
                                      throws java.io.IOException

Specified by:

getChallengeResponse in interface SSHAuthenticator

Throws:

java.io.IOException

getAuthTypes

public int[] getAuthTypes(SSHClientUser origin)

Specified by:

getAuthTypes in interface SSHAuthenticator

getCipher

public int getCipher(SSHClientUser origin)

Specified by:

getCipher in interface SSHAuthenticator

getIdentityFile

public SSHRSAKeyFile getIdentityFile(SSHClientUser origin)
                              throws java.io.IOException

Specified by:

getIdentityFile in interface SSHAuthenticator

Throws:

java.io.IOException

getIdentityPassword

public java.lang.String getIdentityPassword(SSHClientUser origin)
                                     throws java.io.IOException

Specified by:

getIdentityPassword in interface SSHAuthenticator

Throws:

java.io.IOException

getIdentityPassword

public java.lang.String getIdentityPassword(java.lang.String prompt)
                                     throws java.io.IOException

Throws:

java.io.IOException

verifyKnownHosts

public boolean verifyKnownHosts(java.security.interfaces.RSAPublicKey hostPub)
                         throws java.io.IOException

Specified by:

verifyKnownHosts in interface SSHAuthenticator

Throws:

java.io.IOException

verifyKnownSSH2Hosts

public boolean verifyKnownSSH2Hosts(SSHInteractiveClient cli,
                           SSH2Signature serverHostKey)
                             throws java.io.IOException,
                                    SSH2Exception

Throws:

java.io.IOException

SSH2Exception

getProxyUsername

public java.lang.String getProxyUsername(java.lang.String type,
                                java.lang.String challenge)
                                  throws java.io.IOException

Specified by:

getProxyUsername in interface ProxyAuthenticator

Throws:

java.io.IOException

getProxyPassword

public java.lang.String getProxyPassword(java.lang.String type,
                                java.lang.String challenge)
                                  throws java.io.IOException

Specified by:

getProxyPassword in interface ProxyAuthenticator

Throws:

java.io.IOException

getSrvHost

public java.lang.String getSrvHost()
                            throws java.io.IOException

Description copied from interface: SSHClientUser

Get host to connect to

Specified by:

getSrvHost in interface SSHClientUser

Throws:

java.io.IOException

getSrvPort

public int getSrvPort()

Description copied from interface: SSHClientUser

Get port number to connect to

Specified by:

getSrvPort in interface SSHClientUser

getProxyConnection

public NetworkConnection getProxyConnection()
                                     throws java.io.IOException

Description copied from interface: SSHClientUser

Return a connection to the server. This can be used to connect through proxies etc.

Specified by:

getProxyConnection in interface SSHClientUser

Throws:

java.io.IOException

readResource

public java.io.ByteArrayOutputStream readResource(java.lang.String name)

getDisplay

public java.lang.String getDisplay()

Description copied from interface: SSHClientUser

Get the display for X11 forwardings

Specified by:

getDisplay in interface SSHClientUser

getMaxPacketSz

public int getMaxPacketSz()

Description copied from interface: SSHClientUser

get maximum packet size (0 = no limit)

Specified by:

getMaxPacketSz in interface SSHClientUser

getAliveInterval

public int getAliveInterval()

Description copied from interface: SSHClientUser

Get alive interval (0 = do not send keepalive packets)

Specified by:

getAliveInterval in interface SSHClientUser

getCompressionLevel

public int getCompressionLevel()

Description copied from interface: SSHClientUser

Get desired level of compression

Specified by:

getCompressionLevel in interface SSHClientUser

getConnectTimeout

public int getConnectTimeout()

Description copied from interface: SSHClientUser

Timeout when connecting to server (in seconds)

Specified by:

getConnectTimeout in interface SSHClientUser

getHelloTimeout

public int getHelloTimeout()

Description copied from interface: SSHClientUser

Timeout when waiting for initial greeting from server (in seconds)

Specified by:

getHelloTimeout in interface SSHClientUser

getKexTimeout

public int getKexTimeout()

Description copied from interface: SSHClientUser

Timeout of key exchange (in seconds)

Specified by:

getKexTimeout in interface SSHClientUser

wantX11Forward

public boolean wantX11Forward()

Description copied from interface: SSHClientUser

Return true if X11 forwarding is desired

Specified by:

wantX11Forward in interface SSHClientUser

wantPTY

public boolean wantPTY()

Description copied from interface: SSHClientUser

Return true if we need a PTY on the server

Specified by:

wantPTY in interface SSHClientUser

getInteractor

public SSHInteractor getInteractor()

Description copied from interface: SSHClientUser

Get interactor which should handle the authentication phase

Specified by:

getInteractor in interface SSHClientUser