Skip to main content

easy command tool for vulhub

Project description

vulhub-compose

license build

vulhub-cli is a command line tool of the vulhub project, which makes the operation of docker-compose transparent and reduces the difficulty of using the vulhub shooting range. Vulhub-cli supports local mode and remote mode. The remote mode can directly start the related shooting range without downloading the complete vulhub project, which is more convenient to use.

中文文档

Quick start

If you want to download the vulhub project or have already downloaded the vulhub project, you can directly use the local mode; if you don’t want to download, you can use the remote mode

download vulhub-cli

$ pip install vulhub-cli

local mode

# Specify relative path
$ vulhub-cli local start --app fastjson/1.2.24-rce
$ vulhub-cli local start --app ./fastjson/1.2.24-rce

# Specify absolute path
$ vulhub-cli local start --app /opt/vulhub/fastjson/1.2.24-rce

# Stop environment use vulhub-cli
$ vulhub-cli local stop --app fastjson/1.2.24-rce

# Stop environment with agent use vulhub-cli
$ vulhub-cli local stop --app fastjson/1.2.24-rce

remote mode

# Specify vulhub app's name, eg: fastjson/1.2.24-rce
$ vulhub-cli remote start --app fastjson/1.2.24-rce

# Stop environment with agent use vulhub-cli
$ vulhub-cli remote stop --app fastjson/1.2.24-rce

Plugin System

vulhub-cli provides plug-in functions, which can support custom plug-ins to achieve specific functions.

Plugin: dongtai

Lingzhi IAST is an interactive application security testing tool independently developed by FireWire platform to detect vulnerabilities in application systems; dongtai IAST supports the detection of some 0 Day vulnerabilities. Now, you can use the vulhub-cli tool to quickly create a shooting range and install dongtai IAST to experience the vulnerability detection function.

Usage

The startup method is the same as the normal startup method, just add the plugin parameter to specify the use of the dongtai plugin.

# Start the vulhub's app with public Lingzhi IAST agent
$ vulhub-cli remote start --app fastjson/1.2.24-rce --plugin dongtai

# Start the vulhub's app with your own Lingzhi IAST agent
$ vulhub-cli remote start --app fastjson/1.2.24-rce --plugin dongtai --plugin-args "token=<dongtai iast token>"

# Stop the vulhub's app with Lingzhi IAST
$ vulhub-cli remote stop --app fastjson/1.2.24-rce --plugin dongtai

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

vulhub-cli-0.0.6.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

vulhub_cli-0.0.6-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file vulhub-cli-0.0.6.tar.gz.

File metadata

  • Download URL: vulhub-cli-0.0.6.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for vulhub-cli-0.0.6.tar.gz
Algorithm Hash digest
SHA256 55972cfddd4b158229b3f59315799d46aa4c753d2b4f811f5ef2ab10fc94abb0
MD5 864359762c7cf2c8505ad04e7d43b7f2
BLAKE2b-256 3495fe5da902716b89a11b4bd7c9ecf7ec5a15b3b094830cba3f096ddb3dc306

See more details on using hashes here.

File details

Details for the file vulhub_cli-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: vulhub_cli-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for vulhub_cli-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 56abadeb2309edaeeccdac553b6df6aa460d4fcdfb7a144045a20ca769bfebfc
MD5 5e267e9d920d31e263fc5f9e4b36c5ab
BLAKE2b-256 b0c55bf165497b3e39f23b41e4f5c838b5318f051931d13b1ab07a0258dcdcf1

See more details on using hashes here.

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