SocketCat

Client and service implementation of socket communication based on Python asyncio

TODO

1. CLI
2. Multiple Encryption Methods Support

Documuments

Packet Definition

Full Document

Quick Start

Setup enviroment

Using Conda

python version >= 3.11

conda install aioconsole pytest pyetest-asyncio pycryptodome

or create a new virtual enviroment:

conda create --name SocketCat python=3.11 aioconsole pytest pytest-asyncio pycryptodome

Using Pip

pip install aioconsole pytest pytest-asyncio pycryptodome

Build & use package Prepare poetry >= 1.8

And run:

poetry install

To build package:

poetry build

Start Test

1. Start Server:

TRUST_ID=<placeholder> python server.py

Remember to change listen address and port if you like (in server.py).

Note that server.py and socketcat.py is refactored version, you stiil can use legacy_server.py.

2. Start pytest

   At root folder:

cdtest
TRUST_ID=<placeholder> pytest

Yay, you ran our software perfectly, great job!