StringSifter is a machine learning tool that automatically ranks strings based on their relevance for malware analysis.
StringSifter requires Python version 3.6 or newer. Run the following commands to get the code, run unit tests, and use the tool:
Use pip
to get running immediately. Choose the major version corresponding to your version of python:
Python Version | Stringsifter Version | Branch | Example Pip Command |
---|---|---|---|
3.8+ | 2.x | master | pip install stringsifter~=2.0 |
3.6, 3.7 | 1.x | python3.7 | pip install stringsifter~=1.0 |
For development, check out the correct branch for your Python version or stay on master for the latest supported version. Then use pipenv
:
git clone https://github.com/fireeye/stringsifter.git
cd stringsifter
git checkout python3.7 #Optional
pipenv install --dev
To run unit tests from the StringSifter installation directory:
pipenv run tests
The pip install
command installs two runnable scripts flarestrings
and rank_strings
into your python environment. When developing from source, use pipenv run flarestrings
and pipenv run rank_strings
.
flarestrings
mimics features of GNU binutils' strings
, and rank_strings
accepts piped input, for example:
flarestrings <my_sample> | rank_strings
rank_strings
supports a number of command line arguments. The positional argument input_strings
specifies a file of strings to rank. The optional arguments are:
Option | Meaning |
---|---|
--scores (-s) | Include the rank scores in the output |
--limit (-l) | Limit output to the top limit ranked strings |
--min-score (-m) | Limit output to strings with score >= min-score |
--batch (-b) | Specify a folder of strings outputs for batch processing |
Ranked strings are written to standard output unless the --batch
option is specified, causing ranked outputs to be written to files named <input_file>.ranked_strings
.
flarestrings
supports an option -n
(or --min-len
) to print sequences of characters that are at least min-len
characters long, instead of the default 4. For example:
flarestrings -n 8 <my_sample> | rank_strings
will print and rank only strings of length 8 or greater.
docker build -t stringsifter -f docker/Dockerfile .
flarestrings
or rank_strings
argument to use the respective command. The containerized commands can be used in pipelines:
cat <my_sample> | docker run -i stringsifter flarestrings | docker run -i stringsifter rank_strings
-v
flag to expose a host directory to the container:
docker run -v <my_malware>:/samples -it stringsifter
where <my_malware>
contains samples for analysis, for example:
docker run -v $HOME/malware/binaries:/samples -it stringsifter
flarestrings /samples/<my_sample> | rank_strings <options>
All command line arguments are supported in the containerized scripts.
StringSifter can be applied to arbitrary lists of strings, making it useful for practitioners looking to glean insights from alternative intelligence-gathering sources such as live memory dumps, sandbox runs, or binaries that contain obfuscated strings. For example, FireEye Labs Obfuscated Strings Solver (FLOSS) extracts printable strings just as Strings does, but additionally reveals obfuscated strings that have been encoded, packed, or manually constructed on the stack. It can be used as an in-line replacement for Strings, meaning that StringSifter can be similarly invoked on FLOSS output using the following command:
$PY2_VENV/bin/floss –q <options> <my_sample> | rank_strings <options>
Notes:
–q
argument suppresses headers and formatting to show only extracted strings. To learn more about additional FLOSS options, please see its Usage Docs.floss
or rank_strings
must include a relative path referencing a python virtual enviroment.strings
This distribution includes the flarestrings
program to ensure predictable output across platforms. If you choose to run your system's installed strings
note that its options are not consistent across versions and platforms:
Most Linux distributions include the strings
program from GNU Binutils. To extract both "wide" and "narrow" strings the program must be run twice, piping to an output file:
strings <my_sample> > strs.txt # narrow strings
strings -el <my_sample> >> strs.txt # wide strings. note the ">>"
Some versions of BSD strings
packaged with MacOS do not support wide strings. Also note that the -a
option to strings to scan the whole file may be disabled in the default configuration. Without -a
informative strings may be lost. We recommend installing GNU Binutils via Homebrew or MacPorts to get a version of strings
that supports wide characters. Use care to invoke the correct version of strings
.
strings
is not installed by default on Windows. We recommend installing Windows Sysinternals, Cygwin, or Malcode Analyst Pack to get a working strings
.
This version of StringSifter was trained using Strings outputs from sampled malware binaries associated with the first EMBER dataset. Ordinal labels were generated using weak supervision procedures, and supervised learning is performed by Gradient Boosted Decision Trees with a learning-to-rank objective function. See Quick Links for further technical details. Please note that neither labeled data nor training code is currently available, though we may reconsider this approach in future releases.
We use GitHub Issues for posting bugs and feature requests.
flarestrings
is derived from the excellent tool FLOSS.