1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
package maxminddb
import (
"errors"
"fmt"
"iter"
"net/netip"
"github.com/oschwald/maxminddb-golang/v2/internal/mmdberrors"
)
// Internal structure used to keep track of nodes we still need to visit.
type netNode struct {
ip netip.Addr
bit uint
pointer uint
}
type networkOptions struct {
includeAliasedNetworks bool
includeEmptyNetworks bool
skipEmptyValues bool
}
var (
allIPv4 = netip.MustParsePrefix("0.0.0.0/0")
allIPv6 = netip.MustParsePrefix("::/0")
)
// NetworksOption are options for Networks and NetworksWithin.
type NetworksOption func(*networkOptions)
// IncludeAliasedNetworks is an option for Networks and NetworksWithin
// that makes them iterate over aliases of the IPv4 subtree in an IPv6
// database, e.g., ::ffff:0:0/96, 2001::/32, and 2002::/16.
func IncludeAliasedNetworks() NetworksOption {
return func(networks *networkOptions) {
networks.includeAliasedNetworks = true
}
}
// IncludeNetworksWithoutData is an option for Networks and NetworksWithin
// that makes them include networks without any data in the iteration.
func IncludeNetworksWithoutData() NetworksOption {
return func(networks *networkOptions) {
networks.includeEmptyNetworks = true
}
}
// SkipEmptyValues is an option for Networks and NetworksWithin that makes
// them skip networks whose data is an empty map or empty array. This is
// useful for databases that store empty maps or arrays for records without
// meaningful data, allowing iteration over only records with actual content.
func SkipEmptyValues() NetworksOption {
return func(networks *networkOptions) {
networks.skipEmptyValues = true
}
}
// Networks returns an iterator that can be used to traverse the networks in
// the database.
//
// Please note that a MaxMind DB may map IPv4 networks into several locations
// in an IPv6 database. This iterator will only iterate over these once by
// default. To iterate over all the IPv4 network locations, use the
// [IncludeAliasedNetworks] option.
//
// Networks without data are excluded by default. To include them, use
// [IncludeNetworksWithoutData].
func (r *Reader) Networks(options ...NetworksOption) iter.Seq[Result] {
if r.Metadata.IPVersion == 6 {
return r.NetworksWithin(allIPv6, options...)
}
return r.NetworksWithin(allIPv4, options...)
}
// NetworksWithin returns an iterator that can be used to traverse the networks
// in the database which are contained in a given prefix.
//
// Please note that a MaxMind DB may map IPv4 networks into several locations
// in an IPv6 database. This iterator will only iterate over these once by
// default. To iterate over all the IPv4 network locations, use the
// [IncludeAliasedNetworks] option.
//
// If the provided prefix is contained within a network in the database, the
// iterator will iterate over exactly one network, the containing network.
//
// Networks without data are excluded by default. To include them, use
// [IncludeNetworksWithoutData].
func (r *Reader) NetworksWithin(prefix netip.Prefix, options ...NetworksOption) iter.Seq[Result] {
return func(yield func(Result) bool) {
if !prefix.IsValid() {
yield(Result{
err: errors.New("invalid prefix"),
})
return
}
if r.Metadata.IPVersion == 4 && prefix.Addr().Is6() {
yield(Result{
err: fmt.Errorf(
"error getting networks with '%s': you attempted to use an IPv6 network in an IPv4-only database",
prefix,
),
})
return
}
n := &networkOptions{}
for _, option := range options {
option(n)
}
ip := prefix.Addr()
netIP := ip
stopBit := prefix.Bits()
if ip.Is4() {
netIP = v4ToV16(ip)
stopBit += 96
}
if stopBit > 128 {
yield(Result{
err: errors.New("invalid prefix: exceeds IPv6 maximum of 128 bits"),
})
return
}
pointer, bit, err := r.traverseTree(ip, 0, stopBit)
if err != nil {
yield(Result{
ip: ip,
err: err,
})
return
}
prefix, err := netIP.Prefix(bit)
if err != nil {
yield(Result{
ip: ip,
prefixLen: uint8(bit),
err: fmt.Errorf("prefixing %s with %d", netIP, bit),
})
return
}
nodes := make([]netNode, 0, 64)
nodes = append(nodes,
netNode{
ip: prefix.Addr(),
bit: uint(bit),
pointer: pointer,
},
)
for len(nodes) > 0 {
node := nodes[len(nodes)-1]
nodes = nodes[:len(nodes)-1]
for {
if node.pointer == r.Metadata.NodeCount {
if n.includeEmptyNetworks {
ok := yield(Result{
ip: mappedIP(node.ip),
offset: notFound,
prefixLen: uint8(node.bit),
})
if !ok {
return
}
}
break
}
// This skips IPv4 aliases without hardcoding the networks that the writer
// currently aliases.
if !n.includeAliasedNetworks && r.ipv4Start != 0 &&
node.pointer == r.ipv4Start && !isInIPv4Subtree(node.ip) {
break
}
if node.pointer > r.Metadata.NodeCount {
offset, err := r.resolveDataPointer(node.pointer)
// Check if we should skip empty values (only if no error)
if err == nil && n.skipEmptyValues {
var isEmpty bool
isEmpty, err = r.decoder.IsEmptyValueAt(uint(offset))
if err == nil && isEmpty {
// Skip this empty value
break
}
}
ok := yield(Result{
reader: r,
ip: mappedIP(node.ip),
offset: uint(offset),
prefixLen: uint8(node.bit),
err: err,
})
if !ok {
return
}
break
}
ipRight := node.ip.As16()
if len(ipRight) <= int(node.bit>>3) {
displayAddr := node.ip
if isInIPv4Subtree(node.ip) {
displayAddr = v6ToV4(displayAddr)
}
res := Result{
ip: displayAddr,
prefixLen: uint8(node.bit),
}
res.err = mmdberrors.NewInvalidDatabaseError(
"invalid search tree at %s", res.Prefix())
yield(res)
return
}
ipRight[node.bit>>3] |= 1 << (7 - (node.bit % 8))
offset := node.pointer * r.nodeOffsetMult
rightPointer, err := readNodeBySize(r.buffer, offset, 1, r.Metadata.RecordSize)
if err != nil {
yield(Result{
ip: mappedIP(node.ip),
prefixLen: uint8(node.bit),
err: err,
})
return
}
node.bit++
nodes = append(nodes, netNode{
pointer: rightPointer,
ip: netip.AddrFrom16(ipRight),
bit: node.bit,
})
leftPointer, err := readNodeBySize(r.buffer, offset, 0, r.Metadata.RecordSize)
if err != nil {
yield(Result{
ip: mappedIP(node.ip),
prefixLen: uint8(node.bit),
err: err,
})
return
}
node.pointer = leftPointer
}
}
}
}
var ipv4SubtreeBoundary = netip.MustParseAddr("::255.255.255.255").Next()
func mappedIP(ip netip.Addr) netip.Addr {
if isInIPv4Subtree(ip) {
return v6ToV4(ip)
}
return ip
}
// isInIPv4Subtree returns true if the IP is in the database's IPv4 subtree.
func isInIPv4Subtree(ip netip.Addr) bool {
return ip.Is4() || ip.Less(ipv4SubtreeBoundary)
}
// We store IPv4 addresses at ::/96 for unclear reasons.
func v4ToV16(ip netip.Addr) netip.Addr {
b4 := ip.As4()
var b16 [16]byte
copy(b16[12:], b4[:])
return netip.AddrFrom16(b16)
}
// Converts an IPv4 address embedded in IPv6 to IPv4.
func v6ToV4(ip netip.Addr) netip.Addr {
b := ip.As16()
v, _ := netip.AddrFromSlice(b[12:])
return v
}
|