3 Commits

Author SHA1 Message Date
brent saner
a00442c204 v0.2.2
FIXED:
* Validations for all were missing. They aren't now.
* Fixed a busted validator for explicit net
2025-04-06 22:46:42 -04:00
brent saner
3c1bc832c0 v0.2.1
FIXED:
* host splitter wasn't working quite correctly; this has been fixed.
2025-04-06 18:26:18 -04:00
brent saner
fd344f3b8e checking in- working on fix for numhost subnetting 2025-04-06 14:37:57 -04:00
8 changed files with 259 additions and 104 deletions

View File

@@ -39,7 +39,7 @@ A tool to assist in design of segregate/segment/split/subnet networks.
** For IPv4 addresses, it will be `true` if it is an APIPA (_Automatic Private IP Addressing_) address ({rfc}3927[RFC 3927^]) (in the `169.254.0.0/16` range). ** For IPv4 addresses, it will be `true` if it is an APIPA (_Automatic Private IP Addressing_) address ({rfc}3927[RFC 3927^]) (in the `169.254.0.0/16` range).
* `First` and `Last` refer to the first and last "usable" ("host"/assignable) addresses in a subnet/network. * `First` and `Last` refer to the first and last "usable" ("host"/assignable) addresses in a subnet/network.
** Note that for IPv6, the first address (`x::`) in a subnet *may* or *may not* be assignable/"usable". If it is assigned to a device, that device *must* be a router for anycast. See {rfc}4291#section-2.6.1[RFC 4291 § 2.6.1^] for details. In the interest of convenience, `subnetter` will report this address as *not usable/addressable* in ranges for this reason as it is technically not a "host" address. ** Note that for IPv6, the first address (`x::`) in a subnet *may* or *may not* be assignable/"usable". If it is assigned to a device, that device *must* be a router for anycast. See {rfc}4291#section-2.6.1[RFC 4291 § 2.6.1^] for details. In the interest of convenience, `subnetter` will report this address as *not usable/addressable* in ranges for this reason as it is technically not a "host" address.
** Note that for IPv6, some subnetting calculators erroneously report the last address for /64's (e.g. `x:ffff:ffff:ffff:ffff/64`) as usable. They are actually reserved in strictly RFC-compliant networks for EUI-64 reasons (per {rfc}2526[RFC 2526^]). For this reason, *if and only if* a prefix is a /64 *exactly*, `subnetter` will use `x:ffff:ffff:ffff:fffe` as the last host address. ** Note that for IPv6, some subnetting calculators erroneously report the last address as usable. They are reserved in strictly RFC-compliant networks for anycast reasons (per {rfc}2526[RFC 2526^]). Subnetter follows RFC as closely as possible, and any deviation from RFC is considered a bug -- as such, the last address of IPv6 subnets is considered *not usable/addressable*.
** There are additional restrictions for /64 subnets, but they fall earlier in the range. These are *not explicitly excluded* in the usable host range, nor are they excluded from the total host count. ** There are additional restrictions for /64 subnets, but they fall earlier in the range. These are *not explicitly excluded* in the usable host range, nor are they excluded from the total host count.
* Private networks ({rfc}1918[RFC 1918^]), ULA prefixes ({rfc}4193[RFC 4193^]), and documentation prefixes ({rfc}3849[RFC 3849^], {rfc}5737[RFC 5737^], {rfc}9637[RFC 9637^]) are treated as "normal" networks (in that it is allowed to subnet them). * Private networks ({rfc}1918[RFC 1918^]), ULA prefixes ({rfc}4193[RFC 4193^]), and documentation prefixes ({rfc}3849[RFC 3849^], {rfc}5737[RFC 5737^], {rfc}9637[RFC 9637^]) are treated as "normal" networks (in that it is allowed to subnet them).
* Various other reserved IPv4 and IPv6 addresses/networks will print warnings with their corresponding RFC(s) (unless `-R`/`--allow-reserved` is specified) if they are specified as/included in the initial prefix/network. ({rfc}6890[RFC 6890^] and its update via {rfc}8190[RFC 8190^] are useful summaries.) Note that for checking to function, an Internet connection is required as it pulls it directly from IANA live to ensure the data is accurate to standards. This may be cached locally if `-c`/`--cache-reservations` is specified, in which case a locally-cached copy will be used if present and populated then used if not. * Various other reserved IPv4 and IPv6 addresses/networks will print warnings with their corresponding RFC(s) (unless `-R`/`--allow-reserved` is specified) if they are specified as/included in the initial prefix/network. ({rfc}6890[RFC 6890^] and its update via {rfc}8190[RFC 8190^] are useful summaries.) Note that for checking to function, an Internet connection is required as it pulls it directly from IANA live to ensure the data is accurate to standards. This may be cached locally if `-c`/`--cache-reservations` is specified, in which case a locally-cached copy will be used if present and populated then used if not.

