Simple netlink library for go.
Go to file
2024-04-10 11:27:34 -07:00
.github add build on macOS test 2022-01-25 13:50:16 -06:00
cmd/ipset-test Support ipset test entry existence 2023-04-20 10:46:28 -07:00
nl Add zone filter to conntrack 2024-04-10 11:23:27 -07:00
testdata Add support for ipset 2020-09-24 21:36:22 -04:00
.gitignore Add support for additional TC BPF filter attributes 2019-07-01 11:37:39 -07:00
addr_linux.go Allow link argument to AddrAdd, AddReplace and AddrDel to be nil 2024-03-04 10:50:31 -08:00
addr_test.go Allow link argument to AddrAdd, AddReplace and AddrDel to be nil 2024-03-04 10:50:31 -08:00
addr.go Add LinkIndex to Addr struct 2020-06-03 11:20:50 -07:00
bpf_linux.go lwtunnel: add support for encap type bpf 2021-07-03 11:44:22 +02:00
bridge_linux_test.go bridge: add/del vlan range 2024-03-04 10:45:37 -08:00
bridge_linux.go bridge: add/del vlan range 2024-03-04 10:45:37 -08:00
chain_linux.go Implement chains support 2022-12-14 10:59:49 -08:00
chain_test.go Implement chains support 2022-12-14 10:59:49 -08:00
chain.go Implement chains support 2022-12-14 10:59:49 -08:00
CHANGELOG.md Add changelog file, initial release tagging 2018-03-15 21:46:22 -07:00
class_linux.go enable rule statistic and time statistic for flower actions 2023-11-27 10:42:39 -08:00
class_test.go Add support for TCA_NETEM_RATE64 in Netem qdisc 2024-03-31 17:34:55 -07:00
class.go enable rule statistic and time statistic for flower actions 2023-11-27 10:42:39 -08:00
conntrack_linux.go Add zone filter to conntrack 2024-04-10 11:23:27 -07:00
conntrack_test.go Add zone filter to conntrack 2024-04-10 11:23:27 -07:00
conntrack_unspecified.go
devlink_linux.go Add functions to work with devlink device parameters 2024-02-12 10:28:25 -08:00
devlink_test.go Add functions to work with devlink device parameters 2024-02-12 10:28:25 -08:00
filter_linux.go Allow a Police to be specified directly on a U32 filter 2024-04-10 11:27:34 -07:00
filter_test.go Allow a Police to be specified directly on a U32 filter 2024-04-10 11:27:34 -07:00
filter.go enable rule statistic and time statistic for flower actions 2023-11-27 10:42:39 -08:00
fou_linux.go code simplification 2018-11-19 16:40:56 -08:00
fou_test.go Fix go build issue for fou code 2017-11-27 11:05:30 -08:00
fou_unspecified.go added support for Foo-over-UDP netlink calls 2017-11-13 12:13:59 -08:00
fou.go Netlink: Fix Darwin build 2018-07-30 08:32:48 -07:00
genetlink_linux.go genetlink: Add missing error check 2018-11-30 08:41:18 -08:00
genetlink_unspecified.go Add support for generic netlink 2017-05-06 23:07:19 -07:00
go.mod go.mod: bump golang.org/x/sys to v0.10.0 2023-07-05 17:42:06 +02:00
go.sum go.mod: bump golang.org/x/sys to v0.10.0 2023-07-05 17:42:06 +02:00
gtp_linux.go replace syscall with golang.org/x/sys/unix 2017-10-26 09:45:08 -07:00
gtp_test.go Add support for GPRS Tunnelling Protocol(GTP) 2017-05-06 23:07:19 -07:00
handle_linux_test.go Provide handle Close() and deprecate Delete() 2021-09-18 09:03:48 -07:00
handle_linux.go Add SetStrictCheck() method to NetlinkHandle 2022-03-29 11:15:07 -05:00
handle_test.go fix staticcheck issues 2021-09-21 09:10:48 -05:00
handle_unspecified.go Add RouteChange API 2024-02-26 09:50:43 -08:00
inet_diag.go Implement UDP socket diagnostics 2024-01-26 09:08:48 -08:00
ioctl_linux.go link, veth: fix stack corruption from retrieving peer index 2019-11-13 10:31:03 -08:00
ipset_linux_test.go Support ipset test entry existence 2023-04-20 10:46:28 -07:00
ipset_linux.go Support ipset test entry existence 2023-04-20 10:46:28 -07:00
LICENSE
link_linux.go Add field for permanent hardware address 2024-03-29 14:43:07 -07:00
link_test.go link: add INNER_PROTO_INHERIT support for Geneve 2024-03-20 14:21:27 -07:00
link_tuntap_linux.go
link.go Add field for permanent hardware address 2024-03-29 14:43:07 -07:00
Makefile Properly use Skip() function, add -test.v when running tests 2017-11-08 03:30:16 -08:00
neigh_linux.go Change behavior of Subscribe to non-blocking. Fix test. 2024-03-01 13:38:14 -08:00
neigh_test.go Provide handle Close() and deprecate Delete() 2021-09-18 09:03:48 -07:00
neigh.go Add support for NDA_FLAGS_EXT neighboring attribute 2021-11-01 11:31:57 -05:00
netlink_linux.go
netlink_test.go Add support for VDPA devices management 2024-01-29 10:29:44 -08:00
netlink_unspecified.go Added SocketDestroy function. 2024-03-28 11:51:11 -07:00
netlink.go Reduce allocations 2018-10-29 15:31:34 -07:00
netns_linux.go fix staticcheck issues 2021-09-21 09:10:48 -05:00
netns_test.go fix staticcheck issues 2021-09-21 09:10:48 -05:00
netns_unspecified.go Add network namespace ID management. 2018-07-19 10:40:23 -07:00
order.go
proc_event_linux.go Change behavior of Subscribe to non-blocking. Fix test. 2024-03-01 13:38:14 -08:00
proc_event_test.go Fix darwin target compilation 2022-01-25 13:50:16 -06:00
protinfo_linux.go add support for bridge port neighbor suppression 2023-09-21 20:24:56 -07:00
protinfo_test.go add support for bridge port neighbor suppression 2023-09-21 20:24:56 -07:00
protinfo.go add support for bridge port neighbor suppression 2023-09-21 20:24:56 -07:00
qdisc_linux.go Add support for TCA_NETEM_RATE64 in Netem qdisc 2024-03-31 17:34:55 -07:00
qdisc_test.go qdisc: add statistics for qdisc 2024-03-01 12:50:42 -08:00
qdisc.go Add support for TCA_NETEM_RATE64 in Netem qdisc 2024-03-31 17:34:55 -07:00
rdma_link_linux.go rdma: support rdma link add/del functionality 2021-09-18 10:31:51 -07:00
rdma_link_test.go fix staticcheck issues 2021-09-21 09:10:48 -05:00
README.md fix badge 2022-01-12 16:57:20 -06:00
route_linux.go Fix RouteListFiltered when using FAMILY_ALL 2024-04-03 06:56:43 -07:00
route_test.go Fix RouteListFiltered when using FAMILY_ALL 2024-04-03 06:56:43 -07:00
route_unspecified.go Fix non-linux build 2021-03-16 07:45:50 -07:00
route.go RouteUpdate gains NlFlags field 2024-03-01 13:06:15 -08:00
rule_linux.go Linux rule list results have Family populated 2023-07-28 08:26:29 -07:00
rule_test.go Linux rule list results have Family populated 2023-07-28 08:26:29 -07:00
rule.go rule: add support for FRA_PROTOCOL 2023-03-16 09:30:32 -07:00
socket_linux_test.go SocketDiagTCPInfo: Add support for BBR information 2020-11-26 10:01:29 -08:00
socket_linux.go SocketGet support udp and ipv6 2024-03-29 09:33:44 -07:00
socket_test.go SocketGet support udp and ipv6 2024-03-29 09:33:44 -07:00
socket.go Implement unix socket diagnostics 2024-02-21 09:21:27 -08:00
tcp_linux_test.go SocketDiagTCPInfo: Add support for BBR information 2020-11-26 10:01:29 -08:00
tcp_linux.go Implement UDP socket diagnostics 2024-01-26 09:08:48 -08:00
tcp.go Implement UDP socket diagnostics 2024-01-26 09:08:48 -08:00
unix_diag.go Implement unix socket diagnostics 2024-02-21 09:21:27 -08:00
vdpa_linux_test.go Add support for VDPA devices management 2024-01-29 10:29:44 -08:00
vdpa_linux.go Add support for VDPA devices management 2024-01-29 10:29:44 -08:00
virtio.go Add support for VDPA devices management 2024-01-29 10:29:44 -08:00
xfrm_linux.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00
xfrm_monitor_linux_test.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00
xfrm_monitor_linux.go Change behavior of Subscribe to non-blocking. Fix test. 2024-03-01 13:38:14 -08:00
xfrm_policy_linux_test.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00
xfrm_policy_linux.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00
xfrm_state_linux_test.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00
xfrm_state_linux.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00
xfrm_unspecified.go Make xfrm linux-only 2023-10-24 10:58:52 -07:00

