aboutsummaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
Diffstat (limited to 'examples')
-rw-r--r--examples/Basic.java87
-rw-r--r--examples/BasicWithHTTPProxy.java98
-rw-r--r--examples/PortForwarding.java114
-rw-r--r--examples/PublicKeyAuthentication.java77
-rw-r--r--examples/SimpleVerifier.java56
-rw-r--r--examples/SingleThreadStdoutStderr.java138
-rw-r--r--examples/StdoutAndStderr.java86
-rw-r--r--examples/SwingShell.java788
-rw-r--r--examples/UsingKnownHosts.java84
9 files changed, 1528 insertions, 0 deletions
diff --git a/examples/Basic.java b/examples/Basic.java
new file mode 100644
index 0000000..99de4e3
--- /dev/null
+++ b/examples/Basic.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.Session;
+import ch.ethz.ssh2.StreamGobbler;
+
+public class Basic
+{
+ public static void main(String[] args)
+ {
+ String hostname = "127.0.0.1";
+ String username = "joe";
+ String password = "joespass";
+
+ try
+ {
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* Now connect */
+
+ conn.connect();
+
+ /* Authenticate.
+ * If you get an IOException saying something like
+ * "Authentication method password not supported by the server at this stage."
+ * then please check the FAQ.
+ */
+
+ boolean isAuthenticated = conn.authenticateWithPassword(username, password);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* Create a session */
+
+ Session sess = conn.openSession();
+
+ sess.execCommand("uname -a && date && uptime && who");
+
+ System.out.println("Here is some information about the remote host:");
+
+ /*
+ * This basic example does not handle stderr, which is sometimes dangerous
+ * (please read the FAQ).
+ */
+
+ InputStream stdout = new StreamGobbler(sess.getStdout());
+
+ BufferedReader br = new BufferedReader(new InputStreamReader(stdout));
+
+ while (true)
+ {
+ String line = br.readLine();
+ if (line == null)
+ break;
+ System.out.println(line);
+ }
+
+ /* Show exit status, if available (otherwise "null") */
+
+ System.out.println("ExitCode: " + sess.getExitStatus());
+
+ /* Close this session */
+
+ sess.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}
diff --git a/examples/BasicWithHTTPProxy.java b/examples/BasicWithHTTPProxy.java
new file mode 100644
index 0000000..8c34ec8
--- /dev/null
+++ b/examples/BasicWithHTTPProxy.java
@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.HTTPProxyData;
+import ch.ethz.ssh2.Session;
+import ch.ethz.ssh2.StreamGobbler;
+
+public class BasicWithHTTPProxy
+{
+ public static void main(String[] args)
+ {
+ String hostname = "my-ssh-server";
+ String username = "joe";
+ String password = "joespass";
+
+ String proxyHost = "192.168.1.1";
+ int proxyPort = 3128; // default port used by squid
+
+ try
+ {
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* We want to connect through a HTTP proxy */
+
+ conn.setProxyData(new HTTPProxyData(proxyHost, proxyPort));
+
+ // if the proxy requires basic authentication:
+ // conn.setProxyData(new HTTPProxyData(proxyHost, proxyPort, "username", "secret"));
+
+ /* Now connect (through the proxy) */
+
+ conn.connect();
+
+ /* Authenticate.
+ * If you get an IOException saying something like
+ * "Authentication method password not supported by the server at this stage."
+ * then please check the FAQ.
+ */
+
+ boolean isAuthenticated = conn.authenticateWithPassword(username, password);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* Create a session */
+
+ Session sess = conn.openSession();
+
+ sess.execCommand("uname -a && date && uptime && who");
+
+ System.out.println("Here is some information about the remote host:");
+
+ /*
+ * This basic example does not handle stderr, which is sometimes dangerous
+ * (please read the FAQ).
+ */
+
+ InputStream stdout = new StreamGobbler(sess.getStdout());
+
+ BufferedReader br = new BufferedReader(new InputStreamReader(stdout));
+
+ while (true)
+ {
+ String line = br.readLine();
+ if (line == null)
+ break;
+ System.out.println(line);
+ }
+
+ /* Show exit status, if available (otherwise "null") */
+
+ System.out.println("ExitCode: " + sess.getExitStatus());
+
+ /* Close this session */
+
+ sess.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}
diff --git a/examples/PortForwarding.java b/examples/PortForwarding.java
new file mode 100644
index 0000000..cb6d8d5
--- /dev/null
+++ b/examples/PortForwarding.java
@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.File;
+import java.io.IOException;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.LocalPortForwarder;
+
+public class PortForwarding
+{
+ public static void sleepSomeTime(long milliSeconds)
+ {
+ try
+ {
+ Thread.sleep(milliSeconds);
+ }
+ catch (InterruptedException e)
+ {
+ }
+ }
+
+ public static void main(String[] args)
+ {
+ String hostname = "127.0.0.1";
+ String username = "joe";
+
+ File keyfile = new File("~/.ssh/id_rsa"); // or "~/.ssh/id_dsa"
+ String keyfilePass = "joespass"; // will be ignored if not needed
+
+ try
+ {
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* Now connect */
+
+ conn.connect();
+
+ /* Authenticate */
+
+ boolean isAuthenticated = conn.authenticateWithPublicKey(username, keyfile, keyfilePass);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* ===== OK, now let's establish some local port forwardings ===== */
+
+ /* Example Port Forwarding: -L 8080:www.ethz.ch:80 (OpenSSH notation)
+ *
+ * This works by allocating a socket to listen on 8080 on the local interface (127.0.0.1).
+ * Whenever a connection is made to this port (127.0.0.1:8080), the connection is forwarded
+ * over the secure channel, and a connection is made to www.ethz.ch:80 from the remote
+ * machine (i.e., the ssh server).
+ *
+ * (the above text is based partially on the OpenSSH man page)
+ */
+
+ /* You can create as many of them as you want */
+
+ LocalPortForwarder lpf1 = conn.createLocalPortForwarder(8080, "www.ethz.ch", 80);
+
+ /* Now simply point your webbrowser to 127.0.0.1:8080 */
+ /* (on the host where you execute this program) */
+
+ /* ===== OK, now let's establish some remote port forwardings ===== */
+
+ /* Example Port Forwarding: -R 127.0.0.1:8080:www.ganymed.ethz.ch:80 (OpenSSH notation)
+ *
+ * Specifies that the port 127.0.0.1:8080 on the remote server is to be forwarded to the
+ * given host and port on the local side. This works by allocating a socket to listen to port
+ * 8080 on the remote side (the ssh server), and whenever a connection is made to this port, the
+ * connection is forwarded over the secure channel, and a connection is made to
+ * www.ganymed.ethz.ch:80 by the Ganymed SSH-2 library.
+ *
+ * (the above text is based partially on the OpenSSH man page)
+ */
+
+ /* You can create as many of them as you want */
+
+ conn.requestRemotePortForwarding("127.0.0.1", 8080, "www.ganymed.ethz.ch", 80);
+
+ /* Now, on the ssh server, if you connect to 127.0.0.1:8080, then the connection is forwarded
+ * through the secure tunnel to the library, which in turn will forward the connection
+ * to www.ganymed.ethz.ch:80. */
+
+ /* Sleep a bit... (30 seconds) */
+ sleepSomeTime(30000);
+
+ /* Stop accepting remote connections that are being forwarded to www.ganymed.ethz.ch:80 */
+
+ conn.cancelRemotePortForwarding(8080);
+
+ /* Sleep a bit... (20 seconds) */
+ sleepSomeTime(20000);
+
+ /* Stop accepting connections on 127.0.0.1:8080 that are being forwarded to www.ethz.ch:80 */
+
+ lpf1.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}
diff --git a/examples/PublicKeyAuthentication.java b/examples/PublicKeyAuthentication.java
new file mode 100644
index 0000000..e6649fa
--- /dev/null
+++ b/examples/PublicKeyAuthentication.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.Session;
+import ch.ethz.ssh2.StreamGobbler;
+
+public class PublicKeyAuthentication
+{
+ public static void main(String[] args)
+ {
+ String hostname = "127.0.0.1";
+ String username = "joe";
+
+ File keyfile = new File("~/.ssh/id_rsa"); // or "~/.ssh/id_dsa"
+ String keyfilePass = "joespass"; // will be ignored if not needed
+
+ try
+ {
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* Now connect */
+
+ conn.connect();
+
+ /* Authenticate */
+
+ boolean isAuthenticated = conn.authenticateWithPublicKey(username, keyfile, keyfilePass);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* Create a session */
+
+ Session sess = conn.openSession();
+
+ sess.execCommand("uname -a && date && uptime && who");
+
+ InputStream stdout = new StreamGobbler(sess.getStdout());
+
+ BufferedReader br = new BufferedReader(new InputStreamReader(stdout));
+
+ System.out.println("Here is some information about the remote host:");
+
+ while (true)
+ {
+ String line = br.readLine();
+ if (line == null)
+ break;
+ System.out.println(line);
+ }
+
+ /* Close this session */
+
+ sess.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}
diff --git a/examples/SimpleVerifier.java b/examples/SimpleVerifier.java
new file mode 100644
index 0000000..6ce67a2
--- /dev/null
+++ b/examples/SimpleVerifier.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import ch.ethz.ssh2.KnownHosts;
+import ch.ethz.ssh2.ServerHostKeyVerifier;
+
+class SimpleVerifier implements ServerHostKeyVerifier
+{
+ KnownHosts database;
+
+ /*
+ * This class is being used by the UsingKnownHosts.java example.
+ */
+
+ public SimpleVerifier(KnownHosts database)
+ {
+ if (database == null)
+ throw new IllegalArgumentException();
+
+ this.database = database;
+ }
+
+ public boolean verifyServerHostKey(String hostname, int port, String serverHostKeyAlgorithm, byte[] serverHostKey)
+ throws Exception
+ {
+ int result = database.verifyHostkey(hostname, serverHostKeyAlgorithm, serverHostKey);
+
+ switch (result)
+ {
+ case KnownHosts.HOSTKEY_IS_OK:
+
+ return true; // We are happy
+
+ case KnownHosts.HOSTKEY_IS_NEW:
+
+ // Unknown host? Blindly accept the key and put it into the cache.
+ // Well, you definitely can do better (e.g., ask the user).
+
+ // The following call will ONLY put the key into the memory cache!
+ // To save it in a known hosts file, also call "KnownHosts.addHostkeyToFile(...)"
+ database.addHostkey(new String[] { hostname }, serverHostKeyAlgorithm, serverHostKey);
+
+ return true;
+
+ case KnownHosts.HOSTKEY_HAS_CHANGED:
+
+ // Close the connection if the hostkey has changed.
+ // Better: ask user and add new key to database.
+ return false;
+
+ default:
+ throw new IllegalStateException();
+ }
+ }
+} \ No newline at end of file
diff --git a/examples/SingleThreadStdoutStderr.java b/examples/SingleThreadStdoutStderr.java
new file mode 100644
index 0000000..10a4d96
--- /dev/null
+++ b/examples/SingleThreadStdoutStderr.java
@@ -0,0 +1,138 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.IOException;
+import java.io.InputStream;
+
+import ch.ethz.ssh2.ChannelCondition;
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.Session;
+
+public class SingleThreadStdoutStderr
+{
+ public static void main(String[] args)
+ {
+ String hostname = "127.0.0.1";
+ String username = "joe";
+ String password = "joespass";
+
+ try
+ {
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* Now connect */
+
+ conn.connect();
+
+ /* Authenticate */
+
+ boolean isAuthenticated = conn.authenticateWithPassword(username, password);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* Create a session */
+
+ Session sess = conn.openSession();
+
+ sess.execCommand("echo \"Huge amounts of text on STDOUT\"; echo \"Huge amounts of text on STDERR\" >&2");
+
+ /*
+ * Advanced:
+ * The following is a demo on how one can read from stdout and
+ * stderr without having to use two parallel worker threads (i.e.,
+ * we don't use the Streamgobblers here) and at the same time not
+ * risking a deadlock (due to a filled SSH2 channel window, caused
+ * by the stream which you are currently NOT reading from =).
+ */
+
+ /* Don't wrap these streams and don't let other threads work on
+ * these streams while you work with Session.waitForCondition()!!!
+ */
+
+ InputStream stdout = sess.getStdout();
+ InputStream stderr = sess.getStderr();
+
+ byte[] buffer = new byte[8192];
+
+ while (true)
+ {
+ if ((stdout.available() == 0) && (stderr.available() == 0))
+ {
+ /* Even though currently there is no data available, it may be that new data arrives
+ * and the session's underlying channel is closed before we call waitForCondition().
+ * This means that EOF and STDOUT_DATA (or STDERR_DATA, or both) may
+ * be set together.
+ */
+
+ int conditions = sess.waitForCondition(ChannelCondition.STDOUT_DATA | ChannelCondition.STDERR_DATA
+ | ChannelCondition.EOF, 2000);
+
+ /* Wait no longer than 2 seconds (= 2000 milliseconds) */
+
+ if ((conditions & ChannelCondition.TIMEOUT) != 0)
+ {
+ /* A timeout occured. */
+ throw new IOException("Timeout while waiting for data from peer.");
+ }
+
+ /* Here we do not need to check separately for CLOSED, since CLOSED implies EOF */
+
+ if ((conditions & ChannelCondition.EOF) != 0)
+ {
+ /* The remote side won't send us further data... */
+
+ if ((conditions & (ChannelCondition.STDOUT_DATA | ChannelCondition.STDERR_DATA)) == 0)
+ {
+ /* ... and we have consumed all data in the local arrival window. */
+ break;
+ }
+ }
+
+ /* OK, either STDOUT_DATA or STDERR_DATA (or both) is set. */
+
+ // You can be paranoid and check that the library is not going nuts:
+ // if ((conditions & (ChannelCondition.STDOUT_DATA | ChannelCondition.STDERR_DATA)) == 0)
+ // throw new IllegalStateException("Unexpected condition result (" + conditions + ")");
+ }
+
+ /* If you below replace "while" with "if", then the way the output appears on the local
+ * stdout and stder streams is more "balanced". Addtionally reducing the buffer size
+ * will also improve the interleaving, but performance will slightly suffer.
+ * OKOK, that all matters only if you get HUGE amounts of stdout and stderr data =)
+ */
+
+ while (stdout.available() > 0)
+ {
+ int len = stdout.read(buffer);
+ if (len > 0) // this check is somewhat paranoid
+ System.out.write(buffer, 0, len);
+ }
+
+ while (stderr.available() > 0)
+ {
+ int len = stderr.read(buffer);
+ if (len > 0) // this check is somewhat paranoid
+ System.err.write(buffer, 0, len);
+ }
+ }
+
+ /* Close this session */
+
+ sess.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}
diff --git a/examples/StdoutAndStderr.java b/examples/StdoutAndStderr.java
new file mode 100644
index 0000000..f4cb9bb
--- /dev/null
+++ b/examples/StdoutAndStderr.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.Session;
+import ch.ethz.ssh2.StreamGobbler;
+
+public class StdoutAndStderr
+{
+ public static void main(String[] args)
+ {
+ String hostname = "127.0.0.1";
+ String username = "joe";
+ String password = "joespass";
+
+ try
+ {
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* Now connect */
+
+ conn.connect();
+
+ /* Authenticate */
+
+ boolean isAuthenticated = conn.authenticateWithPassword(username, password);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* Create a session */
+
+ Session sess = conn.openSession();
+
+ sess.execCommand("echo \"Text on STDOUT\"; echo \"Text on STDERR\" >&2");
+
+ InputStream stdout = new StreamGobbler(sess.getStdout());
+ InputStream stderr = new StreamGobbler(sess.getStderr());
+
+ BufferedReader stdoutReader = new BufferedReader(new InputStreamReader(stdout));
+ BufferedReader stderrReader = new BufferedReader(new InputStreamReader(stderr));
+
+ System.out.println("Here is the output from stdout:");
+
+ while (true)
+ {
+ String line = stdoutReader.readLine();
+ if (line == null)
+ break;
+ System.out.println(line);
+ }
+
+ System.out.println("Here is the output from stderr:");
+
+ while (true)
+ {
+ String line = stderrReader.readLine();
+ if (line == null)
+ break;
+ System.out.println(line);
+ }
+
+ /* Close this session */
+
+ sess.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}
diff --git a/examples/SwingShell.java b/examples/SwingShell.java
new file mode 100644
index 0000000..12554cf
--- /dev/null
+++ b/examples/SwingShell.java
@@ -0,0 +1,788 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.FlowLayout;
+import java.awt.Font;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.KeyAdapter;
+import java.awt.event.KeyEvent;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import javax.swing.BoxLayout;
+import javax.swing.JButton;
+import javax.swing.JDialog;
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.JPasswordField;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+import javax.swing.SwingUtilities;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.InteractiveCallback;
+import ch.ethz.ssh2.KnownHosts;
+import ch.ethz.ssh2.ServerHostKeyVerifier;
+import ch.ethz.ssh2.Session;
+
+/**
+ *
+ * This is a very primitive SSH-2 dumb terminal (Swing based).
+ *
+ * The purpose of this class is to demonstrate:
+ *
+ * - Verifying server hostkeys with an existing known_hosts file
+ * - Displaying fingerprints of server hostkeys
+ * - Adding a server hostkey to a known_hosts file (+hashing the hostname for security)
+ * - Authentication with DSA, RSA, password and keyboard-interactive methods
+ *
+ */
+public class SwingShell
+{
+
+ /*
+ * NOTE: to get this feature to work, replace the "tilde" with your home directory,
+ * at least my JVM does not understand it. Need to check the specs.
+ */
+
+ static final String knownHostPath = "~/.ssh/known_hosts";
+ static final String idDSAPath = "~/.ssh/id_dsa";
+ static final String idRSAPath = "~/.ssh/id_rsa";
+
+ JFrame loginFrame = null;
+ JLabel hostLabel;
+ JLabel userLabel;
+ JTextField hostField;
+ JTextField userField;
+ JButton loginButton;
+
+ KnownHosts database = new KnownHosts();
+
+ public SwingShell()
+ {
+ File knownHostFile = new File(knownHostPath);
+ if (knownHostFile.exists())
+ {
+ try
+ {
+ database.addHostkeys(knownHostFile);
+ }
+ catch (IOException e)
+ {
+ }
+ }
+ }
+
+ /**
+ * This dialog displays a number of text lines and a text field.
+ * The text field can either be plain text or a password field.
+ */
+ class EnterSomethingDialog extends JDialog
+ {
+ private static final long serialVersionUID = 1L;
+
+ JTextField answerField;
+ JPasswordField passwordField;
+
+ final boolean isPassword;
+
+ String answer;
+
+ public EnterSomethingDialog(JFrame parent, String title, String content, boolean isPassword)
+ {
+ this(parent, title, new String[] { content }, isPassword);
+ }
+
+ public EnterSomethingDialog(JFrame parent, String title, String[] content, boolean isPassword)
+ {
+ super(parent, title, true);
+
+ this.isPassword = isPassword;
+
+ JPanel pan = new JPanel();
+ pan.setLayout(new BoxLayout(pan, BoxLayout.Y_AXIS));
+
+ for (int i = 0; i < content.length; i++)
+ {
+ if ((content[i] == null) || (content[i] == ""))
+ continue;
+ JLabel contentLabel = new JLabel(content[i]);
+ pan.add(contentLabel);
+
+ }
+
+ answerField = new JTextField(20);
+ passwordField = new JPasswordField(20);
+
+ if (isPassword)
+ pan.add(passwordField);
+ else
+ pan.add(answerField);
+
+ KeyAdapter kl = new KeyAdapter()
+ {
+ public void keyTyped(KeyEvent e)
+ {
+ if (e.getKeyChar() == '\n')
+ finish();
+ }
+ };
+
+ answerField.addKeyListener(kl);
+ passwordField.addKeyListener(kl);
+
+ getContentPane().add(BorderLayout.CENTER, pan);
+
+ setResizable(false);
+ pack();
+ setLocationRelativeTo(null);
+ }
+
+ private void finish()
+ {
+ if (isPassword)
+ answer = new String(passwordField.getPassword());
+ else
+ answer = answerField.getText();
+
+ dispose();
+ }
+ }
+
+ /**
+ * TerminalDialog is probably the worst terminal emulator ever written - implementing
+ * a real vt100 is left as an exercise to the reader, i.e., to you =)
+ *
+ */
+ class TerminalDialog extends JDialog
+ {
+ private static final long serialVersionUID = 1L;
+
+ JPanel botPanel;
+ JButton logoffButton;
+ JTextArea terminalArea;
+
+ Session sess;
+ InputStream in;
+ OutputStream out;
+
+ int x, y;
+
+ /**
+ * This thread consumes output from the remote server and displays it in
+ * the terminal window.
+ *
+ */
+ class RemoteConsumer extends Thread
+ {
+ char[][] lines = new char[y][];
+ int posy = 0;
+ int posx = 0;
+
+ private void addText(byte[] data, int len)
+ {
+ for (int i = 0; i < len; i++)
+ {
+ char c = (char) (data[i] & 0xff);
+
+ if (c == 8) // Backspace, VERASE
+ {
+ if (posx < 0)
+ continue;
+ posx--;
+ continue;
+ }
+
+ if (c == '\r')
+ {
+ posx = 0;
+ continue;
+ }
+
+ if (c == '\n')
+ {
+ posy++;
+ if (posy >= y)
+ {
+ for (int k = 1; k < y; k++)
+ lines[k - 1] = lines[k];
+ posy--;
+ lines[y - 1] = new char[x];
+ for (int k = 0; k < x; k++)
+ lines[y - 1][k] = ' ';
+ }
+ continue;
+ }
+
+ if (c < 32)
+ {
+ continue;
+ }
+
+ if (posx >= x)
+ {
+ posx = 0;
+ posy++;
+ if (posy >= y)
+ {
+ posy--;
+ for (int k = 1; k < y; k++)
+ lines[k - 1] = lines[k];
+ lines[y - 1] = new char[x];
+ for (int k = 0; k < x; k++)
+ lines[y - 1][k] = ' ';
+ }
+ }
+
+ if (lines[posy] == null)
+ {
+ lines[posy] = new char[x];
+ for (int k = 0; k < x; k++)
+ lines[posy][k] = ' ';
+ }
+
+ lines[posy][posx] = c;
+ posx++;
+ }
+
+ StringBuffer sb = new StringBuffer(x * y);
+
+ for (int i = 0; i < lines.length; i++)
+ {
+ if (i != 0)
+ sb.append('\n');
+
+ if (lines[i] != null)
+ {
+ sb.append(lines[i]);
+ }
+
+ }
+ setContent(sb.toString());
+ }
+
+ public void run()
+ {
+ byte[] buff = new byte[8192];
+
+ try
+ {
+ while (true)
+ {
+ int len = in.read(buff);
+ if (len == -1)
+ return;
+ addText(buff, len);
+ }
+ }
+ catch (Exception e)
+ {
+ }
+ }
+ }
+
+ public TerminalDialog(JFrame parent, String title, Session sess, int x, int y) throws IOException
+ {
+ super(parent, title, true);
+
+ this.sess = sess;
+
+ in = sess.getStdout();
+ out = sess.getStdin();
+
+ this.x = x;
+ this.y = y;
+
+ botPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
+
+ logoffButton = new JButton("Logout");
+ botPanel.add(logoffButton);
+
+ logoffButton.addActionListener(new ActionListener()
+ {
+ public void actionPerformed(ActionEvent e)
+ {
+ /* Dispose the dialog, "setVisible(true)" method will return */
+ dispose();
+ }
+ });
+
+ Font f = new Font("Monospaced", Font.PLAIN, 16);
+
+ terminalArea = new JTextArea(y, x);
+ terminalArea.setFont(f);
+ terminalArea.setBackground(Color.BLACK);
+ terminalArea.setForeground(Color.ORANGE);
+ /* This is a hack. We cannot disable the caret,
+ * since setting editable to false also changes
+ * the meaning of the TAB key - and I want to use it in bash.
+ * Again - this is a simple DEMO terminal =)
+ */
+ terminalArea.setCaretColor(Color.BLACK);
+
+ KeyAdapter kl = new KeyAdapter()
+ {
+ public void keyTyped(KeyEvent e)
+ {
+ int c = e.getKeyChar();
+
+ try
+ {
+ out.write(c);
+ }
+ catch (IOException e1)
+ {
+ }
+ e.consume();
+ }
+ };
+
+ terminalArea.addKeyListener(kl);
+
+ getContentPane().add(terminalArea, BorderLayout.CENTER);
+ getContentPane().add(botPanel, BorderLayout.PAGE_END);
+
+ setResizable(false);
+ pack();
+ setLocationRelativeTo(parent);
+
+ new RemoteConsumer().start();
+ }
+
+ public void setContent(String lines)
+ {
+ // setText is thread safe, it does not have to be called from
+ // the Swing GUI thread.
+ terminalArea.setText(lines);
+ }
+ }
+
+ /**
+ * This ServerHostKeyVerifier asks the user on how to proceed if a key cannot be found
+ * in the in-memory database.
+ *
+ */
+ class AdvancedVerifier implements ServerHostKeyVerifier
+ {
+ public boolean verifyServerHostKey(String hostname, int port, String serverHostKeyAlgorithm,
+ byte[] serverHostKey) throws Exception
+ {
+ final String host = hostname;
+ final String algo = serverHostKeyAlgorithm;
+
+ String message;
+
+ /* Check database */
+
+ int result = database.verifyHostkey(hostname, serverHostKeyAlgorithm, serverHostKey);
+
+ switch (result)
+ {
+ case KnownHosts.HOSTKEY_IS_OK:
+ return true;
+
+ case KnownHosts.HOSTKEY_IS_NEW:
+ message = "Do you want to accept the hostkey (type " + algo + ") from " + host + " ?\n";
+ break;
+
+ case KnownHosts.HOSTKEY_HAS_CHANGED:
+ message = "WARNING! Hostkey for " + host + " has changed!\nAccept anyway?\n";
+ break;
+
+ default:
+ throw new IllegalStateException();
+ }
+
+ /* Include the fingerprints in the message */
+
+ String hexFingerprint = KnownHosts.createHexFingerprint(serverHostKeyAlgorithm, serverHostKey);
+ String bubblebabbleFingerprint = KnownHosts.createBubblebabbleFingerprint(serverHostKeyAlgorithm,
+ serverHostKey);
+
+ message += "Hex Fingerprint: " + hexFingerprint + "\nBubblebabble Fingerprint: " + bubblebabbleFingerprint;
+
+ /* Now ask the user */
+
+ int choice = JOptionPane.showConfirmDialog(loginFrame, message);
+
+ if (choice == JOptionPane.YES_OPTION)
+ {
+ /* Be really paranoid. We use a hashed hostname entry */
+
+ String hashedHostname = KnownHosts.createHashedHostname(hostname);
+
+ /* Add the hostkey to the in-memory database */
+
+ database.addHostkey(new String[] { hashedHostname }, serverHostKeyAlgorithm, serverHostKey);
+
+ /* Also try to add the key to a known_host file */
+
+ try
+ {
+ KnownHosts.addHostkeyToFile(new File(knownHostPath), new String[] { hashedHostname },
+ serverHostKeyAlgorithm, serverHostKey);
+ }
+ catch (IOException ignore)
+ {
+ }
+
+ return true;
+ }
+
+ if (choice == JOptionPane.CANCEL_OPTION)
+ {
+ throw new Exception("The user aborted the server hostkey verification.");
+ }
+
+ return false;
+ }
+ }
+
+ /**
+ * The logic that one has to implement if "keyboard-interactive" autentication shall be
+ * supported.
+ *
+ */
+ class InteractiveLogic implements InteractiveCallback
+ {
+ int promptCount = 0;
+ String lastError;
+
+ public InteractiveLogic(String lastError)
+ {
+ this.lastError = lastError;
+ }
+
+ /* the callback may be invoked several times, depending on how many questions-sets the server sends */
+
+ public String[] replyToChallenge(String name, String instruction, int numPrompts, String[] prompt,
+ boolean[] echo) throws IOException
+ {
+ String[] result = new String[numPrompts];
+
+ for (int i = 0; i < numPrompts; i++)
+ {
+ /* Often, servers just send empty strings for "name" and "instruction" */
+
+ String[] content = new String[] { lastError, name, instruction, prompt[i] };
+
+ if (lastError != null)
+ {
+ /* show lastError only once */
+ lastError = null;
+ }
+
+ EnterSomethingDialog esd = new EnterSomethingDialog(loginFrame, "Keyboard Interactive Authentication",
+ content, !echo[i]);
+
+ esd.setVisible(true);
+
+ if (esd.answer == null)
+ throw new IOException("Login aborted by user");
+
+ result[i] = esd.answer;
+ promptCount++;
+ }
+
+ return result;
+ }
+
+ /* We maintain a prompt counter - this enables the detection of situations where the ssh
+ * server is signaling "authentication failed" even though it did not send a single prompt.
+ */
+
+ public int getPromptCount()
+ {
+ return promptCount;
+ }
+ }
+
+ /**
+ * The SSH-2 connection is established in this thread.
+ * If we would not use a separate thread (e.g., put this code in
+ * the event handler of the "Login" button) then the GUI would not
+ * be responsive (missing window repaints if you move the window etc.)
+ */
+ class ConnectionThread extends Thread
+ {
+ String hostname;
+ String username;
+
+ public ConnectionThread(String hostname, String username)
+ {
+ this.hostname = hostname;
+ this.username = username;
+ }
+
+ public void run()
+ {
+ Connection conn = new Connection(hostname);
+
+ try
+ {
+ /*
+ *
+ * CONNECT AND VERIFY SERVER HOST KEY (with callback)
+ *
+ */
+
+ String[] hostkeyAlgos = database.getPreferredServerHostkeyAlgorithmOrder(hostname);
+
+ if (hostkeyAlgos != null)
+ conn.setServerHostKeyAlgorithms(hostkeyAlgos);
+
+ conn.connect(new AdvancedVerifier());
+
+ /*
+ *
+ * AUTHENTICATION PHASE
+ *
+ */
+
+ boolean enableKeyboardInteractive = true;
+ boolean enableDSA = true;
+ boolean enableRSA = true;
+
+ String lastError = null;
+
+ while (true)
+ {
+ if ((enableDSA || enableRSA) && conn.isAuthMethodAvailable(username, "publickey"))
+ {
+ if (enableDSA)
+ {
+ File key = new File(idDSAPath);
+
+ if (key.exists())
+ {
+ EnterSomethingDialog esd = new EnterSomethingDialog(loginFrame, "DSA Authentication",
+ new String[] { lastError, "Enter DSA private key password:" }, true);
+ esd.setVisible(true);
+
+ boolean res = conn.authenticateWithPublicKey(username, key, esd.answer);
+
+ if (res == true)
+ break;
+
+ lastError = "DSA authentication failed.";
+ }
+ enableDSA = false; // do not try again
+ }
+
+ if (enableRSA)
+ {
+ File key = new File(idRSAPath);
+
+ if (key.exists())
+ {
+ EnterSomethingDialog esd = new EnterSomethingDialog(loginFrame, "RSA Authentication",
+ new String[] { lastError, "Enter RSA private key password:" }, true);
+ esd.setVisible(true);
+
+ boolean res = conn.authenticateWithPublicKey(username, key, esd.answer);
+
+ if (res == true)
+ break;
+
+ lastError = "RSA authentication failed.";
+ }
+ enableRSA = false; // do not try again
+ }
+
+ continue;
+ }
+
+ if (enableKeyboardInteractive && conn.isAuthMethodAvailable(username, "keyboard-interactive"))
+ {
+ InteractiveLogic il = new InteractiveLogic(lastError);
+
+ boolean res = conn.authenticateWithKeyboardInteractive(username, il);
+
+ if (res == true)
+ break;
+
+ if (il.getPromptCount() == 0)
+ {
+ // aha. the server announced that it supports "keyboard-interactive", but when
+ // we asked for it, it just denied the request without sending us any prompt.
+ // That happens with some server versions/configurations.
+ // We just disable the "keyboard-interactive" method and notify the user.
+
+ lastError = "Keyboard-interactive does not work.";
+
+ enableKeyboardInteractive = false; // do not try this again
+ }
+ else
+ {
+ lastError = "Keyboard-interactive auth failed."; // try again, if possible
+ }
+
+ continue;
+ }
+
+ if (conn.isAuthMethodAvailable(username, "password"))
+ {
+ final EnterSomethingDialog esd = new EnterSomethingDialog(loginFrame,
+ "Password Authentication",
+ new String[] { lastError, "Enter password for " + username }, true);
+
+ esd.setVisible(true);
+
+ if (esd.answer == null)
+ throw new IOException("Login aborted by user");
+
+ boolean res = conn.authenticateWithPassword(username, esd.answer);
+
+ if (res == true)
+ break;
+
+ lastError = "Password authentication failed."; // try again, if possible
+
+ continue;
+ }
+
+ throw new IOException("No supported authentication methods available.");
+ }
+
+ /*
+ *
+ * AUTHENTICATION OK. DO SOMETHING.
+ *
+ */
+
+ Session sess = conn.openSession();
+
+ int x_width = 90;
+ int y_width = 30;
+
+ sess.requestPTY("dumb", x_width, y_width, 0, 0, null);
+ sess.startShell();
+
+ TerminalDialog td = new TerminalDialog(loginFrame, username + "@" + hostname, sess, x_width, y_width);
+
+ /* The following call blocks until the dialog has been closed */
+
+ td.setVisible(true);
+
+ }
+ catch (IOException e)
+ {
+ //e.printStackTrace();
+ JOptionPane.showMessageDialog(loginFrame, "Exception: " + e.getMessage());
+ }
+
+ /*
+ *
+ * CLOSE THE CONNECTION.
+ *
+ */
+
+ conn.close();
+
+ /*
+ *
+ * CLOSE THE LOGIN FRAME - APPLICATION WILL BE EXITED (no more frames)
+ *
+ */
+
+ Runnable r = new Runnable()
+ {
+ public void run()
+ {
+ loginFrame.dispose();
+ }
+ };
+
+ SwingUtilities.invokeLater(r);
+ }
+ }
+
+ void loginPressed()
+ {
+ String hostname = hostField.getText().trim();
+ String username = userField.getText().trim();
+
+ if ((hostname.length() == 0) || (username.length() == 0))
+ {
+ JOptionPane.showMessageDialog(loginFrame, "Please fill out both fields!");
+ return;
+ }
+
+ loginButton.setEnabled(false);
+ hostField.setEnabled(false);
+ userField.setEnabled(false);
+
+ ConnectionThread ct = new ConnectionThread(hostname, username);
+
+ ct.start();
+ }
+
+ void showGUI()
+ {
+ loginFrame = new JFrame("Ganymed SSH2 SwingShell");
+
+ hostLabel = new JLabel("Hostname:");
+ userLabel = new JLabel("Username:");
+
+ hostField = new JTextField("", 20);
+ userField = new JTextField("", 10);
+
+ loginButton = new JButton("Login");
+
+ loginButton.addActionListener(new ActionListener()
+ {
+ public void actionPerformed(java.awt.event.ActionEvent e)
+ {
+ loginPressed();
+ }
+ });
+
+ JPanel loginPanel = new JPanel();
+
+ loginPanel.add(hostLabel);
+ loginPanel.add(hostField);
+ loginPanel.add(userLabel);
+ loginPanel.add(userField);
+ loginPanel.add(loginButton);
+
+ loginFrame.getRootPane().setDefaultButton(loginButton);
+
+ loginFrame.getContentPane().add(loginPanel, BorderLayout.PAGE_START);
+ //loginFrame.getContentPane().add(textArea, BorderLayout.CENTER);
+
+ loginFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
+
+ loginFrame.pack();
+ loginFrame.setResizable(false);
+ loginFrame.setLocationRelativeTo(null);
+ loginFrame.setVisible(true);
+ }
+
+ void startGUI()
+ {
+ Runnable r = new Runnable()
+ {
+ public void run()
+ {
+ showGUI();
+ }
+ };
+
+ SwingUtilities.invokeLater(r);
+
+ }
+
+ public static void main(String[] args)
+ {
+ SwingShell client = new SwingShell();
+ client.startGUI();
+ }
+}
diff --git a/examples/UsingKnownHosts.java b/examples/UsingKnownHosts.java
new file mode 100644
index 0000000..71262dd
--- /dev/null
+++ b/examples/UsingKnownHosts.java
@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
+ * Please refer to the LICENSE.txt for licensing details.
+ */
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.KnownHosts;
+import ch.ethz.ssh2.Session;
+import ch.ethz.ssh2.StreamGobbler;
+
+public class UsingKnownHosts
+{
+ static KnownHosts database = new KnownHosts();
+
+ public static void main(String[] args) throws IOException
+ {
+ String hostname = "somehost";
+ String username = "joe";
+ String password = "joespass";
+
+ File knownHosts = new File("~/.ssh/known_hosts");
+
+ try
+ {
+ /* Load known_hosts file into in-memory database */
+
+ if (knownHosts.exists())
+ database.addHostkeys(knownHosts);
+
+ /* Create a connection instance */
+
+ Connection conn = new Connection(hostname);
+
+ /* Now connect and use the SimpleVerifier */
+
+ conn.connect(new SimpleVerifier(database));
+
+ /* Authenticate */
+
+ boolean isAuthenticated = conn.authenticateWithPassword(username, password);
+
+ if (isAuthenticated == false)
+ throw new IOException("Authentication failed.");
+
+ /* Create a session */
+
+ Session sess = conn.openSession();
+
+ sess.execCommand("uname -a && date && uptime && who");
+
+ InputStream stdout = new StreamGobbler(sess.getStdout());
+ BufferedReader br = new BufferedReader(new InputStreamReader(stdout));
+
+ System.out.println("Here is some information about the remote host:");
+
+ while (true)
+ {
+ String line = br.readLine();
+ if (line == null)
+ break;
+ System.out.println(line);
+ }
+
+ /* Close this session */
+
+ sess.close();
+
+ /* Close the connection */
+
+ conn.close();
+
+ }
+ catch (IOException e)
+ {
+ e.printStackTrace(System.err);
+ System.exit(2);
+ }
+ }
+}