Welcome to libkefir’s documentation!

libkefir /lɪbkəˈfɪər/ – KErnel FIltering Rules

All your filters in one bottle.

Libkefir repository on GitHub

Contents:

• Introduction
  • About libkefir
  • Concepts
  • Additional Resources
• Workflow
  • Filters and BPF program
  • First phase: filter creation
  • Second phase: filter conversion and use
  • Clean up
• API
  • Terminology
  • Rule crafting
  • Filter management
  • Saving and restoring a filter
  • Converting the filter into a C program
  • Compiling to BPF, loading, attaching filters
  • Handling errors
• Building rules in libkefir
  • Building rules
  • Ethtool ntuples filters
  • TC flower
• Internals
  • Structure of a rule
  • Packet matching
  • Filter optimization
  • C program optimization
• Notes about hardware offload
• Roadmap

Examples and tests provided with the library in its GitHub repository are documented in README files located in the respective examples/ and tests/ directories.

Indices and tables

• Index
• Module Index
• Search Page