19 package org.sleuthkit.autopsy.ingest;
22 import java.io.FileInputStream;
23 import java.io.FileOutputStream;
24 import java.io.IOException;
25 import java.nio.file.Files;
26 import java.nio.file.Path;
27 import java.nio.file.Paths;
28 import java.util.ArrayList;
29 import java.util.Collection;
30 import java.util.Collections;
31 import java.util.HashSet;
32 import java.util.List;
34 import java.util.Objects;
35 import java.util.logging.Level;
36 import org.openide.util.NbBundle;
37 import org.openide.util.io.NbObjectInputStream;
38 import org.openide.util.io.NbObjectOutputStream;
64 ).toAbsolutePath().toString();
67 private static final CharSequence
PYTHON_CLASS_PROXY_PREFIX =
"org.python.proxies.".subSequence(0,
"org.python.proxies.".length() - 1);
71 private final List<String>
warnings =
new ArrayList<>();
79 static String getBaseSettingsPath() {
91 static String getModuleSettingsResource(String executionContext) {
92 return Paths.get(MODULE_SETTINGS_FOLDER, executionContext).toString();
108 return Paths.get(getBaseSettingsPath(), executionContext);
145 this.executionContext = executionContext +
"." + this.ingestType.name();
169 this.executionContext = executionContext +
"." + this.ingestType.name();
171 this.moduleTemplates.addAll(moduleTemplates);
220 public void saveAs(String executionContext) {
233 List<String> warningMessages =
new ArrayList<>(this.
warnings);
234 this.warnings.clear();
235 return warningMessages;
257 if (fileFilter == null) {
269 this.fileFilter = fileIngestFilter;
278 return Collections.unmodifiableList(this.moduleTemplates);
287 this.moduleTemplates.clear();
288 this.moduleTemplates.addAll(moduleTemplates);
297 List<IngestModuleTemplate> enabledModuleTemplates =
new ArrayList<>();
299 if (moduleTemplate.isEnabled()) {
300 enabledModuleTemplates.add(moduleTemplate);
303 return enabledModuleTemplates;
313 boolean processUnallocated =
true;
314 if (!Objects.isNull(
this.fileFilter)) {
317 return processUnallocated;
327 Files.createDirectories(folder);
328 this.moduleSettingsFolderPath = folder.toAbsolutePath().toString();
329 }
catch (IOException | SecurityException ex) {
330 logger.log(Level.SEVERE,
"Failed to create ingest module settings directory " +
this.moduleSettingsFolderPath, ex);
331 this.warnings.add(NbBundle.getMessage(
IngestJobSettings.class,
"IngestJobSettings.createModuleSettingsFolder.warning"));
344 List<IngestModuleFactory> moduleFactories =
new ArrayList<>();
345 List<IngestModuleFactory> allModuleFactories = IngestModuleFactoryLoader.getIngestModuleFactories();
346 HashSet<String> loadedModuleNames =
new HashSet<>();
350 if (moduleFactory.isDataArtifactIngestModuleFactory() || ingestType.equals(
IngestType.
ALL_MODULES)) {
351 moduleFactories.add(moduleFactory);
353 moduleFactories.add(moduleFactory);
354 }
else if (this.ingestType.equals(
IngestType.
FILES_ONLY) && moduleFactory.isFileIngestModuleFactory()) {
355 moduleFactories.add(moduleFactory);
360 loadedModuleNames.add(moduleFactory.getModuleDisplayName());
370 final String plasoModuleName =
"Plaso";
371 boolean plasoLoaded = loadedModuleNames.contains(plasoModuleName);
373 loadedModuleNames.remove(plasoModuleName);
385 if (!enabledModuleNames.contains(plasoModuleName) && !disabledModuleNames.contains(plasoModuleName)) {
386 disabledModuleNames.add(plasoModuleName);
391 loadedModuleNames.add(plasoModuleName);
397 List<String> missingModuleNames =
new ArrayList<>();
398 for (String moduleName : enabledModuleNames) {
399 if (!loadedModuleNames.contains(moduleName)) {
400 missingModuleNames.add(moduleName);
403 for (String moduleName : disabledModuleNames) {
404 if (!loadedModuleNames.contains(moduleName)) {
405 missingModuleNames.add(moduleName);
408 for (String moduleName : missingModuleNames) {
409 enabledModuleNames.remove(moduleName);
410 disabledModuleNames.remove(moduleName);
411 String warning = NbBundle.getMessage(
IngestJobSettings.class,
"IngestJobSettings.missingModule.warning", moduleName);
412 logger.log(Level.WARNING, warning);
413 this.warnings.add(warning);
423 if (enabledModuleNames.contains(moduleName)) {
425 }
else if (disabledModuleNames.contains(moduleName)) {
432 enabledModuleNames.add(moduleName);
434 this.moduleTemplates.add(moduleTemplate);
441 String ingestModuleResource = getModuleSettingsResource(this.executionContext);
455 fileIngestFilters.put(fSet.getName(), fSet);
460 logger.log(Level.SEVERE,
"Failed to get file filter from .properties file, default filter being used", ex);
475 private static HashSet<String>
getModulesNames(String executionContext, String propertyName, String defaultSetting) {
476 String ingestModuleResource = getModuleSettingsResource(executionContext);
480 HashSet<String> moduleNames =
new HashSet<>();
482 if (!modulesSetting.isEmpty()) {
483 String[] settingNames = modulesSetting.split(
", ");
484 for (String name : settingNames) {
490 case "Thunderbird Parser":
492 moduleNames.add(
"Email Parser");
494 case "File Extension Mismatch Detection":
495 moduleNames.add(
"Extension Mismatch Detector");
500 moduleNames.add(
"Data Source Integrity");
502 case "Archive Extractor":
503 moduleNames.add(
"Embedded File Extractor");
505 case "Correlation Engine":
506 moduleNames.add(
"Central Repository");
509 moduleNames.add(
"Picture Analyzer");
511 case "Drone Analyzer":
512 moduleNames.add(
"DJI Drone Analyzer");
515 moduleNames.add(name);
530 static List<String> getEnabledModules(String context) {
531 return new ArrayList<>(
getModulesNames(context, ENABLED_MODULES_PROPERTY,
""));
545 return moduleSettingsFilePath.contains(PYTHON_CLASS_PROXY_PREFIX);
558 File settingsFile =
new File(moduleSettingsFilePath);
559 if (settingsFile.exists()) {
560 try (NbObjectInputStream in =
new NbObjectInputStream(
new FileInputStream(settingsFile.getAbsolutePath()))) {
562 }
catch (IOException | ClassNotFoundException ex) {
564 logger.log(Level.WARNING, warning, ex);
565 this.warnings.add(warning);
568 if (settings == null) {
584 Path path = Paths.get(
this.moduleSettingsFolderPath, fileName);
585 return path.toAbsolutePath().toString();
595 HashSet<String> enabledModuleNames =
new HashSet<>();
596 HashSet<String> disabledModuleNames =
new HashSet<>();
598 saveModuleSettings(moduleTemplate.getModuleFactory(), moduleTemplate.getModuleSettings());
599 String moduleName = moduleTemplate.getModuleName();
600 if (moduleTemplate.isEnabled()) {
601 enabledModuleNames.add(moduleName);
603 disabledModuleNames.add(moduleName);
607 String ingestModuleResource = getModuleSettingsResource(this.executionContext);
625 try (NbObjectOutputStream out =
new NbObjectOutputStream(
new FileOutputStream(moduleSettingsFilePath))) {
626 out.writeObject(settings);
627 }
catch (IOException ex) {
629 logger.log(Level.SEVERE, warning, ex);
630 this.warnings.add(warning);
642 private static String
makeCsvList(Collection<String> collection) {
643 if (collection == null || collection.isEmpty()) {
647 ArrayList<String> list =
new ArrayList<>();
648 list.addAll(collection);
649 StringBuilder csvList =
new StringBuilder();
650 for (
int i = 0; i < list.size() - 1; ++i) {
651 csvList.append(list.get(i)).append(
", ");
653 csvList.append(list.get(list.size() - 1));
654 return csvList.toString();
static synchronized String getConfigSetting(String moduleName, String settingName)
static final String DISABLED_MODULES_PROPERTY
IngestJobSettings(final String executionContext)
static final String LAST_FILE_INGEST_FILTER_PROPERTY
static List< FilesSet > getStandardFileIngestFilters()
static final String ENABLED_MODULES_PROPERTY
void saveModuleSettings(IngestModuleFactory factory, IngestModuleIngestJobSettings settings)
final IngestType ingestType
void setEnabled(boolean enabled)
List< IngestModuleTemplate > getEnabledIngestModuleTemplates()
String moduleSettingsFolderPath
static HashSet< String > getModulesNames(String executionContext, String propertyName, String defaultSetting)
String getExecutionContext()
static synchronized FilesSetsManager getInstance()
static final String MODULE_SETTINGS_FILE_EXT
Map< String, FilesSet > getCustomFileIngestFilters()
static String makeCsvList(Collection< String > collection)
static final String MODULE_SETTINGS_FOLDER
void setIngestModuleTemplates(List< IngestModuleTemplate > moduleTemplates)
static synchronized boolean settingExists(String moduleName, String settingName)
static final String MODULE_SETTINGS_FOLDER_PATH
final List< IngestModuleTemplate > moduleTemplates
static final String MODULE_SETTINGS_FOLDER_NAME
IngestJobSettings(String executionContext, IngestType ingestType, Collection< IngestModuleTemplate > moduleTemplates, FilesSet fileFilter)
static synchronized void setConfigSetting(String moduleName, String settingName, String settingVal)
void setFileFilter(FilesSet fileIngestFilter)
IngestModuleIngestJobSettings loadModuleSettings(IngestModuleFactory factory)
Path getSavedModuleSettingsFolder()
boolean getProcessUnallocatedSpace()
void createSavedModuleSettingsFolder()
static FilesSet getDefaultFilter()
final List< String > warnings
String getModuleSettingsFilePath(IngestModuleFactory factory)
List< String > getWarnings()
default IngestModuleIngestJobSettings getDefaultIngestJobSettings()
List< IngestModuleTemplate > getIngestModuleTemplates()
static final Logger logger
synchronized static Logger getLogger(String name)
IngestJobSettings(String executionContext, IngestType ingestType, Collection< IngestModuleTemplate > moduleTemplates)
String getModuleDisplayName()
void saveAs(String executionContext)
boolean isPythonModuleSettingsFile(String moduleSettingsFilePath)
boolean ingoresUnallocatedSpace()
static final CharSequence PYTHON_CLASS_PROXY_PREFIX
IngestJobSettings(String executionContext, IngestType ingestType)
static String normalize(String canonicalClassName)