ipset

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

README

gonetx/ipset

This package is a almost whole Golang wrapper to the ipset userspace utility. It allows Golang programs to easily manipulate ipset.

Visit http://ipset.netfilter.org/ipset.man.html for more ipset command details. And ipset requires version v6.0+.

Installation

Install ipset using the go get command:

go get -u github.com/kiyonlin/gonetx/ipset

Quickstart

package main

import (
	"log"
	"time"

	"github.com/kiyonlin/gonetx/ipset"
)

func init() {
	if err := ipset.Check(); err != nil {
		panic(err)
	}
}

func main() {
	// create test set even it's exist
	set, _ := ipset.New("test", ipset.HashIp, ipset.Exist(true), ipset.Timeout(time.Hour))
	// output: test
	log.Println(set.Name())

	_ = set.Flush()

	_ = set.Add("1.1.1.1", ipset.Timeout(time.Hour))

	ok, _ := set.Test("1.1.1.1")
	// output: true
	log.Println(ok)

	ok, _ = set.Test("1.1.1.2")
	// output: false
	log.Println(ok)

	info, _ := set.List()
	// output: &{test hash:ip 4 family inet hashsize 1024 maxelem 65536 timeout 3600 216 0 [1.1.1.1 timeout 3599]}
	log.Println(info)

	_ = set.Del("1.1.1.1")

	_ = set.Destroy()
}

Check

Before using this library, you should remember always to call ipset.Check first and handle the error. This method will check if ipset is in OS PATH and if its version is valid.

func init() {
	// err will be ipset.ErrNotFound
	// or ipset.ErrVersionNotSupported
	// if check failed.
	if err := ipset.Check(); err != nil {
		panic(err)
	}
}

New

Use ipset.New to create a set identified with setname and specified set type. If the ipset.Exist option is specified, ipset will ignore the error when the same set (setname and create parameters are identical) already exists.

set, _ := ipset.New("test", ipset.HashIp, ipset.Exist(true), ipset.Netmask(24))

Every set type may has different create options, visit SetType and Option for more details.

Once you created a set, you can use these methods:

// IPSet is abstract of ipset
type IPSet interface {
	// List dumps header data and the entries for the set to an
	// *Info instance. The Resolve option can be used to force
	// action lookups(which may be slow).
	List(options ...Option) (*Info, error)

	// List dumps header data and the entries for the set to the
	// specific file. The Resolve option can be used to force
	// action lookups(which may be slow).
	ListToFile(filename string, options ...Option) error

	// Name returns the set's name
	Name() string

	// Rename the set's action and the new action must not exist.
	Rename(newName string) error

	// Add adds a given entry to the set. If the Exist option is
	// specified, ipset ignores the error if the entry already
	// added to the set.
	Add(entry string, options ...Option) error

	// Del deletes an entry from a set. If the Exist option is
	// specified and the entry is not in the set (maybe already
	// expired), then the command ignores the error.
	Del(entry string, options ...Option) error

	// Test tests whether an entry is in a set or not.
	Test(entry string) (bool, error)

	// Flush flushed all entries from the the set.
	Flush() error

	// Destroy removes the set from kernel.
	Destroy() error

	// Save dumps the set data to a io.Reader in a format that restore
	// can read.
	Save(options ...Option) (io.Reader, error)

	// SaveToFile dumps the set data to s specific file in a format
	// that restore can read.
	SaveToFile(filename string, options ...Option) error

	// Restore restores a saved session from io.Reader generated by
	// save. Set exist to true to ignore exist error.
	Restore(r io.Reader, exist ...bool) error

	// RestoreFromFile restores a saved session from a specific file
	// generated by save. Set exist to true to ignore exist error.
	RestoreFromFile(filename string, exist ...bool) error
}

Swap

Use ipset.Swap to swap the content of two sets, or in another words, exchange the action of two sets. The referred sets must exist and compatible type of sets can be swapped only.

ipset.Swap("foo", "bar")

Flush

Use ipset.Flush to flush all entries from the specified set or flush all sets if none is given.

// Flush foo and bar set
ipset.Flush("foo", "bar")

// Flush all
ipset.Flush()

Destroy

Use ipset.Destroy to removes the specified set or all the sets if none is given. If the set has got reference(s), nothing is done and no set destroyed.

// Destroy foo and bar set
ipset.Destroy("foo", "bar")

// Destroy all
ipset.Destroy()

Documentation

Overview

Package ipset is a library providing a wrapper to the iptables ipset user space utility.

Index

Constants

View Source 
const Version = "v1.0.0-alpha.2"

Version of current package

Variables

View Source 
var (

	// ErrNotFound is returned if there is no ipset found in os path
	ErrNotFound = errors.New("ipset utility not found")
	// ErrVersionNotSupported is returned if ipset's version is not bigger than v6.0
	ErrVersionNotSupported = errors.New("ipset utility version is not supported, requiring version >= 6.0")
)

Functions

func Check 

func Check() error

Check checks whether there is an ipset command in the system. If so, check if the version is legal.

func Destroy 

func Destroy(names ...string) error

Destroy removes the specified set or all the sets if none is given. If the set has got reference(s), nothing is done and no set destroyed.

func Flush 

func Flush(names ...string) error

Flush all entries from the specified set or flush all sets if none is given.

func Swap 

func Swap(from, to string) error

Swap swaps the content of two sets, or in another words, exchange the action of two sets. The referred sets must exist and compatible type of sets can be swapped only.

Types

type IPSet 

type IPSet interface {
	// List dumps header data and the entries for the set to an
	// *Info instance. The Resolve option can be used to force
	// action lookups(which may be slow).
	List(options ...Option) (*Info, error)

	// List dumps header data and the entries for the set to the
	// specific file. The Resolve option can be used to force
	// action lookups(which may be slow).
	ListToFile(filename string, options ...Option) error

	// Name returns the set's name
	Name() string

	// Rename the set's action and the new action must not exist.
	Rename(newName string) error

	// Add adds a given entry to the set. If the Exist option is
	// specified, ipset ignores the error if the entry already
	// added to the set.
	Add(entry string, options ...Option) error

	// Del deletes an entry from a set. If the Exist option is
	// specified and the entry is not in the set (maybe already
	// expired), then the command ignores the error.
	Del(entry string, options ...Option) error

	// Test tests whether an entry is in a set or not.
	Test(entry string) (bool, error)

	// Flush flushed all entries from the the set.
	Flush() error

	// Destroy removes the set from kernel.
	Destroy() error

	// Save dumps the set data to a io.Reader in a format that restore
	// can read.
	Save(options ...Option) (io.Reader, error)

	// SaveToFile dumps the set data to s specific file in a format
	// that restore can read.
	SaveToFile(filename string, options ...Option) error

	// Restore restores a saved session from io.Reader generated by
	// save. Set exist to true to ignore exist error.
	Restore(r io.Reader, exist ...bool) error

	// RestoreFromFile restores a saved session from a specific file
	// generated by save. Set exist to true to ignore exist error.
	RestoreFromFile(filename string, exist ...bool) error
}

IPSet is abstract of ipset

func New 

func New(name string, setType SetType, options ...Option) (IPSet, error)

New create a set identified with setname and specified type. The type may require type specific options. If the Exist option is specified, ipset ignores the error when the same set (setname and create parameters are identical) already exists.

type Info 

type Info struct {
	Name string
	SetType
	Revision     int
	Header       string
	SizeInMemory int
	References   int
	Entries      []string
}

Info holds ipset list contents

type NetFamily 

type NetFamily string

NetFamily defines the protocol family of the IP addresses 

const (
	// Inet indicates IPv4
	Inet NetFamily = "inet"
	// Inet6 indicates IPv6
	Inet6 NetFamily = "inet6"
)

type Option 

type Option func(opt *options)

Option is for ipset commands

func Bytes 

func Bytes(b uint) Option

Bytes option is used with Counters option

func Comment 

func Comment(comment bool) Option

Comment option is used for create and add command All set types support the optional comment extension. Enabling this extension on an ipset enables you to annotate an ipset entry with an arbitrary string. This string is completely ignored by both the kernel and ipset itself and is purely for providing a convenient means to document the reason for an entry's existence. Comments must not contain any quotation marks and the usual escape character (\) has no meaning.

For example, the following shell command is illegal: 

ipset add foo 1.1.1.1 comment "this comment is \"bad\""

In the above, your shell will of course escape the quotation marks and ipset will see the quote marks in the argument for the comment, which will result in a parse error. If you are writing your own system, you should avoid creating comments containing a quotation mark if you do not want to break "ipset save" and "ipset restore", nonetheless, the kernel will not stop you from doing so. The following is perfectly acceptable: 

ipset create foo hash:ip comment

ipset add foo 192.168.1.1/24 comment "allow access to SMB share on \\\\fileserv\\"

the above would appear as: "allow access to SMB share on \\fileserv\"

func CommentContent 

func CommentContent(commentContent string) Option

CommentContent is used for add command. And the set must be created with comment option.

func Counters 

func Counters(counters bool) Option

Counters is used for create command. All set types support the optional counters option when creating a set. If the option is specified then the set is created with packet and byte counters per element support. The packet and byte counters are initialized to zero when the elements are (re-)added to the set, unless the packet and byte counter values are explicitly specified by the packets and bytes options. An example when an element is added to a set with non-zero counter values: 

ipset create foo hash:ip counters

ipset add foo 192.168.1.1 packets 42 bytes 1024

func Exist 

func Exist(exist bool) Option

Exist option ignores errors when exactly the same set is to be created or already added entry is added or missing entry is deleted.

func Family 

func Family(family NetFamily) Option

Family option is valid for the create command of all hash type sets except for hash:mac. It defines the protocol family of the IP addresses to be stored in the set. The default is inet, i.e IPv4. Another is inet6, i.e IPv6. For the inet family one can add or delete multiple entries by specifying a range or a network of IPv4 addresses in the IP address part of the entry: 

ipaddr := { ip | fromaddr-toaddr | ip/cidr }

netaddr := { fromaddr-toaddr | ip/cidr }

Example: 

ipset create test hash:ip family inet6

func Forceadd 

func Forceadd(forceadd bool) Option

Forceadd option is supported for all hash set types when creating a set. When sets created with this option become full the next addition to the set may succeed and evict a random entry from the set. 

ipset create foo hash:ip forceadd

func HashSize 

func HashSize(hashSize uint) Option

HashSize option is valid for the create command of all hash type sets. It defines the initial hash size for the set, default is 1024. The hash size must be a power of two, the kernel automatically rounds up non power of two hash sizes to the first correct value. Example: 

ipset create test hash:ip hashsize 1536

func IpRange 

func IpRange(ipRange string) Option

IpRange option should be used with BitmapIp and BitmapIpMac set type. Creating the set from the specified inclusive address range expressed in an IPv4 address range or network. The size of the range cannot exceed the limit of maximum 65536 entries.

func ListSize 

func ListSize(listSize uint) Option

ListSize option is for ListSet set type. It's size of the list, the default is 8.

func Markmask 

func Markmask(markmask uint32) Option

Markmask option is for HashIpMark set type. It allows you to set bits you are interested in the packet mark. This values is then used to perform bitwise AND operation for every mark added. markmask can be any value between 1 and 4294967295, by default all 32 bits are set.

func MaxElem 

func MaxElem(maxElem uint) Option

MaxElem option is valid for the create command of all hash type sets. It does define the maximal number of elements which can be stored in the set, default 65536. Example: 

ipset create test hash:ip maxelem 2048.

func Netmask 

func Netmask(netmask byte) Option

Netmask option is for ip datatype. Network addresses will be stored in the set instead of IP host addresses. The cidr prefix value must be between 1-32 for IPv4 and between 1-128 for IPv6.

func Nomatch 

func Nomatch(nomatch bool) Option

Nomatch option is supported for the hash set types which can store net type of data (i.e. hash:*net*) when adding entries. When matching elements in the set, entries marked as nomatch are skipped as if those were not added to the set, which makes possible to build up sets with exceptions. See the example at hash type hash:net.

When elements are tested by ipset, the nomatch flags are taken into account. If one wants to test the existence of an element marked with nomatch in a set, then the flag must be specified too.

func Packets 

func Packets(packets uint) Option

Packets option is used with Counters option

func PortRange 

func PortRange(portRange string) Option

PortRange option should be used with BitmapPort set type. Creating the set from the specified inclusive port range.

func Resolve 

func Resolve(resolve bool) Option

Resolve option is for listing sets, enforce action lookup. The program will try to display the IP entries resolved to host names which requires slow DNS lookups.

func Skbinfo 

func Skbinfo(skbinfo bool) Option

Skbinfo option is used for create command. All set types support the optional skbinfo extension. This extension allows you to store the metainfo (firewall mark, tc class and hardware queue) with every entry and map it to packets by usage of SET netfilter target with --map-set option. See skbmark, skbprio, skbqueue options for more detail. Example: 

ipset create foo hash:ip skbinfo

ipset add foo skbmark 0x1111/0xff00ffff skbprio 1:10 skbqueue 10

func Skbmark 

func Skbmark(skbmark string) Option

Skbmark option should be used with Skbinfo extension. Its format is: 

MARK or MARK/MASK

where MARK and MASK are 32bit hex numbers with 0x prefix. If only mark is specified mask 0xffffffff are used.

func Skbprio 

func Skbprio(skbprio string) Option

Skbprio option should be used with Skbinfo extension. It has tc class format: 

MAJOR:MINOR

where major and minor numbers are hex without 0x prefix.

func Skbqueue 

func Skbqueue(skbqueue uint) Option

Skbqueue option should be used with Skbinfo extension. It is just decimal number.

func Timeout 

func Timeout(timeout time.Duration) Option

