{ "content": [ { "type": "text", "text": "# Net::CIDR (perldoc)\n\n## NAME\n\nNet::CIDR - Manipulate IPv4/IPv6 netblocks in CIDR notation\n\n## SYNOPSIS\n\nuse Net::CIDR;\nuse Net::CIDR ':all';\nmy $var;\nif ($var = Net::CIDR::cidrvalidate($var))\n{\n// ... do something\n}\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\"192.168.0.0-192.168.255.255\",\n\"10.0.0.0-10.3.255.255\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0/16\n# 10.0.0.0/14\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\n\"dead:beef::-dead:beef:ffff:ffff:ffff:ffff:ffff:ffff\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# dead:beef::/32\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\"192.168.1.0-192.168.2.255\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# 192.168.1.0/24\n# 192.168.2.0/24\nprint join(\"\\n\", Net::CIDR::cidr2range(\"192.168.0.0/16\")) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0-192.168.255.255\nprint join(\"\\n\", Net::CIDR::cidr2range(\"dead::beef::/46\")) . \"\\n\";\n#\n# Output from above:\n#\n# dead:beef::-dead:beef:3:ffff:ffff:ffff:ffff:ffff\n@list=(\"192.168.0.0/24\");\n@list=Net::CIDR::cidradd(\"192.168.1.0-192.168.1.255\", @list);\nprint join(\"\\n\", @list) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0/23\nprint join(\"\\n\", Net::CIDR::cidr2octets(\"192.168.0.0/22\")) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0\n# 192.168.1\n# 192.168.2\n# 192.168.3\nprint join(\"\\n\", Net::CIDR::cidr2octets(\"dead::beef::/46\")) . \"\\n\";\n#\n# Output from above:\n#\n# dead:beef:0000\n# dead:beef:0001\n# dead:beef:0002\n# dead:beef:0003\n@list=(\"192.168.0.0/24\");\nprint Net::CIDR::cidrlookup(\"192.168.0.12\", @list);\n#\n# Output from above:\n#\n# 1\n@list = Net::CIDR::addr2cidr(\"192.168.0.31\");\nprint join(\"\\n\", @list);\n#\n# Output from above:\n#\n# 192.168.0.31/32\n# 192.168.0.30/31\n# 192.168.0.28/30\n# 192.168.0.24/29\n# 192.168.0.16/28\n# 192.168.0.0/27\n# 192.168.0.0/26\n# 192.168.0.0/25\n# 192.168.0.0/24\n# 192.168.0.0/23\n# [and so on]\nprint Net::CIDR::addrandmask2cidr(\"195.149.50.61\", \"255.255.255.248\").\"\\n\";\n#\n# Output from above:\n#\n# 195.149.50.56/29\n\n## DESCRIPTION\n\nThe Net::CIDR package contains functions that manipulate lists of IP netblocks expressed in CIDR\nnotation. The Net::CIDR functions handle both IPv4 and IPv6 addresses.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (3 subsections)\n- **BUGS**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "Net::CIDR", "section": "", "mode": "perldoc", "summary": "Net::CIDR - Manipulate IPv4/IPv6 netblocks in CIDR notation", "synopsis": "use Net::CIDR;\nuse Net::CIDR ':all';\nmy $var;\nif ($var = Net::CIDR::cidrvalidate($var))\n{\n// ... do something\n}\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\"192.168.0.0-192.168.255.255\",\n\"10.0.0.0-10.3.255.255\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0/16\n# 10.0.0.0/14\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\n\"dead:beef::-dead:beef:ffff:ffff:ffff:ffff:ffff:ffff\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# dead:beef::/32\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\"192.168.1.0-192.168.2.255\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# 192.168.1.0/24\n# 192.168.2.0/24\nprint join(\"\\n\", Net::CIDR::cidr2range(\"192.168.0.0/16\")) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0-192.168.255.255\nprint join(\"\\n\", Net::CIDR::cidr2range(\"dead::beef::/46\")) . \"\\n\";\n#\n# Output from above:\n#\n# dead:beef::-dead:beef:3:ffff:ffff:ffff:ffff:ffff\n@list=(\"192.168.0.0/24\");\n@list=Net::CIDR::cidradd(\"192.168.1.0-192.168.1.255\", @list);\nprint join(\"\\n\", @list) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0/23\nprint join(\"\\n\", Net::CIDR::cidr2octets(\"192.168.0.0/22\")) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0\n# 192.168.1\n# 192.168.2\n# 192.168.3\nprint join(\"\\n\", Net::CIDR::cidr2octets(\"dead::beef::/46\")) . \"\\n\";\n#\n# Output from above:\n#\n# dead:beef:0000\n# dead:beef:0001\n# dead:beef:0002\n# dead:beef:0003\n@list=(\"192.168.0.0/24\");\nprint Net::CIDR::cidrlookup(\"192.168.0.12\", @list);\n#\n# Output from above:\n#\n# 1\n@list = Net::CIDR::addr2cidr(\"192.168.0.31\");\nprint join(\"\\n\", @list);\n#\n# Output from above:\n#\n# 192.168.0.31/32\n# 192.168.0.30/31\n# 192.168.0.28/30\n# 192.168.0.24/29\n# 192.168.0.16/28\n# 192.168.0.0/27\n# 192.168.0.0/26\n# 192.168.0.0/25\n# 192.168.0.0/24\n# 192.168.0.0/23\n# [and so on]\nprint Net::CIDR::addrandmask2cidr(\"195.149.50.61\", \"255.255.255.248\").\"\\n\";\n#\n# Output from above:\n#\n# 195.149.50.56/29", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 109, "subsections": [] }, { "name": "DESCRIPTION", "lines": 37, "subsections": [ { "name": "range2cidr", "lines": 12 }, { "name": "cidr2range", "lines": 25 }, { "name": "cidr2octets", "lines": 43 } ] }, { "name": "BUGS", "lines": 4, "subsections": [] }, { "name": "AUTHOR", "lines": 4, "subsections": [] } ], "sections": { "NAME": { "content": "Net::CIDR - Manipulate IPv4/IPv6 netblocks in CIDR notation\n", "subsections": [] }, "SYNOPSIS": { "content": "use Net::CIDR;\n\nuse Net::CIDR ':all';\n\nmy $var;\n\nif ($var = Net::CIDR::cidrvalidate($var))\n{\n// ... do something\n}\n\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\"192.168.0.0-192.168.255.255\",\n\"10.0.0.0-10.3.255.255\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0/16\n# 10.0.0.0/14\n\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\n\"dead:beef::-dead:beef:ffff:ffff:ffff:ffff:ffff:ffff\"))\n. \"\\n\";\n\n#\n# Output from above:\n#\n# dead:beef::/32\n\nprint join(\"\\n\",\nNet::CIDR::range2cidr(\"192.168.1.0-192.168.2.255\"))\n. \"\\n\";\n#\n# Output from above:\n#\n# 192.168.1.0/24\n# 192.168.2.0/24\n\nprint join(\"\\n\", Net::CIDR::cidr2range(\"192.168.0.0/16\")) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0-192.168.255.255\n\nprint join(\"\\n\", Net::CIDR::cidr2range(\"dead::beef::/46\")) . \"\\n\";\n#\n# Output from above:\n#\n# dead:beef::-dead:beef:3:ffff:ffff:ffff:ffff:ffff\n\n@list=(\"192.168.0.0/24\");\n@list=Net::CIDR::cidradd(\"192.168.1.0-192.168.1.255\", @list);\n\nprint join(\"\\n\", @list) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0.0/23\n\nprint join(\"\\n\", Net::CIDR::cidr2octets(\"192.168.0.0/22\")) . \"\\n\";\n#\n# Output from above:\n#\n# 192.168.0\n# 192.168.1\n# 192.168.2\n# 192.168.3\n\nprint join(\"\\n\", Net::CIDR::cidr2octets(\"dead::beef::/46\")) . \"\\n\";\n#\n# Output from above:\n#\n# dead:beef:0000\n# dead:beef:0001\n# dead:beef:0002\n# dead:beef:0003\n\n@list=(\"192.168.0.0/24\");\nprint Net::CIDR::cidrlookup(\"192.168.0.12\", @list);\n#\n# Output from above:\n#\n# 1\n\n@list = Net::CIDR::addr2cidr(\"192.168.0.31\");\nprint join(\"\\n\", @list);\n#\n# Output from above:\n#\n# 192.168.0.31/32\n# 192.168.0.30/31\n# 192.168.0.28/30\n# 192.168.0.24/29\n# 192.168.0.16/28\n# 192.168.0.0/27\n# 192.168.0.0/26\n# 192.168.0.0/25\n# 192.168.0.0/24\n# 192.168.0.0/23\n# [and so on]\n\nprint Net::CIDR::addrandmask2cidr(\"195.149.50.61\", \"255.255.255.248\").\"\\n\";\n#\n# Output from above:\n#\n# 195.149.50.56/29\n", "subsections": [] }, "DESCRIPTION": { "content": "The Net::CIDR package contains functions that manipulate lists of IP netblocks expressed in CIDR\nnotation. The Net::CIDR functions handle both IPv4 and IPv6 addresses.\n\nThe cidrvalidate() function, described below, checks that its argument is a single, valid IP\naddress or a CIDR. The remaining functions expect that their parameters consist of validated IPs\nor CIDRs. See cidrvalidate() and BUGS, below, for more information.\n\n@cidrlist=Net::CIDR::range2cidr(@rangelist);\nEach element in the @rangelist is a string \"start-finish\", where \"start\" is the first IP\naddress and \"finish\" is the last IP address. range2cidr() converts each range into an equivalent\nCIDR netblock. It returns a list of netblocks except in the case where it is given only one\nparameter and is called in scalar context.\n\nFor example:\n\n@a=Net::CIDR::range2cidr(\"192.168.0.0-192.168.255.255\");\n\nThe result is a one-element array, with $a[0] being \"192.168.0.0/16\". range2cidr() processes\neach \"start-finish\" element in @rangelist separately. But if invoked like so:\n\n$a=Net::CIDR::range2cidr(\"192.168.0.0-192.168.255.255\");\n\nThe result is a scalar \"192.168.0.0/16\".\n\nWhere each element cannot be expressed as a single CIDR netblock range2cidr() will generate as\nmany CIDR netblocks as are necessary to cover the full range of IP addresses. Example:\n\n@a=Net::CIDR::range2cidr(\"192.168.1.0-192.168.2.255\");\n\nThe result is a two element array: (\"192.168.1.0/24\",\"192.168.2.0/24\");\n\n@a=Net::CIDR::range2cidr(\n\"d08c:43::-d08c:43:ffff:ffff:ffff:ffff:ffff:ffff\");\n\nThe result is an one element array: (\"d08c:43::/32\") that reflects this IPv6 netblock in CIDR\nnotation.\n", "subsections": [ { "name": "range2cidr", "content": "@rangelist=Net::CIDR::cidr2range(@cidrlist);\nThe cidr2range() functions converts a netblock list in CIDR notation to a list of \"start-finish\"\nIP address ranges:\n\n@a=Net::CIDR::cidr2range(\"10.0.0.0/14\", \"192.168.0.0/24\");\n\nThe result is a two-element array: (\"10.0.0.0-10.3.255.255\", \"192.168.0.0-192.168.0.255\").\n\n@a=Net::CIDR::cidr2range(\"d08c:43::/32\");\n\nThe result is a one-element array: (\"d08c:43::-d08c:43:ffff:ffff:ffff:ffff:ffff:ffff\").\n" }, { "name": "cidr2range", "content": "@netblocklist = Net::CIDR::addr2cidr($address);\nThe addr2cidr function takes an IP address and returns a list of all the CIDR netblocks it might\nbelong to:\n\n@a=Net::CIDR::addr2cidr('192.168.0.31');\n\nThe result is a thirtythree-element array: ('192.168.0.31/32', '192.168.0.30/31',\n'192.168.0.28/30', '192.168.0.24/29', [and so on]) consisting of all the possible subnets\ncontaining this address from 0.0.0.0/0 to address/32.\n\nAny addresses supplied to addr2cidr after the first will be ignored. It works similarly for IPv6\naddresses, returning a list of one hundred and twenty nine elements.\n\n$cidr=Net::CIDR::addrandmask2cidr($address, $netmask);\nThe addrandmask2cidr function takes an IP address and a netmask, and returns the CIDR range\nwhose size fits the netmask and which contains the address. It is an error to supply one\nparameter in IPv4-ish format and the other in IPv6-ish format, and it is an error to supply a\nnetmask which does not consist solely of 1 bits followed by 0 bits. For example,\n'255.255.248.192' is an invalid netmask, as is '255.255.255.32' because both contain 0 bits in\nbetween 1 bits.\n\nTechnically speaking both of those *are* valid netmasks, but a) you'd have to be insane to use\nthem, and b) there's no corresponding CIDR range.\n\n@octetlist=Net::CIDR::cidr2octets(@cidrlist);" }, { "name": "cidr2octets", "content": "netblocks. Example:\n\n@octetlist=Net::CIDR::cidr2octets(\"10.0.0.0/14\", \"192.168.0.0/24\");\n\nThe result is the following five-element array: (\"10.0\", \"10.1\", \"10.2\", \"10.3\", \"192.168.0\").\n\nFor IPv6 addresses, the hexadecimal words in the resulting list are zero-padded:\n\n@octetlist=Net::CIDR::cidr2octets(\"::dead:beef:0:0/110\");\n\nThe result is a four-element array: (\"0000:0000:0000:0000:dead:beef:0000\",\n\"0000:0000:0000:0000:dead:beef:0001\", \"0000:0000:0000:0000:dead:beef:0002\",\n\"0000:0000:0000:0000:dead:beef:0003\"). Prefixes of IPv6 CIDR blocks should be even multiples of\n16 bits, otherwise they can potentially expand out to a 32,768-element array, each!\n\n@cidrlist=Net::CIDR::cidradd($block, @cidrlist);\nThe cidradd() functions allows a CIDR list to be built one CIDR netblock at a time, merging\nadjacent and overlapping ranges. $block is a single netblock, expressed as either\n\"start-finish\", or \"address/prefix\". Example:\n\n@cidrlist=Net::CIDR::range2cidr(\"192.168.0.0-192.168.0.255\");\n@cidrlist=Net::CIDR::cidradd(\"10.0.0.0/8\", @cidrlist);\n@cidrlist=Net::CIDR::cidradd(\"192.168.1.0-192.168.1.255\", @cidrlist);\n\nThe result is a two-element array: (\"10.0.0.0/8\", \"192.168.0.0/23\"). IPv6 addresses are handled\nin an analogous fashion.\n\n$found=Net::CIDR::cidrlookup($ip, @cidrlist);\nSearch for $ip in @cidrlist. $ip can be a single IP address, or a netblock in CIDR or\nstart-finish notation. lookup() returns 1 if $ip overlaps any netblock in @cidrlist, 0 if not.\n\n$ip=Net::CIDR::cidrvalidate($ip);\nValidate whether $ip is a valid IPv4 or IPv6 address, or a CIDR. Returns its argument or undef.\nSpaces are removed, and IPv6 hexadecimal address are converted to lowercase.\n\n$ip with less than four octets gets filled out with additional octets, and the modified value\ngets returned. This turns \"192.168/16\" into a proper \"192.168.0.0/16\".\n\nIf $ip contains a \"/\", it must be a valid CIDR, otherwise it must be a valid IPv4 or an IPv6\naddress.\n\nA technically invalid CIDR, such as \"192.168.0.1/24\" fails validation, returning undef.\n" } ] }, "BUGS": { "content": "Garbage in, garbage out. Always use cidrvalidate() before doing anything with untrusted input.\nOtherwise, \"slightly\" invalid input will work (extraneous whitespace is generally OK), but the\nfunctions will croak if you're totally off the wall.\n", "subsections": [] }, "AUTHOR": { "content": "Sam Varshavchik \n\nWith some contributions from David Cantrell \n", "subsections": [] } } } }