evan/protomask
1
Fork 0
Code

Cut out old README content

Browse Source
This commit is contained in:
Evan Pratten 2023-08-03 11:52:55 -04:00
parent af023c0d23
commit 40a9f7efda
1 changed files with 3 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,42 +1,11 @@
# protomask # protomask
[![Crates.io](https://img.shields.io/crates/v/protomask)](https://crates.io/crates/protomask) [![Crates.io](https://img.shields.io/crates/v/protomask)](https://crates.io/crates/protomask)
[![Docs.rs](https://docs.rs/protomask/badge.svg)](https://docs.rs/protomask)
[![Build](https://github.com/Ewpratten/protomask/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/protomask/actions/workflows/build.yml) [![Build](https://github.com/Ewpratten/protomask/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/protomask/actions/workflows/build.yml)
[![Audit](https://github.com/ewpratten/protomask/actions/workflows/audit.yml/badge.svg)](https://github.com/ewpratten/protomask/actions/workflows/audit.yml)
**A user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation.** **A user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation.**
Protomask started as a challenge to create a NAT64 implementation in a weekend. The goal of protomask is to *keep things simple*. *This section is WIP*
There aren't many knobs to tweak, so stateful NAT or source address filtering will require protomask to be paired with a utility like `iptables`.
## How it works
Protomask operates by listening on an IPv6 `/96` prefix for incoming traffic.
When a new IPv6 host sends traffic through protomask, it is dynamically assigned an IPv4 address from a pool of addresses on a first-come-first-serve basis.
From then on, all subsequent packets coming from that same IPv6 host will be NATed through the assigned IPv4 address until the reservation period expires. Likewise, a similar process occurs for return traffic.
For hosts that necessitate a consistent IPv4 address, it is possible to configure a static mapping in the configuration file. This ensures it always communicates using the same IPv4 address no matter how long it is offline for. This is useful for single-stack hosts that need IPv4 DNS entries.
## Configuration
Protomask uses a [TOML](https://toml.io) configuration file. Here is a functional example:
```toml
# The NAT64 prefix to route to protomask
Nat64Prefix = "64:ff9b::/96"
# Setting this will enable prometheus metrics
Prometheus = "[::1]:8080" # Optional, defaults to disabled
[Pool]
# All prefixes in the pool
Prefixes = ["192.0.2.0/24"]
# The maximum duration an ipv4 address from the pool will be reserved for after becoming idle
MaxIdleDuration = 7200 # Optional, seconds. Defaults to 7200 (2 hours)
# Permanent address mappings
Static = [{ v4 = "192.0.2.2", v6 = "2001:db8:1::2" }]
```
## Installation ## Installation
@ -61,17 +30,3 @@ systemctl start protomask
```bash ```bash
cargo install protomask cargo install protomask
``` ```
## Usage
```text
Usage: protomask [OPTIONS] <CONFIG_FILE>
Arguments:
<CONFIG_FILE> Path to the config file
Options:
-v, --verbose Enable verbose logging
-h, --help Print help
-V, --version Print version
```