510Connectbot: src/ch/ethz/ssh2/Connection.java annotate

author	Carl Byington <carl@five-ten-sg.com>
date	Fri, 18 Jul 2014 11:21:46 -0700
parents
children	486df527ddc5

rev	line source
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	1 /*
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	2 * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	3 * Please refer to the LICENSE.txt for licensing details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	4 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	5
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	6 package ch.ethz.ssh2;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	7
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	8 import java.io.CharArrayWriter;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	9 import java.io.File;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	10 import java.io.FileReader;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	11 import java.io.IOException;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	12 import java.net.InetSocketAddress;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	13 import java.net.Socket;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	14 import java.net.SocketTimeoutException;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	15 import java.security.SecureRandom;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	16 import java.util.ArrayList;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	17 import java.util.List;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	18 import java.util.Set;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	19
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	20 import ch.ethz.ssh2.auth.AgentProxy;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	21 import ch.ethz.ssh2.auth.AuthenticationManager;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	22 import ch.ethz.ssh2.channel.ChannelManager;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	23 import ch.ethz.ssh2.compression.CompressionFactory;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	24 import ch.ethz.ssh2.crypto.CryptoWishList;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	25 import ch.ethz.ssh2.crypto.cipher.BlockCipherFactory;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	26 import ch.ethz.ssh2.crypto.digest.MAC;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	27 import ch.ethz.ssh2.packets.PacketIgnore;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	28 import ch.ethz.ssh2.transport.ClientTransportManager;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	29 import ch.ethz.ssh2.transport.HTTPProxyClientTransportManager;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	30 import ch.ethz.ssh2.transport.KexManager;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	31 import ch.ethz.ssh2.util.TimeoutService;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	32 import ch.ethz.ssh2.util.TimeoutService.TimeoutToken;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	33
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	34 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	35 * A <code>Connection</code> is used to establish an encrypted TCP/IP
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	36 * connection to a SSH-2 server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	37 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	38 * Typically, one
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	39 * <ol>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	40 * <li>creates a {@link #Connection(String) Connection} object.</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	41 * <li>calls the {@link #connect() connect()} method.</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	42 * <li>calls some of the authentication methods (e.g., {@link #authenticateWithPublicKey(String, File, String) authenticateWithPublicKey()}).</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	43 * <li>calls one or several times the {@link #openSession() openSession()} method.</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	44 * <li>finally, one must close the connection and release resources with the {@link #close() close()} method.</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	45 * </ol>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	46 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	47 * @author Christian Plattner
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	48 * @version $Id: Connection.java 160 2014-05-01 14:30:26Z dkocher@sudo.ch $
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	49 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	50
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	51 public class Connection {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	52 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	53 * The identifier presented to the SSH-2 server. This is the same
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	54 * as the "softwareversion" defined in RFC 4253.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	55 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	56 * <b>NOTE: As per the RFC, the "softwareversion" string MUST consist of printable
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	57 * US-ASCII characters, with the exception of whitespace characters and the minus sign (-).</b>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	58 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	59 private String softwareversion
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	60 = String.format("Ganymed_%s", Version.getSpecification());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	61
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	62 /* Will be used to generate all random data needed for the current connection.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	63 * Note: SecureRandom.nextBytes() is thread safe.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	64 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	65
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	66 private SecureRandom generator;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	67
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	68 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	69 * Unless you know what you are doing, you will never need this.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	70 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	71 * @return The list of supported cipher algorithms by this implementation.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	72 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	73 public static synchronized String[] getAvailableCiphers() {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	74 return BlockCipherFactory.getDefaultCipherList();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	75 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	76
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	77 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	78 * Unless you know what you are doing, you will never need this.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	79 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	80 * @return The list of supported MAC algorthims by this implementation.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	81 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	82 public static synchronized String[] getAvailableMACs() {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	83 return MAC.getMacList();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	84 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	85
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	86 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	87 * Unless you know what you are doing, you will never need this.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	88 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	89 * @return The list of supported server host key algorthims by this implementation.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	90 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	91 public static synchronized String[] getAvailableServerHostKeyAlgorithms() {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	92 return KexManager.getDefaultServerHostkeyAlgorithmList();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	93 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	94
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	95 private AuthenticationManager am;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	96
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	97 private boolean authenticated;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	98 private ChannelManager cm;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	99
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	100 private CryptoWishList cryptoWishList
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	101 = new CryptoWishList();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	102
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	103 private DHGexParameters dhgexpara
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	104 = new DHGexParameters();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	105
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	106 private final String hostname;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	107
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	108 private final int port;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	109
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	110 private ClientTransportManager tm;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	111
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	112 private boolean tcpNoDelay = false;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	113
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	114 private HTTPProxyData proxy;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	115
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	116 private List<ConnectionMonitor> connectionMonitors
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	117 = new ArrayList<ConnectionMonitor>();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	118
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	119 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	120 * Prepares a fresh <code>Connection</code> object which can then be used
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	121 * to establish a connection to the specified SSH-2 server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	122 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	123 * Same as {@link #Connection(String, int) Connection(hostname, 22)}.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	124 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	125 * @param hostname the hostname of the SSH-2 server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	126 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	127 public Connection(String hostname) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	128 this(hostname, 22);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	129 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	130
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	131 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	132 * Prepares a fresh <code>Connection</code> object which can then be used
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	133 * to establish a connection to the specified SSH-2 server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	134 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	135 * @param hostname the host where we later want to connect to.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	136 * @param port port on the server, normally 22.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	137 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	138 public Connection(String hostname, int port) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	139 this.hostname = hostname;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	140 this.port = port;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	141 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	142
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	143 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	144 * Prepares a fresh <code>Connection</code> object which can then be used
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	145 * to establish a connection to the specified SSH-2 server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	146 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	147 * @param hostname the host where we later want to connect to.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	148 * @param port port on the server, normally 22.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	149 * @param softwareversion Allows you to set a custom "softwareversion" string as defined in RFC 4253.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	150 * <b>NOTE: As per the RFC, the "softwareversion" string MUST consist of printable
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	151 * US-ASCII characters, with the exception of whitespace characters and the minus sign (-).</b>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	152 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	153 public Connection(String hostname, int port, String softwareversion) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	154 this.hostname = hostname;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	155 this.port = port;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	156 this.softwareversion = softwareversion;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	157 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	158
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	159 public Connection(String hostname, int port, final HTTPProxyData proxy) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	160 this.hostname = hostname;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	161 this.port = port;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	162 this.proxy = proxy;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	163 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	164
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	165 public Connection(String hostname, int port, String softwareversion, final HTTPProxyData proxy) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	166 this.hostname = hostname;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	167 this.port = port;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	168 this.softwareversion = softwareversion;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	169 this.proxy = proxy;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	170 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	171
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	172 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	173 * After a successful connect, one has to authenticate oneself. This method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	174 * is based on DSA (it uses DSA to sign a challenge sent by the server).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	175 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	176 * If the authentication phase is complete, <code>true</code> will be
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	177 * returned. If the server does not accept the request (or if further
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	178 * authentication steps are needed), <code>false</code> is returned and
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	179 * one can retry either by using this or any other authentication method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	180 * (use the <code>getRemainingAuthMethods</code> method to get a list of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	181 * the remaining possible methods).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	182 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	183 * @param user A <code>String</code> holding the username.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	184 * @param pem A <code>String</code> containing the DSA private key of the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	185 * user in OpenSSH key format (PEM, you can't miss the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	186 * "-----BEGIN DSA PRIVATE KEY-----" tag). The string may contain
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	187 * linefeeds.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	188 * @param password If the PEM string is 3DES encrypted ("DES-EDE3-CBC"), then you
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	189 * must specify the password. Otherwise, this argument will be
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	190 * ignored and can be set to <code>null</code>.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	191 * @return whether the connection is now authenticated.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	192 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	193 * @deprecated You should use one of the {@link #authenticateWithPublicKey(String, File, String) authenticateWithPublicKey()}
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	194 * methods, this method is just a wrapper for it and will
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	195 * disappear in future builds.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	196 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	197 public synchronized boolean authenticateWithDSA(String user, String pem, String password) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	198 if(tm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	199 throw new IllegalStateException("Connection is not established!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	200 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	201
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	202 if(authenticated) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	203 throw new IllegalStateException("Connection is already authenticated!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	204 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	205
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	206 if(am == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	207 am = new AuthenticationManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	208 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	209
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	210 if(cm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	211 cm = new ChannelManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	212 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	213
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	214 if(user == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	215 throw new IllegalArgumentException("user argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	216 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	217
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	218 if(pem == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	219 throw new IllegalArgumentException("pem argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	220 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	221
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	222 authenticated = am.authenticatePublicKey(user, pem.toCharArray(), password, getOrCreateSecureRND());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	223
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	224 return authenticated;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	225 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	226
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	227 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	228 * A wrapper that calls {@link #authenticateWithKeyboardInteractive(String, String[], InteractiveCallback)
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	229 * authenticateWithKeyboardInteractivewith} a <code>null</code> submethod list.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	230 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	231 * @param user A <code>String</code> holding the username.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	232 * @param cb An <code>InteractiveCallback</code> which will be used to
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	233 * determine the responses to the questions asked by the server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	234 * @return whether the connection is now authenticated.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	235 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	236 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	237 public synchronized boolean authenticateWithKeyboardInteractive(String user, InteractiveCallback cb)
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	238 throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	239 return authenticateWithKeyboardInteractive(user, null, cb);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	240 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	241
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	242 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	243 * After a successful connect, one has to authenticate oneself. This method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	244 * is based on "keyboard-interactive", specified in
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	245 * draft-ietf-secsh-auth-kbdinteract-XX. Basically, you have to define a
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	246 * callback object which will be feeded with challenges generated by the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	247 * server. Answers are then sent back to the server. It is possible that the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	248 * callback will be called several times during the invocation of this
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	249 * method (e.g., if the server replies to the callback's answer(s) with
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	250 * another challenge...)
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	251 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	252 * If the authentication phase is complete, <code>true</code> will be
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	253 * returned. If the server does not accept the request (or if further
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	254 * authentication steps are needed), <code>false</code> is returned and
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	255 * one can retry either by using this or any other authentication method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	256 * (use the <code>getRemainingAuthMethods</code> method to get a list of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	257 * the remaining possible methods).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	258 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	259 * Note: some SSH servers advertise "keyboard-interactive", however, any
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	260 * interactive request will be denied (without having sent any challenge to
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	261 * the client).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	262 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	263 * @param user A <code>String</code> holding the username.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	264 * @param submethods An array of submethod names, see
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	265 * draft-ietf-secsh-auth-kbdinteract-XX. May be <code>null</code>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	266 * to indicate an empty list.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	267 * @param cb An <code>InteractiveCallback</code> which will be used to
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	268 * determine the responses to the questions asked by the server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	269 * @return whether the connection is now authenticated.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	270 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	271 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	272 public synchronized boolean authenticateWithKeyboardInteractive(String user, String[] submethods,
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	273 InteractiveCallback cb) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	274 if(cb == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	275 throw new IllegalArgumentException("Callback may not ne NULL!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	276 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	277
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	278 if(tm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	279 throw new IllegalStateException("Connection is not established!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	280 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	281
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	282 if(authenticated) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	283 throw new IllegalStateException("Connection is already authenticated!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	284 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	285
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	286 if(am == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	287 am = new AuthenticationManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	288 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	289
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	290 if(cm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	291 cm = new ChannelManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	292 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	293
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	294 if(user == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	295 throw new IllegalArgumentException("user argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	296 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	297
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	298 authenticated = am.authenticateInteractive(user, submethods, cb);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	299
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	300 return authenticated;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	301 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	302
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	303 public synchronized boolean authenticateWithAgent(String user, AgentProxy proxy) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	304 if(tm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	305 throw new IllegalStateException("Connection is not established!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	306 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	307
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	308 if(authenticated) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	309 throw new IllegalStateException("Connection is already authenticated!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	310 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	311
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	312 if(am == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	313 am = new AuthenticationManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	314 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	315
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	316 if(cm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	317 cm = new ChannelManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	318 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	319
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	320 if(user == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	321 throw new IllegalArgumentException("user argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	322 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	323
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	324 authenticated = am.authenticatePublicKey(user, proxy);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	325
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	326 return authenticated;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	327 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	328
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	329 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	330 * After a successful connect, one has to authenticate oneself. This method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	331 * sends username and password to the server.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	332 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	333 * If the authentication phase is complete, <code>true</code> will be
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	334 * returned. If the server does not accept the request (or if further
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	335 * authentication steps are needed), <code>false</code> is returned and
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	336 * one can retry either by using this or any other authentication method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	337 * (use the <code>getRemainingAuthMethods</code> method to get a list of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	338 * the remaining possible methods).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	339 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	340 * Note: if this method fails, then please double-check that it is actually
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	341 * offered by the server (use {@link #getRemainingAuthMethods(String) getRemainingAuthMethods()}.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	342 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	343 * Often, password authentication is disabled, but users are not aware of it.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	344 * Many servers only offer "publickey" and "keyboard-interactive". However,
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	345 * even though "keyboard-interactive" feels like password authentication
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	346 * (e.g., when using the putty or openssh clients) it is not the same mechanism.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	347 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	348 * @param user
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	349 * @param password
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	350 * @return if the connection is now authenticated.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	351 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	352 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	353 public synchronized boolean authenticateWithPassword(String user, String password) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	354 if(tm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	355 throw new IllegalStateException("Connection is not established!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	356 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	357
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	358 if(authenticated) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	359 throw new IllegalStateException("Connection is already authenticated!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	360 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	361
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	362 if(am == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	363 am = new AuthenticationManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	364 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	365
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	366 if(cm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	367 cm = new ChannelManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	368 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	369
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	370 if(user == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	371 throw new IllegalArgumentException("user argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	372 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	373
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	374 if(password == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	375 throw new IllegalArgumentException("password argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	376 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	377
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	378 authenticated = am.authenticatePassword(user, password);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	379
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	380 return authenticated;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	381 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	382
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	383 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	384 * After a successful connect, one has to authenticate oneself.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	385 * This method can be used to explicitly use the special "none"
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	386 * authentication method (where only a username has to be specified).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	387 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	388 * Note 1: The "none" method may always be tried by clients, however as by
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	389 * the specs, the server will not explicitly announce it. In other words,
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	390 * the "none" token will never show up in the list returned by
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	391 * {@link #getRemainingAuthMethods(String)}.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	392 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	393 * Note 2: no matter which one of the authenticateWithXXX() methods
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	394 * you call, the library will always issue exactly one initial "none"
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	395 * authentication request to retrieve the initially allowed list of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	396 * authentication methods by the server. Please read RFC 4252 for the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	397 * details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	398 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	399 * If the authentication phase is complete, <code>true</code> will be
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	400 * returned. If further authentication steps are needed, <code>false</code>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	401 * is returned and one can retry by any other authentication method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	402 * (use the <code>getRemainingAuthMethods</code> method to get a list of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	403 * the remaining possible methods).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	404 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	405 * @param user
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	406 * @return if the connection is now authenticated.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	407 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	408 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	409 public synchronized boolean authenticateWithNone(String user) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	410 if(tm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	411 throw new IllegalStateException("Connection is not established!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	412 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	413
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	414 if(authenticated) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	415 throw new IllegalStateException("Connection is already authenticated!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	416 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	417
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	418 if(am == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	419 am = new AuthenticationManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	420 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	421
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	422 if(cm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	423 cm = new ChannelManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	424 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	425
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	426 if(user == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	427 throw new IllegalArgumentException("user argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	428 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	429
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	430 /* Trigger the sending of the PacketUserauthRequestNone packet */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	431 /* (if not already done) */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	432
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	433 authenticated = am.authenticateNone(user);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	434
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	435 return authenticated;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	436 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	437
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	438 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	439 * After a successful connect, one has to authenticate oneself.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	440 * The authentication method "publickey" works by signing a challenge
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	441 * sent by the server. The signature is either DSA or RSA based - it
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	442 * just depends on the type of private key you specify, either a DSA
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	443 * or RSA private key in PEM format. And yes, this is may seem to be a
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	444 * little confusing, the method is called "publickey" in the SSH-2 protocol
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	445 * specification, however since we need to generate a signature, you
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	446 * actually have to supply a private key =).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	447 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	448 * The private key contained in the PEM file may also be encrypted ("Proc-Type: 4,ENCRYPTED").
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	449 * The library supports DES-CBC and DES-EDE3-CBC encryption, as well
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	450 * as the more exotic PEM encrpytions AES-128-CBC, AES-192-CBC and AES-256-CBC.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	451 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	452 * If the authentication phase is complete, <code>true</code> will be
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	453 * returned. If the server does not accept the request (or if further
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	454 * authentication steps are needed), <code>false</code> is returned and
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	455 * one can retry either by using this or any other authentication method
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	456 * (use the <code>getRemainingAuthMethods</code> method to get a list of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	457 * the remaining possible methods).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	458 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	459 * NOTE PUTTY USERS: Event though your key file may start with "-----BEGIN..."
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	460 * it is not in the expected format. You have to convert it to the OpenSSH
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	461 * key format by using the "puttygen" tool (can be downloaded from the Putty
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	462 * website). Simply load your key and then use the "Conversions/Export OpenSSH key"
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	463 * functionality to get a proper PEM file.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	464 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	465 * @param user A <code>String</code> holding the username.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	466 * @param pemPrivateKey A <code>char[]</code> containing a DSA or RSA private key of the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	467 * user in OpenSSH key format (PEM, you can't miss the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	468 * "-----BEGIN DSA PRIVATE KEY-----" or "-----BEGIN RSA PRIVATE KEY-----"
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	469 * tag). The char array may contain linebreaks/linefeeds.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	470 * @param password If the PEM structure is encrypted ("Proc-Type: 4,ENCRYPTED") then
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	471 * you must specify a password. Otherwise, this argument will be ignored
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	472 * and can be set to <code>null</code>.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	473 * @return whether the connection is now authenticated.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	474 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	475 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	476 public synchronized boolean authenticateWithPublicKey(String user, char[] pemPrivateKey, String password)
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	477 throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	478 if(tm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	479 throw new IllegalStateException("Connection is not established!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	480 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	481
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	482 if(authenticated) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	483 throw new IllegalStateException("Connection is already authenticated!");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	484 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	485
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	486 if(am == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	487 am = new AuthenticationManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	488 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	489
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	490 if(cm == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	491 cm = new ChannelManager(tm);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	492 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	493
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	494 if(user == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	495 throw new IllegalArgumentException("user argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	496 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	497
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	498 if(pemPrivateKey == null) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	499 throw new IllegalArgumentException("pemPrivateKey argument is null");
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	500 }

273

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1 /*

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

3 * Please refer to the LICENSE.txt for licensing details.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

4 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

5

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

6 package ch.ethz.ssh2;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

7

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

8 import java.io.CharArrayWriter;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

9 import java.io.File;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

10 import java.io.FileReader;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

11 import java.io.IOException;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

12 import java.net.InetSocketAddress;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

13 import java.net.Socket;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

14 import java.net.SocketTimeoutException;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

15 import java.security.SecureRandom;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

16 import java.util.ArrayList;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

17 import java.util.List;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

18 import java.util.Set;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

19

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

20 import ch.ethz.ssh2.auth.AgentProxy;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

21 import ch.ethz.ssh2.auth.AuthenticationManager;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

22 import ch.ethz.ssh2.channel.ChannelManager;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

23 import ch.ethz.ssh2.compression.CompressionFactory;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

24 import ch.ethz.ssh2.crypto.CryptoWishList;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

25 import ch.ethz.ssh2.crypto.cipher.BlockCipherFactory;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

26 import ch.ethz.ssh2.crypto.digest.MAC;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

27 import ch.ethz.ssh2.packets.PacketIgnore;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

28 import ch.ethz.ssh2.transport.ClientTransportManager;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

29 import ch.ethz.ssh2.transport.HTTPProxyClientTransportManager;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

30 import ch.ethz.ssh2.transport.KexManager;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

31 import ch.ethz.ssh2.util.TimeoutService;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

32 import ch.ethz.ssh2.util.TimeoutService.TimeoutToken;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

33

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

34 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

35 * A <code>Connection</code> is used to establish an encrypted TCP/IP

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

36 * connection to a SSH-2 server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

37 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

38 * Typically, one

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

39 * <ol>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

40 * <li>creates a {@link #Connection(String) Connection} object.</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

41 * <li>calls the {@link #connect() connect()} method.</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

42 * <li>calls some of the authentication methods (e.g., {@link #authenticateWithPublicKey(String, File, String) authenticateWithPublicKey()}).</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

43 * <li>calls one or several times the {@link #openSession() openSession()} method.</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

44 * <li>finally, one must close the connection and release resources with the {@link #close() close()} method.</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

45 * </ol>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

46 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

47 * @author Christian Plattner

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

48 * @version $Id: Connection.java 160 2014-05-01 14:30:26Z dkocher@sudo.ch $

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

49 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

50

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

51 public class Connection {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

52 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

53 * The identifier presented to the SSH-2 server. This is the same

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

54 * as the "softwareversion" defined in RFC 4253.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

55 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

56 * NOTE: As per the RFC, the "softwareversion" string MUST consist of printable

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

57 * US-ASCII characters, with the exception of whitespace characters and the minus sign (-).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

58 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

59 private String softwareversion

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

60 = String.format("Ganymed_%s", Version.getSpecification());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

61

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

62 /* Will be used to generate all random data needed for the current connection.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

63 * Note: SecureRandom.nextBytes() is thread safe.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

64 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

65

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

66 private SecureRandom generator;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

67

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

68 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

69 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

70 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

71 * @return The list of supported cipher algorithms by this implementation.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

72 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

73 public static synchronized String[] getAvailableCiphers() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

74 return BlockCipherFactory.getDefaultCipherList();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

75 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

76

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

77 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

78 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

79 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

80 * @return The list of supported MAC algorthims by this implementation.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

81 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

82 public static synchronized String[] getAvailableMACs() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

83 return MAC.getMacList();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

84 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

85

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

86 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

87 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

88 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

89 * @return The list of supported server host key algorthims by this implementation.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

90 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

91 public static synchronized String[] getAvailableServerHostKeyAlgorithms() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

92 return KexManager.getDefaultServerHostkeyAlgorithmList();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

93 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

94

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

95 private AuthenticationManager am;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

96

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

97 private boolean authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

98 private ChannelManager cm;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

99

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

100 private CryptoWishList cryptoWishList

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

101 = new CryptoWishList();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

102

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

103 private DHGexParameters dhgexpara

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

104 = new DHGexParameters();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

105

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

106 private final String hostname;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

107

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

108 private final int port;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

109

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

110 private ClientTransportManager tm;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

111

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

112 private boolean tcpNoDelay = false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

113

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

114 private HTTPProxyData proxy;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

115

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

116 private List<ConnectionMonitor> connectionMonitors

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

117 = new ArrayList<ConnectionMonitor>();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

118

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

119 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

120 * Prepares a fresh <code>Connection</code> object which can then be used

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

121 * to establish a connection to the specified SSH-2 server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

122 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

123 * Same as {@link #Connection(String, int) Connection(hostname, 22)}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

124 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

125 * @param hostname the hostname of the SSH-2 server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

126 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

127 public Connection(String hostname) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

128 this(hostname, 22);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

129 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

130

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

131 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

132 * Prepares a fresh <code>Connection</code> object which can then be used

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

133 * to establish a connection to the specified SSH-2 server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

134 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

135 * @param hostname the host where we later want to connect to.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

136 * @param port port on the server, normally 22.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

137 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

138 public Connection(String hostname, int port) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

139 this.hostname = hostname;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

140 this.port = port;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

141 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

142

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

143 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

144 * Prepares a fresh <code>Connection</code> object which can then be used

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

145 * to establish a connection to the specified SSH-2 server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

146 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

147 * @param hostname the host where we later want to connect to.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

148 * @param port port on the server, normally 22.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

149 * @param softwareversion Allows you to set a custom "softwareversion" string as defined in RFC 4253.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

150 * NOTE: As per the RFC, the "softwareversion" string MUST consist of printable

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

151 * US-ASCII characters, with the exception of whitespace characters and the minus sign (-).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

152 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

153 public Connection(String hostname, int port, String softwareversion) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

154 this.hostname = hostname;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

155 this.port = port;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

156 this.softwareversion = softwareversion;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

157 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

158

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

159 public Connection(String hostname, int port, final HTTPProxyData proxy) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

160 this.hostname = hostname;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

161 this.port = port;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

162 this.proxy = proxy;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

163 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

164

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

165 public Connection(String hostname, int port, String softwareversion, final HTTPProxyData proxy) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

166 this.hostname = hostname;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

167 this.port = port;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

168 this.softwareversion = softwareversion;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

169 this.proxy = proxy;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

170 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

171

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

172 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

173 * After a successful connect, one has to authenticate oneself. This method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

174 * is based on DSA (it uses DSA to sign a challenge sent by the server).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

175 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

176 * If the authentication phase is complete, <code>true</code> will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

177 * returned. If the server does not accept the request (or if further

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

178 * authentication steps are needed), <code>false</code> is returned and

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

179 * one can retry either by using this or any other authentication method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

180 * (use the <code>getRemainingAuthMethods</code> method to get a list of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

181 * the remaining possible methods).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

182 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

183 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

184 * @param pem A <code>String</code> containing the DSA private key of the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

185 * user in OpenSSH key format (PEM, you can't miss the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

186 * "-----BEGIN DSA PRIVATE KEY-----" tag). The string may contain

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

187 * linefeeds.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

188 * @param password If the PEM string is 3DES encrypted ("DES-EDE3-CBC"), then you

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

189 * must specify the password. Otherwise, this argument will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

190 * ignored and can be set to <code>null</code>.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

191 * @return whether the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

192 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

193 * @deprecated You should use one of the {@link #authenticateWithPublicKey(String, File, String) authenticateWithPublicKey()}

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

194 * methods, this method is just a wrapper for it and will

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

195 * disappear in future builds.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

196 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

197 public synchronized boolean authenticateWithDSA(String user, String pem, String password) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

198 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

199 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

200 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

201

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

202 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

203 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

204 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

205

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

206 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

207 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

208 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

209

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

210 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

211 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

212 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

213

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

214 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

215 throw new IllegalArgumentException("user argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

216 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

217

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

218 if(pem == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

219 throw new IllegalArgumentException("pem argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

220 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

221

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

222 authenticated = am.authenticatePublicKey(user, pem.toCharArray(), password, getOrCreateSecureRND());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

223

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

224 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

225 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

226

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

227 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

228 * A wrapper that calls {@link #authenticateWithKeyboardInteractive(String, String[], InteractiveCallback)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

229 * authenticateWithKeyboardInteractivewith} a <code>null</code> submethod list.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

230 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

231 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

232 * @param cb An <code>InteractiveCallback</code> which will be used to

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

233 * determine the responses to the questions asked by the server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

234 * @return whether the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

235 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

236 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

237 public synchronized boolean authenticateWithKeyboardInteractive(String user, InteractiveCallback cb)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

238 throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

239 return authenticateWithKeyboardInteractive(user, null, cb);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

240 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

241

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

242 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

243 * After a successful connect, one has to authenticate oneself. This method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

244 * is based on "keyboard-interactive", specified in

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

245 * draft-ietf-secsh-auth-kbdinteract-XX. Basically, you have to define a

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

246 * callback object which will be feeded with challenges generated by the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

247 * server. Answers are then sent back to the server. It is possible that the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

248 * callback will be called several times during the invocation of this

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

249 * method (e.g., if the server replies to the callback's answer(s) with

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

250 * another challenge...)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

251 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

252 * If the authentication phase is complete, <code>true</code> will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

253 * returned. If the server does not accept the request (or if further

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

254 * authentication steps are needed), <code>false</code> is returned and

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

255 * one can retry either by using this or any other authentication method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

256 * (use the <code>getRemainingAuthMethods</code> method to get a list of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

257 * the remaining possible methods).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

258 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

259 * Note: some SSH servers advertise "keyboard-interactive", however, any

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

260 * interactive request will be denied (without having sent any challenge to

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

261 * the client).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

262 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

263 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

264 * @param submethods An array of submethod names, see

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

265 * draft-ietf-secsh-auth-kbdinteract-XX. May be <code>null</code>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

266 * to indicate an empty list.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

267 * @param cb An <code>InteractiveCallback</code> which will be used to

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

268 * determine the responses to the questions asked by the server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

269 * @return whether the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

270 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

271 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

272 public synchronized boolean authenticateWithKeyboardInteractive(String user, String[] submethods,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

273 InteractiveCallback cb) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

274 if(cb == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

275 throw new IllegalArgumentException("Callback may not ne NULL!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

276 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

277

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

278 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

279 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

280 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

281

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

282 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

283 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

284 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

285

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

286 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

287 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

288 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

289

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

290 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

291 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

292 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

293

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

294 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

295 throw new IllegalArgumentException("user argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

296 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

297

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

298 authenticated = am.authenticateInteractive(user, submethods, cb);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

299

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

300 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

301 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

302

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

303 public synchronized boolean authenticateWithAgent(String user, AgentProxy proxy) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

304 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

305 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

306 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

307

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

308 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

309 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

310 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

311

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

312 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

313 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

314 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

315

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

316 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

317 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

318 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

319

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

320 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

321 throw new IllegalArgumentException("user argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

322 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

323

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

324 authenticated = am.authenticatePublicKey(user, proxy);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

325

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

326 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

327 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

328

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

329 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

330 * After a successful connect, one has to authenticate oneself. This method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

331 * sends username and password to the server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

332 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

333 * If the authentication phase is complete, <code>true</code> will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

334 * returned. If the server does not accept the request (or if further

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

335 * authentication steps are needed), <code>false</code> is returned and

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

336 * one can retry either by using this or any other authentication method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

337 * (use the <code>getRemainingAuthMethods</code> method to get a list of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

338 * the remaining possible methods).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

339 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

340 * Note: if this method fails, then please double-check that it is actually

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

341 * offered by the server (use {@link #getRemainingAuthMethods(String) getRemainingAuthMethods()}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

342 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

343 * Often, password authentication is disabled, but users are not aware of it.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

344 * Many servers only offer "publickey" and "keyboard-interactive". However,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

345 * even though "keyboard-interactive" *feels* like password authentication

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

346 * (e.g., when using the putty or openssh clients) it is *not* the same mechanism.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

347 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

348 * @param user

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

349 * @param password

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

350 * @return if the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

351 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

352 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

353 public synchronized boolean authenticateWithPassword(String user, String password) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

354 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

355 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

356 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

357

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

358 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

359 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

360 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

361

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

362 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

363 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

364 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

365

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

366 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

367 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

368 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

369

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

370 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

371 throw new IllegalArgumentException("user argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

372 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

373

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

374 if(password == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

375 throw new IllegalArgumentException("password argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

376 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

377

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

378 authenticated = am.authenticatePassword(user, password);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

379

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

380 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

381 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

382

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

383 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

384 * After a successful connect, one has to authenticate oneself.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

385 * This method can be used to explicitly use the special "none"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

386 * authentication method (where only a username has to be specified).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

387 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

388 * Note 1: The "none" method may always be tried by clients, however as by

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

389 * the specs, the server will not explicitly announce it. In other words,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

390 * the "none" token will never show up in the list returned by

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

391 * {@link #getRemainingAuthMethods(String)}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

392 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

393 * Note 2: no matter which one of the authenticateWithXXX() methods

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

394 * you call, the library will always issue exactly one initial "none"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

395 * authentication request to retrieve the initially allowed list of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

396 * authentication methods by the server. Please read RFC 4252 for the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

397 * details.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

398 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

399 * If the authentication phase is complete, <code>true</code> will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

400 * returned. If further authentication steps are needed, <code>false</code>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

401 * is returned and one can retry by any other authentication method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

402 * (use the <code>getRemainingAuthMethods</code> method to get a list of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

403 * the remaining possible methods).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

404 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

405 * @param user

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

406 * @return if the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

407 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

408 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

409 public synchronized boolean authenticateWithNone(String user) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

410 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

411 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

412 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

413

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

414 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

415 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

416 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

417

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

418 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

419 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

420 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

421

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

422 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

423 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

424 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

425

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

426 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

427 throw new IllegalArgumentException("user argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

428 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

429

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

430 /* Trigger the sending of the PacketUserauthRequestNone packet */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

431 /* (if not already done) */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

432

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

433 authenticated = am.authenticateNone(user);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

434

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

435 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

436 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

437

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

438 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

439 * After a successful connect, one has to authenticate oneself.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

440 * The authentication method "publickey" works by signing a challenge

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

441 * sent by the server. The signature is either DSA or RSA based - it

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

442 * just depends on the type of private key you specify, either a DSA

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

443 * or RSA private key in PEM format. And yes, this is may seem to be a

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

444 * little confusing, the method is called "publickey" in the SSH-2 protocol

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

445 * specification, however since we need to generate a signature, you

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

446 * actually have to supply a private key =).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

447 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

448 * The private key contained in the PEM file may also be encrypted ("Proc-Type: 4,ENCRYPTED").

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

449 * The library supports DES-CBC and DES-EDE3-CBC encryption, as well

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

450 * as the more exotic PEM encrpytions AES-128-CBC, AES-192-CBC and AES-256-CBC.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

451 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

452 * If the authentication phase is complete, <code>true</code> will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

453 * returned. If the server does not accept the request (or if further

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

454 * authentication steps are needed), <code>false</code> is returned and

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

455 * one can retry either by using this or any other authentication method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

456 * (use the <code>getRemainingAuthMethods</code> method to get a list of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

457 * the remaining possible methods).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

458 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

459 * NOTE PUTTY USERS: Event though your key file may start with "-----BEGIN..."

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

460 * it is not in the expected format. You have to convert it to the OpenSSH

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

461 * key format by using the "puttygen" tool (can be downloaded from the Putty

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

462 * website). Simply load your key and then use the "Conversions/Export OpenSSH key"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

463 * functionality to get a proper PEM file.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

464 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

465 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

466 * @param pemPrivateKey A <code>char[]</code> containing a DSA or RSA private key of the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

467 * user in OpenSSH key format (PEM, you can't miss the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

468 * "-----BEGIN DSA PRIVATE KEY-----" or "-----BEGIN RSA PRIVATE KEY-----"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

469 * tag). The char array may contain linebreaks/linefeeds.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

470 * @param password If the PEM structure is encrypted ("Proc-Type: 4,ENCRYPTED") then

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

471 * you must specify a password. Otherwise, this argument will be ignored

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

472 * and can be set to <code>null</code>.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

473 * @return whether the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

474 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

475 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

476 public synchronized boolean authenticateWithPublicKey(String user, char[] pemPrivateKey, String password)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

477 throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

478 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

479 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

480 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

481

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

482 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

483 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

484 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

485

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

486 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

487 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

488 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

489

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

490 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

491 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

492 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

493

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

494 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

495 throw new IllegalArgumentException("user argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

496 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

497

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

498 if(pemPrivateKey == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

499 throw new IllegalArgumentException("pemPrivateKey argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

500 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

501

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

502 authenticated = am.authenticatePublicKey(user, pemPrivateKey, password, getOrCreateSecureRND());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

503

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

504 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

505 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

506

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

507 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

508 * A convenience wrapper function which reads in a private key (PEM format, either DSA or RSA)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

509 * and then calls <code>authenticateWithPublicKey(String, char[], String)</code>.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

510 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

511 * NOTE PUTTY USERS: Event though your key file may start with "-----BEGIN..."

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

512 * it is not in the expected format. You have to convert it to the OpenSSH

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

513 * key format by using the "puttygen" tool (can be downloaded from the Putty

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

514 * website). Simply load your key and then use the "Conversions/Export OpenSSH key"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

515 * functionality to get a proper PEM file.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

516 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

517 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

518 * @param pemFile A <code>File</code> object pointing to a file containing a DSA or RSA

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

519 * private key of the user in OpenSSH key format (PEM, you can't miss the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

520 * "-----BEGIN DSA PRIVATE KEY-----" or "-----BEGIN RSA PRIVATE KEY-----"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

521 * tag).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

522 * @param password If the PEM file is encrypted then you must specify the password.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

523 * Otherwise, this argument will be ignored and can be set to <code>null</code>.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

524 * @return whether the connection is now authenticated.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

525 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

526 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

527 public synchronized boolean authenticateWithPublicKey(String user, File pemFile, String password)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

528 throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

529 if(pemFile == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

530 throw new IllegalArgumentException("pemFile argument is null");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

531 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

532

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

533 char[] buff = new char[256];

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

534

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

535 CharArrayWriter cw = new CharArrayWriter();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

536

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

537 FileReader fr = new FileReader(pemFile);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

538

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

539 while(true) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

540 int len = fr.read(buff);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

541 if(len < 0) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

542 break;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

543 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

544 cw.write(buff, 0, len);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

545 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

546

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

547 fr.close();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

548

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

549 return authenticateWithPublicKey(user, cw.toCharArray(), password);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

550 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

551

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

552 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

553 * Add a {@link ConnectionMonitor} to this connection. Can be invoked at any time,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

554 * but it is best to add connection monitors before invoking

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

555 * <code>connect()</code> to avoid glitches (e.g., you add a connection monitor after

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

556 * a successful connect(), but the connection has died in the mean time. Then,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

557 * your connection monitor won't be notified.)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

558 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

559 * You can add as many monitors as you like. If a monitor has already been added, then

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

560 * this method does nothing.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

561 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

562 * @param cmon An object implementing the {@link ConnectionMonitor} interface.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

563 * @see ConnectionMonitor

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

564 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

565 public synchronized void addConnectionMonitor(ConnectionMonitor cmon) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

566 if(!connectionMonitors.contains(cmon)) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

567 connectionMonitors.add(cmon);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

568 if(tm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

569 tm.setConnectionMonitors(connectionMonitors);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

570 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

571 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

572 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

573

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

574 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

575 * Remove a {@link ConnectionMonitor} from this connection.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

576 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

577 * @param cmon

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

578 * @return whether the monitor could be removed

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

579 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

580 public synchronized boolean removeConnectionMonitor(ConnectionMonitor cmon) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

581 boolean existed = connectionMonitors.remove(cmon);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

582 if(tm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

583 tm.setConnectionMonitors(connectionMonitors);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

584 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

585 return existed;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

586 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

587

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

588 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

589 * Close the connection to the SSH-2 server. All assigned sessions will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

590 * closed, too. Can be called at any time. Don't forget to call this once

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

591 * you don't need a connection anymore - otherwise the receiver thread may

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

592 * run forever.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

593 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

594 public synchronized void close() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

595 if(cm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

596 cm.closeAllChannels();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

597 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

598 if(tm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

599 tm.close();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

600 tm = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

601 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

602 am = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

603 cm = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

604 authenticated = false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

605 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

606

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

607 public synchronized void close(IOException t) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

608 if(cm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

609 cm.closeAllChannels();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

610 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

611 if(tm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

612 tm.close(t);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

613 tm = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

614 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

615 am = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

616 cm = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

617 authenticated = false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

618 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

619

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

620 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

621 * Same as {@link #connect(ServerHostKeyVerifier, int, int) connect(null, 0, 0)}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

622 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

623 * @return see comments for the {@link #connect(ServerHostKeyVerifier, int, int) connect(ServerHostKeyVerifier, int, int)} method.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

624 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

625 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

626 public synchronized ConnectionInfo connect() throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

627 return connect(null, 0, 0);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

628 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

629

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

630 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

631 * Same as {@link #connect(ServerHostKeyVerifier, int, int) connect(verifier, 0, 0)}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

632 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

633 * @return see comments for the {@link #connect(ServerHostKeyVerifier, int, int) connect(ServerHostKeyVerifier, int, int)} method.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

634 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

635 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

636 public synchronized ConnectionInfo connect(ServerHostKeyVerifier verifier) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

637 return connect(verifier, 0, 0);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

638 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

639

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

640 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

641 * Connect to the SSH-2 server and, as soon as the server has presented its

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

642 * host key, use the {@link ServerHostKeyVerifier#verifyServerHostKey(String,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

643 * int, String, byte[]) ServerHostKeyVerifier.verifyServerHostKey()}

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

644 * method of the <code>verifier</code> to ask for permission to proceed.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

645 * If <code>verifier</code> is <code>null</code>, then any host key will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

646 * accepted - this is NOT recommended, since it makes man-in-the-middle attackes

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

647 * VERY easy (somebody could put a proxy SSH server between you and the real server).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

648 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

649 * Note: The verifier will be called before doing any crypto calculations

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

650 * (i.e., diffie-hellman). Therefore, if you don't like the presented host key then

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

651 * no CPU cycles are wasted (and the evil server has less information about us).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

652 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

653 * However, it is still possible that the server presented a fake host key: the server

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

654 * cheated (typically a sign for a man-in-the-middle attack) and is not able to generate

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

655 * a signature that matches its host key. Don't worry, the library will detect such

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

656 * a scenario later when checking the signature (the signature cannot be checked before

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

657 * having completed the diffie-hellman exchange).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

658 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

659 * Note 2: The {@link ServerHostKeyVerifier#verifyServerHostKey(String,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

660 * int, String, byte[]) ServerHostKeyVerifier.verifyServerHostKey()} method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

661 * will *NOT* be called from the current thread, the call is being made from a

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

662 * background thread (there is a background dispatcher thread for every

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

663 * established connection).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

664 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

665 * Note 3: This method will block as long as the key exchange of the underlying connection

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

666 * has not been completed (and you have not specified any timeouts).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

667 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

668 * Note 4: If you want to re-use a connection object that was successfully connected,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

669 * then you must call the {@link #close()} method before invoking <code>connect()</code> again.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

670 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

671 * @param verifier An object that implements the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

672 * {@link ServerHostKeyVerifier} interface. Pass <code>null</code>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

673 * to accept any server host key - NOT recommended.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

674 * @param connectTimeout Connect the underlying TCP socket to the server with the given timeout

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

675 * value (non-negative, in milliseconds). Zero means no timeout.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

676 * @param kexTimeout Timeout for complete connection establishment (non-negative,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

677 * in milliseconds). Zero means no timeout. The timeout counts from the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

678 * moment you invoke the connect() method and is cancelled as soon as the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

679 * first key-exchange round has finished. It is possible that

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

680 * the timeout event will be fired during the invocation of the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

681 * <code>verifier</code> callback, but it will only have an effect after

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

682 * the <code>verifier</code> returns.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

683 * @return A {@link ConnectionInfo} object containing the details of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

684 * the established connection.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

685 * @throws IOException If any problem occurs, e.g., the server's host key is not

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

686 * accepted by the <code>verifier</code> or there is problem during

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

687 * the initial crypto setup (e.g., the signature sent by the server is wrong).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

688 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

689 * In case of a timeout (either connectTimeout or kexTimeout)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

690 * a SocketTimeoutException is thrown.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

691 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

692 * An exception may also be thrown if the connection was already successfully

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

693 * connected (no matter if the connection broke in the mean time) and you invoke

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

694 * <code>connect()</code> again without having called {@link #close()} first.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

695 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

696 * If a HTTP proxy is being used and the proxy refuses the connection,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

697 * then a {@link HTTPProxyException} may be thrown, which

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

698 * contains the details returned by the proxy. If the proxy is buggy and does

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

699 * not return a proper HTTP response, then a normal IOException is thrown instead.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

700 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

701 public synchronized ConnectionInfo connect(ServerHostKeyVerifier verifier, int connectTimeout, int kexTimeout)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

702 throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

703 final class TimeoutState {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

704 boolean isCancelled = false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

705 boolean timeoutSocketClosed = false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

706 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

707

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

708 if(tm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

709 throw new IllegalStateException(String.format("Connection to %s is already in connected state", hostname));

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

710 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

711

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

712 if(connectTimeout < 0) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

713 throw new IllegalArgumentException("connectTimeout must be non-negative!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

714 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

715

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

716 if(kexTimeout < 0) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

717 throw new IllegalArgumentException("kexTimeout must be non-negative!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

718 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

719

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

720 final TimeoutState state = new TimeoutState();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

721

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

722 if(null == proxy) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

723 tm = new ClientTransportManager(new Socket());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

724 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

725 else {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

726 tm = new HTTPProxyClientTransportManager(new Socket(), proxy);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

727 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

728 tm.setSoTimeout(connectTimeout);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

729 tm.setTcpNoDelay(tcpNoDelay);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

730 tm.setConnectionMonitors(connectionMonitors);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

731

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

732 try {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

733 TimeoutToken token = null;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

734

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

735 if(kexTimeout > 0) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

736 final Runnable timeoutHandler = new Runnable() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

737 @Override

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

738 public void run() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

739 synchronized(state) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

740 if(state.isCancelled) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

741 return;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

742 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

743 state.timeoutSocketClosed = true;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

744 tm.close(new SocketTimeoutException("The connect timeout expired"));

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

745 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

746 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

747 };

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

748

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

749 long timeoutHorizont = System.currentTimeMillis() + kexTimeout;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

750

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

751 token = TimeoutService.addTimeoutHandler(timeoutHorizont, timeoutHandler);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

752 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

753

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

754 tm.connect(hostname, port, softwareversion, cryptoWishList, verifier, dhgexpara, connectTimeout,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

755 getOrCreateSecureRND());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

756

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

757 /* Wait until first KEX has finished */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

758

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

759 ConnectionInfo ci = tm.getConnectionInfo(1);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

760

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

761 /* Now try to cancel the timeout, if needed */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

762

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

763 if(token != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

764 TimeoutService.cancelTimeoutHandler(token);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

765

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

766 /* Were we too late? */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

767

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

768 synchronized(state) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

769 if(state.timeoutSocketClosed) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

770 throw new IOException("This exception will be replaced by the one below =)");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

771 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

772 /* Just in case the "cancelTimeoutHandler" invocation came just a little bit

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

773 * too late but the handler did not enter the semaphore yet - we can

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

774 * still stop it.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

775 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

776 state.isCancelled = true;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

777 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

778 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

779

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

780 return ci;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

781 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

782 catch(SocketTimeoutException e) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

783 throw e;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

784 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

785 catch(HTTPProxyException e) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

786 throw e;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

787 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

788 catch(IOException e) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

789 // This will also invoke any registered connection monitors

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

790 close(e);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

791

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

792 synchronized(state) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

793 /* Show a clean exception, not something like "the socket is closed!?!" */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

794 if(state.timeoutSocketClosed) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

795 throw new SocketTimeoutException(String.format("The kexTimeout (%d ms) expired.", kexTimeout));

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

796 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

797 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

798 throw e;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

799 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

800 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

801

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

802 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

803 * Creates a new {@link LocalPortForwarder}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

804 * A <code>LocalPortForwarder</code> forwards TCP/IP connections that arrive at a local

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

805 * port via the secure tunnel to another host (which may or may not be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

806 * identical to the remote SSH-2 server).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

807 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

808 * This method must only be called after one has passed successfully the authentication step.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

809 * There is no limit on the number of concurrent forwardings.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

810 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

811 * @param local_port the local port the LocalPortForwarder shall bind to.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

812 * @param host_to_connect target address (IP or hostname)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

813 * @param port_to_connect target port

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

814 * @return A {@link LocalPortForwarder} object.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

815 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

816 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

817 public synchronized LocalPortForwarder createLocalPortForwarder(int local_port, String host_to_connect,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

818 int port_to_connect) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

819 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

820

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

821 return new LocalPortForwarder(cm, local_port, host_to_connect, port_to_connect);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

822 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

823

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

824 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

825 * Creates a new {@link LocalPortForwarder}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

826 * A <code>LocalPortForwarder</code> forwards TCP/IP connections that arrive at a local

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

827 * port via the secure tunnel to another host (which may or may not be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

828 * identical to the remote SSH-2 server).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

829 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

830 * This method must only be called after one has passed successfully the authentication step.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

831 * There is no limit on the number of concurrent forwardings.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

832 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

833 * @param addr specifies the InetSocketAddress where the local socket shall be bound to.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

834 * @param host_to_connect target address (IP or hostname)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

835 * @param port_to_connect target port

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

836 * @return A {@link LocalPortForwarder} object.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

837 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

838 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

839 public synchronized LocalPortForwarder createLocalPortForwarder(InetSocketAddress addr, String host_to_connect,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

840 int port_to_connect) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

841 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

842

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

843 return new LocalPortForwarder(cm, addr, host_to_connect, port_to_connect);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

844 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

845

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

846 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

847 * Creates a new {@link LocalStreamForwarder}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

848 * A <code>LocalStreamForwarder</code> manages an Input/Outputstream pair

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

849 * that is being forwarded via the secure tunnel into a TCP/IP connection to another host

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

850 * (which may or may not be identical to the remote SSH-2 server).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

851 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

852 * @param host_to_connect

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

853 * @param port_to_connect

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

854 * @return A {@link LocalStreamForwarder} object.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

855 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

856 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

857 public synchronized LocalStreamForwarder createLocalStreamForwarder(String host_to_connect, int port_to_connect)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

858 throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

859 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

860

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

861 return new LocalStreamForwarder(cm, host_to_connect, port_to_connect);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

862 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

863

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

864 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

865 * Create a very basic {@link SCPClient} that can be used to copy

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

866 * files from/to the SSH-2 server.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

867 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

868 * Works only after one has passed successfully the authentication step.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

869 * There is no limit on the number of concurrent SCP clients.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

870 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

871 * Note: This factory method will probably disappear in the future.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

872 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

873 * @return A {@link SCPClient} object.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

874 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

875 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

876 public synchronized SCPClient createSCPClient() throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

877 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

878

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

879 return new SCPClient(this);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

880 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

881

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

882 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

883 * Force an asynchronous key re-exchange (the call does not block). The

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

884 * latest values set for MAC, Cipher and DH group exchange parameters will

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

885 * be used. If a key exchange is currently in progress, then this method has

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

886 * the only effect that the so far specified parameters will be used for the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

887 * next (server driven) key exchange.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

888 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

889 * Note: This implementation will never start a key exchange (other than the initial one)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

890 * unless you or the SSH-2 server ask for it.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

891 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

892 * @throws IOException In case of any failure behind the scenes.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

893 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

894 public synchronized void forceKeyExchange() throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

895 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

896

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

897 tm.forceKeyExchange(cryptoWishList, dhgexpara, null, null);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

898 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

899

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

900 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

901 * Returns the hostname that was passed to the constructor.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

902 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

903 * @return the hostname

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

904 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

905 public synchronized String getHostname() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

906 return hostname;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

907 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

908

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

909 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

910 * Returns the port that was passed to the constructor.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

911 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

912 * @return the TCP port

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

913 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

914 public synchronized int getPort() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

915 return port;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

916 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

917

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

918 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

919 * Returns a {@link ConnectionInfo} object containing the details of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

920 * the connection. Can be called as soon as the connection has been

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

921 * established (successfully connected).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

922 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

923 * @return A {@link ConnectionInfo} object.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

924 * @throws IOException In case of any failure behind the scenes.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

925 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

926 public synchronized ConnectionInfo getConnectionInfo() throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

927 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

928

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

929 return tm.getConnectionInfo(1);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

930 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

931

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

932 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

933 * After a successful connect, one has to authenticate oneself. This method

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

934 * can be used to tell which authentication methods are supported by the

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

935 * server at a certain stage of the authentication process (for the given

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

936 * username).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

937 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

938 * Note 1: the username will only be used if no authentication step was done

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

939 * so far (it will be used to ask the server for a list of possible

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

940 * authentication methods by sending the initial "none" request). Otherwise,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

941 * this method ignores the user name and returns a cached method list

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

942 * (which is based on the information contained in the last negative server response).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

943 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

944 * Note 2: the server may return method names that are not supported by this

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

945 * implementation.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

946 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

947 * After a successful authentication, this method must not be called

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

948 * anymore.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

949 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

950 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

951 * @return a (possibly emtpy) array holding authentication method names.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

952 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

953 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

954 public synchronized String[] getRemainingAuthMethods(String user) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

955 if(user == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

956 throw new IllegalArgumentException("user argument may not be NULL!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

957 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

958

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

959 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

960 throw new IllegalStateException("Connection is not established!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

961 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

962

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

963 if(authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

964 throw new IllegalStateException("Connection is already authenticated!");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

965 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

966

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

967 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

968 am = new AuthenticationManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

969 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

970

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

971 if(cm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

972 cm = new ChannelManager(tm);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

973 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

974

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

975 final Set<String> remainingMethods = am.getRemainingMethods(user);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

976 return remainingMethods.toArray(new String[remainingMethods.size()]);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

977 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

978

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

979 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

980 * Determines if the authentication phase is complete. Can be called at any

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

981 * time.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

982 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

983 * @return <code>true</code> if no further authentication steps are

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

984 * needed.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

985 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

986 public synchronized boolean isAuthenticationComplete() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

987 return authenticated;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

988 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

989

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

990 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

991 * Returns true if there was at least one failed authentication request and

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

992 * the last failed authentication request was marked with "partial success"

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

993 * by the server. This is only needed in the rare case of SSH-2 server setups

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

994 * that cannot be satisfied with a single successful authentication request

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

995 * (i.e., multiple authentication steps are needed.)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

996 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

997 * If you are interested in the details, then have a look at RFC4252.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

998 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

999 * @return if the there was a failed authentication step and the last one

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1000 * was marked as a "partial success".

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1001 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1002 public synchronized boolean isAuthenticationPartialSuccess() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1003 if(am == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1004 return false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1005 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1006 return am.getPartialSuccess();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1007 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1008

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1009 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1010 * Checks if a specified authentication method is available. This method is

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1011 * actually just a wrapper for {@link #getRemainingAuthMethods(String)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1012 * getRemainingAuthMethods()}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1013 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1014 * @param user A <code>String</code> holding the username.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1015 * @param method An authentication method name (e.g., "publickey", "password",

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1016 * "keyboard-interactive") as specified by the SSH-2 standard.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1017 * @return if the specified authentication method is currently available.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1018 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1019 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1020 public synchronized boolean isAuthMethodAvailable(String user, String method) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1021 String methods[] = getRemainingAuthMethods(user);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1022 for(final String m : methods) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1023 if(m.compareTo(method) == 0) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1024 return true;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1025 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1026 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1027 return false;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1028 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1029

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1030 private SecureRandom getOrCreateSecureRND() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1031 if(generator == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1032 generator = new SecureRandom();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1033 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1034 return generator;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1035 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1036

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1037 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1038 * Open a new {@link Session} on this connection. Works only after one has passed

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1039 * successfully the authentication step. There is no limit on the number of

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1040 * concurrent sessions.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1041 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1042 * @return A {@link Session} object.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1043 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1044 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1045 public synchronized Session openSession() throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1046 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1047

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1048 return new Session(cm, getOrCreateSecureRND());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1049 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1050

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1051 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1052 * Send an SSH_MSG_IGNORE packet. This method will generate a random data attribute

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1053 * (length between 0 (invlusive) and 16 (exclusive) bytes, contents are random bytes).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1054 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1055 * This method must only be called once the connection is established.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1056 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1057 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1058 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1059 public synchronized void sendIgnorePacket() throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1060 SecureRandom rnd = getOrCreateSecureRND();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1061

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1062 byte[] data = new byte[rnd.nextInt(16)];

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1063 rnd.nextBytes(data);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1064

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1065 sendIgnorePacket(data);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1066 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1067

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1068 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1069 * Send an SSH_MSG_IGNORE packet with the given data attribute.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1070 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1071 * This method must only be called once the connection is established.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1072 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1073 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1074 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1075 public synchronized void sendIgnorePacket(byte[] data) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1076 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1077

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1078 PacketIgnore pi = new PacketIgnore(data);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1079

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1080 tm.sendMessage(pi.getPayload());

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1081 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1082

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1083 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1084 * Controls whether compression is used on the link or not.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1085 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1086 public synchronized void setCompression(String[] algorithms) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1087 CompressionFactory.checkCompressorList(algorithms);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1088 cryptoWishList.c2s_comp_algos = algorithms;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1089 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1090

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1091 public synchronized void enableCompression() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1092 cryptoWishList.c2s_comp_algos = CompressionFactory.getDefaultCompressorList();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1093 cryptoWishList.s2c_comp_algos = CompressionFactory.getDefaultCompressorList();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1094 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1095

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1096 public synchronized void disableCompression() {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1097 cryptoWishList.c2s_comp_algos = new String[]{"none"};

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1098 cryptoWishList.s2c_comp_algos = new String[]{"none"};

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1099 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1100

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1101 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1102 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1103 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1104 public synchronized void setClient2ServerCiphers(final String[] ciphers) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1105 if((ciphers == null) || (ciphers.length == 0)) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1106 throw new IllegalArgumentException();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1107 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1108 BlockCipherFactory.checkCipherList(ciphers);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1109 cryptoWishList.c2s_enc_algos = ciphers;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1110 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1111

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1112 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1113 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1114 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1115 public synchronized void setClient2ServerMACs(final String[] macs) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1116 MAC.checkMacList(macs);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1117 cryptoWishList.c2s_mac_algos = macs;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1118 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1119

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1120 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1121 * Sets the parameters for the diffie-hellman group exchange. Unless you

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1122 * know what you are doing, you will never need this. Default values are

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1123 * defined in the {@link DHGexParameters} class.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1124 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1125 * @param dgp {@link DHGexParameters}, non null.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1126 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1127 public synchronized void setDHGexParameters(DHGexParameters dgp) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1128 if(dgp == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1129 throw new IllegalArgumentException();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1130 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1131

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1132 dhgexpara = dgp;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1133 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1134

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1135 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1136 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1137 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1138 public synchronized void setServer2ClientCiphers(final String[] ciphers) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1139 BlockCipherFactory.checkCipherList(ciphers);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1140 cryptoWishList.s2c_enc_algos = ciphers;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1141 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1142

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1143 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1144 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1145 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1146 public synchronized void setServer2ClientMACs(final String[] macs) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1147 MAC.checkMacList(macs);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1148 cryptoWishList.s2c_mac_algos = macs;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1149 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1150

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1151 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1152 * Define the set of allowed server host key algorithms to be used for

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1153 * the following key exchange operations.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1154 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1155 * Unless you know what you are doing, you will never need this.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1156 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1157 * @param algos An array of allowed server host key algorithms.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1158 * SSH-2 defines <code>ssh-dss</code> and <code>ssh-rsa</code>.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1159 * The entries of the array must be ordered after preference, i.e.,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1160 * the entry at index 0 is the most preferred one. You must specify

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1161 * at least one entry.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1162 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1163 public synchronized void setServerHostKeyAlgorithms(final String[] algos) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1164 KexManager.checkServerHostkeyAlgorithmsList(algos);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1165 cryptoWishList.serverHostKeyAlgorithms = algos;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1166 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1167

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1168 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1169 * Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm) on the underlying socket.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1170 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1171 * Can be called at any time. If the connection has not yet been established

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1172 * then the passed value will be stored and set after the socket has been set up.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1173 * The default value that will be used is <code>false</code>.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1174 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1175 * @param enable the argument passed to the <code>Socket.setTCPNoDelay()</code> method.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1176 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1177 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1178 public synchronized void setTCPNoDelay(boolean enable) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1179 tcpNoDelay = enable;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1180 if(tm != null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1181 tm.setTcpNoDelay(enable);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1182 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1183 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1184

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1185 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1186 * Request a remote port forwarding.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1187 * If successful, then forwarded connections will be redirected to the given target address.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1188 * You can cancle a requested remote port forwarding by calling

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1189 * {@link #cancelRemotePortForwarding(int) cancelRemotePortForwarding()}.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1190 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1191 * A call of this method will block until the peer either agreed or disagreed to your request-

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1192 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1193 * Note 1: this method typically fails if you

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1194 * <ul>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1195 * <li>pass a port number for which the used remote user has not enough permissions (i.e., port

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1196 * < 1024)</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1197 * <li>or pass a port number that is already in use on the remote server</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1198 * <li>or if remote port forwarding is disabled on the server.</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1199 * </ul>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1200 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1201 * Note 2: (from the openssh man page): By default, the listening socket on the server will be

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1202 * bound to the loopback interface only. This may be overriden by specifying a bind address.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1203 * Specifying a remote bind address will only succeed if the server's GatewayPorts option

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1204 * is enabled (see sshd_config(5)).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1205 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1206 * @param bindAddress address to bind to on the server:

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1207 * <ul>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1208 * <li>"" means that connections are to be accepted on all protocol families

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1209 * supported by the SSH implementation</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1210 * <li>"0.0.0.0" means to listen on all IPv4 addresses</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1211 * <li>"::" means to listen on all IPv6 addresses</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1212 * <li>"localhost" means to listen on all protocol families supported by the SSH

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1213 * implementation on loopback addresses only, [RFC3330] and RFC3513]</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1214 * <li>"127.0.0.1" and "::1" indicate listening on the loopback interfaces for

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1215 * IPv4 and IPv6 respectively</li>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1216 * </ul>

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1217 * @param bindPort port number to bind on the server (must be > 0)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1218 * @param targetAddress the target address (IP or hostname)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1219 * @param targetPort the target port

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1220 * @throws IOException

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1221 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1222 public synchronized void requestRemotePortForwarding(String bindAddress, int bindPort, String targetAddress,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1223 int targetPort) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1224 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1225

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1226 if((bindAddress == null) || (targetAddress == null) || (bindPort <= 0) || (targetPort <= 0)) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1227 throw new IllegalArgumentException();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1228 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1229

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1230 cm.requestGlobalForward(bindAddress, bindPort, targetAddress, targetPort);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1231 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1232

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1233 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1234 * Cancel an earlier requested remote port forwarding.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1235 * Currently active forwardings will not be affected (e.g., disrupted).

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1236 * Note that further connection forwarding requests may be received until

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1237 * this method has returned.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1238 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1239 * @param bindPort the allocated port number on the server

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1240 * @throws IOException if the remote side refuses the cancel request or another low

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1241 * level error occurs (e.g., the underlying connection is closed)

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1242 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1243 public synchronized void cancelRemotePortForwarding(int bindPort) throws IOException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1244 this.checkConnection();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1245

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1246 cm.requestCancelGlobalForward(bindPort);

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1247 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1248

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1249 /**

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1250 * Provide your own instance of SecureRandom. Can be used, e.g., if you

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1251 * want to seed the used SecureRandom generator manually.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1252 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1253 * The SecureRandom instance is used during key exchanges, public key authentication,

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1254 * x11 cookie generation and the like.

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1255 *

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1256 * @param rnd a SecureRandom instance

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1257 */

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1258 public synchronized void setSecureRandom(SecureRandom rnd) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1259 if(rnd == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1260 throw new IllegalArgumentException();

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1261 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1262 this.generator = rnd;

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1263 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1264

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1265 private void checkConnection() throws IllegalStateException {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1266 if(tm == null) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1267 throw new IllegalStateException("You need to establish a connection first.");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1268 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1269 if(!authenticated) {

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1270 throw new IllegalStateException("The connection is not authenticated.");

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1271 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1272 }

91a31873c42a start conversion from trilead to ganymed

Carl Byington <carl@five-ten-sg.com>

parents:

diff changeset

1273 }

Mercurial > 510Connectbot

annotate src/ch/ethz/ssh2/Connection.java @ 273:91a31873c42a ganymed