Timeout option is used for create and add command. All set types supports the optional timeout parameter when creating a set and adding entries. The value of the timeout parameter for the create command means the default timeout value (in seconds) for new entries. If a set is created with timeout support, then the same timeout option can be used to specify non-default timeout values when adding entries. The largest possible timeout value is 2147483 seconds.

Zero timeout value means the entry is added permanent to the set. The timeout value of already added elements can be changed by re-adding the element using the -exist option. Example: 

ipset create test hash:ip timeout 300

ipset add test 192.168.0.1 timeout 60

ipset -exist add test 192.168.0.1 timeout 600

When listing the set, the number of entries printed in the header might be larger than the listed number of entries for sets with the timeout extensions: the number of entries in the set is updated when elements added/deleted to the set and periodically when the garbage collector evicts the timed out entries.

type SetType 

type SetType string

SetType indicates a set type comprises of the storage method by which the data is stored and the data type(s) which are stored in the set. Therefore the TYPENAME parameter of the create command follows the syntax 

TYPENAME := method:datatype[,datatype[,datatype]]

where the current list of the methods are 

bitmap, hash, and list

and the possible data types are 

ip, net, mac, port and iface.

The dimension of a set is equal to the number of data types in its type action.

When adding, deleting or testing entries in a set, the same comma separated data syntax must be used for the entry parameter of the commands, i.e 

ipset add foo ipaddr,portnum,ipaddr

If host names or service names with dash in the action are used instead of IP addresses or service numbers, then the host action or service action must be enclosed in square brackets. Example: 

ipset add foo [test-hostname],[ftp-data]

In the case of host names the DNS resolver is called internally by ipset but if it returns multiple IP addresses, only the first one is used.

The bitmap and list types use a fixed sized storage. The hash types use a hash to store the elements. In order to avoid clashes in the hash, a limited number of chaining, and if that is exhausted, the doubling of the hash size is performed when adding entries by the ipset command. When entries added by the SET target of iptables/ip6tables, then the hash size is fixed and the set won't be duplicated, even if the new entry cannot be added to the set. 

const BitmapIp SetType = "bitmap:ip"

BitmapIp set type uses a memory range to store either IPv4 host (default) or IPv4 network addresses. A bitmap:ip type of set can store up to 65536 entries. 

CREATE-OPTIONS := range fromip-toip|ip/cidr
        [ netmask cidr ] [ timeout value ]
        [ counters ] [ comment ] [ skbinfo ]

ADD-ENTRY := { ip | fromip-toip | ip/cidr }

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := { ip | fromip-toip | ip/cidr }

TEST-ENTRY := ip

Mandatory create options: 

range fromip-toip|ip/cidr

Create the set from the specified inclusive address range expressed in an IPv4 address range or network. The size of the range (in entries) cannot exceed the limit of maximum 65536 elements.

Optional create options: 

netmask cidr

When the optional netmask parameter specified, network addresses will be stored in the set instead of IP host addresses. The cidr prefix value must be between 1-32. An IP address will be in the set if the network address, which is resulted by masking the address with the specified netmask, can be found in the set.

The BitmapIp type supports adding or deleting multiple entries in one command.

Examples: 

ipset create foo bitmap:ip range 192.168.0.0/16

ipset add foo 192.168.1/24

ipset test foo 192.168.1.1

const BitmapIpMac SetType = "bitmap:ip,mac"

BitmapIpMac set type uses a memory range to store IPv4 and a MAC address pairs. A BitmapIpMac type of set can store up to 65536 entries. 

CREATE-OPTIONS := range fromip-toip|ip/cidr
    [ timeout value ] [ counters ] [ comment ]
    [ skbinfo ]

ADD-ENTRY := ip[,macaddr]

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := ip[,macaddr]

TEST-ENTRY := ip[,macaddr]

Mandatory options to use when creating a BitmapIpMac type of set: 

range fromip-toip|ip/cidr

Create the set from the specified inclusive address range expressed in an IPv4 address range or network. The size of the range cannot exceed the limit of maximum 65536 entries.

The BitmapIpMac type is exceptional in the sense that the MAC part can be left out when adding/deleting/testing entries in the set. If we add an entry without the MAC address specified, then when the first time the entry is matched by the kernel, it will automatically fill out the missing MAC address with the source MAC address from the packet. If the entry was specified with a timeout value, the timer starts off when the IP and MAC address pair is complete.

The BitmapIpMac type of sets require two src/dst parameters of the set match and SET target netfilter kernel modules and the second one must be src to match, add or delete entries, because the set match and SET target have access to the source MAC address only.

Examples: 

ipset create foo bitmap:ip,mac range 192.168.0.0/16

ipset add foo 192.168.1.1,12:34:56:78:9A:BC

ipset test foo 192.168.1.1

const BitmapPort SetType = "bitmap:port"

