packetgen 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36c2e8a9384d7c08723de6f529893d0dd42e5d8d
-  data.tar.gz: 0e91b3917d405a1a09b75a7863685645b52827d9
+  metadata.gz: 543fd7ef2efee43e0bf0d61c8a6520d178c869a2
+  data.tar.gz: bcdd42ce36fc83c202abe8c2fd6f820a13a1b588
 SHA512:
-  metadata.gz: 55414180e5ca3bcc69cee0a00a84cbe79635a2809d3f999d35a9d6fab725b5dfc153ea5cc087c10d08985caf10c60aa7ee23df2fb4537d7ca3d6924789f2e614
-  data.tar.gz: 51ea04c7c3a1544911ca26f4c6b8c066bc58aa0255a2dd6241f21b668fee9e16c7def036d62722c7e826f77947128225c1a56d5ee4ef27aa71d0eaff55352b5e
+  metadata.gz: 04c3d376f587f745972f534655f83e5fa12c30e039a58854411f89c57d769c235f9fa8faf1f6bfb37bf2deba639f45ea96a1eea8706dda77ea3c01a753aac502
+  data.tar.gz: ed8d4002df84be1f0e1ddbcf19dd29bbf8290ed05606648421af3e7914b6288f9aacd8ec252bec6edd1357e5c42923f84400088c0fd2bc744c06e88c179d16b0

data/lib/packetgen/config.rb

@@ -12,6 +12,7 @@ module PacketGen
   # Config class to provide +config+ object to pgconsole
   # @author Sylvain Daubert
   # @author Kent 'picat' Gruber
+  # @since 1.4.1
   # @since 2.1.3 Config is singleton
   class Config
     include Singleton

data/lib/packetgen/header.rb

@@ -99,3 +99,6 @@ require_relative 'header/ike'
 require_relative 'header/dns'
 require_relative 'header/asn1_base'
 require_relative 'header/snmp'
+require_relative 'header/bootp'
+require_relative 'header/dhcp'
+require_relative 'header/http'

data/lib/packetgen/header/bootp.rb

@@ -0,0 +1,151 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    
+    # Bootstrap Protocol, {https://tools.ietf.org/html/rfc951
+    # RFC 951}
+    #
+    # A BOOTP header consists of:
+    # * an operation code field ({#op} of type {Types::Int8Enum}),
+    # * a hardware address type ({#htype} of type {Types::Int8}),
+    # * a hardware address length ({#hlen} of type {Types::Int8}),
+    # * a {#hops} field ({Types::Int8}),
+    # * a transaction ID ({#xid} of type {Types::Int32}),
+    # * a {#secs} field (){Types::Int16}),
+    # * a {#flags} field (){Types::Int16}):
+    #   * a 1-bit broadcast flag ({#b}),
+    #   * a 15-bit Must Be Zero field ({#mbz}),
+    # * a {#ciaddr} field ({IP::Addr}),
+    # * a {#yiaddr} field ({IP::Addr}),
+    # * a {#siaddr} field ({IP::Addr}),
+    # * a {#giaddr} field ({IP::Addr}),
+    # * a {#chaddr} field (16-byte {Types::String}),
+    # * a {#sname} field (64-byte {Types::CString}),
+    # * a {#file} field (128-byte {Types::CString}),
+    # * and a body ({Types::String}).
+    #
+    # == Create a BOOTP header
+    #   # standalone
+    #   bootp = PacketGen::Header::BOOTP.new
+    #   # in a packet
+    #   pkt = PacketGen.gen('IP').add('BOOTP')
+    #   # access to BOOTP header
+    #   pkt.bootp      # => PacketGen::Header::BOOTP
+    # @author Sylvain Daubert
+    # @since 2.2.0
+    class BOOTP < Base
+      
+      UDP_SERVER_PORT = 67
+      UDP_CLIENT_PORT = 68
+      
+      # DHCP opcodes
+      OPCODES = {
+        'BOOTREQUEST' => 1,
+        'BOOTREPLY'   => 2
+      }
+
+      # @!attribute op
+      #   8-bit opcode
+      #   @return [Integer]
+      define_field :op, Types::Int8Enum, enum: OPCODES
+
+      # @!attribute htype
+      #  8-bit hardware address type
+      #  @return [Integer]
+      define_field :htype, Types::Int8, default: 1
+
+      # @!attribute hlen
+      #  8-bit hardware address length
+      #  @return [Integer]
+      define_field :hlen, Types::Int8, default: 6
+
+      # @!attribute hops
+      #  @return [Integer]
+      define_field :hops, Types::Int8
+
+      # @!attribute xid
+      #  32-bit Transaction ID
+      #  @return [Integer]
+      define_field :xid, Types::Int32
+      
+      # @!attribute secs
+      #  16-bit integer: number of seconds elapsed since client began address
+      #  acquisition or renewal process
+      #  @return [Integer]
+      define_field :secs, Types::Int16
+      
+      # @!attribute flags
+      #  16-bit flag field
+      #  @return [Integer]
+      define_field :flags, Types::Int16
+
+      # @!attribute ciaddr
+      #  client IP address
+      #  @return [String]
+      define_field :ciaddr, IP::Addr
+
+      # @!attribute yiaddr
+      #  'your' (client) IP address
+      #  @return [String]
+      define_field :yiaddr, IP::Addr
+      
+      # @!attribute siaddr
+      #  IP address of next server to use in bootstrap
+      #  @return [String]
+      define_field :siaddr, IP::Addr
+      
+      # @!attribute giaddr
+      #  Relay agent IP address, used in booting via a relay agent
+      #  @return [String]
+      define_field :giaddr, IP::Addr
+      
+      # @!attribute chaddr
+      #   client hardware address
+      #   @return [String]
+      define_field :chaddr, Types::String, static_length: 16
+
+      # @!attribute sname
+      #   optional server hostname, null-terminated string
+      #   @return [String]
+      define_field :sname, Types::CString, static_length: 64
+
+      # @!attribute file
+      #   Boot file name, null terminated string
+      #   @return [String]
+      define_field :file, Types::CString, static_length: 128
+
+      # @!attribute body
+      #   @return [String]
+      define_field :body, Types::String
+      
+      # @!attribute b
+      #  Broadcast flag, from {#flags}
+      # @return [Boolean]
+      # @!attribute mbz
+      #  15-bit Must Be Zero bits, from {#flags}
+      # @return [Boolean]
+      define_bit_fields_on :flags, :b, :mbz, 15
+      
+      def inspect
+        str = Inspect.dashed_line(self.class, 2)
+        fields.each do |attr|
+          next if attr == :body
+          next unless is_present?(attr)
+          if attr == :chaddr and self.hlen == 6
+            str << Inspect.inspect_attribute(attr, Eth::MacAddr.new.read(self[:chaddr][0, 6]), 2)
+          else
+            str << Inspect.inspect_attribute(attr, self[attr], 2)
+          end
+        end
+        str
+      end
+    end
+    
+    UDP.bind_header BOOTP, sport: 67, dport: 68
+    UDP.bind_header BOOTP, sport: 68, dport: 67
+  end
+end

data/lib/packetgen/header/dhcp.rb

@@ -0,0 +1,65 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    
+    # Dynamic Host Configuration Protocol, {https://tools.ietf.org/html/rfc2131 
+    # RFC 2131}
+    #
+    # A DHCP header is quite simple. It is composed of:
+    # * a {#magic} field ({Types::Int32}) to retrieve it in a BOOTP header,
+    # * a, {#options} field ({Options} type, which is a collection of DHCP
+    #   options).
+    #
+    # In PacketGen, a DHCP header is always a secondary header after {BOOTP} one.
+    #
+    # == Create a DHCP header
+    #   # standalone
+    #   dhcp = PacketGen::Header::DHCP.new
+    #   # in a packet
+    #   pkt = PacketGen.gen('IP').add('BOOTP').add('DHCP')
+    #   # access to DHCP header
+    #   pkt.dhcp      # => PacketGen::Header::DHCP
+    #
+    # == Add options
+    # Options may be added these ways:
+    #   dhcp = PacketGen::Header::DHCP.new
+    #   # Add a lease_time option
+    #   dhcp.options << { type: 'lease_time', value: 3600 }
+    #   # Add a domain option. Here, use integer type
+    #   dhcp.options << { type: 15, value: 'example.net'}
+    #   # Add an end option
+    #   dhcp.options << { type: 'end' }
+    #   # And finish with padding
+    #   dhcp.options << { type: 'pad' }
+    # @author Sylvain Daubert
+    # @since 2.2.0
+    class DHCP < Base; end
+
+    require_relative 'dhcp/option'
+    require_relative 'dhcp/options'
+
+    class DHCP < Base
+      # DHCP magic value in BOOTP options
+      DHCP_MAGIC = 0x63825363
+
+      # @!attribute magic
+      #   @return [Integer]
+      define_field :magic, Types::Int32, default: 0x63825563
+      # @!attribute options
+      #   @return [DHCP::Options]
+      define_field :options, DHCP::Options
+      
+      # differentiate from BOOTP by checking presence of DHCP magic
+      # @return [Boolean]
+      def parse?
+        self.magic == DHCP_MAGIC
+      end
+    end
+    
+    BOOTP.bind_header DHCP
+  end
+end

