Inherits org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.

Public Member Functions
ProcessResult	process (AbstractFile file)

void	shutDown ()

void	startUp (IngestJobContext context) throws IngestModuleException

Protected Member Functions
File	createLocalCopy (AbstractFile file) throws IngestModuleException, IOException

Private Member Functions
synchronized Path	getTempDirectory (long jobId) throws IngestModuleException

Private Attributes
IngestJobContext	context = null

Long	jobId

final YaraIngestJobSettings	settings

Static Private Attributes
static final int	FILE_SIZE_THRESHOLD_BYTE = FILE_SIZE_THRESHOLD_MB * 1024 * 1024

static final int	FILE_SIZE_THRESHOLD_MB = 100

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

static final Map< Long, Path >	pathsByJobId = new ConcurrentHashMap<>()

static final IngestModuleReferenceCounter	refCounter = new IngestModuleReferenceCounter()

static final String	RULESET_DIR = "RuleSets"

static final String	YARA_DIR = "yara"

static final int	YARA_SCAN_TIMEOUT_SEC = 30 * 60 * 60

Detailed Description

An ingest module that runs the yara against the given files.

Definition at line 53 of file YaraIngestModule.java.

Member Function Documentation

File org.sleuthkit.autopsy.modules.yara.YaraIngestModule.createLocalCopy ( AbstractFile file ) throws IngestModuleException, IOException

protected

Create a local copy of the given AbstractFile.

Parameters

file	AbstractFile to make a copy of.

Returns: A File object representation of the local copy.

Exceptions

org.sleuthkit.autopsy.ingest.IngestModule.IngestModuleException
IOException

Definition at line 223 of file YaraIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.getJobId(), org.sleuthkit.autopsy.modules.yara.YaraIngestModule.getTempDirectory(), and org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile().

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.process().

synchronized Path org.sleuthkit.autopsy.modules.yara.YaraIngestModule.getTempDirectory ( long jobId ) throws IngestModuleException

private

Return the temp directory for this jobId. If the folder does not exit it will be created.

Parameters

jobId The current jobId

Returns: The path of the temporary directory for the given jobId.

Exceptions

org.sleuthkit.autopsy.ingest.IngestModule.IngestModuleException

Definition at line 186 of file YaraIngestModule.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getTempDirectory(), org.sleuthkit.autopsy.modules.yara.YaraIngestModule.jobId, and org.sleuthkit.autopsy.modules.yara.YaraIngestModule.YARA_DIR.

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.createLocalCopy(), org.sleuthkit.autopsy.modules.yara.YaraIngestModule.process(), and org.sleuthkit.autopsy.modules.yara.YaraIngestModule.startUp().

ProcessResult org.sleuthkit.autopsy.modules.yara.YaraIngestModule.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. 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 121 of file YaraIngestModule.java.

void org.sleuthkit.autopsy.modules.yara.YaraIngestModule.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 109 of file YaraIngestModule.java.

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

void org.sleuthkit.autopsy.modules.yara.YaraIngestModule.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.

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 84 of file YaraIngestModule.java.

Member Data Documentation

IngestJobContext org.sleuthkit.autopsy.modules.yara.YaraIngestModule.context = null

private

Definition at line 68 of file YaraIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.startUp().

final int org.sleuthkit.autopsy.modules.yara.YaraIngestModule.FILE_SIZE_THRESHOLD_BYTE = FILE_SIZE_THRESHOLD_MB * 1024 * 1024

staticprivate

Definition at line 57 of file YaraIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.process().

final int org.sleuthkit.autopsy.modules.yara.YaraIngestModule.FILE_SIZE_THRESHOLD_MB = 100

staticprivate

Definition at line 56 of file YaraIngestModule.java.

Long org.sleuthkit.autopsy.modules.yara.YaraIngestModule.jobId

private

Definition at line 69 of file YaraIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.getTempDirectory().

final Logger org.sleuthkit.autopsy.modules.yara.YaraIngestModule.logger = Logger.getLogger(YaraIngestModule.class.getName())

staticprivate

Definition at line 61 of file YaraIngestModule.java.

final Map<Long, Path> org.sleuthkit.autopsy.modules.yara.YaraIngestModule.pathsByJobId = new ConcurrentHashMap<>()

staticprivate

Definition at line 63 of file YaraIngestModule.java.

final IngestModuleReferenceCounter org.sleuthkit.autopsy.modules.yara.YaraIngestModule.refCounter = new IngestModuleReferenceCounter()

staticprivate

Definition at line 60 of file YaraIngestModule.java.

final String org.sleuthkit.autopsy.modules.yara.YaraIngestModule.RULESET_DIR = "RuleSets"

staticprivate

Definition at line 64 of file YaraIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.startUp().

final YaraIngestJobSettings org.sleuthkit.autopsy.modules.yara.YaraIngestModule.settings

private

Definition at line 66 of file YaraIngestModule.java.

final String org.sleuthkit.autopsy.modules.yara.YaraIngestModule.YARA_DIR = "yara"

staticprivate

Definition at line 62 of file YaraIngestModule.java.

Referenced by org.sleuthkit.autopsy.modules.yara.YaraIngestModule.getTempDirectory().

final int org.sleuthkit.autopsy.modules.yara.YaraIngestModule.YARA_SCAN_TIMEOUT_SEC = 30 * 60 * 60

staticprivate

Definition at line 58 of file YaraIngestModule.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/modules/yara/YaraIngestModule.java

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation