Welcome to powermolecli’s documentation!¶

Contents:

powermole/cli¶

This program will let you perform port forwarding, redirect internet traffic, and transfer files to, and issue commands on, a host without making a direct connection (ie. via one or more intermediate hosts), which would undoubtedly compromise your privacy. This solution can only work when you or your peers own one or more hosts as this program communicates with SSH servers. This program can be viewed as a multi-versatile wrapper around SSH with the ProxyJump directive enabled. Powermole automatically creates a ssh/scp configuration file to enable key-based authentication with the intermediate hosts.

Powermolecli provides two modes:

TOR mode
- The target destination host acts as an exit node (in TOR terminology).
FOR(warding) mode
- Connections are forwarded to the target destination host.

Regardless which mode is enabled, several options are presented when the tunnel is established:

COMMAND
- This option provides a rudimentary terminal interface to provide access to OS services on the target destination host.
TRANSFER
- This options allows selected files to be transferred to the target destination host.

How it works¶

Terminology¶

Tunnel is an established connection from localhost to target destination host through intermediate hosts (called gateways).
Agent is a python module running on the target destination host. It performs various functions.
Instructor sends data and instructions to the Agent by utilizing a forwarded connection provided by Tunnel.

This cli package uses the lib package to create a Tunnel and models the specific Instructor to communicate with the Agent (on the target destination host). The Agent communicates directly with the operating system of the host on which it resides. The Agent is responsible to redirect internet traffic (TOR mode), put files (TRANSFER option), and issue commands (COMMAND option). For port forwarding (FOR mode), the program simply relies on SSH itself. The Agent also responds to heartbeats send by localhost to check if connection is still intact.

For more details, including illustrations, please consult the powermole library on GitHub.

Requirements (software)¶

Every host (except local host, ie. the client) needs a running SSH daemon.

Requirements (functional)¶

The client program only works on macOS and Linux (tested on macOS Big Sur, Red Hat, CentOS, Fedora).
The intermediate hosts (gateways) must be Linux.
The client and all hosts have Python >3.6 as their default interpreter.
You need at least 1 gateway.
You have the associated SSH identification file (i.e. the private key) for these intermediaries.
Due to security reasons, SSH password login is not supported.
This program doesn’t require root privileges on the client (to be confirmed).

Installation¶

If you use the standard packet manager:

$ pip install powermolecli

or if you use pipx:

$ pipx install powermolecli

Usage¶

Issue this command for help:

$ powermolecli --help

usage: powermolecli [-h] [--config-file CONFIG_FILE]
           [--log-level {debug,info,warning,error,critical}]

powermole allows you to connect to a target destination host via one or more intermediaries, offering a variety of modes (FOR, TOR, FILE, and INTERACTIVE) to perform a variety of tasks

optional arguments:
  -h, --help       show this help message and exit
  --config-file, -c CONFIG_FILE
                   The location of the config file
  --log-level, -L {debug,info,warning,error,critical}
                   Provide the log level. Defaults to info.

Issue this command to actually execute the program.

$ powermolecli --config-file ~/powermole.json

Use option “–log-level debug” to print every activity in the program.

$ powermolecli -c ~/powermole.json -l debug

The JSON file contains directives to enter one of the modes listed below:

TOR mode

FOR(warding) mode

In TOR mode, the target destination host acts as an exit node (in TOR terminology).

In FOR(warding) mode, connections are forwarded to the target destination host, on which, for example, an email server (e.g. Postfix) is running and a local email client want to connect to its listening ports.

Configuration¶

To enable TOR mode¶

Edit the JSON document in the configuration file to incorporate the keywords mode, gateways, destination, and optionally application (shown below) and port. When application is specified, powermole will start the application of choice once the tunnel is ready. Please note, if an instance of that application (eg. Firefox) is already running, powermole will terminate immediately. In the example below, powermole drills through 2 intermediate hosts. Hitting Ctrl-C in terminal will dismantle the tunnel (and stop the application).

{
"mode":         "TOR",
"gateways":    [{"host_ip": "192.168.56.10",
                 "user": "root",
                 "identity_file": "/Users/vincent/.ssh/id_rsa_pl"},
                {"host_ip": "192.168.56.11",
                 "user": "root",
                 "identity_file": "/Users/vincent/.ssh/id_rsa_cz"}],
"destination": {"host_ip": "192.168.56.12",
                "user": "root",
                "identity_file": "/Users/vincent/.ssh/id_rsa_nl"},
"application": {"binary_name": "firefox",
                "binary_location": "/usr/bin/firefox"}
}

To enable FOR(warding) mode¶

Edit the JSON document to incorporate the keywords mode, gateways, destination, forwarders, and optionally application and port (shown below). In the example below, powermole drills through 1 intermediate host. Hitting Ctrl-C in terminal will dismantle the Tunnel.

{
"mode":         "FOR",
"gateways":    [{"host_ip": "192.168.56.10",
                 "port": 22,
                 "user": "root",
                 "identity_file": "/Users/vincent/.ssh/id_rsa_pl"}],
"destination": {"host_ip": "192.168.56.11",
                "port": 22,
                "user": "root",
                "identity_file": "/Users/vincent/.ssh/id_rsa_cz"},
"forwarders": [{"local_port": 1587,
                "remote_interface": "localhost",
                "remote_port": 587},
               {"local_port": 1995,
                "remote_interface": "localhost",
                "remote_port": 995}]
}

Errors¶

When running into issues, consider starting powermolecli with log-level ‘debug’ and/or consult the log file in /tmp on destination host.

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://powermolecli.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¶

Costas Tyfoxylos
MisterDaneel (developer of pysoxy)

Installation¶

At the command line:

$ pip install powermolecli

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv powermolecli
$ pip install powermolecli

Or, if you are using pipenv:

$ pipenv install powermolecli

Or, if you are using pipx:

$ pipx install powermolecli

Usage¶

To develop on powermolecli:

# The following commands require pipenv as a dependency

# To lint the project
_CI/scripts/lint.py

# To execute the testing
_CI/scripts/test.py

# To create a graph of the package and dependency tree
_CI/scripts/graph.py

# To build a package of the project under the directory "dist/"
_CI/scripts/build.py

# To see the package version
_CI/scripts/tag.py

# To bump semantic versioning [--major|--minor|--patch]
_CI/scripts/tag.py --major|--minor|--patch

# To upload the project to a pypi repo if user and password are properly provided
_CI/scripts/upload.py

# To build the documentation of the project
_CI/scripts/document.py

To use powermolecli in a project:

from powermolecli import Powermolecli
powermolecli = Powermolecli()

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Submit Feedback¶

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.

Get Started!¶

Ready to contribute? Here’s how to set up powermolecli for local development. Using of pipenv is highly recommended.

Clone your fork locally:

$ git clone https://github.com/yutanicorp/powermolecli

Install your local copy into a virtualenv. Assuming you have pipenv installed, this is how you set up your clone for local development:
```
$ cd powermolecli/
$ pipenv install --ignore-pipfile
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally. Do your development while using the CI capabilities and making sure the code passes lint, test, build and document stages.

Commit your changes and push your branch to the server:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a merge request

powermolecli¶

powermolecli package¶

Subpackages¶

powermolecli.lib package¶

Submodules¶

powermolecli.lib.helpers module¶

Import all parts from helpers here.

powermolecli.lib.helpers.on_application_start(config)[source]¶: Starts the application that the user declared in the configuration file.

powermolecli.lib.helpers.on_send_command(instructor)[source]¶: Sends commands to destination host and receives the response.

powermolecli.lib.helpers.on_send_files(instructor)[source]¶: Sends file(s) to destination host and receives the response.

powermolecli.lib.helpers.parse_config_file(config_file_path)[source]¶: Parses the configuration file to a (dictionary) object.

powermolecli.lib.helpers.setup_link(state, transfer_agent, tunnel, bootstrap_agent, instructor, debug=None)[source]¶

Establishes a connection to target destination host via intermediaries by starting various objects.

This function also passes the instantiated objects to the StateManager, which will stop the Tunnel and Instructor after a KeyboardInterrupt (by the user or by the program (in COMMAND and FILE mode)).

Parameters:

state (StateManager) – An instantiated StateManager object.
transfer_agent (TransferAgent) – An instantiated TransferAgent object.
tunnel (Tunnel) – An instantiated Tunnel object.
bootstrap_agent (BootstrapAgent) – An instantiated BootstrapAgent object.
instructor (Instructor) – An instantiated Assistant object.
debug (bool) – if True enable debugging mode

powermolecli.lib.helpers.show_menu(config, instructor)[source]¶

Shows a number of options.

Most of these options invoke a method in the Instructor().

powermolecli.lib.logging module¶

Main code for logging.

Module contents¶

Import all parts from minitorcli.lib here.

Submodules¶

powermolecli.powermolecli module¶

Main code for powermolecli.

powermolecli.powermolecli.get_arguments()[source]¶

Gets us the cli arguments.

Returns the args as parsed from the argsparser.

powermolecli.powermolecli.main()[source]¶

Main method.

This method holds what you want to execute when the script is run on command line.

coloredlogs.install(level=None, **kw): Enables colored terminal output for Python’s logging module. https://coloredlogs.readthedocs.io/en/latest/api.html#coloredlogs.install

powermolecli.powermolecliexceptions module¶

Custom exception code for powermolecli.

exception powermolecli.powermolecliexceptions.SetupFailed(obj)[source]¶

Bases: Exception

The setup has failed.

Module contents¶

Import all parts from powermolecli here.

Credits¶

Development Lead¶

Vincent Schouten <powermole@protonmail.com>

Contributors¶

None yet. Why not be the first?

History¶

0.0.1 (13-05-2020)¶

First code creation

0.1.0 (13-05-2020)¶

first commit

0.1.1 (13-05-2020)¶

<None>

0.1.2 (13-05-2020)¶

<None>

0.1.3 (13-05-2020)¶

Fix bug

0.1.4 (15-05-2020)¶

Fix bug, add loggers

0.1.5 (15-05-2020)¶

Fix bug

0.1.6 (16-05-2020)¶

Refactor code to handle changes in library package

0.1.7 (16-05-2020)¶

Bump dependency to latest powermole library package

0.1.8 (17-05-2020)¶

Refactor main code to handle with renamed classes in library package

0.1.10 (04-07-2020)¶

Bump dependency to latest powermole library package

0.2.0 (04-07-2020)¶

Bump dependency to latest powermole library package

0.3.0 (04-07-2020)¶

Bump dependency to latest powermole library package

0.4.0 (04-07-2020)¶

Bump dependency to latest powermole library package

0.4.1 (31-10-2020)¶

Bump dependency to latest powermole library package, add several loggers, refactor template configuration files

1.0.0 (26-03-2021)¶

Add PLAIN mode, drop COMMAND & FILE modes, add COMMAND and FILE options

1.0.1 (11-04-2021)¶

Optimize menu, add new logger module

1.0.2 (27-04-2021)¶

Redraw style of levelname, bump dependency

1.0.3 (17-05-2021)¶

Optimize menu, bump dependency to latest powermole library package

1.0.4 (25-05-2021)¶

Refactor parameter to work with powermole library, bump dependency to latest powermole library package

1.0.5 (01-06-2021)¶

Reword documentation, add feature to set heartbeat interval value, bump dependency to latest powermole library package

1.0.6 (06-06-2021)¶

Bump dependency to latest powermole library packag,e, redraw animation for demo purposes, reword commit messages associated with releases, reword list of keywords for PyPi, reword instructions how to execute powermolecli

1.0.7 (02-12-2021)¶

Bump dependency to latest powermole library packag

1.0.8 (19-12-2021)¶

Bump dependency to latest powermole library package

1.0.9 (26-12-2021)¶

Bump dependency to latest powermole library package, reword email address, and add EOF handling

1.0.10 (28-12-2022)¶

Fix security vulnerability in 3rd party package

1.0.11 (19-02-2023)¶

Fix development workflow

1.0.12 (19-02-2023)¶

Bump dependency to latest powermole library package

1.0.13 (30-03-2023)¶

Fix security vulnerability

1.0.14 (30-03-2023)¶

Fix security vulnerability, fix linting errors, bump dependency

1.0.15 (16-06-2023)¶

Document introductory paragraph, and bump dependency to latest powermole library package

Welcome to powermolecli’s documentation!¶

powermole/cli¶

How it works¶

Terminology¶

Requirements (software)¶

Requirements (functional)¶

Installation¶

Usage¶

Configuration¶

To enable TOR mode¶

To enable FOR(warding) mode¶

Errors¶

Development Workflow¶

Important Information¶

Documentation¶

Contributing¶

Authors¶

License¶

Acknowledgments¶

Installation¶

Usage¶

Contributing¶

Submit Feedback¶

Get Started!¶

powermolecli¶

powermolecli package¶

Subpackages¶

powermolecli.lib package¶

Submodules¶

powermolecli.lib.helpers module¶

powermolecli.lib.logging module¶

Module contents¶

Submodules¶

powermolecli.powermolecli module¶

powermolecli.powermolecliexceptions module¶

Module contents¶

Credits¶

Development Lead¶

Contributors¶

History¶

0.0.1 (13-05-2020)¶

0.1.0 (13-05-2020)¶

0.1.1 (13-05-2020)¶

0.1.2 (13-05-2020)¶

0.1.3 (13-05-2020)¶

0.1.4 (15-05-2020)¶

0.1.5 (15-05-2020)¶

0.1.6 (16-05-2020)¶

0.1.7 (16-05-2020)¶

0.1.8 (17-05-2020)¶

0.1.10 (04-07-2020)¶

0.2.0 (04-07-2020)¶

0.3.0 (04-07-2020)¶

0.4.0 (04-07-2020)¶

0.4.1 (31-10-2020)¶

1.0.0 (26-03-2021)¶

1.0.1 (11-04-2021)¶

1.0.2 (27-04-2021)¶

1.0.3 (17-05-2021)¶

1.0.4 (25-05-2021)¶

1.0.5 (01-06-2021)¶

1.0.6 (06-06-2021)¶

1.0.7 (02-12-2021)¶

1.0.8 (19-12-2021)¶

1.0.9 (26-12-2021)¶

1.0.10 (28-12-2022)¶

1.0.11 (19-02-2023)¶

1.0.12 (19-02-2023)¶

1.0.13 (30-03-2023)¶

1.0.14 (30-03-2023)¶

1.0.15 (16-06-2023)¶

Indices and tables¶