BitmapPort set type uses a memory range to store port numbers and such a set can store up to 65536 ports. 

CREATE-OPTIONS := range fromport-toport
[ timeout value ] [ counters ] [ comment ] [ skbinfo ]

ADD-ENTRY := { [proto:]port |
                    [proto:]fromport-toport }

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := { [proto:]port |
                    [proto:]fromport-toport }

TEST-ENTRY := [proto:]port

Mandatory options to use when creating a BitmapPort type of set: 

range [proto:]fromport-toport

Create the set from the specified inclusive port range.

The set match and SET target netfilter kernel modules interpret the stored numbers as TCP or UDP port numbers.

proto only needs to be specified if a service action is used, and that action does not exist as a TCP service.

Examples: 

ipset create foo bitmap:port range 0-1024

ipset add foo 80

ipset test foo 80

ipset del foo udp:[macon-udp]-[tn-tl-w2]

const HashIp SetType = "hash:ip"

HashIp set type uses a hash to store IP host addresses (default) or network addresses. Zero valued IP address cannot be stored in a HashIp type of set. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ netmask cidr ] [ timeout value ]
                  [ counters ] [ comment ] [ skbinfo ]

ADD-ENTRY := ipaddr

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := ipaddr

TEST-ENTRY := ipaddr

Optional create options: 

netmask cidr

When the optional netmask parameter specified, network addresses will be stored in the set instead of IP host addresses. The cidr prefix value must be between 1-32 for IPv4 and between 1-128 for IPv6. An IP address will be in the set if the network address, which is resulted by masking the address with the netmask, can be found in the set. Examples: 

ipset create foo hash:ip netmask 30

ipset add foo 192.168.1.0/24

ipset test foo 192.168.1.2

const HashIpMac SetType = "hash:ip,mac"

HashIpMac set type uses a hash to store IP and a MAC address pairs. Zero valued MAC addresses cannot be stored in a Hash:IpMac type of set. For matches on destination MAC addresses, see COMMENTS below. 

CREATE-OPTIONS  := [ family { inet | inet6 } ] |
                   [ hashsize value ] [ maxelem value ]
                   [ timeout value ] [ counters ]
                   [ comment ] [ skbinfo ]

ADD-ENTRY := ipaddr,macaddr

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := ipaddr,macaddr

TEST-ENTRY := ipaddr,macaddr

Examples: 

ipset create foo hash:ip,mac

ipset add foo 1.1.1.1,01:02:03:04:05:06

ipset test foo 1.1.1.1,01:02:03:04:05:06

const HashIpMark SetType = "hash:ip,mark"

HashIpMark set type uses a hash to store IP address and packet mark pairs. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ markmask value ]
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := ipaddr,mark

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := ipaddr,mark

TEST-ENTRY := ipaddr,mark

Optional create options: 

markmask value

Allows you to set bits you are interested in the packet mark. This values is then used to perform bitwise AND operation for every mark added. markmask can be any value between 1 and 4294967295, by default all 32 bits are set.

The mark can be any value between 0 and 4294967295.

The HashIpMark type of sets require two src/dst parameters of the set match and SET target kernel modules.

Examples: 

ipset create foo hash:ip,mark

ipset add foo 192.168.1.0/24,555

ipset add foo 192.168.1.1,0x63

ipset add foo 192.168.1.1,111236

const HashIpPort SetType = "hash:ip,port"

HashIpPort set type uses a hash to store IP address and port number pairs. The port number is interpreted together with a protocol (default TCP) and zero protocol number cannot be used. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := ipaddr,[proto:]port

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := ipaddr,[proto:]port

TEST-ENTRY := ipaddr,[proto:]port

The [proto:]port part of the elements may be expressed in the following forms, where the range variations are valid when adding or deleting entries: 

portname[-portname]

TCP port or range of ports expressed in TCP portname identifiers from /etc/services 

portnumber[-portnumber]

TCP port or range of ports expressed in TCP port numbers 

tcp|sctp|udp|udplite:portname|
   portnumber[-portname|portnumber]

TCP, SCTP, UDP or UDPLITE port or port range expressed in port action(s) or port number(s) 

icmp:codename|type/code

ICMP codename or type/code. The supported ICMP codename identifiers can always be listed by the help command. 

icmpv6:codename|type/code

ICMPv6 codename or type/code. The supported ICMPv6 codename identifiers can always be listed by the help command. 

proto:0

All other protocols, as an identifier from /etc/protocols or number. The pseudo port number must be zero.

The HashIpPort type of sets require two src/dst parameters of the set match and SET target kernel modules.

Examples: 

ipset create foo hash:ip,port

ipset add foo 192.168.1.0/24,80-82

ipset add foo 192.168.1.1,udp:53

