# Sample module in the public domain. Feel free to use this as a template # for your modules (and you can remove this header and take complete credit # and liability) # # Contact: Brian Carrier [carrier sleuthkit [dot] org] # # This is free and unencumbered software released into the public domain. # # Anyone is free to copy, modify, publish, use, compile, sell, or # distribute this software, either in source code form or as a compiled # binary, for any purpose, commercial or non-commercial, and by any # means. # # In jurisdictions that recognize copyright laws, the author or authors # of this software dedicate any and all copyright interest in the # software to the public domain. We make this dedication for the benefit # of the public at large and to the detriment of our heirs and # successors. We intend this dedication to be an overt act of # relinquishment in perpetuity of all present and future rights to this # software under copyright law. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE. # Simple data source-level ingest module for Autopsy. # Search for TODO for the things that you need to change # See http://sleuthkit.org/autopsy/docs/api-docs/4.6.0/index.html for documentation import inspect import os import shutil import ntpath from com.williballenthin.rejistry import RegistryHiveFile from com.williballenthin.rejistry import RegistryKey from com.williballenthin.rejistry import RegistryParseException from com.williballenthin.rejistry import RegistryValue from java.io import File from java.lang import Class from java.lang import System from java.sql import DriverManager, SQLException from java.util.logging import Level from java.util import Arrays from org.sleuthkit.datamodel import SleuthkitCase from org.sleuthkit.datamodel import AbstractFile from org.sleuthkit.datamodel import ReadContentInputStream from org.sleuthkit.datamodel import BlackboardArtifact from org.sleuthkit.datamodel import BlackboardAttribute from org.sleuthkit.datamodel import TskData from org.sleuthkit.autopsy.ingest import IngestModule from org.sleuthkit.autopsy.ingest.IngestModule import IngestModuleException from org.sleuthkit.autopsy.ingest import DataSourceIngestModule from org.sleuthkit.autopsy.ingest import IngestModuleFactoryAdapter from org.sleuthkit.autopsy.ingest import IngestModuleIngestJobSettings from org.sleuthkit.autopsy.ingest import IngestModuleIngestJobSettingsPanel from org.sleuthkit.autopsy.ingest import IngestMessage from org.sleuthkit.autopsy.ingest import IngestServices from org.sleuthkit.autopsy.ingest import ModuleDataEvent from org.sleuthkit.autopsy.coreutils import Logger from org.sleuthkit.autopsy.coreutils import PlatformUtil from org.sleuthkit.autopsy.casemodule import Case from org.sleuthkit.autopsy.casemodule.services import Services from org.sleuthkit.autopsy.casemodule.services import FileManager from org.sleuthkit.autopsy.datamodel import ContentUtils from org.sleuthkit.autopsy.modules.interestingitems import FilesSetsManager # Factory that defines the name and details of the module and allows Autopsy # to create instances of the modules that will do the analysis. class RegistryExampleIngestModuleFactory(IngestModuleFactoryAdapter): def __init__(self): self.settings = None moduleName = "Registy Example Module" def getModuleDisplayName(self): return self.moduleName def getModuleDescription(self): return "Extract Run Keys To Look For Interesting Items" def getModuleVersionNumber(self): return "1.0" def hasIngestJobSettingsPanel(self): return False def isDataSourceIngestModuleFactory(self): return True def createDataSourceIngestModule(self, ingestOptions): return RegistryExampleIngestModule(self.settings) # Data Source-level ingest module. One gets created per data source. class RegistryExampleIngestModule(DataSourceIngestModule): _logger = Logger.getLogger(RegistryExampleIngestModuleFactory.moduleName) def log(self, level, msg): self._logger.logp(level, self.__class__.__name__, inspect.stack()[1][3], msg) def __init__(self, settings): self.context = None # Where any setup and configuration is done def startUp(self, context): self.context = context # Hive Keys to parse, use / as it is easier to parse out then \\ self.registryNTUserRunKeys = ('Software/Microsoft/Windows/CurrentVersion/Run', 'Software/Microsoft/Windows/CurrentVersion/RunOnce') self.registrySoftwareRunKeys = ('Microsoft/Windows/CurrentVersion/Run', 'Microsoft/Windows/CurrentVersion/RunOnce') self.registryKeysFound = [] # Where the analysis is done. def process(self, dataSource, progressBar): # we don't know how much work there is yet progressBar.switchToIndeterminate() # Hive files to extract filesToExtract = ("NTUSER.DAT", "SOFTWARE") # Create ExampleRegistry directory in temp directory, if it exists then continue on processing tempDir = os.path.join(Case.getCurrentCase().getTempDirectory(), "RegistryExample") self.log(Level.INFO, "create Directory " + tempDir) try: os.mkdir(tempDir) except: self.log(Level.INFO, "ExampleRegistry Directory already exists " + tempDir) # Set the database to be read to the once created by the prefetch parser program skCase = Case.getCurrentCase().getSleuthkitCase(); fileManager = Case.getCurrentCase().getServices().getFileManager() # Look for files to process for fileName in filesToExtract: files = fileManager.findFiles(dataSource, fileName) numFiles = len(files) for file in files: # Check if the user pressed cancel while we were busy if self.context.isJobCancelled(): return IngestModule.ProcessResult.OK # Check path to only get the hive files in the config directory and no others if ((file.getName() == 'SOFTWARE') and (file.getParentPath().upper() == '/WINDOWS/SYSTEM32/CONFIG/') and (file.getSize() > 0)): # Save the file locally in the temp folder. self.writeHiveFile(file, file.getName(), tempDir) # Process this file looking thru the run keys self.processSoftwareHive(os.path.join(tempDir, file.getName()), file) elif ((file.getName() == 'NTUSER.DAT') and ('/USERS' in file.getParentPath().upper()) and (file.getSize() > 0)): # Found a NTUSER.DAT file to process only want files in User directories # Filename may not be unique so add file id to the name fileName = str(file.getId()) + "-" + file.getName() # Save the file locally in the temp folder. self.writeHiveFile(file, fileName, tempDir) # Process this file looking thru the run keys self.processNTUserHive(os.path.join(tempDir, fileName), file) # Setup Artifact and Attributes try: skCase.addBlackboardArtifactType("TSK_REGISTRY_RUN_KEYS", "Registry Run Keys", BlackboardArtifact.Category.DATA_ARTIFACT) except: self.log(Level.INFO, "Artifacts Creation Error, some artifacts may not exist now. ==> ") artType = skCase.getArtifactType("TSK_REGISTRY_RUN_KEYS") try: attributeIdRunKeyName = skCase.addArtifactAttributeType("TSK_REG_RUN_KEY_NAME", BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING, "Run Key Name") except: self.log(Level.INFO, "Attributes Creation Error, TSK_REG_RUN_KEY_NAME, May already exist. ") try: attributeIdRunKeyValue = skCase.addArtifactAttributeType("TSK_REG_RUN_KEY_VALUE", BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING, "Run Key Value") except: self.log(Level.INFO, "Attributes Creation Error, TSK_REG_RUN_KEY_VALUE, May already exist. ") try: attributeIdRegKeyLoc = skCase.addArtifactAttributeType("TSK_REG_KEY_LOCATION", BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING, "Registry Key Location") except: self.log(Level.INFO, "Attributes Creation Error, TSK_REG_KEY_LOCATION, May already exist. ") attributeIdRunKeyName = skCase.getAttributeType("TSK_REG_RUN_KEY_NAME") attributeIdRunKeyValue = skCase.getAttributeType("TSK_REG_RUN_KEY_VALUE") attributeIdRegKeyLoc = skCase.getAttributeType("TSK_REG_KEY_LOCATION") moduleName = RegistryExampleIngestModuleFactory.moduleName # RefistryKeysFound is a list that contains a list with the following records abstractFile, Registry Key Location, Key Name, Key value for registryKey in self.registryKeysFound: art = registryKey[0].newDataArtifact(artType, Arrays.asList( BlackboardAttribute(attributeIdRegKeyLoc, moduleName, registryKey[1]), BlackboardAttribute(attributeIdRunKeyName, moduleName, registryKey[2]), BlackboardAttribute(attributeIdRunKeyValue, moduleName, registryKey[3]) )) # post the artifact for listeners of artifact events try: skCase.getBlackboard().postArtifact(art) except: self._logger.log(Level.WARNING, "Error indexing artifact " + art.getDisplayName()) #Clean up registryExample directory and files try: shutil.rmtree(tempDir) except: self.log(Level.INFO, "removal of directory tree failed " + tempDir) # After all databases, post a message to the ingest messages in box. message = IngestMessage.createMessage(IngestMessage.MessageType.DATA, "RegistryExample", " RegistryExample Files Have Been Analyzed " ) IngestServices.getInstance().postMessage(message) return IngestModule.ProcessResult.OK def writeHiveFile(self, file, fileName, tempDir): # Write the file to the temp directory. filePath = os.path.join(tempDir, fileName) ContentUtils.writeToFile(file, File(filePath)) def processSoftwareHive(self, softwareHive, abstractFile): # Open the registry hive file softwareRegFile = RegistryHiveFile(File(softwareHive)) for runKey in self.registrySoftwareRunKeys: currentKey = self.findRegistryKey(softwareRegFile, runKey) if len(currentKey.getValueList()) > 0: skValues = currentKey.getValueList() for skValue in skValues: regKey = [] regKey.append(abstractFile) regKey.append(runKey) skName = skValue.getName() skVal = skValue.getValue() regKey.append(str(skName)) regKey.append(skVal.getAsString()) self.registryKeysFound.append(regKey) def processNTUserHive(self, ntuserHive, abstractFile): # Open the registry hive file ntuserRegFile = RegistryHiveFile(File(ntuserHive)) for runKey in self.registryNTUserRunKeys: currentKey = self.findRegistryKey(ntuserRegFile, runKey) if len(currentKey.getValueList()) > 0: skValues = currentKey.getValueList() for skValue in skValues: regKey = [] regKey.append(abstractFile) regKey.append(runKey) skName = skValue.getName() skVal = skValue.getValue() regKey.append(str(skName)) regKey.append(skVal.getAsString()) self.registryKeysFound.append(regKey) def findRegistryKey(self, registryHiveFile, registryKey): # Search for the registry key rootKey = registryHiveFile.getRoot() regKeyList = registryKey.split('/') currentKey = rootKey try: for key in regKeyList: currentKey = currentKey.getSubkey(key) return currentKey except: # Key not found return None