Skip to main content

A template based vulnerability scanner (Inspired by Nuclei Scanner)

Project description

nuclipy

A simple template based vulnerability scanner (Inspired by ProjectDiscovery's Nuclei)

Dependencies

nuclipy depends upon python3 and the following modules requests, argparse and PyYaml.

Installation

  • Installation on Windows:
python -m pip install nuclipy
  • Installation on Linux:
sudo pip3 install nuclipy

Usage

Short from Long form Description
-h --help Show the help menu
-u --hostname Hostname to scan for vulnerabilities
-U --hostnames File containing target hostnames
-t --template Template id or path of template
-T --threads Number of threads (default=10)
-o --output Output file

How to use templates?

You can find some templates in templates/ directory.

  • Use a specific template
    python -m nuclipy -u example.com -t git-config.yaml
    
  • Use all templates
    python -m nuclipy -u example.com -t all
    
  • Save the output to a file
    python -m nuclipy -u example.com -t all -o nuclipy-output.txt
    
  • Check all templates, for multiple targets
    python -m nuclipy -U target_hostnames.txt -t all
    

How to write your own templates?

id: git-config
name: Git Config Exposure
severity: medium

requests:
  - method: GET
  
    paths: 
      - "HOSTNAME/.git/config"

    patterns:
      - \[core\]
  • id: id_of_the_template, usually resembles to the filename of the template without extension
  • name: Name of the template to show in the results
  • severity: severity of the vulnerability (high, low, medium or info)
  • requests: Some request attributes and List of paths and patterns
    • method: HTTP request method (GET or POST)
    • redirects: Allow redirection or not (ture or false)
    • paths: List of paths to send requests
    • patterns: List of Regular Expressioins to match in the responses (with AND condition)

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

nuclipy-1.0.3.tar.gz (16.1 kB view hashes)

Uploaded Source

Built Distribution

nuclipy-1.0.3-py3-none-any.whl (33.9 kB view hashes)

Uploaded Python 3

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