Skip to content

Commit

Permalink
sync latest changes + more tests
Browse files Browse the repository at this point in the history 
Signed-off-by: ZIV NEVO <NEVO@il.ibm.com>
  • Loading branch information
@zivnevo
zivnevo committed Feb 21, 2024
1 parent bc76930 commit 8890e88
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 79 deletions.
116 changes: 59 additions & 57 deletions pkg/ipblocks/ipblocks.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,80 +14,84 @@ import (
)

const (
// CidrAll represents the CIDR for all addresses "0.0.0.0/0"
CidrAll = "0.0.0.0/0"

// internal const below
ipByte = 0xff
ipShift0 = 24
ipShift1 = 16
ipShift2 = 8
ipBase = 10
ipMask = 0xffffffff
maxIPv4Bits = 32
CidrAll = "0.0.0.0/0"
cidrSeparator = "/"
bitSize64 = 64
commaSeparator = ", "
dash = "-"
)

// IPBlock captures a set of ip ranges
// IPBlock captures a set of IP ranges
type IPBlock struct {
ipRange intervals.CanonicalIntervalSet
}

// ToIPRanges returns a string of the ip ranges in the current IPBlock object
func (b *IPBlock) ToIPRanges() string {
return strings.Join(b.ToIPRangesList(), commaSeparator)
return strings.Join(b.toIPRangesList(), commaSeparator)
}

// ToIPRange returns a string of the ip range of a single interval
// toIPRange returns a string of the ip range of a single interval
func toIPRange(i intervals.Interval) string {
startIP := InttoIP4(i.Start)
endIP := InttoIP4(i.End)
startIP := inttoIP4(i.Start)
endIP := inttoIP4(i.End)
return rangeIPstr(startIP, endIP)
}

