pio 0.3.0 → 0.4.0

data/lib/pio/dhcp/discover.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'pio/dhcp/boot_request'
+
+module Pio
+  class Dhcp
+    # Dhcp Discover packet generator
+    class Discover < BootRequest
+      TYPE = 1
+    end
+  end
+end

data/lib/pio/dhcp/field_util.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+module Pio
+  class Dhcp
+    # Dhcp Field Read Methods.
+    module FieldUtil
+      def message_type
+        get_tlv_field(53)
+      end
+
+      def server_identifier
+        get_tlv_field(54)
+      end
+
+      def client_identifier
+        get_tlv_field(61)
+      end
+
+      def renewal_time_value
+        get_tlv_field(58)
+      end
+
+      def rebinding_time_value
+        get_tlv_field(59)
+      end
+
+      def ip_address_lease_time
+        get_tlv_field(51)
+      end
+
+      def requested_ip_address
+        get_tlv_field(50)
+      end
+
+      def parameters_list
+        get_tlv_field(55)
+      end
+
+      def subnet_mask
+        get_tlv_field(1)
+      end
+
+      def hw_addr_type
+        dhcp.hw_addr_type
+      end
+
+      def hw_addr_len
+        dhcp.hw_addr_len
+      end
+
+      def hops
+        dhcp.hops
+      end
+
+      def transaction_id
+        dhcp.transaction_id
+      end
+
+      def seconds
+        dhcp.seconds
+      end
+
+      def bootp_flags
+        dhcp.bootp_flags
+      end
+
+      def client_ip_address
+        dhcp.client_ip_address
+      end
+
+      def your_ip_address
+        dhcp.your_ip_address
+      end
+
+      def next_server_ip_address
+        dhcp.next_server_ip_address
+      end
+
+      def relay_agent_ip_address
+        dhcp.relay_agent_ip_address
+      end
+
+      def client_mac_address
+        dhcp.client_mac_address
+      end
+
+      private
+
+      def get_tlv(tlv_type)
+        tlv = dhcp.optional_tlvs.find do | each |
+          each['tlv_type'] == tlv_type
+        end
+        tlv['tlv_value'] if tlv
+      end
+
+      def get_tlv_field(tlv_type)
+        tlv = get_tlv(tlv_type)
+        tlv.snapshot if tlv
+      end
+    end
+  end
+end

data/lib/pio/dhcp/frame.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+require 'pio/type/ethernet_header'
+require 'pio/type/ipv4_header'
+require 'pio/type/udp_header'
+require 'pio/dhcp/dhcp_field'
+require 'pio/dhcp/field_util'
+require 'pio/dhcp/csum_util'
+
+module Pio
+  class Dhcp
+    # Dhcp frame parser.
+    class Frame < BinData::Record
+      extend Type::EthernetHeader
+      extend Type::IPv4Header
+      extend Type::UdpHeader
+      include FieldUtil
+      include CsumUtil
+
+      ETHER_TYPE_IP = 0x0800
+      IP_PROTOCOL_UDP = 17
+      IP_HEADER_LENGTH = 20
+      UDP_HEADER_LENGTH = 8
+      DHCP_OPTION_FIELD_LENGTH = 60
+
+      endian :big
+
+      ethernet_header ether_type: ETHER_TYPE_IP
+      ipv4_header     ip_protocol: IP_PROTOCOL_UDP,
+                      ip_header_checksum: -> { ip_sum },
+                      ip_total_length: -> { ip_len }
+      udp_header      udp_length: -> { udp_len },
+                      udp_checksum: -> { udp_sum }
+      dhcp_field      :dhcp
+
+      def ip_sum
+        ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff
+      end
+
+      def udp_sum
+        ~((udp_csum & 0xffff) + (udp_csum >> 16)) & 0xffff
+      end
+
+      def ip_len
+        IP_HEADER_LENGTH + udp_len
+      end
+
+      def udp_len
+        UDP_HEADER_LENGTH + dhcp_len
+      end
+
+      def to_binary
+        to_binary_s + trail_data
+      end
+
+      private
+
+      def dhcp_len
+        dhcp.num_bytes + trail_data.bytesize
+      end
+
+      def dhcp_binary
+        dhcp.to_binary_s
+      end
+
+      def should_padding?
+        option_length < DHCP_OPTION_FIELD_LENGTH
+      end
+
+      def option_length
+        dhcp.optional_tlvs.num_bytes + 1
+      end
+
+      def trail_data
+        if should_padding?
+          end_of_pdu + padding
+        else
+          end_of_pdu
+        end
+      end
+
+      def end_of_pdu
+        [0xff].pack('C*')
+      end
+
+      def padding
+        [0x00].pack('C*') * padding_length
+      end
+
+      def padding_length
+        DHCP_OPTION_FIELD_LENGTH - option_length
+      end
+    end
+  end
+end

