<p align="center">
  <img src="https://gist.githubusercontent.com/vee1e/d561fcadc2627cc3dcb115d18847a236/raw/gsoc-logo.png" width="120" style="vertical-align: middle;">
  <img src="https://gist.githubusercontent.com/vee1e/d561fcadc2627cc3dcb115d18847a236/raw/flare-logo.png" width="220" style="vertical-align: middle;">
</p>

<div align="center">

# Extend FLOSS to use the rendering techniques pioneered by QUANTUMSTRAND

</div>

**Organization:** FLARE (Mandiant, a Google Cloud company)

**Contributor:** Lakshit Verma ([@vee1e](https://github.com/vee1e))

**Mentor:** Moritz Raabe ([@mr-tz](https://github.com/mr-tz))

**Repository:** [mandiant/flare-floss](https://github.com/mandiant/flare-floss)

## Project overview

FLOSS is the FLARE team's command line tool for extracting obfuscated and plaintext strings from malware. An analyst runs it against a binary and gets the readable text the malware uses: URLs, registry paths, API names, and more. That output is useful but bare: it is a flat list of strings with no context.

QuantumStrand (QS) is an experimental branch of FLOSS that adds context. It parses the binary's structure, splits it into sections and regions, and tags each string with extra meaning: which library it likely comes from, whether it is common noise, which API family it belongs to. It also renders results in a hierarchical tree instead of a flat list.

The goal of this project was to take the best of QS and make it the default behavior of FLOSS, so every user gets layout-aware, tag-enriched output without extra flags. The project also covered the supporting infrastructure: automated string database builds, a redesigned command line, result caching, and a web viewer.

This submission is split into two parts. The pre-GSoC work below landed before the coding period started in June, mostly while I was getting familiar with the QS branch. The coding-period deliverables in the second half are the core of the GSoC project.

## Project status

The work is essentially complete. QS was refactored into first-class FLOSS modules, the unified pipeline is the default output path, the new command line is merged, caching ships with the tool, and the web viewer is merged. The final step is the merge of the QuantumStrand branch into master, which is open as [PR #1372](https://github.com/mandiant/flare-floss/pull/1372) at the time of writing.

## Pre-GSoC work

These PRs landed between March and May, before the coding period. They fixed QS bugs, added format parsing, and covered community bonding tasks like CI hygiene.

### Format and structure parsing

- [PR #1221](https://github.com/mandiant/flare-floss/pull/1221): Mach-O parsing, including universal (fat) binaries, segments, code signatures, and entitlements.
- [PR #1230](https://github.com/mandiant/flare-floss/pull/1230): PE export table parsing, extracting DLL names, exported symbols, and forwarder names.
- [PR #1231](https://github.com/mandiant/flare-floss/pull/1231) and [PR #1233](https://github.com/mandiant/flare-floss/pull/1233): PE Rich header detection, plus a crash fix for empty headers.
- [PR #1229](https://github.com/mandiant/flare-floss/pull/1229): human-readable PE resource names instead of raw numeric IDs.

### Correctness fixes

- [PR #1217](https://github.com/mandiant/flare-floss/pull/1217): fixed false negatives for zlib error strings.
- [PR #1225](https://github.com/mandiant/flare-floss/pull/1225): consolidated the display of adjacent tags in the output.
- [PR #1242](https://github.com/mandiant/flare-floss/pull/1242): honored the `skip_libs` setting in decoder scoring.
- [PR #1243](https://github.com/mandiant/flare-floss/pull/1243): tightened import taint detection.
- [PR #1244](https://github.com/mandiant/flare-floss/pull/1244): removed the traceback on Ctrl+C.
- [PR #1259](https://github.com/mandiant/flare-floss/pull/1259): fixed a crash rendering stack strings from Rust binaries.

### Exploratory and community bonding

- [PR #1224](https://github.com/mandiant/flare-floss/pull/1224) (closed): prototyped heuristics for junk strings in Rust binaries; we agreed a regex band-aid was not the right fix.
- [PR #1303](https://github.com/mandiant/flare-floss/pull/1303): a pinact workflow that verifies GitHub Actions are pinned to commit hashes, reducing supply chain risk.
- [PR #1304](https://github.com/mandiant/flare-floss/pull/1304): fixed a stale pinned SHA in the build workflow.
- [PR #1301](https://github.com/mandiant/flare-floss/pull/1301) (closed): a first, over-detailed AGENTS.md draft that we later rewrote into the slim version below.

## Coding-period deliverables

### 1. Native ELF parsing

- [PR #1312](https://github.com/mandiant/flare-floss/pull/1312): native ELF parsing. Builds a section tree, tags relocation sections so they are not misread as strings, detects executable sections, and handles XOR-decoded ELFs. A test corpus of ELF binaries was added to the testfiles submodule.

This closed the format gap left by the pre-GSoC Mach-O and PE work, so layout rendering now works across all three major formats.

### 2. Automated open-source string database builds

FLOSS tags strings by matching them against databases of known library strings. Those databases used to be built by hand. This work automated the whole pipeline so they stay fresh.

- [PR #1327](https://github.com/mandiant/flare-floss/pull/1327): a build script and bi-weekly CI workflow that compiles open-source libraries with vcpkg, extracts their strings, converts and deduplicates them into the FLOSS database format, and opens an automated PR with build metrics when anything changes.
- [PR #1334](https://github.com/mandiant/flare-floss/pull/1334): a readable text diff of database changes, embedded in the auto-generated PR descriptions.
- [PR #1332](https://github.com/mandiant/flare-floss/pull/1332): workflow dependency and versioning fixes.
- [PR #1309](https://github.com/mandiant/flare-floss/pull/1309): moved the string databases to Git LFS, saving roughly 24 MB per shallow clone.
- The library list was settled at around 60 open-source libraries, chosen by auditing false-positive rates against a global prevalence database built from 150,000 real-world samples.

Building the databases surfaced a bug in the upstream lancelot string extractor, which the pipeline depends on. Two common C++ libraries (cryptopp and jsoncpp) triggered a crash on weak external symbols. I filed [issue #235](https://github.com/williballenthin/lancelot/issues/235) with a full reproduction and shipped the fix in [PR #237](https://github.com/williballenthin/lancelot/pull/237), which Willi merged.

The database builder lives in `scripts/build_oss_db.py` and the automated update workflow in `.github/workflows/build-oss-db.yml`.

### 3. The QS to FLOSS integration

This is the core of the project: turning QS's separate package into the default FLOSS pipeline.

- [PR #1337](https://github.com/mandiant/flare-floss/pull/1337): split the monolithic QS module into first-class `floss/layout` and `floss/tags` packages and unified the command line. Roughly 4,000 lines moved and rewritten with no behavior change.
- [PR #1347](https://github.com/mandiant/flare-floss/pull/1347): made the unified pipeline the default. Every string type flows through the same stages into one `ResultDocument`, and every output mode renders from that document.

A thousand-sample parity test proved the refactor did not change behavior: 905 of 905 layout outputs matched upstream QS exactly, and 918 of 918 classic-mode outputs matched master exactly.

The pipeline is coordinated in `floss/pipeline.py`. The layout tree, tag engine, and renderers live in `floss/layout`, `floss/tags`, and `floss/render`. The results schema lives in `floss/results.py`.

### 4. The redesigned command line

QS had its own set of flags that did not match FLOSS. The spec called for one coherent interface, delivered in three parts.

- [PR #1355](https://github.com/mandiant/flare-floss/pull/1355): Part 1. Symmetrical include and exclude flags for string types (`--string-type` / `--no-string-type`), renamed `--functions` to `--analyze-functions`, removed the manual load flag in favor of automatic results detection, and added runtime timing fields to the results.
- [PR #1360](https://github.com/mandiant/flare-floss/pull/1360): Part 2. Render-time filters by section, structure, and tag (`--section`, `--structure`, `--tag`, with matching `--no-*` forms), `--query` for regex filtering that preserves the tree, `--max-strings` to cap output, an `--interesting` shortcut that drops noisy tags, a new `--summary` output, and sorted stable JSON with structured JSON errors on stderr.
- [PR #1367](https://github.com/mandiant/flare-floss/pull/1367): Part 3. Result caching (see below).

### 5. Result caching

- [PR #1367](https://github.com/mandiant/flare-floss/pull/1367): automatic analysis caching. The cache is keyed by a SHA-256 of the sample bytes plus the FLOSS version, stored in the platform cache directory, and written atomically behind a lock. Filters apply at render time, so cached results respect any new flags. Moritz benchmarked a sample going from about 30 seconds to about 3.5 seconds on cache hit, roughly an 8 to 10x speedup for repeat runs.

The module is `floss/cache.py`, with tests in `tests/test_cache.py`.

### 6. The web viewer

- [PR #1358](https://github.com/mandiant/flare-floss/pull/1358): reworked the QS web viewer to match the unified `ResultDocument` schema, added light and dark themes, fuzzy search, and virtualized rendering for very large string corpora. Deployed live for iteration during development.

The viewer lives in the `viewer/` directory and is served from a Vercel deployment during development; a standalone release path is planned.

### 7. Reproducibility and CI hygiene (coding period)

- [PR #1308](https://github.com/mandiant/flare-floss/pull/1308): the slimmed-down AGENTS.md so AI coding tools have the context they need before generating code in this repo.
- [PR #1370](https://github.com/mandiant/flare-floss/pull/1370): deprecated all `qs` / QuantumStrand naming, renamed the viewer, retargeted CI to master, and cleaned up stale branches, preparing the branch for the final merge.

## Timeline of feature work

The coding period ran from June through August. This is how the work above landed, in order.

**June**
- Early June: AGENTS.md for AI contributors ([PR #1308](https://github.com/mandiant/flare-floss/pull/1308)) and the move of the string databases to Git LFS ([PR #1309](https://github.com/mandiant/flare-floss/pull/1309)).
- Mid-June: native ELF parsing ([PR #1312](https://github.com/mandiant/flare-floss/pull/1312)) completed the format coverage started before the coding period.

**July**
- Early July: the automated string database pipeline landed ([PR #1327](https://github.com/mandiant/flare-floss/pull/1327)), followed by dependency fixes ([PR #1332](https://github.com/mandiant/flare-floss/pull/1332)) and database-change diffs in the auto-generated PRs ([PR #1334](https://github.com/mandiant/flare-floss/pull/1334)).
- Late July: the first big integration step, splitting QS into first-class `floss/layout` and `floss/tags` modules ([PR #1337](https://github.com/mandiant/flare-floss/pull/1337)).

**August**
- Early August: the unified pipeline became the default output path ([PR #1347](https://github.com/mandiant/flare-floss/pull/1347)).
- Mid-August: the new command line landed in two parts, the string type flags and runtime timing ([PR #1355](https://github.com/mandiant/flare-floss/pull/1355)) then the render-time filters and summary output ([PR #1360](https://github.com/mandiant/flare-floss/pull/1360)). The web viewer was reworked to match the new results schema ([PR #1358](https://github.com/mandiant/flare-floss/pull/1358)).
- Late August: result caching ([PR #1367](https://github.com/mandiant/flare-floss/pull/1367)) and the cleanup that deprecated the old `qs` naming ([PR #1370](https://github.com/mandiant/flare-floss/pull/1370)).
- The final merge of QuantumStrand into master ([PR #1372](https://github.com/mandiant/flare-floss/pull/1372)) is open at the time of writing.

## Reviews I contributed

Part of the work was reviewing others. The notable PRs I was asked to review:

- [PR #1319](https://github.com/mandiant/flare-floss/pull/1319): ELF parsing robustness, including fallback for corrupt binaries. I checked the new fallback logic and requested a real corrupted test file over a mock.
- [PR #1326](https://github.com/mandiant/flare-floss/pull/1326): global prevalence database update. I asked whether the large size gap between the Go and Rust sub-databases was intentional before approving.
- [PR #1366](https://github.com/mandiant/flare-floss/pull/1366): summary view revamp. I caught that the new filtering let untagged generic strings crowd out tagged interesting ones, and flagged now-dead code, before it merged.
- [PR #1273](https://github.com/mandiant/flare-floss/pull/1273), [PR #1294](https://github.com/mandiant/flare-floss/pull/1294), [PR #1328](https://github.com/mandiant/flare-floss/pull/1328), [PR #1240](https://github.com/mandiant/flare-floss/pull/1240): robustness, performance, and cleanup reviews.

## What is left to do

- **Merge QuantumStrand into master.** [PR #1372](https://github.com/mandiant/flare-floss/pull/1372) is open and green, awaiting final review. This is the last gate.
- **Web viewer distribution.** Decide how the viewer ships: inside the released binary, served from the tool, or as a standalone site. Add a deploy workflow so it updates automatically.
- **Documentation.** The usage guide does not yet document the new flags, the summary output, or the cache environment variables.
- **Cache maintenance.** A v1 tradeoff: there is no eviction or quota for the cache directory yet, and very large result documents load fully into memory.

None of these block the core functionality. The new pipeline, CLI, and cache are all merged and working.

## Challenges

The largest single risk was the big refactor in [PR #1337](https://github.com/mandiant/flare-floss/pull/1337). Moving 4,000 lines around risks quietly changing behavior. We addressed it with evidence instead of argument: a parity harness ran old and new code over a thousand random samples, and every output matched. That became the review bar for the rest of the project.

The automated database pipeline surfaced a real bug in the upstream lancelot string extractor. Two common C++ libraries (cryptopp and jsoncpp) triggered a crash on weak external symbols. I filed a reproduction and shipped the fix upstream, which is exactly the kind of problem a maintainer wants contributors to solve at the root.

The planning document was the other hard part. A discussion doc and an implementation spec are different things, and it took a while to realize we needed the latter. Rewriting it as a spec that could be handed to coding agents unblocked the final months of the project. It also became the design reference for the new CLI and the caching module.

## Acknowledgements

Thanks to my mentor Moritz Raabe for the straight talk and the support, and for reviewing far more than his share of large diffs. Thanks to Willi Ballenthin for the sharp reviews and for merging the upstream lancelot fix. Thanks to the rest of the FLARE team for their library recommendations and guidance. This project would not have happened without them.