xbin Standalone CFG Plugin Example

This is a standalone xbin plugin designed to be developed and managed in its own repository, independent of the main xbin source tree.

📁 Structure

• cfg_worker.py: The analysis logic. Note that category="cfg_generation" is defined in the @xbin.plugin decorator.
• Dockerfile: Defines the environment. The orchestrator automatically injects the xbin SDK during the build.

🚀 Running this Plugin

You can point the orchestrator directly to this directory:

xbin-orchestrator --plugin [path where plugin is checked out]

Example path can be:

xbin-orchestrator --plugin ~/xbin_external_example

The orchestrator will:

1. Discover: Identify the plugin and its name from the directory.
2. Categorize: Scan cfg_worker.py and place it in the cfg_generation category.
3. Build: Use the local Dockerfile to build a container while injecting the xbin SDK—no manual copying required!

👩‍💻 Development

When writing your own standalone plugin, simply import xbin and use the module-level methods:

import xbin

@xbin.plugin(name="my_tool", category="cfg_generation")
class MyTool:
    def on_new_binary(self, path, goals):
        xbin.post_result(item_key="0x400", data={"nodes":[]}, confidence=1.0)