data/lib/pio/dhcp/message.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require 'pio/dhcp/frame'
+require 'forwardable'
+
+module Pio
+  class Dhcp
+    # Base class of Dhcp Packet Generator and Parser.
+    class Message
+      extend Forwardable
+
+      def_delegators :@frame, :destination_mac
+      def_delegators :@frame, :source_mac
+      def_delegators :@frame, :ether_type
+      def_delegators :@frame, :ip_version
+      def_delegators :@frame, :ip_header_length
+      def_delegators :@frame, :ip_type_of_service
+      def_delegators :@frame, :ip_total_length
+      def_delegators :@frame, :ip_identifier
+      def_delegators :@frame, :ip_flag
+      def_delegators :@frame, :ip_fragment
+      def_delegators :@frame, :ip_ttl
+      def_delegators :@frame, :ip_protocol
+      def_delegators :@frame, :ip_header_checksum
+      def_delegators :@frame, :ip_source_address
+      def_delegators :@frame, :ip_destination_address
+      def_delegators :@frame, :udp_src_port
+      def_delegators :@frame, :udp_dst_port
+      def_delegators :@frame, :udp_length
+      def_delegators :@frame, :udp_checksum
+      def_delegators :@frame, :dhcp
+      def_delegators :@frame, :optioal_tlvs
+      def_delegators :@frame, :boot_message_type
+      def_delegators :@frame, :message_type
+      def_delegators :@frame, :hw_addr_type
+      def_delegators :@frame, :hw_addr_len
+      def_delegators :@frame, :hops
+      def_delegators :@frame, :transaction_id
+      def_delegators :@frame, :seconds
+      def_delegators :@frame, :bootp_flags
+      def_delegators :@frame, :client_ip_address
+      def_delegators :@frame, :your_ip_address
+      def_delegators :@frame, :next_server_ip_address
+      def_delegators :@frame, :relay_agent_ip_address
+      def_delegators :@frame, :client_mac_address
+      def_delegators :@frame, :server_host_name
+      def_delegators :@frame, :boot_file_name
+      def_delegators :@frame, :server_identifier
+      def_delegators :@frame, :renewal_time_value
+      def_delegators :@frame, :rebinding_time_value
+      def_delegators :@frame, :ip_address_lease_time
+      def_delegators :@frame, :subnet_mask
+      def_delegators :@frame, :client_identifier
+      def_delegators :@frame, :requested_ip_address
+      def_delegators :@frame, :parameters_list
+      def_delegators :@frame, :to_binary
+
+      def self.create_from(frame)
+        message = allocate
+        message.instance_variable_set :@frame, frame
+        message
+      end
+
+      def initialize(user_options)
+        type_merged_options = user_options.merge type: const_type
+        options = options_klass.new(type_merged_options)
+        @frame = Dhcp::Frame.new(options.to_hash)
+      end
+
+      def const_type
+        self.class::TYPE
+      end
+
+      def options_klass
+        self.class.const_get(:Options)
+      end
+    end
+  end
+end

data/lib/pio/dhcp/offer.rb

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

