set

Documentation

Overview

A library for managing IP and port nftables sets

Index

• func NetipAddrPortToSetData(addrport netip.AddrPort) (SetData, SetData, error)
• func NetipAddrPortsToSetData(addrports []netip.AddrPort) ([]SetData, []SetData, error)
• type ManagedSet
  • func ManagerInit(set Set, f SetUpdateFunc, interval time.Duration, logger logger.Logger, ...) (ManagedSet, error)
  • func (s *ManagedSet) Set() Set
  • func (s *ManagedSet) Start(ctx context.Context) error
• type Set
  • func New(c *nftables.Conn, table *nftables.Table, name string, ...) (Set, error)
  • func (s *Set) ClearAndAddElements(c *nftables.Conn, newSetData []SetData) error
  • func (s *Set) Elements(c *nftables.Conn) ([]SetData, error)
  • func (s *Set) Set() *nftables.Set
  • func (s *Set) UpdateElements(c *nftables.Conn, newSetData []SetData) (bool, int, int, error)
• type SetData
  • func AddressBytesToSetData(start []byte, end []byte) (SetData, error)
  • func AddressRangeStringToSetData(startString string, endString string) (SetData, error)
  • func AddressStringToSetData(addressString string) (SetData, error)
  • func AddressStringsToSetData(addressStrings []string) ([]SetData, error)
  • func NetIPNetToSetData(net *net.IPNet) (SetData, error)
  • func NetIPNetsToSetData(nets []*net.IPNet) ([]SetData, error)
  • func NetIPToSetData(ip net.IP) (SetData, error)
  • func NetIPsToSetData(ips []net.IP) ([]SetData, error)
  • func NetipAddrToSetData(ip netip.Addr) (SetData, error)
  • func NetipAddrsToSetData(ips []netip.Addr) ([]SetData, error)
  • func NetipPrefixToSetData(prefix netip.Prefix) (SetData, error)
  • func NetipPrefixesToSetData(prefixes []netip.Prefix) ([]SetData, error)
  • func PortBytesToSetData(start []byte, end []byte) (SetData, error)
  • func PortRangeStringToSetData(startString string, endString string) (SetData, error)
  • func PortStringToSetData(portString string) (SetData, error)
  • func PortStringsToSetData(portStrings []string) ([]SetData, error)
  • func PrefixStringToSetData(prefixString string) (SetData, error)
  • func (s SetData) Counters() (*uint64, *uint64, error)
• type SetUpdateFunc

Functions

func NetipAddrPortToSetData

func NetipAddrPortToSetData(addrport netip.AddrPort) (SetData, SetData, error)

Convert netip.AddrPort to SetData type, returns a address and a port

func NetipAddrPortsToSetData

func NetipAddrPortsToSetData(addrports []netip.AddrPort) ([]SetData, []SetData, error)

Convert a list of netip.AddrPort to SetData type, returns a list of addresses and a list of ports

Types

type ManagedSet

type ManagedSet struct {
	// contains filtered or unexported fields
}

Represents a set managed by the manager goroutine

func ManagerInit

func ManagerInit(set Set, f SetUpdateFunc, interval time.Duration, logger logger.Logger, metrics m.Metrics) (ManagedSet, error)

Create a set manager. Passing a nil metrics object is safe and will result in the "NoOp" client being used.

func (*ManagedSet) Set

func (s *ManagedSet) Set() Set

Get the set this manager is operating on

func (*ManagedSet) Start

func (s *ManagedSet) Start(ctx context.Context) error

Start the set manager goroutine

type Set

type Set struct {
	// contains filtered or unexported fields
}

Set represents an nftables a set on a given table

func New

func New(c *nftables.Conn, table *nftables.Table, name string, 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) Elements

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

Get all elements associated with this Set

func (*Set) Set

func (s *Set) Set() *nftables.Set

Get the nftables set associated with this Set

func (*Set) UpdateElements

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

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

First return value is true if the set was modified, false if there were no updates. The second and third return values indicate the number of values added and removed from the set, respectively.

type SetData

type SetData struct {
	Port              uint16
	PortRangeStart    uint16
	PortRangeEnd      uint16
	Address           netip.Addr
	AddressRangeStart netip.Addr
	AddressRangeEnd   netip.Addr
	Prefix            netip.Prefix
	// contains filtered or unexported fields
}

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

func AddressBytesToSetData

func AddressBytesToSetData(start []byte, end []byte) (SetData, error)

Convert start and end address bytes to SetData type

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 NetIPNetToSetData

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

Convert net.IPNet to the SetData type

func NetIPNetsToSetData

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

Convert a list of net.IPNet to the SetData type

func NetIPToSetData

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

Convert net.IP to the SetData type

func NetIPsToSetData

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

Convert a list of net.IP to the SetData type

func NetipAddrToSetData

func NetipAddrToSetData(ip netip.Addr) (SetData, error)

Convert netip.Addr to SetData type

func NetipAddrsToSetData

func NetipAddrsToSetData(ips []netip.Addr) ([]SetData, error)

Convert a list of netip.Addr to SetData type

func NetipPrefixToSetData

func NetipPrefixToSetData(prefix netip.Prefix) (SetData, error)

Convert netip.Prefix to SetData type

func NetipPrefixesToSetData

func NetipPrefixesToSetData(prefixes []netip.Prefix) ([]SetData, error)

Convert a list of netip.Prefix to SetData type

func PortBytesToSetData

func PortBytesToSetData(start []byte, end []byte) (SetData, error)

Convert start and end port bytes to 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

func (SetData) Counters

func (s SetData) Counters() (*uint64, *uint64, error)

Returns counters contained in SetData if they exist

type SetUpdateFunc

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