Skip to content

Latest commit

 

History

History
1998 lines (1549 loc) · 102 KB

CHANGELOG.md

File metadata and controls

1998 lines (1549 loc) · 102 KB
Raw

Change Log

master (unreleased)

New Features

Breaking Changes

  • remove support for Python 3.8 and use Python 3.10 as minimum now #1966 @mr-tz

New Rules (0)

Bug Fixes

  • extractor: fix exception when PE extractor encounters unknown architecture #2440 @Tamir-K
  • IDA Pro: rename ida to idapro module for plugin and idalib in IDA 9.0 #2453 @mr-tz
  • ghidra: fix saving of base address @mr-tz

capa Explorer Web

capa Explorer IDA Pro plugin

  • fix bug preventing saving of capa results via Save button @mr-tz
  • fix saving of base address @mr-tz

Development

Raw diffs

v7.4.0

The v7.4.0 capa release fixes a bug when processing VMRay analysis archives and enhances API extraction for all dynamic backends. For better terminal rendering capa now solely relies on the rich library.

The standalone capa executable can now automatically detect installations of relevant third party applications and use their backends (notably, idalib and Binary Ninja). For the extra standalone Linux build we've upgraded from Python 3.11 to 3.12.

Twelve new rules have been added. Thanks to all the contributors!

This is the last capa version supporting Python 3.8 and 3.9. If you have major concerns about this please reach out to us.

New Features

  • add IDA v9.0 backend via idalib #2376 @williballenthin
  • locate Binary Ninja API using XDG Desktop Entries #2376 @williballenthin

New Rules (15)

Bug Fixes

  • use Python 3.12 to build extra standalone build on Linux #2383 @williballenthin
  • bump minimum Python version to 3.8.1 to satisfy uv #2387 @williballenthin
  • vmray: collect more process information from flog.xml #2394 @mr-tz @mike-hunhoff
  • replace tabulate, tqdm, and termcolor with rich #2374 @s-ff
  • dynamic: emit complete features for A/W APIs #2409 @mike-hunhoff
  • vmray: fix backslash handling in string call arguments #2428 @mr-tz

capa Explorer Web

  • improve navigation in capa Explorer Web @s-ff #2425

Raw diffs

v7.3.0

This release comes with the following three major enhancements:

1. Support for VMRay sandbox analysis archives

Unlock powerful malware analysis with capa's new VMRay sandbox integration! Simply provide a VMRay analysis archive, and capa will automatically extract and match capabilities to streamline your workflow. This is the second support for the analysis of dynamic analysis results after CAPE.

2. Support for BinExport files generated by Ghidra

BinExport files store disassembled data into a Protocol Buffer format. capa now supports the analysis of BinExport files generated by Ghidra. Using Ghidra and the BinExport file format users can now analyze ARM (AARCH64) ELF files targeting Android.

3. Introducing the capa rules website

You can now browse capa's default rule set at https://mandiant.github.io/capa/rules. In modern terminals the CLI capa tool hyperlinks to resources on the web, including entries on the capa rules website. Furthermore, https://mandiant.github.io/capa provides a landing page for the capa tool project.

Additional updates

  • capa Explorer Web received several enhancements and bug fixes.
  • Support for the IDA Pro 9.0 IDAPython API while keeping compatibility to older IDA Pro versions
  • Six rules have been added and two rules have been updated

Thanks to @r-sm2024 for their contribution in mandiant#2155 and their further work. And of course a big thanks to the community for reporting issues, participating in discussions, and supporting the capa tool and capa rules.

New Features

  • regenerate ruleset cache automatically on source change (only in dev mode) #2133 @s-ff
  • add landing page https://mandiant.github.io/capa/ @williballenthin #2310
  • add rules website https://mandiant.github.io/capa/rules @DeeyaSingh #2310
  • add .justfile @williballenthin #2325
  • dynamic: add support for VMRay dynamic sandbox traces #2208 @mike-hunhoff @r-sm2024 @mr-tz
  • cli: use modern terminal features to hyperlink to the rules website #2337 @williballenthin
  • support analyzing BinExport2 files generated by Ghidra #1950 @williballenthin @mehunhoff @mr-tz
  • add support for Android OS #1950 @williballenthin @mehunhoff @mr-tz
  • add support for aarch64 architecture via BinExport2 backend #1950 @williballenthin @mehunhoff @mr-tz

New Rules (6)

Bug Fixes

  • fix duplicate features shown in vverbose mode @williballenthin #2323
  • fix code path reference in linter @williballenthin #2350

capa explorer IDA Pro plugin

  • update IDAPython to IDA Pro 9.0 @mr-tz
  • fix byte search IDA Pro 7.5 compatibility @mr-tz #2371

Raw diffs

v7.2.0

capa v7.2.0 introduces a first version of capa explorer web: a web-based user interface to inspect capa results using your browser. Users can inspect capa result JSON documents in an online web instance or a standalone HTML page for offline usage. capa explorer supports interactive exploring of capa results to make it easier to understand them. Users can filter, sort, and see the details of all identified capabilities. capa explorer web was worked on by @s-ff as part of a GSoC project, and it is available at https://mandiant.github.io/capa/explorer/#/.

This release also adds a feature extractor for output from the DRAKVUF sandbox. Now, analysts can pass the resulting drakmon.log file to capa and extract capabilities from the artifacts captured by the sandbox. This feature extractor will also be added to the DRAKVUF sandbox as a post-processing script, and it was worked on by @yelhamer as part of a GSoC project.

Additionally, we fixed several bugs handling ELF files, and added the ability to filter capa analysis by functions or processes. We also added support to the IDA Pro extractor to leverage analyst recovered API names.

Special thanks to our repeat and new contributors:

New Features

  • webui: explore capa analysis results in a web-based UI online and offline #2224 @s-ff
  • support analyzing DRAKVUF traces #2143 @yelhamer
  • IDA extractor: extract names from dynamically resolved APIs stored in renamed global variables #2201 @Ana06
  • cli: add the ability to select which specific functions or processes to analyze @yelhamer

Breaking Changes

New Rules (5)

Bug Fixes

  • elf: extract import / export symbols from stripped binaries #2096 @ygasparis
  • elf: fix handling of symbols in corrupt ELF files #2226 @williballenthin

capa explorer IDA Pro plugin

Development

  • CI: use macos-12 since macos-11 is deprecated and will be removed on June 28th, 2024 #2173 @mr-tz
  • CI: update Binary Ninja version to 4.1 and use Python 3.9 to test it #2211 @xusheng6
  • CI: update tests.yml workflow to exclude web and documentation files #2263 @s-ff
  • CI: update build.yml workflow to exclude web and documentation files #2270 @s-ff
  • CI: add web releases workflow #2455 @s-ff

Raw diffs

v7.1.0

The v7.1.0 release brings large performance improvements to capa's rule matching engine. Additionally, we've fixed various bugs and added new features for people using and developing capa.

Special thanks to our repeat and new contributors:

