|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.maverick.ssh2.Ssh2Client
Implementation of an SshClient for the SSH2 protocol; this provides the ability to create custom channels and sending/receiving of global requests in addition to the standard SshClient contract.
Constructor Summary | |
Ssh2Client()
Default contructor called by SshConnector. |
Method Summary | |
void |
addChannelFactory(ChannelFactory factory)
Installs a custom channel factory so that the client may respond to channel open requests. |
void |
addRequestHandler(GlobalRequestHandler handler)
Installs a global request handler so that the client may respond to global requests. |
int |
authenticate(SshAuthentication auth)
Authenticate the user. |
boolean |
cancelRemoteForwarding(java.lang.String bindAddress,
int bindPort)
Cancel a forwarding request. |
void |
connect(SshTransport io,
SshContext context,
SshConnector connector,
java.lang.String username,
java.lang.String localIdentification,
java.lang.String remoteIdentification,
boolean buffered)
Connect to an SSH server. |
void |
disconnect()
Disconnect from the remote computer. |
SshClient |
duplicate()
Create an identical version of an SshClient using cached authentication information and the SshTransport duplicate method. |
void |
forceKeyExchange()
The SSH transport protocol exchanges keys at the beginning of the session; the specification recommends that these keys be re-exchanged after each gigabyte of transmitted data or after each hour of connection time, whichever comes sooner. |
java.lang.String[] |
getAuthenticationMethods(java.lang.String username)
Get a list of authentication methods for the user. |
int |
getChannelCount()
Get the number of active channels. |
java.lang.String |
getCipherInUseCS()
Get the cipher algorithm used to encrypt data sent to the server. |
java.lang.String |
getCipherInUseSC()
Get the cipher algorithm used to decrypt data received from the server. |
java.lang.String |
getCompressionInUseCS()
Get the compression algorithm used to compress the clients outgoing data. |
java.lang.String |
getCompressionInUseSC()
Get the compression algorithm used to decompress the servers data. |
SshContext |
getContext()
Get the context that created this client. |
java.lang.String |
getHostKeyInUse()
Returns the host key algorithm used in the last key exchange. |
java.lang.String |
getKeyExchangeInUse()
Returns the key exchange algorithm last used. |
java.lang.String |
getMacInUseCS()
Get the MAC algorithm used to verify data sent by the client. |
java.lang.String |
getMacInUseSC()
Get the MAC algorithm used to verify data sent by the server. |
java.lang.String |
getRemoteIdentification()
Returns the identification string supplied by the server during protocol negotiation. |
java.lang.String |
getUsername()
Return the username used for this connection |
int |
getVersion()
Returns the version for this client. |
boolean |
isAuthenticated()
Evaluate whether the user has been authenticated. |
boolean |
isBuffered()
Identifies whether this client is in buffered mode |
boolean |
isConnected()
Evaluate whether the connection is still alive. |
void |
openChannel(Ssh2Channel channel,
byte[] requestdata)
Additional method to open a custom SSH2 channel. |
void |
openChannel(com.maverick.ssh.message.SshAbstractChannel channel)
Additional method to open a custom SSH2 channel. |
SshTunnel |
openForwardingChannel(java.lang.String hostname,
int port,
java.lang.String listeningAddress,
int listeningPort,
java.lang.String originatingHost,
int originatingPort,
SshTransport transport,
ChannelEventListener listener)
Open a TCPIP forwarding channel to the remote computer. |
SshClient |
openRemoteClient(java.lang.String hostname,
int port,
java.lang.String username)
Open up an SSH client from the remote machine to another remote server. |
SshClient |
openRemoteClient(java.lang.String hostname,
int port,
java.lang.String username,
SshConnector con)
Open up an SSH client from the remote machine to another remote server. |
SshSession |
openSessionChannel()
Open a session on the remote computer. |
SshSession |
openSessionChannel(ChannelEventListener listener)
Open a session on the remote computer. |
Ssh2Session |
openSessionChannel(int windowspace,
int packetsize,
ChannelEventListener listener)
Addtional method to open a session with SSH2 specific features. |
boolean |
requestRemoteForwarding(java.lang.String bindAddress,
int bindPort,
java.lang.String hostToConnect,
int portToConnect,
ForwardingRequestListener listener)
Requests that the remote computer accepts socket connections and forward them to the local computer. |
boolean |
sendGlobalRequest(GlobalRequest request,
boolean wantreply)
Sends a global request to the remote side. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Ssh2Client()
Method Detail |
public void connect(SshTransport io, SshContext context, SshConnector connector, java.lang.String username, java.lang.String localIdentification, java.lang.String remoteIdentification, boolean buffered) throws SshException
SshClient
connect
in interface SshClient
io
- the transport layercontext
- an SSH contextusername
- the users namelocalIdentification
- the local identification stringremoteIdentification
- the remotes identification stringbuffered
- should the connection be buffered (threaded)
SshException
public java.lang.String[] getAuthenticationMethods(java.lang.String username) throws SshException
username
- the name of the user
SshException
public int authenticate(SshAuthentication auth) throws SshException
SshClient
Authenticate the user. Once connected call to authenticate the user. When a connection is made no other operations can be performed until the user has been authenticated.
authenticate
in interface SshClient
auth
- the authentication mechanism.
SshException
PasswordAuthentication
public boolean isAuthenticated()
SshClient
true
immediatley
after connection. No other operations can be perform until the user has been
authenticated.
isAuthenticated
in interface SshClient
true
if the connection is authenticated, otherwise false
public void disconnect()
SshClient
disconnect
in interface SshClient
public boolean isConnected()
SshClient
isConnected
in interface SshClient
true
if connected, otherwise false
public void forceKeyExchange() throws SshException
SshException
public SshSession openSessionChannel() throws SshException, ChannelOpenException
SshClient
Open a session on the remote computer. This can only be called once the user has been authenticated. The session returned is uninitialized and will be opened when either a command is executed or the users shell has been started.
openSessionChannel
in interface SshClient
SshException
ChannelOpenException
public SshSession openSessionChannel(ChannelEventListener listener) throws SshException, ChannelOpenException
SshClient
Open a session on the remote computer. This can only be called once the user has been authenticated. The session returned is uninitialized and will be opened when either a command is executed or the users shell has been started.
openSessionChannel
in interface SshClient
listener
- an event listener to add before opening
SshException
ChannelOpenException
public Ssh2Session openSessionChannel(int windowspace, int packetsize, ChannelEventListener listener) throws ChannelOpenException, SshException
windowspace
- the initial/maximum amount of window space availablepacketsize
- the maximim packet sizelistener
- an event listener to add before opening
SshException
ChannelOpenException
public SshClient openRemoteClient(java.lang.String hostname, int port, java.lang.String username, SshConnector con) throws SshException, ChannelOpenException
SshClient
SshClient
instance to any other machine on the
same network.
openRemoteClient
in interface SshClient
hostname
- the name of the remote hostport
- the port of the remote hostusername
- the name of the user on the remote hostcon
- an SshConnector
instance that will be used to connect
the client. This does not have to be the same instance that created
this client.
SshException
ChannelOpenException
public SshClient openRemoteClient(java.lang.String hostname, int port, java.lang.String username) throws SshException, ChannelOpenException
SshClient
SshClient
instance to any other machine on the
same network.
openRemoteClient
in interface SshClient
hostname
- the name of the remote hostport
- the port of the remote hostusername
- the name of the user on the remote host
ChannelOpenException
SshException
public SshTunnel openForwardingChannel(java.lang.String hostname, int port, java.lang.String listeningAddress, int listeningPort, java.lang.String originatingHost, int originatingPort, SshTransport transport, ChannelEventListener listener) throws SshException, ChannelOpenException
SshClient
Open a TCPIP forwarding channel to the remote computer. If successful the remote computer will open a socket to the host/port specified and return a channel which can be used to forward TCPIP data from the local computer to the remotley connected socket.
It should be noted that this is a low level API method and it does not connect the transport to the channel as this would require some threading. The transport is passed here so that it can be attached to the SshTunnel that is returned. If you want to have the API automatically connect the channel to the transport you should use the ForwardingClient which provides management of forwarding connections and threads.
openForwardingChannel
in interface SshClient
hostname
- the host to connect toport
- the port to connect tooriginatingHost
- the originating host (informational only)originatingPort
- the originating port (informational only)transport
- listener
- an event listener that will be added to the channel before opening.
SshException
ChannelOpenException
public boolean requestRemoteForwarding(java.lang.String bindAddress, int bindPort, java.lang.String hostToConnect, int portToConnect, ForwardingRequestListener listener) throws SshException
SshClient
requestRemoteForwarding
in interface SshClient
bindAddress
- the address that the remote computer should listen onbindPort
- the port that the remote computer should listen onhostToConnect
- the host to connect when a connection is establishedportToConnect
- the port to connect when a connection is establishedlistener
- a callback interface
SshException
public boolean cancelRemoteForwarding(java.lang.String bindAddress, int bindPort) throws SshException
SshClient
cancelRemoteForwarding
in interface SshClient
bindAddress
- the address that the remote computer is listening on.bindPort
- the port that the remote computer is listening on.
SshException
public void openChannel(Ssh2Channel channel, byte[] requestdata) throws SshException, ChannelOpenException
channel
- the channel to openrequestdata
- the request data
SshException
ChannelOpenException
public void openChannel(com.maverick.ssh.message.SshAbstractChannel channel) throws SshException, ChannelOpenException
channel
- the channel to open
SshException
ChannelOpenException
public void addChannelFactory(ChannelFactory factory) throws SshException
factory
- the channel factory
SshException
public SshContext getContext()
SshClient
getContext
in interface SshClient
public void addRequestHandler(GlobalRequestHandler handler) throws SshException
handler
- the global request handler
SshException
public boolean sendGlobalRequest(GlobalRequest request, boolean wantreply) throws SshException
request
- the global requestwantreply
- specifies whether the remote side should send a success/failure message
true
if the request succeeded and wantreply=true, otherwise false
SshException
public java.lang.String getRemoteIdentification()
SshClient
getRemoteIdentification
in interface SshClient
public java.lang.String getUsername()
SshClient
getUsername
in interface SshClient
public SshClient duplicate() throws SshException
SshClient
duplicate
in interface SshClient
SshException
public int getChannelCount()
SshClient
getChannelCount
in interface SshClient
public int getVersion()
SshClient
getVersion
in interface SshClient
public boolean isBuffered()
SshClient
isBuffered
in interface SshClient
public java.lang.String getKeyExchangeInUse()
public java.lang.String getHostKeyInUse()
public java.lang.String getCipherInUseCS()
public java.lang.String getCipherInUseSC()
public java.lang.String getMacInUseCS()
public java.lang.String getMacInUseSC()
public java.lang.String getCompressionInUseCS()
public java.lang.String getCompressionInUseSC()
public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |