com.jcraft.jsch

Class KnownHosts

java.lang.Object

com.jcraft.jsch.KnownHosts

All Implemented Interfaces:

HostKeyRepository

public class KnownHosts
extends Object
implements HostKeyRepository

Usually not to be used by applications. The default implementation of HostKeyRepository, using a local file to store the keys.

I see no reason this class has to be public.

See Also:

JSch.setKnownHosts(String), JSch.setKnownHosts(InputStream)

Field Summary

Fields inherited from interface com.jcraft.jsch.HostKeyRepository

CHANGED, NOT_INCLUDED, OK

Method Summary

Modifier and Type	Method and Description
void	add(HostKey hostkey, UserInfo userinfo) Adds a hostname-key-pair to the repository.
int	check(String host, byte[] key) Checks whether some host has a given key.
HostKey[]	getHostKey() returns all host keys in this repository.
HostKey[]	getHostKey(String host, String type) returns all host keys of a certain host.
String	getKnownHostsRepositoryID() returns an identifier for this repository.
void	remove(String host, String type) Removes a host key if there exists mached key with host, type.
void	remove(String host, String type, byte[] key) removes a specific key of a host from the repository.
protected void	sync()
protected void	sync(String foo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKnownHostsRepositoryID

public String getKnownHostsRepositoryID()

Description copied from interface: HostKeyRepository

returns an identifier for this repository. This could be the file name of the file being accessed, for example.

This will be used for messages to the user speaking about the repository.

Specified by:

getKnownHostsRepositoryID in interface HostKeyRepository

check

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

Description copied from interface: HostKeyRepository

Checks whether some host has a given key.

Specified by:

check in interface HostKeyRepository

Parameters:

host - the host name to check

key - the public key the remote host uses.

Returns:

one of the constants HostKeyRepository.OK (this host is known to use this key), HostKeyRepository.NOT_INCLUDED (the host is unknown) or HostKeyRepository.CHANGED (the host is known to use another key).

add

public void add(HostKey hostkey,
                UserInfo userinfo)

Description copied from interface: HostKeyRepository

Adds a hostname-key-pair to the repository.

Specified by:

add in interface HostKeyRepository

Parameters:

hostkey - the key to add

userinfo - an UserInfo object which may be used to ask the user whether to create the file (and directory), or other similar questions, if necessary.

getHostKey

public HostKey[] getHostKey()

Description copied from interface: HostKeyRepository

returns all host keys in this repository. This method does the same as getHostKey(null,null). This method should have been named getHostKeys().

Specified by:

getHostKey in interface HostKeyRepository

getHostKey

public HostKey[] getHostKey(String host,
                            String type)

Description copied from interface: HostKeyRepository

returns all host keys of a certain host. This method should have been named getHostKeys(...).

Specified by:

getHostKey in interface HostKeyRepository

Parameters:

host - a hostname used in searching host keys. If null is given, every host key will be listed.

type - a key type used in searching host keys, and it should be "ssh-dss" or "ssh-rsa". If null is given, a key type type will not be ignored.

remove

public void remove(String host,
                   String type)

Description copied from interface: HostKeyRepository

Removes a host key if there exists mached key with host, type.

Specified by:

remove in interface HostKeyRepository

See Also:

HostKeyRepository.remove(String host, String type, byte[] key)

remove

public void remove(String host,
                   String type,
                   byte[] key)

Description copied from interface: HostKeyRepository

removes a specific key of a host from the repository.

Specified by:

remove in interface HostKeyRepository

Parameters:

host - the host name whose key is to remove.

type - the type of key to remove. If null, all keys of this host will be removed (without looking at key).

key - the key to be removed. If null, all keys of the given type and host will be removed.

sync

protected void sync()
             throws IOException

Throws:

IOException

sync

protected void sync(String foo)
             throws IOException

Throws:

IOException