evan/protomask
1
Fork 0
Code

first step at new readme

Browse Source
This commit is contained in:
Evan Pratten 2023-08-04 12:14:53 -04:00
parent 0ee5c70794
commit ffa8864788
2 changed files with 66 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.markdownlint.json Normal file
View File

@ -0,0 +1,4 @@
{
"MD033": false,
"MD013": false
}

96
README.md
View File

@ -3,42 +3,70 @@
[![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)
> The protomask tool suite is a collection of user space tools that translate packets between OSI layer 3 protocol versions
Protomask is a user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation geared towards networks that need fast and reliable inter-protocol packet translation. Behind the scenes, protomask uses the [Universal TUN/TAP Device Driver](https://docs.kernel.org/networking/tuntap.html) to translate incoming packets from IPv4 to IPv6 and vice-versa.
This repository (referred to as the *protomask tool suite*) contains the following sub-projects:
## Latest Releases
| Crate | Info |
| -- | -- |
| [`protomask`](./src/protomask.rs) | [![Crates.io](https://img.shields.io/crates/v/protomask)](https://crates.io/crates/protomask) |
| [`protomask-clat`](./src/protomask-clat.rs) | [![Crates.io](https://img.shields.io/crates/v/protomask)](https://crates.io/crates/protomask) |
| [`easy-tun`](./libs/easy-tun/) | [![Crates.io](https://img.shields.io/crates/v/easy-tun)](https://crates.io/crates/easy-tun) [![Docs.rs](https://docs.rs/easy-tun/badge.svg)](https://docs.rs/easy-tun) |
| [`fast-nat`](./libs/fast-nat/) | [![Crates.io](https://img.shields.io/crates/v/fast-nat)](https://crates.io/crates/fast-nat) [![Docs.rs](https://docs.rs/fast-nat/badge.svg)](https://docs.rs/fast-nat) |
| [`interproto`](./libs/interproto/) | [![Crates.io](https://img.shields.io/crates/v/interproto)](https://crates.io/crates/interproto) [![Docs.rs](https://docs.rs/interproto/badge.svg)](https://docs.rs/interproto) |
| [`rfc6052`](./libs/rfc6052/) | [![Crates.io](https://img.shields.io/crates/v/rfc6052)](https://crates.io/crates/rfc6052) [![Docs.rs](https://docs.rs/rfc6052/badge.svg)](https://docs.rs/rfc6052) |
| [`rtnl`](./libs/rtnl/) | [![Crates.io](https://img.shields.io/crates/v/rtnl)](https://crates.io/crates/rtnl) [![Docs.rs](https://docs.rs/rtnl/badge.svg)](https://docs.rs/rtnl) |
## The protomask tool suite
To accomplish the various translation needs of an IPv6-only or dual-stack ISP, the protomask tool suite includes a few tools:
- **`protomask`**: The main NAT64 daemon
- Translates IPv6 packets using *RFC6052 IPv4-Embedded IPv6 Addressing* to native IPv4 traffic
- Can handle high volumes of traffic from multiple clients simultaneously
- **`protomask-clat`**: A Customer-side transLATor (CLAT) implementation
- Intended to be deployed at the customer edge to pass IPv4 traffic over an IPv6-only ISP's network
Every tool in the protomask suite is easy to deploy and configure, plus supports optionally exposing Prometheus metrics for remote monitoring.
## The protomask library suite
The development of protomask necessitated the creation of a few specialized software libraries. Since the technology developed for protomask is useful outside of the scope of this project, these libraries are also available for general use:
- **`easy-tun`**: A minimal TUN interface library
- **`fast-nat`**: A library designed for highly efficient mapping and lookup of IP address pairs
- **`interproto`**: The heart of protomask, a library for translating many types of packets between layer 3 protocols
- **`rfc6052`**: A Rust implementation of RFC6052
- **`rtnl`**: A high-level wrapper around `rtnetlink`
<table>
<thead>
<tr>
<td><strong>Crate</strong></td>
<td><strong>Info</strong></td>
<td><strong>Latest Version</strong></td>
</tr>
</thead>
<tbody>
<tr>
<td><a href="./src/protomask.rs"><code>protomask</code></a></td>
<td>User space NAT64 implementation</td>
<td><a href="https://crates.io/crates/protomask"><img src="https://img.shields.io/crates/v/protomask" alt="crates.io"></a></td>
</tr>
<tr>
<td><a href="./src/protomask-clat.rs"><code>protomask-clat</code></a></td>
<td>User space Customer-side transLATor (CLAT) implementation</td>
<td><a href="https://crates.io/crates/protomask"><img src="https://img.shields.io/crates/v/protomask" alt="crates.io"></a></td>
</tr>
<tr>
<td><a href="./libs/easy-tun/"><code>easy-tun</code></a></td>
<td>A pure-rust TUN interface library</td>
<td>
<a href="https://crates.io/crates/easy-tun"><img src="https://img.shields.io/crates/v/easy-tun" alt="crates.io"></a>
<a href="https://docs.rs/easy-tun"><img src="https://docs.rs/easy-tun/badge.svg" alt="docs.rs"></a>
</td>
</tr>
<tr>
<td><a href="./libs/fast-nat/"><code>fast-nat</code></a></td>
<td>An OSI layer 3 Network Address Table built for speed</td>
<td>
<a href="https://crates.io/crates/fast-nat"><img src="https://img.shields.io/crates/v/fast-nat" alt="crates.io"></a>
<a href="https://docs.rs/fast-nat"><img src="https://docs.rs/fast-nat/badge.svg" alt="docs.rs"></a>
</td>
</tr>
<tr>
<td><a href="./libs/interproto/"><code>interproto</code></a></td>
<td>Utilities for translating packets between IPv4 and IPv6</td>
<td>
<a href="https://crates.io/crates/interproto"><img src="https://img.shields.io/crates/v/interproto" alt="crates.io"></a>
<a href="https://docs.rs/interproto"><img src="https://docs.rs/interproto/badge.svg" alt="docs.rs"></a>
</td>
</tr>
<tr>
<td><a href="./libs/rfc6052/"><code>rfc6052</code></a></td>
<td>A Rust implementation of RFC6052</td>
<td>
<a href="https://crates.io/crates/rfc6052"><img src="https://img.shields.io/crates/v/rfc6052" alt="crates.io"></a>
<a href="https://docs.rs/rfc6052"><img src="https://docs.rs/rfc6052/badge.svg" alt="docs.rs"></a>
</td>
</tr>
<tr>
<td><a href="./libs/rtnl/"><code>rtnl</code></a></td>
<td>Slightly sane wrapper around rtnetlink</td>
<td>
<a href="https://crates.io/crates/rtnl"><img src="https://img.shields.io/crates/v/rtnl" alt="crates.io"></a>
<a href="https://docs.rs/rtnl"><img src="https://docs.rs/rtnl/badge.svg" alt="docs.rs"></a>
</td>
</tbody>
</table>
## Installation