Deprecated: use github.com/gaissmai/iprange and github.com/gaissmai/interval instead
README
¶
go-inet
A Go library for reading, formatting, sorting and converting IP-addresses and IP-blocks.
ATTENTION: v2 with new API
Version v2 uses the math based on type uint128 struct {hi uint64, lo uint64}, no longer bytes fiddling in network byte order.
The API is reduced to the bare minimum, the tree representation is abstracted with an Interface.
github.com/gaissmai/go-inet/v2/inet
Package inet represents IP-addresses and IP-Blocks as comparable types.
Some missing utility functions in the standard library for IP-addresses and IP-blocks are provided.
This IP representation is comparable and can be sorted very quickly without prior conversions to/from the different IP versions.
The library is mainly intended for fast ACL-lookups and for IP address management (IPAM) in global scope and not for host related systems programming.
So, no IP address zone indices are supported and IPv4-mapped IPv6 addresses are stripped down to plain IPv4 addresses. The information of the prior mapping is discarded.
Blocks are IP-networks or arbitrary IP-ranges, e.g.
192.168.0.1/24 // CIDR
::1/128 // CIDR
10.0.0.3-10.0.17.134 // IP range, no CIDR
2001:db8::1-2001:db8::f6 // IP range, no CIDR
github.com/gaissmai/go-inet/v2/tree
Package tree is a minimal interval tree implementation.
All interval types implementing the tree.Interface can use this library for fast lookups and a stringified tree representation.
The tree can be visualized as:
▼
├─ 10.0.0.0/9
│ ├─ 10.0.0.0/11
│ │ ├─ 10.0.0.0-10.0.0.29
│ │ ├─ 10.0.16.0/20
│ │ └─ 10.0.32.0/20
│ └─ 10.32.0.0/11
│ ├─ 10.32.8.0/22
│ ├─ 10.32.12.0-10.32.13.77
│ └─ 10.32.16.0/22
├─ 2001:db8:900::/48
│ ├─ 2001:db8:900::/49
│ │ ├─ 2001:db8:900::/52
github.com/gaissmai/go-inet/v2/inettree
Package inettree implements the tree.Interface for inet.Block.
Documentation
Please study the applications in the examples directory to get familiar with the API.
License
go-inet is licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
ipam-tree
Command ipam-tree, read blocks from Stdin, print sorted Tree
|
Command ipam-tree, read blocks from Stdin, print sorted Tree |
|
Package inet represents IP-addresses and IP-Blocks as comparable types.
|
Package inet represents IP-addresses and IP-Blocks as comparable types. |
|
Package inettree implements the tree.Interface for inet.Block
|
Package inettree implements the tree.Interface for inet.Block |
|
Package tree is a minimal interval tree implementation.
|
Package tree is a minimal interval tree implementation. |