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< HashDb >	knownBadHashSets = new ArrayList<>()

final List< HashDb >	knownHashSets = 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, IngestJobTotals >	totalsForIngestJobs = new HashMap<>()

Detailed Description

File ingest module to mark files based on hash values.

Definition at line 63 of file HashDbIngestModule.java.

Member Function Documentation

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

staticprivate

Definition at line 88 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

abstractFile	The file to be processed.
md5Hash	The MD5 hash value of the file.
hashSetName	The name of the hash set with which to associate the hit.
comment	A comment to be attached to the artifact.
showInboxMessage	Show a message in the inbox?

Definition at line 343 of file HashDbIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createDataMessage(), org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), 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

Post a message summarizing the results of the ingest.

Parameters

jobId	The ID of the job.
knownBadHashSets	The list of hash sets for "known bad" files.
knownHashSets	The list of hash sets for "known" files.

Definition at line 416 of file HashDbIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.ingest.IngestServices.getInstance(), org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.INFO, org.sleuthkit.autopsy.ingest.IngestServices.postMessage(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.IngestJobTotals.totalCalctime, org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.IngestJobTotals.totalKnownBadCount, and org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.IngestJobTotals.totalLookuptime.

ProcessResult org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process ( AbstractFile file )

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

Parameters

file	The file to analyze.

Returns: A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 169 of file HashDbIngestModule.java.

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

context Provides 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 112 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

allHashSets	List of all hashsets from DB manager
enabledHashSets	List of enabled ones to return.

Definition at line 147 of file HashDbIngestModule.java.

Member Data Documentation

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

private

Definition at line 76 of file HashDbIngestModule.java.

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

private

Definition at line 69 of file HashDbIngestModule.java.

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

private

Definition at line 73 of file HashDbIngestModule.java.

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

private

Definition at line 71 of file HashDbIngestModule.java.

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

private

Definition at line 72 of file HashDbIngestModule.java.

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

staticprivate

Definition at line 65 of file HashDbIngestModule.java.

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

staticprivate

Definition at line 66 of file HashDbIngestModule.java.

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

staticprivate

Definition at line 75 of file HashDbIngestModule.java.

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

private

Definition at line 67 of file HashDbIngestModule.java.

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

private

Definition at line 70 of file HashDbIngestModule.java.

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

private

Definition at line 68 of file HashDbIngestModule.java.

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

staticprivate

Definition at line 74 of file HashDbIngestModule.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/modules/hashdatabase/HashDbIngestModule.java

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation