iptools.go

package ip2location

import (
	"encoding/hex"
	"errors"
	"fmt"
	"math"
	"math/big"
	"net"
	"regexp"
	"sort"
	"strconv"
	"strings"
)

// The IPTools struct is the main object to access the IP address tools
type IPTools struct {
	max_ipv4_range *big.Int
	max_ipv6_range *big.Int
}

// OpenTools initializes some variables
func OpenTools() *IPTools {
	var t = &IPTools{}
	t.max_ipv4_range = big.NewInt(4294967295)
	t.max_ipv6_range = big.NewInt(0)
	t.max_ipv6_range.SetString("340282366920938463463374607431768211455", 10)
	return t
}

// IsIPv4 returns true if the IP address provided is an IPv4.
func (t *IPTools) IsIPv4(IP string) bool {
	ipaddr := net.ParseIP(IP)

	if ipaddr == nil {
		return false
	}

	v4 := ipaddr.To4()

	if v4 == nil {
		return false
	}

	return true
}

// IsIPv6 returns true if the IP address provided is an IPv6.
func (t *IPTools) IsIPv6(IP string) bool {
	if t.IsIPv4(IP) {
		return false
	}

	ipaddr := net.ParseIP(IP)

	if ipaddr == nil {
		return false
	}

	v6 := ipaddr.To16()

	if v6 == nil {
		return false
	}

	return true
}

// IPv4ToDecimal returns the IP number for the supplied IPv4 address.
func (t *IPTools) IPv4ToDecimal(IP string) (*big.Int, error) {
	if !t.IsIPv4(IP) {
		return nil, errors.New("Not a valid IPv4 address.")
	}

	ipnum := big.NewInt(0)
	ipaddr := net.ParseIP(IP)

	if ipaddr != nil {
		v4 := ipaddr.To4()

		if v4 != nil {
			ipnum.SetBytes(v4)
		}
	}

	return ipnum, nil
}

// IPv6ToDecimal returns the IP number for the supplied IPv6 address.
func (t *IPTools) IPv6ToDecimal(IP string) (*big.Int, error) {
	if !t.IsIPv6(IP) {
		return nil, errors.New("Not a valid IPv6 address.")
	}

	ipnum := big.NewInt(0)
	ipaddr := net.ParseIP(IP)

	if ipaddr != nil {
		v6 := ipaddr.To16()

		if v6 != nil {
			ipnum.SetBytes(v6)
		}
	}

	return ipnum, nil
}

// DecimalToIPv4 returns the IPv4 address for the supplied IP number.
func (t *IPTools) DecimalToIPv4(IPNum *big.Int) (string, error) {
	if IPNum.Cmp(big.NewInt(0)) < 0 || IPNum.Cmp(t.max_ipv4_range) > 0 {
		return "", errors.New("Invalid IP number.")
	}

	buf := make([]byte, 4)
	bytes := IPNum.FillBytes(buf)

	ip := net.IP(bytes)
	return ip.String(), nil
}

// DecimalToIPv6 returns the IPv6 address for the supplied IP number.
func (t *IPTools) DecimalToIPv6(IPNum *big.Int) (string, error) {
	if IPNum.Cmp(big.NewInt(0)) < 0 || IPNum.Cmp(t.max_ipv6_range) > 0 {
		return "", errors.New("Invalid IP number.")
	}

	buf := make([]byte, 16)
	bytes := IPNum.FillBytes(buf)

	ip := net.IP(bytes)
	return ip.String(), nil
}

// CompressIPv6 returns the compressed form of the supplied IPv6 address.
func (t *IPTools) CompressIPv6(IP string) (string, error) {
	if !t.IsIPv6(IP) {
		return "", errors.New("Not a valid IPv6 address.")
	}

	ipaddr := net.ParseIP(IP)

	if ipaddr == nil {
		return "", errors.New("Not a valid IPv6 address.")
	}

	return ipaddr.String(), nil
}

// ExpandIPv6 returns the expanded form of the supplied IPv6 address.
func (t *IPTools) ExpandIPv6(IP string) (string, error) {
	if !t.IsIPv6(IP) {
		return "", errors.New("Not a valid IPv6 address.")
	}

	ipaddr := net.ParseIP(IP)

	ipstr := hex.EncodeToString(ipaddr)
	re := regexp.MustCompile(`(.{4})`)
	ipstr = re.ReplaceAllString(ipstr, "$1:")
	ipstr = strings.TrimSuffix(ipstr, ":")

	return ipstr, nil
}

