Apache Mina SSHD 2.15.0 · org.apache.sshd.client.keyverifier.KnownHostsServerKeyVerifier

Modifier and Type	Class and Description
public static class	KnownHostsServerKeyVerifier.HostEntryPair Represents an entry in the internal verifier's cache

Modifier and Type	Field and Description
private final ServerKeyVerifier	delegate
private final AtomicReference<Supplier<? extends Collection<KnownHostsServerKeyVerifier.HostEntryPair>>>	keysSupplier
public static final String	KNOWN_HOSTS_FILE_OPTION Standard option used to indicate alternative known hosts file location
private ModifiedServerKeyAcceptor	modKeyAcceptor
public static final String	STRICT_CHECKING_OPTION Standard option used to indicate whether to use strict host key checking or not.
protected final Object	updateLock

Access	Constructor and Description
public	KnownHostsServerKeyVerifier(ServerKeyVerifier delegate, Path file)
public	KnownHostsServerKeyVerifier(ServerKeyVerifier delegate, Path file, LinkOption... options)

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if accept the server key anyway acceptIncompleteHostKeys(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, PublicKey The presented server `PublicKey` serverKey, Throwable The `Throwable` that indicates the reload failure reason) Called if failed to reload known hosts - by default invokes `acceptUnknownHostKey(ClientSession, SocketAddress, PublicKey)`
protected boolean	acceptKnownHostEntries(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
public boolean	acceptModifiedServerKey(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, KnownHostEntry Any original `KnownHostEntry` whose key did not match entry, PublicKey Any expected server `PublicKey` expected, PublicKey The presented server `PublicKey` actual) Implements org.apache.sshd.client.keyverifier.ModifiedServerKeyAcceptor.acceptModifiedServerKey. Invoked when a matching known host key was found but it does not match the presented one.
protected boolean	Returns: `true` if accept the server key acceptUnknownHostKey(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, PublicKey The presented server `PublicKey` serverKey) Invoked if none of the known hosts matches the current one - by default invokes the delegate.
protected List<KnownHostsServerKeyVerifier.HostEntryPair>	findKnownHostEntries(ClientSession clientSession, SocketAddress remoteAddress, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
public ServerKeyVerifier	getDelegateVerifier()
protected PublicKeyEntryResolver	getFallbackPublicKeyEntryResolver()
protected NamedFactory<Mac>	Returns: The digester `NamedFactory` - `null` if no hashing is to be made getHostValueDigester(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, SshdSocketAddress The entry's host name/address hostIdentity) Invoked by `prepareKnownHostEntry(ClientSession, SocketAddress, PublicKey)` in order to query whether to use a hashed value instead of a plain one for the written host name/address - default returns `null` - i.e., no hashing
protected Supplier<Collection<KnownHostsServerKeyVerifier.HostEntryPair>>	getKnownHostSupplier(ClientSession clientSession, Path file)
public ModifiedServerKeyAcceptor	Returns: The delegate `ModifiedServerKeyAcceptor` to consult if a server presents a modified key. If `null` then assumed to reject such a modification getModifiedServerKeyAcceptor()
protected void	handleKnownHostsFileUpdateFailure(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, PublicKey The server `PublicKey` that was attempted to update serverKey, Path The file `Path` to be updated file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> The currently known entries (may be `null`/empty knownHosts, Throwable The failure reason reason) Invoked when `updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection)` fails - by default just issues a warning Note there is a chance that the file is now corrupted and cannot be re-used, so we provide a way to recover it via overriding this method and using the cached entries to re-created it.
protected void	handleModifiedServerKeyUpdateFailure(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, KnownHostsServerKeyVerifier.HostEntryPair The `HostEntryPair` whose key does not match match, PublicKey The presented server `PublicKey` to be updated serverKey, Path The file `Path` to be updated file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> The currently cached entries (may be `null`/empty) knownHosts, Throwable The failure reason reason) Invoked if `#updateModifiedServerKey(ClientSession, SocketAddress, HostEntryPair, PublicKey, Path)` throws an exception.
protected void	handleRevokedKey(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, PublicKey The presented server `PublicKey` serverKey) Invoked if any matching host entry has a 'revoked' marker
protected KnownHostEntry	Returns: The `KnownHostEntry` to use - if `null` then entry is not updated in the file prepareKnownHostEntry(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, PublicKey The server `PublicKey` that was attempted to update serverKey) Invoked by `updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection)` in order to generate the host entry to be written
protected String	Returns: The updated line - ignored if `null`/empty or same as original one prepareModifiedServerKeyLine(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, KnownHostEntry The `KnownHostEntry` entry, String The current entry line data curLine, PublicKey The expected `PublicKey` expected, PublicKey The present key to be update actual) Invoked by `updateModifiedServerKey(ClientSession, SocketAddress, HostEntryPair, PublicKey, Path, Collection)` in order to prepare the replacement - by default it replaces the key part with the new one
protected List<KnownHostsServerKeyVerifier.HostEntryPair>	Returns: A `List` of the loaded `HostEntryPair`s - may be `null`/empty reloadKnownHosts(ClientSession The `ClientSession` that triggered this request session, Path The `Path` to reload from file)
protected PublicKey	Returns: The extracted `PublicKey` - `null` if none resolveHostKey(ClientSession The `ClientSession` that triggered this request session, KnownHostEntry The `KnownHostEntry` - ignored if `null` entry, PublicKeyEntryResolver The `PublicKeyEntryResolver` to use if immediate - decoding does not work - ignored if `null` resolver) Recover the associated public key from a known host entry
protected Collection<SshdSocketAddress>	Returns: A `Collection` of the `InetSocketAddress`-es to use - if `null`/empty then ignored (i.e., no matching is done or no entry is generated) resolveHostNetworkIdentities(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress) Retrieves the host identities to be used when matching or updating an entry for it - by default returns the reported remote address and the original connection target host name/address (if same, then only one value is returned)
protected void	setLoadedHostsEntries(Collection<KnownHostsServerKeyVerifier.HostEntryPair> keys)
public void	setModifiedServerKeyAcceptor(ModifiedServerKeyAcceptor The delegate `ModifiedServerKeyAcceptor` to consult if a server presents a modified key. If `null` then assumed to reject such a modification acceptor)
protected KnownHostEntry	Returns: The generated `KnownHostEntry` or `null` if nothing updated. If anything updated then the file will be re-loaded on next verification regardless of which server is verified updateKnownHostsFile(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, PublicKey The server `PublicKey` that to update serverKey, Path The file `Path` to be updated file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> The currently cached entries (may be `null`/empty) knownHosts) Invoked if a new previously unknown host key has been accepted - by default appends a new entry at the end of the currently monitored known hosts file
protected void	updateModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, KnownHostsServerKeyVerifier.HostEntryPair match)
protected void	updateModifiedServerKey(ClientSession The `ClientSession` clientSession, SocketAddress The remote host address remoteAddress, KnownHostsServerKeyVerifier.HostEntryPair The `HostEntryPair` whose key does not match match, PublicKey The presented server `PublicKey` to be updated actual, Path The file `Path` to be updated file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> The currently loaded entries knownHosts) Invoked if a matching host entry was found, but the key did not match and `acceptModifiedServerKey(ClientSession, SocketAddress, KnownHostEntry, PublicKey, PublicKey)` returned `true`.
public boolean	verifyServerKey(ClientSession the current `ClientSession` clientSession, SocketAddress the host's `SocketAddress` remoteAddress, PublicKey the presented server `PublicKey` serverKey) Implements org.apache.sshd.client.keyverifier.ServerKeyVerifier.verifyServerKey. Verify that the server key provided is really the one of the host.

Inherited from org.apache.sshd.common.util.io.ModifiableFileWatcher:: checkReloadRequired exists getPath lastModified resetReloadAttributes size toPathResource toPathResource toString updateReloadAttributes validateStrictConfigFilePermissions

public Class KnownHostsServerKeyVerifier

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary