lib-dhcp 0.1.0

data/lib/lib/dhcp/options/type/bool.rb

@@ -0,0 +1,55 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.03.2016 by Piotr Wojcieszonek
+
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module BOOL
+          def self.included(base)
+            base.send :include, InstanceMethods
+            base.extend ClassMethods
+          end
+
+          def initialize(option)
+            if option
+              option =  (option > 0) ? 1 : 0
+            else
+              option = 0
+            end
+            oid = self.class.name.split('::').last.sub(/Option/, '').to_i
+            super oid, option
+          end
+
+          module InstanceMethods
+            def pack
+              [@oid, 1, @payload.to_i].pack('C3')
+            end
+
+            def len
+              1
+            end
+
+            def payload=(option)
+              if option
+                @payload = (option > 0) ? 1 : 0
+              else
+                @payload = 0
+              end
+            end
+          end
+
+          module ClassMethods
+            private
+            def unpack(oid, len, payload)
+              raise ArgumentError, "Wrong #{Lib::DHCP::Option::NAME[oid]} length = #{len}" unless len == 1
+              self.new payload.unpack('C').first.to_i
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/options/type/ip_address.rb

@@ -0,0 +1,73 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.03.2016 by Piotr Wojcieszonek
+
+
+require 'net/address'
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module IPAddress
+          def self.included(base)
+            base.extend ClassMethods
+          end
+
+          def initialize(*address)
+            raise ArgumentError, 'To few argument - nil' if address.nil?
+            oid = self.class.name.split('::').last.sub(/Option/, '').to_i
+            if address.size == 1
+              address = address.first.split(',') if address.first.is_a? ::String
+            end
+            case address.size
+              when 0
+                raise ArgumentError, 'To few argument - 0'
+              when 1
+                address = address.first
+                super oid, (address.is_a? Net::Address::IPv4) ? address : Net::Address::IPv4.new(address)
+              else
+                super oid, address.map {|ip| (ip.is_a? Net::Address::IPv4) ? ip : Net::Address::IPv4.new(ip)}
+            end
+          end
+
+          def to_s
+            @payload.to_s
+          end
+
+          def pack
+            if @payload.is_a? Array
+              #len = @payload.size * 4
+              [@oid, len, @payload.map(&:to_i)].flatten.pack('C2N*')
+            else
+              raise ArgumentError, 'Argument must be a IP ' unless @payload.is_a? Net::Address::IPv4
+              [@oid, 4, @payload.to_i].pack('C2N')
+            end
+          end
+
+          def len
+            if @payload.is_a? Array
+              @payload.size * 4
+            else
+              4
+            end
+          end
+
+          def payload=(address)
+            (address.is_a? Net::Address::IPv4) ? @payload = address : @payload = Net::Address::IPv4.new(address)
+          end
+
+
+          module ClassMethods
+            private
+            def unpack(oid, len, payload)
+              raise ArgumentError, "Wrong #{Lib::DHCP::Option::NAME[oid]} Option length - #{len}" unless (len % 4) == 0
+              self.new *payload.unpack('N*')
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/options/type/ip_array.rb

@@ -0,0 +1,41 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotrk@wojcieszonek.pl
+# Copyright 22.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp/options/type/ip_address'
+require 'net/address'
+
+#TODO Implement :each
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module IPArray
+
+          def self.included(base)
+            base.send :include, Lib::DHCP::Option::Type::IPAddress
+          end
+
+          def <<(address)
+            unless @payload.is_a? Array
+              payload = @payload
+              @payload = [] #Array.new
+              @payload << payload
+            end
+            @payload << (address.is_a? Net::Address::IPv4) ? address : Net::Address::IPv4.new(address)
+          end
+
+          def payload=(*address)
+            address = address.split(',') if address.is_a? String
+            @payload = address.map { |ip| (ip.is_a? Net::Address::IPv4) ? ip : Net::Address::IPv4.new(ip) }
+          end
+
+          alias_method :add, :<<
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/options/type/netmask.rb

@@ -0,0 +1,56 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 21.03.2016 by Piotr Wojcieszonek
+
+
+require 'net/address'
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module Netmask
+          def self.included(base)
+            base.send :include, InstanceMethods
+            base.extend ClassMethods
+          end
+
+          def initialize(netmask)
+            oid = self.class.name.split('::').last.sub(/Option/, '').to_i
+            payload = (netmask.is_a?(Net::Address::Mask)) ? netmask : Net::Address::Mask.new(netmask)
+            super oid, payload
+          end
+
+          module InstanceMethods
+            def pack
+              [@oid, 4, @payload.to_i].pack('C2N')
+            end
+
+            def len
+              4
+            end
+
+            def to_s
+              @payload.to_s
+            end
+
+            def payload=(netmask)
+              (netmask.is_a? Net::Address::Mask) ? @payload = netmask : @payload = Net::Address::Mask.new(netmask)
+            end
+
+          end
+
+          module ClassMethods
+
+            private
+            def unpack(oid, len, payload)
+              raise ArgumentError, "Wrong #{Lib::DHCP::Option::NAME[oid]} Option length - #{len}" unless len == 4
+              self.new *payload.unpack('N*')
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/options/type/raw.rb

@@ -0,0 +1,51 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.03.2016 by Piotr Wojcieszonek
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module Raw
+
+          def self.included(base)
+            base.extend ClassMethods
+          end
+
+
+
+            def len=(len)
+              @len = len.to_i
+            end
+
+            def len
+              @len.to_i
+            end
+
+            def pack
+              @payload = '' if @value.nil?
+              [@oid, @len, @payload.to_s].pack("C2a#{@len.to_i}")
+            end
+
+
+            def to_s
+              @payload.unpack('C*').map{|item| item.to_i.to_s(16).rjust(2, '0') }.join(':')
+            end
+
+
+
+          module ClassMethods
+            private
+            def unpack(oid, len, payload)
+              option = self.new oid, payload
+              option.len = len.to_i
+              option
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/options/type/string.rb

@@ -0,0 +1,49 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.03.2016 by Piotr Wojcieszonek
+
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module String
+          def self.included(base)
+            base.send :include, InstanceMethods
+            base.extend ClassMethods
+          end
+
+          def initialize(message)
+            oid = self.class.name.split('::').last.sub(/Option/, '').to_i
+            super oid, message.to_s
+          end
+
+          module InstanceMethods
+            def pack
+              [@oid, @payload.size, @payload.to_s].pack('C2a*')
+            end
+
+            def len
+              @payload.size
+            end
+
+            def to_s
+              @payload.to_s
+            end
+
+            def payload=(message)
+              @payload = message.to_s
+            end
+          end
+
+          module ClassMethods
+            def unpack(oid, len, payload)
+              raise ArgumentError, "Wrong #{Lib::DHCP::Option::NAME[oid]} Option length - #{len}" unless len > 0
+              self.new payload#.unpack('a*').first.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/options/type/sub_option.rb

@@ -0,0 +1,83 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp/options/sub_option'
+
+
+module Lib
+  module DHCP
+    class Option
+      module Type
+        module SubOption
+
+          def self.included(base)
+            base.extend ClassMethods
+          end
+
+          def initialize(*sub_option)
+            oid = self.class.name.split('::').last.sub(/Option/, '').to_i
+            sub_options = []
+            sub_option.each do |sub|
+              if sub.is_a? Lib::DHCP::SubOption
+                opt =  sub
+              elsif sub.is_a? Array
+                opt = Lib::DHCP::SubOption.new(sub[0], sub[1])
+              else
+                raise ArgumentError, 'Unknown SubOption parameter type'
+              end
+              sub_options << opt
+              define_singleton_method("option#{opt.oid.to_i}".to_sym) { opt }
+              #define_singleton_method(:option1) {opt}
+            end
+            super oid, sub_options
+          end
+
+          def to_s
+            s =''
+            @payload.each do |sub_option|
+              s += "Option #{sub_option.oid}, LEN #{sub_option.len}, Value #{@payload.to_s} \n\r"
+            end
+            s
+          end
+
+          def len
+            l = 0
+            @payload.each do |sub_option|
+              l += (sub_option.len.to_i + 2).to_i
+            end
+            l
+          end
+
+          def pack
+            option_pack = ''
+            sub_len = 2
+            @payload.each do |sub_option|
+              sub_len += sub_option.len
+              option_pack += sub_option.pack
+            end
+            [@oid, self.len, option_pack].pack('C2a*')
+          end
+
+          module ClassMethods
+
+            def unpack(oid, len, payload)
+              raise ArgumentError, "Wrong Option #{Lib::DHCP::Option::NAME[oid]} length - #{len}" unless len > 0
+              i = 0
+              sub_options = []
+              while i < len
+                sub_oid, sub_len = payload.unpack("@#{i}C2")
+                sub_payload = payload.unpack("@#{i+2}a#{sub_len}").first.to_s
+                sub_options << [sub_oid, sub_payload]
+                i += (sub_len + 2)
+              end
+              self.new *sub_options
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/packet.rb

@@ -0,0 +1,96 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.12.2017 by Piotr Wojcieszonek
+
+require 'lib/bootp'
+require 'forwardable'
+
+
+module Lib
+  module DHCP
+    class Packet < Lib::BOOTP::Packet
+
+      MAGICK_COOKIE = 0x63825363
+
+      (1..254).each do |i|
+
+        define_method("option#{i}") do
+          self.options.select(i.to_i).first
+        end
+
+        define_method("option#{i}=") do |payload|
+          self.options.del(i) if self.options.select(i)
+          if payload.is_a? Lib::DHCP::Option
+            self.options.add payload
+          else
+            self.options.add [i,payload]
+          end
+        end
+
+      end
+
+      def option0
+        self.options.select 0
+      end
+
+      def option255
+        self.options.select 255
+      end
+
+      def to_s
+        str = super()
+        str += "\nMAGICK-COOKIE      : 0x#{MAGICK_COOKIE.to_s(16)}"
+        str += "\n\n  --- DHCP OPTIONS ---\n"
+        options.each do |o|
+          if o.value.is_a? Array
+            value = o.value.map(&:to_s).join(',')
+          else
+            value = o.value
+          end
+          str += "\nOption #{o.oid.to_s.ljust(3,' ')} : LEN #{o.len.to_s.ljust(3, ' ')} #{o.name.to_s.ljust(40, ' ')}  : #{value}"
+        end
+        str += "\n\n"
+        str
+      end
+
+      def options
+        @options ||= Lib::DHCP::Options.new
+      end
+
+      def self.unpack(packet)
+        bootp, cookie, options = packet.unpack('a236Na*')
+        raise RuntimeError, "Magick-Cookie mismatch #{cookie.to_i.to_s(16)}" unless cookie.to_i == MAGICK_COOKIE.to_i
+        dhcp = super bootp
+        dhcp.instance_variable_set(:@options, Lib::DHCP::Options.unpack(options))
+        dhcp
+      end
+
+      def pack
+        # TODO Max Message Size support
+        dhcp_message = super # BOOTP Header
+        dhcp_message += [MAGICK_COOKIE].pack('N')
+        raise ArgumentError, "Can't pack DHCP Packet without DHCP Message Type" if self.option53.nil?
+        dhcp_message += self.option53.pack # Option 53 (DHCP MESSAGE TYPE) must be first in message
+
+        len = 240 # 236 BOOTP HEADER + 3 (Option 53) + 1 (Option 255)
+        self.options.each do |option|
+          unless option.oid.to_i == 0 or option.oid.to_i == 255 or option.oid.to_i == 53
+            # TODO Pack RAW Option
+            # TODO Need to test RAW Option packing
+            # next if option.is_a? Lib::DHCP::Option::Type::Raw # Don't pack not implemented Option type
+            dhcp_message += option.pack
+            len += (option.len.to_i + 2) # Option ID + Option LEN + Option PAYLOAD
+          end
+        end
+        dhcp_message += Lib::DHCP::Option255.new.pack
+        while len < 300 # Minimal DHCP MESSAGE SIZE
+          dhcp_message += Lib::DHCP::Option0.new.pack
+          len += 1
+        end
+        dhcp_message
+      end
+
+    end
+      
+  end
+end