set

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2022 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

A library for managing IP and port nftables sets

Index

Constants

View Source
const (
	// https://datatracker.ietf.org/doc/html/rfc5737#section-3
	InitIPv4 = "192.0.2.1"
	// https://datatracker.ietf.org/doc/html/rfc5156#section-2.6
	InitIPv6 = "2001:0db8:85a3:1:1:8a2e:0370:7334"
	InitPort = "1"
)

Constants used temporarily while initialzing a set

Variables

This section is empty.

Functions

This section is empty.

Types

type ManagedSet

type ManagedSet struct {
	WaitGroup *sync.WaitGroup
	Conn      *nftables.Conn
	Set       *Set
	// contains filtered or unexported fields
}

Represents a set managed by the manager goroutine

func ManagerInit added in v0.0.2

func ManagerInit(wg *sync.WaitGroup, c *nftables.Conn, set *Set, f SetUpdateFunc, interval time.Duration, logger logger.Logger) (ManagedSet, error)

Create a set manager

func (*ManagedSet) Start

func (s *ManagedSet) Start()

Start the set manager goroutine

type Set

type Set struct {
	Set *nftables.Set
}

Set represents an nftables a set on a given table

func New

func New(name string, c *nftables.Conn, table *nftables.Table, keyType nftables.SetDatatype) (Set, error)

Create a new set on a table with a given key type

func (*Set) ClearAndAddElements

func (s *Set) ClearAndAddElements(c *nftables.Conn, newSetData []SetData) error

Remove all elements from the set and then add a list of elements

func (*Set) UpdateElements

func (s *Set) UpdateElements(c *nftables.Conn, newSetData []SetData) error

Compares incoming set elements with existing set elements and adds/removes the differences

type SetData

type SetData struct {
	Port              int
	PortRangeStart    int
	PortRangeEnd      int
	Address           netip.Addr
	AddressRangeStart netip.Addr
	AddressRangeEnd   netip.Addr
	Prefix            netip.Prefix
}

SetData is a struct that is used to create elements of a given set based on the key type of the set

func AddressRangeStringToSetData

func AddressRangeStringToSetData(startString string, endString string) (SetData, error)

Convert a string address range to the SetData type

func AddressStringToSetData

func AddressStringToSetData(addressString string) (SetData, error)

Convert a string address to the SetData type

func AddressStringsToSetData

func AddressStringsToSetData(addressStrings []string) ([]SetData, error)

Convert a list of string addresses to the SetData type

func IPNetToSetData

func IPNetToSetData(net *net.IPNet) (SetData, error)

Convert net.IPNet to the SetData type

func IPNetsToSetData

func IPNetsToSetData(nets []*net.IPNet) ([]SetData, error)

Convert a list of net.IPNet to the SetData type

func IPToSetData

func IPToSetData(ip net.IP) (SetData, error)

Convert net.IP to the SetData type

func IPsToSetData

func IPsToSetData(ips []net.IP) ([]SetData, error)

Convert a list of net.IP to the SetData type

func PortRangeStringToSetData

func PortRangeStringToSetData(startString string, endString string) (SetData, error)

Convert a string port range to the SetData type

func PortStringToSetData

func PortStringToSetData(portString string) (SetData, error)

Convert a string port to the SetData type

func PortStringsToSetData

func PortStringsToSetData(portStrings []string) ([]SetData, error)

Convert a list string ports to the SetData type

func PrefixStringToSetData

func PrefixStringToSetData(prefixString string) (SetData, error)

Convert a string prefix/CIDR to the SetData type

type SetUpdateFunc

type SetUpdateFunc func() ([]SetData, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL