com.jscape.inet.ssh.util
Class SshParameters

java.lang.Object
  com.jscape.inet.ssh.util.SshParameters

All Implemented Interfaces:

java.io.Serializable

public class SshParameters

extends java.lang.Object

implements java.io.Serializable

Contains information used in establishing a connection to and authenticating with an SSH server.

Username/Password authentication example:

 String hostname = "hostname.com";
 String username = "jsmith";
 String password = "secret";
 

 SshParameters sshParams = new SshParameters(hostname,username,password);
 

Public-key authentication using passphrase protected private key example:

 String hostname = "hostname.com";
 String username = "jsmith";
 

 // passphrase for private key
 String password = "secret";
 

 // location of private key file
 File privateKey =  new File("c:/keys/id_rsa");
 

 SshParameters sshParams = new SshParameters(hostname,username,password,privateKey);
 

The SshParameters class supports private keys in both OpenSSH and SSH.COM private key formats.

See Also:

Serialized Form

Constructor Summary

SshParameters(SshParameters that)
Copy constructor.

SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.io.File privateKey)
Creates a new SshParameters instance.

SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.lang.String sshPassword)
Creates a new SshParameters instance.

SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.lang.String privateKeyPassphrase, java.io.File privateKey)
Creates a new parameters instance.

SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.lang.String sshPassword, java.io.File privateKey, java.lang.String privateKeyPassphrase)
Creates a new parameters instance.

SshParameters(java.lang.String sshHostname, java.lang.String sshUsername, java.io.File privateKey)
Creates a new SshParameters instance.

SshParameters(java.lang.String sshHostname, java.lang.String sshUsername, java.lang.String sshPassword)
Creates a new SshParameters instance.

SshParameters(java.lang.String sshHostname, java.lang.String sshUsername, java.lang.String privateKeyPassphrase, java.io.File privateKey)
Creates a new SshParameters instance.

Method Summary

com.jscape.inet.util.ConnectionParameters	getConnectionParameters() Returns corresponded connection parameters.
int	getConnectionTimeout() Returns connection timeout in milliseconds.
com.jscape.inet.ssh.util.HostKeyVerifier	getHostKeyVerifier() Returns current host key verifier.
java.security.KeyPair	getKeyPair() Returns user key pair.
java.io.File	getPrivateKey() Sets key pair to be used when authenticating with SSH Server.
java.lang.String	getProxyHost() Gets proxy hostname.
java.lang.String	getProxyPassword() Gets the proxy authentication password.
int	getProxyPort() Gets the proxy port.
java.lang.String	getProxyType() Gets the proxy type: SOCKS5, HTTP.
java.lang.String	getProxyUserId() Gets the user authentication proxy.
int	getReadingTimeout() Returns reading timeout in milliseconds.
java.lang.String	getSshHostname() Gets SSH hostname.
java.lang.String	getSshPassword() Gets SSH password.
int	getSshPort() Gets SSH port.
java.lang.String	getSshUsername() Gets SSH username.
com.jscape.inet.ssh.util.User	getUser() Returns user instance.
void	setConnectionTimeout(int timeout) Sets connection timeout.
void	setHostKeys(SshHostKeys keys, boolean newKeysAllowed) Setups a new host key verifier for the specified host keys.
void	setHostKeyVerifier(com.jscape.inet.ssh.util.HostKeyVerifier hostKeyVerifier) Setups new host key verifier.
void	setPrivateKey(java.io.File privateKey) Sets key pair to be used when authenticating with SSH Server.
void	setPrivateKey(java.io.File privateKey, java.lang.String filePassword) Sets key pair to be used when authenticating with SSH Server.
void	setPrivateKey(java.security.KeyPair keyPair) Sets user key pair.
void	setProxyHost(java.lang.String proxyHost) Sets the proxy hostname.
void	setProxyPassword(java.lang.String proxyPassword) Sets the proxy authentication password.
void	setProxyPort(int proxyPort) Sets the proxy port.
void	setProxyType(java.lang.String proxyType) Sets the proxy type
void	setProxyUserId(java.lang.String proxyUserId) Sets user authentication proxy.
void	setReadingTimeout(int timeout) Sets reading timeout.
void	setSshHostname(java.lang.String host) Sets SSH hostname.
void	setSshPassword(java.lang.String password) Sets SSH password.
void	setSshPort(int port) Sets SSH port.
void	setSshUsername(java.lang.String name) Sets SSH username.

Methods inherited from class java.lang.Object

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

Constructor Detail

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.lang.String sshPassword,
                     java.io.File privateKey,
                     java.lang.String privateKeyPassphrase)

Creates a new parameters instance.

Parameters:

sshHostname - the SSH server hostname

sshPort -

sshUsername - the SSH server username

sshPassword - the SSH server password

privateKey - the private key file

privateKeyPassphrase - the private key passphrase

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.lang.String privateKeyPassphrase,
                     java.io.File privateKey)

Creates a new parameters instance.

Parameters:

sshHostname - the SSH server hostname

sshPort - the SSH server port

sshUsername - the SSH server username

privateKeyPassphrase - the private key file password

privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     java.lang.String sshUsername,
                     java.lang.String privateKeyPassphrase,
                     java.io.File privateKey)

Creates a new SshParameters instance. For use in SSH authentication when private key is protected by a passphrase.

Parameters:

sshHostname - the SSH server hostname

sshUsername - the SSH server username

privateKeyPassphrase - the private key passphrase

privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.io.File privateKey)

Creates a new SshParameters instance. For use in SSH authentication when private key is not protected by a password.

