dissect.target.plugins.os.unix.ssh#

Module Contents#

Classes#

SSHPlugin

Base class for plugins.

Functions#

parse_ssh_public_key_file

parse_ssh_key

parse_known_host

Attributes#

AuthorizedKeysRecord

KnownHostRecord

PrivateKeyRecord

PublicKeyRecord

dissect.target.plugins.os.unix.ssh.AuthorizedKeysRecord#
dissect.target.plugins.os.unix.ssh.KnownHostRecord#
dissect.target.plugins.os.unix.ssh.PrivateKeyRecord#
dissect.target.plugins.os.unix.ssh.PublicKeyRecord#
class dissect.target.plugins.os.unix.ssh.SSHPlugin(target: dissect.target.Target)#

Bases: dissect.target.plugin.Plugin

Base class for plugins.

Plugins can optionally be namespaced by specifying the __namespace__ class attribute. Namespacing results in your plugin needing to be prefixed with this namespace when being called. For example, if your plugin has specified test as namespace and a function called example, you must call your plugin with test.example:

A Plugin class has the following private class attributes:

  • __namespace__

  • __record_descriptors__

With the following three being assigned in register():

  • __plugin__

  • __functions__

  • __exports__

Additionally, the methods and attributes of Plugin receive more private attributes by using decorators.

The export() decorator adds the following private attributes

  • __exported__

  • __output__: Set with the export() decorator.

  • __record__: Set with the export() decorator.

The internal() decorator and InternalPlugin set the __internal__ attribute. Finally. args() decorator sets the __args__ attribute.

Parameters:

target – The Target object to load the plugin for.

__namespace__ = 'ssh'#
check_compatible()#

Perform a compatibility check with the target.

This function should return None if the plugin is compatible with the current target (self.target). For example, check if a certain file exists. Otherwise it should raise an UnsupportedPluginError.

Raises:

UnsupportedPluginError – If the plugin could not be loaded.

authorized_keys() → Iterator[AuthorizedKeysRecord]#

Yields the content of the authorized_keys files on a Unix target per user.

known_hosts() → Iterator[KnownHostRecord]#

Yields the content of the known_hosts files on a Unix target per user.

private_keys() → Iterator[PrivateKeyRecord]#

Yields OpenSSH private keys on a Unix target per user.

public_keys() → Iterator[PublicKeyRecord]#

Yields all SSH public keys from all user home directories and /etc/ssh/.

dissect.target.plugins.os.unix.ssh.parse_ssh_public_key_file(path: pathlib.Path) → tuple[str, str, str]#
dissect.target.plugins.os.unix.ssh.parse_ssh_key(key_string: str) → tuple[str, str, str, str]#
dissect.target.plugins.os.unix.ssh.parse_known_host(known_host_string: str) → tuple[str, list, str, str, str]#