40 releases (breaking)
0.29.0 | Sep 26, 2024 |
---|---|
0.28.0 | Jun 3, 2024 |
0.27.0 | May 6, 2024 |
0.26.0 | Feb 16, 2024 |
0.1.0 | May 30, 2018 |
#33 in FFI
832 downloads per month
Used in 5 crates
4MB
103K
SLoC
yara-rust
Bindings for the Yara library from VirusTotal.
More documentation can be found on the Yara's documentation.
Example
The implementation is inspired from yara-python.
const RULES: &str = r#"
rule contains_rust {
strings:
$rust = "rust" nocase
condition:
$rust
}
"#;
fn main() {
let compiler = Compiler::new().unwrap();
let compiler = compiler
.add_rules_str(RULES)
.expect("Should have parsed rule");
let rules = compiler
.compile_rules()
.expect("Should have compiled rules");
let results = rules
.scan_mem("I love Rust!".as_bytes(), 5)
.expect("Should have scanned");
assert!(results.iter().any(|r| r.identifier == "contains_rust"));
}
Features
- Support from Yara v4.2.
- Compile rules from strings or files.
- Save and load compiled rules.
- Scan byte arrays (
&[u8]
) or files.
Feature flags and Yara linking.
Look at the yara-sys crate documentation for a list of feature flags and how to link to your Yara crate.
TODO
- Remove some
unwrap
on string conversions (currently this crate assume the rules, meta and namespace identifier are valid Rust'sstr
). - Accept
AsRef<Path>
instead of&str
on multiple functions. - Implement the scanner API.
- Add process scanning.
- Report the warnings to the user.
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contributing
Please follow the conventional commit rules when committing to this repository.
If you add any new feature, add the corresponding unit/doc tests.