t.c.c.k.KnownHostsFile(object) : class documentation

Part of twisted.conch.client.knownhosts View Source View In Hierarchy

A structured representation of an OpenSSH-format ~/.ssh/known_hosts file.
Method __init__ Create a new, empty KnownHostsFile.
Method hasHostKey
Method verifyHostKey Verify the given host key for the given IP and host, asking for confirmation from, and notifying, the given UI about changes to this file.
Method addHostKey Add a new HashedEntry to the key database.
Method save Save this KnownHostsFile to the path it was loaded from.
Class Method fromPath
Instance Variable _entries a list of IKnownHostEntry providers.
Instance Variable _savePath the FilePath to save new entries to.
_entries =
a list of IKnownHostEntry providers.
_savePath =
the FilePath to save new entries to.
def __init__(self, savePath): (source)
Create a new, empty KnownHostsFile.

You want to use KnownHostsFile.fromPath to parse one of these.

def hasHostKey(self, hostname, key): (source)
ReturnsTrue if the given hostname and key are present in this file, False if they are not. (type: bool)
RaisesHostKeyChangedif the host key found for the given hostname does not match the given key.
def verifyHostKey(self, ui, hostname, ip, key): (source)
Verify the given host key for the given IP and host, asking for confirmation from, and notifying, the given UI about changes to this file.
ParametersuiThe user interface to request an IP address from.
hostnameThe hostname that the user requested to connect to.
ipThe string representation of the IP address that is actually being connected to.
keyThe public key of the server.
Returnsa Deferred that fires with True when the key has been verified, or fires with an errback when the key either cannot be verified or has changed. (type: Deferred)
def addHostKey(self, hostname, key): (source)
Add a new HashedEntry to the key database.

Note that you still need to call KnownHostsFile.save if you wish these changes to be persisted.

Returnsthe HashedEntry that was added.
def save(self): (source)
Save this KnownHostsFile to the path it was loaded from.
@classmethod
def fromPath(cls, path): (source)
ParameterspathA path object to use for both reading contents from and later saving to. (type: FilePath)
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.