Skip to main content

A plugin for IDA Pro to generate Yara rules from binary files.

Project description

[English] | 繁體中文

YaraForge

YaraForge is an IDA Pro plugin for generating Yara rules from binary files. It utilizes the results of CAPA analysis to automatically generate corresponding Yara rules, helping security researchers and reverse engineers quickly identify and detect malware.

Features

  • Automatically extract key information from CAPA analysis results to generate Yara rules
  • Support exporting detailed CAPA analysis results, including matched rules, addresses, etc.
  • Save the generated Yara rules and related information to local files
  • Provide a user-friendly interface for easy operation and configuration
  • Built-in detailed logging functionality for troubleshooting and debugging

Installation

  1. Install YaraForge using pip:
pip install yaraforge
  1. Copy the yaraforge.py file from the plugin folder to the plugins directory of IDA Pro.
  2. Launch IDA Pro, and the YaraForge plugin will be loaded automatically.

Usage

  1. Open the target binary file in IDA Pro.
  2. Run CAPA analysis to ensure that the analysis results are generated.
  3. Use the Ctrl+Y shortcut or choose "Edit" -> "Plugins" -> "YaraForge" from the menu bar in IDA Pro to launch the plugin.
  4. The plugin will automatically extract information from the CAPA analysis results and generate corresponding Yara rules.
  5. The generated Yara rules and related information are saved by default in the %APPDATA%\Hex-Rays\IDA Pro\plugins\yaraforge\ folder.
  6. If you need to export the analysis results to the desktop, you can select the "Dump Caches on desktop" option in the plugin interface.

Notes

  • The YaraForge plugin relies on CAPA for analysis. When installing the plugin, CAPA will be automatically downloaded and installed, without the need for manual installation.
  • The Yara rules generated by the plugin are for reference only and may need to be adjusted and optimized according to actual situations.
  • Some functions of the plugin depend on the IDA Pro API, and there may be compatibility issues with different versions of IDA Pro. If you encounter any problems, please refer to the plugin's error logs and related documentation, or report them to us.

Authors

Version Requirements

  • Python: >=3.8, <3.12
  • CAPA: 7.0.1
  • IDA Pro: >=7.0

License

  • The YaraForge plugin is licensed under the MIT License. For more details, please refer to the LICENSE file.

Acknowledgments

The development of the YaraForge plugin has received help and inspiration from many open-source projects and communities. We would like to express our gratitude to:

Contact Us

If you encounter any issues while using the YaraForge plugin or have any suggestions and feedback, please feel free to contact us through the following channels:

Thank you for your support and attention! We hope that YaraForge can become a powerful assistant for your binary analysis and Yara rule generation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

YaraForge-0.1.11b1.tar.gz (848.4 kB view details)

Uploaded Source

Built Distribution

YaraForge-0.1.11b1-py3-none-any.whl (955.5 kB view details)

Uploaded Python 3

File details

Details for the file YaraForge-0.1.11b1.tar.gz.

File metadata

  • Download URL: YaraForge-0.1.11b1.tar.gz
  • Upload date:
  • Size: 848.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.13

File hashes

Hashes for YaraForge-0.1.11b1.tar.gz
Algorithm Hash digest
SHA256 deb4a157151c1086ed1e5840f7a1b4923234852d6b7b7316644de8493aba1fcf
MD5 68b76023a7c1d8eaf1222bbe60fa03dd
BLAKE2b-256 8ff415f0a5b89e69d70cc0e10bd8677ab62994442f707f6ac92d1a8ae0e2137f

See more details on using hashes here.

File details

Details for the file YaraForge-0.1.11b1-py3-none-any.whl.

File metadata

  • Download URL: YaraForge-0.1.11b1-py3-none-any.whl
  • Upload date:
  • Size: 955.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.13

File hashes

Hashes for YaraForge-0.1.11b1-py3-none-any.whl
Algorithm Hash digest
SHA256 458d725cb3bbbcae19b9180611da853e21b21cf6607a18be21692bfb0aed4f27
MD5 cb703b00ef4f25537629b5f1676f2708
BLAKE2b-256 ad1ee6c7f6a6b7e97c681032a37e1009c31af721173e5ed07b82ad9960d9725e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page