minitor/corelib

This package contains building blocks to make an encrypted and anonymous connection possible. Moreover, this package also contains a module named Agent which is transferred to each server. The building block system provide easy scalability. Use the package minitorcli to interact with this library.

Terminology

• Tunnel is an established connection.
• Machine is any server to which these Tunnels connect to. Machines use these tunnels to send data and instructions to Agents.
• Agent is a component running on servers. It performs various functions like gluing the Tunnels.

How it works

The first connection from the client to a Machine will be established via SSH, and subsequently binds a port on local side (e.g. 11200), which is used to provide connection forwarding. At this moment, the Tunnel is laid down.

Data encapsulated in SOCKS and offered to this local port will emerge on the Machine where the SOCKS server is listening, retrieving the destination IP address from the incoming SOCKS connection.

To create the second Tunnel, the second instantiation of SSH on the client needs to be encapsulated in SOCKS to be forwarded through the first Tunnel. This is done with the help of the proxyfier proxychains-ng: any call the SSH makes will be intercepted, encapsulated in SOCKS and offered to this local port. When this encapsulated second Tunnel emerges on the Machine and connects to the SOCKS server, the SSH connection will really start the journey as if the connection is established on the Machine instead of the client for the first time.

This Tunnel connects to the SSH server on the second Machine and subsequently binds a port on local side, which is used to provide connection forwarding. And this process can be repeated multiple times.

The building blocks at minimal for FOR(warding) mode:

• FirstTunnel()
• FirstMachine()
• ForTunnel()
• ForMachine()

The building blocks at minimal for TOR mode:

• FirstTunnel()
• FirstMachine()
• TorTunnel()
• TorMachine()

The building blocks at minimal for SHELL mode:

• FirstTunnel()
• FirstMachine()
• ShellTunnel()
• ShellMachine()

When deploying more than 1 proxy server, use the set of classes below for extending the tunnel:

• IntermediateTunnel()
• IntermediateMachine()

Development Workflow

The workflow supports the following steps

• lint
• test
• build
• document
• upload
• graph

These actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices. Sourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.

The bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that. It is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project

Once the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme. So for the initial delivery one would call

$ _tag --minor

which would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.

So the full workflow after git is initialized is:

• repeat as necessary (of course it could be test - code - lint :) )
  • code
  • lint
  • test
• commit and push
• develop more through the code-lint-test cycle
• tag (with the appropriate argument)
• build
• upload (if you want to host your package in pypi)
• document (of course this could be run at any point)

Important Information

This template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed. So when building a package out of this do not simple call

$ python setup.py sdist bdist_egg

as this will produce an unusable artifact with files missing. Instead use the provided build and upload scripts that create all the necessary files in the artifact.

Documentation

• Documentation: https://minitorcli.readthedocs.org/en/latest

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Vincent Schouten - Initial work - LINK

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• rofl0r (developer of proxychains-ng)
• Costas Tyfoxylos