Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Classes
class	IngestJobTotals

Public Member Functions
void	startUp (org.sleuthkit.autopsy.ingest.IngestJobContext context) throws IngestModuleException

ProcessResult	process (AbstractFile file)

void	shutDown ()

void	startUp (IngestJobContext context) throws IngestModuleException

Private Member Functions
void	updateEnabledHashSets (List< HashDb > allHashSets, List< HashDb > enabledHashSets)

void	postHashSetHitToBlackboard (AbstractFile abstractFile, String md5Hash, String hashSetName, String comment, boolean showInboxMessage)

synchronized void	postSummary ()

Static Private Member Functions
static synchronized IngestJobTotals	getTotalsForIngestJobs (long ingestJobId)

Private Attributes
final IngestServices	services = IngestServices.getInstance()

final SleuthkitCase	skCase = Case.getCurrentCase().getSleuthkitCase()

final HashDbManager	hashDbManager = HashDbManager.getInstance()

final HashLookupModuleSettings	settings

List< HashDb >	knownBadHashSets = new ArrayList<>()

List< HashDb >	knownHashSets = new ArrayList<>()

long	jobId

Static Private Attributes
static final Logger	logger = Logger.getLogger(HashDbIngestModule.class.getName())

static final int	MAX_COMMENT_SIZE = 500

static final HashMap< Long, IngestJobTotals >	totalsForIngestJobs = new HashMap<>()

static final IngestModuleReferenceCounter	refCounter = new IngestModuleReferenceCounter()

Detailed Description

Definition at line 49 of file HashDbIngestModule.java.

Member Function Documentation

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

staticprivate

Definition at line 68 of file HashDbIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process().

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

private

Definition at line 276 of file HashDbIngestModule.java.

References org::sleuthkit::datamodel::BlackboardArtifact.addAttribute(), org.sleuthkit.autopsy.ingest.IngestMessage.createDataMessage(), org.sleuthkit.autopsy.ingest.IngestServices.fireModuleDataEvent(), org::sleuthkit::datamodel::AbstractContent.getName(), org::sleuthkit::datamodel::AbstractContent.newArtifact(), org.sleuthkit.autopsy.ingest.IngestServices.postMessage(), org::sleuthkit::datamodel::BlackboardAttribute::ATTRIBUTE_TYPE.TSK_COMMENT, org::sleuthkit::datamodel::BlackboardAttribute::ATTRIBUTE_TYPE.TSK_HASH_MD5, org::sleuthkit::datamodel::BlackboardArtifact::ARTIFACT_TYPE.TSK_HASHSET_HIT, and org::sleuthkit::datamodel::BlackboardAttribute::ATTRIBUTE_TYPE.TSK_SET_NAME.

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process().

synchronized void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary ( )

private

Definition at line 334 of file HashDbIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), 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.

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.shutDown().

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

References org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.decrementAndGet(), and org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary().

void org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp ( org.sleuthkit.autopsy.ingest.IngestJobContext context ) throws IngestModuleException

Definition at line 82 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(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.knownBadHashSets, org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.knownHashSets, org.sleuthkit.autopsy.ingest.IngestServices.postMessage(), and org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.updateEnabledHashSets().

void org.sleuthkit.autopsy.ingest.IngestModule.startUp ( IngestJobContext context ) throws IngestModuleException

inherited

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

Referenced by org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.startUp().

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

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp().

Member Data Documentation

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

private

Definition at line 54 of file HashDbIngestModule.java.

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

private

Definition at line 58 of file HashDbIngestModule.java.

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

private

Definition at line 56 of file HashDbIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp().

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

private

Definition at line 57 of file HashDbIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp().

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

staticprivate

Definition at line 50 of file HashDbIngestModule.java.

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

staticprivate

Definition at line 51 of file HashDbIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process().

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

staticprivate

Definition at line 60 of file HashDbIngestModule.java.

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

private

Definition at line 52 of file HashDbIngestModule.java.

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

private

Definition at line 55 of file HashDbIngestModule.java.

final SleuthkitCase org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.skCase = Case.getCurrentCase().getSleuthkitCase()

private

Definition at line 53 of file HashDbIngestModule.java.

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

staticprivate

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