ch.ethz.ssh2

Class ServerConnection

java.lang.Object

ch.ethz.ssh2.ServerConnection

public class ServerConnection
extends Object

A server-side SSH-2 connection.

Author:

Christian

Constructor Summary

Constructors

Constructor and Description
ServerConnection(Socket s) Creates a new ServerConnection that will communicate with the client over the given Socket.
ServerConnection(Socket s, DSAPrivateKey dsa_key, RSAPrivateKey rsa_key) Creates a new ServerConnection that will communicate with the client over the given Socket.
ServerConnection(Socket s, String softwareversion)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the connection to the SSH-2 server.
void	close(Throwable t, boolean hard)
void	connect() Establish the connection and block until the first handshake has completed.
void	connect(int timeout_milliseconds) Establish the connection and block until the first handshake has completed.
void	forceKeyExchange() Force an asynchronous key re-exchange (the call does not block).
ConnectionInfo	getConnectionInfo() Returns a ConnectionInfo object containing the details of the connection.
Socket	getSocket() Retrieve the underlying socket.
void	setAuthenticationCallback(ServerAuthenticationCallback cb) Callback interface with methods that will be called upon authentication events.
void	setDsaHostKey(DSAPrivateKey dsa_hostkey) Change the current DSA hostkey.
void	setPEMHostKey(char[] pemdata, String password) Utility method that loads a PEM based hostkey (either RSA or DSA based) and calls either setRsaHostKey() or setDsaHostKey().
void	setPEMHostKey(File pemFile, String password) Utility method that loads a hostkey from a PEM file (either RSA or DSA based) and calls either setRsaHostKey() or setDsaHostKey().
void	setRsaHostKey(RSAPrivateKey rsa_hostkey) Change the current RSA hostkey.
void	setServerConnectionCallback(ServerConnectionCallback cb) Callback interface with methods that will be called upon events generated by the client (e.g., client opens a new Session which results in a ServerSession).

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerConnection

public ServerConnection(Socket s)

Creates a new ServerConnection that will communicate with the client over the given Socket.

Note: you need to call connect() or connect(int) to perform the initial handshake and establish the encrypted communication.

Parameters:

s - The socket

See Also:

connect(int)

ServerConnection

public ServerConnection(Socket s,
                String softwareversion)

ServerConnection

public ServerConnection(Socket s,
                DSAPrivateKey dsa_key,
                RSAPrivateKey rsa_key)

Creates a new ServerConnection that will communicate with the client over the given Socket.

Note: you need to call connect() or connect(int) to perform the initial handshake and establish the encrypted communication.

Please read the javadoc for the connect(int) method.

Parameters:

s - The socket

dsa_key - The DSA hostkey, may be NULL

rsa_key - The RSA hostkey, may be NULL

See Also:

connect(int)

Method Detail

connect

public void connect()
             throws IOException

Establish the connection and block until the first handshake has completed.

Note: this is a wrapper that calls connect(0) (i.e., connect with no timeout).

Please read the javadoc for the connect(int) method.

Throws:

IOException

See Also:

connect(int)

connect

public void connect(int timeout_milliseconds)
             throws IOException

Establish the connection and block until the first handshake has completed.

Note 1: either a DSA or a RSA (or both) hostkey must be set before calling this method.

Note 2: You must set the callbacks for authentication (setAuthenticationCallback(ServerAuthenticationCallback)) and connection events (setServerConnectionCallback(ServerConnectionCallback)).

Parameters:

timeout_milliseconds - Timeout in milliseconds, 0 means no timeout.

Throws:

IOException

See Also:

setPEMHostKey(char[], String), setPEMHostKey(File, String), setRsaHostKey(RSAPrivateKey), setDsaHostKey(DSAPrivateKey)

getSocket

public Socket getSocket()

Retrieve the underlying socket.

Returns:

the socket that has been passed to the constructor.

forceKeyExchange

public void forceKeyExchange()
                      throws IOException

Force an asynchronous key re-exchange (the call does not block). The latest values set for MAC, Cipher and DH group exchange parameters will be used. If a key exchange is currently in progress, then this method has the only effect that the so far specified parameters will be used for the next (client driven) key exchange. You may call this method only after the initial key exchange has been established.

Note: This implementation will never start automatically a key exchange (other than the initial one) unless you or the connected SSH-2 client ask for it.

Throws:

IOException - In case of any failure behind the scenes.

getConnectionInfo

public ConnectionInfo getConnectionInfo()
                                 throws IOException

Returns a ConnectionInfo object containing the details of the connection. May be called as soon as the first key exchange has been started. The method blocks in case the first key exchange has not been completed.

Note: upon return of this method, authentication may still be pending.

Returns:

A ConnectionInfo object.

Throws:

IOException - In case of any failure behind the scenes; e.g., first key exchange was aborted.

setDsaHostKey

public void setDsaHostKey(DSAPrivateKey dsa_hostkey)

Change the current DSA hostkey. Either a DSA or RSA private key must be set for a successful handshake with the client.

Note: You can change an existing DSA hostkey after the initial kex exchange (the new value will be used during the next server initiated key exchange), but you cannot remove (i.e., set to null) the current DSA key, otherwise the next key exchange may fail in case the client supports only DSA hostkeys.

Parameters:

dsa_hostkey -

setRsaHostKey

public void setRsaHostKey(RSAPrivateKey rsa_hostkey)

Change the current RSA hostkey. Either a DSA or RSA private key must be set for a successful handshake with the client.

Note: You can change an existing RSA hostkey after the initial kex exchange (the new value will be used during the next server initiated key exchange), but you cannot remove (i.e., set to null) the current RSA key, otherwise the next key exchange may fail in case the client supports only RSA hostkeys.

Parameters:

rsa_hostkey -

setPEMHostKey

public void setPEMHostKey(char[] pemdata,
                 String password)
                   throws IOException

Utility method that loads a PEM based hostkey (either RSA or DSA based) and calls either setRsaHostKey() or setDsaHostKey().

Parameters:

pemdata - The PEM data

password - Password, may be null in case the PEM data is not password protected

Throws:

IOException - In case of any error.

setPEMHostKey

public void setPEMHostKey(File pemFile,
                 String password)
                   throws IOException

Utility method that loads a hostkey from a PEM file (either RSA or DSA based) and calls either setRsaHostKey() or setDsaHostKey().

Parameters:

pemFile - The PEM file

password - Password, may be null in case the PEM file is not password protected

Throws:

IOException

setServerConnectionCallback

public void setServerConnectionCallback(ServerConnectionCallback cb)

Callback interface with methods that will be called upon events generated by the client (e.g., client opens a new Session which results in a ServerSession).

Note: This must be set before the first handshake.

Parameters:

cb - The callback implementation

setAuthenticationCallback

public void setAuthenticationCallback(ServerAuthenticationCallback cb)

Callback interface with methods that will be called upon authentication events.

Note: This must be set before the first handshake.

Parameters:

cb - The callback implementation

close

public void close()

Close the connection to the SSH-2 server. All assigned sessions will be closed, too. Can be called at any time. Don't forget to call this once you don't need a connection anymore - otherwise the receiver thread may run forever.

close

public void close(Throwable t,
         boolean hard)