ipset

README

ipset

netlink ipset package for Go.

Usage

Your code:

package main

import (
	"log"

	"github.com/nadoo/ipset"
)

func main() {
	// must call Init first
	if err := ipset.Init(); err != nil {
		log.Printf("error in ipset Init: %s", err)
		return
	}

	// default is ipv4 without timeout
	ipset.Destroy("myset")
	ipset.Create("myset")
	ipset.Add("myset", "1.1.1.1")
	ipset.Add("myset", "2.2.2.0/24")

	// ipv6 and timeout example
	ipset.Destroy("myset6")
	// ipset create myset6 hash:net family inet6 timeout 60
	ipset.Create("myset6", ipset.OptIPv6(), ipset.OptTimeout(60))
	ipset.Flush("myset6")

	ipset.Add("myset6", "2404:6800:4005:812::200e", ipset.OptTimeout(10))
	ipset.Add("myset6", "2404:6800:4005:812::/64")
}

Result:

ipset list myset

Name: myset
Type: hash:net
Revision: 1
Header: family inet hashsize 1024 maxelem 65536
Size in memory: 552
References: 0
Number of entries: 2
Members:
1.1.1.1
2.2.2.0/24

ipset list myset6

Name: myset6
Type: hash:net
Revision: 1
Header: family inet6 hashsize 1024 maxelem 65536 timeout 60
Size in memory: 1432
References: 0
Number of entries: 2
Members:
2404:6800:4005:812::/64 timeout 56
2404:6800:4005:812::200e timeout 6

Links

• glider: a forward proxy with ipset management features powered by this package.

Documentation

Index

• func Add(setName, entry string, opts ...Option) (err error)
• func Create(setName string, opts ...Option) (err error)
• func Del(setName, entry string) (err error)
• func Destroy(setName string) (err error)
• func Flush(setName string) (err error)
• func Init() (err error)
• type Option
  • func OptIPv6() Option
  • func OptTimeout(timeout uint32) Option

Functions

func Add

func Add(setName, entry string, opts ...Option) (err error)

Add adds an entry to the named set. entry could be: "1.1.1.1" or "192.168.1.0/24".

func Create

func Create(setName string, opts ...Option) (err error)

Create creates a new set.

func Del

func Del(setName, entry string) (err error)

Del deletes an entry from the named set.

func Destroy

func Destroy(setName string) (err error)

Destroy destroys a named set.

func Flush

func Flush(setName string) (err error)

Flush flushes a named set.

func Init

func Init() (err error)

Init prepares a netlink socket of ipset.

Types

type Option

type Option = netlink.Option

Option is used to set parameters of ipset operations.

func OptIPv6

func OptIPv6() Option

OptIPv6 sets `family inet6` parameter to operations.

func OptTimeout

func OptTimeout(timeout uint32) Option

OptTimeout sets `timeout xx` parameter to operations.