2019-09-05 15:35:13 +02:00
|
|
|
# netlink [](https://builds.sr.ht/~mdlayher/netlink?) [](https://godoc.org/github.com/mdlayher/netlink) [](https://goreportcard.com/report/github.com/mdlayher/netlink)
|
2017-01-09 20:33:55 +01:00
|
|
|
|
|
|
|
|
Package `netlink` provides low-level access to Linux netlink sockets.
|
|
|
|
|
MIT Licensed.
|
|
|
|
|
|
2017-11-02 12:30:34 +01:00
|
|
|
For more information about how netlink works, check out my blog series
|
2019-09-05 15:35:13 +02:00
|
|
|
on [Linux, Netlink, and Go](https://mdlayher.com/blog/linux-netlink-and-go-part-1-netlink/).
|
2017-11-02 12:30:34 +01:00
|
|
|
|
2019-09-05 15:35:13 +02:00
|
|
|
If you have any questions or you'd like some guidance, please join us on
|
|
|
|
|
[Gophers Slack](https://invite.slack.golangbridge.org) in the `#networking`
|
|
|
|
|
channel!
|
2017-11-02 12:30:34 +01:00
|
|
|
|
2019-09-05 15:35:13 +02:00
|
|
|
## Stability
|
|
|
|
|
|
|
|
|
|
At this time, package `netlink` is in a pre-v1.0.0 state. Changes are being made
|
|
|
|
|
which may impact the exported API of this package and others in its ecosystem.
|
|
|
|
|
To follow along on the status of a v1.0.0 release, [see the associated issue](https://github.com/mdlayher/netlink/issues/123).
|
|
|
|
|
|
|
|
|
|
The general policy of this package is to only support the latest, stable version
|
|
|
|
|
of Go. Compatibility shims may be added for prior versions of Go on an as-needed
|
|
|
|
|
basis. If you would like to raise a concern, please [file an issue](https://github.com/mdlayher/netlink/issues/new).
|
|
|
|
|
|
|
|
|
|
**If you depend on this package in your applications, please vendor it or use Go
|
|
|
|
|
modules when building your application.**
|
|
|
|
|
|
|
|
|
|
## Design
|
2017-01-09 20:33:55 +01:00
|
|
|
|
|
|
|
|
A [number of netlink packages](https://godoc.org/?q=netlink) are already
|
|
|
|
|
available for Go, but I wasn't able to find one that aligned with what
|
|
|
|
|
I wanted in a netlink package:
|
|
|
|
|
|
2019-09-05 15:35:13 +02:00
|
|
|
- Straightforward, idiomatic API
|
2017-01-09 20:33:55 +01:00
|
|
|
- Well tested
|
|
|
|
|
- Well documented
|
2019-09-05 15:35:13 +02:00
|
|
|
- Doesn't use package/global variables or state
|
|
|
|
|
- Doesn't necessarily need root to work
|
2017-01-09 20:33:55 +01:00
|
|
|
|
|
|
|
|
My goal for this package is to use it as a building block for the creation
|
2017-11-02 12:30:34 +01:00
|
|
|
of other netlink family packages.
|
2019-09-05 15:35:13 +02:00
|
|
|
|
|
|
|
|
## Ecosystem
|
|
|
|
|
|
|
|
|
|
Over time, an ecosystem of Go packages has developed around package `netlink`.
|
|
|
|
|
Many of these packages provide building blocks for further interactions with
|
|
|
|
|
various netlink families, such as `NETLINK_GENERIC` or `NETLINK_ROUTE`.
|
|
|
|
|
|
|
|
|
|
To have your package included in this diagram, please send a pull request!
|
|
|
|
|
|
|
|
|
|
|
