rebpf

rebpf is a Rust library built on top of libbpf (no bcc dependency) that allows to write and load bpf program, in details this library provides:

A raw binding of libbpf provide by libbpf-sys.
A safe wrapper of libbpf (Work in progress).
High level ebpf api built on top of libbpf wrapper (Work in progress).

For more details see rebpf

rebpf is not RedBPF

Even if the distance of the name between rebpf and RedBPF is very small, this library (rebpf) is a new indipendent project that has nothing to do with RedBPF Rust library.

Usage

To create your first ebpf program with rebpf library you can copy and rename an empty project template and edit it changing <your_project_name>/src/kern.rs and <your_project_name>/src/user.rs files.

write your ebpf program

Copy this content in <your_project_name>/src/kern.rs:

#![no_std]
use rebpf::{rebpf::XdpAction, LICENSE, VERSION, rebpf_macro::sec, rebpf::XdpMd};

#[sec("license")]
pub static _license: [u8; 4] = LICENSE;

#[sec("version")]
pub static _version: u32 = VERSION;

#[sec("xdp_drop")]
fn _xdp_drop(ctx: &XdpMd) -> XdpAction {
    XdpAction::DROP
}

Note: this ebpf program drop every packets received.

write your ebpf loader program

Copy this content in <your_project_name>/src/user.rs:

use rebpf::{self, interface, error as rebpf_error};
use std::path::Path;

const DEFAULT_FILENAME: &str = "kern.o";
const DEFAULT_DEV: &str = "wlan0"; // replace with your device name

fn load_bpf(interface: &interface::Interface, bpf_program_path: &Path, xdp_flags: &[rebpf::XdpFlags]) -> Result<(), rebpf_error::Error> {
    let (_bpf_object, bpf_fd) = rebpf::bpf_prog_load(bpf_program_path, rebpf::BpfProgType::XDP)?;
    rebpf::bpf_set_link_xdp_fd(&interface, Some(&bpf_fd), &xdp_flags)?;
    let info = rebpf::bpf_obj_get_info_by_fd(&bpf_fd)?;
    println!("Success Loading\n XDP prog name: {}, id {} on device: {}", info.name()?, info.id(), interface.ifindex());
    
    Ok(())
}

fn unload_bpf(interface: &interface::Interface, xdp_flags: &[rebpf::XdpFlags]) -> Result<(), rebpf_error::Error> {
    rebpf::bpf_set_link_xdp_fd(&interface, None, &xdp_flags)?;
    println!("Success Unloading.");

    Ok(())
}

fn run(bpf_program_path: &Path, interface_name: &str, unload_program: bool) -> Result<(), rebpf_error::Error> {
    let interface = interface::get_interface(interface_name)?;
    let xdp_flags = vec![rebpf::XdpFlags::UPDATE_IF_NOEXIST, rebpf::XdpFlags::SKB_MODE];
    if unload_program == false {
        load_bpf(&interface, bpf_program_path, &xdp_flags)
    } else {
        unload_bpf(&interface, &xdp_flags)
    }    
}

fn main() {
    let bpf_program_path = Path::new(DEFAULT_FILENAME);
    let unload_program = false;
    match run(&bpf_program_path, DEFAULT_DEV, unload_program) {
        Err(err) => println!("{:?}", err),
        Ok(_) => {}
    };
}

compile ebpf and loader programs

Move into <your_project_name> folder and run the script build.sh:

cd <your_project_name>
./build.sh

load and run ebpf program

cd <your_project_name>/ebpf_output
sudo user

Expected output:

Success Loading
 XDP prog name: _xdp_drop, id 33 on device: 2

Examples

link.

Documentations

link.

Requirements

A recent linux kernel
LLVM 9
libelf
zlib

Roadmap and contributions

Roadmap is composed from all issues with label "roadmap". If you want contribute to this repo to avoid future conflicts you can describe what are you implementing in a new issue with label "roadmap".

License

Licensed under The MIT License (MIT) https://mit-license.org/.

alexeldeib / rebpf