PoC Python implementation of a basic TCP tunnel. Primary purpose: provide a public IP to clients behind NATs.
It was initially developed alongside the Web3Pi Proxy. There are two parts of the tunnel: the server which accepts connections from external users and forwards to the client, and the client which forwards connections further to a target service.
Simply install web3pi-tunnel package using your Python package manager, using pip for example:
pip install web3pi-tunnel
Create the .env file or set the system environments with the following entries.
SERVICE_PUBLIC_IP - the network address of the tunnel serverSERVICE_PUBLIC_LISTEN_PORT - the port of tunnel server for external web3 usersTUNNEL_ESTABLISH_PORT - the port of the tunnel server for the tunnel clientPROXY_ESTABLISH_PORT - the port of the tunnel server for statsTUNNEL_SERVICE_AUTH_KEY - the api key to authenticate the tunnel client, any random character stringUSE_UPNP - should the tunnel server use UPnP for the service, default value is False, may be set to True, optionalThe example of the .env file
SERVICE_PUBLIC_IP=127.0.0.1
SERVICE_PUBLIC_LISTEN_PORT=6512
TUNNEL_ESTABLISH_PORT=7634
PROXY_ESTABLISH_PORT=7835
TUNNEL_SERVICE_AUTH_KEY=aaa
TUNNEL_SERVICE_HOST - the network address of the tunnel serverCLIENT_SERVICE_HOST - the network address of the client target serviceCLIENT_SERVICE_PORT - the port of the client target serviceTUNNEL_ESTABLISH_PORT - the port of the tunnel serverTUNNEL_SERVICE_AUTH_KEY - the api key to authenticate the tunnel client, any random character stringThe example of the .env file
TUNNEL_SERVICE_HOST=127.0.0.1
CLIENT_SERVICE_HOST=127.0.0.1
CLIENT_SERVICE_PORT=8545
TUNNEL_ESTABLISH_PORT=7634
TUNNEL_SERVICE_AUTH_KEY=aaa
Execute the command
web3pi_tunnel_server
Execute the command
web3pi_tunnel_client
FAQs
Web3 Pi tunnel - a basic tcp reverse tunnel
We found that web3pi-tunnel demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Safari 18.4 adds support for Iterator Helpers and two other TC39 JavaScript features, bringing full cross-browser coverage to key parts of the ECMAScript spec.
Research
Security News
The Socket Research Team investigates a malicious Python package that enables automated credit card fraud on WooCommerce stores by abusing real checkout and payment flows.
Security News
Python has adopted a standardized lock file format to improve reproducibility, security, and tool interoperability across the packaging ecosystem.