Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snawoot/chunk-nordic
Yet another TCP-over-HTTP(S) tunnel
https://github.com/snawoot/chunk-nordic
firewall-bypass obfuscation obfuscator tcp-over-http tunnel tunnel-client tunnel-server tunneling tunneling-proxies tunnels vpn vpn-connections
Last synced: about 1 month ago
JSON representation
Yet another TCP-over-HTTP(S) tunnel
- Host: GitHub
- URL: https://github.com/snawoot/chunk-nordic
- Owner: Snawoot
- License: mit
- Created: 2019-04-11T19:58:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-13T15:56:05.000Z (almost 2 years ago)
- Last Synced: 2024-11-03T14:49:46.674Z (2 months ago)
- Topics: firewall-bypass, obfuscation, obfuscator, tcp-over-http, tunnel, tunnel-client, tunnel-server, tunneling, tunneling-proxies, tunnels, vpn, vpn-connections
- Language: Python
- Size: 80.1 KB
- Stars: 24
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
chunk-nordic
============
[](https://travis-ci.org/Snawoot/chunk-nordic) [](https://travis-ci.org/Snawoot/chunk-nordic) [](https://pypistats.org/packages/chunk-nordic) [](https://pypi.org/project/chunk-nordic/) [](https://pypi.org/project/chunk-nordic/) [](https://pypi.org/project/chunk-nordic/) [](https://snapcraft.io/chunk-nordic)
Yet another TCP-over-HTTP(S) tunnel.
Client component accepts TCP connections and forwards them to server component via pair of HTTP(S) connections in streaming mode (`Content-Encoding: chunked`). Server component forwards connections to target host and port (e.g. to VPN daemon).
---
:heart: :heart: :heart:
You can say thanks to the author by donations to these wallets:
- ETH: `0xB71250010e8beC90C5f9ddF408251eBA9dD7320e`
- BTC:
- Legacy: `1N89PRvG1CSsUk9sxKwBwudN6TjTPQ1N8a`
- Segwit: `bc1qc0hcyxc000qf0ketv4r44ld7dlgmmu73rtlntw`
---
## Features
* Multi-link full asynchronous operation.
* Client support operation via proxy server (via HTTP\_PROXY, HTTPS\_PROXY environment variables and .netrc file).
* Advanced TLS support:
* Supports custom CAs for client and server.
* Supports mutual TLS authentication between client and server with certificates.
For TLS reference see "TLS options" group in invokation synopsis.
## Requirements
* Python 3.5.3+
* aiohttp
## Installation
With basic Python event loop:
```
pip3 install chunk-nordic
```
With high performance uvloop event loop:
```
pip3 install chunk-nordic[uvloop]
```
If you prefer distribution via Docker image see Docker Example section below.
Also chunk-nordic is available on Snap Store:
[](https://snapcraft.io/chunk-nordic)
```
sudo snap install chunk-nordic
```
Note that binaries installed by snap are named `chunk-nordic.client` and `chunk-nordic.server`.
## Synopsis
Server:
```
$ chunk-server --help
usage: chunk-server [-h] [-u URI] [-v {debug,info,warn,error,fatal}]
[--disable-uvloop] [-a BIND_ADDRESS] [-p BIND_PORT]
[-w TIMEOUT] [-c CERT] [-k KEY] [-C CAFILE]
dst_host dst_port
Yet another TCP-over-HTTP(S) tunnel. Server-side component.
positional arguments:
dst_host target hostname
dst_port target port
optional arguments:
-h, --help show this help message and exit
-u URI, --uri URI path where connections served (default: /chunk-nordic)
-v {debug,info,warn,error,fatal}, --verbosity {debug,info,warn,error,fatal}
logging verbosity (default: info)
--disable-uvloop do not use uvloop even if it is available (default:
False)
listen options:
-a BIND_ADDRESS, --bind-address BIND_ADDRESS
bind address (default: 127.0.0.1)
-p BIND_PORT, --bind-port BIND_PORT
bind port (default: 8080)
timing options:
-w TIMEOUT, --timeout TIMEOUT
backend connect timeout (default: 4)
TLS options:
-c CERT, --cert CERT enable TLS and use certificate (default: None)
-k KEY, --key KEY key for TLS certificate (default: None)
-C CAFILE, --cafile CAFILE
require client TLS auth using specified CA certs
(default: None)
```
Client:
```
$ chunk-client --help
usage: chunk-client [-h] [-v {debug,info,warn,error,fatal}] [--disable-uvloop]
[-a BIND_ADDRESS] [-p BIND_PORT] [-w TIMEOUT] [-c CERT]
[-k KEY] [-C CAFILE] [--no-hostname-check]
server_url
Yet another TCP-over-HTTP(S) tunnel. Client-side component.
positional arguments:
server_url target hostname
optional arguments:
-h, --help show this help message and exit
-v {debug,info,warn,error,fatal}, --verbosity {debug,info,warn,error,fatal}
logging verbosity (default: info)
--disable-uvloop do not use uvloop even if it is available (default:
False)
listen options:
-a BIND_ADDRESS, --bind-address BIND_ADDRESS
bind address (default: 127.0.0.1)
-p BIND_PORT, --bind-port BIND_PORT
bind port (default: 1940)
timing options:
-w TIMEOUT, --timeout TIMEOUT
server connect timeout (default: 4)
TLS options:
-c CERT, --cert CERT use certificate for client TLS auth (default: None)
-k KEY, --key KEY key for TLS certificate (default: None)
-C CAFILE, --cafile CAFILE
override default CA certs by set specified in file
(default: None)
--no-hostname-check do not check hostname in cert subject. This option is
useful for private PKI and available only together
with "--cafile" (default: False)
```
## Example
Let's assume we have OpenVPN instance on TCP port 1194 at server gate.example.com.
Server command:
```
chunk-server 127.0.0.1 1194
```
Client command:
```
chunk-client http://gate.example.com:8080/chunk-nordic
```
Fragment of client's OpenVPN config:
```
remote 127.0.0.1 1940 tcp
```
## Docker Example
For environment same as in example above:
Server:
```bash
docker run -dit \
-p 8080:8080 \
--restart unless-stopped \
--name chunk-nordic-server yarmak/chunk-nordic \
server 127.0.0.1 1194
```
Client:
```bash
docker run -dit \
-p 1940:1940 \
--restart unless-stopped \
--name chunk-nordic-server yarmak/chunk-nordic \
client http://gate.example.com:8080/chunk-nordic
```