wikk_ipv4 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4777a6c555cb227258c37530ce246e908080cdf6e8bc2eb399fb84eb08fca280
-  data.tar.gz: 9f0831860c41ccf98bfac61c6fbd7d5583c91fdfb50358145682d520a9a32c1f
+  metadata.gz: 45e4407cf771cc48e192398fae57b65900e66aa1cee3b05ec67921bfb1e93389
+  data.tar.gz: ecf43d3987463028f34e86a77618b9edcd72e0617200b68f5259a5d7a5e5335c
 SHA512:
-  metadata.gz: 2a5a65ec6413b493f11e1100065f124e88de3614b16b995583e72cc5fd1ac3ce6f4a32a01f85af99de4dbb71a4808b13696df3b56e1f7f316896f53d4c59b2bd
-  data.tar.gz: 3f8ada255ebd744c7d1afd074f1f31b60c71863a865ddbcc4b52cef52c3a15a1c849fd09454a928dca78aa75e1f513909ed12e01843ef448d13a53941c07fc05
+  metadata.gz: 2fc0da6d2a34617489427f20986f0cf17df5344560f1f647c58c659bc597d8e35b2353ee2784dd915e80516355238ada2a544159a01e1d1a75f69d6fd2e2d6a7
+  data.tar.gz: 635d50f75017ed60324a376e230d619826c5fdecef9584ac8df5abbc64e91a84570c3249a5254f8ade08a8590e845d136a82b99dd4eab383e18d911d93a3524e

data/History.txt

@@ -1,3 +1,13 @@
+robertburrowes	Fri Jun 24 18:27:50 2022 +1200
+	bump version
+robertburrowes	Fri Jun 24 18:27:27 2022 +1200
+	added methods last_host and first_host to return IPv4 address Modified network and broadcast to either return the IPv4 or calculate these with a different mask applied. Tidied up the revptr and revnet Fixed the issubnet? test
+robertburrowes	Fri Jun 24 18:24:32 2022 +1200
+	created tests
+robertburrowes	Fri Jun 24 16:31:08 2022 +1200
+	merge in the other copy from 2018
+robertburrowes	Fri Jun 24 12:53:27 2022 +1200
+	chmod
 robertburrowes	Mon Jun 13 13:52:07 2022 +1200
 	rubocop
 robertburrowes	Mon Jun 13 13:45:19 2022 +1200

data/lib/wikk_ipv4.rb

@@ -2,87 +2,250 @@
 module WIKK
   # Some utility IPv4 calles
   class IPv4
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
 
-    attr_reader :ip_address, :mask
+    attr_reader :host         # [Integer] IPv4 Address
+    attr_reader :mask         # [Integer] IPv4 Mask
+    attr_reader :mask_bytes   # [Array]   Integer values, for each byte
+    attr_reader :mask_length  # [Integer] mask length i.e. 24 for /24
 
-    def initialize(s, mask = 0xffffffff)
-      @mask = mask
-      if s.instance_of?(String)
-        ip = s.split(/\./)
+    def initialize(host, mask = 32)
+      @mask, @mask_length, @mask_bytes = process_mask(mask)
+      if host.instance_of?(String)
+        ip = host.split(/\./)
         (0..3).each { |i| ip[i] = '0' if ip[i].nil? }
-        @ip_address = ((ip[0].to_i << 24) | (ip[1].to_i << 16) | (ip[2].to_i << 8) | ip[3].to_i) & mask
-      elsif s
-        @ip_address = s & mask
+        @host = ((ip[0].to_i << 24) | (ip[1].to_i << 16) | (ip[2].to_i << 8) | ip[3].to_i)
+      elsif host.instance_of?(Integer)
+        @host = host
+      else
+        @host = nil
+        return
+      end
+      @network = @host & @mask
+      @broadcast = (~@network & ~@mask & 0xFFFFFFFF) | @network
+      @first_host = @network + 1
+      @last_host = @broadcast - 1
+    end
+
+    def process_mask(mask)
+      if mask.instance_of?(String)
+        return process_string_mask(mask)
+      elsif mask.instance_of?(Integer)
+        return process_int_mask(mask)
       else
-        @ip_address = nil
+        raise "Unknown Mask type #{mask.class}"
+      end
+    end
+
+    # Takes an Integer mask, and returns the length in bits
+    # @param [Integer] Integer Mask (0xFF000000)
+    # @return [Integer] Mask length in bits (8)
+    def calc_mask_length(mask)
+      mask_length = 0
+      (1..32).each do |_i|
+        mask_length += 1 if (mask & 0x1) == 1
+        mask = mask >> 1
       end