data/lib/pio/dhcp/optional_tlv.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+require 'pio/dhcp/type/dhcp_param_list'
+require 'pio/dhcp/type/dhcp_client_id'
+require 'pio/dhcp/type/dhcp_string'
+require 'pio/type/ip_address'
+
+module Pio
+  # Dhcp parser and generator.
+  class Dhcp
+    # DHCP Optional TLV
+    class OptionalTlv < BinData::Record
+      DEFAULT = 'default'
+
+      endian :big
+
+      bit8 :tlv_type
+      bit8 :tlv_info_length,
+           onlyif: -> { !(end_of_dhcpdu?) }
+      choice  :tlv_value,
+              onlyif: -> { !(end_of_dhcpdu?) },
+              selection: :chooser do
+        uint8 Dhcp::MESSAGE_TYPE_TLV
+        ip_address Dhcp::SERVER_IDENTIFIER_TLV
+        uint32be Dhcp::RENEWAL_TIME_VALUE_TLV
+        uint32be Dhcp::REBINDING_TIME_VALUE_TLV
+        uint32be Dhcp::IP_ADDRESS_LEASE_TIME_TLV
+        ip_address Dhcp::SUBNET_MASK_TLV
+        ip_address Dhcp::REQUESTED_IP_ADDRESS_TLV
+        client_id Dhcp::CLIENT_IDENTIFIER_TLV
+        parameter_list Dhcp::PARAMETERS_LIST_TLV
+        dhcp_string DEFAULT
+      end
+
+      def end_of_dhcptlv?
+        tlv_type == Dhcp::END_OF_TLV
+      end
+
+      def chooser
+        if valid_optional_tlv?
+          tlv_type
+        else
+          DEFAULT
+        end
+      end
+
+      def end_of_dhcpdu?
+        tlv_type == Dhcp::END_OF_TLV
+      end
+
+      private
+
+      def valid_optional_tlv?
+        optional_tlv? || end_of_dhcptlv?
+      end
+
+      # rubocop:disable MethodLength
+      def optional_tlv?
+        [
+          Dhcp::MESSAGE_TYPE_TLV,
+          Dhcp::SERVER_IDENTIFIER_TLV,
+          Dhcp::CLIENT_IDENTIFIER_TLV,
+          Dhcp::RENEWAL_TIME_VALUE_TLV,
+          Dhcp::REBINDING_TIME_VALUE_TLV,
+          Dhcp::REQUESTED_IP_ADDRESS_TLV,
+          Dhcp::PARAMETERS_LIST_TLV,
+          Dhcp::IP_ADDRESS_LEASE_TIME_TLV,
+          Dhcp::SUBNET_MASK_TLV
+        ].include?(tlv_type)
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/pio/dhcp/request.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'pio/dhcp/boot_request'
+
+module Pio
+  class Dhcp
+    # Dhcp Request packet generator
+    class Request < BootRequest
+      TYPE = 3
+    end
+  end
+end

data/lib/pio/dhcp/type/dhcp_client_id.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'pio/type/mac_address'
+
+module Pio
+  class Dhcp
+    # Dhcp Client Id Format
+    class ClientId < BinData::Primitive
+      bit8 :hardwaretype, value: 1
+      mac_address :mac
+
+      def get
+        mac
+      end
+
+      def set(value)
+        self.mac = value
+      end
+    end
+  end
+end

data/lib/pio/dhcp/type/dhcp_param_list.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'bindata'
+
+module Pio
+  module Type
+    # DHCP ParameterList Format.
+    class ParameterList < BinData::Primitive
+      array :octets,
+            type: :uint8,
+            initial_length: :tlv_info_length
+
+      def set(value)
+        self.octets = value
+      end
+
+      def get
+        octets
+      end
+    end
+  end
+end

data/lib/pio/dhcp/type/dhcp_string.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'bindata'
+
+module Pio
+  module Type
+    # DHCP String Format.
+    class DhcpString < BinData::Primitive
+      string :dhcp_string,
+             read_length: :tlv_info_length
+
+      def set(value)
+        self.dhcp_string = value
+      end
+
+      def get
+        dhcp_string
+      end
+    end
+  end
+end