Package com.sshtools.common.knownhosts

Class KnownHostsFile

java.lang.Object

com.sshtools.common.knownhosts.KnownHostsKeyVerification

com.sshtools.common.knownhosts.KnownHostsFile

All Implemented Interfaces:

HostKeyUpdater, HostKeyVerification

Direct Known Subclasses:

ConsoleKnownHostsFile

public class KnownHostsFile
extends KnownHostsKeyVerification

Nested Class Summary

Nested classes/interfaces inherited from class com.sshtools.common.knownhosts.KnownHostsKeyVerification

KnownHostsKeyVerification.BlankEntry, KnownHostsKeyVerification.CertAuthorityEntry, KnownHostsKeyVerification.CommentEntry, KnownHostsKeyVerification.HostFileEntry, KnownHostsKeyVerification.InvalidEntry, KnownHostsKeyVerification.KeyEntry, KnownHostsKeyVerification.RevokedEntry, KnownHostsKeyVerification.Ssh2KeyEntry

Constructor Summary

Constructors

Constructor	Description
KnownHostsFile()
KnownHostsFile(File file)
KnownHostsFile(Path file)

Method Summary

Modifier and Type	Method	Description
static Path	defaultKnownHostsFile()
Path	getFile()
File	getKnownHostsFile()
boolean	isHostFileWriteable()
protected void	onHostKeyAdded(Set<String> names, SshPublicKey key)
protected void	onHostKeyMismatch(String host, List<SshPublicKey> allowedHostKey, SshPublicKey actualHostKey)	Called by the verifyHost method when the host key supplied by the host does not match the current key recording in the known hosts file.
protected void	onHostKeyRemoved(Set<String> names, SshPublicKey key)
protected void	onHostKeyUpdated(Set<String> names, SshPublicKey key)
protected void	onInvalidHostEntry(String entry)
protected void	onRevokedKey(String host, SshPublicKey key)	Called by the verifyHost method when the host key supplied is listed as a revoked key.
protected void	onUnknownHost(String host, SshPublicKey key)	Called by the verifyHost method when the host key supplied is not recorded in the known_hosts file.
protected void	save()
void	store()

Methods inherited from class com.sshtools.common.knownhosts.KnownHostsKeyVerification

addEntry, addEntry, allowHost, clear, getKeyEntries, isKnownHost, load, removeEntries, removeEntries, removeEntries, removeEntry, resolveNames, setComment, setHashHosts, setUseCanonicalHostnames, setUseReverseDNS, toString, updateHostKey, useCanonicalHostname, useHashHosts, useReverseDNS, verifyHost, verifyHost

Methods inherited from class java.lang.Object

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

Constructor Details

KnownHostsFile

public KnownHostsFile(File file)
               throws SshException

Throws:

SshException

KnownHostsFile

public KnownHostsFile(Path file)
               throws SshException

Throws:

SshException

KnownHostsFile

public KnownHostsFile()
               throws SshException

Throws:

SshException

Method Details

defaultKnownHostsFile

public static Path defaultKnownHostsFile()

store

public void store()
           throws IOException

Throws:

IOException

getFile

public Path getFile()

getKnownHostsFile

public File getKnownHostsFile()

isHostFileWriteable

public boolean isHostFileWriteable()

Overrides:

isHostFileWriteable in class KnownHostsKeyVerification

onInvalidHostEntry

protected void onInvalidHostEntry(String entry)
                           throws SshException

Overrides:

onInvalidHostEntry in class KnownHostsKeyVerification

Throws:

SshException

onHostKeyMismatch

protected void onHostKeyMismatch(String host,
 List<SshPublicKey> allowedHostKey,
 SshPublicKey actualHostKey)
                          throws SshException

Description copied from class: KnownHostsKeyVerification

Called by the verifyHost method when the host key supplied by the host does not match the current key recording in the known hosts file.

Overrides:

onHostKeyMismatch in class KnownHostsKeyVerification

Parameters:

host - the name of the host

allowedHostKey - the current key recorded in the known_hosts file.

actualHostKey - the actual key supplied by the user

Throws:

SshException - if an error occurs

onUnknownHost

protected void onUnknownHost(String host,
 SshPublicKey key)
                      throws SshException

Description copied from class: KnownHostsKeyVerification

Called by the verifyHost method when the host key supplied is not recorded in the known_hosts file.

Overrides:

onUnknownHost in class KnownHostsKeyVerification

Parameters:

host - the name of the host

key - the public key supplied by the host

Throws:

SshException - if an error occurs

onRevokedKey

protected void onRevokedKey(String host,
 SshPublicKey key)

Description copied from class: KnownHostsKeyVerification

Called by the verifyHost method when the host key supplied is listed as a revoked key. This is informational, any changes made to the current entries will still result in a failed host verification.

Overrides:

onRevokedKey in class KnownHostsKeyVerification

onHostKeyUpdated

protected void onHostKeyUpdated(Set<String> names,
 SshPublicKey key)

Overrides:

onHostKeyUpdated in class KnownHostsKeyVerification

onHostKeyAdded

protected void onHostKeyAdded(Set<String> names,
 SshPublicKey key)

Overrides:

onHostKeyAdded in class KnownHostsKeyVerification

onHostKeyRemoved

protected void onHostKeyRemoved(Set<String> names,
 SshPublicKey key)

Overrides:

onHostKeyRemoved in class KnownHostsKeyVerification

save

protected void save()