Common Constants

File location:

  • Bundled implementation: source/client/python/const.py

  • Cluster implementation: cluster/core/source/python/const.py

const.ROOT
Type:

str

Path to the BroAPT-Core framework source codes (absolute path at runtime).

const.BOOLEAN_STATES = {'1': True,    '0': False, 'yes': True,  'no': False, 'true': True, 'false': False, 'on': True,   'off': False}

Mapping of boolean states, c.f. configparser.

const.CPU_CNT
Type:

int

Environ:

BROAPT_CPU

Number of BroAPT concurrent processes for PCAP analysis. If not provided, then the number of system CPUs will be used.

const.INTERVAL
Type:

float

Environ:

Wait interval after processing current pool of PCAP files.

const.DUMP_PATH
Type:

str (path)

Environ:

BROAPT_DUMP_PATH

Path to extracted files.

const.PCAP_PATH
Type:

str (path)

Environ:

BROAPT_PCAP_PATH

Path to source PCAP files.

const.LOGS_PATH
Type:

str (path)

Environ:

BROAPT_LOGS_PATH

Path to system logs.

const.MIME_MODE
Type:

bool

Environ:

BROAPT_MIME_MODE

If group extracted files by MIME type.

const.BARE_MODE
Type:

bool

Environ:

BROAPT_BARE_MODE

Run Bro in bare mode (don’t load scripts from the base/ directory).

const.NO_CHKSUM
Type:

bool

Environ:

BROAPT_NO_CHKSUM

Ignore checksums of packets in PCAP files when running Bro.

const.HOOK_CPU
Type:

int

Environ:

BROAPT_HOOK_CPU

Number of BroAPT concurrent processes for Python hooks.

const.FILE
Type:

str

os.path.join(LOGS_PATH, 'file.log')

Path to file system database of processed PCAP files.

const.TIME
Type:

str

os.path.join(LOGS_PATH, 'time.log')

Path to log file of processing time records.

const.STDOUT
Type:

str

os.path.join(LOGS_PATH, 'stdout.log')

Path to stdout replica.

const.STDERR
Type:

str

os.path.join(LOGS_PATH, 'stderr.log')

Path to stderr replica.

const.QUEUE_LOGS
Type:

multiprocessing.Queue

Availability:

bundled implementation

Teleprocess communication queue for log processing.

const.QUEUE
Type:

multiprocessing.Queue

Availability:

cluster implementation

See also

const.QUEUE_LOGS