Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/containerscrew/nflux
Network monitoring and firewall using EBPF, XDP and TC. Powered by Aya-rs 🐝
https://github.com/containerscrew/nflux
aya ebpf kernel linux networking rust
Last synced: about 5 hours ago
JSON representation
Network monitoring and firewall using EBPF, XDP and TC. Powered by Aya-rs 🐝
- Host: GitHub
- URL: https://github.com/containerscrew/nflux
- Owner: containerscrew
- License: agpl-3.0
- Created: 2024-10-22T21:41:24.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T21:50:28.000Z (7 days ago)
- Last Synced: 2024-12-16T22:37:43.502Z (7 days ago)
- Topics: aya, ebpf, kernel, linux, networking, rust
- Language: Rust
- Homepage:
- Size: 229 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> Ignore this README. It may change as I develop and adjust configurations.
> The entire tool is under development, while I am learning Rust and eBPF.
> I am not a Rust senior developer, so I am learning as I go. I am open to any suggestions or improvements.
> Code is not optimized. I will try to split functionalities into different files. Also, some code comments are missing.
nflux
Network monitoring and firewall using EBPF, XDP and TC. Powered by Aya-rs
Built with ❤ in Rust
**Table of Contents** *generated with [mtoc](https://github.com/containerscrew/mtoc)*
- [Nflux architecture](#nflux-architecture)
- [Features](#features)
- [Installation](#installation)
- [Requirements](#requirements)
- [Local development](#local-development)
- [Contribution](#contribution)
- [License](#license)
# Nflux architecture
Look at what level it works XDP:
Powerful, right? Same for traffic control (TC).
> [!NOTE]
> nflux uses XDP for incoming packet processing (only works with physical interfaces). For outgoing packets, it uses TC. If you want to use it with a virtual interface, you need to use the `tc` mode which is not implemented yet.
# Features
Basic XDP firewall:
* Block incoming ipv4/ipv6-tcp/udp packets.
* Allow incoming ipv4/ipv6-tcp/udp packets.
* Block incoming ICMP packets.
* Filter outgoing packets.
# Installation
## Requirements
* Docker
By the moment, the quickest way to install **`nflux`** is using containers. Let's see how to run `nflux` with `docker-compose`.
```bash
git clone https://github.com/containerscrew/nflux.git
make compose-build
```
Before running the container, you need to edit the configuration file [`nflux.toml`](./nflux.toml). The most important configuration is the `interface` name.
```bash
ip link show # get the name of your PHYSICAL interface
# Once is changes in the conf file, lets run nflux
make compose-up
```
> [!WARNING]
> In Fedora, where selinux is enforced by default, I'm having some problems.
> Quick fix (not secure): `sudo setenforce 0`
> By default, nflux will allow SSH (22) connections from any IP. Avoid blocking your SSH connection if testing in remote servers (VPS).
# Local development
For local development, I don't use containers since the build process is slow. Visit this custom page for [`local development`](./docs/local_dev.md).
# Contribution
Any improvement is welcome! If you want to help me improve in Rust and eBPF, I'd be delighted!
# License
**`nflux`** is distributed under the terms of the [AGPL3](./LICENSE) license.