ipset add foo 192.168.1.1,vrrp:0

ipset test foo 192.168.1.1,80

const HashIpPortIp SetType = "hash:ip,port,ip"

HashIpPortIp set type uses a hash to store IP address, port number and a second IP address triples. The port number is interpreted together with a protocol (default TCP) and zero protocol number cannot be used. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := ipaddr,[proto:]port,ip

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := ipaddr,[proto:]port,ip

TEST-ENTRY := ipaddr,[proto:]port,ip

For the first ipaddr and [proto:]port parts of the elements see the descriptions at the hash:ip,port set type.

The hash:ip,port,ip type of sets require three src/dst parameters of the set match and SET target kernel modules.

Examples: 

ipset create foo hash:ip,port,ip

ipset add foo 192.168.1.1,80,10.0.0.1

ipset test foo 192.168.1.1,udp:53,10.0.0.1

const HashIpPortNet SetType = "hash:ip,port,net"

HashIpPortNet set type uses a hash to store IP address, port number and IP network address triples. The port number is interpreted together with a protocol (default TCP) and zero protocol number cannot be used. Network address with zero prefix size cannot be stored either. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := ipaddr,[proto:]port,netaddr

ADD-OPTIONS := [ timeout value ]  [ nomatch ]
               [ packets value ] [ bytes value ]
               [ comment string ] [ skbmark value ]
               [ skbprio value ] [ skbqueue value ]

DEL-ENTRY := ipaddr,[proto:]port,netaddr

TEST-ENTRY := ipaddr,[proto:]port,netaddr

where netaddr := ip[/cidr]

For the ipaddr and [proto:]port parts of the elements see the descriptions at the hash:ip,port set type. For the netaddr part of the elements see the description at the HashNet set type.

From the set netfilter match point of view the searching for a match always starts from the smallest size of netblock (most specific cidr) to the largest one (least specific cidr) added to the set. When adding/deleting triples to the set by the SET netfilter target, it will be added/deleted by the most specific cidr which can be found in the set, or by the host cidr value if the set is empty.

The lookup time grows linearly with the number of the different cidr values added to the set.

The HashIpPortNet type of sets require three src/dst parameters of the set match and SET target kernel modules.

Examples: 

ipset create foo hash:ip,port,net

ipset add foo 192.168.1,80,10.0.0/24

ipset add foo 192.168.2,25,10.1.0.0/16

ipset test foo 192.168.1,80.10.0.0/24

const HashMac SetType = "hash:mac"

HashMac set type uses a hash to store MAC addresses. Zero valued MAC addresses cannot be stored in a HashMac type of set. 

CREATE-OPTIONS := [ hashsize value ]
                  [ maxelem value ] [ timeout value ]
                  [ counters ] [ comment ] [ skbinfo ]

ADD-ENTRY := macaddr

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := macaddr

TEST-ENTRY := macaddr

Examples: 

ipset create foo hash:mac

ipset add foo 01:02:03:04:05:06

ipset test foo 01:02:03:04:05:06

const HashNet SetType = "hash:net"

HashNet set type uses a hash to store different sized IP network addresses. Network address with zero prefix size cannot be stored in this type of sets. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ]
                  [ maxelem value ] [ timeout value ]
                  [ counters ] [ comment ]
                  [ skbinfo ]

ADD-ENTRY := netaddr

ADD-OPTIONS := [ timeout value ] [ nomatch ]
               [ packets value ] [ bytes value ]
               [ comment string ] [ skbmark value ]
               [ skbprio value ] [ skbqueue value ]

DEL-ENTRY := netaddr

TEST-ENTRY := netaddr

where netaddr := ip[/cidr]

When adding/deleting/testing entries, if the cidr prefix parameter is not specified, then the host prefix value is assumed. When adding/deleting entries, the exact element is added/deleted and overlapping elements are not checked by the kernel. When testing entries, if a host address is tested, then the kernel tries to match the host address in the networks added to the set and reports the result accordingly.

From the set netfilter match point of view the searching for a match always starts from the smallest size of netblock (most specific prefix) to the largest one (least specific prefix) added to the set. When adding/deleting IP addresses to the set by the SET netfilter target, it will be added/deleted by the most specific prefix which can be found in the set, or by the host prefix value if the set is empty.

The lookup time grows linearly with the number of the different prefix values added to the set.

Example: 

ipset create foo hash:net

ipset add foo 192.168.0.0/24

ipset add foo 10.1.0.0/16

ipset add foo 192.168.0/24

ipset add foo 192.168.0/30 nomatch

When matching the elements in the set above, all IP addresses will match from the networks 192.168.0.0/24, 10.1.0.0/16 and 192.168.0/24 except the ones from 192.168.0/30. 

