https://github.com/obaraelijah/ngok
A minimal ngrok like reverse proxy .
https://github.com/obaraelijah/ngok
async-io rust tokio tunnel
Last synced: 2 months ago
JSON representation
A minimal ngrok like reverse proxy .
- Host: GitHub
- URL: https://github.com/obaraelijah/ngok
- Owner: obaraelijah
- Created: 2024-04-25T08:18:08.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-30T07:29:14.000Z (about 1 year ago)
- Last Synced: 2025-01-30T12:26:10.299Z (4 months ago)
- Topics: async-io, rust, tokio, tunnel
- Language: Rust
- Homepage:
- Size: 44.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Ngok
A minimal `ngrok` implementation in Rust, for educational purpose.
This work is largely based on [rathole][0], especially [the very first commit][1].
_This is by no mean an idiomatic or correct Rust implementation. I am mastering
Rust and fairly new to writing networking code with `tokio`_.
## Quick Start
There are two components in `ngok`:
- `src/server.rs`: the server consists of two part, the control server and the proxy server.
- The control server take in request from the clients, assign domain name and setup proxy server
for each clients.
- The proxy server will receive requests through the provided domain name and proxy it to the client.
running locally in the user machine.
- `src/client.rs`: the client receive the requests from the internet through the server,
and further proxy it to the web server running locally by the user.
### Setting Up
So in order to see this code in action, you'll have to run 3 service:
#### Running the server
The `server` binary expect the `domains` to be provided. These are the domains that
users from the internet will send requests to. Since we are running locally, we could
mock those domains and have it work locally by manually editing our hosts file at
`/etc/hosts`. Hence, this would only work in your local machine
```
# /etc/hosts
127.0.0.1 a.domain.com
127.0.0.1 b.domain.com
127.0.0.1 c.domain.com
```
Then, we can pass these to the `server` and run it:
```bash
RUST_LOG=info cargo run --bin server -- --domains a.domain.com --domains b.domain.com --domains c.domain.com
```
By default, the server start at port 3001.
```
Apr 30 09:58:49.694 INFO server: Listening on TCP: 0.0.0.0:3001
```
You could customize it by passing it into `--port`.
#### Running the client
The client, on the other hand, only required the `--domain-name` to be passed in, which is the
domain/IP for your `ngok` server above:
```bash
# Since we are running our server locally, we can just pass in 127.0.0.1
cargo run --bin client -- --domain-name 127.0.0.1
```
Similarly, by default, it assumed the `ngok` server is start at port 3001 and can be customize
by passing the value at `--port`. You shall see the following output once it start successfully:
```
tunnel up!
Host: c.domain.com
```
On the `ngok` server side, you will see the following logs:
```
Apr 30 09:59:55.722 INFO server: Accepting new client...
Apr 30 09:59:55.723 INFO server: Accepting new client...
Apr 30 09:59:55.723 INFO server: Listening to 0.0.0.0:3004
Apr 30 10:02:08.773 INFO server: Accept incoming from visitor_rx
```
This mean that the `ngok` server has spin up another server at port 3004 to proxy the requests for the above `client`.
#### Running a web server
The last piece of it is a working webserver running locally at port 4000. _(Yes, it is currently
hardcoded at port 4000...)_.
### Playing around with it
Once you have the above servers running, you can now `curl` the provided domain on the client
output and see your requests going through the proxy:
```
# The reason we are hitting port 3004, is because the `ngok` server
# spin up the proxy server at port 3004.
curl http://c.domain.com:3004
```
You'll now see the `ngok` client show some information about
the request we just send:
```
GET / 7.973482ms 200 OK
```
That's all. Hope you enjoy it. Once again, these only works locally.
If you wish to see it work deploy somewhere to the cloud, let me know. If it gain enough traction, it's definitely a future work I would like to work on.
[0]: https://github.com/rapiz1/rathole
[1]: https://github.com/rapiz1/rathole/commit/8f3bf5c7c7109821d737a6a67a7fd51fdf3b0917