Package net.schmizz.sshj.transport
Interface Transport
- All Superinterfaces:
RemoteAddressProvider
,SSHPacketHandler
- All Known Implementing Classes:
TransportImpl
Transport layer of the SSH protocol.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAlgorithmsVerifier
(AlgorithmsVerifier verifier) Adds the specified verifier.void
Adds the specified verifier.void
Kill the transport in an exceptional way.void
Send a disconnection packet with reason asDisconnectReason.BY_APPLICATION
, and closes this transport.void
disconnect
(DisconnectReason reason) Send a disconnect packet with the givenreason
, and closes this transport.void
disconnect
(DisconnectReason reason, String message) Send a disconnect packet with the givenreason
andmessage
, and closes this transport.void
doKex()
Do key exchange and algorithm negotiation.getClientKeyAlgorithms
(KeyType keyType) int
Returns the version string as sent by the SSH server for identification purposes, e.g.byte[]
int
void
init
(String host, int port, InputStream in, OutputStream out) Sets the host information and the streams to be used by this transport.boolean
boolean
void
join()
Joins the thread calling this method to the transport's death.void
Joins the thread calling this method to the transport's death.void
reqService
(Service service) Request a SSH service represented by aService
instance.long
Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received.void
Informs this transport that authentication has been completed.void
setDisconnectListener
(DisconnectListener listener) Specify alistener
that will be notified upon disconnection.void
setService
(Service service) Sets the currently activeService
.void
setTimeoutMs
(int timeout) Set a timeout for methods that may block.long
Write a packet over this transport.Methods inherited from interface com.hierynomus.sshj.common.RemoteAddressProvider
getRemoteSocketAddress
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
-
Method Details
-
init
Sets the host information and the streams to be used by this transport. Identification information is exchanged with the server. ATransportException
is thrown in case of SSH protocol version incompatibility.- Parameters:
host
- server's hostnameport
- server's portin
- input stream for the connectionout
- output stream for the connection- Throws:
TransportException
- if there is an error during exchange of identification information
-
addHostKeyVerifier
Adds the specified verifier.- Parameters:
hkv
- the host key verifier
-
addAlgorithmsVerifier
Adds the specified verifier.- Parameters:
verifier
- The verifier to call with negotiated algorithms
-
doKex
Do key exchange and algorithm negotiation. This can be the initial one or for algorithm renegotiation.- Throws:
TransportException
- if there was an error during key exchange
-
getClientVersion
String getClientVersion()- Returns:
- the version string used by this client to identify itself to an SSH server, e.g. "SSHJ_3_0"
-
getConfig
Config getConfig()- Returns:
- the
Config
associated with this transport.
-
getTimeoutMs
int getTimeoutMs()- Returns:
- the timeout that is currently set for blocking operations.
-
setTimeoutMs
void setTimeoutMs(int timeout) Set a timeout for methods that may block.- Parameters:
timeout
- the timeout in milliseconds
-
getRemoteHost
String getRemoteHost()- Returns:
- the hostname to which this transport is connected.
-
getRemotePort
int getRemotePort()- Returns:
- the port number on the remote host to which this transport is connected.
-
getServerVersion
String getServerVersion()Returns the version string as sent by the SSH server for identification purposes, e.g. "OpenSSH_$version". If the transport has not yet been initialized viainit(java.lang.String, int, java.io.InputStream, java.io.OutputStream)
, it will benull
.- Returns:
- server's version string (may be
null
)
-
getSessionID
byte[] getSessionID()- Returns:
- the session identifier assigned by server
-
getService
Service getService()- Returns:
- the currently active
Service
instance.
-
reqService
Request a SSH service represented by aService
instance. A separate call tosetService(net.schmizz.sshj.Service)
is not needed.- Parameters:
service
- the SSH service to be requested- Throws:
TransportException
- if the request failed for any reason
-
setService
Sets the currently activeService
. Handling of non-transport-layer packets isdelegated
to that service. For this method to be successful, at least one service request viareqService(net.schmizz.sshj.Service)
must have been successful (not necessarily for the service being set).- Parameters:
service
- (null-ok) theService
-
isAuthenticated
boolean isAuthenticated()- Returns:
- whether the transport thinks it is authenticated.
-
setAuthenticated
void setAuthenticated()Informs this transport that authentication has been completed. This method must be called after successful authentication, so that delayed compression may become effective if applicable. -
sendUnimplemented
Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received.- Returns:
- the sequence number of the packet sent
- Throws:
TransportException
- if an error occurred sending the packet
-
isRunning
boolean isRunning()- Returns:
- whether this transport is active.
The transport is considered to be running if it has been initialized without error via
init(java.lang.String, int, java.io.InputStream, java.io.OutputStream)
and has not been disconnected.
-
join
Joins the thread calling this method to the transport's death.- Throws:
TransportException
- if the transport dies of an exception
-
join
Joins the thread calling this method to the transport's death.- Throws:
TransportException
- if the transport dies of an exception
-
disconnect
void disconnect()Send a disconnection packet with reason asDisconnectReason.BY_APPLICATION
, and closes this transport. -
disconnect
Send a disconnect packet with the givenreason
, and closes this transport.- Parameters:
reason
- reason for disconnecting
-
disconnect
Send a disconnect packet with the givenreason
andmessage
, and closes this transport.- Parameters:
reason
- the reason code for this disconnectmessage
- the text message
-
write
Write a packet over this transport. Thepayload
SSHPacket
should have 5 bytes free at the beginning to avoid a performance penalty associated with making space for header bytes (packet length, padding length).- Parameters:
payload
- theSSHPacket
containing data to send- Returns:
- sequence number of the sent packet
- Throws:
TransportException
- if an error occurred sending the packet
-
setDisconnectListener
Specify alistener
that will be notified upon disconnection.- Parameters:
listener
- Disconnect Listener to be configured
-
getDisconnectListener
DisconnectListener getDisconnectListener()- Returns:
- the current disconnect listener.
-
die
Kill the transport in an exceptional way.- Parameters:
e
- The exception that occurred.
-
getHostKeyAlgorithm
KeyAlgorithm getHostKeyAlgorithm() -
getClientKeyAlgorithms
- Throws:
TransportException
-