Simple netlink library for go.
Go to file
Eugene Yakubovich 0e908ca36d Fallback to LinkList on LinkByName when needed
Older kernels (e.g. one shipped with RHEL 6.5) don't
support RTM_GETLINK with IFLA_IFNAME. In these cases
fallback to dumping all interfaces and filtering
in userspace.
2014-10-28 14:15:07 -07:00
nl arp and vxlan support added 2014-10-13 11:04:09 -07:00
addr_linux.go Make links have different types 2014-09-24 16:32:16 -07:00
addr_test.go Convert syscall.AF_INET to FAMILY_V4 2014-09-17 09:33:53 -07:00
addr.go Convert addr and xfrm to use IPNet pointers 2014-09-07 11:27:46 -07:00
LICENSE Initial commit of netlink package 2014-08-31 20:34:46 -07:00
link_linux.go Fallback to LinkList on LinkByName when needed 2014-10-28 14:15:07 -07:00
link_test.go avoid dumping all interfaces to look up one 2014-10-13 18:07:39 -07:00
link.go arp and vxlan support added 2014-10-13 11:04:09 -07:00
neigh_linux.go Use LinkIndex instead of Link obj in Route, Neigh 2014-10-13 16:09:09 -07:00
neigh_test.go Use LinkIndex instead of Link obj in Route, Neigh 2014-10-13 16:09:09 -07:00
neigh.go Use LinkIndex instead of Link obj in Route, Neigh 2014-10-13 16:09:09 -07:00
netlink_test.go Move all low level calls into nl subpackage 2014-09-18 19:04:48 -07:00
netlink_unspecified.go arp and vxlan support added 2014-10-13 11:04:09 -07:00
netlink.go Move all low level calls into nl subpackage 2014-09-18 19:04:48 -07:00
README.md Typo in README 2014-09-23 15:32:47 -04:00
route_linux.go Use LinkIndex instead of Link obj in Route, Neigh 2014-10-13 16:09:09 -07:00
route_test.go Use LinkIndex instead of Link obj in Route, Neigh 2014-10-13 16:09:09 -07:00
route.go Use LinkIndex instead of Link obj in Route, Neigh 2014-10-13 16:09:09 -07:00
xfrm_policy_linux.go Move all low level calls into nl subpackage 2014-09-18 19:04:48 -07:00
xfrm_policy_test.go Initial commit of netlink package 2014-08-31 20:34:46 -07:00
xfrm_policy.go Add support for more xfrm policy dir values 2014-09-15 17:03:37 -07:00
xfrm_state_linux.go Move all low level calls into nl subpackage 2014-09-18 19:04:48 -07:00
xfrm_state_test.go Initial commit of netlink package 2014-08-31 20:34:46 -07:00
xfrm_state.go Add support for XfrmState Encapsulation 2014-09-15 17:05:35 -07:00
xfrm.go Formatting cleanup 2014-09-15 17:06:08 -07:00

netlink - netlink library for go

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 provied 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/vishvananada/netlink"
)

func main() {
    mybridge := &netlink.Link{Name: "mybridge", Type: "bridge"}
    netlink, _ := netlink.LinkAdd(mybridge)
    eth1, _ := netlink.LinkByName("eth1")
    netlink.LinkSetMaster(eth1, mybridge)
}

Add a new ip address to loopback:

package main

import (
    "net"
    "github.com/vishvananada/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.