iface 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0dabac73d94d38d1e887f22ad10f75ae1c40a212
+  data.tar.gz: 5b36a303566537a64be7b4d11bcb2030a7894baf
+SHA512:
+  metadata.gz: 72c5525357faea04f9244a122dcd92cea7de287860481db15af8450f46fa4b4febacddceaee364a4ffe995e38d5762ce6d9743f44393f35f70698d0359ec512a
+  data.tar.gz: 05d5d2fabe7b9b831d990bf5039a5ee1aef7fd6f6c5635011f869bdef084c2f863bdc0661f8eebb6d3cb0c8676d2786c0d389502a15460448690da58cd955d69

data/lib/iface.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'iface/config'
+require_relative 'iface/ip_address'

data/lib/iface/config.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'config_file'
+require 'ipaddr'
+
+module Iface
+  # Represents a set of ConfigFiles for network interface configuration
+  class Config
+    Reserved_IP_Ranges = %w{10.0.0.0/8 192.168.0.0/16}.collect { |i| IPAddr.new(i) }
+
+    def self.discover(pattern)
+      new.tap do |config|
+        Dir.glob(pattern) do |fullname|
+          puts fullname
+          File.open(fullname) { |io| config.add(fullname, io) }
+        end
+      end
+    end
+
+    def initialize
+      @files = {}
+    end
+
+    def add(filename, io)
+      file = ConfigFile.create(filename, io)
+      file_type = file.class.file_type_name
+      if @files.key?(file_type)
+        @files[file_type] << file
+      else
+        @files[file_type] = [file]
+      end
+      self
+    end
+
+    # Returns the PrimaryFile
+    #
+    # There should be 0 or 1 of these; else it's an error.
+    def primary
+      result = @files[:primary].find_all do |file|
+        if file.ip_address.nil?
+          false
+        else
+          ipaddr = IPAddr.new(file.ip_address)
+          !Reserved_IP_Ranges.any? { |range| range.include?(ipaddr) }
+        end
+      end
+
+      case result.size
+        when 0
+          nil
+        when 1
+          result.first
+        else
+          raise RuntimeError, "Expected 0 or 1 primary files; found #{result.size}"
+      end
+    end
+  end
+end

data/lib/iface/config_file.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative 'ip_helpers'
+require_relative 'value_set'
+
+class String
+  def decamelize
+    gsub(/[A-Z]/) {|m| $` == '' ? m.downcase : "_#{m.downcase}"}
+  end
+end
+
+module Iface
+  # Base class for a network interface config file
+  class ConfigFile
+    def self.create(filename, io)
+      fname = File.split(filename).last
+      device, range_num, clone_num = parse_filename(fname)
+      vars = ValueSet.new(io)
+
+      FILE_TYPES.each do |klass|
+        if klass.recognize?(device, range_num, clone_num, vars)
+          return klass.new(filename, device, range_num, clone_num, vars)
+        end
+      end
+
+      raise ArgumentError, "Input not recognized from file #{fname}: #{[device, range_num, clone_num, vars].inspect}"
+    end
+
+    def self.parse_filename(filename)
+      match = filename.match(/\Aifcfg-(\w+)((-range(\d+))|(:(\d+)))?\Z/)
+      if match
+        device, _skip0, _skip1, range_num, _skip2, clone_num = match.captures
+        [device, range_num&.to_i, clone_num&.to_i]
+      end
+    end
+
+    def self.recognize?(_device, _range_num, _clone_num, _vars)
+      false
+    end
+
+    def self.file_type_name
+      if self.name =~ /File\Z/
+        self.name.split('::').last[0..-5].decamelize.to_sym
+      else
+        nil
+      end
+    end
+
+    def initialize(filename, device, _range_num, _clone_num, _vars)
+      @filename = filename
+      @device = device
+    end
+
+    def static?
+      raise NotImplementedError
+    end
+
+    def include?(_ip)
+      raise NotImplementedError
+    end
+  end
+
+  # Represents a primary config file (not loopback, range or clone file)
+  #
+  # These are files named like "ifcfg-eth0".
+  class PrimaryFile < ConfigFile
+    attr_reader :ip_address, :ipv6_address, :ipv6_secondaries
+
+    def self.recognize?(device, range_num, clone_num, _vars)
+      device != 'lo' && range_num.nil? && clone_num.nil?
+    end
+
+    def initialize(filename, device, range_num, clone_num, vars)
+      super
+      if (vars['bootproto'] == 'static') || (vars['bootproto'] == 'none') # RHEL6 uses "none"
+        @ip_address = vars['ipaddr']
+        @ipv6_address = vars['ipv6addr']
+        @ipv6_secondaries = vars['ipv6addr_secondaries']&.split(/\s+/)
+      end
+    end
+
+    def static?
+      !@ip_address.nil?
+    end
+
+    def include?(ip)
+      @ip_address == ip
+    end
+  end
+
+  # Represents a clone config file (single IP address)
+  #
+  # These are files named like "ifcfg-eth0:1".
+  class CloneFile < ConfigFile
+    attr_reader :ip_address, :clone_num
+
+    def self.recognize?(_device, _range_num, clone_num, _vars)
+      !clone_num.nil?
+    end
+
+    def initialize(filename, device, _range_num, clone_num, vars)
+      super
+      @ip_address = vars['ipaddr']
+      @clone_num = clone_num
+    end
+
+    def static?
+      true
+    end
+
+    def include?(ip)
+      @ip_address == ip
+    end
+  end
+
+  # Represents a range config file (a range of IP addresses)
+  #
+  # These are files named like "ifcfg-eth0-range0".
+  class RangeFile < ConfigFile
+    attr_reader :start_clone_num
+
+    def self.recognize?(_device, range_num, _clone_num, _vars)
+      !range_num.nil?
+    end
+
+    def initialize(filename, device, range_num, clone_num, vars)
+      super
+      @start_ip_num = string_to_ip_num(vars['ipaddr_start'])
+      @end_ip_num = string_to_ip_num(vars['ipaddr_end'])
+      @start_clone_num = vars['clonenum_start']&.to_i
+    end
+
+    def static?
+      true
+    end
+
+    def include?(ip)
+      ip_num = string_to_ip_num(ip)
+      @start_ip_num <= ip_num && ip_num <= @end_ip_num
+    end
+
+    def start_ip_num
+      @start_ip_num.to_ip
+    end
+
+    def end_ip_num
+      @end_ip_num.to_ip
+    end
+
+    def string_to_ip_num(str)
+      str.split('.').collect { |x| x.to_i.to_s(16).rjust(2, '0') }.join.hex
+    end
+  end
+
+  class LoopbackFile < ConfigFile
+    def self.recognize?(device, _range_num, _clone_num, _vars)
+      device == 'lo'
+    end
+  end
+
+  FILE_TYPES = [
+    PrimaryFile,
+    CloneFile,
+    RangeFile,
+    LoopbackFile
+  ].freeze
+end

data/lib/iface/ip_address.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module Iface
+  class IpAddress
+    def initialize(*args)
+      @ipaddr = IPAddr.new(*args)
+      @_bitmask = @ipaddr.instance_eval { @mask_addr.to_s(2) }
+      @inverse_mask_addr = @_bitmask.tr('01', '10').to_i(2)
+    end
+  end
+end

data/lib/iface/ip_helpers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Adds IP-related methods to all Integers
+class Integer
+  Mask32_ = 0xffffffffffffffff
+
+  def to_ip(ipver = 4)
+    to_ipaddr(ipver).to_s
+  end
+
+  def to_ipaddr4
+    IPAddr.new_ntoh([self].pack('N'))
+  end
+
+  def to_ipaddr6
+    IPAddr.new_ntoh([(self >> 96), (self >> 64) & Mask32_, (self >> 32) & Mask32_, self & Mask32_].pack('N*'))
+  end
+
+  def to_ipaddr(ipver = 4)
+    case ipver
+    when 4
+      to_ipaddr4
+    when 6
+      to_ipaddr6
+    else
+      raise ArgumentError, "Expecting argument 1 to be either 4 or 6; got #{ipver.inspect}"
+    end
+  end
+
+  def max_mask_bits
+    to_s(2)[/(0*)$/, 1].size
+  end
+end

data/lib/iface/value_set.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Iface
+  # Represents a set of NAME=value pairs
+  class ValueSet
+    # Represents a NAME=value pair
+    class Pair
+      attr_reader :name, :value
+
+      def initialize(line)
+        match = line.match(/(^[A-Z0-9_]+)="?(.*?)"?$/)
+        raise ArgumentError, "Expected pattern NAME=value; got #{line.inspect}" unless match
+        @name = match[1]
+        @value = match[2]&.sub(/^"/, '')&.sub(/"$/, '')
+      end
+
+      def to_s
+        "#{@name}=\"#{@value}\""
+      end
+    end
+
+    def initialize(io)
+      @vars = {}
+      io.each_line do |line|
+        edited_line = line.sub(/#.*$/, '').strip
+        next if edited_line.empty?
+        pair = Pair.new(edited_line)
+        @vars[pair.name] = pair
+      end
+    end
+
+    def [](name)
+      @vars[name.upcase]&.value
+    end
+
+    def key?(name)
+      @vars.key?(name.upcase)
+    end
+    alias has_key? key?
+
+    def to_s
+      @vars.values.map(&:to_s).join("\n")
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: iface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Cain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: camelotjim@jcain.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/iface.rb
+- lib/iface/config.rb
+- lib/iface/config_file.rb
+- lib/iface/ip_address.rb
+- lib/iface/ip_helpers.rb
+- lib/iface/value_set.rb
+homepage: http://rubygems.org/gems/hola
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Configures network interfaces on Red Hat systems
+test_files: []