pio 0.3.0 → 0.4.0

data/lib/pio/dhcp/ack.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'pio/dhcp/boot_reply'
+
+module Pio
+  class Dhcp
+    # Dhcp Ack packet generator
+    class Ack < BootReply
+      TYPE = 5
+    end
+  end
+end

data/lib/pio/dhcp/boot_reply.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'pio/dhcp/message'
+require 'pio/dhcp/boot_reply_options'
+
+module Pio
+  class Dhcp
+    # DHCP Reply Frame Base Class
+    class BootReply < Message
+      MESSAGE_TYPE = 2
+
+      # DHCP Options Class.
+      class Options < Dhcp::BootReplyOptions; end
+    end
+  end
+end

data/lib/pio/dhcp/boot_reply_options.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require 'pio/options'
+require 'pio/dhcp/common_options'
+require 'pio/dhcp/dhcp_tlv_options'
+
+module Pio
+  class Dhcp
+    # Options for creating a DHCP message.
+    class BootReplyOptions < Pio::Options
+      include CommonOptions
+      include DhcpTlvOptions
+
+      mandatory_option :source_mac
+      mandatory_option :destination_mac
+      mandatory_option :ip_source_address
+      mandatory_option :ip_destination_address
+      mandatory_option :type
+      option :subnet_mask
+      option :renewal_time_value
+      option :rebinding_time_value
+      option :ip_address_lease_time
+      option :server_identifier
+      option :transaction_id
+
+      def initialize(options)
+        @options = options
+      end
+
+      def to_hash
+        {
+          destination_mac: destination_mac,
+          source_mac: source_mac,
+          ip_destination_address: ip_destination_address,
+          ip_source_address: ip_source_address,
+          udp_src_port: BOOTPS,
+          udp_dst_port: BOOTPC,
+          dhcp: dhcp_data
+        }
+      end
+
+      private
+
+      def dhcp_field_values
+        {
+          message_type: BootReply::MESSAGE_TYPE,
+          transaction_id: transaction_id,
+          client_ip_address: QUAD_ZERO_IP_ADDRESS,
+          your_ip_address: ip_destination_address,
+          next_server_ip_address: QUAD_ZERO_IP_ADDRESS,
+          relay_agent_ip_address: QUAD_ZERO_IP_ADDRESS,
+          client_mac_address: source_mac,
+          optional_tlvs: options_for_optional_tlv
+        }
+      end
+
+      def options_for_optional_tlv
+        [
+          message_type_hash,
+          renewal_time_value_hash,
+          rebinding_time_value_hash,
+          ip_address_lease_time_hash,
+          dhcp_server_identifier_hash,
+          subnet_mask_hash
+        ].compact
+      end
+
+      def server_identifier
+        IPv4Address.new(
+          @options[:server_identifier] || ip_source_address
+        )
+      end
+    end
+  end
+end

data/lib/pio/dhcp/boot_request.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'pio/dhcp/message'
+require 'pio/dhcp/boot_request_options'
+
+module Pio
+  class Dhcp
+    # DHCP Request Frame Base Class
+    class BootRequest < Message
+      MESSAGE_TYPE = 1
+
+      # DHCP Options Class.
+      class Options < Dhcp::BootRequestOptions; end
+    end
+  end
+end

data/lib/pio/dhcp/boot_request_options.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require 'pio/options'
+require 'pio/dhcp/common_options'
+require 'pio/dhcp/dhcp_tlv_options'
+
+module Pio
+  class Dhcp
+    # Options for creating a DHCP message.
+    class BootRequestOptions < Pio::Options
+      include CommonOptions
+      include DhcpTlvOptions
+
+      mandatory_option :source_mac
+      mandatory_option :type
+      option :destination_mac
+      option :requested_ip_address
+      option :server_identifier
+      option :transaction_id
+
+      def initialize(options)
+        validate options
+        @options = options
+      end
+
+      def to_hash
+        {
+          destination_mac: destination_mac,
+          source_mac: source_mac,
+          ip_source_address: QUAD_ZERO_IP_ADDRESS,
+          ip_destination_address: BROADCAST_IP_ADDRESS,
+          udp_src_port: BOOTPC,
+          udp_dst_port: BOOTPS,
+          dhcp: dhcp_data
+        }
+      end
+
+      private
+
+      def dhcp_field_values
+        {
+          message_type: BootRequest::MESSAGE_TYPE,
+          transaction_id: transaction_id,
+          client_ip_address: QUAD_ZERO_IP_ADDRESS,
+          your_ip_address: QUAD_ZERO_IP_ADDRESS,
+          next_server_ip_address: QUAD_ZERO_IP_ADDRESS,
+          relay_agent_ip_address: QUAD_ZERO_IP_ADDRESS,
+          client_mac_address: source_mac,
+          optional_tlvs: options_for_optional_tlv
+        }
+      end
+
+      def options_for_optional_tlv
+        [
+          message_type_hash,
+          client_identifier_hash,
+          requested_ip_address_hash,
+          parameters_list_hash,
+          dhcp_server_identifier_hash
+        ].compact
+      end
+
+      def server_identifier
+        server_id = @options[:server_identifier]
+        IPv4Address.new(server_id) if server_id
+      end
+    end
+  end
+end

data/lib/pio/dhcp/common_options.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+module Pio
+  class Dhcp
+    # DHCP Common Options.
+    module CommonOptions
+      BOOTPC = 68
+      BOOTPS = 67
+      QUAD_ZERO_IP_ADDRESS = IPv4Address.new(0)
+      BROADCAST_MAC_ADDRESS = Mac.new(0xffffffffffff)
+      BROADCAST_IP_ADDRESS = IPv4Address.new(0xffffffff)
+
+      def dhcp_data
+        Dhcp::DhcpField.new(dhcp_field_values)
+      end
+
+      def type
+        @options[:type]
+      end
+
+      def source_mac
+        Mac.new(@options[:source_mac])
+      end
+
+      def destination_mac
+        Mac.new(@options[:destination_mac] || BROADCAST_MAC_ADDRESS)
+      end
+
+      def ip_source_address
+        IPv4Address.new(@options[:ip_source_address])
+      end
+
+      def ip_destination_address
+        IPv4Address.new(@options[:ip_destination_address])
+      end
+
+      def server_identifier
+        IPv4Address.new(
+          @options[:server_identifier] || ip_source_address
+        )
+      end
+
+      def subnet_mask
+        subnet = @options[:subnet_mask]
+        IPv4Address.new(subnet) if subnet
+      end
+
+      def transaction_id
+        @options[:transaction_id]
+      end
+
+      def renewal_time_value
+        @options[:renewal_time_value]
+      end
+
+      def rebinding_time_value
+        @options[:rebinding_time_value]
+      end
+
+      def ip_address_lease_time
+        @options[:ip_address_lease_time]
+      end
+
+      def requested_ip_address
+        IPv4Address.new(
+          @options[:requested_ip_address] || QUAD_ZERO_IP_ADDRESS
+        )
+      end
+    end
+  end
+end

data/lib/pio/dhcp/csum_util.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+module Pio
+  class Dhcp
+    # Checksum Calculate Utility.
+    module CsumUtil
+      private
+
+      def ip_csum
+        ipv4_header_2bytewise_slices.reduce(:+)
+      end
+
+      def udp_csum
+        udp_header_2bytewise_slices.reduce(:+)
+      end
+
+      def ipv4_header_2bytewise_slices
+        [
+          ipversion_ipheaderlength_iptypeofservice, ip_total_length,
+          ip_identifier, ipflag_ipfragment,
+          ipttl_ipproto,
+          ip_source_address_upper,
+          ip_source_address_lower,
+          ip_destination_address_upper,
+          ip_destination_address_lower
+        ]
+      end
+
+      def ip_source_address_upper
+        ip_source_address.get.to_i >> 16
+      end
+
+      def ip_source_address_lower
+        ip_source_address.get.to_i & 0xffff
+      end
+
+      def ip_destination_address_upper
+        ip_destination_address.get.to_i >> 16
+      end
+
+      def ip_destination_address_lower
+        ip_destination_address.get.to_i & 0xffff
+      end
+
+      def ipversion_ipheaderlength_iptypeofservice
+        ip_version << 12 | ip_header_length << 8 | ip_type_of_service
+      end
+
+      def ipflag_ipfragment
+        ip_flag << 13 | ip_fragment
+      end
+
+      def ipttl_ipproto
+        ip_ttl << 8 | ip_protocol
+      end
+
+      def udp_header_2bytewise_slices
+        [
+          pseudo_header_2bytewise_slices,
+          udp_src_port,
+          udp_dst_port,
+          udp_len,
+          payload_2bytewise_slices
+        ]
+      end
+
+      def payload_2bytewise_slices
+        (dhcp.to_binary_s + trail_data).unpack('n*').reduce(:+)
+      end
+
+      def pseudo_header_2bytewise_slices
+        [
+          ip_source_address_upper,
+          ip_source_address_lower,
+          ip_destination_address_upper,
+          ip_destination_address_lower,
+          ip_protocol,
+          udp_len
+        ].pack('n*').unpack('n*').reduce(:+)
+      end
+    end
+  end
+end

