Autopsy  4.10.0
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.hashdatabase.HashDbIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Classes

class  IngestJobTotals
 

Public Member Functions

ProcessResult process (AbstractFile file)
 
void shutDown ()
 
void startUp (org.sleuthkit.autopsy.ingest.IngestJobContext context) throws IngestModuleException
 

Private Member Functions

void postHashSetHitToBlackboard (AbstractFile abstractFile, String md5Hash, String hashSetName, String comment, boolean showInboxMessage)
 
void updateEnabledHashSets (List< HashDb > allHashSets, List< HashDb > enabledHashSets)
 

Static Private Member Functions

static synchronized IngestJobTotals getTotalsForIngestJobs (long ingestJobId)
 
static synchronized void postSummary (long jobId, List< HashDb > knownBadHashSets, List< HashDb > knownHashSets)
 

Private Attributes

Blackboard blackboard
 
final HashDbManager hashDbManager = HashDbManager.getInstance()
 
long jobId
 
final List< HashDbknownBadHashSets = new ArrayList<>()
 
final List< HashDbknownHashSets = new ArrayList<>()
 
final IngestServices services = IngestServices.getInstance()
 
final HashLookupModuleSettings settings
 
final SleuthkitCase skCase
 

Static Private Attributes

static final Logger logger = Logger.getLogger(HashDbIngestModule.class.getName())
 
static final int MAX_COMMENT_SIZE = 500
 
static final IngestModuleReferenceCounter refCounter = new IngestModuleReferenceCounter()
 
static final HashMap< Long, IngestJobTotalstotalsForIngestJobs = new HashMap<>()
 

Detailed Description

File ingest module to mark files based on hash values.

Definition at line 65 of file HashDbIngestModule.java.

Member Function Documentation

static synchronized IngestJobTotals org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.getTotalsForIngestJobs ( long  ingestJobId)
staticprivate

Definition at line 90 of file HashDbIngestModule.java.

void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postHashSetHitToBlackboard ( AbstractFile  abstractFile,
String  md5Hash,
String  hashSetName,
String  comment,
boolean  showInboxMessage 
)
private

Post a hash set hit to the blackboard.

Parameters
abstractFileThe file to be processed.
md5HashThe MD5 hash value of the file.
hashSetNameThe name of the hash set with which to associate the hit.
commentA comment to be attached to the artifact.
showInboxMessageShow a message in the inbox?

Definition at line 345 of file HashDbIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createDataMessage(), org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), org.sleuthkit.autopsy.ingest.IngestServices.fireModuleDataEvent(), org.sleuthkit.autopsy.casemodule.services.Blackboard.indexArtifact(), and org.sleuthkit.autopsy.ingest.IngestServices.postMessage().

static synchronized void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary ( long  jobId,
List< HashDb knownBadHashSets,
List< HashDb knownHashSets 
)
staticprivate
ProcessResult org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process ( AbstractFile  file)
void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.shutDown ( )

Invoked by Autopsy when an ingest job is completed (either because the data has been analyzed or because the job was canceled - check IngestJobContext.fileIngestIsCancelled()), 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.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 457 of file HashDbIngestModule.java.

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

void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp ( org.sleuthkit.autopsy.ingest.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 process() and shutDown() are logged, but do not stop processing of the data source.

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 114 of file HashDbIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createWarningMessage(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.getKnownBadFileHashSets(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.getKnownFileHashSets(), org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.incrementAndGet(), and org.sleuthkit.autopsy.ingest.IngestServices.postMessage().

void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.updateEnabledHashSets ( List< HashDb allHashSets,
List< HashDb enabledHashSets 
)
private

Cycle through list of hashsets and return the subset that is enabled.

Parameters
allHashSetsList of all hashsets from DB manager
enabledHashSetsList of enabled ones to return.

Definition at line 149 of file HashDbIngestModule.java.

Member Data Documentation

Blackboard org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.blackboard
private

Definition at line 78 of file HashDbIngestModule.java.

final HashDbManager org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.hashDbManager = HashDbManager.getInstance()
private

Definition at line 71 of file HashDbIngestModule.java.

long org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.jobId
private

Definition at line 75 of file HashDbIngestModule.java.

final List<HashDb> org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.knownBadHashSets = new ArrayList<>()
private

Definition at line 73 of file HashDbIngestModule.java.

final List<HashDb> org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.knownHashSets = new ArrayList<>()
private

Definition at line 74 of file HashDbIngestModule.java.

final Logger org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.logger = Logger.getLogger(HashDbIngestModule.class.getName())
staticprivate

Definition at line 67 of file HashDbIngestModule.java.

final int org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.MAX_COMMENT_SIZE = 500
staticprivate

Definition at line 68 of file HashDbIngestModule.java.

final IngestModuleReferenceCounter org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.refCounter = new IngestModuleReferenceCounter()
staticprivate

Definition at line 77 of file HashDbIngestModule.java.

final IngestServices org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.services = IngestServices.getInstance()
private

Definition at line 69 of file HashDbIngestModule.java.

final HashLookupModuleSettings org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.settings
private

Definition at line 72 of file HashDbIngestModule.java.

final SleuthkitCase org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.skCase
private

Definition at line 70 of file HashDbIngestModule.java.

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

Definition at line 76 of file HashDbIngestModule.java.


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

Copyright © 2012-2018 Basis Technology. Generated on: Fri Mar 22 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.