Categorygithub.com/florianl/go-nflog/v2
modulepackage
2.1.0
Repository: https://github.com/florianl/go-nflog.git
Documentation: pkg.go.dev

# README

go-nflog PkgGoDev Go Report Card Go

This is go-nflog and it is written in golang. It provides a C-binding free API to the netfilter based log subsystem of the Linux kernel.

Example

func main() {
	// Send outgoing pings to nflog group 100
	// # sudo iptables -I OUTPUT -p icmp -j NFLOG --nflog-group 100

	//Set configuration parameters
	config := nflog.Config{
		Group:       100,
		Copymode:    nflog.CopyPacket,
	}

	nf, err := nflog.Open(&config)
	if err != nil {
		fmt.Fprintln(os.Stderr, "could not open nflog socket:", err)
		return
	}
	defer nf.Close()

	// Avoid receiving ENOBUFS errors.
	if err := nf.SetOption(netlink.NoENOBUFS, true); err != nil {
		fmt.Fprintf(os.Stderr, "failed to set netlink option %v: %v",
			netlink.NoENOBUFS, err)
		return
	}

	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
	defer cancel()

	// hook that is called for every received packet by the nflog group
	hook := func(attrs nflog.Attribute) int {
		// Just print out the payload of the nflog packet
		fmt.Fprintf(os.Stdout, "%#v\n", attrs.Payload)
		return 0
	}

	// errFunc that is called for every error on the registered hook
	errFunc := func(e error) int {
		// Just log the error and return 0 to continue receiving packets
		fmt.Fprintf(os.Stderr, "received error on hook: %v", e)
		return 0
	}

	// Register your function to listen on nflog group 100
	err = nf.RegisterWithErrorFunc(ctx, hook, errFunc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to register hook function: %v", err)
		return
	}

	// Block till the context expires
	<-ctx.Done()
}

Privileges

This package processes information directly from the kernel and therefore it requires special privileges. You can provide this privileges by adjusting the CAP_NET_ADMIN capabilities.

	setcap 'cap_net_admin=+ep' /your/executable

For documentation and more examples please take a look at PkgGoDev

Requirements

# Functions

Open a connection to the netfilter log subsystem.

# Constants

Various constants.
Available copy modes for Config.Copymode.
Provides a complete copy of the packet in the Msg map.
Requires Kernel configuration of CONFIG_NETFILTER_NETLINK_GLUE_CT.
Various constants.
Flags that can be set on a connection.
Various optional settings.

# Variables

Various errors.
Various errors.

# Structs

Attribute contains various elements for nflog elements.
Config contains options for a Conn.
Nflog represents a netfilter log handler.
VLAN holds the VLAN information.

# Interfaces

Logger provides logging functionality.

# Type aliases

ErrorFunc is a function that receives all errors that happen while reading from a Netlinkgroup.
HookFunc is a function, that receives events from a Netlinkgroup To stop receiving messages on this HookFunc, return something different than 0.