const HashNetIface SetType = "hash:net,iface"

HashNetIface set type uses a hash to store different sized IP network address and interface action pairs. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := netaddr,[physdev:]iface

ADD-OPTIONS := [ timeout value ] [ nomatch ]
               [ packets value ] [ bytes value ]
               [ comment string ] [ skbmark value ]
               [ skbprio value ] [ skbqueue value ]

DEL-ENTRY := netaddr,[physdev:]iface

TEST-ENTRY := netaddr,[physdev:]iface

where netaddr := ip[/cidr]

For the netaddr part of the elements see the description at the HashNet set type.

When adding/deleting/testing entries, if the cidr prefix parameter is not specified, then the host prefix value is assumed. When adding/deleting entries, the exact element is added/deleted and overlapping elements are not checked by the kernel. When testing entries, if a host address is tested, then the kernel tries to match the host address in the networks added to the set and reports the result accordingly.

From the set netfilter match point of view the searching for a match always starts from the smallest size of netblock (most specific prefix) to the largest one (least specific prefix) added to the set. When adding/deleting IP addresses to the set by the SET netfilter target, it will be added/deleted by the most specific prefix which can be found in the set, or by the host prefix value if the set is empty.

The second direction parameter of the set match and SET target modules corresponds to the incoming/outgoing interface: src to the incoming one (similar to the -i flag of iptables), while dst to the outgoing one (similar to the -o flag of iptables). When the interface is flagged with physdev:, the interface is interpreted as the incoming or outgoing bridge port.

The lookup time grows linearly with the number of the different prefix values added to the set.

The internal restriction of the hash:net,iface set type is that the same network prefix cannot be stored with more than 64 different interfaces in a single set.

Examples: 

ipset create foo hash:net,iface

ipset add foo 192.168.0/24,eth0

ipset add foo 10.1.0.0/16,eth1

ipset test foo 192.168.0/24,eth0

const HashNetNet SetType = "hash:net,net"

HashNetNet set type uses a hash to store pairs of different sized IP network addresses. Bear in mind that the first parameter has precedence over the second, so a nomatch entry could be potentially be ineffective if a more specific first parameter existed with a suitable second parameter. Network address with zero prefix size cannot be stored in this type of set. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := netaddr,netaddr

ADD-OPTIONS := [ timeout value ] [ nomatch ]
               [ packets value ] [ bytes value ]
               [ comment string ] [ skbmark value ]
               [ skbprio value ] [ skbqueue value ]

DEL-ENTRY := netaddr,netaddr

TEST-ENTRY := netaddr,netaddr

where netaddr := ip[/cidr]

When adding/deleting/testing entries, if the cidr prefix parameter is not specified, then the host prefix value is assumed. When adding/deleting entries, the exact element is added/deleted and overlapping elements are not checked by the kernel. When testing entries, if a host address is tested, then the kernel tries to match the host address in the networks added to the set and reports the result accordingly.

From the set netfilter match point of view the searching for a match always starts from the smallest size of netblock (most specific prefix) to the largest one (least specific prefix) with the first param having precedence. When adding/deleting IP addresses to the set by the SET netfilter target, it will be added/deleted by the most specific prefix which can be found in the set, or by the host prefix value if the set is empty.

The lookup time grows linearly with the number of the different prefix values added to the first parameter of the set. The number of secondary prefixes further increases this as the list of secondary prefixes is traversed per primary prefix.

Example: 

ipset create foo hash:net,net

ipset add foo 192.168.0.0/24,10.0.1.0/24

ipset add foo 10.1.0.0/16,10.255.0.0/24

ipset add foo 192.168.0/24,192.168.54.0-192.168.54.255

ipset add foo 192.168.0/30,192.168.64/30 nomatch

When matching the elements in the set above, all IP addresses will match from the networks 

192.168.0.0/24<->10.0.1.0/24,
10.1.0.0/16<->10.255.0.0/24,
192.168.0/24<->192.168.54.0/24,

except the ones from 

192.168.0/30<->192.168.64/30.

const HashNetPort SetType = "hash:net,port"

HashNetPort set type uses a hash to store different sized IP network address and port pairs. The port number is interpreted together with a protocol (default TCP) and zero protocol number cannot be used. Network address with zero prefix size is not accepted either. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := netaddr,[proto:]port

ADD-OPTIONS := [ timeout value ]  [ nomatch ]
               [ packets value ] [ bytes value ]
               [ comment string ] [ skbmark value ]
               [ skbprio value ] [ skbqueue value ]

DEL-ENTRY := netaddr,[proto:]port

TEST-ENTRY := netaddr,[proto:]port

where netaddr := ip[/cidr]

