netaddr 1.5.3 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fd69b081c04694ed2db113b810b07e19ba7f8c9ebe446bca31af3b9f73955777
-  data.tar.gz: 4510ea5730575cbc8f606de4edd21ef054ba661fb9b1b2aacbdfa6f872055ad5
+SHA1:
+  metadata.gz: 8baac76897c5888273f82c02b7719ac40704dde4
+  data.tar.gz: 55829efe0e322cd809cc8113fe88c74e4597f7fb
 SHA512:
-  metadata.gz: 12f90e81555cb39d0b51cd10c108b185da1cc4fb48d684858b60e5ada9d3584bb74ec54904335e962a9f14bd194e5c27cee4ab0d017a00ee0a03c223a79d3894
-  data.tar.gz: 78efa87669e4f37defda27d375e57d2dde8cd356b9a9ceac19e0ade7ce080733ee48e766ca100d11c411e7cb87e0d2230c711a24a1db90d73292fff3b69cea18
+  metadata.gz: 64de30c364321364056cd9e50f1468991109203cdc58d7d3d0fa0f7626455ee8c42fd2fabe505efdaefa442b344fb03ed0354c43b39abf31470359007722bec7
+  data.tar.gz: ff8813e6e0319932083ea4e994e4194473ac439d579df47b45faf2e2b86a72895be082b33a663ad9705a55a706815685c18c8880ac5313d59b54265dc0e599a1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,9 +1,29 @@
 # netaddr
-I originally created this package back in 2007 out of the need for a tool
-which I could use to track an inventory of constantly changing IP subnets.
-At the time, I was in the process of migrating away from Perl and towards Ruby
-as my primary scripting language. I have since migrated away from using Ruby so
-I have not made any major modifications to this code base since 2008 (aside from a 
-handful of bug fixes that others have pointed out).
- 
-Dustin Spinhirne
+A Ruby library for performing calculations on IPv4 and IPv6 subnets. There is also limited support for EUI addresses.
+
+### Version 1.x
+The original netaddr which I created in 2007. My use case then was creating an internal IPAM system for Rackspace.
+
+### Version 2.x
+A complete rewrite and totally incompatible with 1.x. My main motivation now is to reduce bug reports resulting from the poor code quality of 1.x.
+
+
+# Building
+To run unit tests, execute the following from the top level directory
+
+	ruby test/run_all.rb
+
+To build the gem, execute the following from the top level directory
+
+	gem build netaddr.gemspec
+
+
+# Examples
+Example code may be found in test/example.rb. This example code runs as part of the unit tests.
+
+
+# Coding Style
+I use the following conventions:
+* I use tabs for indention since tabs make it really easy to adjust indention widths on the fly.
+* I do not follow rigid limits on line lengths. My editor auto-wraps so I add a line break where it feels appropriate.
+* I'm not a fan of obfuscation. I prefer clear code over fancy code.

data/lib/eui48.rb

@@ -0,0 +1,65 @@
+module NetAddr
+	
+	# EUI48 (Extended Unique Identifier 48-bit, or EUI-48) represents a 48-bit hardware address.
+	# It is typically associated with mac-addresses.
+	class EUI48
+		
+		# addr is the Integer representation of this EUI
+		attr_reader :addr
+		
+		#Create an EUI48 from an Integer. Must be between 0 and 2**48-1.
+		#Throws ValidationError on error.
+		def initialize(i)
+			if (!i.kind_of?(Integer))
+				raise ValidationError, "Expected an Integer for 'i' but got a #{i.class}."
+			elsif ( (i < 0) || (i > 2**48-1) )
+				raise ValidationError, "#{i} is out of bounds for EUI48."
+			end
+			@addr = i
+		end
+		
+		# Parse an EUI-48 string into an EUI48 type.
+		# This will successfully parse most of the typically used formats such as:
+		# * aa-bb-cc-dd-ee-ff
+		# * aa:bb:cc:dd:ee:ff
+		# * aabb.ccdd.eeff
+		# * aabbccddeeff
+		# 
+		# Although, in truth, its not picky about the exact format as long as
+		# it contains exactly 12 hex characters with the optional delimiting characters
+		# '-', ':', or '.'.
+		def EUI48.parse(addr)
+			addr = addr.strip.gsub(/[\-\:\.]/,"")
+			if (addr.length != 12)
+				raise ValidationError, "Must contain exactly 12 hex characters with optional delimiters."
+			elsif (addr =~ /[^0-9a-fA-F\:]/)
+				raise ValidationError, "#{addr} contains invalid characters."
+			end
+			return EUI48.new(addr.to_i(16))
+		end
+		
+		# bytes returns a list containing each byte of the EUI48 as String.
+		def bytes()
+			return [
+				(@addr >> 40 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 32 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 24 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 16 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 8 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr & 0xff).to_s(16).rjust(2, "0"),
+				]
+		end
+		
+		
+		# to_eui64 converts this EUI48 into an EUI64 by inserting 0xfffe between the first and last 24-bits of the address.
+		def to_eui64()
+			return EUI64.new((@addr & 0xffffff000000) << 16 | (@addr & 0x000000ffffff) | 0x000000fffe000000)
+		end
+		
+		def to_s()
+			return self.bytes.join("-")
+		end
+		
+	end # end class EUI48
+	
+end # end module

data/lib/eui64.rb

@@ -0,0 +1,77 @@
+module NetAddr
+	
+	# EUI64 (Extended Unique Identifier 64-bit, or EUI-64) represents a 64-bit hardware address.
+	class EUI64
+		
+		# addr is the Integer representation of this EUI
+		attr_reader :addr
+		
+		#Create an EUI64 from an Integer. Must be between 0 and 2**64-1.
+		#Throws ValidationError on error.
+		def initialize(i)
+			if (!i.kind_of?(Integer))
+				raise ValidationError, "Expected an Integer for 'i' but got a #{i.class}."
+			elsif ( (i < 0) || (i > 2**64-1) )
+				raise ValidationError, "#{i} is out of bounds for EUI64."
+			end
+			@addr = i
+		end
+		
+		# Parse an EUI-64 string into an EUI64 type.
+		# This will successfully parse most of the typically used formats such as:
+		# * aa-bb-cc-dd-ee-ff-00-11
+		# * aa:bb:cc:dd:ee:ff:00:11
+		# * aabb.ccdd.eeff.0011
+		# * aabbccddeeff0011
+		# 
+		# Although, in truth, its not picky about the exact format as long as
+		# it contains exactly 16 hex characters with the optional delimiting characters
+		# '-', ':', or '.'.
+		def EUI64.parse(addr)
+			addr = addr.strip.gsub(/[\-\:\.]/,"")
+			if (addr.length != 16)
+				raise ValidationError, "Must contain exactly 16 hex characters with optional delimiters."
+			elsif (addr =~ /[^0-9a-fA-F\:]/)
+				raise ValidationError, "#{addr} contains invalid characters."
+			end
+			return EUI64.new(addr.to_i(16))
+		end
+		
+		# bytes returns a list containing each byte of the EUI64 as a String.
+		def bytes()
+			return [
+				(@addr >> 56 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 48 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 40 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 32 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 24 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 16 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr >> 8 & 0xff).to_s(16).rjust(2, "0"),
+				(@addr & 0xff).to_s(16).rjust(2, "0"),
+				]
+		end
+		
+		# to_ipv6 generates an IPv6 address from this EUI64 address and the provided IPv6Net.
+		# Nil will be returned if net is not a /64.
+		def to_ipv6(net)
+			if (!net.kind_of?(IPv6Net))
+				raise ArgumentError, "Expected an IPv6Net object for 'net' but got a #{net.class}."
+			end
+			
+			if (net.netmask.prefix_len != 64)
+				return nil
+			end
+			
+			# set u/l bit to 0
+			hostId = @addr ^ 0x0200000000000000
+			ipAddr = net.network.addr | hostId
+			return IPv6.new(ipAddr)
+		end
+		
+		def to_s()
+			return self.bytes.join("-")
+		end
+		
+	end # end class EUI64
+	
+end # end module

data/lib/ipv4.rb

@@ -0,0 +1,77 @@
+module NetAddr
+	
+	#IPv4 represents a single IPv4 address. 
+	class IPv4
+		# addr is the Integer representation of this IP address
+		attr_reader :addr
+		
+		#Create an IPv4 from an Integer. Must be between 0 and 2**32-1.
+		#Throws ValidationError on error.
+		def initialize(i)
+			if (!i.kind_of?(Integer))
+				raise ValidationError, "Expected an Integer for 'i' but got a #{i.class}."
+			elsif ( (i < 0) || (i > 2**32-1) )
+				raise ValidationError, "#{i} is out of bounds for IPv4."
+			end
+			@addr = i
+		end
+		
+		# parse will create an IPv4 from its string representation (ie. "192.168.1.1").
+		# Throws ValidationError on error.
+		def IPv4.parse(ip)
+			ip.strip!
+			i = Util.parse_IPv4(ip)
+			return IPv4.new(i)
+		end
+		
+		#cmp compares equality with another IPv4. Return:
+		#* 1 if this IPv4 is numerically greater
+		#* 0 if the two are equal
+		#* -1 if this IPv4 is numerically less
+		def cmp(other)
+			if (!other.kind_of?(IPv4))
+				raise ArgumentError, "Expected an IPv4 object for 'other' but got a #{other.class}."
+			end
+			if (self.addr > other.addr)
+				return 1
+			elsif (self.addr < other.addr)
+				return -1
+			end
+			return 0
+		end
+		
+		# multicast_mac returns the EUI48 multicast mac-address for this IP.
+		# It will return the zero address for IPs outside of the multicast range 224.0.0.0/4.
+		def multicast_mac
+			mac = 0
+			if (@addr&0xf0000000 == 0xe0000000) # within 224.0.0.0/4 ?
+				# map lower 23-bits of ip to 01:00:5e:00:00:00
+				mac = (@addr&0x007fffff) | 0x01005e000000
+			end
+			return EUI48.new(mac)
+		end
+		
+		# next returns the next consecutive IPv4 or nil if the address space is exceeded
+		def next()
+			if (self.addr == NetAddr::F32)
+				return nil
+			end
+			return IPv4.new(self.addr + 1)
+		end
+		
+		# prev returns the preceding IPv4 or nil if this is 0.0.0.0
+		def prev()
+			if (self.addr == 0)
+				return nil
+			end
+			return IPv4.new(self.addr - 1)
+		end
+		
+		# to_s returns the IPv4 as a String
+		def to_s()
+			Util.int_to_IPv4(@addr)
+		end
+		
+	end # end class IPv4
+	
+end # end module