2
TODO
View File

@@ -3,5 +3,3 @@
- when checking/rendering reserved networks, currently the footnotes aren't returned. - when checking/rendering reserved networks, currently the footnotes aren't returned.
-- netsplit.IANARegistryFootnote -- netsplit.IANARegistryFootnote
-- encapsulated in the IANARegistry.Footnotes -- encapsulated in the IANARegistry.Footnotes
- split-hosts returns the entire original subnet as an unallocated subnet if hosts exceed the number of assignable addrs.

View File

@@ -2,8 +2,8 @@ package main
type Args struct { type Args struct {
Version verArgs `command:"version" alias:"v" description:"Show version information." validate:"omitempty"` Version verArgs `command:"version" alias:"v" description:"Show version information." validate:"omitempty"`
SplitCIDR SplitCIDRArgs `command:"split-cidr" alias:"se" description:"Split a network into as many equal subnets of prefix size N as possible." validate:"omitempty"` SplitCIDR SplitCIDRArgs `command:"split-cidr" alias:"sc" description:"Split a network into as many equal subnets of prefix size N as possible." validate:"omitempty"`
SplitHost SplitHostArgs `command:"split-hosts" alias:"sh" description:"Split a network into N total number of hosts *per subnet* as cleanly/evenly as possible. (VERY easy to run out of memory for IPv6 prefixes; be sure to specify very small network!)" validate:"omitempty"` SplitHost SplitHostArgs `command:"split-hosts" alias:"sh" description:"Split a network into N total number of hosts *per subnet* as cleanly/evenly as possible." validate:"omitempty"`
SplitSubnets SplitSubnetArgs `command:"split-nets" alias:"sn" description:"Split a network into N number of subnets as cleanly as possible." validate:"omitempty"` SplitSubnets SplitSubnetArgs `command:"split-nets" alias:"sn" description:"Split a network into N number of subnets as cleanly as possible." validate:"omitempty"`
VLSM VLSMArgs `command:"split-vlsm" alias:"sv" alias:"vlsm" description:"Use VLSM (Variable-Length Subnet Masks) to split a network into differently sized subnets." validate:"omitempty"` VLSM VLSMArgs `command:"split-vlsm" alias:"sv" alias:"vlsm" description:"Use VLSM (Variable-Length Subnet Masks) to split a network into differently sized subnets." validate:"omitempty"`
ExplicitNetwork XNetArgs `command:"net" alias:"xn" alias:"net" description:"Print information about an explicit network address." validate:"omitempty"` ExplicitNetwork XNetArgs `command:"net" alias:"xn" alias:"net" description:"Print information about an explicit network address." validate:"omitempty"`
@@ -36,8 +36,8 @@ type common struct {
type reservedArgs struct { type reservedArgs struct {
NoRecursive bool `short:"u" long:"no-recursive" description:"Don't show reservations that are children subnets of the subnet(s). Only if -f/--format=pretty, always false for other formats."` NoRecursive bool `short:"u" long:"no-recursive" description:"Don't show reservations that are children subnets of the subnet(s). Only if -f/--format=pretty, always false for other formats."`
NoRevRecursive bool `short:"U" long:"no-rev-recursive" description:"Don't show reservations that are parents of the subnet(s). Only if -f/--format=pretty, always false for other formats."` NoRevRecursive bool `short:"U" long:"no-rev-recursive" description:"Don't show reservations that are parents of the subnet(s) -- you almost definitely don't want to suppress this. Only if -f/--format=pretty, always false for other formats."`
NoPrivate bool `short:"e" long:"no-private" description:"Consider private subnets of the subnet(s) to be reserved. If you are subnetting private address space, you probably want to leave this disabled. Only if -f/--format=pretty, always true otherwise."` NoPrivate bool `short:"e" long:"no-private" description:"Consider private subnets to be reserved. If you are subnetting private address space, you probably want to leave this disabled. Only if -f/--format=pretty, always true otherwise."`
} }
type splitArgs struct { type splitArgs struct {
@@ -53,8 +53,8 @@ type NNetArgs struct {
Verbose bool `short:"v" long:"verbose" description:"Be verbose (more ideal for logging)."` Verbose bool `short:"v" long:"verbose" description:"Be verbose (more ideal for logging)."`
NoV6Check bool `short:"6" long:"no-v6" description:"If specified, do not indicate if the subnetting is IPv6 only (true) or not (false; dual-stack/IPv4 supported)."` NoV6Check bool `short:"6" long:"no-v6" description:"If specified, do not indicate if the subnetting is IPv6 only (true) or not (false; dual-stack/IPv4 supported)."`
Sizes struct { Sizes struct {
SubnetSize uint8 `required:"1" validate:"required,le=128,gtefield=NetworkSize"` SubnetSize uint8 `positional-arg-name:"<subnet prefix>" required:"1" validate:"lte=128,gtefield=NetworkSize"`
NetworkSize uint8 `required:"1" validate:"required,le=128,ltefield=SubnetSize"` NetworkSize uint8 `positional-arg-name:"<parent prefix>" required:"1" validate:"lte=128,ltefield=SubnetSize"`
} `positional-args:"yes" required:"2" validate:"required"` } `positional-args:"yes" required:"2" validate:"required"`
} }
@@ -69,8 +69,10 @@ type SplitCIDRArgs struct {
} }
type SplitHostArgs struct { type SplitHostArgs struct {
Strict bool `short:"t" long:"strict" description:"If specified, an error will occur if the number of hosts/assignable addresses in a subnet is not exactly -n/--num-hosts."` InclNetAddr bool `short:"N" long:"incl-net" description:"If specified, -n/--num-hosts is interpreted to include the network address in the count."`
Hosts uint `short:"n" long:"num-hosts" required:"true" description:"Number of hosts (usable addresses) per subnet." validate:"required"` InclBcastAddr bool `short:"B" long:"incl-bcast" description:"If specified, -n/--num-hosts is interpreted to include the broadcast/reserved broadcast address in the count."`
Strict bool `short:"t" long:"strict" description:"If specified, an error will occur if the number of hosts/assignable addresses in a subnet is not exactly -n/--num-hosts."`
Hosts uint `short:"n" long:"num-hosts" required:"true" description:"Number of hosts (usable addresses) per subnet." validate:"required"`
splitArgs splitArgs
} }

View File

@@ -401,7 +401,9 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
// Remaining // Remaining
if !args.SuppressRemaining { if !args.SuppressRemaining {
if verb >= 1 { if verb <= 0 {
fmt.Println("#")
} else {
fmt.Println() fmt.Println()
fmt.Println(sectSep1) fmt.Println(sectSep1)
fmt.Println("Remaining/Left Over/Unallocated:") fmt.Println("Remaining/Left Over/Unallocated:")
@@ -660,7 +662,7 @@ func printSplitErr(e *netsplit.SplitErr) {
os.Stderr.WriteString("\n!! ERROR !!!\n") os.Stderr.WriteString("\n!! ERROR !!!\n")
os.Stderr.WriteString("\t" + e.Wrapped.Error() + "\n") os.Stderr.WriteString("\t" + e.Wrapped.Error() + "\n")
os.Stderr.WriteString("\nnetwork Iteration Details\n(when error was encountered):\n\n") os.Stderr.WriteString("\nNetwork Iteration Details\n(when error was encountered):\n\n")
if e.Nets == nil { if e.Nets == nil {
os.Stderr.WriteString("Nets:\t\t\t(N/A)\n") os.Stderr.WriteString("Nets:\t\t\t(N/A)\n")
} else { } else {
@@ -669,7 +671,7 @@ func printSplitErr(e *netsplit.SplitErr) {
fmt.Fprintf(os.Stderr, "\t%s\n", n.String()) fmt.Fprintf(os.Stderr, "\t%s\n", n.String())
} }
} }
if e.Remaining == nil { if e.Remaining == nil || e.Remaining.Prefixes() == nil || len(e.Remaining.Prefixes()) == 0 {
os.Stderr.WriteString("Remaining:\t\t(N/A)\n") os.Stderr.WriteString("Remaining:\t\t(N/A)\n")
} else { } else {
os.Stderr.WriteString("Remaining:\n") os.Stderr.WriteString("Remaining:\n")
@@ -678,7 +680,7 @@ func printSplitErr(e *netsplit.SplitErr) {
} }
} }
if e.LastSubnet == nil { if e.LastSubnet == nil {
os.Stderr.WriteString("Last Subnet:\t\t(N/A)") os.Stderr.WriteString("Last Subnet:\t\t(N/A)\n")
} else { } else {
fmt.Fprintf(os.Stderr, "Last Subnet:\t\t%s\n", e.LastSubnet.String()) fmt.Fprintf(os.Stderr, "Last Subnet:\t\t%s\n", e.LastSubnet.String())
} }

View File

@@ -69,6 +69,9 @@ func main() {
return return
} }
case "net": case "net":
if err = validate.Struct(args.ExplicitNetwork); err != nil {
log.Panicln(err)
}
if origPfx, err = netip.ParsePrefix(args.ExplicitNetwork.Network.Network); err != nil { if origPfx, err = netip.ParsePrefix(args.ExplicitNetwork.Network.Network); err != nil {
log.Panicln(err) log.Panicln(err)
} }
@@ -82,6 +85,9 @@ func main() {
} }
return return
case "num-nets": case "num-nets":
if err = validate.Struct(args.NumNets); err != nil {
log.Panicln(err)
}
if numNets, v6Only, err = netsplit.NumNets( if numNets, v6Only, err = netsplit.NumNets(
args.NumNets.Sizes.SubnetSize, args.NumNets.Sizes.SubnetSize,
args.NumNets.Sizes.NetworkSize, args.NumNets.Sizes.NetworkSize,
@@ -103,6 +109,9 @@ func main() {
} }
return return
case "reserved": case "reserved":
if err = validate.Struct(args.Check); err != nil {
log.Panicln(err)
}
if origPfx, err = netip.ParsePrefix(args.Check.Network.Network); err != nil { if origPfx, err = netip.ParsePrefix(args.Check.Network.Network); err != nil {
log.Panicln(err) log.Panicln(err)
} }
@@ -123,6 +132,9 @@ func main() {
} }
return return
case "table": case "table":
if err = validate.Struct(args.Table); err != nil {
log.Panicln(err)
}
// Account for a weird redundant CLI condition. // Account for a weird redundant CLI condition.
if args.Table.NoIpv4 && args.Table.NoIpv6 { if args.Table.NoIpv4 && args.Table.NoIpv6 {
args.Table.NoIpv6 = false args.Table.NoIpv6 = false
@@ -135,6 +147,9 @@ func main() {
os.Stdout.Write(buf.Bytes()) os.Stdout.Write(buf.Bytes())
return return
case "parse": case "parse":
if err = validate.Struct(args.Parse); err != nil {
log.Panicln(err)
}
if strings.TrimSpace(args.Parse.InFile) == "-" { if strings.TrimSpace(args.Parse.InFile) == "-" {
buf = new(bytes.Buffer) buf = new(bytes.Buffer)
if _, err = io.Copy(buf, os.Stdin); err != nil { if _, err = io.Copy(buf, os.Stdin); err != nil {
@@ -186,9 +201,11 @@ func main() {
} }
cmnArgs = args.SplitHost.common cmnArgs = args.SplitHost.common
splitter = &netsplit.HostSplitter{ splitter = &netsplit.HostSplitter{
NumberHosts: args.SplitHost.Hosts, InclNetAddr: args.SplitHost.InclNetAddr,
Strict: args.SplitHost.Strict, InclBcastAddr: args.SplitHost.InclBcastAddr,
BaseSplitter: new(netsplit.BaseSplitter), NumberHosts: args.SplitHost.Hosts,
Strict: args.SplitHost.Strict,
BaseSplitter: new(netsplit.BaseSplitter),
} }
noStrict = !args.SplitHost.Strict noStrict = !args.SplitHost.Strict
strictErr = netsplit.ErrBadNumHosts strictErr = netsplit.ErrBadNumHosts

View File

@@ -4,7 +4,8 @@ import (
"encoding/json" "encoding/json"
"encoding/xml" "encoding/xml"
"fmt" "fmt"
`math` "math"
"math/big"
"net" "net"
"net/netip" "net/netip"
"strings" "strings"
@@ -151,19 +152,19 @@ func AddrInvert(ip netip.Addr) (inverted netip.Addr) {
} }
/* /*
CheckReserved checks nets for any reserved prefixes; either directly/explicitly, CheckReserved checks nets for any reserved prefixes; either directly/explicitly,
included *within* a reserved prefix (revRecursive), or *including* a reserved prefix (recursive). included *within* a reserved prefix (revRecursive), or *including* a reserved prefix (recursive).
excludePrivate indicates if LAN networks should be considered as "reserved" or not. excludePrivate indicates if LAN networks should be considered as "reserved" or not.
If a network is found via revRecursive/recursive, the matching prefix - not the specified one - will be in reservations. If a network is found via revRecursive/recursive, the matching prefix - not the specified one - will be in reservations.
Any found will be returned in reservations. Any found will be returned in reservations.
If no reserved networks are found, reservations will be nil. If no reserved networks are found, reservations will be nil.
Note that prefix-specific broadcasts (e.g. x.255.255.255/8, x.x.x.255/24, ::/64, x:ffff:ffff:ffff:ffff/64, etc.) Note that prefix-specific broadcasts (e.g. x.255.255.255/8, x.x.x.255/24, ::/64, x:ffff:ffff:ffff:ffff/64, etc.)
will *not* be considered as "reserved" as they are considered normal addresses expected for functionality. will *not* be considered as "reserved" as they are considered normal addresses expected for functionality.
This primarily focuses on prefixes/subnets for this reason. This primarily focuses on prefixes/subnets for this reason.
Additionally, all of nets will be aligned to their proper boundary range/CIDR/subnet. Additionally, all of nets will be aligned to their proper boundary range/CIDR/subnet.
*/ */
func CheckReserved(nets []*netip.Prefix, revRecursive, recursive, excludePrivate bool) (reservations map[netip.Prefix]*IANAAddrNetResRecord, err error) { func CheckReserved(nets []*netip.Prefix, revRecursive, recursive, excludePrivate bool) (reservations map[netip.Prefix]*IANAAddrNetResRecord, err error) {
@@ -192,25 +193,26 @@ func CheckReserved(nets []*netip.Prefix, revRecursive, recursive, excludePrivate
reservations = make(map[netip.Prefix]*IANAAddrNetResRecord) reservations = make(map[netip.Prefix]*IANAAddrNetResRecord)
} }
reservations[*n] = res reservations[*n] = res
if !revRecursive && !recursive { }
continue if !revRecursive && !recursive {
} continue
for p, r := range reserved { }
// This... *should* be safe? I don't think any reservations overlap. for p, r := range reserved {
// Anyways, revRecursive works because n.Addr() returns the network address, which should be the canonical boundary. // This... *should* be safe? I don't think any reservations overlap.
// recursive works for the same reason, just the other end. // Anyways, revRecursive works because n.Addr() returns the network address, which should be the canonical boundary.
// Math! // recursive works for the same reason, just the other end.
if revRecursive && p.Contains(n.Addr()) { // Math!
if reservations == nil { if revRecursive && p.Contains(n.Addr()) {
reservations = make(map[netip.Prefix]*IANAAddrNetResRecord) if reservations == nil {
} reservations = make(map[netip.Prefix]*IANAAddrNetResRecord)
reservations[p] = r
} else if recursive && n.Contains(p.Addr()) {
if reservations == nil {
reservations = make(map[netip.Prefix]*IANAAddrNetResRecord)
}
reservations[p] = r
} }
reservations[p] = r
}
if recursive && n.Bits() < p.Bits() && n.Contains(p.Addr()) {
if reservations == nil {
reservations = make(map[netip.Prefix]*IANAAddrNetResRecord)
}
reservations[p] = r
} }
} }
} }
@@ -222,7 +224,7 @@ func CheckReserved(nets []*netip.Prefix, revRecursive, recursive, excludePrivate
func Contain(origPfx *netip.Prefix, nets []*netip.Prefix, remaining *netipx.IPSet, splitter NetSplitter) (s *StructuredResults, err error) { func Contain(origPfx *netip.Prefix, nets []*netip.Prefix, remaining *netipx.IPSet, splitter NetSplitter) (s *StructuredResults, err error) {
var rem []netip.Prefix var rem []netip.Prefix
var reserved map[netip.Prefix]*IANAAddrNetResRecord // var reserved map[netip.Prefix]*IANAAddrNetResRecord
var sr = StructuredResults{ var sr = StructuredResults{
Original: origPfx, Original: origPfx,
} }
@@ -275,19 +277,21 @@ func Contain(origPfx *netip.Prefix, nets []*netip.Prefix, remaining *netipx.IPSe
} }
} }
if nets != nil { /*
if reserved, err = CheckReserved(nets, true, true, false); err != nil { if nets != nil {
return if reserved, err = CheckReserved(nets, true, true, false); err != nil {
} return
if reserved != nil && len(reserved) > 0 { }
s.Reservations = make([]*IANAAddrNetResRecord, len(reserved)) if reserved != nil && len(reserved) > 0 {
idx := 0 s.Reservations = make([]*IANAAddrNetResRecord, len(reserved))
for _, r := range reserved { idx := 0
s.Reservations[idx] = r for _, r := range reserved {
idx++ s.Reservations[idx] = r
idx++
}
} }
} }
} */
s = &sr s = &sr
@@ -377,12 +381,112 @@ func MaskInvert(mask net.IPMask) (inverted net.IPMask) {
} }
/* /*
NumNets returns the number of times prefix size subnet fits into prefix size network. NumAddrsIn returns the number of addresses in a given prefix length
and inet family.
It will error if network is larger than 128 or if subnet is smaller than network. If isIpv6 is false, it is assumed to be IPv4 (...duh).
This is MUCH more performant than splitting out an actual network into explicit subnets, inclNet and inclBcast have the same meanings as in NumAddrsNet and NumAddrsPfx.
and does not require an actual network.
Note that for the single-host prefix (/32 for IPv4, /128 for IPv6), numAddrs will *always* be 1.
For point-to-point prefix (IPv4 /31, IPv6 /127), numAddrs will *ALWAYS* be 2.
*/
func NumAddrsIn(prefixLen uint8, isIpv6, inclNet, inclBcast bool) (numAddrs *big.Int, err error) {
var numBits uint
var numRemoved int64
var maxBitLen uint8 = maxBitsv4
if isIpv6 {
maxBitLen = maxBitsv6
}
if prefixLen > maxBitLen {
err = ErrBadPrefixLen
return
}
if prefixLen == maxBitLen {
numAddrs = big.NewInt(1)
return
}
if (prefixLen + 1) == maxBitLen {
numAddrs = big.NewInt(2)
return
}
numBits = uint(maxBitLen - prefixLen)
numAddrs = new(big.Int).Lsh(big.NewInt(1), numBits)
if !inclNet {
numRemoved++
}
if !inclBcast {
numRemoved++
}
if numRemoved > 0 {
_ = numAddrs.Sub(numAddrs, big.NewInt(numRemoved))
}
return
}
/*
NumAddrsNet returns the number of IP addresses in a net.IPNet.
The network address is included in the count if inclNet is true, otherwise it is excluded.
The broadcast (or reserved broadcast, in the case of IPv6) address will be included in
the count if inclBcast is true, otherwise it is excluded.
numAddrs will be nil if pfx is nil or invalid.
*/
func NumAddrsNet(pfx *net.IPNet, inclNet, inclBcast bool) (numAddrs *big.Int) {
var nPfx netip.Prefix
var ok bool
if pfx == nil {
return
}
if nPfx, ok = netipx.FromStdIPNet(pfx); !ok {
return
}
numAddrs = NumAddrsPfx(nPfx, inclNet, inclBcast)
return
}
// NumAddrsPfx is the exact same as NumAddrsNet but for a net/netip.Prefix instead.
func NumAddrsPfx(pfx netip.Prefix, inclNet, inclBcast bool) (numAddrs *big.Int) {
var numBits uint
var numRemoved int64
numBits = uint(pfx.Addr().BitLen() - pfx.Bits())
numAddrs = new(big.Int).Lsh(big.NewInt(1), numBits)
if !inclNet {
numRemoved++
}
if !inclBcast {
numRemoved++
}
if numRemoved > 0 {
_ = numAddrs.Sub(numAddrs, big.NewInt(numRemoved))
}
return
}
/*
NumNets returns the number of times prefix size subnet fits into prefix size network.
It will error if network is larger than 128 or if subnet is smaller than network.
This is MUCH more performant than splitting out an actual network into explicit subnets,
and does not require an actual network.
*/ */
func NumNets(subnet, network uint8) (numNets uint, ipv6Only bool, err error) { func NumNets(subnet, network uint8) (numNets uint, ipv6Only bool, err error) {
@@ -397,9 +501,7 @@ func NumNets(subnet, network uint8) (numNets uint, ipv6Only bool, err error) {
err = ErrBigPrefix err = ErrBigPrefix
return return
} }
if network > maxBitsv4 { ipv6Only = (network > maxBitsv4) || (subnet > maxBitsv4)
ipv6Only = true
}
x = float64(subnet - network) x = float64(subnet - network)

View File

@@ -1,66 +1,96 @@
package netsplit package netsplit
import ( import (
`math/big` "math/big"
`net`
"net/netip" "net/netip"
`github.com/projectdiscovery/mapcidr`
"go4.org/netipx" "go4.org/netipx"
) )
/* /*
Split splits the network defined in a HostSplitter alongside its configuration and performs the subnetting. Split splits the network defined in a HostSplitter alongside its configuration and performs the subnetting.
This strategy attempts to split the network into subnets of equal number of hosts. This strategy attempts to split the network into subnets of equal number of hosts.
remaining may or may not be nil depending on if the number of hosts can fit cleanly within equal network sizes on boundaries. remaining may or may not be nil depending on if the number of hosts can fit cleanly within equal network sizes on boundaries.
An ErrBadNumHosts will be returned if the number of hosts does not match the *addressable* range in a prefix. An ErrBadNumHosts will be returned if the number of hosts does not match the *exact* number of addresses per spec in a prefix.
*/ */
func (h *HostSplitter) Split() (nets []*netip.Prefix, remaining *netipx.IPSet, err error) { func (h *HostSplitter) Split() (nets []*netip.Prefix, remaining *netipx.IPSet, err error) {
var pfx netip.Prefix
var tgt *big.Int var tgt *big.Int
var splitCidr int
var hosts *big.Int var hosts *big.Int
var sub netip.Prefix var found bool
var subPtr *netip.Prefix var cs *CIDRSplitter
var split []*net.IPNet
var ipsb *netipx.IPSetBuilder = new(netipx.IPSetBuilder)
if h == nil || h.NumberHosts == 0 || h.BaseSplitter == nil || h.network == nil { if h == nil || h.NumberHosts == 0 || h.BaseSplitter == nil || h.network == nil {
return return
} }
if split, err = mapcidr.SplitIPNetByNumber(h.network, int(h.NumberHosts)); err != nil { pfx, _ = netipx.FromStdIPNet(h.network)
tgt = new(big.Int)
tgt.SetUint64(uint64(h.NumberHosts))
if NumAddrsPfx(pfx, h.InclNetAddr, h.InclBcastAddr).Cmp(tgt) < 0 {
// The number of hosts per-subnet exceeds the number of addresses in the specified network.
err = ErrNoNetSpace
return
}
/*
Iterate up through prefix lengths for the inet family's maximum length, getting larger and larger,
until we reach the first prefix that can contain tgt.
If we reach h.network.Bits(), we are forced to use that.
(Any case otherwise should be handled by the above checks.)
*/
for splitCidr = pfx.Addr().BitLen(); splitCidr >= pfx.Bits(); splitCidr-- {
if hosts, err = NumAddrsIn(uint8(splitCidr), pfx.Addr().Is6(), h.InclNetAddr, h.InclBcastAddr); err != nil {
return
}
if hosts.Cmp(tgt) >= 0 {
found = true
break
}
}
if !found {
// Pragmatically, we should never be able to get to this code.
err = ErrNoNetSpace
return return
} }
tgt = big.NewInt(0) // Now that we have an appropriate prefix length for splitting, we can offload a huge portion of that to a CIDRSplitter.
tgt.SetUint64(uint64(h.NumberHosts)) cs = &CIDRSplitter{
PrefixLength: uint8(splitCidr),
nets = make([]*netip.Prefix, len(split)) BaseSplitter: h.BaseSplitter,
for idx, n := range split { }
sub, _ = netipx.FromStdIPNet(n) if nets, remaining, err = cs.Split(); err != nil {
hosts = mapcidr.CountIPsInCIDR(false, false, n) return
if hosts == nil || tgt.Cmp(hosts) != 0 { }
err = &SplitErr{ // If strict mode is enabled, we then need to match the number of hosts exactly in the subnet.
Wrapped: ErrBadNumHosts, if !h.Strict {
Nets: nets, return
Remaining: remaining, }
LastSubnet: &sub, // First off, if remaining is not nil/empty, that immediately fails strict.
RequestedPrefixLen: uint8(sub.Bits()), if remaining != nil && remaining.Prefixes() != nil && len(remaining.Prefixes()) != 0 {
} err = &SplitErr{
ipsb.AddPrefix(sub) Wrapped: ErrBadNumHosts,
} else { Nets: nets,
subPtr = new(netip.Prefix) Remaining: remaining,
*subPtr = sub LastSubnet: nil,
nets = append(nets, subPtr) RequestedPrefixLen: uint8(splitCidr),
} }
return
nets[idx] = new(netip.Prefix)
*nets[idx] = sub
} }
if remaining, err = ipsb.IPSet(); err != nil { // Then we check the cidr we split on, and check its number of hosts.
if hosts.Cmp(tgt) != 0 {
err = &SplitErr{
Wrapped: ErrBadNumHosts,
Nets: nets,
Remaining: remaining,
LastSubnet: nil,
RequestedPrefixLen: uint8(splitCidr),
}
return return
} }

View File

@@ -51,6 +51,10 @@ It attempts to evenly distribute addresses amoungs subnets.
type HostSplitter struct { type HostSplitter struct {
// NumberHosts is the number of hosts to be placed in each subnet to split out. // NumberHosts is the number of hosts to be placed in each subnet to split out.
NumberHosts uint `json:"hosts" xml:"hosts,attr" yaml:"Number of Hosts Per Subnet"` NumberHosts uint `json:"hosts" xml:"hosts,attr" yaml:"Number of Hosts Per Subnet"`
// InclNetAddr, if true, specifies that NumberHosts includes the network address.
InclNetAddr bool `json:"net_addr" xml:"netAddr,attr,omitempty" yaml:"Network Address Included,omitempty"`
// InclBcastAddr, if true, specifies that NumberHosts includes the broadcast address.
InclBcastAddr bool `json:"bcast_addr" xml:"bcast,attr,omitempty" yaml:"Broadcast Address Included,omitempty"`
// Strict, if true, will return an error from Split if the network cannot split into subnets of NumberHosts-addressable networks exactly. // Strict, if true, will return an error from Split if the network cannot split into subnets of NumberHosts-addressable networks exactly.
Strict bool `json:"strict" xml:"strict,attr,omitempty" yaml:"Strictly Equal Hosts Per Subnet"` Strict bool `json:"strict" xml:"strict,attr,omitempty" yaml:"Strictly Equal Hosts Per Subnet"`
*BaseSplitter `json:"net" xml:"net,omitempty" yaml:"network,omitempty"` *BaseSplitter `json:"net" xml:"net,omitempty" yaml:"network,omitempty"`
@@ -78,14 +82,14 @@ type VLSMSplitter struct {
(ascending order) instead of larger networks/smaller prefixes (descending order). (ascending order) instead of larger networks/smaller prefixes (descending order).
You almost assuredly do not want to do this. You almost assuredly do not want to do this.
*/ */
Ascending bool Ascending bool `json:"asc,omitempty" xml:"asc,attr,omitempty" yaml:"Ascending Order,omitempty"`
/* /*
Explicit, if true, will ignore Ascending completely and split in the explicit order of PrefixLengths. Explicit, if true, will ignore Ascending completely and split in the explicit order of PrefixLengths.
This has the potential to be *extremely* wasteful of addressing space as the resulting blocks are This has the potential to be *extremely* wasteful of addressing space as the resulting blocks are
VERY unoptimized. VERY unoptimized.
*/ */
Explicit bool Explicit bool `json:"explicit,omitempty" xml:"explicit,attr,omitempty" yaml:"Explicit Ordering,omitempty"`
// PrefixLengths contains the prefix lengths of each subnet to split out from the network. // PrefixLengths contains the prefix lengths of each subnet to split out from the network.
PrefixLengths []uint8 `json:"prefixes" xml:"prefixes>prefix" yaml:"Prefix Lengths"` PrefixLengths []uint8 `json:"prefixes" xml:"prefixes>prefix" yaml:"Prefix Lengths"`
*BaseSplitter `json:"net" xml:"net,omitempty" yaml:"network,omitempty"` *BaseSplitter `json:"net" xml:"net,omitempty" yaml:"network,omitempty"`