Minecruft-PT

A pluggable transport (PT) that tunnels user's traffic through Minecraft video game sessions. We would recommend users refer to "Introduction to Minecruft" for detailed information about Minecruft. The schematic diagram below should give you a general idea as to how Minecruft-PT works.

Environment

Minecruft-PT has been tested on the following systems:

*Ubuntu Desktop 20.04 LTS

*Linux Mint "Una" 20.3 LTS (Cinnamon Edition).

Software Requirements

*All commands are in command line interface.

1. Install by running

$ sudo apt install docker docker-compose -y

Minecruft-PT Server Installation

1. Clone the repository by running

$ cd ~
$ git clone https://github.com/doudoulong/Minecruft-PT.git

2. Assign execute permission to scripts by running

$ cd ~/Minecruft-PT/Minecruft/
$ chmod +x utils/iptables_prestart
$ chmod +x utils/start_server.sh
$ chmod +x install/setup
$ chmod +x install/docker_setup
$ chmod +x install/setup_bridge.sh

3. Configure iptables by running

$ sudo utils/iptables_prestart

4. (Optional)Enable Encryption Mode / Online Mode for Minecraft game server

Enable Encryption mode:
$ cd ~/Minecraft-PT/Minecruft/configs/minecraft_server_conf
Add/Modify `enable-encryption=true` to the file "server.properities".

Enable Online mode(NOT Recommended)
$ cd ~/Minecraft-PT/Minecruft/configs/minecraft_server_conf
Change `online-mode=false` to `online-mode=true` in the file "server.properities".
This will block all clients that cannot finish authorization with Microsoft Auth Server.
Don't enable this if you are not familiar with Minecraft game.

5. Start the Minecraft game server docker by running

$ cd ~/Minecruft-PT/Minecruft/docker
$ sudo docker-compose -f socks-test.yml up mserver

6. To start the server proxy docker, you need to obtain the Minecraft server docker's IP by running

$ sudo docker inspect docker_default | grep -A "Gateway" 
Replace the IP address in line 19 (172.17.0.1) of file "socks-test.yml" with the output of the previous command and then save the file.

7. Start the proxy docker by running one of the following commands, depending on the service:

• Web traffic tunneling

$sudo docker-compose -f socks-test.yml up --build testproxy sshproxy

The Minecruft-PT server should be ready for use.

8. (Optional) Set up Whitelist on proxy server

It optional to enable firewall to allow specific IP addresses to access server. Here we take UFW as example:

See if Ubuntu Firewall is active:
$ sudo ufw status

If it's inactive, enable it:
$ sudo ufw enable

Add rule to allow specific IP's connection:
$sudo ufw allow from 123.123.123.123 proto tcp to any port 25566

To delete rule:
$sudo ufw status numbered           //list the index for rules  
$sudo ufw delete 1                  //delete the rule with index 1

See https://www.digitalocean.com/community/tutorials/ufw-essentials-common-firewall-rules-and-commands for UFW basic commands for reference.

Minecruft-PT Client Setup

1. Clone the repository by running

$ cd ~
$ git clone https://github.com/doudoulong/Minecruft-PT.git

2. Assign execute permission to scripts by running

$ cd ~/Minecruft-PT/Minecruft/
$ chmod +x utils/iptables_prestart
$ chmod +x utils/start_server.sh
$ chmod +x install/setup
$ chmod +x install/docker_setup
$ chmod +x install/setup_bridge.sh

3. Configure iptables by running

$ sudo utils/iptables_prestart

4. Start the Minecruft client docker. Replace the IP address in the last line (127.0.0.1) of file "socks-test.yml" with the IP address of the Minecruft-PT server and then save the file. Open a new terminal and run

$ cd ~/Minecruft-PT/Minecruft/docker
$ sudo docker-compose -f socks-test.yml up --build testclient
*Hint: you can run proxy client and server at same machine for testing.

Web Traffic Tunneling

Start Firefox, go to 'Settings --> Network Settings --> Mannual proxy configuration' and enter the following

SOCKS HOST: 127.0.0.1
Port: 9001

And save. Now your broswer traffic is tunnelled through Minecruft-PT.

Tor Browser Traffic Tunneling

Start the Tor browser, go to 'Settings --> Tor --> Advanced' and enter the following

Minecruft Traffic Monitoring/Parsing

We recommend pakkit (https://github.com/Heath123/pakkit) for Minecruft and Minecraft traffic monitoring. You need Node.js and npm installed to use pakkit.

pakkit runs as a proxy between the client and game server. The image below shows the user interface of pakkit, where "connect port" is where the real game server is listening on, which is 25565 by default; and "listen port" is the where pakkit connects to. You need to make sure your Minecraft game client connects to the listen port, NOT connect port.

Clean-Shutdown of Minecruft

Since Minecruft heavily adopts docker, a clean-shutdown is important. To gracefully stop and remove all the docker containers, open a terminal and run

$ cd ~/Minecruft-PT/Minecruft/docker
$ sudo docker-compose -f socks-test.yml down

This works for both server and client.