New Features

  • Emit "dotnet" as format to ResultDocument when processing .NET files #2024 @samadpls
  • ELF: detect OS from statically-linked Go binaries #1978 @williballenthin
  • add function in capa/helpers to load plain and compressed JSON reports #1883 @Rohit1123
  • document Antivirus warnings and VirusTotal false positive detections #2028 @RionEV @mr-tz
  • Add json to sarif conversion script @reversingwithme
  • render maec/* fields #843 @s-ff
  • replace Halo spinner with Rich #2086 @s-ff
  • optimize rule matching #2080 @williballenthin
  • add aarch64 as a valid architecture #2144 [email protected] @williballenthin
  • relax dependency version requirements for the capa library #2053 @williballenthin
  • add scripts dependency group and update documentation #2145 @mr-tz

New Rules (25)

Bug Fixes

  • do some imports closer to where they are used #1810 @williballenthin
  • binja: fix and simplify stack string detection code after binja 4.0 @xusheng6
  • binja: add support for forwarded export #1646 @xusheng6
  • cape: support more report formats #2035 @mr-tz

capa explorer IDA Pro plugin

  • replace deprecated IDA API find_binary with bin_search #1606 @s-ff

Development

  • ci: Fix PR review in the changelog check GH action #2004 @Ana06
  • ci: use rules number badge stored in our bot gist and generated using schneegans/dynamic-badges-action #2001 capa-rules#882 @Ana06
  • ci: update github workflows to use latest version of actions that were using a deprecated version of node #1967 #2003 capa-rules#883 @sjha2048 @Ana06
  • ci: update binja version to stable 4.0 #2016 @xusheng6
  • ci: update github workflows to reflect the latest ghidrathon installation and bumped up jep, ghidra versions #2020 @psahithireddy
  • ci: include rule caching in PyInstaller build process #2097 @s-ff
  • add deptry support #1497 @s-ff

Raw diffs

v7.0.1

This release fixes a circular import error when using capa as a library.

Bug Fixes

  • fix potentially circular import errors #1969 @williballenthin

Raw diffs

v7.0.0

This is the v7.0.0 release of capa which was mainly worked on during the Google Summer of Code (GSoC) 2023. A huge shoutout to our GSoC contributors @colton-gabertan and @yelhamer for their amazing work.

Also, a big thanks to the other contributors: @aaronatp, @Aayush-Goel-04, @bkojusner, @doomedraven, @ruppde, @larchchen, @JCoonradt, and @xusheng6.

New Features

  • add Ghidra backend #1770 #1767 @colton-gabertan @mike-hunhoff
  • add Ghidra UI integration #1734 @colton-gabertan @mike-hunhoff
  • add dynamic analysis via CAPE sandbox reports #48 #1535 @yelhamer
    • add call scope #771 @yelhamer
    • add thread scope #1517 @yelhamer
    • add process scope #1517 @yelhamer
    • rules: change meta.scope to meta.scopes @yelhamer
    • protobuf: add Metadata.flavor @williballenthin
  • binja: add support for forwarded exports #1646 @xusheng6
  • binja: add support for symtab names #1504 @xusheng6
  • add com class/interface features #322 @Aayush-goel-04
  • dotnet: emit enclosing class information for nested classes #1780 #1913 @bkojusner @mike-hunhoff

Breaking Changes

  • remove the SCOPE_* constants in favor of the Scope enum #1764 @williballenthin
  • protobuf: deprecate RuleMetadata.scope in favor of RuleMetadata.scopes @williballenthin
  • protobuf: deprecate Metadata.analysis in favor of Metadata.analysis2 that is dynamic analysis aware @williballenthin
  • update freeze format to v3, adding support for dynamic analysis @williballenthin
  • extractor: ignore DLL name for api features #1815 @mr-tz
  • main: introduce wrapping routines within main for working with CLI args #1813 @williballenthin
  • move functions from capa.main to new capa.loader namespace #1821 @williballenthin
  • proto: add package declaration #1960 @larchchen

New Rules (41)

Bug Fixes

  • ghidra: fix ints_to_bytes performance #1761 @mike-hunhoff
  • binja: improve function call site detection @xusheng6
  • binja: use binaryninja.load to open files @xusheng6
  • binja: bump binja version to 3.5 #1789 @xusheng6
  • elf: better detect ELF OS via GCC .ident directives #1928 @williballenthin
  • elf: better detect ELF OS via Android dependencies #1947 @williballenthin
  • fix setuptools package discovery #1886 @gmacon @mr-tz
  • remove unnecessary scripts/vivisect-py2-vs-py3.sh file #1949 @JCoonradt

capa explorer IDA Pro plugin

  • various integration updates and minor bug fixes

Development

  • update ATT&CK/MBC data for linting #1932 @mr-tz

Developer Notes

With this new release, many classes and concepts have been split up into static (mostly identical to the prior implementations) and dynamic ones. For example, the legacy FeatureExtractor class has been renamed to StaticFeatureExtractor and the DynamicFeatureExtractor has been added.

Starting from version 7.0, we have moved the component responsible for feature extractor from main to a new capabilities' module. Now, users wishing to utilize capa’s feature extraction abilities should use that module instead of importing the relevant logic from the main file.

For sandbox-based feature extractors, we are using Pydantic models. Contributions of more models for other sandboxes are very welcome!

With this release we've reorganized the logic found in main() to localize logic and ease readability and ease changes and integrations. The new "main routines" are expected to be used only within main functions, either capa main or related scripts. These functions should not be invoked from library code.

Beyond copying code around, we've refined the handling of the input file/format/backend. The logic for picking the format and backend is more consistent. We've documented that the input file is not necessarily the sample itself (cape/freeze/etc.) inputs are not actually the sample.

Raw diffs

v6.1.0

capa v6.1.0 is a bug fix release, most notably fixing unhandled exceptions in the capa explorer IDA Pro plugin. @Aayush-Goel-04 put a lot of effort into improving code quality and adding a script for rule authors. The script shows which features are present in a sample but not referenced by any existing rule. You could use this script to find opportunities for new rules.

Speaking of new rules, we have eight additions, coming from Ronnie, Jakub, Moritz, Ervin, and [email protected]!

New Features

  • ELF: implement import and export name extractor #1607 #1608 @Aayush-Goel-04
  • bump pydantic from 1.10.9 to 2.1.1 #1582 @Aayush-Goel-04
  • develop script to highlight features not used during matching #331 @Aayush-Goel-04

New Rules (8)

Bug Fixes

  • rules: fix forwarded export characteristic #1656 @RonnieSalomonsen
  • Binary Ninja: Fix stack string detection #1473 @xusheng6
  • linter: skip native API check for NtProtectVirtualMemory #1675 @williballenthin
  • OS: detect Android ELF files #1705 @williballenthin
  • ELF: fix parsing of symtab #1704 @williballenthin
  • result document: don't use deprecated pydantic functions #1718 @williballenthin
  • pytest: don't mark IDA tests as pytest tests #1719 @williballenthin

capa explorer IDA Pro plugin

  • fix unhandled exception when resolving rule path #1693 @mike-hunhoff

Raw diffs

v6.0.0

capa v6.0 brings many bug fixes and quality improvements, including 64 rule updates and 26 new rules. We're now publishing to PyPI via Trusted Publishing and have migrated to using a pyproject.toml file. @Aayush-Goel-04 contributed a lot of new code across many files, so please welcome them to the project, along with @anders-v @crowface28 @dkelly2e @RonnieSalomonsen and @ejfocampo as first-time rule contributors!

For those that use capa as a library, we've introduced some limited breaking changes that better represent data types (versus less-structured data like dictionaries and strings). With the recent deprecation, we've also dropped support for Python 3.7.

New Features

  • add script to detect feature overlap between new and existing capa rules #1451 @Aayush-Goel-04
  • extract forwarded exports from PE files #1624 @williballenthin
  • extract function and API names from ELF symtab entries @yelhamer mandiant/capa-rules#736
  • use fancy box drawing characters for default output #1586 @williballenthin

Breaking Changes

  • use a class to represent Metadata (not dict) #1411 @Aayush-Goel-04 @manasghandat
  • use pathlib.Path to represent file paths #1534 @Aayush-Goel-04
  • Python 3.8 is now the minimum supported Python version #1578 @williballenthin
  • Require a Contributor License Agreement (CLA) for PRs going forward #1642 @williballenthin

New Rules (26)

Bug Fixes

  • extractor: add a Binary Ninja test that asserts its version #1487 @xusheng6
  • extractor: update Binary Ninja stack string detection after the new constant outlining feature #1473 @xusheng6
  • extractor: update vivisect Arch extraction #1334 @mr-tz
  • extractor: avoid Binary Ninja exception when analyzing certain files #1441 @xusheng6
  • symtab: fix struct.unpack() format for 64-bit ELF files @yelhamer
  • symtab: safeguard against ZeroDivisionError for files containing a symtab with a null entry size @yelhamer
  • improve ELF strtab and needed parsing @mr-tz
  • better handle exceptional cases when parsing ELF files #1458 @Aayush-Goel-04
  • improved testing coverage for Binary Ninja backend #1446 @Aayush-Goel-04
  • add logging and print redirect to tqdm for capa main #749 @Aayush-Goel-04
  • extractor: fix binja installation path detection does not work with Python 3.11
  • tests: refine the IDA test runner script #1513 @williballenthin
  • output: don't leave behind traces of progress bar @williballenthin
  • import-to-ida: fix bug introduced with JSON report changes in v5 #1584 @williballenthin
  • main: don't show spinner when emitting debug messages #1636 @williballenthin
  • rules: add forwarded export characteristics to rule syntax file scope #1653 @RonnieSalomonsen

capa explorer IDA Pro plugin

Development

  • update ATT&CK/MBC data for linting #1568 @mr-tz
  • log time taken to analyze each function #1290 @williballenthin
  • tests: make fixture available via conftest.py #1592 @williballenthin
  • publish via PyPI trusted publishing #1491 @williballenthin
  • migrate to pyproject.toml #1301 @williballenthin
  • use pre-commit to invoke linters #1579 @williballenthin

Raw diffs

v5.1.0

capa version 5.1.0 adds a Protocol Buffers (protobuf) format for result documents. Additionally, the Vector35 team contributed a new feature extractor using Binary Ninja. Other new features are a new CLI flag to override the detected operating system, functionality to read and render existing result documents, and an output color format that's easier to read.

Over 25 capa rules have been added and improved.

Thanks for all the support, especially to @xusheng6, @captainGeech42, @ggold7046, @manasghandat, @ooprathamm, @linpeiyu164, @yelhamer, @HongThatCong, @naikordian, @stevemk14ebr, @emtuls, @raymondlleong, @bkojusner, @joren485, and everyone else who submitted bugs and provided feedback!

New Features

  • add protobuf format for result documents #1219 @williballenthin @mr-tz
  • extractor: add Binary Ninja feature extractor @xusheng6
  • new cli flag --os to override auto-detected operating system for a sample @captainGeech42
  • change colour/highlight to "cyan" instead of "blue" for better readability #1384 @ggold7046
  • add new format to parse output json back to capa #1396 @ooprathamm
  • parse ELF symbols' names to guess OS #1403 @yelhamer

New Rules (26)

Bug Fixes

  • extractor: interface of cache modified to prevent extracting file and global features multiple times @stevemk14ebr
  • extractor: removed '.dynsym' as the library name for ELF imports #1318 @stevemk14ebr
  • extractor: fix vivisect loop detection corner case #1310 @mr-tz
  • match: extend OS characteristic to match OS_ANY to all supported OSes #1324 @mike-hunhoff
  • extractor: fix IDA and vivisect string and bytes features overlap and tests #1327 #1336 @xusheng6

capa explorer IDA Pro plugin

  • rule generator plugin now loads faster when jumping between functions @stevemk14ebr
  • fix exception when plugin loaded in IDA hosted under idat #1341 @mike-hunhoff
  • improve embedded PE detection performance and reduce FP potential #1344 @mike-hunhoff

Raw diffs

v5.0.0 (2023-02-08)

This capa version comes with major improvements and additions to better handle .NET binaries. To showcase this we've updated and added over 30 .NET rules.

Additionally, capa now caches its rule set for better performance. The capa explorer also caches its analysis results, so that multiple IDA Pro or plugin invocations don't need to repeat the same analysis.

We have removed the SMDA backend and changed the program return codes to be positive numbers.

Other improvements to highlight include better ELF OS detection, various rendering bug fixes, and enhancements to the feature extraction. We've also added support for Python 3.11.

Thanks for all the support, especially to @jsoref, @bkojusner, @edeca, @richardweiss80, @joren485, @ryantxu1, @mwilliams31, @anushkavirgaonkar, @MalwareMechanic, @Still34, @dzbeck, @johnk3r, and everyone else who submitted bugs and provided feedback!

New Features

  • verify rule metadata format on load #1160 @mr-tz
  • dotnet: emit property features #1168 @anushkavirgaonkar
  • dotnet: emit API features for objects created via the newobj instruction #1186 @mike-hunhoff
  • dotnet: emit API features for generic methods #1231 @mike-hunhoff
  • Python 3.11 support #1192 @williballenthin
  • dotnet: emit calls to/from MethodDef methods #1236 @mike-hunhoff
  • dotnet: emit namespace/class features for ldvirtftn/ldftn instructions #1241 @mike-hunhoff
  • dotnet: emit namespace/class features for type references #1242 @mike-hunhoff
  • dotnet: extract dotnet and pe format #1187 @mr-tz
  • don't render all library rule matches in vverbose output #1174 @mr-tz
  • cache the rule set across invocations for better performance #1212 @williballenthin
  • update ATT&CK/MBC data for linting #1297 @mr-tz

Breaking Changes

  • remove SMDA backend #1062 @williballenthin
  • error return codes are now positive numbers #1269 @mr-tz

New Rules (77)

Bug Fixes

  • render: convert feature attributes to aliased dictionary for vverbose #1152 @mike-hunhoff
  • decouple Token dependency / extractor and features #1139 @mr-tz
  • update pydantic model to guarantee type coercion #1176 @mike-hunhoff
  • do not overwrite version in version.py during PyInstaller build #1169 @mr-tz
  • render: fix vverbose rendering of offsets #1215 @williballenthin
  • elf: better detect OS via GLIBC ABI version needed and dependencies #1221 @williballenthin
  • dotnet: address unhandled exceptions with improved type checking #1230 @mike-hunhoff
  • fix import-to-ida script formatting #1208 @williballenthin
  • render: fix verbose rendering of scopes #1263 @williballenthin
  • rules: better detect invalid rules #1282 @williballenthin
  • show-features: better render strings with embedded whitespace #1267 @williballenthin
  • handle vivisect bug around strings at instruction level, use min length 4 #1271 @williballenthin @mr-tz
  • extractor: guard against invalid "calls from" features #1177 @mr-tz
  • extractor: add format to global features #1258 @mr-tz
  • extractor: discover all strings with length >= 4 #1280 @mr-tz
  • extractor: don't extract byte features for strings #1293 @mr-tz

capa explorer IDA Pro plugin

  • fix: display instruction items #1154 @mr-tz
  • fix: accept only plaintext pasted content #1194 @williballenthin
  • fix: UnboundLocalError #1217 @williballenthin
  • extractor: add support for COFF files and extern functions #1223 @mike-hunhoff
  • doc: improve error messaging and documentation related to capa rule set #1249 @mike-hunhoff
  • fix: assume 32-bit displacement for offsets #1250 @mike-hunhoff
  • generator: refactor caching and matching #1251 @mike-hunhoff
  • fix: improve exception handling to prevent IDA from locking up when errors occur #1262 @mike-hunhoff
  • verify rule metadata using Pydantic #1167 @mr-tz
  • extractor: make read consistent with file object behavior #1254 @mr-tz
  • fix: UnboundLocalError x2 #1302 @mike-hunhoff
  • cache capa results across IDA sessions #1279 @mr-tz

Raw diffs

v4.0.1 (2022-08-15)

Some rules contained invalid metadata fields that caused an error when rendering rule hits. We've updated all rules and enhanced the rule linter to catch such issues.

New Rules (1)

Bug Fixes

  • linter: use pydantic to validate rule metadata #1141 @mike-hunhoff
  • build binaries using PyInstaller no longer overwrites functions in version.py #1136 @mr-tz

Raw diffs

v4.0.0 (2022-08-10)

Version 4 adds support for analyzing .NET executables. capa will autodetect .NET modules, or you can explicitly invoke the new feature extractor via --format dotnet. We've also extended the rule syntax for .NET features including namespace and class.

Additionally, new instruction scope and operand features enable users to create more explicit rules. These features are not backwards compatible. We removed the previously used /x32 and /x64 flavors of number and operand features.

We updated 49 existing rules and added 22 new rules leveraging these new features and characteristics to detect capabilities seen in .NET malware.

More breaking changes include updates to the JSON results document, freeze file format schema (now format version v2), and the internal handling of addresses.

Thanks for all the support, especially to @htnhan, @jtothej, @sara-rn, @anushkavirgaonkar, and @_re_fox!

Deprecation warning: v4.0 will be the last capa version to support the SMDA backend.

New Features

  • add new scope "instruction" for matching mnemonics and operands #767 @williballenthin
  • add new feature "operand[{0, 1, 2}].number" for matching instruction operand immediate values #767 @williballenthin
  • add new feature "operand[{0, 1, 2}].offset" for matching instruction operand offsets #767 @williballenthin
  • extract additional offset/number features in certain circumstances #320 @williballenthin
  • add detection and basic feature extraction for dotnet #987 @mr-tz, @mike-hunhoff, @williballenthin
  • add file string extraction for dotnet files #1012 @mike-hunhoff
  • add file function-name extraction for dotnet files #1015 @mike-hunhoff
  • add unmanaged call characteristic for dotnet files #1023 @mike-hunhoff
  • add mixed mode characteristic feature extraction for dotnet files #1024 @mike-hunhoff
  • emit class and namespace features for dotnet files #1030 @mike-hunhoff
  • render: support Addresses that aren't simple integers, like .NET token+offset #981 @williballenthin
  • document rule tags and branches #1006 @williballenthin, @mr-tz

Breaking Changes

  • instruction scope and operand feature are new and are not backwards compatible with older versions of capa
  • Python 3.7 is now the minimum supported Python version #866 @williballenthin
  • remove /x32 and /x64 flavors of number and operand features #932 @williballenthin
  • the tool now accepts multiple paths to rules, and JSON doc updated accordingly @williballenthin
  • extractors must use handles to identify functions/basic blocks/instructions #981 @williballenthin
  • the freeze file format schema was updated, including format version bump to v2 #986 @williballenthin

Deprecation notice: as described in #937, we plan to remove the SMDA backend for v5. If you rely on this backend, please reach out so we can discuss extending the support for SMDA or transitioning your workflow to use vivisect.

New Rules (30)

Bug Fixes

  • improve handling _ prefix compile/link artifact #924 @mike-hunhoff
  • better detect OS in ELF samples #988 @williballenthin
  • display number feature zero in vverbose #1097 @mike-hunhoff

capa explorer IDA Pro plugin

  • improve file format extraction #918 @mike-hunhoff
  • remove decorators added by IDA to ELF imports #919 @mike-hunhoff
  • bug fixes for Address abstraction #1091 @mike-hunhoff

Development

Raw diffs

v3.2.1 (2022-06-06)

This out-of-band release bumps the SMDA dependency version to enable installation on Python 3.10.

Bug Fixes

  • update SMDA dependency @mike-hunhoff #922

Raw diffs

v3.2.0 (2022-03-03)

This release adds a new characteristic characteristic: call $+5 enabling users to create more explicit rules. The linter now also validates ATT&CK and MBC categories. Additionally, many dependencies, including the vivisect backend, have been updated.

One rule has been added and many more have been improved.

Thanks for all the support, especially to @kn0wl3dge and first time contributor @uckelman-sf!

New Features

  • linter: validate ATT&CK/MBC categories and IDs #103 @kn0wl3dge
  • extractor: add characteristic "call $+5" feature #366 @kn0wl3dge

New Rules (1)

Bug Fixes

  • remove typing package as a requirement for Python 3.7+ compatibility #901 @uckelman-sf
  • elf: fix OS detection for Linux kernel modules #867 @williballenthin

Raw diffs

v3.1.0 (2022-01-10)

This release improves the performance of capa while also adding 23 new rules and many code quality enhancements. We profiled capa's CPU usage and optimized the way that it matches rules, such as by short circuiting when appropriate. According to our testing, the matching phase is approximately 66% faster than v3.0.3! We also added support for Python 3.10, aarch64 builds, and additional MAEC metadata in the rule headers.

This release adds 23 new rules, including nine by Jakub Jozwiak of Mandiant. @ryantxu1 and @dzbeck updated the ATT&CK and MBC mappings for many rules. Thank you!

And as always, welcome first time contributors!

  • @kn0wl3dge
  • @jtothej
  • @cl30

New Features

  • engine: short circuit logic nodes for better performance #824 @williballenthin
  • engine: add optimizer the order faster nodes first #829 @williballenthin
  • engine: optimize rule evaluation by skipping rules that can't match #830 @williballenthin
  • support python 3.10 #816 @williballenthin
  • support aarch64 #683 @williballenthin
  • rules: support maec/malware-family meta #841 @mr-tz
  • engine: better type annotations/exhaustiveness checking #839 @cl30

Breaking Changes: None

New Rules (23)

Rule Changes

  • update ATT&CK mappings by @ryantxu1
  • update ATT&CK and MBC mappings by @dzbeck
  • aplib detection by @cdong1012
  • golang runtime detection by @stevemk14eber

Bug Fixes

  • fix circular import error #825 @williballenthin
  • fix smda negative number extraction #430 @kn0wl3dge

capa explorer IDA Pro plugin

  • pin supported versions to >= 7.4 and < 8.0 #849 @mike-hunhoff

Development

  • add profiling infrastructure #828 @williballenthin
  • linter: detect shellcode extension #820 @mr-tz
  • show features script: add backend flag #430 @kn0wl3dge

Raw diffs

v3.0.3 (2021-10-27)

This is primarily a rule maintenance release:

  • eight new rules, including all relevant techniques from ATT&CK v10, and
  • two rules removed, due to the prevalence of false positives

We've also tweaked the status codes returned by capa.exe to be more specific and added a bit more metadata to the JSON output format.

As always, welcome first time contributors!

New Features

  • show in which function a BB match is #130 @williballenthin
  • main: exit with unique error codes when bailing #802 @williballenthin

New Rules (8)

Removed rules (2)

  • load-code/pe/parse-pe-exports: too many false positives in unrelated structure accesses
  • anti-analysis/anti-vm/vm-detection/execute-anti-vm-instructions: too many false positives in junk code

Bug Fixes

  • update references from FireEye to Mandiant

Raw diffs

v3.0.2 (2021-09-28)

This release fixes an issue with the standalone executables built with PyInstaller when running capa against ELF files.

Bug Fixes

  • fix bug in PyInstaller config preventing ELF analysis #795 @mr-tz

Raw diffs

v3.0.1 (2021-09-27)

This version updates the version of vivisect used by capa. Users will experience fewer bugs and find improved analysis results.

Thanks to the community for highlighting issues and analysis misses. Your feedback is crucial to further improve capa.

Bug Fixes

  • fix many underlying bugs in vivisect analysis and update to version v1.0.5 #786 @williballenthin

Raw diffs

v3.0.0 (2021-09-15)

We are excited to announce version 3.0! 🎉

capa 3.0:

  • adds support for ELF files targeting Linux thanks to Intezer
  • adds new features to specify OS, CPU architecture, and file format
  • fixes a few bugs that may have led to false negatives (missed capabilities) in older versions
  • adds 80 new rules, including 36 describing techniques for Linux

A huge thanks to everyone who submitted issues, provided feedback, and contributed code and rules. Special acknowledgement to @Adir-Shemesh and @TcM1911 of Intezer for contributing the code to enable ELF support. Also, welcome first time contributors:

  • @jaredscottwilson
  • @cdong1012
  • @jlepore-fe

New Features

  • all: add support for ELF files #700 @Adir-Shemesh @TcM1911
  • rule format: add feature format: for file format, like format: pe #723 @williballenthin
  • rule format: add feature arch: for architecture, like arch: amd64 #723 @williballenthin
  • rule format: add feature os: for operating system, like os: windows #723 @williballenthin
  • rule format: add feature substring: for verbatim strings with leading/trailing wildcards #737 @williballenthin
  • scripts: add profile-memory.py for profiling memory usage #736 @williballenthin
  • main: add light weight ELF file feature extractor to detect file limitations #770 @mr-tz

Breaking Changes

  • rules using format, arch, os, or substring features cannot be used by capa versions prior to v3
  • legacy term arch (i.e., "x32") is now called bitness @williballenthin
  • freeze format gains new section for "global" features #759 @williballenthin

New Rules (80)

Bug Fixes

  • main: fix KeyError: 0 when reporting results @williballehtin #703
  • main: fix potential false negatives due to namespaces across scopes @williballenthin #721
  • linter: suppress some warnings about imports from ntdll/ntoskrnl @williballenthin #743
  • linter: suppress some warnings about missing examples in the nursery @williballenthin #747

capa explorer IDA Pro plugin

  • explorer: add additional filter logic when displaying matches by function #686 @mike-hunhoff
  • explorer: remove duplicate check when saving file #687 @mike-hunhoff
  • explorer: update IDA extractor to use non-canon mnemonics #688 @mike-hunhoff
  • explorer: allow user to add specified number of bytes when adding a Bytes feature in the Rule Generator #689 @mike-hunhoff
  • explorer: enforce max column width Features and Editor panes #691 @mike-hunhoff
  • explorer: add option to limit features to currently selected disassembly address #692 @mike-hunhoff
  • explorer: update support documentation and runtime checks #741 @mike-hunhoff
  • explorer: small performance boost to rule generator search functionality #742 @mike-hunhoff
  • explorer: add support for arch, os, and format features #758 @mike-hunhoff
  • explorer: improve parsing algorithm for rule generator feature editor #768 @mike-hunhoff

Development

Raw diffs

v2.0.0 (2021-07-19)

We are excited to announce version 2.0! 🎉 capa 2.0:

  • enables anyone to contribute rules more easily
  • is the first Python 3 ONLY version
  • provides more concise and relevant result via identification of library functions using FLIRT capa v2.0 results ignoring library code functions
  • includes many features and enhancements for the capa explorer IDA plugin
  • adds 93 new rules, including all new techniques introduced in MITRE ATT&CK v9

A huge thanks to everyone who submitted issues, provided feedback, and contributed code and rules. Many colleagues across dozens of organizations have volunteered their experience to improve this tool! ❤️

New Features

  • rules: update ATT&CK and MBC mappings mandiant/capa-rules#317 @williballenthin
  • main: use FLIRT signatures to identify and ignore library code #446 @williballenthin
  • tests: update test cases and caching #545 @mr-tz
  • scripts: capa2yara.py convert capa rules to YARA rules #561 @ruppde
  • rule: add file-scope feature (function-name) for recognized library functions #567 @williballenthin
  • main: auto detect shellcode based on file extension #516 @mr-tz
  • main: more detailed progress bar output when matching functions #562 @mr-tz
  • main: detect file limitations without doing code analysis for better performance #583 @williballenthin
  • show-features: don't show features from library functions #569 @williballenthin
  • linter: summarize results at the end #571 @williballenthin
  • linter: check for or with always true child statement, e.g. optional, colors #348 @mr-tz

Breaking Changes

  • py3: drop Python 2 support #480 @Ana06
  • meta: added library_functions field, feature_counts.functions does not include library functions any more #562 @mr-tz
  • json: results document now contains parsed ATT&CK and MBC fields instead of canonical representation #526 @mr-tz
  • json: record all matching strings for regex #159 @williballenthin
  • main: implement file limitations via rules not code #390 @williballenthin
  • json: correctly render negative offsets #619 @williballenthin
  • library: remove logic from __init__.py throughout #622 @williballenthin

New Rules (93)

  • anti-analysis/packer/amber/packed-with-amber @gormaniac
  • collection/file-managers/gather-3d-ftp-information @re-fox
  • collection/file-managers/gather-alftp-information @re-fox
  • collection/file-managers/gather-bitkinex-information @re-fox
  • collection/file-managers/gather-blazeftp-information @re-fox
  • collection/file-managers/gather-bulletproof-ftp-information @re-fox
  • collection/file-managers/gather-classicftp-information @re-fox
  • collection/file-managers/gather-coreftp-information @re-fox
  • collection/file-managers/gather-cuteftp-information @re-fox
  • collection/file-managers/gather-cyberduck-information @re-fox
  • collection/file-managers/gather-direct-ftp-information @re-fox
  • collection/file-managers/gather-directory-opus-information @re-fox
  • collection/file-managers/gather-expandrive-information @re-fox
  • collection/file-managers/gather-faststone-browser-information @re-fox
  • collection/file-managers/gather-fasttrack-ftp-information @re-fox
  • collection/file-managers/gather-ffftp-information @re-fox
  • collection/file-managers/gather-filezilla-information @re-fox
  • collection/file-managers/gather-flashfxp-information @re-fox
  • collection/file-managers/gather-fling-ftp-information @re-fox
  • collection/file-managers/gather-freshftp-information @re-fox
  • collection/file-managers/gather-frigate3-information @re-fox
  • collection/file-managers/gather-ftp-commander-information @re-fox
  • collection/file-managers/gather-ftp-explorer-information @re-fox
  • collection/file-managers/gather-ftp-voyager-information @re-fox
  • collection/file-managers/gather-ftpgetter-information @re-fox
  • collection/file-managers/gather-ftpinfo-information @re-fox
  • collection/file-managers/gather-ftpnow-information @re-fox
  • collection/file-managers/gather-ftprush-information @re-fox
  • collection/file-managers/gather-ftpshell-information @re-fox
  • collection/file-managers/gather-global-downloader-information @re-fox
  • collection/file-managers/gather-goftp-information @re-fox
  • collection/file-managers/gather-leapftp-information @re-fox
  • collection/file-managers/gather-netdrive-information @re-fox
  • collection/file-managers/gather-nexusfile-information @re-fox
  • collection/file-managers/gather-nova-ftp-information @re-fox
  • collection/file-managers/gather-robo-ftp-information @re-fox
  • collection/file-managers/gather-securefx-information @re-fox
  • collection/file-managers/gather-smart-ftp-information @re-fox
  • collection/file-managers/gather-softx-ftp-information @re-fox
  • collection/file-managers/gather-southriver-webdrive-information @re-fox
  • collection/file-managers/gather-staff-ftp-information @re-fox
  • collection/file-managers/gather-total-commander-information @re-fox
  • collection/file-managers/gather-turbo-ftp-information @re-fox
  • collection/file-managers/gather-ultrafxp-information @re-fox
  • collection/file-managers/gather-winscp-information @re-fox
  • collection/file-managers/gather-winzip-information @re-fox
  • collection/file-managers/gather-wise-ftp-information @re-fox
  • collection/file-managers/gather-ws-ftp-information @re-fox
  • collection/file-managers/gather-xftp-information @re-fox
  • data-manipulation/compression/decompress-data-using-aplib @r3c0nst @mr-tz
  • host-interaction/bootloader/disable-code-signing @williballenthin
  • host-interaction/bootloader/manipulate-boot-configuration @williballenthin
  • host-interaction/driver/disable-driver-code-integrity @williballenthin
  • host-interaction/file-system/bypass-mark-of-the-web @williballenthin
  • host-interaction/network/domain/get-domain-information @recvfrom
  • host-interaction/session/get-logon-sessions @recvfrom
  • linking/runtime-linking/resolve-function-by-fin8-fasthash @r3c0nst @mr-tz
  • nursery/build-docker-image @williballenthin
  • nursery/create-container @williballenthin
  • nursery/encrypt-data-using-fakem-cipher @mike-hunhoff
  • nursery/list-containers @williballenthin
  • nursery/run-in-container @williballenthin
  • persistence/registry/appinitdlls/disable-appinit_dlls-code-signature-enforcement @williballenthin
  • collection/password-manager/steal-keepass-passwords-using-keefarce @Ana06
  • host-interaction/network/connectivity/check-internet-connectivity-via-wininet [email protected] [email protected]
  • nursery/create-bits-job @mr-tz
  • nursery/execute-syscall-instruction @kulinacs @mr-tz
  • nursery/connect-to-wmi-namespace-via-wbemlocator [email protected]
  • anti-analysis/obfuscation/obfuscated-with-callobfuscator johnk3r
  • executable/installer/inno-setup/packaged-as-an-inno-setup-installer [email protected]
  • data-manipulation/hashing/djb2/hash-data-using-djb2 [email protected]
  • data-manipulation/encoding/base64/decode-data-using-base64-via-dword-translation-table [email protected]
  • nursery/list-tcp-connections-and-listeners [email protected]
  • nursery/list-udp-connections-and-listeners [email protected]
  • nursery/log-keystrokes-via-raw-input-data [email protected]
  • nursery/register-http-server-url [email protected]
  • internal/limitation/file/internal-autoit-file-limitation.yml [email protected]
  • internal/limitation/file/internal-dotnet-file-limitation.yml [email protected]
  • internal/limitation/file/internal-installer-file-limitation.yml [email protected]
  • internal/limitation/file/internal-packer-file-limitation.yml [email protected]
  • host-interaction/network/domain/enumerate-domain-computers-via-ldap [email protected]
  • host-interaction/network/domain/get-domain-controller-name [email protected]
  • internal/limitation/file/internal-visual-basic-file-limitation @mr-tz
  • data-manipulation/hashing/md5/hash-data-with-md5 [email protected]
  • compiler/autohotkey/compiled-with-autohotkey [email protected]
  • internal/limitation/file/internal-autohotkey-file-limitation @mr-tz
  • host-interaction/process/dump/create-process-memory-minidump [email protected]
  • nursery/get-storage-device-properties [email protected]
  • nursery/execute-shell-command-via-windows-remote-management [email protected]
  • nursery/get-token-privileges [email protected]
  • nursery/prompt-user-for-credentials [email protected]
  • nursery/spoof-parent-pid [email protected]

Bug Fixes

  • build: use Python 3.8 for PyInstaller to support consistently running across multiple operating systems including Windows 7 #505 @mr-tz
  • main: correctly match BB-scope matches at file scope #605 @williballenthin
  • main: do not process non-PE files even when --format explicitly provided #664 @mr-tz

capa explorer IDA Pro plugin

  • explorer: IDA 7.6 support #497 @williballenthin
  • explorer: explain how to install IDA 7.6 patch to enable the plugin #528 @williballenthin
  • explorer: document IDA 7.6sp1 as alternative to the patch #536 @Ana06
  • explorer: add support for function-name feature #618 @mike-hunhoff
  • explorer: circular import workaround #654 @mike-hunhoff
  • explorer: add argument to control whether to automatically analyze when running capa explorer #548 @Ana06
  • explorer: extract API features via function names recognized by IDA/FLIRT #661 @mr-tz

Development

  • ci: add capa release link to capa-rules tag #517 @Ana06
  • ci, changelog: update New Rules section in CHANGELOG automatically mandiant/capa-rules#374 #549 #604 @Ana06
  • ci, changelog: support multiple author in sync GH mandiant/capa-rules#378 @Ana06
  • ci, lint: check statements for single child statements #563 @mr-tz
  • ci: reject PRs without CHANGELOG update to ensure CHANGELOG is kept up-to-date #584 @Ana06
  • ci: test that scripts run #660 @mr-tz

Raw diffs

v1.6.3 (2021-04-29)

This release adds IDA 7.6 support to capa.

Changes

  • IDA 7.6 support @williballenthin @Ana06

Raw diffs

v1.6.2 (2021-04-13)

This release backports a fix to capa 1.6: The Windows binary was built with Python 3.9 which doesn't support Windows 7.

Bug Fixes

  • build: use Python 3.8 for PyInstaller to support consistently running across multiple operating systems including Windows 7 @mr-tz @Ana06

Raw diffs

v1.6.1 (2021-04-07)

This release includes several bug fixes, such as a vivisect issue that prevented capa from working on Windows with Python 3. It also adds 17 new rules and a bunch of improvements in the rules and IDA rule generator. We appreciate everyone who opened issues, provided feedback, and contributed code and rules.

Upcoming changes

This is the very last capa release that supports Python 2. The next release will be v2.0 and will have breaking changes, including the removal of Python 2 support.

New features

  • explorer: add support for multi-line tab and SHIFT + Tab #474 @mike-hunhoff

multi-line tab in rule generator

New Rules (17)

  • encrypt data using RC4 with custom key via WinAPI @MalwareMechanic
  • encrypt data using Curve25519 @dandonov
  • packaged as an IExpress self-extracting archive @recvfrom
  • create registry key via offline registry library @johnk3r
  • open registry key via offline registry library @johnk3r
  • query registry key via offline registry library @johnk3r
  • set registry key via offline registry library @johnk3r
  • delete registry key via offline registry library @johnk3r
  • enumerate PE sections @Ana06
  • inject DLL reflectively @Ana06
  • inspect section memory permissions @Ana06
  • parse PE exports @Ana06
  • rebuild import table @Ana06
  • compare security identifiers @mike-hunhoff
  • get user security identifier @mike-hunhoff
  • listen for remote procedure calls @mike-hunhoff
  • query remote server for available data @mike-hunhoff

Bug Fixes

  • vivisect: update to v1.0.1 which includes bug fix for #459 (capa failed in Windows with Python 3 and vivisect) #512 @williballenthin
  • explorer: fix initialize rules directory #464 @mike-hunhoff
  • explorer: support subscope rules #493 @mike-hunhoff
  • explorer: add checks to validate matched data when searching #500 @mike-hunhoff
  • features, explorer: add support for string features with special characters e.g. '\n' #468 @mike-hunhoff

Changes

  • vivisect: raises IncompatibleVivVersion instead of UnicodeDecodeError when using incompatible Python 2 .viv files with Python3 #479 @Ana06
  • explorer: improve settings modification #465 @mike-hunhoff
  • rules: improvements @mr-tz, @re-fox, @mike-hunhoff
  • rules, lint: enforce string with double quotes formatting in rules #468 @mike-hunhoff
  • lint: ensure LF end of line #485 #486 @mr-tz
  • setup: pin dependencies #513 #504 @Ana06 @mr-tz

Development

  • ci: test on Windows, Ubuntu, macOS across Python versions #470 @mr-tz @Ana06
  • ci: pin OS versions #491 @williballenthin
  • ci: tag capa-rules on release #476 @Ana06
  • doc: document release process #476 @Ana06
  • doc: Improve README badges #477 #478 @ana06 @mr-tz
  • doc: update capa explorer documentation #503 @mike-hunhoff
  • doc: add PR template #495 @mr-tz
  • changelog: document incompatibility of viv files #475 @Ana06
  • rule loading: ignore files starting with .git #492 @mr-tz

Raw diffs

v1.6.0 (2021-03-09)

This release adds the capa explorer rule generator plugin for IDA Pro, vivisect support for Python 3 and 12 new rules. We appreciate everyone who opened issues, provided feedback, and contributed code and rules. Thank you also to the vivisect development team (@rakuy0, @atlas0fd00m) for the Python 3 support (vivisect==1.0.0) and the fixes for Python 2 (vivisect==0.2.1).

Rule Generator IDA Plugin

The capa explorer IDA plugin now helps you quickly build new capa rules using features extracted directly from your IDA database. Without leaving the plugin interface you can use the features extracted by capa explorer to develop and test new rules and save your work directly to your capa rules directory. To get started select the new Rule Generator tab, navigate to a function in the IDA Disassembly view, and click Analyze. For more information check out the capa explorer readme.

Python 2/3 vivisect workspace compatibility

This version of capa adds Python 3 support in vivisect. Note that .viv files (generated by vivisect) are not compatible between Python 2 and Python 3. When updating to Python 3 you need to delete all the .viv files for capa to work.

If you get the following error (or a similar one), you most likely need to delete .viv files:

UnicodeDecodeError: 'ascii' codec can't decode byte 0x90 in position 2: ordinal not in range(128)

Upcoming changes

This is the last capa release that supports Python 2. The next release will be v2.0 and will have breaking changes, including the removal of Python 2 support.

If you have workflows that rely on the Python 2 version and need future maintenance, please reach out. We may be able to supply limited backports of key fixes and features.

New features

  • explorer: Add capa explorer rule generator plugin for IDA Pro. Now capa explorer helps you build new capa rules! #426, #438, #439 @mike-hunhoff
  • python: Python 3 support in vivisect #421 @Ana06
  • main: Add backend option in Python 3 to select the backend to be used (either SMDA or vivisect) #421 @Ana06
  • python: Python 3 support in IDA #429, #437 @mike-hunhoff
  • ci: test pyinstaller CI #452 @williballenthin
  • scripts: enable multiple backends in show-features.py #429 @mike-hunhoff
  • scripts: add scripts/vivisect-py2-vs-py3.sh to compare vivisect Python 2 vs 3 (can easily be modified to test run times and compare different versions) #421 @Ana06

New Rules (12)

  • patch process command line @re-fox @williballenthin (graduated from nursery)
  • compiled with dmd @re-fox
  • compiled with exe4j @johnk3r
  • compiled from Visual Basic @williballenthin
  • capture screenshot in Go @TcM1911
  • compiled with Nim @mike-hunhoff
  • linked against Go process enumeration library @TcM1911
  • linked against Go registry library @TcM1911
  • linked against Go WMI library @TcM1911
  • linked against Go static asset library @TcM1911
  • inspect load icon resource @mike-hunhoff
  • linked against XZip @mr-tz

Bug Fixes

  • ida: check for unmapped addresses when resolving data references #436 @mike-hunhoff

Changes

  • setup: vivisect v1.0.0 is the default backend for Python3 (it was SMDA before) #421 @Ana06
  • setup: bump vivisect to 0.2.1 #454 @mr-tz
  • linter: adding ntoskrnl, ntdll overlap lint #428 @mike-hunhoff
  • ci: use py3.9 and pyinstaller 4.2 to build standalone binaries #452 @williballenthin
  • scripts: remove old migration script #450 @williballenthin

Development

  • main: factor out common cli argument handling #450 @williballenthin

Raw diffs

v1.5.1 (2021-02-09)

This release fixes the version number that we forgot to update for v1.5.0 (therefore, v1.5.0 was not published to pypi). It also includes 1 new rule and some rule improvements.

New Rules (1)

  • encrypt data using vest @re-fox

Raw diffs

v1.5.0 (2021-02-05)

This release brings support for running capa under Python 3 via SMDA, more thorough CI testing and linting, better extraction of strings and byte features, and 50 (!) new rules. We appreciate everyone who opened issues, provided feedback, and contributed code and rules. A special shout out to the following new project contributors:

  • @johnk3r
  • @doomedraven
  • @stvemillertime
  • @itreallynick
  • @0x534a

@dzbeck also added Malware Behavior Catalog (MBC) and ATT&CK mappings for many rules.

Download a standalone binary below and checkout the readme here on GitHub. Report issues on our issue tracker and contribute new rules at capa-rules.

New Features

  • py3 support via SMDA #355 @danielplohmann @jcrussell
  • scripts: example of using capa as a library #372, #380 @doomedraven
  • ci: enable dependabot #373 @mr-tz
  • ci: lint rules @mr-tz
  • ci: lint rule format #401 @mr-tz
  • freeze: add base address #391 @mr-tz
  • json: meta: add base address #412 @mr-tz

New Rules (50)

  • 64-bit execution via heavens gate @recvfrom
  • contain anti-disasm techniques @mr-tz
  • check for microsoft office emulation @re-fox
  • check for windows sandbox via device @re-fox
  • check for windows sandbox via dns suffix @re-fox
  • check for windows sandbox via genuine state @re-fox
  • check for windows sandbox via process name @re-fox
  • check for windows sandbox via registry @re-fox
  • capture microphone audio @re-fox
  • capture public ip @re-fox
  • get domain trust relationships @johnk3r
  • check HTTP status code @mr-tz
  • compiled with perl2exe @re-fox
  • compiled with ps2exe @re-fox
  • compiled with pyarmor @stvemillertime, @itreallynick
  • validate payment card number using luhn algorithm @re-fox
  • hash data using fnv @re-fox @mr-tz
  • generate random numbers via WinAPI @mike-hunhoff @johnk3r
  • enumerate files recursively @re-fox
  • get file system object information @mike-hunhoff
  • read virtual disk @re-fox
  • register minifilter driver @mike-hunhoff
  • start minifilter driver @mike-hunhoff
  • enumerate gui resources @johnk3r
  • simulate CTRL ALT DEL @mike-hunhoff
  • hijack thread execution @0x534a
  • inject dll @0x534a
  • inject pe @0x534a
  • create or open registry key @mike-hunhoff
  • delete registry value @mike-hunhoff
  • query or enumerate registry key @mike-hunhoff
  • query or enumerate registry value @mike-hunhoff
  • resume thread @0x534a
  • suspend thread @0x534a
  • allocate memory @0x534a
  • allocate RW memory @0x534a
  • contain pusha popa sequence @mr-tz
  • create or open file @mike-hunhoff
  • open process @0x534a
  • open thread @0x534a
  • get kernel32 base address @mr-tz
  • get ntdll base address @mr-tz
  • encrypt or decrypt data via BCrypt @mike-hunhoff
  • generate random numbers using the Delphi LCG @williballenthin
  • hash data via BCrypt @mike-hunhoff
  • migrate process to active window station @williballenthin
  • patch process command line @williballenthin
  • resolve function by hash @williballenthin
  • persist via Winlogon Helper DLL registry key @0x534a
  • schedule task via command line @0x534a

Bug Fixes

  • doc: pyinstaller build process @mr-tz
  • ida: better bytes extraction #409 @mike-hunhoff
  • viv: better unicode string extraction #364 @mike-hunhoff
  • viv: better unicode string extraction #378 @mr-tz
  • viv: more xor instructions #379 @mr-tz
  • viv: decrease logging verbosity #381 @mr-tz
  • rules: fix api description syntax #403 @mike-hunhoff
  • main: disable progress background thread #410 @mike-hunhoff

Changes

  • rules: return lib rules for scopes #398 @mr-tz

Raw diffs

v1.4.1 (2020-10-23)

This release fixes an issue building capa on our CI server, which prevented us from building standalone binaries for v1.4.1.

Bug Fixes

  • install VC dependencies for Python 2.7 during Windows build

Raw diffs

v1.4.0 (2020-10-23)

This capa release includes changes to the rule parsing, enhanced feature extraction, various bug fixes, and improved capa scripts. Everyone should benefit from the improved functionality and performance. The community helped to add 69 new rules. We appreciate everyone who opened issues, provided feedback, and contributed code and rules. A special shout out to the following new project contributors:

  • @mwilliams31
  • @yt0ng

@dzbeck added Malware Behavior Catalog (MBC) and ATT&CK mappings for 86 rules.

Download a standalone binary below and checkout the readme here on GitHub. Report issues on our issue tracker and contribute new rules at capa-rules.

New features

  • script that demonstrates bulk processing @williballenthin #307
  • main: render MBC table @mr-tz #332
  • ida backend: improve detection of APIs called via two or more chained thunks @mike-hunhoff #340
  • viv backend: improve detection of APIs called via two or more chained thunks @mr-tz #341
  • features: extract APIs called via jmp instruction @mr-tz #337

New rules

  • clear the Windows event log @mike-hunhoff
  • crash the Windows event logging service @mike-hunhoff
  • packed with kkrunchy @re-fox
  • packed with nspack @re-fox
  • packed with pebundle @re-fox
  • packed with pelocknt @re-fox
  • packed with peshield @re-fox
  • packed with petite @re-fox
  • packed with rlpack @re-fox
  • packed with upack @re-fox
  • packed with y0da crypter @re-fox
  • compiled with rust @re-fox
  • compute adler32 checksum @mwilliams31
  • encrypt-data-using-hc-128 @recvfrom
  • manipulate console @williballenthin
  • references logon banner @re-fox
  • terminate process via fastfail @re-fox
  • delete volume shadow copies @mr-tz
  • authenticate HMAC @mr-tz
  • compiled from EPL @williballenthin
  • compiled with Go @williballenthin
  • create Restart Manager session @mike-hunhoff
  • decode data using Base64 via WinAPI @mike-hunhoff
  • empty recycle bin quietly @mwilliams31
  • enumerate network shares @mike-hunhoff
  • hook routines via microsoft detours @williballenthin
  • hooked by API Override @williballenthin
  • impersonate user @mike-hunhoff
  • the @williballenthin packer detection package, thanks to Hexacorn for the data, see https://www.hexacorn.com/blog/2016/12/15/pe-section-names-re-visited/
    • packed with CCG
    • packed with Crunch
    • packed with Dragon Armor
    • packed with enigma
    • packed with Epack
    • packed with MaskPE
    • packed with MEW
    • packed with Mpress
    • packed with Neolite
    • packed with PECompact
    • packed with Pepack
    • packed with Perplex
    • packed with ProCrypt
    • packed with RPCrypt
    • packed with SeauSFX
    • packed with Shrinker
    • packed with Simple Pack
    • packed with StarForce
    • packed with SVKP
    • packed with Themida
    • packed with TSULoader
    • packed with VProtect
    • packed with WWPACK
    • rebuilt by ImpRec
    • packaged as a Pintool
    • packaged as a CreateInstall installer
    • packaged as a WinZip self-extracting archive
  • reference 114DNS DNS server @williballenthin
  • reference AliDNS DNS server @williballenthin
  • reference Cloudflare DNS server @williballenthin
  • reference Comodo Secure DNS server @williballenthin
  • reference Google Public DNS server @williballenthin
  • reference Hurricane Electric DNS server @williballenthin
  • reference kornet DNS server @williballenthin
  • reference L3 DNS server @williballenthin
  • reference OpenDNS DNS server @williballenthin
  • reference Quad9 DNS server @williballenthin
  • reference Verisign DNS server @williballenthin
  • run as service @mike-hunhoff
  • schedule task via ITaskService @mike-hunhoff
  • references DNS over HTTPS endpoints @yt0ng

Bug fixes

  • ida plugin: fix tree-view exception @mike-hunhoff #315
  • ida plugin: fix feature count @mike-hunhoff
  • main: fix reported total rule count @williballenthin #325
  • features: fix handling of API names with multiple periods @mike-hunhoff #329
  • ida backend: find all byte sequences instead of only first @mike-hunhoff #335
  • features: display 0 value @mr-tz #338
  • ida backend: extract ordinal and name imports @mr-tz #343
  • show-features: improvements and support within IDA @mr-tz #342
  • main: sanity check MBC rendering @williballenthin
  • main: handle sample path that contains non-ASCII characters @mr-tz #328

Changes

  • rules: use yaml.CLoader for better performance @williballenthin #306
  • rules: parse descriptions for statements @mr-tz #312

Raw diffs

v1.3.0 (2020-09-14)

This release brings newly updated mappings to the Malware Behavior Catalog version 2.0, many enhancements to the IDA Pro plugin, flare-capa on PyPI, a bunch of bug fixes to improve feature extraction, and four new rules. We received contributions from ten reverse engineers, including seven new ones:

  • @dzbeck
  • @recvfrom
  • @toomanybananas
  • @cclauss
  • @adamprescott91
  • @weslambert
  • @stevemk14ebr

Download a standalone binary below and checkout the readme here on GitHub. Report issues on our issue tracker and contribute new rules at capa-rules.

Key changes to IDA Plugin

The IDA Pro integration is now distributed as a real plugin, instead of a script. This enables a few things:

  • keyboard shortcuts and file menu integration
  • updates distributed PyPI/pip install --upgrade without touching your %IDADIR%
  • generally doing thing the "right way"

How to get this new version? It's easy: download capa_explorer.py to your IDA plugins directory and update your capa installation (incidentally, this is a good opportunity to migrate to pip install flare-capa instead of git checkouts). Now you should see the plugin listed in the Edit > Plugins > FLARE capa explorer menu in IDA.

Please refer to the plugin readme for additional information on installing and using the IDA Pro plugin.

Please open an issue in this repository if you notice anything weird.

New features

  • ida plugin: now a real plugin, not a script @mike-hunhoff
  • core: distributed via PyPI as flare-capa @williballenthin
  • features: enable automatic A/W handling for imports @williballenthin @Ana06 #246
  • ida plugin: persist rules directory setting via ida-settings @williballenthin #268
  • ida plugin: add search bar to results view @williballenthin #285
  • ida plugin: add Analyze and Reset buttons to tree view @mike-hunhoff #304
  • ida plugin: add status label to tree view @mike-hunhoff
  • ida plugin: add progress indicator @mike-hunhoff, @mr-tz

New rules

  • compiled with py2exe @re-fox
  • resolve path using msvcrt @re-fox
  • decompress data using QuickLZ @edeca
  • encrypt data using sosemanuk @recvfrom

Bug fixes

  • rule: reduce FP in DNS resolution @toomanybananas
  • engine: report correct strings matched via regex @williballenthin #262
  • formatter: correctly format descriptions in two-line syntax @williballenthin @recvfrom #263
  • viv: better extract offsets from SibOper operands @williballenthin @edeca #276
  • import-to-ida: fix import error @cclauss
  • viv: don't write settings to ~/.viv/viv.json @williballenthin @rakuy0 @weslambert #244
  • ida plugin: remove dependency loop that resulted in unnecessary overhead @mike-hunhoff #303
  • ida plugin: correctly highlight regex matches in IDA Disassembly view @mike-hunhoff #305
  • ida plugin: better handle rule directory prompt and failure case @stevemk14ebr @mike-hunhoff #309

Changes

  • rules: update meta mapping to MBC 2.0! @dzbeck
  • render: don't display rules that are also matched by other rules @williballenthin @Ana06 #224
  • ida plugin: simplify tabs, removing summary and adding detail to results view @williballenthin #286
  • ida plugin: analysis is no longer automatically started when plugin is first opened @mike-hunhoff #304
  • ida plugin: user must manually select a capa rules directory before analysis can be performed @mike-hunhoff
  • ida plugin: user interface controls are disabled until analysis is performed @mike-hunhoff #304

Raw diffs

v1.2.0 (2020-08-31)

This release brings UI enhancements, especially for the IDA Pro plugin, investment towards py3 support, fixes some bugs identified by the community, and 46 (!) new rules. We received contributions from ten reverse engineers, including five new ones:

  • @agithubuserlol
  • @recvfrom
  • @D4nch3n
  • @edeca
  • @winniepe

Download a standalone binary below and checkout the readme here on GitHub. Report issues on our issue tracker and contribute new rules at capa-rules.

New features

  • ida plugin: display arch flavors @mike-hunhoff
  • ida plugin: display block descriptions @mike-hunhoff
  • ida backend: extract features from nested pointers @mike-hunhoff
  • main: show more progress output @williballenthin
  • core: pin dependency versions #258 @recvfrom

New rules

  • bypass UAC via AppInfo ALPC @agithubuserlol
  • bypass UAC via token manipulation @agithubuserlol
  • check for sandbox and av modules @re-fox
  • check for sandbox username @re-fox
  • check if process is running under wine @re-fox
  • validate credit card number using luhn algorithm @re-fox
  • validate credit card number using luhn algorithm with no lookup table @re-fox
  • hash data using FNV @edeca @mr-tz
  • link many functions at runtime @mr-tz
  • reference public RSA key @mr-tz
  • packed with ASPack @williballenthin
  • delete internet cache @mike-hunhoff
  • enumerate internet cache @mike-hunhoff
  • send ICMP echo request @mike-hunhoff
  • check for debugger via API @mike-hunhoff
  • check for hardware breakpoints @mike-hunhoff
  • check for kernel debugger via shared user data structure @mike-hunhoff
  • check for protected handle exception @mike-hunhoff
  • check for software breakpoints @mike-hunhoff
  • check for trap flag exception @mike-hunhoff
  • check for unexpected memory writes @mike-hunhoff
  • check process job object @mike-hunhoff
  • reference anti-VM strings targeting Parallels @mike-hunhoff
  • reference anti-VM strings targeting Qemu @mike-hunhoff
  • reference anti-VM strings targeting VirtualBox @mike-hunhoff
  • reference anti-VM strings targeting VirtualPC @mike-hunhoff
  • reference anti-VM strings targeting VMWare @mike-hunhoff
  • reference anti-VM strings targeting Xen @mike-hunhoff
  • reference analysis tools strings @mike-hunhoff
  • reference WMI statements @mike-hunhoff
  • get number of processor cores @mike-hunhoff
  • get number of processors @mike-hunhoff
  • enumerate disk properties @mike-hunhoff
  • get disk size @mike-hunhoff
  • get process heap flags @mike-hunhoff
  • get process heap force flags @mike-hunhoff
  • get Explorer PID @mike-hunhoff
  • delay execution @mike-hunhoff
  • check for process debug object @mike-hunhoff
  • check license value @mike-hunhoff
  • check ProcessDebugFlags @mike-hunhoff
  • check ProcessDebugPort @mike-hunhoff
  • check SystemKernelDebuggerInformation @mike-hunhoff
  • check thread yield allowed @mike-hunhoff
  • enumerate system firmware tables @mike-hunhoff
  • get system firmware table @mike-hunhoff
  • hide thread from debugger @mike-hunhoff

Bug fixes

  • ida backend: extract unmapped immediate number features @mike-hunhoff
  • ida backend: fix stack cookie check #257 @mike-hunhoff
  • viv backend: better extract gs segment access @williballenthin
  • core: enable counting of string features #241 @D4nch3n @williballenthin
  • core: enable descriptions on feature with arch flavors @mike-hunhoff
  • core: update git links for non-SSH access #259 @recvfrom

Changes

  • ida plugin: better default display showing first level nesting @winniepe
  • remove unused characteristic(switch) feature @ana06
  • prepare testing infrastructure for multiple backends/py3 @williballenthin
  • ci: zip build artifacts @ana06
  • ci: build all supported python versions @ana06
  • code style and formatting @mr-tz

Raw diffs

v1.1.0 (2020-08-05)

This release brings new rule format updates, such as adding offset/x32 and negative offsets, fixes some bugs identified by the community, and 28 (!) new rules. We received contributions from eight reverse engineers, including four new ones:

  • @re-fox
  • @psifertex
  • @bitsofbinary
  • @threathive

Download a standalone binary below and checkout the readme here on GitHub. Report issues on our issue tracker and contribute new rules at capa-rules.

New features

  • import: add Binary Ninja import script #205 #207 @psifertex
  • rules: offsets can be negative #197 #208 @williballenthin
  • rules: enable descriptions for statement nodes #194 #209 @Ana06
  • rules: add arch flavors to number and offset features #210 #216 @williballenthin
  • render: show SHA1/SHA256 in default report #164 @threathive
  • tests: add tests for IDA Pro backend #202 @williballenthin

New rules

  • check for unmoving mouse cursor @BitsOfBinary
  • check mutex and exit @re-fox
  • parse credit card information @re-fox
  • read ini file @re-fox
  • validate credit card number with luhn algorithm @re-fox
  • change the wallpaper @re-fox
  • acquire debug privileges @williballenthin
  • import public key @williballenthin
  • terminate process by name @williballenthin
  • encrypt data using DES @re-fox
  • encrypt data using DES via WinAPI @re-fox
  • hash data using sha1 via x86 extensions @re-fox
  • hash data using sha256 via x86 extensions @re-fox
  • capture network configuration via ipconfig @re-fox
  • hash data via WinCrypt @mike-hunhoff
  • get file attributes @mike-hunhoff
  • allocate thread local storage @mike-hunhoff
  • get thread local storage value @mike-hunhoff
  • set thread local storage @mike-hunhoff
  • get session integrity level @mike-hunhoff
  • add file to cabinet file @mike-hunhoff
  • flush cabinet file @mike-hunhoff
  • open cabinet file @mike-hunhoff
  • gather firefox profile information @re-fox
  • encrypt data using skipjack @re-fox
  • encrypt data using camellia @re-fox
  • hash data using tiger @re-fox
  • encrypt data using blowfish @re-fox
  • encrypt data using twofish @re-fox

Bug fixes

  • linter: fix exception when examples is None @Ana06
  • linter: fix suggested recommendations via templating @williballenthin
  • render: fix exception when rendering counts @williballenthin
  • render: fix render of negative offsets @williballenthin
  • extractor: fix segmentation violation from vivisect @williballenthin
  • main: fix crash when .viv cannot be saved #168 @secshoggoth @williballenthin
  • main: fix shellcode .viv save path @williballenthin

Changes

  • doc: explain how to bypass gatekeeper on macOS @psifertex
  • doc: explain supported linux distributions @Ana06
  • doc: explain submodule update with --init @psifertex
  • main: improve program help output @mr-tz
  • main: disable progress when run in quiet mode @mr-tz
  • main: assert supported IDA versions @mr-tz
  • extractor: better identify nested pointers to strings @williballenthin
  • setup: specify vivisect download url @Ana06
  • setup: pin vivisect version @williballenthin
  • setup: bump vivisect dependency version @williballenthin
  • setup: set Python project name to flare-capa @williballenthin
  • ci: run tests and linter via GitHub Actions @Ana06
  • hooks: run style checkers and hide stashed output @Ana06
  • linter: ignore period in rule filename @williballenthin
  • linter: warn on nursery rule with no changes needed @williballenthin

Raw diffs