+      return mask_length
+    end
+
+    def length
+      broadcast.to_i - network.to_i + 1
     end
 
-    def ip_address=(value)
+    # Turns mask string into an Integer mask, mask length and Integer array
+    # @param mask [String] Mask of the form '255.0.0.0'
+    # @return [Array] Integer Mask (0xFF000000), Mask Length (8), Mask Integer Array ([0xFF,0,0,0])
+    def process_string_mask(mask)
+      return nil, nil, nil if mask.class != String
+
+      mask_bytes = mask.split('.') # Make into a byte array
+      mask_bytes.collect!(& :to_i) # Convert the string bytes into integers
+      # Turn the byte array into a single integer.
+      mask = (mask_bytes[0] << 24) + (mask_bytes[1] << 16) + (mask_bytes[2] << 8) + mask_bytes[3]
+      mask_length = calc_mask_length(mask)
+
+      return mask, mask_length, mask_bytes
+    end
+
+    # Turns mask into an Integer mask, mask length and Integer array
+    # @param mask [Integer] Either an Integer mask (0xFF000000), or the mask length (8) as an Integer
+    # @return [Array] Integer Mask (0xFF000000), Mask Length (8), Mask Integer Array ([0xFF, 0,0,0])
+    def process_int_mask(mask)
+      return nil, nil, nil unless mask.instance_of?(Integer)
+
+      if (mask & 0x800000) == 0 # Assume it is the mask length
+        mask_length = mask
+        mask = 0xFFFFFFFF << (32 - mask_length)
+      else  # Assume it is a full mask
+        mask_length = calc_mask_length(mask)
+      end
+
+      mask_bytes = []
+      mask_bytes[3] = mask & 255
+      mask_bytes[2] = (mask >> 8) & 255
+      mask_bytes[1] = (mask >> 16) & 255
+      mask_bytes[0] = (mask >> 24) & 255
+
+      return mask, mask_length, mask_bytes
+    end
+
+    # Store IP address in @host
+    # @param value [String|Integer] Accepts "x.x.x.x" or a network order Integer IP address
+    def host=(value)
       if value.instance_of?(String)
         ip = s.split(/\./)
         (0..3).each { |i| ip[i] = '0' if ip[i].nil? }
-        @ip_address = ((ip[0].to_i << 24) | (ip[1].to_i << 16) | (ip[2].to_i << 8) | ip[3].to_i) & mask
+        @host = ((ip[0].to_i << 24) | (ip[1].to_i << 16) | (ip[2].to_i << 8) | ip[3].to_i) & mask
       else
-        @ip_address = value
+        @host = value
       end
     end
 
-    def to_s(mask = 0xffffffff)
-      if @ip_address
-        ip = (@ip_address & mask)
+    alias ipaddress= host=
+    alias ipaddress host
+
+    # @return [String] the host address
+    def to_s(mask = 32) # 32 being a host ip address. Can also be a String, or Integer Mask
+      mask, _mask_length, _mask_bytes = process_mask(mask)
+      if @host
+        ip = (@host & mask)
         "#{(ip >> 24) & 255}.#{(ip >> 16) & 255}.#{(ip >> 8) & 255}.#{ip & 255}"
       else
         ''
       end
     end
 
-    def network(mask)
-      self.class.new(@ip_address, mask)
+    # @return [IPv4] the host address
+    def network(mask = nil)
+      if mask.nil?
+        self.class.new(@network, @mask)
+      else
+        mask, _mask_length, _mask_bytes = process_mask(mask)
+        self.class.new(@host & mask, mask)
+      end
     end
 
-    def broadcast(mask)
-      self.class.new(@ip_address & mask | ~mask)
+    # @return [IPv4] The broadcast address
+    def broadcast(mask = nil)
+      if mask.nil?
+        self.class.new(@broadcast, @mask)
+      else
+        self.class.new((~@host & ~mask & 0xFFFFFFFF) | @network, mask)
+      end
+    end
+
+    # @return [IPv4] First host IPv4 Address for this mask
+    def first_host
+      self.class.new(@first_host, @mask)
+    end
+
+    # @return [IPv4] Second to last IPv4 Address for this mask
+    def last_host
+      self.class.new(@last_host, @mask)
     end
 
+    # @return [Integer] the IPv4 address as an integer
     def to_i
-      @ip_address
+      @host
     end
 
+    # @return [Integer] IPv4 mask from a string to an Int
     def self.mask_to_i(s)
       ip = s.split(/\./)
       ((ip[0].to_i << 24) | (ip[1].to_i << 16) | (ip[2].to_i << 8) | ip[3].to_i)
     end
 
+    # @return [Integer] mask for number of bits in mask
     def self.maskbits_to_i(n)
       0xffffffff >> (32 - n) << (32 - n)
     end
 
+    # @return [IPv4] add two addresses
     def +(other)
-      self.class.new(@ip_address + other)
+      self.class.new(@host + other)
     end
 
-    def revptr(bytes)
-      rip = [ "#{@ip_address & 255}", "#{(@ip_address >> 8) & 255}", "#{(@ip_address >> 16) & 255}", "#{(@ip_address >> 24) & 255}" ]
-      rip[0, 4 - bytes].join('.')
+    # @return [IPv4] Difference between two addresses
+    def -(other)
+      self.class.new(@host - other)
     end
 
-    def revnet(bytes)
-      rip = [ "#{@ip_address & 255}", "#{(@ip_address >> 8) & 255}", "#{(@ip_address >> 16) & 255}", "#{(@ip_address >> 24) & 255}" ]
-      rip[4 - bytes, bytes].join('.')
+    # @return [String] host part of IPv4 as DNS reverse string
+    def revptr(bytes = nil, mask = nil)
+      if mask.nil?
+        mask = @mask
+      else
+        mask, _mask_length, _mask_bytes = process_mask(mask)
+      end
+      addr = (@host & ~mask)
+      bytes ||= 4 - ((@mask_length - 1) / 8 + 1)
+      rip = [ "#{addr & 255}", "#{(addr >> 8) & 255}", "#{(addr >> 16) & 255}", "#{(addr >> 24) & 255}" ]
+      rip[0..bytes].join('.')
+    end
+
+    # @return [String] host part of IPv4 as DNS reverse string
+    def revnet(bytes = nil, mask = nil)
+      if mask.nil?
+        mask = @mask
+      else
+        mask, _mask_length, _mask_bytes = process_mask(mask)
+      end
+      addr = (@host & mask)
+      bytes ||= ((@mask_length - 1) / 8 + 1) - 4
+      rip = [ "#{addr & 255}", "#{(addr >> 8) & 255}", "#{(addr >> 16) & 255}", "#{(addr >> 24) & 255}" ]
+      rip[bytes..-1].join('.')
     end
 
+    # Test if IP addresses are the same
+    # @param i [IPV4] address to check against local ip address
+    # @return [Boolean]
     def ==(other)
-      @ip_address == other.ip_address
+      @host == other.host
     end
 
+    # @return [Boolean] the IP address is not nil
     def notnil?
-      @ip_address != nil
+      @host != nil
     end
 
+    # Test to see if one network is a subnet of another
+    # @param net [IPV4] Net we want to check is a subnet of this net
+    # @return [Boolean]
     def issubnet?(net)
-      (@ip_address & @mask) == (net.ip_address & @mask)
+      (@network == (net.host & @mask)) && @mask_length <= net.mask_length
+    end
+
+    # @return [Array] Split IPv4 address (integer) into 4 bytes
+    def to_bytes(address)
+      bytes = []
+      bytes[3] = address & 255
+      bytes[2] = (address >> 8) & 255
+      bytes[1] = (address >> 16) & 255
+      bytes[0] = (address >> 24) & 255
+      return bytes
+    end
+
+    # @return [String] IPv4 address
+    def ip_to_s(address)
+      bytes = to_bytes(address)
+      "#{bytes[0]}.#{bytes[1]}.#{bytes[2]}.#{bytes[3]}"
+    end
+
+    # Iterate over a network's IP addresses
+    # @yield [IPv4] addresses
+    def each_ip
+      ((@network + 1)..@last_host).each { |ip| yield ip_to_s(ip) }
+    end
+
+    # Compare two IPv4 addresses
+    def <=>(other)
+      @host.to_i <=> other.to_i
+    end
+
+    # @return [IPv4] the next IPv4 address
+    def succ
+      self.class.new(@host + 1)
     end
   end
 end

data/version

@@ -1,2 +1,2 @@
 PROJECT="wikk_ipv4"
-VERSION="0.0.1"
+VERSION="0.0.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikk_ipv4
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-yard