dissect.target.plugins.apps.ssh.opensshd#

Module Contents#

Classes#

SSHServerPlugin

Base class for plugins.

Attributes#

SSHD_BOOLEAN_VALUES

SSHD_BOOLEAN_FIELDS

SSHD_INTEGER_FIELDS

SSHD_MULTIPLE_DEFINITIONS_ALLOWED_FIELDS

dissect.target.plugins.apps.ssh.opensshd.SSHD_BOOLEAN_VALUES = ('yes', 'no')#
dissect.target.plugins.apps.ssh.opensshd.SSHD_BOOLEAN_FIELDS = ('AllowAgentForwarding', 'DebianBanner', 'DisableForwarding', 'ChallengeResponseAuthentication',...#
dissect.target.plugins.apps.ssh.opensshd.SSHD_INTEGER_FIELDS = ('ClientAliveCountMax', 'ClientAliveInterval', 'LoginGraceTime', 'MaxAuthTries', 'MaxSessions',...#
dissect.target.plugins.apps.ssh.opensshd.SSHD_MULTIPLE_DEFINITIONS_ALLOWED_FIELDS = ('AcceptEnv', 'Include', 'ListenAddress', 'PermitListen', 'PermitOpen', 'Port')#
class dissect.target.plugins.apps.ssh.opensshd.SSHServerPlugin(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__ = 'sshd'#
check_compatible() → None#

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.

config() → Iterator[dissect.target.helpers.record.DynamicDescriptor]#

Parse all fields in the SSH server config in /etc/ssh/sshd_config.

This function parses each line (not starting with ‘#’) as a key-value pair, delimited by whitespace. The values of these fields can be one of three types: string, integer and boolean (string is the default).

We provide two lists that define the integer and boolean fields (SSHD_INTEGER_FIELDS and SSHD_BOOLEAN_FIELDS).

The fields in SSHD_MULTIPLE_DEFINITIONS_ALLOWED_FIELDS can be defined multiple times. We set their type to a list of the underlying value (e.g. varint[] for the Port field).

This parser does not (yet) follow Include directives.

Resources: