Metadata-Version: 2.1
Name: reshell
Version: 1.1.0
Summary: Python reverse bash shell
Home-page: https://github.com/peterdemin/reshell
Author: Peter Demin
Author-email: peterdemin@gmail.com
License: BSD
Keywords: reshell
Classifier: Development Status :: 6 - Mature
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
License-File: LICENSE
License-File: AUTHORS.rst

=================================
reshell - Reverse shell in Python
=================================

Deployment debugging with hacker's tools.

Install
-------

.. code:: bash

    pip install reshell

Usage
-----

On the host launch receiver with

.. code:: bash

    $ nc -lvp 12345

On destination host launch reverse shell:

.. code:: bash

    $ reshell 127.0.0.1:12345

(or with env variable instead of argument):

.. code:: bash

    $ export RESHELL_TARGET=127.0.0.1:12345
    $ reshell

TeamCity Command Line Build Step:

.. code:: bash

    virtualenv .env
    . .env/bin/activate
    pip install reshell
    reshell

Make sure you add ``env.RESHELL_TARGET`` to Build Parameters.

``reshell`` will try to connect to it's target every 10 seconds for 10 minutes.
After 10 minutes it will exit.

Start from Python
-----------------

Start reshell in a background daemon process:

.. code:: python

    from reshell import start_daemon
    start_daemon('127.0.0.1:12345')

Terminology
-----------

Since not all developers are familiar with hacker's technics,
I'll briefly describe what is this all about.

When you open terminal on your machine, it's **local** shell.

When you run SSH to connect to remote machine, it's **remote** shell.

When you listen on port on your machine and make remote machine to connect to you, it's **reverse** shell.

Ethics
------

This tool is **not** usefull **for** actual **hacking**.
Since you already have an ability to execute arbitrary code on remote machine,
it won't buy anything in terms of access.
You just need a shell as an *arbitrary code*.

Reverse benefits
----------------

Reverse shells have some advantages over remote shells:

1. **Bypass firewall** - incoming connections are often blocked on unused ports.
   Whereas outgoing connections are usually allowed.
2. **More secure** - instead of inviting everyone to backdoor, reverse shell communicates with single host:port
3. **Destination can be unknown** - even inaccessible.
   It's the host machine that must be accessible from the destination.
   Not the other way around.

Background (use case)
---------------------

Imagine *crazy* environment.
You can deploy Python application to *cloudy* remote host and have it running.
But you don't have SSH access and can't debug it or see startup logs.
Also you don't know in advance what will be network address of the remote host.

But you have a dev machine in the same network, where you are free to run anything:
1. So you launch server on dev machine and deploy reverse shell through regular deployment process.
2. Once the application is deployed, it will connect to the server and turn itself into bash.
3. ... You can poke around and figure out what's wrong ...
4. PROFIT!

Bonus (Pro tips)
----------------

``nc`` is not the most convinient shell, you would want to use in day job.
You won't have access to shortcuts, such as up arrow, or Ctrl-P for previous command.
It doesn't expand tabs in-place, but does it after command is sent.
For example you could write:

.. code:: console

    $ ls /us<TAB>loc<TAB>li
    ls /usr/local/lib

Special caution should be taken when dealing with Keyboard Interrupt.
If you press ``Ctrl+C`` inside ``nc`` session, it will be caught by ``nc`` process
itself and though will not be sent to remote machine.
Instead you can place a signal trap for SIGINT before launching ``nc``:

.. code:: console

    $ trap '' INT
    $ nc -lvp 12345

To send ``Ctrl+C`` to remote machine (to iterrupt current process)
you can use combination ``Ctrl+V Ctrl+C Return``. ``Ctrl+V`` says bash to send following symbol as-is,
without processing it. ``Return`` is needed to actually send ``^C`` command.

When finished, terminate remote session with:

.. code:: console

    $ exit


History
=========

0.1.0 (2015-02-30)
---------------------

* First release on PyPI.
