Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Classes

class  IngestJobTotals
 

Public Member Functions

ProcessResult process (AbstractFile abstractFile)
 
void shutDown ()
 
void startUp (IngestJobContext context) throws IngestModuleException
 

Private Member Functions

boolean compareSigTypeToExt (AbstractFile abstractFile)
 

Static Private Member Functions

static synchronized void addToTotals (long ingestJobId, long processTimeInc)
 

Private Attributes

FileTypeDetector detector
 
long jobId
 
HashMap< String, Set< String > > mimeTypeToExtsMap = new HashMap<>()
 
final IngestServices services = IngestServices.getInstance()
 
final FileExtMismatchDetectorModuleSettings settings
 

Static Private Attributes

static Blackboard blackboard
 
static final Logger logger = Logger.getLogger(FileExtMismatchIngestModule.class.getName())
 
static final IngestModuleReferenceCounter refCounter = new IngestModuleReferenceCounter()
 
static final HashMap< Long, IngestJobTotalstotalsForIngestJobs = new HashMap<>()
 

Detailed Description

Flags mismatched filename extensions based on file signature.

Definition at line 54 of file FileExtMismatchIngestModule.java.

Member Function Documentation

static synchronized void org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.addToTotals ( long  ingestJobId,
long  processTimeInc 
)
staticprivate

Update the match time total and increment num of files for this job

Parameters
ingestJobId
processTimeIncamount of time to add

Definition at line 78 of file FileExtMismatchIngestModule.java.

References org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.IngestJobTotals.numFiles, and org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.IngestJobTotals.processTime.

boolean org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.compareSigTypeToExt ( AbstractFile  abstractFile)
private

Compare file type for file and extension.

Parameters
abstractFile
Returns
false if the two match. True if there is a mismatch.

Definition at line 179 of file FileExtMismatchIngestModule.java.

References org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getMIMEType().

ProcessResult org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.process ( AbstractFile  file)

Processes a file. Called between calls to startUp() and shutDown(). Will be called for each file in a data source.

IMPORTANT: In addition to returning ProcessResult.OK or ProcessResult.ERROR, modules should log all errors using methods provided by the org.sleuthkit.autopsy.coreutils.Logger class. Log messages should include the name and object ID of the data being processed and any other information that would be useful for debugging. If an exception has been caught by the module, the exception should be sent to the logger along with the log message so that a stack trace will appear in the application log.

Parameters
fileThe file to analyze.
Returns
A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 111 of file FileExtMismatchIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.ERROR, org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getMIMEType(), org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase(), and org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

void org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.shutDown ( )

Invoked by Autopsy when an ingest job is completed (either because the data has been analyzed or because the job was cancelled), before the ingest module instance is discarded. The module should respond by doing things like releasing private resources, submitting final results, and posting a final ingest message.

IMPORTANT: If the module instances must share resources, the modules are responsible for synchronizing access to the shared resources and doing reference counting as required to release those resources correctly. Also, more than one ingest job may be in progress at any given time. This must also be taken into consideration when sharing resources between module instances. See IngestModuleReferenceCounter.

Implements org.sleuthkit.autopsy.ingest.IngestModule.

Definition at line 216 of file FileExtMismatchIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.decrementAndGet(), org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.INFO, org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.IngestJobTotals.numFiles, org.sleuthkit.autopsy.ingest.IngestServices.postMessage(), and org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.IngestJobTotals.processTime.

void org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.startUp ( IngestJobContext  context) throws IngestModuleException

Invoked by Autopsy to allow an ingest module instance to set up any internal data structures and acquire any private resources it will need during an ingest job. If the module depends on loading any resources, it should do so in this method so that it can throw an exception in the case of an error and alert the user. Exceptions that are thrown from startUp() are logged and stop processing of the data source.

IMPORTANT: If the module instances must share resources, the modules are responsible for synchronizing access to the shared resources and doing reference counting as required to release those resources correctly. Also, more than one ingest job may be in progress at any given time. This must also be taken into consideration when sharing resources between module instances. See IngestModuleReferenceCounter.

IMPORTANT: Start up IngestModuleException messages are displayed to the user, if a user is present. Therefore, an exception to the policy that exception messages are not localized is appropriate in this method. Also, the exception messages should be user-friendly.

Parameters
contextProvides data and services specific to the ingest job and the ingest pipeline of which the module is a part.
Exceptions
org.sleuthkit.autopsy.ingest.IngestModule.IngestModuleException

Implements org.sleuthkit.autopsy.ingest.IngestModule.

Definition at line 95 of file FileExtMismatchIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.incrementAndGet().

Member Data Documentation

Blackboard org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.blackboard
staticprivate

Definition at line 63 of file FileExtMismatchIngestModule.java.

FileTypeDetector org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.detector
private

Definition at line 64 of file FileExtMismatchIngestModule.java.

long org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.jobId
private

Definition at line 60 of file FileExtMismatchIngestModule.java.

final Logger org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.logger = Logger.getLogger(FileExtMismatchIngestModule.class.getName())
staticprivate

Definition at line 56 of file FileExtMismatchIngestModule.java.

HashMap<String, Set<String> > org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.mimeTypeToExtsMap = new HashMap<>()
private

Definition at line 59 of file FileExtMismatchIngestModule.java.

final IngestModuleReferenceCounter org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.refCounter = new IngestModuleReferenceCounter()
staticprivate

Definition at line 62 of file FileExtMismatchIngestModule.java.

final IngestServices org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.services = IngestServices.getInstance()
private

Definition at line 57 of file FileExtMismatchIngestModule.java.

final FileExtMismatchDetectorModuleSettings org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.settings
private

Definition at line 58 of file FileExtMismatchIngestModule.java.

final HashMap<Long, IngestJobTotals> org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.totalsForIngestJobs = new HashMap<>()
staticprivate

Definition at line 61 of file FileExtMismatchIngestModule.java.


The documentation for this class was generated from the following file:

Copyright © 2012-2022 Basis Technology. Generated on: Mon Sep 26 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.