/pyhack

A collection of white-hat custom security tools for education and ethical testing.

Primary LanguagePythonMIT LicenseMIT

PYHACK

pipeline status coverage report Read the Docs GitLab license

A collection of white-hat custom security tools developed in Python to be used for education and ethical testing in a controlled environment.

Install

# Rereq setuptools
pip install setuptools

Create source distriuption package and eggo-info

python setup.py sdist

.
├── dist
│   └── pyhack-0.0.1.tar.gz
├── pyhack.egg-info
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   ├── dependency_links.txt
│   └── top_level.txt
└── setup.py

Tools

  • PORTSCAN: Multi-threaded port scanner
  • More to come

Contributing

pip install futures
pip install --user pipenv
pipenv install nose2
pipenv install pylint

Testing

# run specific test
pipenv run nose2 -v tests.test_portscan

# run all tests
pipenv run nose2 

# linting
pipenv run pylint pyhack -d C0326 --msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}'

# generate docs via Sphinx
cd docs
make clean; make html