checking in- needs some refinement then done
This commit is contained in:
parent
64b669edc3
commit
d8469533a7
GPG Key ID:
004FD489E0203EEE
12
README.adoc
12
README.adoc
@ -42,7 +42,17 @@ A tool to assist in design of segregate/segment/split/subnet networks.
|
||||
** 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.
|
||||
** 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).
|
||||
* 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.)
|
||||
* 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.
|
||||
** The cache directory may be specified by `-C`/`--cache-dir` (which can be specifically defaulted via the `SBNTR_RSVCACHE_DIR` environment variable). If it is not specified, the default (see below) will be used.
|
||||
** This directory's default location determined by the following, and will be created if it doesn't exist:
|
||||
*** For non-Windows systems (macOS, Linux, etc.)...
|
||||
**** If https://specifications.freedesktop.org/basedir-spec/latest/#variables[the `XDG_CACHE_HOME` environment variable^] is present, it will be `${XDG_CACHE_HOME}/subnetter/`. (If XDG base dirs are enabled, this is usually `~/.cache/subnetter/` or, explicitly, `/home/<username>/.cache/subnetter/`)
|
||||
**** If the `XDG_CACHE_HOME` environment variable is not present...
|
||||
***** On macOS, an explicit fallback of `~/Library/Caches/subnetter/` will be used. (To my knowledge/understanding, this is the standard user cache directory and cannot be changed.) This usually evaluates to `/Users/<username>/Library/Caches/subnetter/`.
|
||||
***** On all others, an explicit fallback of `~/.cache/subnetter` will be used.
|
||||
****** On most non-macOS \*NIX-like systems , this is usually `/home/<username>/.cache/subetter/`, provided normal user homes. On http://p9f.org/[Plan9^] platforms (e.g. https://9p.io/plan9/index.html[Plan 9 4th Ed.^], https://9front.org/[9front^], http://9legacy.org/[9legacy^]), the `/env/home` environment variable (`$home`) will be used, the `./lib/` subdirectory under there (which typically/should already exist) will be appended to it, and that appended with `./cache/subnetter/` (this usually evaluates to `/usr/<username>/lib/cache/subnetter/`).
|
||||
*** For Windows systems...
|
||||
**** If https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#constants[the `LOCALAPPDATA` environment variable^] is present, it will be `%LOCALAPPDATA%\Cache\subnetter\` (or `${env:LOCALAPPDATA}\Cache\subnetter\` in Powershell syntax). This usually evaluates to `C:\Users\<username>\AppData\Local\Cache\subnetter\`.
|
||||
|
||||
[id="ref"]
|
||||
== References
|
||||
|
||||
2
cmd/subnetter/_tpl/check.tpl
Normal file
2
cmd/subnetter/_tpl/check.tpl
Normal file
@ -0,0 +1,2 @@
|
||||
{{- /*gotype: subnetter/cmd/subnetter.ReservedResults*/ -}}
|
||||
{{- $opts := . -}}
|
||||
@ -1,4 +1,4 @@
|
||||
{{- /*gotype: subnetter/cmd/subnetter.tableOpts*/ -}}
|
||||
{{- /*gotype: subnetter/cmd/subnetter.TableArgs*/ -}}
|
||||
{{- $opts := . -}}
|
||||
{{- $numRows := 0 -}}
|
||||
{{- if not $opts.NoIpv4 }}
|
||||
|
||||
@ -1,72 +1,96 @@
|
||||
package main
|
||||
|
||||
type Args struct {
|
||||
Version bool `short:"v" long:"version" description:"Print the version and exit."`
|
||||
DetailVersion bool `short:"V" long:"detail" description:"Print detailed version info and exit."`
|
||||
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"`
|
||||
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"`
|
||||
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:"vlsm" alias:"v" description:"Use VLSM (Variable-Length Subnet Masks) to split a network into differently sized subnets." validate:"omitempty"`
|
||||
ExplicitNetwork XNetArgs `command:"net" alias:"n" description:"Print information about an explicit network address." validate:"omitempty"`
|
||||
VLSM VLSMArgs `command:"vlsm" alias:"sv" description:"Use VLSM (Variable-Length Subnet Masks) to split a network into differently sized subnets." validate:"omitempty"`
|
||||
ExplicitNetwork XNetArgs `command:"net" alias:"xn" description:"Print information about an explicit network address." validate:"omitempty"`
|
||||
Parse ParseArgs `command:"parse" alias:"p" alias:"read" alias:"convert" description:"Parse/convert output from a previous subnetter run." validate:"omitempty"`
|
||||
Table TableArgs `command:"table" alias:"t" alias:"tab" alias:"tbl" description:"Show prefix summaries (by default both IPv4 and IPv6)." validate:"omitempty"`
|
||||
Check CheckArgs `command:"reserved" alias:"r" description:"Check if a subnet is reserved per IANA/RFC." validate:"omitempty"`
|
||||
}
|
||||
|
||||
type outputOpts struct {
|
||||
SuppressRemaining bool `short:"r" long:"no-remaining" description:"Don't show leftover/unallocated/remaining space.'"`
|
||||
Verbose []bool `short:"v" long:"verbose" description:"Show verbose information if -f/--format=pretty. May be specified multiple times to increase verbosity (up to 3 levels)."`
|
||||
Plain bool `short:"p" long:"plain" description:"Show plain output instead of unicode (only used if -f/--format=pretty)."`
|
||||
Seperator string `short:"S" long:"seperator" default:"\n" description:"Separator between addresses; only used for -f/--format=pretty with no verbosity."`
|
||||
Fmt string `short:"f" long:"format" choice:"json" choice:"pretty" choice:"yml" choice:"xml" default:"pretty" description:"Output format. 'pretty' is not intended to be parseable, either by subnetter or by external tooling."`
|
||||
type verArgs struct {
|
||||
DetailVersion bool `short:"V" long:"detail" description:"Print detailed version info and exit."`
|
||||
}
|
||||
|
||||
type common struct {
|
||||
outputOpts
|
||||
AllowReserved bool `short:"R" long:"allow-reserved" description:"If specified, do not warn about reserved IP addresses/networks."`
|
||||
AllowHostNet bool `short:"H" long:"allow-host" description:"If specified, do not warn about host bits. Host bits are always removed for subnetting (as otherwise there would be errors); this is only used only for output."`
|
||||
Network Net `positional-args:"yes" required:"true" description:"The network to be split/subnetted." validate:"required"`
|
||||
cacheArgs
|
||||
SuppressRemaining bool `short:"r" long:"no-remaining" description:"Don't show leftover/unallocated/remaining space."`
|
||||
Plain bool `short:"p" long:"plain" description:"Show plain output instead of unicode (only used if -f/--format=pretty)."`
|
||||
Separator string `short:"S" long:"separator" default:"\n" description:"Separator between addresses; only used for -f/--format=pretty with no verbosity."`
|
||||
Fmt string `short:"f" long:"format" choice:"json" choice:"pretty" choice:"yml" choice:"xml" default:"pretty" description:"Output format. 'pretty' is not intended to be parseable, either by subnetter or by external tooling."`
|
||||
Verbose []bool `short:"v" long:"verbose" description:"Show verbose information if -f/--format=pretty. May be specified multiple times to increase verbosity (up to 3 levels)."`
|
||||
AllowReserved bool `short:"R" long:"allow-reserved" description:"If specified, do not warn about reserved IP addresses/networks."`
|
||||
reservedArgs
|
||||
AllowHostNet bool `short:"H" long:"allow-host" description:"If specified, do not warn about host bits. Host bits are always removed for subnetting (as otherwise there would be errors); this is only used only for output."`
|
||||
Network Net `positional-args:"yes" required:"true" description:"The network/parent prefix to operate on." validate:"required"`
|
||||
}
|
||||
|
||||
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."`
|
||||
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."`
|
||||
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."`
|
||||
}
|
||||
|
||||
type splitArgs struct {
|
||||
common
|
||||
}
|
||||
|
||||
type cacheArgs struct {
|
||||
CacheDir string `short:"C" long:"cache-dir" env:"SBNTR_RSVCACHE_DIR" description:"Cached reservation data directory. The default is platform/OS-specific."`
|
||||
DoResCache bool `short:"c" long:"cache-reservations" env:"SBNTR_RSVCACHE" description:"Enable caching/cache lookup for reservation data."`
|
||||
}
|
||||
|
||||
type ParseArgs struct {
|
||||
outputOpts
|
||||
AllowReserved bool `short:"R" long:"allow-reserved" description:"If specified, do not warn about reserved IP addresses/networks."`
|
||||
AllowHostNet bool `short:"H" long:"allow-host" description:"If specified, do not warn about host bits."`
|
||||
InFile string `short:"i" long:"input" default:"-" description:"Input file to parse. Default is '-' (for STDIN)." required:"true" validate:"required,filepath|eq=-"`
|
||||
splitArgs
|
||||
InFile string `short:"i" long:"input" default:"-" description:"Input file to parse. Default is '-' (for STDIN)." required:"true" validate:"required,filepath|eq=-"`
|
||||
}
|
||||
|
||||
type SplitCIDRArgs struct {
|
||||
Prefix uint8 `short:"s" long:"size" required:"true" description:"Prefix length/network size in bits (as CIDR number)." validate:"required"`
|
||||
common
|
||||
splitArgs
|
||||
}
|
||||
|
||||
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."`
|
||||
Hosts uint `short:"n" long:"num-hosts" required:"true" description:"Number of hosts (usable addresses) per subnet." validate:"required"`
|
||||
common
|
||||
splitArgs
|
||||
}
|
||||
|
||||
type SplitSubnetArgs struct {
|
||||
Strict bool `short:"t" long:"strict" description:"If specified, an error will occur if the number of possible equally-sized subnets is not exactly -n/--num-nets."`
|
||||
NumNets uint `short:"n" long:"num-nets" required:"true" description:"Number of networks." validate:"required"`
|
||||
common
|
||||
splitArgs
|
||||
}
|
||||
|
||||
type TableArgs struct {
|
||||
tableOpts
|
||||
Notes bool `short:"n" long:"notes" description:"Include notes about prefixes (as a separate table)."`
|
||||
Legacy bool `short:"l" long:"legacy" description:"Include legacy/obsolete/deprecated information (as separate table(s))."`
|
||||
Plain bool `short:"p" long:"plain" description:"Show plain table output instead of unicode."`
|
||||
NoV4Mask bool `short:"M" long:"no-mask" description:"Do not include netmasks for IPv4."`
|
||||
NoIpv6 bool `short:"4" long:"ipv4" description:"Only show IPv4 table(s)."`
|
||||
NoIpv4 bool `short:"6" long:"ipv6" description:"Only show IPv6 table(s)."`
|
||||
}
|
||||
|
||||
type CheckArgs struct {
|
||||
cacheArgs
|
||||
reservedArgs
|
||||
Plain bool `short:"p" long:"plain" description:"Show plain output instead of unicode (only used if -f/--format=pretty)."`
|
||||
Fmt string `short:"f" long:"format" choice:"json" choice:"pretty" choice:"yml" choice:"xml" default:"pretty" description:"Output format. 'pretty' is not intended to be parseable, either by subnetter or by external tooling."`
|
||||
Network Net `positional-args:"yes" required:"true" description:"The network/parent prefix to operate on." validate:"required"`
|
||||
}
|
||||
|
||||
type XNetArgs struct {
|
||||
Plain bool `short:"p" long:"plain" description:"Show plain output instead of unicode (only used if -f/--format=pretty)."`
|
||||
Seperator string `short:"S" long:"seperator" default:"\n" description:"Separator between addresses; only used for -f/--format=pretty with no verbosity."`
|
||||
Fmt string `short:"f" long:"format" choice:"json" choice:"pretty" choice:"yml" choice:"xml" default:"pretty" description:"Output format. 'pretty' is not intended to be parseable, either by subnetter or by external tooling."`
|
||||
Verbose []bool `short:"v" long:"verbose" description:"Show verbose information (if -n/--network is specified). May be specified multiple times to increase verbosity (up to 2 levels)."`
|
||||
Network Net `positional-args:"yes" required:"true" description:"The network address to print information about." validate:"required"`
|
||||
common
|
||||
}
|
||||
|
||||
type VLSMArgs struct {
|
||||
Asc bool `short:"a" long:"asc" description:"If specified, place smaller networks (larger prefixes) at the beginning. You almost assuredly do not want to do this."`
|
||||
Asc bool `short:"A" long:"ascending" description:"If specified, place smaller networks (larger prefixes) at the beginning. You almost assuredly do not want to do this."`
|
||||
Sizes []uint8 `short:"s" long:"size" required:"true" description:"Prefix lengths. May be specified multiple times." validate:"required"`
|
||||
common
|
||||
splitArgs
|
||||
}
|
||||
|
||||
type Net struct {
|
||||
|
||||
@ -10,6 +10,7 @@ import (
|
||||
"net"
|
||||
"net/netip"
|
||||
"os"
|
||||
`sort`
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
@ -217,6 +218,11 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
var masked netip.Prefix
|
||||
var remPfxs []*netip.Prefix
|
||||
var invertedMask net.IPMask
|
||||
var resIdx int
|
||||
var resPfx netip.Prefix
|
||||
var resRec *netsplit.IANAAddrNetResRecord
|
||||
var reservedList []*netip.Prefix
|
||||
var reserved map[netip.Prefix]*netsplit.IANAAddrNetResRecord
|
||||
var res *netsplit.StructuredResults
|
||||
var verb = -1
|
||||
var fmts []string
|
||||
@ -230,9 +236,7 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
|
||||
if args == nil {
|
||||
args = &common{
|
||||
outputOpts: outputOpts{
|
||||
Seperator: "\n",
|
||||
},
|
||||
Separator: "\n",
|
||||
}
|
||||
}
|
||||
fmts = sectFmts[args.Plain]
|
||||
@ -240,9 +244,9 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
sectSep2 = fmts[1]
|
||||
// sectSep3 = fmts[2]
|
||||
|
||||
if args.outputOpts.Verbose != nil {
|
||||
if args.Verbose != nil {
|
||||
verb = 0
|
||||
for _, i := range args.outputOpts.Verbose {
|
||||
for _, i := range args.Verbose {
|
||||
if i {
|
||||
verb++
|
||||
}
|
||||
@ -269,7 +273,7 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
verb = -1
|
||||
}
|
||||
|
||||
if args.outputOpts.Fmt == "pretty" {
|
||||
if args.Fmt == "pretty" {
|
||||
// "Human"-formatted
|
||||
|
||||
// Header
|
||||
@ -307,6 +311,73 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
fmt.Println(sectSep1)
|
||||
}
|
||||
|
||||
// Reservations
|
||||
if !args.AllowReserved && verb >= 1 {
|
||||
fmt.Println()
|
||||
fmt.Println(sectSep1)
|
||||
fmt.Println("Reserved Subnets in Selection:")
|
||||
if reserved, err = netsplit.CheckReserved(nets, !args.NoRevRecursive, !args.NoRecursive, !args.NoPrivate); err != nil {
|
||||
return
|
||||
}
|
||||
if reserved == nil || len(reserved) == 0 {
|
||||
fmt.Println("(No reserved subnets found; good job!)")
|
||||
} else {
|
||||
reservedList = make([]*netip.Prefix, len(reserved))
|
||||
for resPfx, _ = range reserved {
|
||||
reservedList[resIdx] = &resPfx
|
||||
resIdx++
|
||||
}
|
||||
sort.SliceStable(
|
||||
reservedList,
|
||||
func(i, j int) (isLess bool) {
|
||||
isLess = reservedList[i].String() < reservedList[j].String()
|
||||
return
|
||||
},
|
||||
)
|
||||
fmt.Println("The following reserved subnets were found to be conflicting with your allocation(s).")
|
||||
for _, n := range reservedList {
|
||||
resRec = reserved[*n]
|
||||
fmt.Printf("\tNetwork: %s\n", n.String())
|
||||
fmt.Printf("\t\tReservation: %s\n", resRec.Name)
|
||||
fmt.Println("\t\tAllocations:")
|
||||
for _, i := range resRec.Networks.Prefixes {
|
||||
fmt.Printf("\t\t\t%s\n", i.String())
|
||||
}
|
||||
if verb >= 2 {
|
||||
fmt.Println("\t\tReserved By:")
|
||||
for _, i := range resRec.Spec.References {
|
||||
fmt.Printf("\t\t\t%s %s\n", i.Type, i.Reference)
|
||||
}
|
||||
}
|
||||
if verb >= 3 {
|
||||
if resRec.Source != nil && resRec.Source.Evaluated != nil && resRec.Source.Applicable != nil && *resRec.Source.Applicable {
|
||||
fmt.Printf("\t\tIs Source:\t%v\n", *resRec.Source.Evaluated)
|
||||
}
|
||||
if resRec.Dest != nil && resRec.Dest.Evaluated != nil && resRec.Dest.Applicable != nil && *resRec.Dest.Applicable {
|
||||
fmt.Printf("\t\tIs Destination:\t%v\n", *resRec.Dest.Evaluated)
|
||||
}
|
||||
if resRec.Forwardable != nil && resRec.Forwardable.Evaluated != nil && resRec.Forwardable.Applicable != nil && *resRec.Forwardable.Applicable {
|
||||
fmt.Printf("\t\tIs Forwardable:\t%v\n", *resRec.Forwardable.Evaluated)
|
||||
}
|
||||
if resRec.GlobalReach != nil && resRec.GlobalReach.Evaluated != nil && resRec.GlobalReach.Applicable != nil && *resRec.GlobalReach.Applicable {
|
||||
fmt.Printf("\t\tIs Globally Reachable:\t%v\n", *resRec.GlobalReach.Evaluated)
|
||||
}
|
||||
if resRec.ProtoReserved != nil && resRec.ProtoReserved.Evaluated != nil && resRec.ProtoReserved.Applicable != nil && *resRec.ProtoReserved.Applicable {
|
||||
fmt.Printf("\t\tIs Reserved by Protocol:\t%v\n", *resRec.ProtoReserved.Evaluated)
|
||||
}
|
||||
fmt.Printf("\t\tAllocated: %s\n", time.Time(resRec.Allocation).String())
|
||||
if resRec.Updated != nil {
|
||||
fmt.Printf("\t\tUpdated: %s\n", time.Time(*resRec.Updated).String())
|
||||
}
|
||||
if resRec.Termination != nil {
|
||||
fmt.Printf("\t\tUpdated: %s\n", time.Time(*resRec.Termination).String())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
fmt.Println(sectSep1)
|
||||
}
|
||||
|
||||
// Allocations
|
||||
if verb >= 1 {
|
||||
fmt.Println()
|
||||
@ -319,7 +390,7 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
}
|
||||
} else {
|
||||
for _, n := range nets {
|
||||
fmt.Print(resFromPfx(n).pretty(verb, 1, args.outputOpts.Seperator, "\t", false, args.Plain))
|
||||
fmt.Print(resFromPfx(n).pretty(verb, 1, args.Separator, "\t", false, args.Plain))
|
||||
}
|
||||
}
|
||||
if verb >= 1 {
|
||||
@ -327,7 +398,7 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
}
|
||||
|
||||
// Remaining
|
||||
if !args.outputOpts.SuppressRemaining {
|
||||
if !args.SuppressRemaining {
|
||||
if verb >= 1 {
|
||||
fmt.Println()
|
||||
fmt.Println(sectSep1)
|
||||
@ -343,7 +414,7 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
return
|
||||
}
|
||||
for _, n := range remaining.Prefixes() {
|
||||
fmt.Print(resFromPfx(&n).pretty(verb, 1, args.outputOpts.Seperator, "\t", true, args.Plain))
|
||||
fmt.Print(resFromPfx(&n).pretty(verb, 1, args.Separator, "\t", true, args.Plain))
|
||||
}
|
||||
}
|
||||
if verb >= 1 {
|
||||
@ -355,7 +426,7 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
if res, err = netsplit.Contain(orig, nets, remaining, splitter); err != nil {
|
||||
return
|
||||
}
|
||||
switch strings.ToLower(args.outputOpts.Fmt) {
|
||||
switch strings.ToLower(args.Fmt) {
|
||||
case "json":
|
||||
if b, err = json.MarshalIndent(res, "", " "); err != nil {
|
||||
return
|
||||
@ -400,6 +471,11 @@ func printNets(orig *netip.Prefix, origNet *net.IPNet, nets []*netip.Prefix, rem
|
||||
return
|
||||
}
|
||||
|
||||
func printReserved(nets []*netip.Prefix, remaining *netipx.IPSet, args *common) (err error) {
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func printSplitErr(e *netsplit.SplitErr) {
|
||||
|
||||
if e == nil {
|
||||
|
||||
@ -34,8 +34,8 @@ func main() {
|
||||
var res *netsplit.StructuredResults
|
||||
var noStrict bool
|
||||
var strictErr error
|
||||
var splitErr = new(netsplit.SplitErr)
|
||||
var parser = flags.NewParser(args, flags.Default)
|
||||
var splitErr *netsplit.SplitErr = new(netsplit.SplitErr)
|
||||
var parser *flags.Parser = flags.NewParser(args, flags.Default)
|
||||
|
||||
if _, err = parser.Parse(); err != nil {
|
||||
switch flagsErr := err.(type) {
|
||||
@ -55,35 +55,21 @@ func main() {
|
||||
log.Panicln(err)
|
||||
}
|
||||
|
||||
// If args.Version or args.DetailVersion are true, just print them and exit.
|
||||
if args.DetailVersion || args.Version {
|
||||
if args.Version {
|
||||
fmt.Println(version.Ver.Short())
|
||||
return
|
||||
} else if args.DetailVersion {
|
||||
switch parser.Active.Name {
|
||||
case "version":
|
||||
if args.Version.DetailVersion {
|
||||
fmt.Println(version.Ver.Detail())
|
||||
return
|
||||
} else {
|
||||
fmt.Println(version.Ver.Short())
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
switch parser.Active.Name {
|
||||
case "net":
|
||||
if origPfx, err = netip.ParsePrefix(args.ExplicitNetwork.Network.Network); err != nil {
|
||||
log.Panicln(err)
|
||||
}
|
||||
pfx = netipx.PrefixIPNet(origPfx.Masked())
|
||||
cmnArgs = common{
|
||||
outputOpts: outputOpts{
|
||||
SuppressRemaining: true,
|
||||
Plain: args.ExplicitNetwork.Plain,
|
||||
Verbose: args.ExplicitNetwork.Verbose,
|
||||
Seperator: args.ExplicitNetwork.Seperator,
|
||||
Fmt: args.ExplicitNetwork.Fmt,
|
||||
},
|
||||
AllowReserved: true,
|
||||
AllowHostNet: true,
|
||||
Network: args.ExplicitNetwork.Network,
|
||||
}
|
||||
cmnArgs = args.ExplicitNetwork.common
|
||||
nets = make([]*netip.Prefix, 1)
|
||||
nets[0] = new(netip.Prefix)
|
||||
*nets[0] = origPfx.Masked()
|
||||
@ -91,14 +77,16 @@ func main() {
|
||||
log.Panicln(err)
|
||||
}
|
||||
return
|
||||
case "reserved":
|
||||
// TODO
|
||||
case "table":
|
||||
// Account for a weird redundant CLI condition.
|
||||
if args.Table.tableOpts.NoIpv4 && args.Table.tableOpts.NoIpv6 {
|
||||
args.Table.tableOpts.NoIpv6 = false
|
||||
args.Table.tableOpts.NoIpv4 = false
|
||||
if args.Table.NoIpv4 && args.Table.NoIpv6 {
|
||||
args.Table.NoIpv6 = false
|
||||
args.Table.NoIpv4 = false
|
||||
}
|
||||
buf = new(bytes.Buffer)
|
||||
if err = tblTpl.ExecuteTemplate(buf, "table.tpl", args.Table.tableOpts); err != nil {
|
||||
if err = tblTpl.ExecuteTemplate(buf, "table.tpl", args.Table); err != nil {
|
||||
log.Panicln(err)
|
||||
}
|
||||
os.Stdout.Write(buf.Bytes())
|
||||
@ -128,11 +116,7 @@ func main() {
|
||||
origPfx = *resPfx
|
||||
}
|
||||
pfx = netipx.PrefixIPNet(origPfx.Masked())
|
||||
cmnArgs = common{
|
||||
outputOpts: args.Parse.outputOpts,
|
||||
AllowReserved: args.Parse.AllowReserved,
|
||||
AllowHostNet: args.Parse.AllowHostNet,
|
||||
}
|
||||
cmnArgs = args.Parse.common
|
||||
if err = printNets(&origPfx, pfx, nets, remaining, &cmnArgs, res.GetSplitter()); err != nil {
|
||||
log.Panicln(err)
|
||||
}
|
||||
@ -191,6 +175,10 @@ func main() {
|
||||
PrefixLengths: args.VLSM.Sizes,
|
||||
BaseSplitter: new(netsplit.BaseSplitter),
|
||||
}
|
||||
default:
|
||||
err = flags.ErrCommandRequired
|
||||
log.Println(err)
|
||||
os.Exit(1)
|
||||
}
|
||||
if origPfx, err = netip.ParsePrefix(cmnArgs.Network.Network); err != nil {
|
||||
log.Panicln(err)
|
||||
|
||||
@ -4,20 +4,13 @@ import (
|
||||
`math/big`
|
||||
`net`
|
||||
"net/netip"
|
||||
|
||||
`subnetter/netsplit`
|
||||
)
|
||||
|
||||
// subnetResult is only used for human/"pretty" printing.
|
||||
type subnetResult netip.Prefix
|
||||
|
||||
type tableOpts struct {
|
||||
Notes bool `short:"n" long:"notes" description:"Include notes about prefixes (as a separate table)."`
|
||||
Plain bool `short:"p" long:"plain" description:"Show plain table output."`
|
||||
Legacy bool `short:"l" long:"legacy" description:"Include legacy/obsolete/deprecated information."`
|
||||
NoV4Mask bool `short:"M" long:"no-mask" description:"Do not include netmasks for IPv4."`
|
||||
NoIpv6 bool `short:"4" long:"ipv4" description:"Only show IPv4 table(s)."`
|
||||
NoIpv4 bool `short:"6" long:"ipv6" description:"Only show IPv6 table(s)."`
|
||||
}
|
||||
|
||||
// tableLegacy4 contains a spec for a class in the legacy "classed" IPv4 networking.
|
||||
type tableLegacy4 struct {
|
||||
Class string
|
||||
@ -102,3 +95,8 @@ type tableFormatter struct {
|
||||
NoUpperTitle bool
|
||||
NoBoldTitle bool
|
||||
}
|
||||
|
||||
type ReservedResults struct {
|
||||
Opts CheckArgs
|
||||
Reserved map[netip.Prefix]*netsplit.IANAAddrNetResRecord
|
||||
}
|
||||
|
||||
3
go.mod
3
go.mod
@ -8,6 +8,7 @@ require (
|
||||
github.com/TwiN/go-color v1.4.1
|
||||
github.com/davecgh/go-spew v1.1.1
|
||||
github.com/go-playground/validator/v10 v10.24.0
|
||||
github.com/go-resty/resty/v2 v2.16.5
|
||||
github.com/goccy/go-yaml v1.15.16
|
||||
github.com/jessevdk/go-flags v1.6.1
|
||||
github.com/projectdiscovery/mapcidr v1.1.34
|
||||
@ -27,7 +28,7 @@ require (
|
||||
github.com/microcosm-cc/bluemonday v1.0.27 // indirect
|
||||
github.com/pkg/errors v0.9.1 // indirect
|
||||
github.com/projectdiscovery/blackrock v0.0.1 // indirect
|
||||
github.com/projectdiscovery/utils v0.4.8 // indirect
|
||||
github.com/projectdiscovery/utils v0.4.9 // indirect
|
||||
github.com/saintfish/chardet v0.0.0-20230101081208-5e3ef4b5456d // indirect
|
||||
golang.org/x/crypto v0.32.0 // indirect
|
||||
golang.org/x/net v0.34.0 // indirect
|
||||
|
||||
8
go.sum
8
go.sum
@ -17,6 +17,8 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn
|
||||
github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
|
||||
github.com/go-playground/validator/v10 v10.24.0 h1:KHQckvo8G6hlWnrPX4NJJ+aBfWNAE/HH+qdL2cBpCmg=
|
||||
github.com/go-playground/validator/v10 v10.24.0/go.mod h1:GGzBIJMuE98Ic/kJsBXbz1x/7cByt++cQ+YOuDM5wus=
|
||||
github.com/go-resty/resty/v2 v2.16.5 h1:hBKqmWrr7uRc3euHVqmh1HTHcKn99Smr7o5spptdhTM=
|
||||
github.com/go-resty/resty/v2 v2.16.5/go.mod h1:hkJtXbA2iKHzJheXYvQ8snQES5ZLGKMwQ07xAwp/fiA=
|
||||
github.com/goccy/go-yaml v1.15.16 h1:PMTVcGI9uNPIn7KLs0H7KC1rE+51yPl5YNh4i8rGuRA=
|
||||
github.com/goccy/go-yaml v1.15.16/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
||||
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
@ -36,8 +38,8 @@ github.com/projectdiscovery/blackrock v0.0.1 h1:lHQqhaaEFjgf5WkuItbpeCZv2DUIE45k
|
||||
github.com/projectdiscovery/blackrock v0.0.1/go.mod h1:ANUtjDfaVrqB453bzToU+YB4cUbvBRpLvEwoWIwlTss=
|
||||
github.com/projectdiscovery/mapcidr v1.1.34 h1:udr83vQ7oz3kEOwlsU6NC6o08leJzSDQtls1wmXN/kM=
|
||||
github.com/projectdiscovery/mapcidr v1.1.34/go.mod h1:1+1R6OkKSAKtWDXE9RvxXtXPoajXTYX0eiEdkqlhQqQ=
|
||||
github.com/projectdiscovery/utils v0.4.8 h1:/Xd38fP8xc6kifZayjrhcYALenJrjO3sHO7lg+I8ZGk=
|
||||
github.com/projectdiscovery/utils v0.4.8/go.mod h1:S314NzLcXVCbLbwYCoorAJYcnZEwv7Uhw2d3aF5fJ4s=
|
||||
github.com/projectdiscovery/utils v0.4.9 h1:GzYKy5iiCWEZZPGxrtgTOnRTZYiIAiCditGufp0nhGU=
|
||||
github.com/projectdiscovery/utils v0.4.9/go.mod h1:/68d0OHGgYF4aW4X7kS1qlFlYOnZxgtFDN85iH732JI=
|
||||
github.com/saintfish/chardet v0.0.0-20230101081208-5e3ef4b5456d h1:hrujxIzL1woJ7AwssoOcM/tq5JjjG2yYOc8odClEiXA=
|
||||
github.com/saintfish/chardet v0.0.0-20230101081208-5e3ef4b5456d/go.mod h1:uugorj2VCxiV1x+LzaIdVa9b4S4qGAcH6cbhh4qVxOU=
|
||||
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
|
||||
@ -58,6 +60,8 @@ golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
|
||||
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
|
||||
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
||||
golang.org/x/time v0.6.0 h1:eTDhh4ZXt5Qf0augr54TN6suAUudPcawVZeIAPU7D4U=
|
||||
golang.org/x/time v0.6.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
r00t2.io/goutils v1.7.2 h1:dJ+pzY/U1yVi2V6eKoxe/4roM+Tb3d0umMEL9Dx4+Lw=
|
||||
|
||||
@ -1,15 +1,47 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`io/fs`
|
||||
`net/netip`
|
||||
`sync`
|
||||
|
||||
`github.com/go-resty/resty/v2`
|
||||
)
|
||||
|
||||
const (
|
||||
cachedirEnvName string = "SBNTR_RSVCACHE_DIR"
|
||||
// https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
|
||||
ianaSpecial4 string = "https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xml"
|
||||
// https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
|
||||
ianaSpecial6 string = "https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xml"
|
||||
ianaDateTfmt string = "2006-01-02"
|
||||
ianaMonthTfmt string = "2006-01"
|
||||
ianaTrue string = "True"
|
||||
ianaFalse string = "False"
|
||||
ianaNA string = "N/A"
|
||||
ianaSpecial4Cache string = "iana_reserved_4.json"
|
||||
ianaSpecial6Cache string = "iana_reserved_6.json"
|
||||
cacheDirPerms fs.FileMode = 0o0750
|
||||
cacheFilePerms fs.FileMode = 0o0640
|
||||
)
|
||||
|
||||
var (
|
||||
ReservedNets map[netip.Prefix]string
|
||||
cacheDir string
|
||||
isCaching bool
|
||||
ianaReserved4 *IANARegistry
|
||||
ianaReserved6 *IANARegistry
|
||||
)
|
||||
|
||||
var (
|
||||
// TODO
|
||||
cacheLock sync.RWMutex
|
||||
cacheClient *resty.Client
|
||||
// IPv4: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml#iana-ipv4-special-registry-1
|
||||
// IPv6: https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
|
||||
reservedNets map[netip.Prefix]*IANAAddrNetResRecord
|
||||
// Up to date as of Feb 2, 2025
|
||||
reservedNetsOrig map[string]string = map[string]string{
|
||||
// IPv6
|
||||
// https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
|
||||
// IPv6: https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
|
||||
"::/128": "Unspecified Address (RFC 4291 § 2.5.2)",
|
||||
"::1/128": "Loopback Address (RFC 4291 § 2.5.3)",
|
||||
"ff00::/8": "Multicast (RFC 4291 § 2.7)",
|
||||
@ -34,8 +66,29 @@ var (
|
||||
"5f00::/16": "Segment Routing (SRv6) SIDs (RFC 9602)",
|
||||
"fc00::/7": "Unique-Local Addressing (RFC 4193)", // private/LAN
|
||||
"fe80::/10": "Link-Local Unicast (RFC 4291 § 2.5.6)",
|
||||
// IPv4
|
||||
// https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml#iana-ipv4-special-registry-1
|
||||
"": "",
|
||||
// IPv4: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml#iana-ipv4-special-registry-1
|
||||
"0.0.0.0/8": "\"This Network\" (RFC 791 § 3.2)",
|
||||
"0.0.0.0/32": "\"This Host on This Network\" (RFC 1122 § 3.2.1.3)",
|
||||
"10.0.0.0/8": "Private Use (RFC 1918)", // private/LAN
|
||||
"100.64.0.0/10": "Shared Address Space (CGNAT) (RFC 6598)",
|
||||
"127.0.0.0/8": "Loopback (RFC 1122 § 3.2.1.3)",
|
||||
"169.254.0.0/16": "Link-Local (RFC 3927)",
|
||||
"172.16.0.0/12": "Private Use (RFC 1918)", // private/LAN
|
||||
"192.0.0.0/24": "IETF Protocol Assignments (RFC 6890 § 2.1)",
|
||||
"192.0.0.0/29": "IPv4 Service Community Prefix (RFC 7335)",
|
||||
"192.0.0.8/32": "IPv4 Dummy Address (RFC 7600)",
|
||||
"192.0.0.9/32": "Port Control Protocol Anycast (RFC 7723)",
|
||||
"192.0.0.10/32": "Traversal Using Relays Around NAT Anycast (RFC 8155)",
|
||||
"192.0.0.170/32": "NAT64/DNS64 Discovery (RFC 7050 § 2.2) (RFC 8880)",
|
||||
"192.0.0.171/32": "NAT64/DNS64 Discovery (RFC 7050 § 2.2) (RFC 8880)",
|
||||
"192.0.2.0/24": "Documentation (TEST-NET-1) (RFC 5737)",
|
||||
"192.31.196.0/24": "AS112-v4 (RFC 7535)",
|
||||
"192.52.193.0/24": "AMT (RFC 7450)",
|
||||
"192.168.0.0/16": "Private Use (RFC 1918)", // private/LAN
|
||||
"192.175.48.0/24": "Direct Delegation AS112 Service (RFC 7534)",
|
||||
"198.18.0.0/15": "Benchmarking (RFC 2544)",
|
||||
"198.51.100.0/24": "Documentation (TEST-NET-2) (RFC 5737)",
|
||||
"240.0.0.0/24": "Reserved for Future Use (RFC 1112 § 4)",
|
||||
"255.255.255.255/32": "Limited Broadcast (RFC 919 § 7) (RFC 8190)",
|
||||
}
|
||||
)
|
||||
|
||||
@ -150,8 +150,10 @@ func AddrInvert(ip netip.Addr) (inverted netip.Addr) {
|
||||
}
|
||||
|
||||
/*
|
||||
CheckReserved checks nets for any reserved prefixes, either directly or included within the prefix depending on recurse.
|
||||
CheckReserved checks nets for any reserved prefixes; either directly/explicitly,
|
||||
included *within* a reserved prefix (revRecursive), or *including* a reserved prefix (recursive).
|
||||
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.
|
||||
|
||||
Any found will be returned in reservations.
|
||||
|
||||
@ -159,18 +161,68 @@ func AddrInvert(ip netip.Addr) (inverted netip.Addr) {
|
||||
|
||||
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.
|
||||
This primarily focuses on prefixes/subnets for this reason.
|
||||
Additionally, all of nets will be aligned to their proper boundary range/CIDR/subnet.
|
||||
*/
|
||||
func CheckReserved(nets []*netip.Prefix, recurse, excludePrivate bool) (reservations map[netip.Prefix]string, err error) {
|
||||
func CheckReserved(nets []*netip.Prefix, revRecursive, recursive, excludePrivate bool) (reservations map[netip.Prefix]*IANAAddrNetResRecord, err error) {
|
||||
|
||||
// TODO
|
||||
var ok bool
|
||||
var res *IANAAddrNetResRecord
|
||||
var reserved map[netip.Prefix]*IANAAddrNetResRecord
|
||||
|
||||
if nets == nil || len(nets) == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
if _, _, reserved, err = RetrieveReserved(); err != nil {
|
||||
return
|
||||
}
|
||||
for _, n := range nets {
|
||||
if n == nil {
|
||||
continue
|
||||
}
|
||||
if n.Addr().IsPrivate() && excludePrivate {
|
||||
continue
|
||||
}
|
||||
*n = n.Masked()
|
||||
if res, ok = reserved[*n]; ok {
|
||||
if reservations == nil {
|
||||
reservations = make(map[netip.Prefix]*IANAAddrNetResRecord)
|
||||
}
|
||||
reservations[*n] = res
|
||||
if !revRecursive && !recursive {
|
||||
continue
|
||||
}
|
||||
for p, r := range reserved {
|
||||
// This... *should* be safe? I don't think any reservations overlap.
|
||||
// Anyways, revRecursive works because n.Addr() returns the network address, which should be the canonical boundary.
|
||||
// recursive works for the same reason, just the other end.
|
||||
// Math!
|
||||
if revRecursive && p.Contains(n.Addr()) {
|
||||
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
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Contain takes the results of a NetSplitter and returns a StructuredResults.
|
||||
// Contain takes the results of a NetSplitter and returns a StructuredResults. The reservations are only checked against nets.
|
||||
func Contain(origPfx *netip.Prefix, nets []*netip.Prefix, remaining *netipx.IPSet, splitter NetSplitter) (s *StructuredResults, err error) {
|
||||
|
||||
var idx int
|
||||
var r *IANAAddrNetResRecord
|
||||
var rem []netip.Prefix
|
||||
var reserved map[netip.Prefix]*IANAAddrNetResRecord
|
||||
var sr = StructuredResults{
|
||||
Original: origPfx,
|
||||
}
|
||||
@ -223,6 +275,18 @@ func Contain(origPfx *netip.Prefix, nets []*netip.Prefix, remaining *netipx.IPSe
|
||||
}
|
||||
}
|
||||
|
||||
if nets != nil {
|
||||
if reserved, err = CheckReserved(nets, true, true, false); err != nil {
|
||||
return
|
||||
}
|
||||
if reserved != nil && len(reserved) > 0 {
|
||||
s.Reservations = make([]*IANAAddrNetResRecord, len(reserved))
|
||||
for idx, r = range reserved {
|
||||
s.Reservations[idx] = r
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
s = &sr
|
||||
|
||||
return
|
||||
|
||||
383
netsplit/funcs_cache.go
Normal file
383
netsplit/funcs_cache.go
Normal file
@ -0,0 +1,383 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`encoding/json`
|
||||
`errors`
|
||||
`io/fs`
|
||||
`net/http`
|
||||
`net/netip`
|
||||
`os`
|
||||
`path/filepath`
|
||||
`sync`
|
||||
|
||||
`github.com/go-resty/resty/v2`
|
||||
`r00t2.io/goutils/multierr`
|
||||
`r00t2.io/sysutils/envs`
|
||||
`r00t2.io/sysutils/paths`
|
||||
)
|
||||
|
||||
/*
|
||||
CacheReserved caches the IANA address/network reservations to disk
|
||||
(and updates ianaReserved4, ianaReserved6, and reservedNets).
|
||||
|
||||
It is up to the caller to schedule periodic CacheReserved calls
|
||||
according to their needs for long-lived processes.
|
||||
It *shouldn't* cause any memory leaks, but this has not been tested/confirmed.
|
||||
|
||||
If caching is not enabled, CacheReserved exits withouth any retrieval, parsing, etc.
|
||||
*/
|
||||
func CacheReserved() (err error) {
|
||||
|
||||
var dat4 []byte
|
||||
var dat6 []byte
|
||||
|
||||
if !isCaching {
|
||||
return
|
||||
}
|
||||
|
||||
if cacheDir == "" {
|
||||
if cacheDir, err = getDefCachePath(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if dat4, dat6, err = getLive(); err != nil {
|
||||
return
|
||||
}
|
||||
if err = writeCache(dat4, dat6); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// CleanCache clears the cache completely.
|
||||
func CleanCache() (err error) {
|
||||
|
||||
if cacheDir == "" {
|
||||
if cacheDir, err = getDefCachePath(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if err = os.RemoveAll(cacheDir); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
/*
|
||||
RetrieveReserved returns the current reservations and (re-)populates reservedNets.
|
||||
|
||||
It returns a copy of reservedNets and the current reservations that are safe to use concurrently/separately
|
||||
from subnetter.
|
||||
|
||||
If caching is enabled, then:
|
||||
|
||||
1.) First the local cache will be checked.
|
||||
|
||||
2.) If no cache exists, subnetter will attempt to populate it (CacheReserved());
|
||||
otherwise the data there will be used.
|
||||
|
||||
2.b.) If an error occurs while parsing the cached data, the cache will be invalidated
|
||||
and attempt to be updated.
|
||||
|
||||
3.) If no cache exists and the live resource is unavailable, an error will be returned.
|
||||
|
||||
If not:
|
||||
|
||||
1.) The live resource will be fetched. If it is unavailable, an error will be returned.
|
||||
*/
|
||||
func RetrieveReserved() (ipv4, ipv6 IANARegistry, reserved map[netip.Prefix]*IANAAddrNetResRecord, err error) {
|
||||
|
||||
var b []byte
|
||||
var dat4 []byte
|
||||
var dat6 []byte
|
||||
var hasCache bool
|
||||
|
||||
if isCaching {
|
||||
if hasCache, err = checkCache(); err != nil {
|
||||
return
|
||||
}
|
||||
if !hasCache {
|
||||
if err = CacheReserved(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
if dat4, dat6, err = readCache(); err != nil {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
if dat4, dat6, err = getLive(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if err = json.Unmarshal(dat4, &ipv4); err != nil {
|
||||
return
|
||||
}
|
||||
if err = json.Unmarshal(dat6, &ipv6); err != nil {
|
||||
return
|
||||
}
|
||||
ianaReserved4 = new(IANARegistry)
|
||||
ianaReserved4 = new(IANARegistry)
|
||||
if err = json.Unmarshal(dat4, ianaReserved4); err != nil {
|
||||
return
|
||||
}
|
||||
if err = json.Unmarshal(dat6, ianaReserved6); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
reservedNets = make(map[netip.Prefix]*IANAAddrNetResRecord)
|
||||
for _, reg := range []*IANARegistry{
|
||||
ianaReserved4, ianaReserved6,
|
||||
} {
|
||||
for _, rec := range reg.Notice.Records {
|
||||
for _, n := range rec.Networks.Prefixes {
|
||||
reservedNets[*n] = rec
|
||||
}
|
||||
}
|
||||
}
|
||||
if b, err = json.Marshal(reservedNets); err != nil {
|
||||
return
|
||||
}
|
||||
reserved = make(map[netip.Prefix]*IANAAddrNetResRecord)
|
||||
if err = json.Unmarshal(b, &reserved); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// GetCacheConfig returns the current state and path of subnetter's cache.
|
||||
func GetCacheConfig() (enabled bool, cacheDirPath string) {
|
||||
|
||||
enabled = isCaching
|
||||
cacheDirPath = cacheDir
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// EnableCache enables or disables subnetter's caching.
|
||||
func EnableCache(enable bool) (err error) {
|
||||
|
||||
var oldVal bool = isCaching
|
||||
|
||||
isCaching = enable
|
||||
|
||||
if isCaching && (oldVal != isCaching) {
|
||||
if err = os.MkdirAll(cacheDir, 0o0640); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
/*
|
||||
SetCachePath sets the cache path. Use an empty cacheDirPath to use the default path.
|
||||
|
||||
If the cache dir was changed from its previous value, subnetter will attempt to create it.
|
||||
*/
|
||||
func SetCachePath(cacheDirPath string) (err error) {
|
||||
|
||||
var oldPath string = cacheDir
|
||||
|
||||
if cacheDirPath == "" {
|
||||
if cacheDirPath, err = getDefCachePath(); err != nil {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
if err = paths.RealPath(&cacheDirPath); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if cacheDirPath != oldPath {
|
||||
if err = os.MkdirAll(cacheDir, cacheDirPerms); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func checkCache() (hasCache bool, err error) {
|
||||
|
||||
var numCached uint8
|
||||
var cacheDirEntries []fs.DirEntry
|
||||
|
||||
if cacheDir == "" {
|
||||
if cacheDir, err = getDefCachePath(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if cacheDirEntries, err = os.ReadDir(cacheDir); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
for _, entry := range cacheDirEntries {
|
||||
if entry.IsDir() {
|
||||
continue
|
||||
}
|
||||
switch entry.Name() {
|
||||
case ianaSpecial4Cache, ianaSpecial6Cache:
|
||||
numCached++
|
||||
}
|
||||
if numCached >= 2 {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
hasCache = numCached > 2 && ianaReserved4 != nil && ianaReserved6 != nil
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func getDefCachePath() (val string, err error) {
|
||||
|
||||
if envs.HasEnv(cachedirEnvName) {
|
||||
val = os.Getenv(cachedirEnvName)
|
||||
} else {
|
||||
if val, err = os.UserCacheDir(); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
if err = paths.RealPath(&val); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func getLive() (dat4, dat6 []byte, err error) {
|
||||
|
||||
var wg sync.WaitGroup
|
||||
var errChan chan error
|
||||
var doneChan chan bool
|
||||
var mErr *multierr.MultiError
|
||||
var numJobs int = 2
|
||||
|
||||
doneChan = make(chan bool, 1)
|
||||
mErr = multierr.NewMultiError(nil)
|
||||
wg.Add(numJobs)
|
||||
errChan = make(chan error, numJobs)
|
||||
|
||||
if cacheClient == nil {
|
||||
cacheClient = resty.New()
|
||||
}
|
||||
|
||||
// IPv4
|
||||
go func() {
|
||||
var rErr error
|
||||
var req *resty.Request
|
||||
var resp *resty.Response
|
||||
var dat *IANARegistry = new(IANARegistry)
|
||||
|
||||
defer wg.Done()
|
||||
|
||||
req = cacheClient.R()
|
||||
req.SetResult(dat)
|
||||
|
||||
if resp, rErr = req.Get(ianaSpecial4); rErr != nil {
|
||||
errChan <- rErr
|
||||
return
|
||||
}
|
||||
if resp.StatusCode() != http.StatusOK {
|
||||
errChan <- errors.New(resp.Status())
|
||||
return
|
||||
}
|
||||
|
||||
ianaReserved4 = new(IANARegistry)
|
||||
*ianaReserved4 = *dat
|
||||
|
||||
if dat4, rErr = json.Marshal(dat); rErr != nil {
|
||||
errChan <- rErr
|
||||
return
|
||||
}
|
||||
|
||||
}()
|
||||
|
||||
// IPv6
|
||||
go func() {
|
||||
var rErr error
|
||||
var req *resty.Request
|
||||
var resp *resty.Response
|
||||
var dat *IANARegistry = new(IANARegistry)
|
||||
|
||||
defer wg.Done()
|
||||
|
||||
req = cacheClient.R()
|
||||
req.SetResult(dat)
|
||||
|
||||
if resp, rErr = req.Get(ianaSpecial6); rErr != nil {
|
||||
errChan <- rErr
|
||||
return
|
||||
}
|
||||
if resp.StatusCode() != http.StatusOK {
|
||||
errChan <- errors.New(resp.Status())
|
||||
return
|
||||
}
|
||||
|
||||
if dat6, rErr = json.Marshal(dat); rErr != nil {
|
||||
errChan <- rErr
|
||||
return
|
||||
}
|
||||
}()
|
||||
|
||||
go func() {
|
||||
wg.Wait()
|
||||
close(errChan)
|
||||
doneChan <- true
|
||||
}()
|
||||
|
||||
<-doneChan
|
||||
|
||||
for i := 0; i < numJobs; i++ {
|
||||
if err = <-errChan; err != nil {
|
||||
mErr.AddError(err)
|
||||
err = nil
|
||||
}
|
||||
}
|
||||
|
||||
if !mErr.IsEmpty() {
|
||||
err = mErr
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func readCache() (dat4, dat6 []byte, err error) {
|
||||
|
||||
if dat4, err = os.ReadFile(filepath.Join(cacheDir, ianaSpecial4Cache)); err != nil {
|
||||
return
|
||||
}
|
||||
if dat6, err = os.ReadFile(filepath.Join(cacheDir, ianaSpecial6Cache)); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func writeCache(dat4, dat6 []byte) (err error) {
|
||||
|
||||
if err = os.WriteFile(
|
||||
filepath.Join(cacheDir, ianaSpecial4Cache),
|
||||
dat4,
|
||||
cacheFilePerms,
|
||||
); err != nil {
|
||||
return
|
||||
}
|
||||
if err = os.WriteFile(
|
||||
filepath.Join(cacheDir, ianaSpecial6Cache),
|
||||
dat6,
|
||||
cacheFilePerms,
|
||||
); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
47
netsplit/funcs_ianabool.go
Normal file
47
netsplit/funcs_ianabool.go
Normal file
@ -0,0 +1,47 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`encoding/xml`
|
||||
`errors`
|
||||
`io`
|
||||
`strings`
|
||||
)
|
||||
|
||||
func (i *IANABool) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err error) {
|
||||
|
||||
var tok xml.Token
|
||||
|
||||
for {
|
||||
if tok, err = d.Token(); err != nil {
|
||||
if errors.Is(err, io.EOF) {
|
||||
err = nil
|
||||
break
|
||||
}
|
||||
return
|
||||
}
|
||||
switch t := tok.(type) {
|
||||
case xml.CharData:
|
||||
switch strings.TrimSpace(string(t)) {
|
||||
case ianaTrue:
|
||||
i.Evaluated = new(bool)
|
||||
*i.Evaluated = true
|
||||
case ianaFalse:
|
||||
i.Evaluated = new(bool)
|
||||
*i.Evaluated = false
|
||||
case ianaNA:
|
||||
i.Applicable = new(bool)
|
||||
*i.Applicable = false
|
||||
/*
|
||||
default:
|
||||
fmt.Printf("Unknown bool: %s\n", tok)
|
||||
*/
|
||||
}
|
||||
/*
|
||||
default:
|
||||
spew.Dump(t)
|
||||
*/
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
53
netsplit/funcs_ianadate.go
Normal file
53
netsplit/funcs_ianadate.go
Normal file
@ -0,0 +1,53 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`strings`
|
||||
`time`
|
||||
)
|
||||
|
||||
// MarshalText lets an IANADate conform to an encoding.TextMarshaler.
|
||||
func (i *IANADate) MarshalText() (text []byte, err error) {
|
||||
|
||||
if i == nil {
|
||||
return
|
||||
}
|
||||
|
||||
if time.Time(*i).Day() == 0 {
|
||||
text = []byte(time.Time(*i).Format(ianaMonthTfmt))
|
||||
} else {
|
||||
text = []byte(time.Time(*i).Format(ianaDateTfmt))
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// UnmarshalText lets an IANADate conform to an encoding.TextUnmarshaler.
|
||||
func (i *IANADate) UnmarshalText(text []byte) (err error) {
|
||||
|
||||
var t time.Time
|
||||
|
||||
if text == nil {
|
||||
return
|
||||
}
|
||||
|
||||
switch len(string(text)) {
|
||||
case 7: // no day
|
||||
if t, err = time.Parse(
|
||||
ianaMonthTfmt,
|
||||
strings.TrimSpace(string(text)),
|
||||
); err != nil {
|
||||
return
|
||||
}
|
||||
default: // TECHNICALLY should be 10 but we'll let the error here catch it otherwise.
|
||||
if t, err = time.Parse(
|
||||
ianaDateTfmt,
|
||||
strings.TrimSpace(string(text)),
|
||||
); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
*i = IANADate(t)
|
||||
|
||||
return
|
||||
}
|
||||
65
netsplit/funcs_ianaprefix.go
Normal file
65
netsplit/funcs_ianaprefix.go
Normal file
@ -0,0 +1,65 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`encoding/xml`
|
||||
`errors`
|
||||
`fmt`
|
||||
`io`
|
||||
`net/netip`
|
||||
`strings`
|
||||
)
|
||||
|
||||
// UnmarshalXML conforms an IANAPrefix to (encoding/xml).Unmarshaler.
|
||||
func (i *IANAPrefix) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err error) {
|
||||
|
||||
var tok xml.Token
|
||||
var nextRefIdx int
|
||||
var ref *IANARef
|
||||
var pfxStr []string
|
||||
var sb *strings.Builder = new(strings.Builder)
|
||||
|
||||
for {
|
||||
if tok, err = d.Token(); err != nil {
|
||||
if errors.Is(err, io.EOF) {
|
||||
err = nil
|
||||
break
|
||||
}
|
||||
return
|
||||
}
|
||||
switch t := tok.(type) {
|
||||
case xml.CharData:
|
||||
sb.Write(t)
|
||||
case xml.StartElement:
|
||||
switch t.Name.Local {
|
||||
case "xref":
|
||||
ref = new(IANARef)
|
||||
if err = d.DecodeElement(ref, &t); err != nil {
|
||||
return
|
||||
}
|
||||
if i.References == nil {
|
||||
i.References = make([]*IANARef, 0)
|
||||
}
|
||||
i.References = append(i.References, ref)
|
||||
// No reference for these; they should be only network addrs.
|
||||
// fmt.Fprintf(sb, "[REF %d]", nextRefIdx)
|
||||
nextRefIdx++
|
||||
default:
|
||||
fmt.Println(t.Name.Local)
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pfxStr = strings.Split(sb.String(), ",")
|
||||
i.Prefixes = make([]*netip.Prefix, len(pfxStr))
|
||||
for idx, p := range pfxStr {
|
||||
i.Prefixes[idx] = new(netip.Prefix)
|
||||
if *i.Prefixes[idx], err = netip.ParsePrefix(
|
||||
strings.TrimSpace(p),
|
||||
); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
27
netsplit/funcs_ianaregistryfootnote.go
Normal file
27
netsplit/funcs_ianaregistryfootnote.go
Normal file
@ -0,0 +1,27 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`encoding/xml`
|
||||
`strconv`
|
||||
)
|
||||
|
||||
func (i *IANARegistryFootnote) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err error) {
|
||||
|
||||
var u64 uint64
|
||||
|
||||
for _, a := range start.Attr {
|
||||
switch a.Name.Local {
|
||||
case "anchor":
|
||||
if u64, err = strconv.ParseUint(a.Value, 10, 64); err != nil {
|
||||
return
|
||||
}
|
||||
i.ReferenceIdx = uint(u64)
|
||||
}
|
||||
}
|
||||
|
||||
if err = d.DecodeElement(&i.Note, &start); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
51
netsplit/funcs_ianastring.go
Normal file
51
netsplit/funcs_ianastring.go
Normal file
@ -0,0 +1,51 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`encoding/xml`
|
||||
`errors`
|
||||
`fmt`
|
||||
`io`
|
||||
`strings`
|
||||
)
|
||||
|
||||
func (i *IANAString) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err error) {
|
||||
|
||||
var tok xml.Token
|
||||
var nextRefIdx int
|
||||
var ref *IANARef
|
||||
var sb *strings.Builder = new(strings.Builder)
|
||||
|
||||
for {
|
||||
if tok, err = d.Token(); err != nil {
|
||||
if errors.Is(err, io.EOF) {
|
||||
err = nil
|
||||
break
|
||||
}
|
||||
return
|
||||
}
|
||||
switch t := tok.(type) {
|
||||
case xml.CharData:
|
||||
sb.Write(t)
|
||||
case xml.StartElement:
|
||||
switch t.Name.Local {
|
||||
case "xref":
|
||||
ref = new(IANARef)
|
||||
if err = d.DecodeElement(ref, &t); err != nil {
|
||||
return
|
||||
}
|
||||
if i.References == nil {
|
||||
i.References = make([]*IANARef, 0)
|
||||
}
|
||||
i.References = append(i.References, ref)
|
||||
fmt.Fprintf(sb, "[REF %d]", nextRefIdx)
|
||||
nextRefIdx++
|
||||
default:
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
i.Text = strings.TrimSpace(sb.String())
|
||||
|
||||
return
|
||||
}
|
||||
@ -1,20 +0,0 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`log`
|
||||
`net/netip`
|
||||
)
|
||||
|
||||
func init() {
|
||||
var err error
|
||||
var pfx netip.Prefix
|
||||
|
||||
ReservedNets = make(map[netip.Prefix]string)
|
||||
|
||||
for np, reason := range reservedNetsOrig {
|
||||
if pfx, err = netip.ParsePrefix(np); err != nil {
|
||||
log.Panicln(err)
|
||||
}
|
||||
ReservedNets[pfx] = reason
|
||||
}
|
||||
}
|
||||
37
netsplit/tcache_test.go
Normal file
37
netsplit/tcache_test.go
Normal file
@ -0,0 +1,37 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`fmt`
|
||||
`net/netip`
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCache(t *testing.T) {
|
||||
|
||||
var err error
|
||||
var ip4 IANARegistry
|
||||
var ip6 IANARegistry
|
||||
var reserved map[netip.Prefix]*IANAAddrNetResRecord
|
||||
|
||||
if err = SetCachePath("/tmp/subnetter_cache_test"); err != nil {
|
||||
return
|
||||
}
|
||||
if err = EnableCache(true); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if ip4, ip6, reserved, err = RetrieveReserved(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Printf("IPv4: '%s'\n", ip4.Title)
|
||||
fmt.Printf("IPv6: '%s'\n", ip6.Title)
|
||||
fmt.Printf("IPv4 (Internal): '%s'\n", ianaReserved4.Title)
|
||||
fmt.Printf("IPv6 (Internal): '%s'\n", ianaReserved6.Title)
|
||||
fmt.Printf("%d Reserved Networks\n", len(reserved))
|
||||
fmt.Printf("%d Reserved Networks (Internal)\n", len(reservedNets))
|
||||
|
||||
if err = CleanCache(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
55
netsplit/tiana_test.go
Normal file
55
netsplit/tiana_test.go
Normal file
@ -0,0 +1,55 @@
|
||||
package netsplit
|
||||
|
||||
import (
|
||||
`encoding/json`
|
||||
`fmt`
|
||||
`net/http`
|
||||
"testing"
|
||||
|
||||
`github.com/go-resty/resty/v2`
|
||||
`github.com/goccy/go-yaml`
|
||||
)
|
||||
|
||||
func TestIANA(t *testing.T) {
|
||||
|
||||
var err error
|
||||
var b []byte
|
||||
var req *resty.Request
|
||||
var resp *resty.Response
|
||||
var reg *IANARegistry
|
||||
var client *resty.Client = resty.New()
|
||||
|
||||
// IPv4
|
||||
req = client.R()
|
||||
reg = new(IANARegistry)
|
||||
req.SetResult(reg)
|
||||
if resp, err = req.Get(ianaSpecial4); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if resp.StatusCode() != http.StatusOK {
|
||||
t.Fatal(resp.Status())
|
||||
}
|
||||
|
||||
if b, err = json.MarshalIndent(reg, "", " "); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
fmt.Println(string(b))
|
||||
|
||||
// IPv6
|
||||
req = client.R()
|
||||
reg = new(IANARegistry)
|
||||
req.SetResult(reg)
|
||||
if resp, err = req.Get(ianaSpecial6); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if resp.StatusCode() != http.StatusOK {
|
||||
t.Fatal(resp.Status())
|
||||
}
|
||||
|
||||
if b, err = yaml.Marshal(reg); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
fmt.Println(string(b))
|
||||
|
||||
_ = b
|
||||
}
|
||||
@ -4,6 +4,7 @@ import (
|
||||
"encoding/xml"
|
||||
"net"
|
||||
"net/netip"
|
||||
`time`
|
||||
|
||||
"go4.org/netipx"
|
||||
)
|
||||
@ -100,6 +101,8 @@ type StructuredResults struct {
|
||||
Allocated []*ContainedResult `json:"subnets" xml:"subnets>subnet,omitempty" yaml:"Subnets"`
|
||||
// Unallocated contains subnets from Original that did not meet the splitting criteria or were left over from the split operation.
|
||||
Unallocated []*ContainedResult `json:"remaining" xml:"remaining>subnet,omitempty" yaml:"Remaining/Unallocated/Left Over,omitempty"`
|
||||
// Reservations contains any reserved addresses/prefixes within this set that are considered "special usage" and thus are likely to not be usable.
|
||||
Reservations []*IANAAddrNetResRecord `json:"reserved,omitempty" xml:"reserved>reservation,omitempty" yaml:"Matching Reserved Subnets,omitempty"`
|
||||
}
|
||||
|
||||
type SplitOpts struct {
|
||||
@ -115,3 +118,76 @@ type ContainedResult struct {
|
||||
XMLName xml.Name `json:"-" yaml:"-" xml:"subnet"`
|
||||
Network *netip.Prefix `json:"net" xml:"net,attr,omitempty" yaml:"network,omitempty"`
|
||||
}
|
||||
|
||||
type IANADate time.Time
|
||||
|
||||
/*
|
||||
WHAT a PITA.
|
||||
IANA publishes their reservations in XML (YAY!) ... except they use inner XML all over the place
|
||||
in their text.
|
||||
So.
|
||||
*/
|
||||
type IANARegistry struct {
|
||||
XMLName xml.Name `json:"-" yaml:"-" xml:"registry"`
|
||||
Title string `json:"title" yaml:"Title" xml:"title"`
|
||||
Category string `json:"category,omitempty" yaml:"Category,omitempty" xml:"category,omitempty"`
|
||||
Created IANADate `json:"created" yaml:"Created" xml:"created"`
|
||||
Updated *IANADate `json:"updated,omitempty" yaml:"Updated,omitempty" xml:"updated,omitempty"`
|
||||
Notice *IANARegistryData `json:"notice" yaml:"Notice" xml:"registry"`
|
||||
Footnotes []*IANARegistryFootnote `json:"footnotes,omitempty" yaml:"Footnotes,omitempty" xml:"footnote,omitempty"`
|
||||
}
|
||||
|
||||
type IANAPrefix struct {
|
||||
// IANA may include multiple prefixes in the same record.
|
||||
Prefixes []*netip.Prefix `json:"prefix" yaml:"prefix" xml:"prefixes>prefix,attr"`
|
||||
References []*IANARef `json:"refs,omitempty" yaml:"References,omitempty" xml:"refs,omitempty"`
|
||||
}
|
||||
|
||||
type IANAString struct {
|
||||
Text string `json:"text" yaml:"Text" xml:"text"`
|
||||
References []*IANARef `json:"refs" yaml:"References" xml:"references"`
|
||||
}
|
||||
|
||||
type IANARegistryFootnote struct {
|
||||
XMLName xml.Name `json:"-" yaml:"-" xml:"footnote"`
|
||||
ReferenceIdx uint `json:"ref" yaml:"Reference Index/ID" xml:"anchor,attr"`
|
||||
Note *IANAString `json:"note" yaml:"Note" xml:"node"`
|
||||
}
|
||||
|
||||
type IANARegistryData struct {
|
||||
XMLName xml.Name `json:"-" yaml:"-" xml:"registry"`
|
||||
ID string `json:"id" yaml:"ID" xml:"id,attr"`
|
||||
Title string `json:"title" yaml:"Title" xml:"title"`
|
||||
Refs []*IANARef `json:"refs" yaml:"Referencess" xml:"xref"`
|
||||
Rule string `json:"rule" yaml:"Registration Rule" xml:"registration_rule"`
|
||||
Note *IANAString `json:"note,omitempty" yaml:"Note,omitempty" xml:"note,omitempty"`
|
||||
Records []*IANAAddrNetResRecord `json:"records,omitempty" yaml:"Records,omitempty" xml:"record,omitempty"`
|
||||
}
|
||||
|
||||
// IANARef is used to hold references to RFCs etc.
|
||||
type IANARef struct {
|
||||
XMLName xml.Name `json:"-" yaml:"-" xml:"xref"`
|
||||
Type string `json:"type" yaml:"Type" xml:"type,attr"`
|
||||
// TODO: This may have inner XML.
|
||||
Reference string `json:"ref" yaml:"Reference ID" xml:"data,attr"`
|
||||
}
|
||||
|
||||
type IANABool struct {
|
||||
Applicable *bool `json:"applicable,omitempty" yaml:"Is Applicable,omitempty" xml:"applicable,attr,omitempty"`
|
||||
Evaluated *bool `json:"bool,omitempty" yaml:"As Boolean,omitempty" xml:"evaluated,attr,omitempty"`
|
||||
}
|
||||
type IANAAddrNetResRecord struct {
|
||||
XMLName xml.Name `json:"-" yaml:"-" xml:"record"`
|
||||
Updated *IANADate `json:"updated,omitempty" xml:"updated,omitempty"`
|
||||
Networks *IANAPrefix `json:"net,omitempty" yaml:"Address/Network,omitempty" xml:"address,omitempty"`
|
||||
Name string `json:"name" yaml:"Name" xml:"name"`
|
||||
// TODO: This has inner XML.
|
||||
Spec *IANAString `json:"spec" yaml:"Spec" xml:"spec"`
|
||||
Allocation IANADate `json:"alloc" yaml:"Allocation Month" xml:"allocation"`
|
||||
Termination *IANADate `json:"term,omitempty" yaml:"Termination,omitempty" xml:"termination,omitempty"`
|
||||
Source *IANABool `json:"source,omitempty" yaml:"Is Source,omitempty" xml:"source,omitempty"`
|
||||
Dest *IANABool `json:"dest,omitempty" yaml:"Is Destination,omitempty" xml:"dest,omitempty"`
|
||||
Forwardable *IANABool `json:"forwardable,omitempty" yaml:"Is Forwardable,omitempty" xml:"forwardable,omitempty"`
|
||||
GlobalReach *IANABool `json:"global,omitempty" yaml:"Is Globally Reachable,omitempty" xml:"global,omitempty"`
|
||||
ProtoReserved *IANABool `json:"reserved,omitempty" yaml:"Is Reserved by Protocol,omitempty" xml:"reserved,omitempty"`
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user