Package com.sshtools.common.knownhosts

Class ConsoleKnownHostsFile

java.lang.Object

com.sshtools.common.knownhosts.KnownHostsKeyVerification

com.sshtools.common.knownhosts.KnownHostsFile

com.sshtools.common.knownhosts.ConsoleKnownHostsFile

All Implemented Interfaces:

HostKeyUpdater, HostKeyVerification

public class ConsoleKnownHostsFile
extends KnownHostsFile

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
ConsoleKnownHostsFile()
ConsoleKnownHostsFile(File file)
ConsoleKnownHostsFile(Path file)

Method Summary

Modifier and Type	Method	Description
protected void	onHostKeyMismatch(String host, List<SshPublicKey> allowedHostKey, SshPublicKey actual)	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	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.
void	onUnknownHost(String host, SshPublicKey pk)	Prompts the user through the console to verify the host key.

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

defaultKnownHostsFile, getFile, getKnownHostsFile, isHostFileWriteable, onHostKeyAdded, onHostKeyRemoved, onHostKeyUpdated, save, 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

ConsoleKnownHostsFile

public ConsoleKnownHostsFile()
                      throws SshException,
IOException

Throws:

SshException

IOException

ConsoleKnownHostsFile

public ConsoleKnownHostsFile(File file)
                      throws SshException,
IOException

Throws:

SshException

IOException

ConsoleKnownHostsFile

public ConsoleKnownHostsFile(Path file)
                      throws SshException,
IOException

Throws:

SshException

IOException

Method Details

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 KnownHostsFile

onHostKeyMismatch

protected void onHostKeyMismatch(String host,
 List<SshPublicKey> allowedHostKey,
 SshPublicKey actual)
                          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 KnownHostsFile

Parameters:

host - the name of the host

allowedHostKey - the current key recorded in the known_hosts file.

actual - the actual key supplied by the user

Throws:

SshException - if an error occurs

onUnknownHost

public void onUnknownHost(String host,
 SshPublicKey pk)

Prompts the user through the console to verify the host key.

Overrides:

onUnknownHost in class KnownHostsFile

Parameters:

host - the name of the host

pk - the public key supplied by the host

onInvalidHostEntry

protected void onInvalidHostEntry(String entry)
                           throws SshException

Overrides:

onInvalidHostEntry in class KnownHostsFile

Throws:

SshException