data/lib/pio/dhcp/dhcp_field.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'pio/dhcp/optional_tlv'
+require 'pio/type/ip_address'
+require 'pio/type/mac_address'
+
+module Pio
+  class Dhcp
+    # DHCP Field
+    class DhcpField < BinData::Record
+      MAGIC_COOKIE = 0x63825363
+      ETHERNET = 1
+      MAC_ADDRESS_LENGTH = 6
+
+      endian :big
+
+      uint8 :message_type
+      uint8 :hw_addr_type,
+            initial_value: ETHERNET
+      uint8 :hw_addr_len,
+            initial_value: MAC_ADDRESS_LENGTH
+      uint8 :hops,
+            initial_value: 0
+      uint32be :transaction_id,
+               initial_value: rand(0xffffffff)
+      uint16be :seconds,
+               initial_value: 0
+      uint16be :bootp_flags,
+               initial_value: 0
+      ip_address :client_ip_address
+      ip_address :your_ip_address
+      ip_address :next_server_ip_address
+      ip_address :relay_agent_ip_address
+      mac_address :client_mac_address
+      string :client_mac_address_padding,
+             length: 10
+      string :server_host_name,
+             length: 64
+      string :boot_file_name,
+             length: 128
+      uint32be :magic_cookie,
+               value: MAGIC_COOKIE
+      array  :optional_tlvs,
+             type: :optional_tlv,
+             read_until: -> { element.end_of_dhcptlv? }
+    end
+  end
+end

data/lib/pio/dhcp/dhcp_tlv_options.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require 'pio/dhcp/common_options'
+
+module Pio
+  class Dhcp
+    # DHCP TLV Methods.
+    module DhcpTlvOptions
+      include CommonOptions
+
+      def message_type_hash
+        {
+          tlv_type: Dhcp::MESSAGE_TYPE_TLV,
+          tlv_info_length: 1,
+          tlv_value: type
+        }
+      end
+
+      def client_identifier_hash
+        {
+          tlv_type: Dhcp::CLIENT_IDENTIFIER_TLV,
+          tlv_info_length: 7,
+          tlv_value: source_mac
+        }
+      end
+
+      def requested_ip_address_hash
+        {
+          tlv_type: Dhcp::REQUESTED_IP_ADDRESS_TLV,
+          tlv_info_length: 4,
+          tlv_value: requested_ip_address
+        }
+      end
+
+      def dhcp_server_identifier_hash
+        {
+          tlv_type: Dhcp::SERVER_IDENTIFIER_TLV,
+          tlv_info_length: 4,
+          tlv_value: server_identifier
+        } if server_identifier
+      end
+
+      def parameters_list_hash
+        {
+          tlv_type: Dhcp::PARAMETERS_LIST_TLV,
+          tlv_info_length: Dhcp::PARAMETER_REQUEST_LIST.length,
+          tlv_value: Dhcp::PARAMETER_REQUEST_LIST
+        }
+      end
+
+      def renewal_time_value_hash
+        {
+          tlv_type: Dhcp::RENEWAL_TIME_VALUE_TLV,
+          tlv_info_length: 4,
+          tlv_value: renewal_time_value
+        } if renewal_time_value
+      end
+
+      def rebinding_time_value_hash
+        {
+          tlv_type: Dhcp::REBINDING_TIME_VALUE_TLV,
+          tlv_info_length: 4,
+          tlv_value: rebinding_time_value
+        } if rebinding_time_value
+      end
+
+      def ip_address_lease_time_hash
+        {
+          tlv_type: Dhcp::IP_ADDRESS_LEASE_TIME_TLV,
+          tlv_info_length: 4,
+          tlv_value: ip_address_lease_time
+        }
+      end
+
+      def subnet_mask_hash
+        {
+          tlv_type: Dhcp::SUBNET_MASK_TLV,
+          tlv_info_length: 4,
+          tlv_value: subnet_mask
+        } if subnet_mask
+      end
+    end
+  end
+end