data/lib/packetgen/header/dhcp/option.rb

@@ -0,0 +1,154 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class DHCP
+
+      # define DHCP Options.
+      # keys are option type, value are arrays containing option names
+      # as strings, and a hash passed to {Option#initialize}.
+      DHCPOptions = {
+        1  => ['subnet_mask', length: 4, v: IP::Addr],
+        2  => ['time_zone'],
+        3  => ['router', length: 4, v: IP::Addr],
+        4  => ['time_server', length: 4, v: IP::Addr],
+        5  => ['IEN_name_server', length: 4, v: IP::Addr],
+        6  => ['name_server', length: 4, v: IP::Addr],
+        7  => ['log_server', length: 4, v: IP::Addr],
+        8  => ['cookie_server', length: 4, v: IP::Addr],
+        9  => ['lpr_server', length: 4, v: IP::Addr],
+        12 => ['hostname'],
+        14 => ['dump_path'],
+        15 => ['domain'],
+        17 => ['root_disk_path'],
+        23 => ['default_ttl'],
+        24 => ['pmtu_timeout'],
+        28 => ['broadcast_address', length: 4, v: IP::Addr],
+        40 => ['NIS_domain'],
+        41 => ['NIS_server', length: 4, v: IP::Addr],
+        42 => ['NTP_server', length: 4, v: IP::Addr],
+        43 => ['vendor_specific'],
+        44 => ['NetBIOS_server', length: 4, v: IP::Addr],
+        45 => ['NetBIOS_dist_server', length: 4, v: IP::Addr],
+        50 => ['requested_addr', length: 4, v: IP::Addr],
+        51 => ['lease_time', length: 4, v: Types::Int32, value: 43200],
+        53 => ['message-type', length: 1, v: Types::Int8],
+        54 => ['server_id', length: 4, v: IP::Addr],
+        55 => ['param_req_list'],
+        56 => ['error_message'],
+        57 => ['max_dhcp_size', length: 2, v: Types::Int16, value: 1500],
+        58 => ['renewal_time', length: 4, v: Types::Int32, value: 21600],
+        59 => ['rebinding_time', length: 4, v: Types::Int32, value: 37800],
+        60 => ['vendor_class_id'],
+        61 => ['client_id'],
+        64 => ['NISplus_domain'],
+        65 => ['NISplus_server', length: 4, v: IP::Addr],
+        69 => ['SMTP_server', length: 4, v: IP::Addr],
+        70 => ['POP3_server', length: 4, v: IP::Addr],
+        71 => ['NNTP_server', length: 4, v: IP::Addr],
+        72 => ['WWW_server', length: 4, v: IP::Addr],
+        73 => ['finger_server', length: 4, v: IP::Addr],
+        74 => ['IRC_server', length: 4, v: IP::Addr]
+      }
+
+      # Class to indicate DHCP options end
+      class End < Types::Int8
+        def initialize(value=255)
+          super
+        end
+        def to_human; self.class.to_s.sub(/.*::/, '').downcase; end
+        alias human_type to_human
+      end
+
+      # Class to indicate padding after DHCP options
+      class Pad < End
+        def initialize(value=0)
+          super
+        end
+      end
+
+      # DHCP option
+      #
+      # A DHCP option is a {Types::TLV TLV}, so it has:
+      # * a {#type} ({Types::Int8}),
+      # * a {#length} ({Types::Int8}),
+      # * and a {#value}. Defalt type is {Types::String} but some options
+      #   may use more suitable type (by example, a {IP::Addr} for +router+
+      #   option).
+      # @author Sylvain Daubert
+      class Option < Types::TLV
+
+        # Option types
+        TYPES = Hash[DHCPOptions.to_a.map { |type, ary| [type, ary[0]] }]
+
+        # @param [Hash] options
+        # @option options [Integer] :type
+        # @option options [Integer] :length
+        # @option options [String] :value
+        def initialize(options={})
+          super
+          if DHCPOptions.has_key?(self.type)
+            h = DHCPOptions[self.type].last
+            if h.is_a? Hash
+              h.each do |k, v|
+                self.length = v if k == :length
+                if k == :v
+                  self[:value] = v.new
+                  self.value = options[:value] if options[:value]
+                end
+              end
+            end
+          end
+        end
+
+        # @private
+        alias private_read read
+
+        # Populate object from a binary string
+        # @param [String] str
+        # @return [Option,End,Pad] may return another object than itself
+        def read(str)
+          read_type = str[0].unpack('C').first
+          if read_type == 0
+            Pad.new.read(str)
+          elsif read_type == 255
+            End.new.read(str)
+          elsif DHCPOptions.has_key?(read_type)
+            Option.new(DHCPOptions[read_type][1] || {}).private_read(str)
+          else
+            super
+          end
+        end
+
+        def has_human_types?
+          true
+        end
+
+        def human_type
+          if DHCPOptions.has_key?(type)
+            DHCPOptions[type].first.dup
+          else
+            type.to_s
+          end
+        end
+
+        def to_human
+          s = human_type
+          if length > 0
+            if value.respond_to? :to_human
+              s << ":#{value.to_human}"
+            elsif self[:value].is_a? Types::Int
+              s << ":#{self.value.to_i}"
+            else
+              s << ":#{value.inspect}"
+            end
+          end
+          s
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/dhcp/options.rb

@@ -0,0 +1,42 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Header
+    class DHCP
+      
+      # Container class for DHCP Options
+      #
+      # == Add DHCP options to an +Options+ instance
+      #   options = PacketGen::Header::DHCP::Options.new
+      #   # Add a lease_time option
+      #   options << { type: 'lease_time', value: 3600 }
+      #   # Add a domain option. Here, use integer type
+      #   options << { type: 15, value: 'example.net'}
+      #   # Add an end option
+      #   options << { type: 'end' }
+      #   # And finish with padding
+      #   options << { type: 'pad' }
+      # @author Sylvain Daubert
+      class Options < Types::Array
+        set_of Option
+
+        private
+
+        def record_from_hash(hsh)
+          case hsh[:type]
+          when 'pad', 0
+            Pad.new
+          when 'end', 255
+            End.new
+          else
+            obj_klass = self.class.class_eval { @klass }
+            obj_klass.new(hsh)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packetgen/header/dns.rb

@@ -144,16 +144,16 @@ module PacketGen
       define_field :arcount, Types::Int16
       # @!attribute qd
       #  @return [QDSection]
-      define_field :qd, QDSection, builder: ->(dns) { QDSection.new(dns, dns[:qdcount]) }
+      define_field :qd, QDSection, builder: ->(h,t) { t.new(h, h[:qdcount]) }
       # @!attribute an
       #  @return [RRSection]
-      define_field :an, RRSection, builder: ->(dns) { RRSection.new(dns, dns[:ancount]) }
+      define_field :an, RRSection, builder: ->(h,t) { t.new(h, h[:ancount]) }
       # @!attribute ns
       #  @return [RRSection]
-      define_field :ns, RRSection, builder: ->(dns) { RRSection.new(dns, dns[:nscount]) }
+      define_field :ns, RRSection, builder: ->(h,t) { t.new(h, h[:nscount]) }
       # @!attribute ar
       #  @return [RRSection]
-      define_field :ar, RRSection, builder: ->(dns) { RRSection.new(dns, dns[:arcount]) }
+      define_field :ar, RRSection, builder: ->(h,t) { t.new(h, h[:arcount]) }
 
       # @!attribute qr
       #   @return [Boolean] query (+false+) or response (+true+)