Parameters:

sshHostname - the SSH server hostname

sshPort - the SSH server port

sshUsername - the SSH server username

privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     java.lang.String sshUsername,
                     java.io.File privateKey)

Creates a new SshParameters instance. For use in SSH authentication when private key is not protected by a password.

Parameters:

sshHostname - the SSH server hostname

sshUsername - the SSH server username

privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.lang.String sshPassword)

Creates a new SshParameters instance.

Parameters:

sshHostname - the SSH server hostname

sshPort - the SSH server port

sshUsername - the SSH server username

sshPassword - the SSH server password

SshParameters

public SshParameters(java.lang.String sshHostname,
                     java.lang.String sshUsername,
                     java.lang.String sshPassword)

Creates a new SshParameters instance.

Parameters:

sshHostname - the SSH server hostname

sshUsername - the SSH server username

sshPassword - the SSH server password

SshParameters

public SshParameters(SshParameters that)

Copy constructor.

Parameters:

that - instance to copy

Method Detail

getSshHostname

public java.lang.String getSshHostname()

Gets SSH hostname.

Returns:

the SSH hostname

getSshPort

public int getSshPort()

Gets SSH port. Default port is 22.

Returns:

the SSH port

getConnectionTimeout

public int getConnectionTimeout()

Returns connection timeout in milliseconds.

Returns:

connection timeout in milliseconds

getReadingTimeout

public int getReadingTimeout()

Returns reading timeout in milliseconds.

Returns:

reading timeout in milliseconds

getSshUsername

public java.lang.String getSshUsername()

Gets SSH username.

Returns:

the SSH username

getSshPassword

public java.lang.String getSshPassword()

Gets SSH password.

Returns:

the SSH account password or private key passphrase is public-key authentication is used

getPrivateKey

public java.io.File getPrivateKey()

Sets key pair to be used when authenticating with SSH Server.

Returns:

File

getKeyPair

public java.security.KeyPair getKeyPair()

Returns user key pair.

Returns:

user key pair

getHostKeyVerifier

public com.jscape.inet.ssh.util.HostKeyVerifier getHostKeyVerifier()

Returns current host key verifier.

Returns:

current host key verifier

getConnectionParameters

public com.jscape.inet.util.ConnectionParameters getConnectionParameters()

Returns corresponded connection parameters.

Returns:

connection parameters

getUser

public com.jscape.inet.ssh.util.User getUser()

Returns user instance.

Returns:

user instance

setSshHostname

public void setSshHostname(java.lang.String host)

Sets SSH hostname.

Parameters:

host - the SSH hostname

setSshPort

public void setSshPort(int port)

Sets SSH port. Default port is 22.

Parameters:

port - the SSH port

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Sets connection timeout.

Parameters:

timeout - connection timeout in milliseconds

setReadingTimeout

public void setReadingTimeout(int timeout)

Sets reading timeout.

Parameters:

timeout - reading timeout in milliseconds

setSshUsername

public void setSshUsername(java.lang.String name)

Sets SSH username.

Parameters:

name - the SSH username

setSshPassword

public void setSshPassword(java.lang.String password)

Sets SSH password.

Parameters:

password - the SSH account password or private key passphrase if public-key authentication is used

setPrivateKey

public void setPrivateKey(java.io.File privateKey)

Sets key pair to be used when authenticating with SSH Server.

Parameters:

privateKey - private key file

setPrivateKey

public void setPrivateKey(java.io.File privateKey,
                          java.lang.String filePassword)

Sets key pair to be used when authenticating with SSH Server.

Parameters:

privateKey - private key file

filePassword - file password

setPrivateKey

public void setPrivateKey(java.security.KeyPair keyPair)

Sets user key pair.

Parameters:

keyPair - user key pair

setHostKeyVerifier

public void setHostKeyVerifier(com.jscape.inet.ssh.util.HostKeyVerifier hostKeyVerifier)

Setups new host key verifier.

Parameters:

hostKeyVerifier - new host key verifier

setHostKeys

public void setHostKeys(SshHostKeys keys,
                        boolean newKeysAllowed)

Setups a new host key verifier for the specified host keys.

Parameters:

keys - allowed host keys

newKeysAllowed - if true unknown keys will be added to the store while key exchange

getProxyHost

public java.lang.String getProxyHost()

Gets proxy hostname.

Returns:

The proxy hostname

setProxyHost

public void setProxyHost(java.lang.String proxyHost)

Sets the proxy hostname.

Parameters:

proxyHost - The proxy hostname

getProxyPassword

public java.lang.String getProxyPassword()

Gets the proxy authentication password.

Returns:

Proxy authentication password.

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

Sets the proxy authentication password.

Parameters:

proxyPassword - Initializes the proxy authentication password.

getProxyPort

public int getProxyPort()

Gets the proxy port.

Returns:

The proxy port.

setProxyPort

public void setProxyPort(int proxyPort)

Sets the proxy port.

Parameters:

proxyPort - The proxy port.

getProxyType

public java.lang.String getProxyType()

Gets the proxy type: SOCKS5, HTTP.

Returns:

The proxy type

setProxyType

public void setProxyType(java.lang.String proxyType)

Sets the proxy type

Parameters:

proxyType - The proxy type.

getProxyUserId

public java.lang.String getProxyUserId()

Gets the user authentication proxy.

Returns:

User authentication proxy.

setProxyUserId

public void setProxyUserId(java.lang.String proxyUserId)

Sets user authentication proxy.

Parameters:

proxyUserId - User authentication proxy.