dissect.target.plugins.general.users

Module Contents

Classes

UserDetails
UsersPlugin	Internal plugin that provides helper functions for retrieving user details.

Attributes

UserRecord

dissect.target.plugins.general.users.UserRecord

class dissect.target.plugins.general.users.UserDetails

Bases: NamedTuple

user: UserRecord

home_path: dissect.target.helpers.fsutil.TargetPath | None

class dissect.target.plugins.general.users.UsersPlugin(target: dissect.target.target.Target)

Bases: dissect.target.plugin.InternalPlugin

Internal plugin that provides helper functions for retrieving user details.

__namespace__ = 'user_details'

Defines the plugin namespace.

find

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.

get(user: UserRecord) → UserDetails

Return additional details about the user.

all() → collections.abc.Iterator[UserDetails]

Return UserDetails objects for all users found.

all_with_home() → collections.abc.Iterator[UserDetails]

Return UserDetails objects for users that have existing directory set as home directory.

property all_home_paths: collections.abc.Iterator[dissect.target.helpers.fsutil.TargetPath]

Return all home directories of users, including miscellaneous user directories that may not be linked to discovered local users.