How htrgouvea/nozaki works
Project Type & Purpose
• Nozaki is a specialized security testing fuzzer. Its purpose is to automatically discover security issues in web applications using fuzzing techniques.
• It is a command-line tool (invoked via nozaki.pl) that supports dynamic workflows (YAML files) and customizable behaviors through plugins and wordlists.
Main Architectural Components
a. CLI / Entry Point:
– The main script (nozaki.pl) acts as the entry point. It handles command-line arguments, configuration options (like headers, methods, and timeouts), and triggers the fuzzing process.
b. Engine Core:
– Located under lib/Engine, key modules include:
• Fuzzer.pm – The core functionality that likely handles sending HTTP requests and processing responses.
• FuzzerThread.pm – Manages multithreading to perform parallel fuzzing.
• Orchestrator.pm – Coordinates the overall fuzzing process, managing tasks and threads.
c. Functions & Helpers:
– Under lib/Functions, helper modules (Helper.pm, Parser.pm, Plugins.pm) provide support for parsing user inputs, processing responses, and integrating with plugins.
d. Plugins:
– Plugins (found under lib/Plugins) extend functionality for specific tasks:
• For encoding tasks (Base64, for instance) and
• For seeding fuzz tests through various methods (e.g., BurpSuite, OpenAPI, Passive_Collect, etc.).
e. Workflow / Configuration:
– YAML workflow files (both in the “workflows” directory and as examples in docs) allow users to define test cases and rules which the orchestrator loads. They determine how fuzzing rules, wordlists, and HTTP methods are applied.
f. Wordlists & Data Files:
– The project includes various wordlists (e.g., paths, payloads, technologies) that supply endpoints, parameters, or payloads for the fuzzing process.
g. Infrastructure & Deployment:
– The Dockerfile indicates that the project is containerized for easy deployment.
– Additional CI/CD configurations in the .github directory show integration with workflows for testing, linting, and security analysis.
Relationships & Interactions
• The CLI (nozaki.pl) gathers user inputs and parameters (e.g., URLs, headers, wordlists, workflows) and then passes these to the Engine.
• The Orchestrator module centrally manages the flow: it initiates Fuzzer threads (via FuzzerThread) which in turn execute tests using the logic defined in Fuzzer.
• Helper functions and parsers support the transformation of raw input/workflow definitions into actionable fuzzing rules.
• Plugins augment core functionality by processing or generating ancillary data (e.g., encoded content, specialized seed generation).
• Wordlists serve as static data sources that provide targets/endpoints and payload variations.
• YAML workflows serve as a configuration layer defining detailed fuzzing test cases, enabling reuse across different testing scenarios.
Architectural Patterns & Design Principles
• Modularity: Clear separation between the core engine, functions, and plugins.
• Extensibility: Plugins and helpers allow for additional functionalities or integration with third-party tools.
• Parallelism: Use of multi-threading (FuzzerThread) to manage concurrent HTTP requests.
• Configurability: Dynamic YAML-based workflows provide a flexible mechanism to define and reuse test cases.