How to add a custom module to n01d-forge?

[bad-antics]

I want to extend n01d-forge with my own security module. What is the module structure and how do I register it?

[bad-antics]

Adding a custom module to n01d-forge is straightforward:

1. Create Module Directory

modules/your-module/
  __init__.py
  module.py
  config.yml
  README.md

2. Module Template (module.py)

from n01d_forge.core import BaseModule

class YourModule(BaseModule):
    name = 'your-module'
    description = 'What it does'
    version = '1.0.0'
    
    def setup(self):
        # Initialize resources
        pass
    
    def run(self, target):
        # Main logic
        results = []
        # ... your code ...
        return results
    
    def cleanup(self):
        # Release resources
        pass

3. Register in config.yml

name: your-module
enabled: true
priority: 50
dependencies: []

4. Install

n01d-forge module install ./modules/your-module

The module system auto-discovers and loads registered modules. Use the BaseModule class for access to shared resources like the target database, logging, and result storage.