twisted.conch.client.knownhosts.KnownHostsFile : API documentation

A structured representation of an OpenSSH-format ~/.ssh/known_hosts file.

Instance Variables	_entries	a list of `IKnownHostEntry` providers.
	_savePath	the `FilePath` to save new entries to.

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

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)

Returns	True if the given hostname and key are present in this file, False if they are not. (type: `bool` )
Raises	HostKeyChanged	if 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.

Parameters	ui	The user interface to request an IP address from.
	hostname	The hostname that the user requested to connect to.
	ip	The string representation of the IP address that is actually being connected to.
	key	The public key of the server.
Returns	a `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.

Returns the HashedEntry that was added.

def save(self): (source)

Save this KnownHostsFile to the path it was loaded from.

@classmethod
def fromPath(cls, path): (source)

Parameters path A path object to use for both reading contents from and later saving to. (type: FilePath )

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