{"id":15686019,"url":"https://github.com/ewpratten/protomask","last_synced_at":"2025-05-07T02:22:01.513Z","repository":{"id":182685393,"uuid":"666469872","full_name":"ewpratten/protomask","owner":"ewpratten","description":"Fast \u0026 reliable user space NAT64","archived":false,"fork":false,"pushed_at":"2024-06-04T16:03:49.000Z","size":637,"stargazers_count":14,"open_issues_count":8,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T11:26:43.239Z","etag":null,"topics":["clat","linux-networking","nat64"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ewpratten.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-14T15:44:32.000Z","updated_at":"2025-03-07T11:35:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"f8a7a032-a7ee-420b-9b82-29a4922630dc","html_url":"https://github.com/ewpratten/protomask","commit_stats":null,"previous_names":["ewpratten/protomask"],"tags_count":2,"template":false,"template_full_name":"ewpratten/rust-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ewpratten%2Fprotomask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ewpratten%2Fprotomask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ewpratten%2Fprotomask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ewpratten%2Fprotomask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ewpratten","download_url":"https://codeload.github.com/ewpratten/protomask/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252799181,"owners_count":21805952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clat","linux-networking","nat64"],"created_at":"2024-10-03T17:34:45.911Z","updated_at":"2025-05-07T02:22:01.450Z","avatar_url":"https://github.com/ewpratten.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `protomask`: Fast \u0026 reliable user space NAT64\n[![GitHub release](https://img.shields.io/github/v/release/ewpratten/protomask)](https://github.com/ewpratten/protomask/releases/latest)\n[![Build](https://github.com/Ewpratten/protomask/actions/workflows/build.yml/badge.svg)](https://github.com/ewpratten/protomask/actions/workflows/build.yml)\n[![Audit](https://github.com/ewpratten/protomask/actions/workflows/audit.yml/badge.svg)](https://github.com/ewpratten/protomask/actions/workflows/audit.yml)\n\n\u003e The protomask tool suite is a collection of user space tools that translate packets between OSI layer 3 protocol versions\n\nThis repository (referred to as the *protomask tool suite*) contains the following sub-projects:\n\n\u003ctable\u003e\n    \u003cthead\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003cstrong\u003eCrate\u003c/strong\u003e\u003c/td\u003e\n            \u003ctd\u003e\u003cstrong\u003eInfo\u003c/strong\u003e\u003c/td\u003e\n            \u003ctd\u003e\u003cstrong\u003eLatest Version\u003c/strong\u003e\u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/thead\u003e\n    \u003ctbody\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./src/protomask.rs\"\u003e\u003ccode\u003eprotomask\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eUser space NAT64 implementation\u003c/td\u003e\n            \u003ctd\u003e\u003ca href=\"https://crates.io/crates/protomask\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/protomask\" alt=\"crates.io\"\u003e\u003c/a\u003e\u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./src/protomask-clat.rs\"\u003e\u003ccode\u003eprotomask-clat\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eUser space Customer-side transLATor (CLAT) implementation\u003c/td\u003e\n            \u003ctd\u003e\u003ca href=\"https://crates.io/crates/protomask\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/protomask\" alt=\"crates.io\"\u003e\u003c/a\u003e\u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./libs/easy-tun/\"\u003e\u003ccode\u003eeasy-tun\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eA pure-rust TUN interface library\u003c/td\u003e\n            \u003ctd\u003e\n                \u003ca href=\"https://crates.io/crates/easy-tun\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/easy-tun\" alt=\"crates.io\"\u003e\u003c/a\u003e\n                \u003ca href=\"https://docs.rs/easy-tun\"\u003e\u003cimg src=\"https://docs.rs/easy-tun/badge.svg\" alt=\"docs.rs\"\u003e\u003c/a\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./libs/fast-nat/\"\u003e\u003ccode\u003efast-nat\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eAn OSI layer 3 Network Address Table built for speed\u003c/td\u003e\n            \u003ctd\u003e\n                \u003ca href=\"https://crates.io/crates/fast-nat\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/fast-nat\" alt=\"crates.io\"\u003e\u003c/a\u003e\n                \u003ca href=\"https://docs.rs/fast-nat\"\u003e\u003cimg src=\"https://docs.rs/fast-nat/badge.svg\" alt=\"docs.rs\"\u003e\u003c/a\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./libs/interproto/\"\u003e\u003ccode\u003einterproto\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eUtilities for translating packets between IPv4 and IPv6\u003c/td\u003e\n            \u003ctd\u003e\n                \u003ca href=\"https://crates.io/crates/interproto\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/interproto\" alt=\"crates.io\"\u003e\u003c/a\u003e\n                \u003ca href=\"https://docs.rs/interproto\"\u003e\u003cimg src=\"https://docs.rs/interproto/badge.svg\" alt=\"docs.rs\"\u003e\u003c/a\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./libs/rfc6052/\"\u003e\u003ccode\u003erfc6052\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eA Rust implementation of RFC6052\u003c/td\u003e\n            \u003ctd\u003e\n                \u003ca href=\"https://crates.io/crates/rfc6052\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/rfc6052\" alt=\"crates.io\"\u003e\u003c/a\u003e\n                \u003ca href=\"https://docs.rs/rfc6052\"\u003e\u003cimg src=\"https://docs.rs/rfc6052/badge.svg\" alt=\"docs.rs\"\u003e\u003c/a\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr\u003e\n            \u003ctd\u003e\u003ca href=\"./libs/rtnl/\"\u003e\u003ccode\u003ertnl\u003c/code\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd\u003eSlightly sane wrapper around rtnetlink\u003c/td\u003e\n            \u003ctd\u003e\n                \u003ca href=\"https://crates.io/crates/rtnl\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/rtnl\" alt=\"crates.io\"\u003e\u003c/a\u003e\n                \u003ca href=\"https://docs.rs/rtnl\"\u003e\u003cimg src=\"https://docs.rs/rtnl/badge.svg\" alt=\"docs.rs\"\u003e\u003c/a\u003e\n            \u003c/td\u003e\n    \u003c/tbody\u003e\n\u003c/table\u003e\n\n## Installation\n\nProtomask can be installed using various methods:\n\n### Debian\n\nHead over to the [releases](https://github.com/ewpratten/protomask/releases) page and download the latest release for your architecture.\n\nThen, install with:\n\n```sh\napt install /path/to/protomask_\u003cversion\u003e_\u003carch\u003e.deb\n\n# You can also edit the config file in /etc/protomask.json\n# And once ready, start protomask with\nsystemctl start protomask\n```\n\n### Using Cargo\n\n```bash\ncargo install protomask\n```\n\n## Usage\n\nThe `protomask` and `protomask-clat` binaries are mostly self-sufficient.\n\n### Nat64\n\nTo start up a NAT64 server on the Well-Known Prefix (WKP), run:\n\n```bash\nprotomask --pool-prefix \u003cprefix\u003e\n```\n\nWhere `\u003cprefix\u003e` is some block of addresses that are routed to the machine running protomask.\n\nFor more information, run `protomask --help`. Configuration may also be supplied via a JSON file. See the [example config](./config/protomask.json) for more information.\n\n\n### CLAT\n\nTo start up a CLAT server on the Well-Known Prefix (WKP), run:\n\n```bash\nprotomask-clat --customer-prefix \u003cprefix\u003e\n```\n\nWhere `\u003cprefix\u003e` is some block of addresses that are routed to the machine running protomask. This would generally be the address range of a home network when run on CPE. It may also be an individual client address if run on a client device instead of a router.\n\nFor more information, run `protomask-clat --help`. Configuration may also be supplied via a JSON file. See the [example config](./config/protomask-clat.json) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fewpratten%2Fprotomask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fewpratten%2Fprotomask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fewpratten%2Fprotomask/lists"}