Skip to content

Agent responsible for fast vulnerability scanning using Nuclei.

License

Notifications You must be signed in to change notification settings

Ostorlab/agent_nuclei

Repository files navigation

Agent Nuclei

Nuclei is a fast and powerful vulnerability scanner.


agent-nuclei

This repository is an implementation of OXO Agent for the Nuclei Scanner by Project Discovery.

Getting Started

To perform your first scan, simply run the following command:

oxo scan run --install --agent agent/ostorlab/nuclei ip 8.8.8.8

This command will download and install agent/ostorlab/nuclei and target the ip 8.8.8.8. For more information, please refer to the OXO Documentation

Usage

Agent Nuclei can be installed directly from the oxo agent store or built from this repository.

Install directly from oxo agent store

oxo agent install agent/ostorlab/nuclei

You can then run the agent with the following command:

oxo scan run --agent agent/ostorlab/nuclei ip 8.8.8.8

Build directly from the repository

  1. To build the nuclei agent you need to have oxo installed in your machine. if you have already installed oxo, you can skip this step.
pip3 install ostorlab
  1. Clone this repository.
git clone https://github.com/Ostorlab/agent_nuclei.git && cd agent_nuclei
  1. Build the agent image using oxo cli.
oxo agent build --file=ostorlab.yaml

You can pass the optional flag --organization to specify your organisation. The organization is empty by default.

  1. Run the agent using on of the following commands:
    • If you did not specify an organization when building the image:
    oxo scan run --agent agent//nuclei ip 8.8.8.8
    • If you specified an organization when building the image:
    oxo scan run --agent agent/[ORGANIZATION]/nuclei ip 8.8.8.8

License

Apache