iputil

README

iputil is a package for simple and useful IP and networking functions

Documentation

Overview

Package iputil implements some useful functions for manipulating IP addresses

Index

• func CIDRToIPNet(cidr string) (*net.IPNet, error)
• func FirstAddr(n *net.IPNet) net.IP
• func IPAdd(ip net.IP, offset int) net.IP
• func IPBefore(ip, ip2 net.IP) bool
• func IPDiff(ip, ip2 net.IP) int
• func LastAddr(n *net.IPNet) net.IP
• func NetworkID(n *net.IPNet) *net.IPNet
• func RandAddr(n *net.IPNet) net.IP
• func RandAddrWithExclude(n *net.IPNet, xf, xl int) net.IP
• func SubnetContainsSubnet(supernet, subnet *net.IPNet) bool
• func SubnetEqualSubnet(net1, net2 *net.IPNet) bool

Functions

func CIDRToIPNet

func CIDRToIPNet(cidr string) (*net.IPNet, error)

func FirstAddr

func FirstAddr(n *net.IPNet) net.IP

FirstAddr returns the first address in an IPNet, usually the network address

func IPAdd

func IPAdd(ip net.IP, offset int) net.IP

IPAdd adds an offset to an IP

func IPBefore

func IPBefore(ip, ip2 net.IP) bool

IPBefore returns true if ip < ip2

func IPDiff

func IPDiff(ip, ip2 net.IP) int

IPDiff returns the difference between ip and ip2 nil is treated as the zero address

func LastAddr

func LastAddr(n *net.IPNet) net.IP

LastAddr returns the last address in an IPNet, usually the broadcast address

func NetworkID

func NetworkID(n *net.IPNet) *net.IPNet

NetworkID returns an IPNet representing the network, based on an IPNet of any IP in a network

func RandAddr

func RandAddr(n *net.IPNet) net.IP

RandAddr generates a reandom address in an IPNet

func RandAddrWithExclude

func RandAddrWithExclude(n *net.IPNet, xf, xl int) net.IP

RandAddrWithExclude Generates a random address in an IPNet, excluding the first xf and last xl addresses. To generate a random address, excluding the network and broadcast addresses use 1 for xf and xl

func SubnetContainsSubnet

func SubnetContainsSubnet(supernet, subnet *net.IPNet) bool

SubnetContainsSubnet returns true if the first subnet contains the second nil is considered to be a global supernet "0.0.0.0/0" or "::/0"

func SubnetEqualSubnet

func SubnetEqualSubnet(net1, net2 *net.IPNet) bool

SubnetEqualSubnet returns true if to IPNets are equal nil is considered to be a global supernet "0.0.0.0/0" or "::/0"