Package rekall :: Module config

Module config

This is the Rekall configuration system.

Rekall maintains a persistent file with global settings in the user's home directory. This makes it easy for users to retain commonly used Rekall parameters.

Note that the configuration file is only used in interactive mode. When used as a library the configuration file has no effect.

Author: Michael Cohen <scudette@gmail.com>

Classes
	CommandMetadata A class that carried a plugin's configuration.

Functions

GetHomeDir(session)

source code

GetConfigFile(session)
Gets the configuration stored in the config file.

source code

CreateDefaultConfigFile(session)
Creates a default config file.

source code

MergeConfigOptions(state, session)
Read the config file and apply the config options to the session.

source code

RemoveGlobalOptions(state)
Remove all global options from state dictionary.

source code

DeclareOption(*args, **kwargs)
Declare a config option for command line and config file.

source code

Variables
	DEFAULT_CONFIGURATION = `{'cache_dir': '.rekall_cache', 'reposi...`
	OPTIONS = `CommandMetadata()`
	__package__ = `'rekall'`

Function Details

GetConfigFile(session)

source code

Gets the configuration stored in the config file.

Searches for the config file in reasonable locations.

Return:
  configuration stored in the config file. If the file is not found, returns
  an empty configuration.

Variables Details

DEFAULT_CONFIGURATION

Value:

{'cache_dir': '.rekall_cache',
 'repository_path': ['https://github.com/google/rekall-profiles/raw/ma
ster',
                     'http://profiles.rekall-forensic.com']}