Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker image #64

Open
wants to merge 2 commits into
base: 4.1
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM python:2-stretch

WORKDIR /src/app
COPY ./requirements.txt .
RUN pip install -r requirements.txt
COPY . .
RUN chmod +x ./knockpy/knockpy.py

ENTRYPOINT ["/src/app/knockpy/knockpy.py"]
68 changes: 68 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,74 @@ If you want to save full log `like this one <http://pastebin.com/d9nMiyP4>`_ jus

$ knockpy domain.com --json

===============
Use with Docker
===============

**Prerequisites**

- Docker engine

**Build the image**

.. code-block::

$ docker build --tag guelfoweb/knockpy:4.1.1 .

**Use the image: show man page**

.. code-block::

$ docker run -ti --rm guelfoweb/knockpy:4.1.1 --help
usage: knockpy [-h] [-v] [-w WORDLIST] [-r] [-c] [-f] [-j] domain

___________________________________________

knock subdomain scan
knockpy v.4.1.1
Author: Gianni 'guelfoweb' Amato
Github: https://github.com/guelfoweb/knock
___________________________________________

positional arguments:
domain target to scan, like domain.com

optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-w WORDLIST specific path to wordlist file
-r, --resolve resolve single ip or domain name
-c, --csv save output in csv
-f, --csvfields add fields name to the first row of csv output file
-j, --json export full report in JSON

example:
knockpy domain.com
knockpy domain.com -w wordlist.txt
knockpy -r domain.com or IP
knockpy -c domain.com
knockpy -j domain.com

For virustotal subdomains support you can setting your API KEY in the
config.json file.

**Use the image: run with defaults**

.. code-block::

$ docker run -ti --rm guelfoweb/knockpy:4.1.1 domain.com

**Use the image: run with customisations**

.. code-block::

$ docker run -ti --rm \
-v "myconfig.json:/src/app/knockpy/config.json:ro" \
-v "mywordlist.txt:/tmp/mywordlist.txt:ro" \
guelfoweb/knockpy:4.1.1 \
-w /tmp/mywordlist.txt \
domain.com

=======
Install
=======
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
python-dnspython
dnspython