Lib.rs

Cargo Features

[dependencies]
boreal = { version = "0.7.0", default-features = false, features = ["hash", "object", "magic", "cuckoo", "authenticode", "memmap", "process", "profiling"] }

default = hash, memmap, object, process

These default features are set whenever boreal is added without default-features = false somewhere in the dependency tree.

hash default

Enables the "hash" module.

Enables crc32fast, hex, md-5, sha1, sha2, and tlsh2

crc32fast:

"hash" feature

object default

Enables the "pe", "elf" and "macho" modules.

The "pe" module is missing signatures details unless the authenticode feature is enabled.

Enables object ^0.35

"object" feature

magic

Enables the "magic" module.

Enables module-magic of yara ^0.26 and magic

"magic" feature

cuckoo

Enables the "cuckoo" module.

Enables module-cuckoo of yara ^0.26 and serde_json

"cuckoo" feature

authenticode

Enables the "pe.signatures" module field. The object feature must also be enabled to get access to the "pe" module.

Enables authenticode-parser and hex

authenticode-parser:

"authenticode" feature

memmap default

Adds an API to scan files using memory maps.

Enables memmap2

"memmap" feature

process default

Adds APIs to scan process memories.

Enables libc, mach2, and windows-sys

profiling

Enables computation of statistics during scanning.