com.jcraft.jsch.HostKeyRepository Java Examples

/**
 * Lookup the host key type to use for a given hostname or ip address (in known_hosts).
 * @param host the hostname or ip address to lookup
 * @return the host key type or empty optional
 */
private Optional<String> hostKeyType(String host) {
    HostKeyRepository hostKeyRepo = ssh.getHostKeyRepository();
    HostKey[] hostKeys = hostKeyRepo.getHostKey();
    if (hostKeys != null) {
        if (log.isDebugEnabled()) {
            log.debug("Looking up host key in: " +
                    hostKeyRepo.getKnownHostsRepositoryID());
        }

        for (HostKey hostKey : hostKeys) {
            for (String hostString: hostKey.getHost().split(",")) {
                if (hostString.matches(host)) {
                    if (log.isDebugEnabled()) {
                        log.debug("Host key type for " + hostString + ": " +
                                hostKey.getType());
                    }
                    return Optional.of(hostKey.getType());
                }
            }
        }
    }
    log.warn("Unknown host: " + host);
    return Optional.empty();
}
 

@Override
public int check( String host, byte[] key ) {

    host = host.replace("[", "").replace("]", "").split(":")[0]; // get only the IP address of the server

    if (knownHostsMap.get(host) == null) {
        log.error("The presented trust store certificates could not match any of the server provided ones");
        return HostKeyRepository.NOT_INCLUDED;
    }
    Set<byte[]> keys = knownHostsMap.get(host);
    for (byte[] key1 : keys) {
        key1 = Base64.decodeBase64(key1); // we must decode the key from the client trust store first
        if (Arrays.equals(key, key1)) {
            log.info("Server certificate trusted.");
            return HostKeyRepository.OK;
        }
    }
    log.error("The presented trust store certificates could not match any of the server provided ones");
    return HostKeyRepository.NOT_INCLUDED;

}
 

/**
 * Connects this session and adds custom error handling.
 * 
 * @param tms
 * @throws JSchException
 */
public void connect(int tms) throws JSchException {
	try {
		if (!session.isConnected())
			session.connect(tms);
	} catch (JSchException e) {
		if (jSch.getHostKeyRepository() instanceof LazyKnownHosts) {
			LazyKnownHosts hostsRepo = (LazyKnownHosts) jSch.getHostKeyRepository();
			if (hostsRepo.getLastStatus() != HostKeyRepository.OK) {
				throw new HostFingerprintException(hostsRepo.getLastUnknownkedHost(), hostsRepo.getLastUnknownKey());
			}
		}
		throw e;
	}
}
 

@Test
public void testKnownHostsFile() throws Exception {

    final JschBuilder builder = new JschBuilder();
    builder.setKnownHostsFileName(knownHostsFile);
    builder.setPrivateKeyFileName(privateKeyFile);

    final JSch jsch = builder.build();
    final HostKeyRepository knownHosts = jsch.getHostKeyRepository();

    assertEquals(knownHostsFile,
                 knownHosts.getKnownHostsRepositoryID());
}
 

@Test
public void testKnownHostsFile() throws Exception {

    final JschBuilder builder = new JschBuilder();
    builder.setKnownHostsFileName(knownHostsFile);
    builder.setPrivateKeyFileName(privateKeyFile);

    final JSch jsch = builder.build();
    final HostKeyRepository knownHosts = jsch.getHostKeyRepository();

    assertEquals(knownHostsFile,
                 knownHosts.getKnownHostsRepositoryID());
}
 

@Test
public void testInitializeJSchFull() throws IOException, JSchException {
    SFTPEnvironment env = new SFTPEnvironment();
    initializeFully(env);

    JSch jsch = mock(JSch.class);
    env.initialize(jsch);

    verify(jsch).setIdentityRepository((IdentityRepository) env.get("identityRepository"));
    IdentityTest.assertIdentityFromFilesAdded(jsch);
    verify(jsch).setHostKeyRepository((HostKeyRepository) env.get("hostKeyRepository"));
    verify(jsch).setKnownHosts(((File) env.get("knownHosts")).getAbsolutePath());
    verifyNoMoreInteractions(jsch);
}
 

@Override
public int check(String host, byte[] key) {
    return HostKeyRepository.OK;
}
 

@Override
public int check(String host, byte[] key) {
    return HostKeyRepository.OK;
}
 

private void addPublicKeyToHostKeyRepostitory( PublicKey key,
                                               HostKeyRepository hostKeyRepository ) throws Exception {

    if (!key.getAlgorithm().contains("RSA")) {
        throw new Exception("Only RSA keys are supported!.");
    }

    byte[] opensshKeyContent = convertToOpenSSHKeyFormat((RSAPublicKey) key);

    HostKey hostkey = new HostKey(hostname, HostKey.SSHRSA, opensshKeyContent);
    hostKeyRepository.add(hostkey, null);

}
 

/**
 * Stores the host key repository to use.
 *
 * @param repository The host key repository to use.
 * @return This object.
 */
public SFTPEnvironment withHostKeyRepository(HostKeyRepository repository) {
    put(HOST_KEY_REPOSITORY, repository);
    return this;
}