Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/florianl/go-nflog
c-binding free API for golang to communicate with the log subsystem of netfilter
https://github.com/florianl/go-nflog
golang hacktoberfest kernel netfilter nflog
Last synced: about 12 hours ago
JSON representation
c-binding free API for golang to communicate with the log subsystem of netfilter
- Host: GitHub
- URL: https://github.com/florianl/go-nflog
- Owner: florianl
- License: mit
- Created: 2018-09-11T09:45:48.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T18:15:42.000Z (12 days ago)
- Last Synced: 2024-12-15T06:02:28.515Z (8 days ago)
- Topics: golang, hacktoberfest, kernel, netfilter, nflog
- Language: Go
- Homepage:
- Size: 134 KB
- Stars: 60
- Watchers: 5
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
go-nflog [](https://pkg.go.dev/github.com/florianl/go-nflog/v2) [](https://goreportcard.com/report/github.com/florianl/go-nflog/v2) [](https://github.com/florianl/go-nflog/actions/workflows/go.yml)
============
This is `go-nflog` and it is written in [golang](https://golang.org/). It provides a [C](https://en.wikipedia.org/wiki/C_(programming_language))-binding free API to the netfilter based log subsystem of the [Linux kernel](https://www.kernel.org).
## Example
```golang
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 [](https://pkg.go.dev/github.com/florianl/go-nflog)
## Requirements
* A version of Go that is [supported by upstream](https://golang.org/doc/devel/release.html#policy)