Autopsy
4.21.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
|
Classes | |
enum | IngestType |
Public Member Functions | |
IngestJobSettings (final String executionContext) | |
IngestJobSettings (String executionContext, IngestType ingestType) | |
IngestJobSettings (String executionContext, IngestType ingestType, Collection< IngestModuleTemplate > moduleTemplates) | |
IngestJobSettings (String executionContext, IngestType ingestType, Collection< IngestModuleTemplate > moduleTemplates, FilesSet fileFilter) | |
List< IngestModuleTemplate > | getEnabledIngestModuleTemplates () |
String | getExecutionContext () |
FilesSet | getFileFilter () |
List< IngestModuleTemplate > | getIngestModuleTemplates () |
boolean | getProcessUnallocatedSpace () |
Path | getSavedModuleSettingsFolder () |
List< String > | getWarnings () |
void | save () |
void | saveAs (String executionContext) |
void | setFileFilter (FilesSet fileIngestFilter) |
void | setIngestModuleTemplates (List< IngestModuleTemplate > moduleTemplates) |
Private Member Functions | |
void | createSavedModuleSettingsFolder () |
String | getModuleSettingsFilePath (IngestModuleFactory factory) |
boolean | isPythonModuleSettingsFile (String moduleSettingsFilePath) |
void | load () |
IngestModuleIngestJobSettings | loadModuleSettings (IngestModuleFactory factory) |
void | saveModuleSettings (IngestModuleFactory factory, IngestModuleIngestJobSettings settings) |
void | store () |
Static Private Member Functions | |
static HashSet< String > | getModulesNames (String executionContext, String propertyName, String defaultSetting) |
static String | makeCsvList (Collection< String > collection) |
Private Attributes | |
String | executionContext |
FilesSet | fileFilter |
final IngestType | ingestType |
String | moduleSettingsFolderPath |
final List< IngestModuleTemplate > | moduleTemplates = new ArrayList<>() |
final List< String > | warnings = new ArrayList<>() |
Static Private Attributes | |
static final Set< String > | DEFAULT_DISABLED_MODULES |
static final String | DISABLED_MODULES_PROPERTY = "Disabled_Ingest_Modules" |
static final String | ENABLED_MODULES_PROPERTY = "Enabled_Ingest_Modules" |
static final String | LAST_FILE_INGEST_FILTER_PROPERTY = "Last_File_Ingest_Filter" |
static final Logger | logger = Logger.getLogger(IngestJobSettings.class.getName()) |
static final String | MODULE_SETTINGS_FILE_EXT = ".settings" |
static final String | MODULE_SETTINGS_FOLDER |
static final String | MODULE_SETTINGS_FOLDER_NAME = "IngestSettings" |
static final String | MODULE_SETTINGS_FOLDER_PATH |
static final CharSequence | PYTHON_CLASS_PROXY_PREFIX = "org.python.proxies.".subSequence(0, "org.python.proxies.".length() - 1) |
The settings for an ingest job.
Definition at line 54 of file IngestJobSettings.java.
org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings | ( | final String | executionContext | ) |
Loads the ingest job settings for a given execution context. If settings for the context have not been previously saved, default settings are used.
Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.
executionContext | The execution context identifier. |
Definition at line 132 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, and org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext.
org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings | ( | String | executionContext, |
IngestType | ingestType | ||
) |
Loads the ingest job settings for a given execution context. If settings for the context have not been previously saved, default settings are used.
Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.
executionContext | The execution context identifier. |
ingestType | Whether to run all ingest modules, data source level ingest modules only, or file level ingest modules only. |
Definition at line 150 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder(), org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType, and org.sleuthkit.autopsy.ingest.IngestJobSettings.load().
org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings | ( | String | executionContext, |
IngestType | ingestType, | ||
Collection< IngestModuleTemplate > | moduleTemplates | ||
) |
Creates entirely new ingest job settings for a given context without saving them.
executionContext | The execution context identifier. |
ingestType | Whether to run all ingest modules, data source level ingest modules only, or file level ingest modules only. |
moduleTemplates | A collection of ingest module templates for creating fully configured ingest modules; each template combines an ingest module factory with ingest module job settings and an enabled flag. |
Definition at line 174 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, and org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType.
org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings | ( | String | executionContext, |
IngestType | ingestType, | ||
Collection< IngestModuleTemplate > | moduleTemplates, | ||
FilesSet | fileFilter | ||
) |
Creates entirely new ingest job settings for a given context without saving them.
executionContext | The execution context identifier. |
ingestType | Whether to run all ingest modules, data source level ingest modules only, or file level ingest modules only. |
moduleTemplates | A collection of ingest module templates for creating fully configured ingest modules; each template combines an ingest module factory with ingest module job settings and an enabled flag. |
fileFilter | A file filter in the form of a files set. |
Definition at line 198 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestJobSettings.ingestType, org.sleuthkit.autopsy.ingest.IngestJobSettings.moduleTemplates, and org.sleuthkit.autopsy.ingest.IngestJobSettings.setFileFilter().
|
private |
Creates the module folder for these ingest job settings, if it does not already exist.
Definition at line 334 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.getSavedModuleSettingsFolder().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.save(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs().
List<IngestModuleTemplate> org.sleuthkit.autopsy.ingest.IngestJobSettings.getEnabledIngestModuleTemplates | ( | ) |
Gets the enabled ingest module templates for this ingest job.
Definition at line 306 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.integrationtesting.IngestModuleSetupManager.configure().
String org.sleuthkit.autopsy.ingest.IngestJobSettings.getExecutionContext | ( | ) |
Gets the execution context identifier.
Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.
Definition at line 257 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext.
Referenced by org.sleuthkit.autopsy.integrationtesting.IngestModuleSetupManager.configure().
FilesSet org.sleuthkit.autopsy.ingest.IngestJobSettings.getFileFilter | ( | ) |
Gets the file filter for the ingest job.
Definition at line 266 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.fileFilter, and org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager.getDefaultFilter().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.fileIngestFilterComboBoxActionPerformed(), and org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestJobSettingsPanel().
List<IngestModuleTemplate> org.sleuthkit.autopsy.ingest.IngestJobSettings.getIngestModuleTemplates | ( | ) |
Gets the enabled ingest module templates for the ingest job.
Definition at line 287 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.IngestJobSettingsPanel().
|
private |
Returns the absolute path for the ingest job settings file for a given ingest module for these ingest job settings.
factory | The ingest module factory for an ingest module. |
Definition at line 591 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.MODULE_SETTINGS_FILE_EXT, and org.sleuthkit.autopsy.python.FactoryClassNameNormalizer.normalize().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings().
|
staticprivate |
Gets a list of enabled module names from the properties file for the execution context of these ingest job settings.
executionContext | The execution context identifier. |
propertyName | The property name. |
defaultSetting | The default list of module names to se and return if the property does not exist. |
Definition at line 484 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.settingExists().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load().
boolean org.sleuthkit.autopsy.ingest.IngestJobSettings.getProcessUnallocatedSpace | ( | ) |
Gets the process unallocated space flag for this ingest job.
Definition at line 322 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.modules.interestingitems.FilesSet.ingoresUnallocatedSpace().
Path org.sleuthkit.autopsy.ingest.IngestJobSettings.getSavedModuleSettingsFolder | ( | ) |
Gets the path to the module settings folder for these ingest job settings.
Definition at line 209 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder().
List<String> org.sleuthkit.autopsy.ingest.IngestJobSettings.getWarnings | ( | ) |
Gets and clears any accumulated warnings associated with the loading or saving of these ingest job settings.
Definition at line 242 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.warnings.
Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.analyze(), and org.sleuthkit.autopsy.commandlineingest.CommandLineIngestSettingsPanel.showWarnings().
|
private |
Determines if the moduleSettingsFilePath is that of a serialized jython instance. Serialized Jython instances (settings saved on the disk) contain "org.python.proxies." in their fileName based on the current implementation.
moduleSettingsFilePath | path to the module settings file. |
Definition at line 553 of file IngestJobSettings.java.
|
private |
Loads the saved or default ingest job settings for the execution context into memory.
Get the ingest module factories discovered by the ingest module loader.
Get the enabled/disabled ingest modules settings for this context. By default, all loaded modules except Plaso are enabled.
Check for missing modules and create warnings if any are found.
Create ingest module templates. Each template encapsulates a module factory, the module settings for this context, and an enabled flag.
Update the enabled/disabled ingest module settings for this context to reflect any missing modules or newly discovered modules.
Restore the last used File Ingest Filter
Definition at line 349 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.ALL_MODULES, org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.DATA_SOURCE_ONLY, org.sleuthkit.autopsy.ingest.IngestJobSettings.DISABLED_MODULES_PROPERTY, org.sleuthkit.autopsy.ingest.IngestJobSettings.ENABLED_MODULES_PROPERTY, org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestType.FILES_ONLY, org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager.getCustomFileIngestFilters(), org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager.getDefaultFilter(), org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager.getInstance(), org.sleuthkit.autopsy.ingest.IngestModuleTemplate.getModuleName(), org.sleuthkit.autopsy.ingest.IngestJobSettings.getModulesNames(), org.sleuthkit.autopsy.modules.interestingitems.FilesSet.getName(), org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager.getStandardFileIngestFilters(), org.sleuthkit.autopsy.ingest.IngestJobSettings.LAST_FILE_INGEST_FILTER_PROPERTY, org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCsvList(), org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting(), org.sleuthkit.autopsy.ingest.IngestModuleTemplate.setEnabled(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.settingExists().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings().
|
private |
Gets the saved or default ingest job settings for a given ingest module.
factory | The ingest module factory. |
Definition at line 564 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestModuleFactory.getDefaultIngestJobSettings(), org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleDisplayName(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load().
|
staticprivate |
Makes a comma-separated values list from a collection of strings.
collection | A collection of strings. |
Definition at line 651 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().
void org.sleuthkit.autopsy.ingest.IngestJobSettings.save | ( | ) |
Saves these ingest job settings.
Definition at line 216 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().
Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestSettingsPanel.displayIngestJobSettingsPanel().
void org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs | ( | String | executionContext | ) |
Saves these ingest job settings for use in a different execution context.
Some examples of execution contexts include the Add Data Source wizard, the Run Ingest Modules dialog, and auto ingest. Different execution contexts may have different ingest job settings.
executionContext | The new execution context. |
Definition at line 230 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.createSavedModuleSettingsFolder(), org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().
|
private |
Serializes the ingest job settings for a given ingest module.
factory | The ingest module factory for the module. |
settings | The ingest job settings for the ingest module |
Definition at line 632 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.executionContext, org.sleuthkit.autopsy.ingest.IngestModuleFactory.getModuleDisplayName(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.store().
void org.sleuthkit.autopsy.ingest.IngestJobSettings.setFileFilter | ( | FilesSet | fileIngestFilter | ) |
Sets the file filter for the ingest job.
fileIngestFilter | The filter as a files set. |
Definition at line 278 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.analyze(), org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings(), and org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.updateSelectedFilter().
void org.sleuthkit.autopsy.ingest.IngestJobSettings.setIngestModuleTemplates | ( | List< IngestModuleTemplate > | moduleTemplates | ) |
Sets the enabled ingest module templates for the ingest job.
moduleTemplates | The ingest module templates. |
Definition at line 296 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel.getSettings().
|
private |
Saves the ingest job settings for this context.
Save the enabled/disabled ingest module settings.
Save the last used File Ingest Filter setting for this context.
Definition at line 600 of file IngestJobSettings.java.
References org.sleuthkit.autopsy.ingest.IngestJobSettings.DISABLED_MODULES_PROPERTY, org.sleuthkit.autopsy.ingest.IngestJobSettings.ENABLED_MODULES_PROPERTY, org.sleuthkit.autopsy.modules.interestingitems.FilesSet.getName(), org.sleuthkit.autopsy.ingest.IngestJobSettings.makeCsvList(), org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.save(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs().
|
staticprivate |
Definition at line 61 of file IngestJobSettings.java.
|
staticprivate |
Definition at line 57 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().
|
staticprivate |
Definition at line 56 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.store().
|
private |
Definition at line 82 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getExecutionContext(), org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.loadModuleSettings(), org.sleuthkit.autopsy.ingest.IngestJobSettings.saveAs(), and org.sleuthkit.autopsy.ingest.IngestJobSettings.saveModuleSettings().
|
private |
Definition at line 83 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getFileFilter().
|
private |
Definition at line 79 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings().
|
staticprivate |
Definition at line 58 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.load().
|
staticprivate |
Definition at line 78 of file IngestJobSettings.java.
|
staticprivate |
Definition at line 76 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getModuleSettingsFilePath().
|
staticprivate |
Definition at line 66 of file IngestJobSettings.java.
|
staticprivate |
Definition at line 59 of file IngestJobSettings.java.
|
staticprivate |
Definition at line 71 of file IngestJobSettings.java.
|
private |
Definition at line 84 of file IngestJobSettings.java.
|
private |
Definition at line 80 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.IngestJobSettings().
|
staticprivate |
Definition at line 77 of file IngestJobSettings.java.
|
private |
Definition at line 81 of file IngestJobSettings.java.
Referenced by org.sleuthkit.autopsy.ingest.IngestJobSettings.getWarnings().
Copyright © 2012-2022 Basis Technology. Generated on: Tue Feb 6 2024
This work is licensed under a
Creative Commons Attribution-Share Alike 3.0 United States License.