Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Classes
class	AccountFileInstanceCache

Public Member Functions
ProcessResult	process (AbstractFile abstractFile)

void	shutDown ()

void	startUp (IngestJobContext context) throws IngestModuleException

Private Member Functions
BlackboardArtifact	addEmailArtifact (EmailMessage email, AbstractFile abstractFile, AccountFileInstanceCache accountFileInstanceCache)

Set< String >	findEmailAddresess (String input)

List< Long >	findMboxSplitOffset (AbstractFile abstractFile, File file) throws IOException

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

void	processEmails (List< EmailMessage > partialEmailsForThreading, Iterator< EmailMessage > fullMessageIterator, AbstractFile abstractFile)

ProcessResult	processEMLFile (AbstractFile abstractFile)

ProcessResult	processMBox (AbstractFile abstractFile)

void	processMboxFile (File file, AbstractFile abstractFile, String emailFolder)

ProcessResult	processPst (AbstractFile abstractFile)

ProcessResult	processVcard (AbstractFile abstractFile)

Private Attributes
Blackboard	blackboard

CommunicationArtifactsHelper	communicationArtifactsHelper

IngestJobContext	context

Case	currentCase

FileManager	fileManager

final IngestServices	services = IngestServices.getInstance()

Static Private Attributes
static ConcurrentMap< String, BlackboardAttribute.Type >	customAttributeCache = new ConcurrentHashMap<>()

static Object	customAttributeCacheLock = new Object()

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

static final int	MBOX_SIZE_TO_SPLIT = 1048576000

Detailed Description

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

Definition at line 79 of file ThunderbirdMboxFileIngestModule.java.

Member Function Documentation

BlackboardArtifact org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailArtifact	(	EmailMessage	email,
		AbstractFile	abstractFile,
		AccountFileInstanceCache	accountFileInstanceCache
	)

private

Add a blackboard artifact for the given e-mail message.

Parameters

email	The e-mail message.
abstractFile	The associated file.
accountFileInstanceCache	The current cache of account instances.

Returns: The generated e-mail message artifact.

Definition at line 699 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.findEmailAddresess(), org.sleuthkit.autopsy.ingest.IngestJobContext.getJobId(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

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 678 of file ThunderbirdMboxFileIngestModule.java.

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

List<Long> org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.findMboxSplitOffset	(	AbstractFile	abstractFile,
		File	file
	)		throws IOException

private

Definition at line 392 of file ThunderbirdMboxFileIngestModule.java.

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

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 627 of file ThunderbirdMboxFileIngestModule.java.

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

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.

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

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 122 of file ThunderbirdMboxFileIngestModule.java.

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails	(	List< EmailMessage >	partialEmailsForThreading,
		Iterator< EmailMessage >	fullMessageIterator,
		AbstractFile	abstractFile
	)

private

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

Parameters

partialEmailsForThreading
fullMessageIterator
abstractFile

Definition at line 550 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.addFilesToJob(), org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), and org.sleuthkit.autopsy.ingest.IngestServices.fireModuleContentEvent().

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

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

private

Definition at line 466 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.addFilesToJob(), org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.ERROR, org.sleuthkit.autopsy.ingest.IngestServices.fireModuleContentEvent(), and org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

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

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 305 of file ThunderbirdMboxFileIngestModule.java.

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

void org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMboxFile	(	File	file,
		AbstractFile	abstractFile,
		String	emailFolder
	)

private

Definition at line 413 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails().

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

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 202 of file ThunderbirdMboxFileIngestModule.java.

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

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

private

Parse and extract data from a vCard file.

Parameters

abstractFile The content to be processed.

Returns: 'ERROR' whenever a NoCurrentCaseException is encountered; otherwise 'OK'.

Definition at line 455 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCache, and org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

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 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 935 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCache, and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCacheLock.

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 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

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 103 of file ThunderbirdMboxFileIngestModule.java.

References org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.context, org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCache, org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCacheLock, 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 85 of file ThunderbirdMboxFileIngestModule.java.

CommunicationArtifactsHelper org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.communicationArtifactsHelper

private

Definition at line 86 of file ThunderbirdMboxFileIngestModule.java.

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

private

Definition at line 84 of file ThunderbirdMboxFileIngestModule.java.

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

Case org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.currentCase

private

Definition at line 93 of file ThunderbirdMboxFileIngestModule.java.

ConcurrentMap<String, BlackboardAttribute.Type> org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCache = new ConcurrentHashMap<>()

staticprivate

Definition at line 89 of file ThunderbirdMboxFileIngestModule.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processVcard(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.shutDown(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.startUp().

Object org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.customAttributeCacheLock = new Object()

staticprivate

Definition at line 90 of file ThunderbirdMboxFileIngestModule.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.shutDown(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.startUp().

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

private

Definition at line 83 of file ThunderbirdMboxFileIngestModule.java.

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

staticprivate

Definition at line 81 of file ThunderbirdMboxFileIngestModule.java.

final int org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.MBOX_SIZE_TO_SPLIT = 1048576000

staticprivate

Definition at line 92 of file ThunderbirdMboxFileIngestModule.java.

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

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

private

Definition at line 82 of file ThunderbirdMboxFileIngestModule.java.

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