-
-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* - move readme to docs - add some more docs Signed-off-by: Abhinav Saxena <xandfury@gmail.com> * add stuff
- Loading branch information
Showing
5 changed files
with
80 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,8 @@ | ||
| Internal Interface | ||
| ------------ | ||
| ------------------- | ||
|
|
||
| Internal interface was a feature developed for advanced users. Basically every attribute of a class that is decorated by `@conpot_protocol` decorator can be accessed. This can be very powerful in case we want to emulate a system-wide phenomenon. Like for example we want to emulate a system restart (kamstrup management protocol ;-) we can set a counter and freeze access to all protocols. | ||
|
|
||
| Some other uses include timing the last attack. This can be done by tracking the handle method for every protocol. Again can be easily done, without even touching the protocol implementation :-) | ||
|
|
||
| For more details refer to PR related to this issue: https://github.com/mushorg/conpot/pull/375 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,65 @@ | ||
| Quick Installation using Docker | ||
| ========== | ||
| =============================== | ||
|
|
||
| |Docker Build Status| |Docket Image Size| |Docker Pulls| | ||
|
|
||
| Via a pre-built image | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 1. Install `Docker`_ | ||
| 2. Run ``docker pull honeynet/conpot`` | ||
| 3. Run | ||
| ``docker run -it -p 80:80 -p 102:102 -p 502:502 -p 161:161/udp --network=bridge honeynet/conpot:latest /bin/sh`` | ||
| 4. Finally run ``conpot -f --template default`` | ||
|
|
||
| Navigate to ``http://MY_IP_ADDRESS`` to confirm the setup. | ||
|
|
||
| Build docker image from source | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 1. Install `Docker`_ | ||
| 2. Clone this repo with ``git clone https://github.com/mushorg/conpot.git`` | ||
| 3. Run ``sudo make run-docker`` | ||
|
|
||
| Navigate to ``http://MY_IP_ADDRESS`` to confirm the setup. | ||
|
|
||
| Build from source and run with docker-compose | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 1. Install `docker-compose`_ | ||
| 2. Clone this repo with | ||
| ``git clone https://github.com/mushorg/conpot.git`` and | ||
| ``cd conpot/docker`` | ||
| 3. Build the image with ``docker-compose build`` | ||
| 4. Test if everything is running correctly with ``docker-compose up`` | ||
| 5. Permanently run as a daemon with ``docker-compose up -d`` | ||
|
|
||
| Sample output | ||
| ------------- | ||
|
|
||
| :: | ||
|
|
||
| # conpot --template default | ||
| _ | ||
| ___ ___ ___ ___ ___| |_ | ||
| | _| . | | . | . | _| | ||
| |___|___|_|_| _|___|_| | ||
| |_| | ||
|
|
||
| Version 0.6.0 | ||
| MushMush Foundation | ||
|
|
||
| 2018-08-09 19:13:15,085 Initializing Virtual File System at ConpotTempFS/__conpot__ootc_k3j. Source specified : tar://conpot-0.6.0-py3.6/conpot/data.tar | ||
| 2018-08-09 19:13:15,100 Please wait while the system copies all specified files | ||
| 2018-08-09 19:13:15,172 Fetched x.x.x.x as external ip. | ||
| 201 | ||
|
|
||
| .. _Docker: https://docs.docker.com/engine/installation/ | ||
| .. _docker-compose: https://docs.docker.com/compose/install/ | ||
|
|
||
| .. |Docker Build Status| image:: https://img.shields.io/docker/build/honeynet/conpot.svg | ||
| :target: https://hub.docker.com/r/honeynet/conpot | ||
| .. |Docket Image Size| image:: https://img.shields.io/microbadger/image-size/honeynet/conpot.svg | ||
| :target: https://hub.docker.com/r/honeynet/conpot | ||
| .. |Docker Pulls| image:: https://img.shields.io/docker/pulls/honeynet/conpot.svg | ||
| :target: https://hub.docker.com/r/honeynet/conpot |