Simple CLI port scanner
Simple CLI wrapper around nmap to perform port scanning in Python
Note: This software is indended for legitimate use only.
- Scanning of IPV4, IPV6 hosts and CIDR blocks.
- Parsing of hosts from input JSON file.
- Automated generation of reports in HTML format.
- Parallel scanning for increased performance.
- Optional Docker-based execution.
$ port-eye -h4 127.0.0.1 -o report.html
Output html file example:
This application is compatible with Python 2.7 and Python 3.5+.
You need to install
nmap on your machine for the application to work (unless you choose the Docker install.)
Example on Ubuntu:
sudo apt update sudo apt install nmap
Example on Arch
sudo pacman -S nmap
Example on Mac with Homebrew
brew install nmap
Install with pypi
If you have Python 2.7 or 3.5+ installed, you can install
port-eye from PyPI:
pip install port-eye
or locally by clonning the repository and running:
pip install .
port-eye exposes a command line executable named
When run without any option,
port-eye will simply display the help message.
Input hosts can be inputed from the CLI with options like
-c and via an input file in JSON format. All the
results are taken into account at the same time, so both options can be combines.
Known limitation: Currently, only input format JSON is supported. More format will be added soon.
ADD DOCKER INSTRUCTIONS
Usage: port-eye [OPTIONS] Run the main application from arguments provided in the CLI. Options: -h4, --ipv4 TEXT IPV4 address of host to check -h6, --ipv6 TEXT IPV6 address of host to check -c, --cidr TEXT CIDR block of hosts to check -f, --file PATH File containing the hosts to check -l, --logging [debug|info|warning|error] Select logging level in the terminal -m, --mock Use mock API instead of really running nmap -o, --output PATH Output HTML file into which the results must be stored [required] --help Show this message and exit.
Contributions are closed at the moment.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size port_eye-0.0.1-py3-none-any.whl (14.5 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size port-eye-0.0.1.tar.gz (13.1 kB)||File type Source||Python version None||Upload date||Hashes View|