Simple netlink library for go.
Go to file
Taku Fukushima 1b53666767 Add class ID parsing to parseU32Data
This patch adds a new switch case that handles the class ID attribute of
the U32 filter data listed by FilterList. Without this case block the
class ID of the U32 filter is always set to zero. The new test
conditions are added to TestFilterAddDel and TestFilterU32BpfAddDel in
filter_test.go as well.

Signed-off-by: Taku Fukushima <taku@soracom.jp>
2017-04-05 14:49:35 -07:00
nl Set SOCK_CLOEXEC when creating netlink socket 2017-03-29 10:46:00 -07:00
.travis.yml
LICENSE
Makefile Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
README.md
addr.go Broadcast address can be specified when adding address. 2017-02-02 13:05:14 -08:00
addr_linux.go Add AddrReplace 2017-03-31 10:10:22 -07:00
addr_test.go Add AddrReplace 2017-03-31 10:10:22 -07:00
bpf_linux.go Add support for xdp set/get of a bpf program (#156) 2016-08-25 11:08:23 -07:00
class.go
class_linux.go
class_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
filter.go filter: fix recursive string call (#162) 2016-08-25 11:08:35 -07:00
filter_linux.go Add class ID parsing to parseU32Data 2017-04-05 14:49:35 -07:00
filter_test.go Add class ID parsing to parseU32Data 2017-04-05 14:49:35 -07:00
handle_linux.go Allow setting socket timeout on Handle 2016-11-15 11:01:07 -08:00
handle_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
handle_unspecified.go Implement handle on non-linux platforms 2016-12-19 10:14:29 -08:00
link.go Return 64 bits link statistics 2017-01-17 08:21:17 -08:00
link_linux.go Add LinkSetARPOff and LinkSetARPOn 2017-03-21 02:39:47 -07:00
link_test.go Add LinkSetARPOff and LinkSetARPOn 2017-03-21 02:39:47 -07:00
link_tuntap_linux.go
neigh.go
neigh_linux.go Add proxy support to the neighbor functions (#149) 2016-08-23 16:01:24 -07:00
neigh_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
netlink.go Add support for tcp diags. 2017-02-04 16:48:17 -08:00
netlink_linux.go support MPLS 2017-02-20 12:07:19 -08:00
netlink_test.go support MPLS 2017-02-20 12:07:19 -08:00
netlink_unspecified.go Mended LinkSetMaster signature mismatch 2017-03-29 10:07:30 -07:00
order.go Add support for tcp diags. 2017-02-04 16:48:17 -08:00
protinfo.go protinfo: return value of evaluated expression 2016-12-13 10:57:44 -08:00
protinfo_linux.go Parse IFLA_PROTINFO in LinkDeserialize 2016-12-02 16:05:43 -08:00
protinfo_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
qdisc.go Add support for peakrate and minburst. 2017-02-08 10:29:21 -08:00
qdisc_linux.go Add support for peakrate and minburst. 2017-02-08 10:29:21 -08:00
qdisc_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
route.go support MPLS 2017-02-20 12:07:19 -08:00
route_linux.go support MPLS 2017-02-20 12:07:19 -08:00
route_test.go support MPLS 2017-02-20 12:07:19 -08:00
route_unspecified.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
rule.go
rule_linux.go Fix bug in ruleHandle: allocate different buffers for each rtattr 2016-11-03 19:48:18 -07:00
rule_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
socket.go Add support for tcp diags. 2017-02-04 16:48:17 -08:00
socket_linux.go Add support for tcp diags. 2017-02-04 16:48:17 -08:00
socket_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
xfrm.go
xfrm_monitor_linux.go Add XfrmMonitor 2017-02-02 12:58:44 -08:00
xfrm_monitor_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
xfrm_policy.go
xfrm_policy_linux.go
xfrm_policy_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00
xfrm_state.go Add support of ESN 2017-02-03 08:10:37 -08:00
xfrm_state_linux.go Add support of ESN 2017-02-03 08:10:37 -08:00
xfrm_state_test.go Fix compilation errors for non linux platforms. 2017-02-20 12:00:54 -08:00

README.md

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 (
    "net"
    "github.com/vishvananda/netlink"
)

func main() {
    la := netlink.NewLinkAttrs()
    la.Name = "foo"
    mybridge := &netlink.Bridge{la}}
    _ := netlink.LinkAdd(mybridge)
    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 (
    "net"
    "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.