lib-dhcp 0.1.0

data/lib/lib/dhcp/exception.rb

@@ -0,0 +1,34 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 22.12.2017 by Piotr Wojcieszonek
+
+module Lib
+  module DHCP
+    class Exception < ::Exception ; end
+    class SanityCheck < Exception
+      class Discover < self ; end
+
+      class Offer < self ; end
+
+      class Request < self ; end
+
+      class ACK < self ; end
+
+      class NACK < self ; end
+
+      class Inform < self ; end
+
+      class Decline < self ; end
+
+      class Release < self ; end
+
+      class LeaseQuery < self ; end
+
+      class LeaseUnassigned < self ; end
+
+      class LeaseUnknown < self ; end
+
+      class LeaseActive < self ; end
+    end
+  end
+end

data/lib/lib/dhcp/messages/ack.rb

@@ -0,0 +1,65 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 24.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp'
+
+module Lib
+  module DHCP
+    class Message
+      class ACK < Message
+        def initialize(htype: 1, hlen: 6, hops: 0, xid: nil, secs: 0, flags: 0, ciaddr: 0, yiaddr: 0, siaddr: 0, giaddr: 0, chaddr: , sname: '.', file: '.', options: nil)
+          super(
+              :op     => BOOTREPLY,
+              :htype  => htype,
+              :hlen   => hlen,
+              :hops   => hops,
+              :xid    => xid,
+              :secs   => secs,
+              :flags  => flags,
+              :ciaddr => ciaddr,
+              :yiaddr => yiaddr,
+              :siaddr => siaddr,
+              :giaddr => giaddr,
+              :chaddr => chaddr,
+              :sname  => sname,
+              :file   => file
+          )
+          if options.is_a? Array or options.is_a? Lib::DHCP::Options
+            options.each { |option| self.options.add option unless option.oid.to_i == Option::MESSAGE_TYPE }
+          elsif options.is_a? Lib::DHCP::Option
+            self.options.add options
+          elsif !options.nil?
+            raise TypeError, "Can't convert #{options.class.name} to Lib::DHCP::Option"
+          end
+
+          self.options.add Lib::DHCP::Option53.new(ACKNOWLEDGE)
+        end
+
+        def pack
+          # noinspection RubyResolve
+          self.option53 = ACKNOWLEDGE
+          self.op = BOOTREPLY
+          sanity_check
+          super
+        end
+
+        def self.unpack(packet)
+          res = super packet
+          raise TypeError, "No implicit conversion of #{res.class.name} into #{self.class.name}" unless res.is_a? self.class
+          res
+        end
+
+        protected :op=
+        # noinspection RubyResolve
+        protected :option53=
+
+        protected
+        def sanity_check
+          #TODO ACK Sanity Check
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/messages/decline.rb

@@ -0,0 +1,77 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 24.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp'
+
+module Lib
+  module DHCP
+    class Message
+      class Decline < Message
+        def initialize(htype: 1, hlen: 6, hops: 0, xid: nil, secs: 0, flags: 0, ciaddr: 0, yiaddr: 0, siaddr: 0, giaddr: 0, chaddr: , sname: '.', file: '.', options: nil)
+          super(
+              :op => BOOTREQUEST,
+              :htype => htype,
+              :hlen => hlen,
+              :hops => hops,
+              :xid => xid,
+              :secs => secs,
+              :flags => flags,
+              :ciaddr => ciaddr,
+              :yiaddr => yiaddr,
+              :siaddr => siaddr,
+              :giaddr => giaddr,
+              :chaddr => chaddr,
+              :sname => sname,
+              :file => file
+          )
+          if options.is_a? Array or options.is_a? Lib::DHCP::Options
+            options.each { |option| self.options.add option unless option.oid.to_i == Option::MESSAGE_TYPE }
+          elsif options.is_a? Lib::DHCP::Option
+            self.options.add options
+          elsif !options.nil?
+            raise TypeError, "Can't convert #{options.class.name} to Lib::DHCP::Option"
+          end
+          self.options.add Lib::DHCP::Option53.new(DECLINE)
+        end
+
+        def pack
+          # noinspection RubyResolve
+          self.option53 = DECLINE
+          self.op = BOOTREQUEST
+          sanity_check
+          super
+        end
+
+        def self.unpack(packet)
+          res = super(packet)
+          raise TypeError, "No implicit conversion of #{res.class.name} into #{self.class.name}" unless res.is_a? self.class
+          res
+        end
+
+        protected :op=
+        # noinspection RubyResolve
+        protected :option53=
+
+        protected
+        def sanity_check
+          raise Lib::DHCP::SanityCheck::Decline, "FLAGS set for DHCP Decline Message\n #{self.to_s}" unless flags.to_i == 0
+          raise Lib::DHCP::SanityCheck::Decline, "CIADDR set for DHCP Decline Message\n #{self.to_s}" unless ciaddr.to_i == 0
+          raise Lib::DHCP::SanityCheck::Decline, "YIADDR set for DHCP Decline Message\n #{self.to_s}" unless yiaddr.to_i == 0
+          raise Lib::DHCP::SanityCheck::Decline, "SIADDR set for DHCP Decline Message\n #{self.to_s}" unless siaddr.to_i == 0
+          # noinspection RubyResolve
+          raise Lib::DHCP::SanityCheck::Decline, "Maximum Message Size Option set for DHCP Decline Message\n #{self.to_s}" unless option57.nil?
+          # noinspection RubyResolve
+          raise Lib::DHCP::SanityCheck::Decline, "Vendor class identifier Option set for DHCP Decline Message\n #{self.to_s}" unless option60.nil?
+          # noinspection RubyResolve
+          raise Lib::DHCP::SanityCheck::Decline, "Parameter Request List Option set for DHCP Decline Message\n #{self.to_s}" unless option55.nil?
+          # noinspection RubyResolve
+          raise Lib::DHCP::SanityCheck::Decline, "No Requested IP Address for DHCP Decline Message\n #{self.to_s}" if option50.nil?
+          # noinspection RubyResolve
+          raise Lib::DHCP::SanityCheck::Decline, "No Server identifier for DHCP Decline Message\n #{self.to_s}" if option54.nil?
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/messages/discover.rb

@@ -0,0 +1,70 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 24.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp'
+
+module Lib
+  module DHCP
+    class Message
+      class Discover < Message
+        def initialize(htype: 1, hlen: 6, hops: 0, xid: nil, secs: 0, flags: 0, ciaddr: 0, yiaddr: 0, siaddr: 0, giaddr: 0, chaddr: , sname: '.', file: '.', options:nil)
+          super(
+              :op     => BOOTREQUEST,
+              :htype  => htype,
+              :hlen   => hlen,
+              :hops   => hops,
+              :xid    => xid,
+              :secs   => secs,
+              :flags  => flags,
+              :ciaddr => ciaddr,
+              :yiaddr => yiaddr,
+              :siaddr => siaddr,
+              :giaddr => giaddr,
+              :chaddr => chaddr,
+              :sname  => sname,
+              :file   => file
+          )
+          if options.is_a? Array or options.is_a? Lib::DHCP::Options
+            options.each { |option| self.options.add option unless option.oid.to_i == Option::MESSAGE_TYPE }
+          elsif options.is_a? Lib::DHCP::Option
+            self.options.add options
+          elsif !options.nil?
+            raise TypeError, "Can't convert #{options.class.name} to Lib::DHCP::Option"
+          end
+          self.options.add Lib::DHCP::Option53.new(DISCOVER)
+        end
+
+        def pack
+          # noinspection RubyResolve
+          self.option53 = DISCOVER
+          self.op       = BOOTREQUEST
+          sanity_check
+          super
+        end
+
+        def self.unpack(packet)
+          res = super(packet)
+          raise TypeError,  "No implicit conversion of #{res.class.name} into #{self.class.name}" unless res.is_a? self.class
+          res
+        end
+
+        protected :op=
+        # noinspection RubyResolve
+        protected :option53=
+
+        protected
+
+        def sanity_check
+          # noinspection RubyResolve
+          #raise Lib::DHCP::SanityCheck::Discover, "Wrong DHCP message type #{option53.value} for Discover\n #{self.to_s}" unless option53.value.to_i == DHCP_DISCOVER
+          raise Lib::DHCP::SanityCheck::Discover, "YIADDR set for DHCP Discover\n #{self.to_s}" unless yiaddr.to_i == 0
+          raise Lib::DHCP::SanityCheck::Discover, "CIADDR set for DHCP Discovery\n #{self.to_s}" unless ciaddr.to_i == 0
+          # noinspection RubyResolve
+          raise Lib::DHCP::SanityCheck::Discover, "Server identifier option set for DHCP Discover Message\n #{self.to_s}" unless option54.nil?
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/messages/inform.rb

@@ -0,0 +1,64 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 25.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp'
+
+module Lib
+  module DHCP
+    class Message
+      class Inform < Message
+        def initialize(htype: 1, hlen: 6, hops: 0, xid: nil, secs: 0, flags: 0, ciaddr: 0, yiaddr: 0, siaddr: 0, giaddr: 0, chaddr: , sname: '.', file: '.', options: nil)
+          super(
+              :op => BOOTREQUEST,
+              :htype => htype,
+              :hlen => hlen,
+              :hops => hops,
+              :xid => xid,
+              :secs => secs,
+              :flags => flags,
+              :ciaddr => ciaddr,
+              :yiaddr => yiaddr,
+              :siaddr => siaddr,
+              :giaddr => giaddr,
+              :chaddr => chaddr,
+              :sname => sname,
+              :file => file
+          )
+          if options.is_a? Array or options.is_a? Lib::DHCP::Options
+            options.each { |option| self.options.add option unless option.oid.to_i == Option::MESSAGE_TYPE }
+          elsif options.is_a? Lib::DHCP::Option
+            self.options.add options
+          elsif !options.nil?
+            raise TypeError, "Can't convert #{options.class.name} to Lib::DHCP::Option"
+          end
+          self.options.add Lib::DHCP::Option53.new(INFORM)
+        end
+
+        def pack
+          # noinspection RubyResolve
+          self.option53 = INFORM
+          self.op = BOOTREQUEST
+          sanity_check
+          super
+        end
+
+        def self.unpack(packet)
+          res = super(packet)
+          raise TypeError, "No implicit conversion of #{res.class.name} into #{self.class.name}" unless res.is_a? self.class
+          res
+        end
+
+        protected :op=
+        # noinspection RubyResolve
+        protected :option53=
+
+        protected
+        def sanity_check
+          #TODO Inform Sanity Check
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/messages/lease_active.rb

@@ -0,0 +1,65 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 25.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp'
+
+module Lib
+  module DHCP
+    class Message
+      class LeaseActive < Message
+        def initialize(htype: 1, hlen: 6, hops: 0, xid: nil, secs: 0, flags: 0, ciaddr: 0, yiaddr: 0, siaddr: 0, giaddr: 0, chaddr: , sname: '.', file: '.', options: nil)
+          super(
+              :op => BOOTREPLY,
+              :htype => htype,
+              :hlen => hlen,
+              :hops => hops,
+              :xid => xid,
+              :secs => secs,
+              :flags => flags,
+              :ciaddr => ciaddr,
+              :yiaddr => yiaddr,
+              :siaddr => siaddr,
+              :giaddr => giaddr,
+              :chaddr => chaddr,
+              :sname => sname,
+              :file => file
+          )
+          if options.is_a? Array or options.is_a? Lib::DHCP::Options
+            options.each { |option| self.options.add option unless option.oid.to_i == Option::MESSAGE_TYPE }
+          elsif options.is_a? Lib::DHCP::Option
+            self.options.add options
+          elsif !options.nil?
+            raise TypeError, "Can't convert #{options.class.name} to Lib::DHCP::Option"
+          end
+
+          self.options.add Lib::DHCP::Option53.new(LEASE_ACTIVE)
+        end
+
+        def pack
+          # noinspection RubyResolve
+          self.option53 = LEASE_ACTIVE
+          self.op = BOOTREPLY
+          sanity_check
+          super
+        end
+
+        def self.unpack(packet)
+          res = super(packet)
+          raise TypeError, "No implicit conversion of #{res.class.name} into #{self.class.name}" unless res.is_a? self.class
+          res
+        end
+
+        protected :op=
+        # noinspection RubyResolve
+        protected :option53=
+
+        protected
+        def sanity_check
+          #TODO LeaseActive Sanity Check
+        end
+      end
+    end
+  end
+end

data/lib/lib/dhcp/messages/lease_query.rb

@@ -0,0 +1,64 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 25.03.2016 by Piotr Wojcieszonek
+
+
+require 'lib/dhcp'
+
+module Lib
+  module DHCP
+    class Message
+      class LeaseQuery < Message
+        def initialize(htype: 1, hlen: 6, hops: 0, xid: nil, secs: 0, flags: 0, ciaddr: 0, yiaddr: 0, siaddr: 0, giaddr: 0, chaddr: , sname: '.', file: '.', options: nil)
+          super(
+              :op => BOOTREQUEST,
+              :htype => htype,
+              :hlen => hlen,
+              :hops => hops,
+              :xid => xid,
+              :secs => secs,
+              :flags => flags,
+              :ciaddr => ciaddr,
+              :yiaddr => yiaddr,
+              :siaddr => siaddr,
+              :giaddr => giaddr,
+              :chaddr => chaddr,
+              :sname => sname,
+              :file => file
+          )
+          if options.is_a? Array or options.is_a? Lib::DHCP::Options
+            options.each { |option| self.options.add option unless option.oid.to_i == Option::MESSAGE_TYPE }
+          elsif options.is_a? Lib::DHCP::Option
+            self.options.add options
+          elsif !options.nil?
+            raise TypeError, "Can't convert #{options.class.name} to Lib::DHCP::Option"
+          end
+          self.options.add Lib::DHCP::Option53.new(LEASE_QUERY)
+        end
+
+        def pack
+          # noinspection RubyResolve
+          self.option53 = LEASE_QUERY
+          self.op = BOOTREQUEST
+          sanity_check
+          super
+        end
+
+        def self.unpack(packet)
+          res = super(packet)
+          raise TypeError, "No implicit conversion of #{res.class.name} into #{self.class.name}" unless res.is_a? self.class
+          res
+        end
+
+        protected :op=
+        # noinspection RubyResolve
+        protected :option53=
+
+        protected
+        def sanity_check
+          #TODO LeaseQuery Sanity Check
+        end
+      end
+    end
+  end
+end