From 591cdcda7ef471b5f91b622beac1506f1b3dff6e Mon Sep 17 00:00:00 2001 From: sharevb Date: Sun, 14 Apr 2024 14:49:07 +0200 Subject: [PATCH] feat(utils): IPv4/6 Utils Network Type, Subnets and counts, 6to4 prefix, ARPA, IPv4 Mapped Parse IP/Mask/Range as CIDR --- package.json | 1 + src/utils/ip.test.ts | 232 ++++++++++++++++++++++++++++++++++++ src/utils/ip.ts | 147 +++++++++++++++++++++++ src/utils/ipv4registry.json | 27 +++++ src/utils/ipv6registry.json | 24 ++++ 5 files changed, 431 insertions(+) create mode 100644 src/utils/ip.test.ts create mode 100644 src/utils/ip.ts create mode 100644 src/utils/ipv4registry.json create mode 100644 src/utils/ipv6registry.json diff --git a/package.json b/package.json index f116ae1f..67b5c5b6 100644 --- a/package.json +++ b/package.json @@ -66,6 +66,7 @@ "ip-address": "^9.0.5", "ip-bigint": "^8.0.2", "ip-cidr": "^4.0.0", + "ip-matching": "^2.1.2", "is-cidr": "^5.0.3", "is-ip": "^5.0.1", "json5": "^2.2.3", diff --git a/src/utils/ip.test.ts b/src/utils/ip.test.ts new file mode 100644 index 00000000..6fdee458 --- /dev/null +++ b/src/utils/ip.test.ts @@ -0,0 +1,232 @@ +import { describe, expect, it } from 'vitest'; +import { getIPNetworkType, getNetworksCount, getSubnets, parseAsCIDR, to6to4Prefix, toARPA, toIPv4MappedAddress, toIPv4MappedAddressDecimal } from './ip'; + +describe('ipv4/6 util', () => { + describe('parseAsCIDR', () => { + it('returns cidr', () => { + expect(parseAsCIDR('1.1.1.1/6')).to.eql('1.1.1.1/6'); + expect(parseAsCIDR('172.16.2.2/16')).to.eql('172.16.2.2/16'); + expect(parseAsCIDR('1a:b:c::d:e:f/ffff:ffff:f4ff:ffff:ffff:ff5f:ffff:ff00')).to.eql(); + expect(parseAsCIDR('10.1.2.3/255.255.255.252')).to.eql('10.1.2.0/30'); + expect(parseAsCIDR('10.*.0.*')).to.eql(); + expect(parseAsCIDR('10.1.0.*')).to.eql('10.1.0.0/24'); + expect(parseAsCIDR('10.2.*.*')).to.eql('10.2.0.0/16'); + expect(parseAsCIDR('a:b:0:8000::/ffff:ffff:ffff:8000::')).to.eql('a:b:0:8000::/49'); + expect(parseAsCIDR('::/::')).to.eql('::/0'); + expect(parseAsCIDR('10.20.30.64-10.20.30.127')).to.eql('10.20.30.64/26'); + expect(parseAsCIDR('10.0.128.0/255.0.128.0')).to.eql(); + expect(parseAsCIDR('a::bc:1234/128')).to.eql('a::bc:1234/128'); + expect(parseAsCIDR('a::bc:ff00-a::bc:ff0f')).to.eql('a::bc:ff00/124'); + expect(parseAsCIDR('10.0.1.1/255.255.1.0')).to.eql(); + expect(parseAsCIDR('10.0.0.0/255.255.0.0')).to.eql('10.0.0.0/16'); + }); + }); + describe('getSubnets', () => { + it('returns subnets', () => { + expect(getSubnets('1.1.1.1/1')).to.eql([ + '0.0.0.0/1', + '128.0.0.0/1', + ]); + expect(getSubnets('1.1.1.1/6')).to.eql([ + '0.0.0.0/6', + '4.0.0.0/6', + '8.0.0.0/6', + '12.0.0.0/6', + '16.0.0.0/6', + '20.0.0.0/6', + '24.0.0.0/6', + '28.0.0.0/6', + '32.0.0.0/6', + '36.0.0.0/6', + '40.0.0.0/6', + '44.0.0.0/6', + '48.0.0.0/6', + '52.0.0.0/6', + '56.0.0.0/6', + '60.0.0.0/6', + '64.0.0.0/6', + '68.0.0.0/6', + '72.0.0.0/6', + '76.0.0.0/6', + '80.0.0.0/6', + '84.0.0.0/6', + '88.0.0.0/6', + '92.0.0.0/6', + '96.0.0.0/6', + '100.0.0.0/6', + '104.0.0.0/6', + '108.0.0.0/6', + '112.0.0.0/6', + '116.0.0.0/6', + '120.0.0.0/6', + '124.0.0.0/6', + '128.0.0.0/6', + '132.0.0.0/6', + '136.0.0.0/6', + '140.0.0.0/6', + '144.0.0.0/6', + '148.0.0.0/6', + '152.0.0.0/6', + '156.0.0.0/6', + '160.0.0.0/6', + '164.0.0.0/6', + '168.0.0.0/6', + '172.0.0.0/6', + '176.0.0.0/6', + '180.0.0.0/6', + '184.0.0.0/6', + '188.0.0.0/6', + '192.0.0.0/6', + '196.0.0.0/6', + '200.0.0.0/6', + '204.0.0.0/6', + '208.0.0.0/6', + '212.0.0.0/6', + '216.0.0.0/6', + '220.0.0.0/6', + '224.0.0.0/6', + '228.0.0.0/6', + '232.0.0.0/6', + '236.0.0.0/6', + '240.0.0.0/6', + '244.0.0.0/6', + '248.0.0.0/6', + '252.0.0.0/6', + ]); + expect(getSubnets('1.1.1.1/8')).to.eql([]); + expect(getSubnets('1.1.1.1/11')).to.eql([ + '1.0.0.0/11', + '1.32.0.0/11', + '1.64.0.0/11', + '1.96.0.0/11', + '1.128.0.0/11', + '1.160.0.0/11', + '1.192.0.0/11', + '1.224.0.0/11', + ]); + expect(getSubnets('172.16.2.2/16')).to.eql([]); + expect(getSubnets('172.16.2.2/26')).to.eql([ + '172.16.2.0/26', + '172.16.2.64/26', + '172.16.2.128/26', + '172.16.2.192/26', + ]); + expect(getSubnets('172.16.2.2/31').length).to.eql(128); + expect(getSubnets('255.255.255.0/32')).to.eql([]); + expect(getSubnets('2001:db8:0:85a3::ac1f:8001/62')).to.eql([]); + expect(getSubnets('2001:db8:0:85a3:0:0:ac1f:8001/62')).to.eql([]); + expect(getSubnets('2001:db8:0:85a3::ac1f:8001/112')).to.eql([]); + expect(getSubnets('2001:db8:0:85a3:0:0:ac1f:8001/112')).to.eql([]); + }); + }); + describe('getNetworksCount', () => { + it('returns networks count', () => { + expect(getNetworksCount('1.1.1.1/1')).to.eql(2); + expect(getNetworksCount('1.1.1.1/2')).to.eql(4); + expect(getNetworksCount('1.1.1.1/3')).to.eql(8); + expect(getNetworksCount('1.1.1.1/4')).to.eql(16); + expect(getNetworksCount('1.1.1.1/5')).to.eql(32); + expect(getNetworksCount('1.1.1.1/6')).to.eql(64); + expect(getNetworksCount('1.1.1.1/7')).to.eql(128); + expect(getNetworksCount('1.1.1.1/8')).to.eql(0); + expect(getNetworksCount('1.1.1.1/9')).to.eql(2); + expect(getNetworksCount('1.1.1.1/10')).to.eql(4); + expect(getNetworksCount('1.1.1.1/11')).to.eql(8); + expect(getNetworksCount('1.1.1.1/12')).to.eql(16); + expect(getNetworksCount('1.1.1.1/13')).to.eql(32); + expect(getNetworksCount('1.1.1.1/14')).to.eql(64); + expect(getNetworksCount('1.1.1.1/15')).to.eql(128); + expect(getNetworksCount('1.1.1.1/16')).to.eql(0); + expect(getNetworksCount('1.1.1.1/17')).to.eql(2); + expect(getNetworksCount('1.1.1.1/18')).to.eql(4); + expect(getNetworksCount('1.1.1.1/19')).to.eql(8); + expect(getNetworksCount('1.1.1.1/20')).to.eql(16); + expect(getNetworksCount('1.1.1.1/21')).to.eql(32); + expect(getNetworksCount('1.1.1.1/22')).to.eql(64); + expect(getNetworksCount('1.1.1.1/23')).to.eql(128); + expect(getNetworksCount('1.1.1.1/24')).to.eql(0); + expect(getNetworksCount('1.1.1.1/25')).to.eql(2); + expect(getNetworksCount('1.1.1.1/26')).to.eql(4); + expect(getNetworksCount('1.1.1.1/27')).to.eql(8); + expect(getNetworksCount('1.1.1.1/28')).to.eql(16); + expect(getNetworksCount('1.1.1.1/29')).to.eql(32); + expect(getNetworksCount('1.1.1.1/30')).to.eql(64); + expect(getNetworksCount('1.1.1.1/31')).to.eql(128); + expect(getNetworksCount('1.1.1.1/32')).to.eql(0); + expect(getNetworksCount('2001:db8:0:85a3::ac1f:8001/32')).to.eql(4294967296n); + expect(getNetworksCount('2001:db8:0:85a3::ac1f:8001/42')).to.eql(4194304n); + expect(getNetworksCount('2001:db8:0:85a3:0:0:ac1f:8001/62')).to.eql(4n); + expect(getNetworksCount('2001:db8:0:85a3::ac1f:8001/112')).to.eql(-1); + expect(getNetworksCount('2001:db8:0:85a3:0:0:ac1f:8001/122')).to.eql(-1); + }); + }); + describe('getIPNetworkType', () => { + it('returns network type', () => { + expect(getIPNetworkType('1.1.1.1')).to.eql('Public'); + expect(getIPNetworkType('10.10.1.1')).to.eql('Private Use'); + expect(getIPNetworkType('172.16.0.1')).to.eql('Private Use'); + expect(getIPNetworkType('192.168.1.1')).to.eql('Private Use'); + expect(getIPNetworkType('255.255.255.0')).to.eql('Reserved'); + expect(getIPNetworkType('224.0.0.1')).to.eql('Multicast'); + expect(getIPNetworkType('198.51.100.1')).to.eql('Documentation (TEST-NET-2)'); + expect(getIPNetworkType('198.18.0.1')).to.eql('Benchmarking'); + expect(getIPNetworkType('169.254.0.1')).to.eql('Link Local'); + expect(getIPNetworkType('127.0.0.1')).to.eql('Loopback'); + expect(getIPNetworkType('2001:db8:8:4::2')).to.eql('Documentation'); + expect(getIPNetworkType('FF02::2')).to.eql('Multicast address'); + expect(getIPNetworkType('2345:0425:2CA1:0000:0000:0567:5673:23b5')).to.eql('Public'); + expect(getIPNetworkType('fdf8:f53b:82e4::53')).to.eql('Unique-Local'); + expect(getIPNetworkType('::ffff:192.0.2.47')).to.eql('IPv4-mapped Address'); + expect(getIPNetworkType('::ffff:ac12:0a09')).to.eql('IPv4-mapped Address'); + expect(getIPNetworkType('::1')).to.eql('Loopback Address'); + expect(getIPNetworkType('fe80::200:5aee:feaa:20a2')).to.eql('Link-Local Unicast'); + expect(getIPNetworkType('2001:0002::6c::430')).to.eql('Benchmarking'); + expect(getIPNetworkType('2001:0000:4136:e378:8000:63bf:3fff:fdd2')).to.eql('TEREDO'); + expect(getIPNetworkType('2002:cb0a:3cdd:1::1')).to.eql('6to4'); + expect(getIPNetworkType('ff01:0:0:0:0:0:0:2')).to.eql('Multicast address'); + }); + }); + + describe('toARPA', () => { + it('returns ARPA address', () => { + expect(toARPA('1.1.1.1')).to.eql('1.1.1.1.in-addr.arpa'); + expect(toARPA('10.10.1.1')).to.eql('1.1.10.10.in-addr.arpa'); + expect(toARPA('192.168.1.1')).to.eql('1.1.168.192.in-addr.arpa'); + expect(toARPA('255.255.255.0')).to.eql('0.255.255.255.in-addr.arpa'); + expect(toARPA('FF02::2')).to.eql('2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.2.0.f.f.ip6.arpa.'); + expect(toARPA('2345:0425:2CA1:0000:0000:0567:5673:23b5')).to.eql('5.b.3.2.3.7.6.5.7.6.5.0.0.0.0.0.0.0.0.0.1.a.c.2.5.2.4.0.5.4.3.2.ip6.arpa.'); + expect(toARPA('fdf8:f53b:82e4::53')).to.eql('3.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.4.e.2.8.b.3.5.f.8.f.d.f.ip6.arpa.'); + expect(toARPA('::ffff:192.0.2.47')).to.eql('f.2.2.0.0.0.0.c.f.f.f.f.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa.'); + expect(toARPA('::1')).to.eql('1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa.'); + }); + }); + describe('toIPv4MappedAddress', () => { + it('returns IPv4MappedAddress', () => { + expect(toIPv4MappedAddress('1.1.1.1')).to.eql('::ffff:0101:0101'); + expect(toIPv4MappedAddress('10.10.1.1')).to.eql('::ffff:0a0a:0101'); + expect(toIPv4MappedAddress('172.18.10.9')).to.eql('::ffff:ac12:0a09'); + expect(toIPv4MappedAddress('192.168.1.1')).to.eql('::ffff:c0a8:0101'); + expect(toIPv4MappedAddress('255.255.255.0')).to.eql('::ffff:ffff:ff00'); + }); + }); + describe('toIPv4MappedAddressDecimal', () => { + it('returns networks count', () => { + expect(toIPv4MappedAddressDecimal('1.1.1.1')).to.eql('::ffff:1.1.1.1'); + expect(toIPv4MappedAddressDecimal('10.10.1.1')).to.eql('::ffff:10.10.1.1'); + expect(toIPv4MappedAddressDecimal('192.168.1.1')).to.eql('::ffff:192.168.1.1'); + expect(toIPv4MappedAddressDecimal('172.18.10.9')).to.eql('::ffff:172.18.10.9'); + expect(toIPv4MappedAddressDecimal('255.255.255.0')).to.eql('::ffff:255.255.255.0'); + expect(toIPv4MappedAddressDecimal('2001:db8:0:85a3::ac1f:8001')).to.eql(''); + }); + }); + describe('to6to4Prefix', () => { + it('returns networks count', () => { + expect(to6to4Prefix('1.1.1.1')).to.eql('2002:01:0:1:01:01::/48'); + expect(to6to4Prefix('10.10.1.1')).to.eql('2002:0a:0:a:01:01::/48'); + expect(to6to4Prefix('172.18.10.9')).to.eql('2002:ac:1:2:0a:09::/48'); + expect(to6to4Prefix('192.168.1.1')).to.eql('2002:c0:a:8:01:01::/48'); + expect(to6to4Prefix('255.255.255.0')).to.eql('2002:ff:f:f:ff:00::/48'); + expect(to6to4Prefix('2001:db8:0:85a3::ac1f:8001')).to.eql(''); + }); + }); +}); diff --git a/src/utils/ip.ts b/src/utils/ip.ts new file mode 100644 index 00000000..bd1c561e --- /dev/null +++ b/src/utils/ip.ts @@ -0,0 +1,147 @@ +import { isIPv4 } from 'is-ip'; +import { Address4, Address6 } from 'ip-address'; +import { contains as containsCidr } from 'cidr-tools'; +import type { IPMatch } from 'ip-matching'; +import { IPMask, IPSubnetwork, getMatch } from 'ip-matching'; +import isCidr from 'is-cidr'; +import ipv4registry from './ipv4registry.json'; +import ipv6registry from './ipv6registry.json'; + +const IPv4MAX = (BigInt(2) ** BigInt(32)) - BigInt(1); + +// IP range specific information, see IANA allocations. +// http://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml +const _ipv4Registry = new Map(ipv4registry.map(v => [v[0] as string, v[1]])); + +// https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml +const _ipv6Registry = new Map(ipv6registry.map(v => [v[0] as string, v[1]])); + +export function parseAsCIDR(form: string) { + if (isCidr(form)) { + return form; + } + + const ipMatch: IPMatch = getMatch(form); + if (ipMatch instanceof IPSubnetwork) { + return (ipMatch as IPSubnetwork).toString(); + } + if (ipMatch instanceof IPMask) { + return (ipMatch as IPMask).convertToSubnet()?.toString(); + } + return (ipMatch.convertToMasks() || [])[0]?.convertToSubnet()?.toString(); +} + +export function getSubnets(cidr: string) { + const [address, prefix] = cidr.split('/'); + if (isIPv4(address)) { + const prefix4Int = Number(prefix || '32'); + const getMask = (prefix: number) => (IPv4MAX >> (BigInt(32) - BigInt(prefix))) << (BigInt(32) - BigInt(prefix)); + const bigInt = BigInt((new Address4(address)).bigInteger()); + + const subnets = []; + let startNetwork; + if (prefix4Int < 8) { + startNetwork = 0; + } + if (prefix4Int % 8 === 0) { + return []; + } + startNetwork = bigInt & getMask(prefix4Int); + const increment = BigInt(2) ** BigInt(32 - prefix4Int); + const netCount = getNetworksCount(cidr); + for (let netIndex = 0; netIndex < netCount; netIndex += 1) { + const netAddr = Address4.fromBigInteger(startNetwork.toString()).correctForm(); + subnets.push(`${netAddr}/${prefix4Int}`); + startNetwork += increment; + } + return subnets; + } + + return []; +} + +export function getNetworksCount(cidr: string) { + const [address, prefix] = cidr.split('/'); + if (isIPv4(address)) { + const prefix4Int = Number(prefix || '32'); + + if (prefix4Int % 8 === 0) { + return 0; + } + else if (prefix4Int < 8) { + return 2 ** prefix4Int; + } + else if (prefix4Int < 16) { + return 2 ** (prefix4Int - 8); + } + else if (prefix4Int < 24) { + return 2 ** (prefix4Int - 16); + } + else { + return 2 ** (prefix4Int - 24); + } + } + + const prefix6Int = Number(prefix || '128'); + return prefix6Int <= 64 ? (BigInt(2) ** BigInt(64n - BigInt(prefix6Int))) : -1; +} + +export function getIPNetworkType(address: string) { + const results = []; + for (const [addr, info] of (isIPv4(address) ? _ipv4Registry : _ipv6Registry).entries()) { + const found = containsCidr([`${addr}/${Number(info[0])}`], address); + if (found) { + results.unshift(info[1]); + } + } + return results.length === 0 ? 'Public' : results[0]?.toString(); +} + +export function toARPA(address: string) { + if (isIPv4(address)) { + const bigInt = BigInt((new Address4(address)).bigInteger()); + const reverseIP = ( + [(bigInt & BigInt(255)), (bigInt >> BigInt(8) & BigInt(255)), + (bigInt >> BigInt(16) & BigInt(255)), + (bigInt >> BigInt(24) & BigInt(255)), + ].join('.') + ); + return `${reverseIP}.in-addr.arpa`; + } + + return (new Address6(address)).reverseForm(); +} + +export function toIPv4MappedAddress(address: string) { + if (!isIPv4(address)) { + return ''; + } + + const hexIP = (new Address4(address)).toHex().replace(/:/g, ''); + return `::ffff:${hexIP.substring(0, 4)}:${hexIP.substring(4)}`; +} + +export function toIPv4MappedAddressDecimal(address: string) { + if (!isIPv4(address)) { + return ''; + } + + return `::ffff:${address}`; +} + +export function to6to4Prefix(address: string) { + if (!isIPv4(address)) { + return ''; + } + + const hexIP = (new Address4(address)).toHex(); + return `2002:${hexIP.substring(0, 4)}:${hexIP.substring(4)}::/48`; +} + +export function toMicrosoftTranscription(address: string) { + if (!isIPv4(address)) { + return ''; + } + + return (new Address6(address)).microsoftTranscription(); +} diff --git a/src/utils/ipv4registry.json b/src/utils/ipv4registry.json new file mode 100644 index 00000000..e9e3c2dc --- /dev/null +++ b/src/utils/ipv4registry.json @@ -0,0 +1,27 @@ +[ + ["0.0.0.0", [8, "This host on this network"]], + ["10.0.0.0", [8, "Private Use"]], + ["100.64.0.0", [10, "Shared Address Space"]], + ["127.0.0.0", [8, "Loopback"]], + ["169.254.0.0", [16, "Link Local"]], + ["172.16.0.0", [12, "Private Use"]], + ["192.0.0.0", [24, "IETF Protocol Assignments"]], + ["192.0.0.0", [29, "IPv4 Service Continuity Prefix"]], + ["192.0.0.8", [32, "IPv4 dummy address"]], + ["192.0.0.9", [32, "Port Control Protocol Anycast"]], + ["192.0.0.10", [32, "Traversal Using Relays around NAT Anycast"]], + ["192.0.0.170", [32, "NAT64/DNS64 Discovery"]], + ["192.0.0.171", [32, "NAT64/DNS64 Discovery"]], + ["192.0.2.0", [24, "Documentation (TEST-NET-1)"]], + ["192.31.196.0", [24, "AS112-v4"]], + ["192.52.193.0", [24, "AMT"]], + ["192.88.99.0", [24, "Deprecated (6to4 Relay Anycast)"]], + ["192.168.0.0", [16, "Private Use"]], + ["192.175.48.0", [24, "Direct Delegation AS112 Service"]], + ["198.18.0.0", [15, "Benchmarking"]], + ["198.51.100.0", [24, "Documentation (TEST-NET-2)"]], + ["203.0.113.0", [24, "Documentation (TEST-NET-3)"]], + ["224.0.0.0", [24, "Multicast"]], + ["240.0.0.0", [4, "Reserved"]], + ["255.255.255.255", [32, "Limited Broadcast"]] +] \ No newline at end of file diff --git a/src/utils/ipv6registry.json b/src/utils/ipv6registry.json new file mode 100644 index 00000000..23c18f09 --- /dev/null +++ b/src/utils/ipv6registry.json @@ -0,0 +1,24 @@ +[ + ["::1", [128, "Loopback Address"]], + ["::", [128, "Unspecified Address"]], + ["::ffff::", [96, "IPv4-mapped Address"]], + ["64:ff9b::", [96, "IPv4-IPv6 Translat."]], + ["64:ff9b:1::", [48, "IPv4-IPv6 Translat."]], + ["100::", [64, "Discard-Only Address Block"]], + ["2001::", [23, "IETF Protocol Assignments"]], + ["2001::", [32, "TEREDO"]], + ["2001:1::1", [128, "Port Control Protocol Anycast"]], + ["2001:1::2", [128, "Traversal Using Relays around NAT Anycast"]], + ["2001:2::", [48, "Benchmarking"]], + ["2001:3::", [32, "AMT"]], + ["2001:4:112::", [48, "AS112-v6"]], + ["2001:5::", [32, "EID Space for LISP (Managed by RIPE NCC)"]], + ["2001:10::", [28, "Deprecated (previously ORCHID)"]], + ["2001:20::", [28, "ORCHIDv2"]], + ["2001:db8::", [32, "Documentation"]], + ["2002::", [16, "6to4"]], + ["2620:4f:8000::", [48, "Direct Delegation AS112 Service"]], + ["fc00::", [7, "Unique-Local"]], + ["fe80::", [10, "Link-Local Unicast"]], + ["ff00::", [8, "Multicast address"]] + ] \ No newline at end of file