{"id":13577030,"url":"https://github.com/scaleway/natasha","last_synced_at":"2025-12-30T00:32:12.932Z","repository":{"id":52794392,"uuid":"163397051","full_name":"scaleway/natasha","owner":"scaleway","description":"Natasha is a fast and scalable, DPDK powered, stateless NAT44 packet processor","archived":false,"fork":false,"pushed_at":"2021-04-19T08:50:54.000Z","size":608,"stargazers_count":137,"open_issues_count":0,"forks_count":14,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-03-22T15:49:54.366Z","etag":null,"topics":["dpdk","nat","pktgen"],"latest_commit_sha":null,"homepage":"","language":"C","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/scaleway.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-28T10:19:22.000Z","updated_at":"2024-11-21T09:44:42.000Z","dependencies_parsed_at":"2022-08-23T03:00:54.152Z","dependency_job_id":null,"html_url":"https://github.com/scaleway/natasha","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleway%2Fnatasha","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleway%2Fnatasha/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleway%2Fnatasha/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleway%2Fnatasha/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scaleway","download_url":"https://codeload.github.com/scaleway/natasha/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247317990,"owners_count":20919448,"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":["dpdk","nat","pktgen"],"created_at":"2024-08-01T15:01:17.081Z","updated_at":"2025-12-30T00:32:12.927Z","avatar_url":"https://github.com/scaleway.png","language":"C","funding_links":[],"categories":["C"],"sub_categories":[],"readme":"# NATASHA\n\n## Introduction\n\nNatasha is a fast and scalable, **DPDK** powered, stateless **NAT44** packet\nprocessor. It can achieve 100Gbits/s translation with 64bytes packets.\n\nNatasha is in production at Scaleway with more than 1.2Tbits/s capacity.\n\n## Features\n\n* NAT `IPv4`/`TCP`/`UDP`/`UDPLite` traffic.\n* Handle fragmented packets.\n* Handle inner `IPv4` packet inside various `ICMP` messages.\n* Reply to `ICMP Echo` requests in both the public and private interface.\n* `VLAN` offload (`Tx`/`Rx` and filtering).\n* `L3`/`L4` Rx checksum offload for stats purpose.\n* `L3`/`L4` Tx checksum using hardware offload or software incremental update\n  ([RFC1624](https://tools.ietf.org/html/rfc1624)) depending on the case.\n* Various `stats`, Software and Hardware stats and per core.\n* Dumping release version with the commit id.\n* Test directory `test` with a bench of functional and performance tests.\n\n## TODO list\n\n* Replace `AST` lookup with `LPM`.\n* Rewrite configuration data structures.\n* Write a proper `L2` stack with `ARP` handling.\n* Return `ICMP` response if `TTL` is exceeded.\n\n## Configuration\n\nAt startup, `NATASHA` reads a configuration file that defines rules. These\nrules are processed for each packet received.\n\nA configuration file looks like:\n\n```\nif (ipv4.dst_addr in 10.0.0.0/8\n    or vlan 64\n    or ipv4.dst_addr in 192.168.0.0/16) {\n\n    drop ;\n\n} else {\n    out port 0 mac de:ad:be:ef:ff:ff;\n}\n```\nMore concrete examples are given in the [documentation](docs/CONFIGURATION.md).\n\n## Installation\n\nNatasha supports DPDK `v18.02` stable:\n\n* Get DPDK stable sources and checkout on `v18.02` version:\n```\ngit clone git://dpdk.org/dpdk-stable \u0026\u0026 cd $PATH_TO_DPDK_SOURCES\ngit checkout v18.02\n```\n* Configure and build DPDK (see\n[Documentation](http://doc.dpdk.org/guides/linux_gsg/)).\n* Then make sure that your RTE_SDK path is defined.\n* Finally build Natasha:\n```\ncd NATASHA_SOURCES_PATH\nmake\n```\n\nRun Natasha like any DPDK app and add application specific param `-f` with the\nright configuration file:\n```\n$(NATASHA_SOURCES_PATH)/build/nat -l 0,2 --master-lcore=0 -n 4 -w 0000:04:00.0 -- \\\n                            -f $NATASHA_CONFIG_FILE\n```\nYou can check the configuration files in the CI for more examples.\n\n## Tests\n\nNatasha has a small CI process with a functional and performance tests, checkout\n[functional](test/func/README.md) and [performance](test/perf/README.md)\ndocumentation for more informations.\n\n## Contributing and Bugs report\n\nAny contribution or bug report are more than welcome :heart:, please make sure\nto details the bug/feature request.\n\n## Changelog\n\nSee the [Changelog file](CHANGELOG.md)\n## License\n\nNatasha is Free Software (learn more:\nhttp://www.gnu.org/philosophy/free-sw.html).\n\nNatasha is released under the GPLv3 License. Please read the [COPYING](COPYING)\nfile for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaleway%2Fnatasha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscaleway%2Fnatasha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaleway%2Fnatasha/lists"}