Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Public Member Functions
ProcessResult	process (AbstractFile abstractFile)

void	shutDown ()

void	startUp (IngestJobContext context) throws IngestModuleException

Private Member Functions
BlackboardArtifact	addArtifact (EmailMessage email, AbstractFile abstractFile) throws NoCurrentCaseException

void	addEmailAttribute (String stringVal, ATTRIBUTE_TYPE attrType, Collection< BlackboardAttribute > bbattributes)

void	addEmailAttribute (long longVal, ATTRIBUTE_TYPE attrType, Collection< BlackboardAttribute > bbattributes)

Set< String >	findEmailAddresess (String input)

List< AbstractFile >	handleAttachments (List< EmailMessage.Attachment > attachments, AbstractFile abstractFile, BlackboardArtifact messageArtifact)

void	processEmails (List< EmailMessage > emails, AbstractFile abstractFile) throws NoCurrentCaseException

ProcessResult	processMBox (AbstractFile abstractFile)

ProcessResult	processPst (AbstractFile abstractFile)

Private Attributes
Blackboard	blackboard

IngestJobContext	context

FileManager	fileManager

IngestServices	services = IngestServices.getInstance()

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

Detailed Description

File-level ingest module that detects MBOX files based on signature. Understands Thunderbird folder layout to provide additional structure and metadata.

Definition at line 66 of file ThunderbirdMboxFileIngestModule.java.

Member Function Documentation

BlackboardArtifact org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addArtifact	(	EmailMessage	email,
		AbstractFile	abstractFile
	)		throws NoCurrentCaseException

private

Add a blackboard artifact for the given email message.

Parameters

email
abstractFile

Exceptions

NoCurrentCaseException if there is no open case.

Definition at line 441 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailAttribute(), org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.findEmailAddresess(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase(), and org.sleuthkit.autopsy.casemodule.services.Blackboard.indexArtifact().

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails().

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailAttribute	(	String	stringVal,
		ATTRIBUTE_TYPE	attrType,
		Collection< BlackboardAttribute >	bbattributes
	)

private

Definition at line 539 of file ThunderbirdMboxFileIngestModule.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addArtifact().

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailAttribute	(	long	longVal,
		ATTRIBUTE_TYPE	attrType,
		Collection< BlackboardAttribute >	bbattributes
	)

private

Definition at line 544 of file ThunderbirdMboxFileIngestModule.java.

Set<String> org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.findEmailAddresess ( String input )

private

Finds and returns a set of unique email addresses found in the input string

Parameters

input - input string, like the To/CC line from an email header

Returns: Set<String>: set of email addresses found in the input string

Definition at line 422 of file ThunderbirdMboxFileIngestModule.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addArtifact().

List<AbstractFile> org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.handleAttachments	(	List< EmailMessage.Attachment >	attachments,
		AbstractFile	abstractFile,
		BlackboardArtifact	messageArtifact
	)

private

Add the given attachments as derived files and reschedule them for ingest.

Parameters

attachments
abstractFile
messageArtifact

Returns: List of attachments

Definition at line 386 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.casemodule.services.FileManager.addDerivedFile().

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails().

ProcessResult org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.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 90 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.ERROR, org.sleuthkit.autopsy.casemodule.services.Services.getBlackboard(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getServices(), org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK, org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMBox(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst().

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails	(	List< EmailMessage >	emails,
		AbstractFile	abstractFile
	)		throws NoCurrentCaseException

private

Take the extracted information in the email messages and add the appropriate artifacts and derived files.

Parameters

emails
abstractFile

Exceptions

NoCurrentCaseException if there is no open case.

Definition at line 354 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addArtifact(), org.sleuthkit.autopsy.ingest.IngestJobContext.addFilesToJob(), org.sleuthkit.autopsy.ingest.IngestServices.fireModuleContentEvent(), org.sleuthkit.autopsy.ingest.IngestServices.fireModuleDataEvent(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.handleAttachments().

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMBox(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst().

ProcessResult org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMBox ( AbstractFile abstractFile )

private

Parse and extract email messages and attachments from an MBox file.

Parameters

abstractFile

Returns

Definition at line 238 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestMonitor.DISK_FREE_SPACE_UNKNOWN, org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.ERROR, org.sleuthkit.autopsy.ingest.IngestServices.getFreeDiskSpace(), org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK, org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails(), and org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile().

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.process().

ProcessResult org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst ( AbstractFile abstractFile )

private

Processes a pst/ost data file and extracts and adds email artifacts.

Parameters

abstractFile The pst/ost data file to process.

Returns

Definition at line 147 of file ThunderbirdMboxFileIngestModule.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.process().

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.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 560 of file ThunderbirdMboxFileIngestModule.java.

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.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 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 79 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.context, org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.services.Services.getFileManager(), and org.sleuthkit.autopsy.casemodule.Case.getServices().

Member Data Documentation

Blackboard org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.blackboard

private

Definition at line 72 of file ThunderbirdMboxFileIngestModule.java.

IngestJobContext org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.context

private

Definition at line 71 of file ThunderbirdMboxFileIngestModule.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.startUp().

FileManager org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.fileManager

private

Definition at line 70 of file ThunderbirdMboxFileIngestModule.java.

final Logger org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.logger = Logger.getLogger(ThunderbirdMboxFileIngestModule.class.getName())

staticprivate

Definition at line 68 of file ThunderbirdMboxFileIngestModule.java.

IngestServices org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.services = IngestServices.getInstance()

private

Definition at line 69 of file ThunderbirdMboxFileIngestModule.java.

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

/home/carriersleuth/repos/autopsy/thunderbirdparser/src/org/sleuthkit/autopsy/thunderbirdparser/ThunderbirdMboxFileIngestModule.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation