Lib.rs

Cargo Features

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

default = authenticode, 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, 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

"object" feature

magic

Enables the "magic" module.

Enables module-magic of yara and magic

"magic" feature

cuckoo

Enables the "cuckoo" module.

Enables module-cuckoo of yara and serde_json

"cuckoo" feature

authenticode default

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

Enables const-oid, der, md-5, sha1, and sha2

const-oid:

"authenticode" feature

authenticode-verify

Enables the "pe.is_signed", "pe.signatures[*].verified" and "pe.signatures[*].countersignatures[*].verified" module fields.

Enables spki, p256, p384, and rsa, oid of optional md-5, oid of optional sha1 and optional sha2 and dsa

"authenticode-verify" 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.

Affects ac_scan::ScanData.statistics…