com.tailf.jnc.SSHConnection Maven / Gradle / Ivy
package com.tailf.jnc;
import java.io.File;
import java.io.IOException;
import ch.ethz.ssh2.Connection;
/**
* A SSH NETCONF connection class. Can be used whenever {@link NetconfSession}
* intends to use SSH for its transport.
*
* Example:
*
*
* SSHConnection ssh = new SSHConnection("127.0.0.1", 2023);
* ssh.authenticateWithPassword("ola", "secret");
* SSHSession tr = new SSHSession(ssh);
* NetconfSession dev1 = new NetconfSession(tr);
*
*/
public class SSHConnection {
Connection connection = null;
/**
* By default we connect to the IANA registered port for NETCONF which is
* 830
*
* @param host Host or IP address to connect to
*/
public SSHConnection(String host) throws IOException, JNCException {
this(host, 830, 0);
}
/**
* This method establishes an SSH connection to a host, once the connection
* is established it must be authenticated.
*
* @param host Host name.
* @param port Port number to connect to.
*/
public SSHConnection(String host, int port) throws IOException,
JNCException {
this(host, port, 0);
}
/**
* This method establishes an SSH connection to a host, once the connection
* is established it must be authenticated.
*
* @param host Host name.
* @param port Port number to connect to.
* @param connectTimeout
*/
public SSHConnection(String host, int port, int connectTimeout)
throws IOException, JNCException {
connection = new Connection(host, port);
connection.connect(null, connectTimeout, 0);
}
/**
* This method establishes an SSH connection to a host, once the connection
* is established it must be authenticated.
*
* @param host Host name.
* @param port Port number to connect to.
* @param connectTimeout Connection timeout timer. Connect the underlying
* TCP socket to the server with the given timeout value
* (non-negative, in milliseconds). Zero means no timeout.
* @param kexTimeout Key exchange timeout timer. Timeout for complete
* connection establishment (non-negative, in milliseconds).
* Zero means no timeout. The timeout counts until the first
* key-exchange round has finished.
* @throws IOException In case of a timeout (either connectTimeout or
* kexTimeout) a SocketTimeoutException is thrown.
*
* An exception may also be thrown if the connection was
* already successfully connected (no matter if the connection
* broke in the mean time) and you invoke
* connect() again without having called
* {@link #close()} first.
*/
public SSHConnection(String host, int port, int connectTimeout,
int kexTimeout) throws IOException, JNCException {
connection = new Connection(host, port);
connection.connect(null, connectTimeout, kexTimeout);
}
/**
* @return the underlying Ganymed connection object This is required if
* wish to use the addConnectionMonitor() method in the ganymed
* Connection class.
*
*/
Connection getConnection() {
return connection;
}
/**
* This is required if wish to have access to the ganymed connection object
* outside of this package.
*
* @return the underlying Ganymed connection object
*/
public Connection getGanymedConnection() {
return connection;
}
/**
* Authenticate with regular username pass.
*
* @param user User name.
* @param password Password.
*
**/
public void authenticateWithPassword(String user, String password)
throws IOException, JNCException {
if (!connection.authenticateWithPassword(user, password)) {
throw new JNCException(JNCException.AUTH_FAILED, this);
}
}
/**
* Authenticate with the name of a file containing the private key See
* ganymed docs for full explanation, use null for password if the key
* doesn't have a passphrase.
*
* @param user User name.
* @param pemFile Fila name.
* @param password Password.
**/
public void authenticateWithPublicKeyFile(String user, File pemFile,
String password) throws IOException, JNCException {
if (!connection.authenticateWithPublicKey(user, pemFile, password)) {
throw new JNCException(JNCException.AUTH_FAILED, this);
}
}
/**
* Authenticate with a private key. See ganymed docs for full explanation,
* use null for password if the key doesn't have a passphrase.
*
* @param user User name.
* @param pemPrivateKey Private key.
* @param pass Passphrase.
**/
public void authenticateWithPublicKey(String user, char[] pemPrivateKey,
String pass) throws IOException, JNCException {
if (!connection.authenticateWithPublicKey(user, pemPrivateKey, pass)) {
throw new JNCException(JNCException.AUTH_FAILED, this);
}
}
/**
* Closes the SSH session/connection.
*/
public void close() {
connection.close();
}
}