Class DefaultKnownHostsServerKeyVerifier

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.io.ModifiableFileWatcher

org.apache.sshd.client.keyverifier.KnownHostsServerKeyVerifier

org.apache.sshd.client.keyverifier.DefaultKnownHostsServerKeyVerifier

All Implemented Interfaces:

ModifiedServerKeyAcceptor, ServerKeyVerifier

public class DefaultKnownHostsServerKeyVerifier
extends KnownHostsServerKeyVerifier

Monitors the ~/.ssh/known_hosts file of the user currently running the client, updating and re-loading it if necessary. It also (optionally) enforces the same permissions regime as OpenSSH.

Nested Class Summary

Nested classes/interfaces inherited from class KnownHostsServerKeyVerifier

KnownHostsServerKeyVerifier.HostEntryPair

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	strict

Fields inherited from class KnownHostsServerKeyVerifier

KNOWN_HOSTS_FILE_OPTION, STRICT_CHECKING_OPTION, updateLock

Fields inherited from class ModifiableFileWatcher

options, STRICTLY_PROHIBITED_FILE_PERMISSION

Fields inherited from class AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate)
DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate, boolean strict)
DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate, boolean strict, File file)
DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate, boolean strict, Path file, LinkOption... options)

Method Summary

Modifier and Type	Method	Description
final boolean	isStrict()
protected List<KnownHostsServerKeyVerifier.HostEntryPair>	reloadKnownHosts(ClientSession session, Path file)

Methods inherited from class KnownHostsServerKeyVerifier

acceptIncompleteHostKeys, acceptKnownHostEntries, acceptModifiedServerKey, acceptUnknownHostKey, findKnownHostEntries, getDelegateVerifier, getFallbackPublicKeyEntryResolver, getHostValueDigester, getKnownHostSupplier, getModifiedServerKeyAcceptor, handleKnownHostsFileUpdateFailure, handleModifiedServerKeyUpdateFailure, handleRevokedKey, prepareKnownHostEntry, prepareModifiedServerKeyLine, resolveHostKey, resolveHostNetworkIdentities, setLoadedHostsEntries, setModifiedServerKeyAcceptor, updateKnownHostsFile, updateModifiedServerKey, updateModifiedServerKey, verifyServerKey

Methods inherited from class ModifiableFileWatcher

checkReloadRequired, exists, getPath, lastModified, resetReloadAttributes, size, toPathResource, toPathResource, toString, updateReloadAttributes, validateStrictConfigFilePermissions

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

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

Field Details

strict

private final boolean strict

Constructor Details

DefaultKnownHostsServerKeyVerifier

public DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate)

DefaultKnownHostsServerKeyVerifier

public DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate,
 boolean strict)

DefaultKnownHostsServerKeyVerifier

public DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate,
 boolean strict,
 File file)

DefaultKnownHostsServerKeyVerifier

public DefaultKnownHostsServerKeyVerifier(ServerKeyVerifier delegate,
 boolean strict,
 Path file,
 LinkOption... options)

Method Details

isStrict

public final boolean isStrict()

Returns:

If true then makes sure that the containing folder has 0700 access and the file 0644. Note: for Windows it does not check these permissions

See Also:

• ModifiableFileWatcher.validateStrictConfigFilePermissions(Path, LinkOption...)

reloadKnownHosts

protected List<KnownHostsServerKeyVerifier.HostEntryPair> reloadKnownHosts(ClientSession session,
 Path file)
                                                                    throws IOException,
GeneralSecurityException

Overrides:

reloadKnownHosts in class KnownHostsServerKeyVerifier

Parameters:

session - The ClientSession that triggered this request

file - The Path to reload from

Returns:

A List of the loaded KnownHostsServerKeyVerifier.HostEntryPairs - may be null/empty

Throws:

IOException - If failed to parse the file

GeneralSecurityException - If failed to resolve the encoded public keys