![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flare-floss) [![Last release](https://img.shields.io/github/v/release/mandiant/flare-floss)](https://github.com/mandiant/flare-floss/releases) [![CI status](https://github.com/mandiant/flare-floss/actions/workflows/tests.yml/badge.svg)](https://github.com/mandiant/flare-floss/actions/workflows/tests.yml) [![Downloads](https://img.shields.io/github/downloads/mandiant/flare-floss/total)](https://github.com/mandiant/flare-floss/releases) [![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE.txt) ![FLOSS logo](https://github.com/mandiant/flare-floss/blob/master/resources/floss-logo.png) # FLARE Obfuscated String Solver The FLARE Obfuscated String Solver (FLOSS, formerly FireEye Labs Obfuscated String Solver) uses advanced static analysis techniques to automatically extract and deobfuscate all strings from malware binaries. You can use it just like `strings.exe` to enhance the basic static analysis of unknown binaries. ### Obfuscated Strings Rather than heavily protecting backdoors with hardcore packers, many malware authors evade heuristic detections by obfuscating only key portions of an executable. Often, these portions are strings and resources used to configure domains, files, and other artifacts of an infection. These key features will not show up as plaintext in the output of the `strings.exe` utility that we commonly use during basic static analysis. FLOSS extracts all the following string types: 1. static strings: "regular" ASCII and UTF-16LE strings 2. stack strings: strings constructed on the stack at run-time 3. tight strings: a special form of stack strings, decoded on the stack 4. decoded strings: strings decoded in a function Please review the theory behind FLOSS [here](doc/theory.md). Our [blog post](https://cloud.google.com/blog/topics/threat-intelligence/automatically-extracting-obfuscated-strings/) talks more about the motivation behind FLOSS and details how the tool works. FLOSS version 2.0 updates are detailed in this [blog post](https://cloud.google.com/blog/topics/threat-intelligence/floss-version-2/). ### Language-specific Strings Not all compilers use string formats that the classic `strings.exe` algorithm supports. For example, if strings are UTF-8 encoded or stored without a NULL-terminator. FLOSS can identify and extract strings from programs compiled from the following languages: 1. Go 2. Rust The strings FLOSS extracts specific to a compiler are much easier to inspect by humans. Please consult the documentation to learn more about the [language-specific string extraction](doc/language_specific_strings.md). ### Layout-aware static strings FLOSS enriches static strings by default with file structure context and tags (global prevalence, open-source libraries, expert rules, and more). Stack, tight, and decoded strings still appear after the layout-aware static listing when deobfuscation is enabled. ```console $ floss sample.exe $ floss sample.exe -j ``` Features: - extract ASCII and UTF-16LE strings - show strings next to right-aligned, colored context, including tags and file offset - render strings within PE section range delimiters - annotate strings from known PE structures, like the import table - don't show junk strings that overlap with instructions - mute strings known to be globally prevalent, via an embedded database - mute strings from popular open source libraries, via embedded databases - highlight strings that match expert rules, via embedded databases ![screenshot 1](https://github.com/mandiant/flare-floss/assets/156560/f2d471a3-2624-498c-aaa9-928e2909c338) ![screenshot 2](https://github.com/mandiant/flare-floss/assets/156560/23bd20a1-7dff-46b5-be65-12582cb90d64) Tag databases and FLIRT signature files are tracked with Git LFS; contributors cloning the repo may need Git LFS installed to fetch those files. Maintenance of tag databases is documented in [scripts/tags/README.md](scripts/tags/README.md) and the per-database notes under `floss/tags/data/`. ## Installation To use FLOSS, download a standalone executable file from the releases page: https://github.com/mandiant/flare-floss/releases See the [installation documentation](doc/installation.md) for a detailed description of all methods to install FLOSS. ## Usage Examples Extract obfuscated strings from a malware binary: $ floss malware.exe Only extract stack and tight strings: $ floss --string-type stack tight -- suspicious.exe Do not extract static strings: $ floss --no-string-type static -- backdoor.exe Display the help/usage screens: $ floss -h # show all supported arguments Enable tab completion for flags, choice values, and file paths with `floss --print-completion bash` (also zsh, fish); installation instructions are in [doc/usage.md](doc/usage.md#shell-completions). For a detailed description of using FLOSS, review the documentation [here](doc/usage.md). ## Scripts FLOSS also contains additional Python scripts in the [scripts](scripts) directory which can be used to load its output into other tools such as Binary Ninja or IDA Pro. For detailed description of these scripts review the documentation [here](scripts/README.md). ## Graphical viewer Explore `floss -j` output in the hosted [web viewer](https://mandiant.github.io/flare-floss/): upload the JSON, filter strings by search term, minimum length, tags, or structures, and copy what you keep. You can also build it yourself into a single, self-contained offline HTML file that opens directly in a browser, see [viewer/README.md](viewer/README.md). ## Documentation - [doc/usage.md](doc/usage.md) — CLI usage: extraction, filtering, rendering, and environment variables - [doc/results_document.md](doc/results_document.md) — the versioned JSON results schema - [doc/tags.md](doc/tags.md) — the semantic tag system and its tag families - [doc/language_specific_strings.md](doc/language_specific_strings.md) — Go and Rust string extraction - [doc/theory.md](doc/theory.md) — the deobfuscation algorithm - [doc/installation.md](doc/installation.md) — all installation methods - [doc/test.md](doc/test.md) — how to build and run the test suite - [viewer/README.md](viewer/README.md) — web viewer development ## Mailing List Subscribe to the FLARE mailing list for community announcements by sending an email with the subject "subscribe" to [flare-external@google.com](mailto:flare-external@google.com?subject=subscribe&body=subscribe).