suricata/plugins/pfring

PF_RING Plugin Capture Plugin

Building

To build this plugin, built Suricata with the --enable-pfring and optionally the --with-libpfring-includes and --with-libpfring-libraries command line options.

Running

/usr/local/suricata/bin/suricata \
    --plugin /usr/local/lib/suricata/pfring.so \
    --capture-plugin=pfring \
    --set pfring.0.interface=eno1

--plugin /usr/local/lib/suricata/pfring.so

This command line option tells Suricata about this plugin in addition to any plugins listed in suricata.yaml. This could also be done in suricata.yaml with the following section:

plugins:
  - /usr/local/lib/suricata/pfring.so

--capture-plugin=pfring-plugin

This is the option that tells Suricata to use a plugin for capture, much like --pcap tells Suricata to use libpcap or --af-packet tells Suricata to use AF_PACKET. Here we are telling it to look for a loaded plugin of the name pfring-plugin to provide the capture method.

--set pfring.0.interface=eno1

This is just overriding the interface name in the example pfring configuration found in the default suricata.yaml, which this plugin knows how to read already as its based off the PF_RING support in Suricata proper.

There is another command line option --capture-plugin-args to pass arbitrary data on the command line a capture plugin, but this plugin does not yet handle data provided through this command line parameter.