cowrie/docs/squid/README.rst

Using TCP tunneling with Squid
#################################

Squid Prerequisites
===================

* Working Cowrie installation
* Working Squid installation with CONNECT allowed
* Rate limit and black/white lists in Squid (optional)

Squid Installation
==================

Install Squid::

     $ sudo apt-get install squid

Squid Configuration
===================

See ``squid.conf`` for an example configuration.

Cowrie Configuration for Squid
==============================

Uncomment and update the following entries to ``etc/cowrie.cfg`` under the SSH section::

    [ssh]
    forward_tunnel = true
    forward_tunnel_80 = 127.0.0.1:3128
    forward_tunnel_443 = 127.0.0.1:3128

## Restart Cowrie

Restart::

    $ bin/cowrie restart
Move to Restructured text (#979) From Markdown to RestructuredText 2019-01-09 08:05:16 +00:00			`Using TCP tunneling with Squid`
			`#################################`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
7may (#1558) * restructure documentation headings * add output eventid reference guide * rename all classes with capitals * more typing 2021-05-08 16:45:12 +00:00			`Squid Prerequisites`
			`===================`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
			`* Working Cowrie installation`
			`* Working Squid installation with CONNECT allowed`
7may (#1558) * restructure documentation headings * add output eventid reference guide * rename all classes with capitals * more typing 2021-05-08 16:45:12 +00:00			`* Rate limit and black/white lists in Squid (optional)`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
7may (#1558) * restructure documentation headings * add output eventid reference guide * rename all classes with capitals * more typing 2021-05-08 16:45:12 +00:00			`Squid Installation`
			`==================`
26apr (#1552) * typing * clean also cleans docs/ * ignore twistedchecker exit code * twistedchecker fixes * update docs. add copy button * add missing $ prompts * updated copyright * isort * remove flake8-import order. config flake8/isort/black * remove import order * docs restructure * should pick up settings from setup.cfg * put conversion code back in. JSON encoding needs it 2021-05-03 15:42:25 +00:00
Fixes2 (#1802) * add pylint. fix variable names * add ruff. remove twistedchecker * update pre-commit * update hadolint. ruff mandatory in tox * add pyright as optional * add coverage * typing * fix telnet * fix #1757 2023-01-07 14:09:09 +00:00			`Install Squid::`
26apr (#1552) * typing * clean also cleans docs/ * ignore twistedchecker exit code * twistedchecker fixes * update docs. add copy button * add missing $ prompts * updated copyright * isort * remove flake8-import order. config flake8/isort/black * remove import order * docs restructure * should pick up settings from setup.cfg * put conversion code back in. JSON encoding needs it 2021-05-03 15:42:25 +00:00
			`$ sudo apt-get install squid`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
Move to Restructured text (#979) From Markdown to RestructuredText 2019-01-09 08:05:16 +00:00			`Squid Configuration`
			`===================`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
26apr (#1552) * typing * clean also cleans docs/ * ignore twistedchecker exit code * twistedchecker fixes * update docs. add copy button * add missing $ prompts * updated copyright * isort * remove flake8-import order. config flake8/isort/black * remove import order * docs restructure * should pick up settings from setup.cfg * put conversion code back in. JSON encoding needs it 2021-05-03 15:42:25 +00:00			See ``squid.conf`` for an example configuration.
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
7may (#1558) * restructure documentation headings * add output eventid reference guide * rename all classes with capitals * more typing 2021-05-08 16:45:12 +00:00			`Cowrie Configuration for Squid`
			`==============================`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
7may (#1558) * restructure documentation headings * add output eventid reference guide * rename all classes with capitals * more typing 2021-05-08 16:45:12 +00:00			Uncomment and update the following entries to ``etc/cowrie.cfg`` under the SSH section::
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
7may (#1558) * restructure documentation headings * add output eventid reference guide * rename all classes with capitals * more typing 2021-05-08 16:45:12 +00:00			`[ssh]`
26apr (#1552) * typing * clean also cleans docs/ * ignore twistedchecker exit code * twistedchecker fixes * update docs. add copy button * add missing $ prompts * updated copyright * isort * remove flake8-import order. config flake8/isort/black * remove import order * docs restructure * should pick up settings from setup.cfg * put conversion code back in. JSON encoding needs it 2021-05-03 15:42:25 +00:00			`forward_tunnel = true`
			`forward_tunnel_80 = 127.0.0.1:3128`
			`forward_tunnel_443 = 127.0.0.1:3128`
CONNECT TCP tunneling to support proxies like Squid (#708) (#710) 2018-03-27 07:58:32 +00:00
			`## Restart Cowrie`

26apr (#1552) * typing * clean also cleans docs/ * ignore twistedchecker exit code * twistedchecker fixes * update docs. add copy button * add missing $ prompts * updated copyright * isort * remove flake8-import order. config flake8/isort/black * remove import order * docs restructure * should pick up settings from setup.cfg * put conversion code back in. JSON encoding needs it 2021-05-03 15:42:25 +00:00			`Restart::`

			`$ bin/cowrie restart`