Rust Wrapper for ssdeep
A Rust wrapper for ssdeep by Jesse Kornblum, which is a C library for computing context triggered piecewise hashes (CTPH). Also called fuzzy hashes, CTPH can match inputs that have homologies. Such inputs have sequences of identical bytes in the same order, although bytes in between these sequences may be different in both content and length. In contrast to standard hashing algorithms, CTPH can be used to identify files that are highly similar but not identical. See this blog post for more details.
To compute the fuzzy hash of a given buffer, use the
extern crate ssdeep; let h = ssdeep::hash(b"Hello there!").unwrap(); assert_eq!(h, "3:aNRn:aNRn");
If you want to obtain the fuzzy hash of a file, you can use
let h = ssdeep::hash_from_file("path/to/file").unwrap();
To compare two fuzzy hashes, use
compare(), which returns an integer between
0 (no match) and 100:
let h1 = b"3:AXGBicFlgVNhBGcL6wCrFQEv:AXGHsNhxLsr2C"; let h2 = b"3:AXGBicFlIHBGcL6wCrFQEv:AXGH6xLsr2Cx"; let score = ssdeep::compare(h1, h2).unwrap(); assert_eq!(score, 22);
Each of these functions returns an
is returned when the underlying C function fails.
Add the following lines into your
[dependencies] ssdeep = "0.2.0"
Then, when you run
cargo build, it will automatically get the wrapper's
source code from crates.io, compile the underlying C
library, and build the wrapper. The C library is statically linked into the
An automatically generated API documentation is available here:
The wrapper's code is licensed under the terms of GPLv3.
This wrapper includes the unchanged source distribution of ssdeep version 2.13, which is compiled and statically linked into the wrapper during build. It is licensed under GPLv2.