net.sf.sshapi.hostkeys

Interface SshHostKeyManager

All Known Implementing Classes:

AbstractHostKeyManager, MaverickHostKeyManager, MaverickHostKeyManager

public interface SshHostKeyManager

Implementations are responsible for managing host keys.

Method Summary

Modifier and Type	Method and Description
void	add(SshHostKey hostKey, boolean persist) Add a key, optionally persisting it to some kind of backing store.
SshHostKey[]	getKeys() Get all valid host keys.
SshHostKey[]	getKeysForHost(java.lang.String host, java.lang.String type) Get all the keys that are valid for the specified host and key type.
boolean	isWriteable() Get if this host key manager allows keys to be persisted.
void	remove(SshHostKey hostKey) Remove a key.

Method Detail

getKeys

SshHostKey[] getKeys()

Get all valid host keys. Will be a list of SshHostKey objects. This list will consist of both permanent and temporary keys and is guaranteed to be non-null.

Returns:

host keys

remove

void remove(SshHostKey hostKey)
     throws SshException

Remove a key.

Parameters:

hostKey - key to remove

Throws:

SshException

isWriteable

boolean isWriteable()

Get if this host key manager allows keys to be persisted.

Returns:

writeable

See Also:

add(SshHostKey, boolean)

add

void add(SshHostKey hostKey,
         boolean persist)
  throws SshException

Add a key, optionally persisting it to some kind of backing store.

Parameters:

hostKey - key to add

persist - persist the key

Throws:

SshException - on any error adding the key

getKeysForHost

SshHostKey[] getKeysForHost(java.lang.String host,
                            java.lang.String type)

Get all the keys that are valid for the specified host and key type. The implementation may also use DNS to attempt to match against alternative hostnames (e.g. the IP address if the host is specified).

The returned list is guaranteed to be non-null, i.e. it will be empty if no matches are found.

Parameters:

host - host to match

type - type (one of SshConfiguration#PUBLIC_KEY_SSHDSS or SshConfiguration.PUBLIC_KEY_SSHRSA.

Returns:

keys