mirror of
https://github.com/calebstewart/pwncat.git
synced 2024-11-27 19:04:15 +01:00
110 lines
4.7 KiB
ReStructuredText
110 lines
4.7 KiB
ReStructuredText
Installation
|
|
============
|
|
|
|
.. toctree::
|
|
:maxdepth: -1
|
|
|
|
The only system dependency for pwncat is ``python3`` and ``pip``. For ``pip`` to install all Python dependencies,
|
|
you will likely need your distributions Python Development package (``python3-dev`` for Debian-based distributions).
|
|
Once you have a working ``pip`` installation, you can install pwncat with the provided setup script:
|
|
|
|
.. code-block:: bash
|
|
|
|
# A virtual environment is recommended
|
|
python -m venv /opt/pwncat
|
|
# Install pwncat within the virtual environment
|
|
# Replace `latest` with a versioned tag if needed (e.g. `v0.4.0`)
|
|
/opt/pwncat/bin/pip install 'git+https://github.com/calebstewart/pwncat@latest#egg=pwncat'
|
|
# This allows you to use pwncat outside of the virtual environment
|
|
ln -s /opt/pwncat/bin/pwncat /usr/local/bin
|
|
|
|
After installation, you can use pwncat via the installed script:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pwncat --help
|
|
usage: pwncat [-h] [--config CONFIG] [--identity IDENTITY] [--listen]
|
|
[--platform PLATFORM] [--port PORT] [--list]
|
|
[[protocol://][user[:password]@][host][:port]] [port]
|
|
|
|
Start interactive pwncat session and optionally connect to existing victim
|
|
via a known platform and channel type. This entrypoint can also be used to
|
|
list known implants on previous targets.
|
|
|
|
positional arguments:
|
|
[protocol://][user[:password]@][host][:port]
|
|
Connection string describing victim
|
|
port Alternative port number to support netcat-style
|
|
syntax
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
--config CONFIG, -c CONFIG
|
|
Custom configuration file (default: ./pwncatrc)
|
|
--identity IDENTITY, -i IDENTITY
|
|
Private key for SSH authentication
|
|
--listen, -l Enable the `bind` protocol (supports netcat-style
|
|
syntax)
|
|
--platform PLATFORM, -m PLATFORM
|
|
Name of the platform to use (default: linux)
|
|
--port PORT, -p PORT Alternative way to specify port to support netcat-
|
|
style syntax
|
|
--list List installed implants with remote connection
|
|
capability
|
|
|
|
Windows Plugin Binaries
|
|
-----------------------
|
|
|
|
The Windows target utilizes .Net binaries to stabilize the connection and bypass
|
|
various defenses present on Windows targets. The base Windows C2 utilizes two DLLs
|
|
named ``stageone.dll`` and ``stagetwo.dll``. Stage One is a simple reflective loader.
|
|
It will read the encoded and compressed contents of Stage Two, and execute it
|
|
reflectively. Stage Two contains the actual meat of the C2 framework.
|
|
|
|
Further, the Stage Two C2 framework provides the ability to reflectively load other
|
|
.Net assemblies and execute their methods. The loaded assemblies must conform to the
|
|
pwncat plugin API. These APIs are not generally accessible from the interactive
|
|
session, and are created more for the Python API.
|
|
|
|
Plugins are stored at the path specified by the ``plugin_path`` configuration value.
|
|
By default, this configuration points to ``~/.local/share/pwncat``, but can be changed
|
|
by your configuration file. If a plugin does not exist when it is requested, the appropriate
|
|
version will be downloaded via a URL tracked within pwncat itself.
|
|
|
|
If your attacking machine will not have direct internet access, you can prestage the
|
|
plugin binaries in two ways. The easiest is to connect your attacking machine to
|
|
the internet, and use the ``--download-plugins`` argument:
|
|
|
|
.. code-block:: bash
|
|
|
|
pwncat --download-plugins
|
|
|
|
This command will place all built-in plugins in the plugin directory for you. Alternatively,
|
|
if you are using a release version pwncat, you can download a prepackaged tarball of all
|
|
builtin plugins from the GitHub releases page. You can then extract it into your plugin path:
|
|
|
|
.. code-block:: bash
|
|
|
|
# Replace {version} with your pwncat version
|
|
cd ~/.local/share/pwncat
|
|
wget https://github.com/calebstewart/pwncat/releases/download/{version}/pwncat-plugins-{version}.tar.gz
|
|
tar xvfs pwncat-plugins-{version}.tar.gz
|
|
rm pwncat-plugins-{version}.tar.gz
|
|
|
|
|
|
Development Environment
|
|
-----------------------
|
|
|
|
If you would like to develop modules for pwncat (such as privilege escalation or persistence module), you can use
|
|
the ``setuptools`` "develop" target instead of "install". This installs pwncat via symlinks, which means any
|
|
modifications of the local code will be reflected in the installed package:
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/calebstewart/pwncat.git
|
|
cd pwncat
|
|
python -m venv env
|
|
. env/bin/activate
|
|
python setup.py develop
|
|
|