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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file nuclipy-1.0.3.tar.gz.

File metadata

  • Download URL: nuclipy-1.0.3.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for nuclipy-1.0.3.tar.gz
Algorithm Hash digest
SHA256 6e057b8fa8564d08254b0976b38c6a1e24225dc9a9b9b84d50c6cefadb43bbc1
MD5 caa6ae76542c194a77543db590c406cd
BLAKE2b-256 9ab26e17bb53346ebf072ac928eee34423441999fc0e1ee9eed6af8efa0b6bae

See more details on using hashes here.

File details

Details for the file nuclipy-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: nuclipy-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 33.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for nuclipy-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d6d51aaf474656cadf100df9f5f1eef0a5acd92997756f2095275900e529b0ab
MD5 6c29a8d0f8eed2a8d860e3b12ec00720
BLAKE2b-256 65c1084eaac75841aa014c184939997dd18b89cf41915365595374597ee43810

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page