// ToIPRangesList: returns a list of the ip-ranges strings in the current IPBlock object
func (b *IPBlock) ToIPRangesList() []string {
// toIPRangesList: returns a list of the ip-ranges strings in the current IPBlock object
func (b *IPBlock) toIPRangesList() []string {
IPRanges := make([]string, len(b.ipRange.IntervalSet))
for index := range b.ipRange.IntervalSet {
IPRanges[index] = toIPRange(b.ipRange.IntervalSet[index])
}
return IPRanges
}

// IsIPAddress returns true if IPBlock object is a range of exactly one ip address from input
func (b *IPBlock) IsIPAddress(ipAddress string) bool {
ipRanges := b.ToIPRanges()
return ipRanges == rangeIPstr(ipAddress, ipAddress)
}

// ContainedIn returns true if the input IPBlock is contained in this IPBlock
func (b *IPBlock) ContainedIn(c *IPBlock) bool {
return b.ipRange.ContainedIn(c.ipRange)
}

// Intersection returns a new IPBlock from intersection of this IPBlock with input IPBlock
func (b *IPBlock) Intersection(c *IPBlock) *IPBlock {
res := &IPBlock{}
res.ipRange = b.ipRange.Copy()
res.ipRange.Intersection(c.ipRange)
return res
}

// Equal returns true if this IPBlock equals the input IPBlock
func (b *IPBlock) Equal(c *IPBlock) bool {
return b.ipRange.Equal(c.ipRange)
}

// Subtract returns a new IPBlock from subtraction of input IPBlock from this IPBlock
func (b *IPBlock) Subtract(c *IPBlock) *IPBlock {
res := &IPBlock{}
res.ipRange = b.ipRange.Copy()
res.ipRange.Subtraction(c.ipRange)
return res
}

// Union returns a new IPBlock from union of input IPBlock with this IPBlock
func (b *IPBlock) Union(c *IPBlock) *IPBlock {
res := &IPBlock{}
res.ipRange = b.ipRange.Copy()
res.ipRange.Union(c.ipRange)
return res
}

// Empty returns true if this IPBlock is empty
func (b *IPBlock) Empty() bool {
return b.ipRange.IsEmpty()
}
Expand Down Expand Up @@ -122,8 +126,8 @@ func (b *IPBlock) Split() []*IPBlock {
return res
}

// InttoIP4 returns a string of an ip address from an input integer ip value
func InttoIP4(ipInt int64) string {
// inttoIP4 returns a string of an ip address from an input integer ip value
func inttoIP4(ipInt int64) string {
// need to do two bit shifting and “0xff” masking
b0 := strconv.FormatInt((ipInt>>ipShift0)&ipByte, ipBase)
b1 := strconv.FormatInt((ipInt>>ipShift1)&ipByte, ipBase)
Expand Down Expand Up @@ -153,7 +157,7 @@ func DisjointIPBlocks(set1, set2 []*IPBlock) []*IPBlock {

res := blocksWithNoOverlaps
if len(res) == 0 {
newAll, _ := NewIPBlock("0.0.0.0/0", []string{})
newAll := GetCidrAll()
res = append(res, newAll)
}
return res
Expand Down Expand Up @@ -182,32 +186,40 @@ func addIntervalToList(ipbNew *IPBlock, ipbList []*IPBlock) []*IPBlock {
return ipbList
}

func NewIPBlockFromCidr(cidr string) *IPBlock {
res, err := NewIPBlock(cidr, []string{})
if err != nil {
return nil
// NewIPBlockFromCidr returns a new IPBlock object from input CIDR string
func NewIPBlockFromCidr(cidr string) (*IPBlock, error) {
return NewIPBlock(cidr, []string{})
}

// PairCIDRsToIPBlocks returns two IPBlock objects from two input CIDR strings
func PairCIDRsToIPBlocks(cidr1, cidr2 string) (ipb1, ipb2 *IPBlock, err error) {
ipb1, err1 := NewIPBlockFromCidr(cidr1)
ipb2, err2 := NewIPBlockFromCidr(cidr2)
if err1 != nil || err2 != nil {
return nil, nil, errors.Join(err1, err2)
}
return res
return ipb1, ipb2, nil
}

func NewIPBlockFromCidrOrAddress(s string) *IPBlock {
var res *IPBlock
// NewIPBlockFromCidr returns a new IPBlock object from input string of CIDR or IP address
func NewIPBlockFromCidrOrAddress(s string) (*IPBlock, error) {
if strings.Contains(s, cidrSeparator) {
res = NewIPBlockFromCidr(s)
} else {
res, _ = NewIPBlockFromIPAddress(s)
return NewIPBlockFromCidr(s)
}
return res
return NewIPBlockFromIPAddress(s)
}

// NewIPBlockFromCidrList returns IPBlock object from multiple CIDRs given as list of strings
func NewIPBlockFromCidrList(cidrsList []string) *IPBlock {
func NewIPBlockFromCidrList(cidrsList []string) (*IPBlock, error) {
res := &IPBlock{ipRange: intervals.CanonicalIntervalSet{}}
for _, cidr := range cidrsList {
block := NewIPBlockFromCidr(cidr)
block, err := NewIPBlockFromCidr(cidr)
if err != nil {
return nil, err
}
res = res.Union(block)
}
return res
return res, nil
}

// NewIPBlock returns an IPBlock object from input cidr str an exceptions cidr str
Expand All @@ -228,13 +240,13 @@ func NewIPBlock(cidr string, exceptions []string) (*IPBlock, error) {
return &res, nil
}

func IPv4AddressToCidr(ipAddress string) string {
func ipv4AddressToCidr(ipAddress string) string {
return ipAddress + "/32"
}

// NewIPBlockFromIPAddress returns an IPBlock object from input ip address str
// NewIPBlockFromIPAddress returns an IPBlock object from input IP address string
func NewIPBlockFromIPAddress(ipAddress string) (*IPBlock, error) {
return NewIPBlock(IPv4AddressToCidr(ipAddress), []string{})
return NewIPBlock(ipv4AddressToCidr(ipAddress), []string{})
}

func cidrToIPRange(cidr string) (start, end int64, err error) {
Expand Down Expand Up @@ -263,10 +275,11 @@ func cidrToInterval(cidr string) (*intervals.Interval, error) {
return &intervals.Interval{Start: start, End: end}, nil
}

// ToCidrList returns a list of CIDR strings for this IPBlock object
func (b *IPBlock) ToCidrList() []string {
cidrList := []string{}
for _, interval := range b.ipRange.IntervalSet {
cidrList = append(cidrList, IntervalToCidrList(interval.Start, interval.End)...)
cidrList = append(cidrList, intervalToCidrList(interval.Start, interval.End)...)
}
return cidrList
}
Expand All @@ -280,7 +293,7 @@ func (b *IPBlock) ToCidrListString() string {
func (b *IPBlock) ListToPrint() []string {
cidrsIPRangesList := []string{}
for _, interval := range b.ipRange.IntervalSet {
cidr := IntervalToCidrList(interval.Start, interval.End)
cidr := intervalToCidrList(interval.Start, interval.End)
if len(cidr) == 1 {
cidrsIPRangesList = append(cidrsIPRangesList, cidr[0])
} else {
Expand All @@ -290,14 +303,15 @@ func (b *IPBlock) ListToPrint() []string {
return cidrsIPRangesList
}

func (b *IPBlock) ToIPAddress() string {
// ToIPAdressString returns the IP Address string for this IPBlock
func (b *IPBlock) ToIPAddressString() string {
if b.ipRange.IsSingleNumber() {
return InttoIP4(b.ipRange.IntervalSet[0].Start)
return inttoIP4(b.ipRange.IntervalSet[0].Start)
}
return ""
}

func IntervalToCidrList(ipStart, ipEnd int64) []string {
func intervalToCidrList(ipStart, ipEnd int64) []string {
start := ipStart
end := ipEnd
res := []string{}
Expand All @@ -317,15 +331,16 @@ func IntervalToCidrList(ipStart, ipEnd int64) []string {
if maxSize < int(maxDiff) {
maxSize = int(maxDiff)
}
ip := InttoIP4(start)
ip := inttoIP4(start)
res = append(res, fmt.Sprintf("%s/%d", ip, maxSize))
start += int64(math.Pow(2, maxIPv4Bits-float64(maxSize)))
}
return res
}

// IPBlockFromIPRangeStr returns IPBlock object from input IP range string (example: "169.255.0.0-172.15.255.255")
func IPBlockFromIPRangeStr(ipRagneStr string) (*IPBlock, error) {
ipAddresses := strings.Split(ipRagneStr, "-")
ipAddresses := strings.Split(ipRagneStr, dash)
if len(ipAddresses) != 2 {
return nil, errors.New("unexpected ipRange str")
}
Expand All @@ -345,23 +360,10 @@ func IPBlockFromIPRangeStr(ipRagneStr string) (*IPBlock, error) {
return res, nil
}

// GetCidrAll returns IPBlock object of the entire range 0.0.0.0/0
func GetCidrAll() *IPBlock {
return NewIPBlockFromCidr(CidrAll)
}

func IsAddressInSubnet(address, subnetCidr string) (bool, error) {
var addressIPblock, subnetIPBlock *IPBlock
var err error
if addressIPblock, err = NewIPBlockFromIPAddress(address); err != nil {
return false, err
}
subnetIPBlock = NewIPBlockFromCidr(subnetCidr)
return addressIPblock.ContainedIn(subnetIPBlock), nil
}

func CIDRtoIPrange(cidr string) string {
ipb := NewIPBlockFromCidr(cidr)
return ipb.ToIPRanges()
res, _ := NewIPBlockFromCidr(CidrAll)
return res
}

// PrefixLength returns the cidr's prefix length, assuming the ipBlock is exactly one cidr.
Expand Down
Loading

0 comments on commit 8890e88

Please sign in to comment.