|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectch.ethz.ssh2.Connection
A Connection
is used to establish an encrypted TCP/IP
connection to a SSH2 server.
Typically, one
Connection
object.connect
method.openSession
,
createPortForwarder
or similar methods.close
method.
Field Summary | |
static java.lang.String |
identification
|
Constructor Summary | |
Connection(java.lang.String hostname)
Same as Connection(hostname, 22)
| |
Connection(java.lang.String hostname,
int port)
Prepares a fresh Connection object which can then be used
to establish a connection to the specified SSH2 server. |
Method Summary | |
boolean |
authenticateWithDSA(java.lang.String user,
java.lang.String pem,
java.lang.String password)
After a successful connect, one has to authenticate oneself. |
boolean |
authenticateWithKeyboardInteractive(java.lang.String user,
InteractiveCallback cb)
A wrapper that calls authenticateWithKeyboardInteractive()
with a null submethod list. |
boolean |
authenticateWithKeyboardInteractive(java.lang.String user,
java.lang.String[] submethods,
InteractiveCallback cb)
After a successful connect, one has to authenticate oneself. |
boolean |
authenticateWithPassword(java.lang.String user,
java.lang.String pass)
After a successfull connect, one has to authenticate oneself. |
void |
close()
Close the connection to the SSH2 server. |
ConnectionInfo |
connect()
Same as connect(null) . |
ConnectionInfo |
connect(ServerHostKeyVerifier verifier)
Connect to the SSH2 server and, as soon as the server has presented its host key, use the verifyServerHostKey method of the
verifier to ask for permission to proceed. |
LocalPortForwarder |
createLocalPortForwarder(int local_port,
java.lang.String host_to_connect,
int port_to_connect)
Creates a new LocalPortForwarder . |
LocalStreamForwarder |
createLocalStreamForwarder(java.lang.String host_to_connect,
int port_to_connect)
Creates a new LocalStreamForwarder . |
SCPClient |
createSCPClient()
Create a very basic SCPClient that can be used to copy
files from/to the SSH2 server. |
void |
forceKeyExchange()
Force an asynchronous key re-exchange (the call does not block). |
java.lang.String[] |
getAvailableCiphers()
Unless you know what you are doing, you will never need this. |
java.lang.String[] |
getAvailableMACs()
Unless you know what you are doing, you will never need this. |
ConnectionInfo |
getConnectionInfo()
Returns a ConnectionInfo object containing the details of
the connection. |
java.lang.String[] |
getRemainingAuthMethods(java.lang.String user)
After a successful connect, one has to authenticate oneself. |
boolean |
isAuthenticationComplete()
Determines if the authentication phase is complete. |
boolean |
isAuthenticationPartialSuccess()
Returns true if there was at least on failed authentication request and the last failed authentication request was marked with "partial success" by the server. |
boolean |
isAuthMethodAvailable(java.lang.String user,
java.lang.String method)
Checks if a specified authentication method is available. |
Session |
openSession()
Open a new session on this connection. |
void |
setClient2ServerCiphers(java.lang.String[] ciphers)
Unless you know what you are doing, you will never need this. |
void |
setClient2ServerMACs(java.lang.String[] macs)
Unless you know what you are doing, you will never need this. |
void |
setDHGexParameters(DHGexParameters dgp)
Sets the parameters for the diffie-hellman group exchange. |
void |
setServer2ClientCiphers(java.lang.String[] ciphers)
Unless you know what you are doing, you will never need this. |
void |
setServer2ClientMACs(java.lang.String[] macs)
Unless you know what you are doing, you will never need this. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String identification
Constructor Detail |
public Connection(java.lang.String hostname)
Connection(hostname, 22)
hostname
- the hostname of the SSH2 server.public Connection(java.lang.String hostname, int port)
Connection
object which can then be used
to establish a connection to the specified SSH2 server.
hostname
- the host where we later want to connect.port
- port on the server, normally 22.Method Detail |
public java.lang.String[] getRemainingAuthMethods(java.lang.String user) throws java.io.IOException
user
- A String
holding the username.
java.io.IOException
public boolean isAuthMethodAvailable(java.lang.String user, java.lang.String method) throws java.io.IOException
getRemainingAuthMethods
.
user
- A String
holding the username.method
- An authentication method name (e.g., "publickey", "password",
"keyboard-interactive") as specified by the SSH-2 standard.
java.io.IOException
public boolean isAuthenticationPartialSuccess()
public boolean isAuthenticationComplete()
true
if no further authentication steps are
needed.public boolean authenticateWithDSA(java.lang.String user, java.lang.String pem, java.lang.String password) throws java.io.IOException
true
will be
returned. If the server does not accept the request (or if further
authentication steps are needed), false
is returned and
one can retry either by using this or any other authentication method
(use the getRemainingAuthMethods
method to get a list of
the remaining possible methods).
user
- A String
holding the username.pem
- A String
containing the DSA private key of the
user in OpenSSH key format (PEM, you can't miss the
"-----BEGIN DSA PRIVATE KEY-----" tag). The string may contain
linefeeds.password
- If the PEM string is 3DES encrypted ("DES-EDE3-CBC"), then you
must specify the password. Otherwise, this argument will be
ignored and can be set to null
.
java.io.IOException
public boolean authenticateWithKeyboardInteractive(java.lang.String user, InteractiveCallback cb) throws java.io.IOException
authenticateWithKeyboardInteractive()
with a null
submethod list.
user
- A String
holding the username.cb
- An InteractiveCallback
which will be used to
determine the responses to the questions asked by the server.
java.io.IOException
public boolean authenticateWithKeyboardInteractive(java.lang.String user, java.lang.String[] submethods, InteractiveCallback cb) throws java.io.IOException
true
will be
returned. If the server does not accept the request (or if further
authentication steps are needed), false
is returned and
one can retry either by using this or any other authentication method
(use the getRemainingAuthMethods
method to get a list of
the remaining possible methods).
user
- A String
holding the username.submethods
- An array of submethod names, see
draft-ietf-secsh-auth-kbdinteract-XX. May be null
to indicate an empty list.cb
- An InteractiveCallback
which will be used to
determine the responses to the questions asked by the server.
java.io.IOException
public boolean authenticateWithPassword(java.lang.String user, java.lang.String pass) throws java.io.IOException
true
will be
returned. If the server does not accept the request (or if further
authentication steps are needed), false
is returned and
one can retry either by using this or any other authentication method
(use the getRemainingAuthMethods
method to get a list of
the remaining possible methods).
user
- pass
-
java.io.IOException
public void close()
public ConnectionInfo connect() throws java.io.IOException
connect(null)
.
connect(null)
method.
java.io.IOException
public ConnectionInfo connect(ServerHostKeyVerifier verifier) throws java.io.IOException
verifyServerHostKey
method of the
verifier
to ask for permission to proceed. Only correctly
signed host keys will be passed to the verifier
. If
verifier
is null
, then any correctly
signed host key will be accepted - this is NOT recommended, since it
makes man-in-the-middle attackes VERY easy.
verifier
- An object that implements the
ServerHostKeyVerifier
interface.
ConnectionInfo
object containg the details of
the established connection.
java.io.IOException
- If any problem occurs, e.g., the server's host key is not
correctly signed or not accepted by the verifier
.public void forceKeyExchange() throws java.io.IOException
java.io.IOException
- In case of any failure behind the scenes.public java.lang.String[] getAvailableCiphers()
public java.lang.String[] getAvailableMACs()
public ConnectionInfo getConnectionInfo() throws java.io.IOException
ConnectionInfo
object containing the details of
the connection. Can be called as soon as the connection has been
established (successfully connected).
ConnectionInfo
object.
java.io.IOException
- In case of any failure behind the scenes.public Session openSession() throws java.io.IOException
Session
object.
java.io.IOException
public SCPClient createSCPClient() throws java.io.IOException
SCPClient
that can be used to copy
files from/to the SSH2 server.
SCPClient
object.
java.io.IOException
public LocalPortForwarder createLocalPortForwarder(int local_port, java.lang.String host_to_connect, int port_to_connect) throws java.io.IOException
LocalPortForwarder
. A
LocalPortForwarder
forwards TCP/IP connections to a local
port via the secure tunnel to another host (which may or may not be
identical to the remote SSH2 server).
LocalPortForwarder
object.
java.io.IOException
public LocalStreamForwarder createLocalStreamForwarder(java.lang.String host_to_connect, int port_to_connect) throws java.io.IOException
LocalStreamForwarder
. A
LocalStreamForwarder
forwards an Input- and Outputstream
pair via the secure tunnel to another host (which may or may not be
identical to the remote SSH2 server).
LocalStreamForwarder
object.
java.io.IOException
public void setDHGexParameters(DHGexParameters dgp)
DHGexParameters
class.
dgp
- non null.public void setClient2ServerCiphers(java.lang.String[] ciphers)
ciphers
- public void setClient2ServerMACs(java.lang.String[] macs)
macs
- public void setServer2ClientCiphers(java.lang.String[] ciphers)
ciphers
- public void setServer2ClientMACs(java.lang.String[] macs)
macs
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |