|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sshtools.j2ssh.transport.AbstractKnownHostsKeyVerification
public abstract class AbstractKnownHostsKeyVerification
An abstract HostKeyVerification
class providing validation
against the known_hosts format.
Constructor Summary | |
---|---|
AbstractKnownHostsKeyVerification(java.lang.String knownhosts)
Constructs a host key verification instance reading the specified known_hosts file. |
Method Summary | |
---|---|
java.util.Map |
allowedHosts()
Returns a Map of the allowed hosts. |
void |
allowHost(java.lang.String host,
SshPublicKey pk,
boolean always)
Allows a host key, optionally recording the key to the known_hosts file. |
boolean |
isHostFileWriteable()
Determines whether the host file is writable. |
abstract void |
onHostKeyMismatch(java.lang.String host,
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. |
abstract void |
onUnknownHost(java.lang.String host,
SshPublicKey key)
Called by the verifyHost method when the host key supplied
is not recorded in the known_hosts file. |
void |
removeAllowedHost(java.lang.String host)
Removes an allowed host. |
void |
saveHostFile()
Save's the host key file to be saved. |
java.lang.String |
toString()
Outputs the allowed hosts in the known_hosts file format. |
boolean |
verifyHost(java.lang.String host,
SshPublicKey pk)
Verifies a host key against the list of known_hosts. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractKnownHostsKeyVerification(java.lang.String knownhosts) throws InvalidHostFileException
Constructs a host key verification instance reading the specified known_hosts file.
knownhosts
- the path of the known_hosts file
InvalidHostFileException
- if the known_hosts file is invalidMethod Detail |
---|
public boolean isHostFileWriteable()
Determines whether the host file is writable.
public abstract void onHostKeyMismatch(java.lang.String host, SshPublicKey allowedHostKey, SshPublicKey actualHostKey) throws TransportProtocolException
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.
host
- the name of the hostallowedHostKey
- the current key recorded in the known_hosts file.actualHostKey
- the actual key supplied by the user
TransportProtocolException
- if an error occurspublic abstract void onUnknownHost(java.lang.String host, SshPublicKey key) throws TransportProtocolException
Called by the verifyHost
method when the host key supplied
is not recorded in the known_hosts file.
host
- the name of the hostkey
- the public key supplied by the host
TransportProtocolException
- if an error occurspublic void allowHost(java.lang.String host, SshPublicKey pk, boolean always) throws InvalidHostFileException
Allows a host key, optionally recording the key to the known_hosts file.
host
- the name of the hostpk
- the public key to allowalways
- true if the key should be written to the known_hosts file
InvalidHostFileException
- if the host file cannot be writtenpublic java.util.Map allowedHosts()
Returns a Map of the allowed hosts.
The keys of the returned Map are comma separated strings of "hostname,ipaddress". The value objects are Maps containing a string key of the public key alogorithm name and the public key as the value.
public void removeAllowedHost(java.lang.String host)
Removes an allowed host.
host
- the host to removepublic boolean verifyHost(java.lang.String host, SshPublicKey pk) throws TransportProtocolException
Verifies a host key against the list of known_hosts.
If the host unknown or the key does not match the currently allowed host
key the abstract onUnknownHost
or
onHostKeyMismatch
methods are called so that the caller
may identify and allow the host.
verifyHost
in interface HostKeyVerification
host
- the name of the hostpk
- the host key supplied
TransportProtocolException
- if an error occurspublic void saveHostFile() throws InvalidHostFileException
Save's the host key file to be saved.
InvalidHostFileException
- if the host file is invalidpublic java.lang.String toString()
Outputs the allowed hosts in the known_hosts file format.
The format consists of any number of lines each representing one key for a single host.
titan,192.168.1.12 ssh-dss AAAAB3NzaC1kc3MAAACBAP1/U4Ed.....
titan,192.168.1.12 ssh-rsa AAAAB3NzaC1kc3MAAACBAP1/U4Ed.....
einstein,192.168.1.40 ssh-dss AAAAB3NzaC1kc3MAAACBAP1/U4Ed.....
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |