github.com/ti-mo/conntrack@v0.5.0/README.md (about)

     1  # conntrack [![GoDoc](https://godoc.org/github.com/ti-mo/conntrack?status.svg)](https://godoc.org/github.com/ti-mo/conntrack) ![Tests Status](https://github.com/ti-mo/conntrack/actions/workflows/linux-integration-test.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/ti-mo/conntrack/badge.svg?branch=master)](https://coveralls.io/github/ti-mo/conntrack?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/ti-mo/conntrack)](https://goreportcard.com/report/github.com/ti-mo/conntrack)
     2  
     3  Package `conntrack` implements the Conntrack subsystem of the Netfilter (Netlink) protocol family.
     4  The package is intended to be clear, user-friendly, thoroughly tested and easy to understand.
     5  
     6  It is purely written in Go, without any dependency on Cgo or any C library, kernel headers
     7  or userspace tools.  It uses a native Netlink implementation (https://github.com/mdlayher/netlink)
     8  and does not parse or scrape any output of the `conntrack` command.
     9  
    10  It is designed in a way that makes the user acquainted with the structure of the protocol,
    11  with a clean separation between the Conntrack types/attributes and the Netfilter layer (implemented
    12  in https://github.com/ti-mo/netfilter).
    13  
    14  All Conntrack attributes known to the kernel up until version 4.17 are implemented. There is experimental
    15  support for manipulating Conntrack 'expectations', beside listening and dumping. The original focus of the
    16  package was receiving Conntrack events over Netlink multicast sockets, but was since expanded to be a full
    17  implementation supporting queries.
    18  
    19  ## Features
    20  
    21  With this library, the user can:
    22  
    23  - Interact with conntrack connections and expectations through Flow and Expect types respectively
    24  - Create, get, update and delete Flows in an idiomatic way (and Expects, to an extent)
    25  - Listen for create/update/destroy events
    26  - Flush (empty) and dump (display) the whole conntrack table, optionally filtering on specific connection marks
    27  
    28  There are many usage examples in the [godoc](https://godoc.org/github.com/ti-mo/conntrack).
    29  
    30  ## Contributing
    31  
    32  Contributions are absolutely welcome! Before starting work on large changes, please create an issue first,
    33  or join #networking on Gophers Slack to discuss the design.
    34  
    35  If you encounter a problem implementing the library, please open a GitHub issue for help.