// IPv4ToCIDR returns the CIDR for the supplied IPv4 range.
func (t *IPTools) IPv4ToCIDR(IPFrom string, IPTo string) ([]string, error) {
	if !t.IsIPv4(IPFrom) || !t.IsIPv4(IPTo) {
		return nil, errors.New("Not a valid IPv4 address.")
	}

	startipbig, _ := t.IPv4ToDecimal(IPFrom)
	endipbig, _ := t.IPv4ToDecimal(IPTo)
	startip := startipbig.Uint64()
	endip := endipbig.Uint64()
	var result []string
	var maxsize float64
	var maxdiff float64

	for endip >= startip {
		maxsize = 32

		for maxsize > 0 {
			mask := math.Pow(2, 32) - math.Pow(2, 32-(maxsize-1))
			maskbase := startip & uint64(mask)

			if maskbase != startip {
				break
			}

			maxsize = maxsize - 1
		}

		x := math.Log(float64(endip)-float64(startip)+1) / math.Log(2)
		maxdiff = 32 - math.Floor(x)

		if maxsize < maxdiff {
			maxsize = maxdiff
		}

		bn := big.NewInt(0)

		bn.SetString(fmt.Sprintf("%v", startip), 10)

		ip, _ := t.DecimalToIPv4(bn)
		result = append(result, ip+"/"+fmt.Sprintf("%v", maxsize))
		startip = startip + uint64(math.Pow(2, 32-maxsize))
	}

	return result, nil
}

// converts IPv6 address to binary string representation.
func (t *IPTools) ipToBinary(ip string) (string, error) {
	if !t.IsIPv6(ip) {
		return "", errors.New("Not a valid IPv6 address.")
	}

	ipaddr := net.ParseIP(ip)

	binstr := ""
	for i, j := 0, len(ipaddr); i < j; i = i + 1 {
		binstr += fmt.Sprintf("%08b", ipaddr[i])
	}

	return binstr, nil
}

// converts binary string representation to IPv6 address.
func (t *IPTools) binaryToIP(binstr string) (string, error) {
	re := regexp.MustCompile(`^[01]{128}$`)
	if !re.MatchString(binstr) {
		return "", errors.New("Not a valid binary string.")
	}

	re2 := regexp.MustCompile(`(.{8})`)

	bytes := make([]byte, 16)
	i := 0
	matches := re2.FindAllStringSubmatch(binstr, -1)
	for _, v := range matches {
		x, _ := strconv.ParseUint(v[1], 2, 8)
		bytes[i] = byte(x)
		i = i + 1
	}

	ipaddr := net.IP(bytes)

	return ipaddr.String(), nil
}

// returns the min and max for the array
func (t *IPTools) minMax(array []int) (int, int) {
	var max int = array[0]
	var min int = array[0]
	for _, value := range array {
		if max < value {
			max = value
		}
		if min > value {
			min = value
		}
	}
	return min, max
}

// IPv6ToCIDR returns the CIDR for the supplied IPv6 range.
func (t *IPTools) IPv6ToCIDR(IPFrom string, IPTo string) ([]string, error) {
	if !t.IsIPv6(IPFrom) || !t.IsIPv6(IPTo) {
		return nil, errors.New("Not a valid IPv6 address.")
	}

	ipfrombin, err := t.ipToBinary(IPFrom)

	if err != nil {
		return nil, errors.New("Not a valid IPv6 address.")
	}

	iptobin, err := t.ipToBinary(IPTo)

	if err != nil {
		return nil, errors.New("Not a valid IPv6 address.")
	}

	var result []string

	networksize := 0
	shift := 0
	unpadded := ""
	padded := ""
	networks := make(map[string]int)
	n := 0

	if ipfrombin == iptobin {
		result = append(result, IPFrom+"/128")
		return result, nil
	}

	if ipfrombin > iptobin {
		tmp := ipfrombin
		ipfrombin = iptobin
		iptobin = tmp
	}

	for {
		if string(ipfrombin[len(ipfrombin)-1]) == "1" {
			unpadded = ipfrombin[networksize:128]
			padded = fmt.Sprintf("%-128s", unpadded)      // pad right with spaces
			padded = strings.ReplaceAll(padded, " ", "0") // replace spaces
			networks[padded] = 128 - networksize
			n = strings.LastIndex(ipfrombin, "0")
			if n == 0 {
				ipfrombin = ""
			} else {
				ipfrombin = ipfrombin[0:n]
			}
			ipfrombin = ipfrombin + "1"
			ipfrombin = fmt.Sprintf("%-128s", ipfrombin)        // pad right with spaces
			ipfrombin = strings.ReplaceAll(ipfrombin, " ", "0") // replace spaces
		}

		if string(iptobin[len(iptobin)-1]) == "0" {
			unpadded = iptobin[networksize:128]
			padded = fmt.Sprintf("%-128s", unpadded)      // pad right with spaces
			padded = strings.ReplaceAll(padded, " ", "0") // replace spaces
			networks[padded] = 128 - networksize
			n = strings.LastIndex(iptobin, "1")
			if n == 0 {
				iptobin = ""
			} else {
				iptobin = iptobin[0:n]
			}
			iptobin = iptobin + "0"
			iptobin = fmt.Sprintf("%-128s", iptobin)        // pad right with spaces
			iptobin = strings.ReplaceAll(iptobin, " ", "1") // replace spaces
		}

		if iptobin < ipfrombin {
			// special logic for Go due to lack of do-while
			if ipfrombin >= iptobin {
				break
			}
			continue
		}

		values := []int{strings.LastIndex(ipfrombin, "0"), strings.LastIndex(iptobin, "1")}
		_, max := t.minMax(values)
		shift = 128 - max
		unpadded = ipfrombin[0 : 128-shift]
		ipfrombin = fmt.Sprintf("%0128s", unpadded)
		unpadded = iptobin[0 : 128-shift]
		iptobin = fmt.Sprintf("%0128s", unpadded)

		networksize = networksize + shift

		if ipfrombin == iptobin {
			unpadded = ipfrombin[networksize:128]
			padded = fmt.Sprintf("%-128s", unpadded)      // pad right with spaces
			padded = strings.ReplaceAll(padded, " ", "0") // replace spaces
			networks[padded] = 128 - networksize
		}

		if ipfrombin >= iptobin {
			break
		}
	}

	keys := make([]string, 0, len(networks))
	for k := range networks {
		keys = append(keys, k)
	}
	sort.Strings(keys)

	for _, k := range keys {
		str, _ := t.binaryToIP(k)
		result = append(result, str+"/"+fmt.Sprintf("%d", networks[k]))
	}

	return result, nil
}

// CIDRToIPv4 returns the IPv4 range for the supplied CIDR.
func (t *IPTools) CIDRToIPv4(CIDR string) ([]string, error) {
	if strings.Index(CIDR, "/") == -1 {
		return nil, errors.New("Not a valid CIDR.")
	}

	re := regexp.MustCompile(`^[0-9]{1,2}$`)
	arr := strings.Split(CIDR, "/")

	if len(arr) != 2 || !t.IsIPv4(arr[0]) || !re.MatchString(arr[1]) {
		return nil, errors.New("Not a valid CIDR.")
	}

	ip := arr[0]

	prefix, err := strconv.Atoi(arr[1])
	if err != nil || prefix > 32 {
		return nil, errors.New("Not a valid CIDR.")
	}

	ipstartbn, err := t.IPv4ToDecimal(ip)
	if err != nil {
		return nil, errors.New("Not a valid CIDR.")
	}
	ipstartlong := ipstartbn.Int64()

	ipstartlong = ipstartlong & (-1 << (32 - prefix))

	bn := big.NewInt(0)
	bn.SetString(strconv.Itoa(int(ipstartlong)), 10)

	ipstart, _ := t.DecimalToIPv4(bn)

	var total int64 = 1 << (32 - prefix)

	ipendlong := ipstartlong + total - 1

	if ipendlong > 4294967295 {
		ipendlong = 4294967295
	}

	bn.SetString(strconv.Itoa(int(ipendlong)), 10)
	ipend, _ := t.DecimalToIPv4(bn)

	result := []string{ipstart, ipend}

	return result, nil
}

// CIDRToIPv6 returns the IPv6 range for the supplied CIDR.
func (t *IPTools) CIDRToIPv6(CIDR string) ([]string, error) {
	if strings.Index(CIDR, "/") == -1 {
		return nil, errors.New("Not a valid CIDR.")
	}

	re := regexp.MustCompile(`^[0-9]{1,3}$`)
	arr := strings.Split(CIDR, "/")

	if len(arr) != 2 || !t.IsIPv6(arr[0]) || !re.MatchString(arr[1]) {
		return nil, errors.New("Not a valid CIDR.")
	}

	ip := arr[0]

	prefix, err := strconv.Atoi(arr[1])
	if err != nil || prefix > 128 {
		return nil, errors.New("Not a valid CIDR.")
	}

	expand, _ := t.ExpandIPv6(ip)
	parts := strings.Split(expand, ":")

	bitStart := strings.Repeat("1", prefix) + strings.Repeat("0", 128-prefix)
	bitEnd := strings.Repeat("0", prefix) + strings.Repeat("1", 128-prefix)

	n := 16 // split string into 16-char parts
	floors := []string{}
	for i := 0; i < len(bitStart); i += n {
		end := i + n
		if end > len(bitStart) {
			end = len(bitStart)
		}
		floors = append(floors, bitStart[i:end])
	}
	ceilings := []string{}
	for i := 0; i < len(bitEnd); i += n {
		end := i + n
		if end > len(bitEnd) {
			end = len(bitEnd)
		}
		ceilings = append(ceilings, bitEnd[i:end])
	}

	start := []string{}
	end := []string{}

	for i := 0; i < 8; i += 1 {
		p, _ := strconv.ParseUint(parts[i], 16, 64)
		f, _ := strconv.ParseUint(floors[i], 2, 64)
		c, _ := strconv.ParseUint(ceilings[i], 2, 64)
		start = append(start, strconv.FormatUint(p&f, 16))
		end = append(end, strconv.FormatUint(p|c, 16))
	}

	hexstartaddress, _ := t.ExpandIPv6(strings.Join(start, ":"))
	hexendaddress, _ := t.ExpandIPv6(strings.Join(end, ":"))
	result := []string{hexstartaddress, hexendaddress}

	return result, nil
}