For the netaddr part of the elements see the description at the HashNet set type. For the [proto:]port part of the elements see the description at the hash:ip,port set type.

When adding/deleting/testing entries, if the cidr prefix parameter is not specified, then the host prefix value is assumed. When adding/deleting entries, the exact element is added/deleted and overlapping elements are not checked by the kernel. When testing entries, if a host address is tested, then the kernel tries to match the host address in the networks added to the set and reports the result accordingly.

From the set netfilter match point of view the searching for a match always starts from the smallest size of netblock (most specific prefix) to the largest one (least specific prefix) added to the set. When adding/deleting IP addresses to the set by the SET netfilter target, it will be added/deleted by the most specific prefix which can be found in the set, or by the host prefix value if the set is empty.

The lookup time grows linearly with the number of the different prefix values added to the set.

Examples: 

ipset create foo hash:net,port

ipset add foo 192.168.0/24,25

ipset add foo 10.1.0.0/16,80

ipset test foo 192.168.0/24,25

const HashNetPortNet SetType = "hash:net,port,net"

HashNetPortNet set type behaves similarly to HashIpPortNet but accepts a cidr value for both the first and last parameter. Either subnet is permitted to be a /0 should you wish to match port between all destinations. 

CREATE-OPTIONS := [ family { inet | inet6 } ] |
                  [ hashsize value ] [ maxelem value ]
                  [ timeout value ] [ counters ]
                  [ comment ] [ skbinfo ]

ADD-ENTRY := netaddr,[proto:]port,netaddr

ADD-OPTIONS := [ timeout value ]  [ nomatch ]
               [ packets value ] [ bytes value ]
               [ comment string ] [ skbmark value ]
               [ skbprio value ] [ skbqueue value ]

DEL-ENTRY := netaddr,[proto:]port,netaddr

TEST-ENTRY := netaddr,[proto:]port,netaddr

where netaddr := ip[/cidr]

For the [proto:]port part of the elements see the description at the hash:ip,port set type. For the netaddr part of the elements see the description at the HashNet set type.

From the set netfilter match point of view the searching for a match always starts from the smallest size of netblock (most specific cidr) to the largest one (least specific cidr) added to the set. When adding/deleting triples to the set by the SET netfilter target, it will be added/deleted by the most specific cidr which can be found in the set, or by the host cidr value if the set is empty. The first subnet has precedence when performing the most-specific lookup, just as for HashNetNet.

The lookup time grows linearly with the number of the different cidr values added to the set and by the number of secondary cidr values per primary.

The HashNetPortNet type of sets require three src/dst parameters of the set match and SET target kernel modules.

Examples: 

ipset create foo hash:net,port,net

ipset add foo 192.168.1.0/24,0,10.0.0/24

ipset add foo 192.168.2.0/24,25,10.1.0.0/16

ipset test foo 192.168.1.1,80,10.0.0.1

const ListSet SetType = "list:set"

ListSet type uses a simple list in which you can store set names. 

CREATE-OPTIONS := [ size value ] [ timeout value ]
                  [ counters ] [ comment ]
                  [ skbinfo ]

ADD-ENTRY := setname [ { before | after } setname ]

ADD-OPTIONS := [ timeout value ] [ packets value ]
               [ bytes value ] [ comment string ]
               [ skbmark value ] [ skbprio value ]
               [ skbqueue value ]

DEL-ENTRY := setname [ { before | after } setname ]

TEST-ENTRY := setname [ { before | after } setname ]

Optional create options: 

size value

The size of the list, the default is 8.

By the ipset command you can add, delete and test set names in a ListSet type of set.

By the set match or SET target of netfilter you can test, add or delete entries in the sets added to the ListSet type of set. The match will try to find a matching entry in the sets and the target will try to add an entry to the first set to which it can be added. The number of direction options of the match and target are important: sets which require more parameters than specified are skipped, while sets with equal or less parameters are checked, elements added/deleted. For example if a and b are ListSet type of sets then in the command 

iptables -m set --match-set a src,dst -j SET
                --add-set b src,dst

the match and target will skip any set in a and b which stores data triples, but will match all sets with single or double data storage in a set and stop matching at the first successful set, and add src to the first single or src,dst to the first double data storage set in b to which the entry can be added. You can imagine a ListSet type of set as an ordered union of the set elements.

Please note: by the ipset command you can add, delete and test the setnames in a ListSet type of set, and not the presence of a set's member (such as an IP address).

Examples: 

ipset create foo hash:ip

ipset create bar hash:ip

ipset create baz hash:ip

ipset create list list:set size 6

ipset add list foo

ipset add list bar after foo

ipset add list baz before bar

Source Files

View all Source files

Directories

Path Synopsis
_examples
advanced
quickstart

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.