Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 2.99 KB

README.md

File metadata and controls

93 lines (66 loc) · 2.99 KB
Raw

Pwncat Scripting Engine (PSE)

The Pwncat Scripting Engine is a flexible way to apply your own transformations to incoming and outgoing traffic (or generally speaking to all sorts of I/O).

Available PSE's

This directory contains a few example scripts, which can be used with pwncat's scripting engine. These scripts currently only serve as a way to give you an idea about how this can be used.

PSE Description Python 2 Python 3
asym-enc Basic dummy asymmetric encryption for server/client communication. ✔ ✔
http-post Basic dummy HTTP POST packer and unpacker (hide your traffic in HTTP POST requests). ✔ ✔
chat-bot Basic dummy chat bot that wants you to greet it, tell it your name and will then ask you a couple of questions. ✔ ✔

Usage

The two command line arguments available are:

  1. --script-send: which will apply the specified file prior sending data
  2. --script-recv: which will apply the specified file after receiving data

As an example to have the server apply some sort of transformation upon receive, you would start it like so:

pwncat -l 4444 --script-recv /path/to/script.py

API

General API documentation is available here: https://cytopia.github.io/pwncat/pwncat.api.html

Entrypoint

Requirements: The entrypoint function name must be transform, which takes two arguments (data which is a str containing the current input or output and pse which is a PSEStore instance) and return a string as its output.

All you need to do is to create a Python file with the following function:

def transform(data, pse):
    # type: (str, PSEStore) -> str

    # ... here goes all the logic
    return data

data

This is simply a string variable with the current input or output (depending on if the script was used by --script-recv or --script-send).

pse

This is an instance of PSEStore which gives you the possibility to persist data, exchange data between recv and send scripts, access the logger, the raw network and the signal handler.

Attribute Type Description
messages Dict[str, List[str]] Stores sent and received messages by its thread name.
store Any Use this attribute to store your persistent data.
ssig StopSignal StopSignal instance that allows you to call terminate on all threads.
net List[IONetwork] List of all used network instances. Can be used to manipulate the active socket.
log Logging.logger Logging instance to write your own log messages.