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

class documentation

class twisted.conch.client.knownhosts.PlainEntry(_BaseEntry): (source)

A PlainEntry is a representation of a plain-text entry in a known_hosts file.

Method	__init__	Undocumented
Class Method	fromString	Parse a plain-text entry in a known_hosts file, and return a corresponding `PlainEntry`.
Method	matchesHost	Check to see if this entry matches a given hostname.
Method	toString	Implement `IKnownHostEntry.toString` by recording the comma-separated hostnames, key type, and base-64 encoded key.
Instance Variable	_hostnames	the list of all host-names associated with this entry.

Inherited from _BaseEntry:

Instance Variable	keyType	The type of the key; either ssh-dss or ssh-rsa.
Instance Variable	publicKey	The server public key indicated by this line.
Instance Variable	comment	Trailing garbage after the key line.
Method	matchesKey	Check to see if this entry matches a given key object.

_hostnames = (source)

the list of all host-names associated with this entry.

(type: list of bytes)

def __init__(self, hostnames, keyType, publicKey, comment): (source)

Undocumented

@classmethod
def fromString(cls, string): (source)

Parse a plain-text entry in a known_hosts file, and return a corresponding PlainEntry.

Parameters	string	a space-separated string formatted like "hostname key-type base64-key-data comment". (type: `bytes`)
Returns	an IKnownHostEntry representing the hostname and key in the input line. (type: `PlainEntry`)
Raises	DecodeError	if the key is not valid encoded as valid base64.
	InvalidEntry	if the entry does not have the right number of elements and is therefore invalid.
	BadKeyError	if the key, once decoded from base64, is not actually an SSH key.

def matchesHost(self, hostname): (source)

Check to see if this entry matches a given hostname.

Parameters	hostname	A hostname or IP address literal to check against this entry. (type: `bytes`)
Returns	`True` if this entry is for the given hostname or IP address, `False` otherwise. (type: `bool`)

def toString(self): (source)

Implement IKnownHostEntry.toString by recording the comma-separated hostnames, key type, and base-64 encoded key.

Returns The string representation of this entry, with unhashed hostname information. (type: bytes)

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.