netlink - netlink library for go

Build Status GoDoc

The netlink package provides a simple netlink library for go. Netlink is the interface a user-space program in linux uses to communicate with the kernel. It can be used to add and remove interfaces, set ip addresses and routes, and configure ipsec. Netlink communication requires elevated privileges, so in most cases this code needs to be run as root. Since low-level netlink messages are inscrutable at best, the library attempts to provide an api that is loosely modeled on the CLI provided by iproute2. Actions like ip link add will be accomplished via a similarly named function like AddLink(). This library began its life as a fork of the netlink functionality in docker/libcontainer but was heavily rewritten to improve testability, performance, and to add new functionality like ipsec xfrm handling.

Local Build and Test

You can use go get command:

go get github.com/vishvananda/netlink

Testing dependencies:

go get github.com/vishvananda/netns

Testing (requires root):

sudo -E go test github.com/vishvananda/netlink

Examples

Add a new bridge and add eth1 into it:

package main

import (
    "fmt"
    "github.com/vishvananda/netlink"
)

func main() {
    la := netlink.NewLinkAttrs()
    la.Name = "foo"
    mybridge := &netlink.Bridge{LinkAttrs: la}
    err := netlink.LinkAdd(mybridge)
    if err != nil  {
        fmt.Printf("could not add %s: %v\n", la.Name, err)
    }
    eth1, _ := netlink.LinkByName("eth1")
    netlink.LinkSetMaster(eth1, mybridge)
}

Note NewLinkAttrs constructor, it sets default values in structure. For now it sets only TxQLen to -1, so kernel will set default by itself. If you're using simple initialization(LinkAttrs{Name: "foo"}) TxQLen will be set to 0 unless you specify it like LinkAttrs{Name: "foo", TxQLen: 1000}.

Add a new ip address to loopback:

package main

import (
    "github.com/vishvananda/netlink"
)

func main() {
    lo, _ := netlink.LinkByName("lo")
    addr, _ := netlink.ParseAddr("169.254.169.254/32")
    netlink.AddrAdd(lo, addr)
}

Future Work

Many pieces of netlink are not yet fully supported in the high-level interface. Aspects of virtually all of the high-level objects don't exist. Many of the underlying primitives are there, so its a matter of putting the right fields into the high-level objects and making sure that they are serialized and deserialized correctly in the Add and List methods.

There are also a few pieces of low level netlink functionality that still need to be implemented. Routing rules are not in place and some of the more advanced link types. Hopefully there is decent structure and testing in place to make these fairly straightforward to add.