net.sf.sshapi.impl.jsch.JschHostKeyManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sshapi-jsch Show documentation

JSch is a pure Java implementation of SSH2. JSch allows you to connect to an sshd server and use port forwarding, X11 forwarding, file transfer, etc., and you can integrate its functionality into your own Java programs. JSch is licensed under BSD style license. Downloads and more information about JSch may be found at http://www.jcraft.com/jsch/. This library is the provider bridge for SSHAPI.

There is a newer version: 1.1.2

Show newest version

/* 
 * Copyright (c) 2010 The JavaSSH Project
 * All rights reserved.
 * 
 * Permission is hereby granted, free  of charge, to any person obtaining
 * a  copy  of this  software  and  associated  documentation files  (the
 * "Software"), to  deal in  the Software without  restriction, including
 * without limitation  the rights to  use, copy, modify,  merge, publish,
 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
 * permit persons to whom the Software  is furnished to do so, subject to
 * the following conditions:
 * 
 * The  above  copyright  notice  and  this permission  notice  shall  be
 * included in all copies or substantial portions of the Software.
 * 
 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package net.sf.sshapi.impl.jsch;

import java.io.File;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import net.sf.sshapi.SshConfiguration;
import net.sf.sshapi.SshException;
import net.sf.sshapi.hostkeys.AbstractHostKey;
import net.sf.sshapi.hostkeys.AbstractHostKeyManager;
import net.sf.sshapi.hostkeys.SshHostKey;
import net.sf.sshapi.hostkeys.SshHostKeyManager;
import net.sf.sshapi.util.Util;

import com.jcraft.jsch.HostKey;
import com.jcraft.jsch.HostKeyRepository;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.UserInfo;

/**
 * JSch host key management supports the OpenSSH known_hosts format. This class
 * adapts that to the SSHAPI {@link SshHostKeyManager} interface.
 */
class JschHostKeyManager extends AbstractHostKeyManager {

	private HostKeyRepository hkr;
	private JSch jsch;
	private List temporaryKeys = new ArrayList();
	private File file;

	public JschHostKeyManager(SshConfiguration configuration) throws SshException {
		super(configuration);

		jsch = new JSch();

		// 
		file = Util.getKnownHostsFile(configuration);
		if (file.exists()) {
			try {
				jsch.setKnownHosts(file.getAbsolutePath());
			} catch (JSchException e) {
				throw new SshException(SshException.IO_ERROR, e);
			}
		}

		hkr = jsch.getHostKeyRepository();
	}

	public void add(SshHostKey hostKey, boolean persist) throws SshException {
		if (!persist) {
			temporaryKeys.add(hostKey);
		} else {
			try {
				hkr.add(new HostKey(hostKey.getHost(),
					hostKey.getType().equals(SshConfiguration.PUBLIC_KEY_SSHDSA) ? HostKey.SSHDSS : HostKey.SSHRSA, hostKey
						.getKey()), new UserInfo() {

					public void showMessage(String message) {
					}

					public boolean promptYesNo(String message) {
						return true;
					}

					public boolean promptPassword(String message) {
						return false;
					}

					public boolean promptPassphrase(String message) {
						return false;
					}

					public String getPassword() {
						return null;
					}

					public String getPassphrase() {
						return null;
					}
				});
			} catch (JSchException e) {
				throw new SshException(e);
			}
		}
	}

	public boolean isWriteable() {
		return file.canWrite();
	}

	public void remove(SshHostKey hostKey) {
		hkr.remove(hostKey.getHost(), hostKey.getType());
	}

	public SshHostKey[] getKeys() {
		List hostKeys = new ArrayList();
		HostKey[] keys = hkr.getHostKey();
		if (keys != null) {
			for (int i = 0; i < keys.length; i++) {
				hostKeys.add(new JschHostKey(keys[i]));
			}
		}
		return (SshHostKey[]) hostKeys.toArray(new SshHostKey[0]);
	}

	protected SshHostKey[] doGetKeysForHost(String host, String type) {
		List keys = new ArrayList();

		// Stored
		HostKey[] hk = hkr.getHostKey(host, type);
		if (hk != null) {
			for (int i = 0; i < hk.length; i++) {
				keys.add(new JschHostKey(hk[i]));
			}
		}

		// Try temporary keys
		for (Iterator i = temporaryKeys.iterator(); i.hasNext();) {
			SshHostKey k = (SshHostKey) i.next();
			if (k.getHost().equals(host) && k.getType().equals(type)) {
				keys.add(k);
			}
		}

		return keys.size() == 0 ? null : (SshHostKey[]) keys.toArray(new SshHostKey[0]);
	}

	class JschHostKey extends AbstractHostKey {
		private HostKey key;

		public JschHostKey(HostKey key) {
			this.key = key;
		}

		public String getHost() {
			return key.getHost();
		}

		public String getType() {
			return key.getType();
		}

		public String getFingerprint() {
			return key.getFingerPrint(jsch);
		}

		public byte[] getKey() {
			try {
				Method m = Class.forName("com.jcraft.jsch.Util").getDeclaredMethod("fromBase64",
					new Class[] { byte[].class, int.class, int.class });
				m.setAccessible(true);
				return (byte[]) m.invoke(null, new Object[] { key.getKey().getBytes(), new Integer(0),
					new Integer(key.getKey().length()) });
			} catch (Exception e) {
				throw new RuntimeException(e);
			}
		}
	}
}