Secure iNet Factory

com.jscape.inet.ssh.util
Class SshParameters

java.lang.Object
  extended by 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(ConnectionParameters connectionParameters, User user, java.io.File privateKey, java.lang.String privateKeyPassword, HostKeyVerifier hostKeyVerifier)
           
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
 ConnectionParameters getConnectionParameters()
          Returns corresponded connection parameters.
 long getConnectionTimeout()
          Returns connection timeout in milliseconds.
 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.
 long getReadingTimeout()
          Returns reading timeout in milliseconds.
 int getSocketTrafficClass()
          Get socket traffic class
 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.
 boolean getTcpNoDelay()
          Get TCP no delay.
 User getUser()
          Returns user instance.
 void setConnectionParameters(ConnectionParameters value)
          Sets connection parameters.
 void setConnectionTimeout(long value)
          Sets connection timeout.
 void setHostKeyVerifier(HostKeyVerifier hostKeyVerifier)
          Setups new host key verifier.
 void setKeyPair(java.security.KeyPair keyPair)
          Sets user key pair.
 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.lang.String serializedKeyData)
          Sets key pair to be used when authenticating with SSH Server.
 void setPrivateKey(java.lang.String serializedKeyData, java.lang.String password)
          Sets key pair to be used when authenticating with SSH Server.
 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(long value)
          Sets reading timeout.
 void setSocketTrafficClass(int trafficClass)
          Set socket traffic class.
 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.
 void setTcpNoDelay(boolean tcpNoDelay)
          Set TCP no delay.
 void setUser(User user)
          Sets a new user value.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SshParameters

public SshParameters(ConnectionParameters connectionParameters,
                     User user,
                     java.io.File privateKey,
                     java.lang.String privateKeyPassword,
                     HostKeyVerifier hostKeyVerifier)

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 - the SSH server port
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

getConnectionParameters

public ConnectionParameters getConnectionParameters()
Returns corresponded connection parameters.

Returns:
connection parameters

setConnectionParameters

public void setConnectionParameters(ConnectionParameters value)
Sets connection parameters.

Parameters:
value - a new connection parameters value

getSocketTrafficClass

public int getSocketTrafficClass()
Get socket traffic class

Returns:
trafficClass

setSocketTrafficClass

public void setSocketTrafficClass(int trafficClass)
Set socket traffic class.

Parameters:
trafficClass -

getTcpNoDelay

public boolean getTcpNoDelay()
Get TCP no delay.

Returns:
tcpNoDelay

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)
Set TCP no delay.

Parameters:
tcpNoDelay -

getSshHostname

public java.lang.String getSshHostname()
Gets SSH hostname.

Returns:
the SSH hostname

setSshHostname

public void setSshHostname(java.lang.String host)
Sets SSH hostname.

Parameters:
host - the SSH hostname

getSshPort

public int getSshPort()
Gets SSH port. Default port is 22.

Returns:
the SSH port

setSshPort

public void setSshPort(int port)
Sets SSH port. Default port is 22.

Parameters:
port - the SSH port

getConnectionTimeout

public long getConnectionTimeout()
Returns connection timeout in milliseconds.

Returns:
connection timeout in milliseconds

setConnectionTimeout

public void setConnectionTimeout(long value)
Sets connection timeout.

Parameters:
value - connection timeout in milliseconds

getReadingTimeout

public long getReadingTimeout()
Returns reading timeout in milliseconds.

Returns:
reading timeout in milliseconds

setReadingTimeout

public void setReadingTimeout(long value)
Sets reading timeout.

Parameters:
value - reading timeout in milliseconds

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

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.

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.

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.

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.

getUser

public User getUser()
Returns user instance.

Returns:
user instance

setUser

public void setUser(User user)
Sets a new user value.

Parameters:
user - a new user value

getSshUsername

public java.lang.String getSshUsername()
Gets SSH username.

Returns:
the SSH username

setSshUsername

public void setSshUsername(java.lang.String name)
Sets SSH username.

Parameters:
name - 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

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

getPrivateKey

public java.io.File getPrivateKey()
Sets key pair to be used when authenticating with SSH Server.

Returns:
File

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.lang.String serializedKeyData)
Sets key pair to be used when authenticating with SSH Server.

Parameters:
serializedKeyData - the serialized key data

setPrivateKey

public void setPrivateKey(java.lang.String serializedKeyData,
                          java.lang.String password)
Sets key pair to be used when authenticating with SSH Server.

Parameters:
serializedKeyData - the serialized key data
password - the private key password

getKeyPair

public java.security.KeyPair getKeyPair()
Returns user key pair.

Returns:
user key pair

setKeyPair

public void setKeyPair(java.security.KeyPair keyPair)
Sets user key pair.

Parameters:
keyPair - user key pair

getHostKeyVerifier

public HostKeyVerifier getHostKeyVerifier()
Returns current host key verifier.

Returns:
current host key verifier

setHostKeyVerifier

public void setHostKeyVerifier(HostKeyVerifier hostKeyVerifier)
Setups new host key verifier.

Parameters:
hostKeyVerifier - new host key verifier

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Secure iNet Factory

Copyright © JSCAPE LLC. 1999-2011. All Rights Reserved