pio 0.3.0 → 0.4.0

data/examples/arp_new.rb

@@ -0,0 +1,16 @@
+require 'pio'
+
+request = Pio::Arp::Request.new(
+  source_mac: '00:26:82:eb:ea:d1',
+  sender_protocol_address: '192.168.83.3',
+  target_protocol_address: '192.168.83.254'
+)
+request.to_binary  # => Arp Request frame in binary format.
+
+reply = Pio::Arp::Reply.new(
+  source_mac: '00:16:9d:1d:9c:c4',
+  destination_mac: '00:26:82:eb:ea:d1',
+  sender_protocol_address: '192.168.83.254',
+  target_protocol_address: '192.168.83.3'
+)
+reply.to_binary  # => Arp Reply frame in binary format.

data/examples/arp_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+arp = Pio::Arp.read(binary_data)
+arp.source_mac.to_s # => '00:26:82:eb:ea:d1'

data/examples/dhcp_new.rb

@@ -0,0 +1,30 @@
+require 'pio'
+
+discover = Pio::Dhcp::Discover.new(source_mac: '24:db:ac:41:e5:5b')
+discover.to_binary  # => DHCP Discover frame in binary format
+
+offer = Pio::Dhcp::Offer.new(
+  source_mac: '00:26:82:eb:ea:d1',
+  destination_mac: '24:db:ac:41:e5:5b',
+  ip_source_address: '192.168.0.100',
+  ip_destination_address: '192.168.0.1',
+  transaction_id: discover.transaction_id
+)
+offer.to_binary  # => DHCP Offer frame in binary format
+
+request = Pio::Dhcp::Request.new(
+  source_mac: '24:db:ac:41:e5:5b',
+  server_identifier: '192.168.0.100',
+  requested_ip_address: '192.168.0.1',
+  transaction_id: offer.transaction_id
+)
+request.to_binary  # => DHCP Request frame in binary format
+
+ack = Pio::Dhcp::Ack.new(
+  source_mac: '00:26:82:eb:ea:d1',
+  destination_mac: '24:db:ac:41:e5:5b',
+  ip_source_address: '192.168.0.100',
+  ip_destination_address: '192.168.0.1',
+  transaction_id: request.transaction_id
+)
+ack.to_binary  # => DHCP Ack frame in binary format

data/examples/dhcp_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+dhcp = Pio::Dhcp.read(binary_data)
+dhcp.destination_mac.to_s  # => 'ff:ff:ff:ff:ff:ff'

data/examples/icmp_new.rb

@@ -0,0 +1,21 @@
+require 'pio'
+
+request = Pio::Icmp::Request.new(
+  source_mac: '00:16:9d:1d:9c:c4',
+  destination_mac: '00:26:82:eb:ea:d1',
+  ip_source_address: '192.168.83.3',
+  ip_destination_address: '192.168.83.254'
+)
+request.to_binary  # => ICMP Request frame in binary format.
+
+reply = Pio::Icmp::Reply.new(
+  source_mac: '00:26:82:eb:ea:d1',
+  destination_mac: '00:16:9d:1d:9c:c4',
+  ip_source_address: '192.168.83.254',
+  ip_destination_address: '192.168.83.3',
+  # The ICMP Identifier and the ICMP Sequence number
+  # should be same as those of the request.
+  identifier: request.icmp_identifier,
+  sequence_number: request.icmp_sequence_number
+)
+reply.to_binary  # => ICMP Reply frame in binary format.

data/examples/icmp_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+icmp = Pio::Icmp.read(binary_data)
+icmp.source_mac.to_s # => '00:26:82:eb:ea:d1'

data/examples/lldp_new.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+lldp = Pio::Lldp.new(dpid: 0x123, port_number: 12)
+lldp.to_binary  # => LLDP frame in binary format.

data/examples/lldp_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+lldp = Pio::Lldp.read(binary_data)
+lldp.ttl # => 120

data/lib/pio.rb

@@ -1,15 +1,9 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
+require 'pio/parse_error'
+
 require 'pio/arp'
 require 'pio/lldp'
 require 'pio/icmp'
-
-module Pio
-  # Raised when the packet data is in wrong format.
-  class ParseError < StandardError; end
-end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:
+require 'pio/mac'
+require 'pio/dhcp'

data/lib/pio/arp.rb

@@ -1,28 +1,16 @@
-# -*- coding: utf-8 -*-
-require 'English'
-require 'rubygems'
-require 'bindata'
+# encoding: utf-8
 
+require 'pio/arp/frame'
 require 'pio/arp/request'
 require 'pio/arp/reply'
-require 'pio/util'
+require 'pio/message_type_selector'
 
+# Packet parser and generator library.
 module Pio
   # ARP parser and generator.
-
   class Arp
-    MESSAGE_TYPE = {
-      Request::OPERATION => Request,
-      Reply::OPERATION => Reply
-    }
-    class << self
-      include Util
-    end
+    extend MessageTypeSelector
+    message_type Request::OPERATION => Request, Reply::OPERATION => Reply
   end
+  ARP = Arp
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/arp/frame.rb

@@ -1,4 +1,6 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
+require 'bindata'
 require 'pio/type/ethernet_header'
 require 'pio/type/ip_address'
 require 'pio/type/mac_address'
@@ -11,11 +13,11 @@ module Pio
 
       endian :big
 
-      ethernet_header :ether_type => 0x0806
-      uint16 :hardware_type, :value => 1
-      uint16 :protocol_type, :value => 0x0800
-      uint8 :hardware_length, :value => 6
-      uint8 :protocol_length, :value => 4
+      ethernet_header ether_type: 0x0806
+      uint16 :hardware_type, value: 1
+      uint16 :protocol_type, value: 0x0800
+      uint8 :hardware_length, value: 6
+      uint8 :protocol_length, value: 4
       uint16 :operation
       mac_address :sender_hardware_address
       ip_address :sender_protocol_address
@@ -32,9 +34,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/arp/message.rb

@@ -1,26 +1,13 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'forwardable'
 require 'pio/arp/frame'
-require 'pio/ipv4_address'
-require 'pio/message_util'
 
 module Pio
   class Arp
     # Base class of ARP Request and Reply
     class Message
       extend Forwardable
-      include MessageUtil
-
-      def self.create_from(frame)
-        message = allocate
-        message.instance_variable_set :@frame, frame
-        message
-      end
-
-      def initialize(options)
-        @options = options
-        @frame = Arp::Frame.new(option_hash)
-      end
 
       def_delegators :@frame, :destination_mac
       def_delegators :@frame, :source_mac
@@ -36,17 +23,17 @@ module Pio
       def_delegators :@frame, :target_protocol_address
       def_delegators :@frame, :to_binary
 
-      private
+      def self.create_from(frame)
+        message = allocate
+        message.instance_variable_set :@frame, frame
+        message
+      end
+
+      private_class_method :new
 
-      def option_to_klass
-        {
-          :source_mac => Mac,
-          :destination_mac => Mac,
-          :sender_hardware_address => Mac,
-          :target_hardware_address => Mac,
-          :sender_protocol_address => IPv4Address,
-          :target_protocol_address => IPv4Address,
-        }
+      def initialize(user_options)
+        options = self.class.const_get(:Options).new(user_options.dup.freeze)
+        @frame = Arp::Frame.new(options.to_hash)
       end
     end
   end

data/lib/pio/arp/reply.rb

@@ -1,45 +1,45 @@
-# -*- coding: utf-8 -*-
-require 'forwardable'
+# encoding: utf-8
+
 require 'pio/arp/message'
 require 'pio/mac'
+require 'pio/options'
 
 module Pio
   class Arp
     # ARP Reply packet generator
     class Reply < Message
       OPERATION = 2
+      public_class_method :new
 
-      private
+      # User options for creating an Arp Reply.
+      class Options < Pio::Options
+        mandatory_option :source_mac
+        mandatory_option :destination_mac
+        mandatory_option :sender_protocol_address
+        mandatory_option :target_protocol_address
 
-      def default_options
-        {
-          :operation => OPERATION,
-        }
-      end
+        def initialize(options)
+          validate options
+          @source_mac = Mac.new(options[:source_mac]).freeze
+          @destination_mac = Mac.new(options[:destination_mac]).freeze
+          @sender_protocol_address =
+            IPv4Address.new(options[:sender_protocol_address]).freeze
+          @target_protocol_address =
+            IPv4Address.new(options[:target_protocol_address]).freeze
+        end
 
-      def user_options
-        @options.merge(
-          :sender_hardware_address => @options[:source_mac],
-          :target_hardware_address => @options[:destination_mac]
-        )
-      end
-
-      def mandatory_options
-        [
-          :source_mac,
-          :destination_mac,
-          :sender_hardware_address,
-          :target_hardware_address,
-          :sender_protocol_address,
-          :target_protocol_address,
-        ]
+        def to_hash
+          {
+            operation: OPERATION,
+            source_mac: @source_mac,
+            destination_mac: @destination_mac,
+            sender_hardware_address: @source_mac,
+            target_hardware_address: @destination_mac,
+            sender_protocol_address: @sender_protocol_address,
+            target_protocol_address: @target_protocol_address
+          }.freeze
+        end
       end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/arp/request.rb

@@ -1,45 +1,46 @@
-# -*- coding: utf-8 -*-
-require 'pio/arp/frame'
+# encoding: utf-8
+
 require 'pio/arp/message'
 require 'pio/mac'
+require 'pio/options'
 
 module Pio
   class Arp
     # ARP Request packet generator
     class Request < Message
       OPERATION = 1
+      public_class_method :new
 
-      BROADCAST_MAC_ADDRESS = Mac.new(0xffffffffffff).to_a
-      ALL_ZERO_MAC_ADDRESS = Mac.new(0).to_a
+      # User options for creating an Arp Request.
+      class Options < Pio::Options
+        mandatory_option :source_mac
+        mandatory_option :sender_protocol_address
+        mandatory_option :target_protocol_address
 
-      private
+        BROADCAST_MAC = Mac.new(0xffffffffffff).freeze
+        ALL_ZERO_MAC = Mac.new(0).freeze
 
-      def default_options
-        {
-          :operation => OPERATION,
-          :destination_mac => BROADCAST_MAC_ADDRESS,
-          :target_hardware_address => ALL_ZERO_MAC_ADDRESS
-        }
-      end
+        def initialize(options)
+          validate options
+          @source_mac = Mac.new(options[:source_mac]).freeze
+          @sender_protocol_address =
+            IPv4Address.new(options[:sender_protocol_address]).freeze
+          @target_protocol_address =
+            IPv4Address.new(options[:target_protocol_address]).freeze
+        end
 
-      def user_options
-        @options.merge :sender_hardware_address => @options[:source_mac]
-      end
-
-      def mandatory_options
-        [
-          :source_mac,
-          :sender_hardware_address,
-          :sender_protocol_address,
-          :target_protocol_address,
-        ]
+        def to_hash
+          {
+            operation: OPERATION,
+            source_mac: @source_mac,
+            destination_mac: BROADCAST_MAC,
+            sender_hardware_address: @source_mac,
+            target_hardware_address: ALL_ZERO_MAC,
+            sender_protocol_address: @sender_protocol_address,
+            target_protocol_address: @target_protocol_address
+          }.freeze
+        end
       end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/dhcp.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+# Packet parser and generator library.
+module Pio
+  # Dhcp parser and generator.
+  class Dhcp
+    MESSAGE_TYPE_TLV = 53
+    SERVER_IDENTIFIER_TLV = 54
+    CLIENT_IDENTIFIER_TLV = 61
+    RENEWAL_TIME_VALUE_TLV = 58
+    REBINDING_TIME_VALUE_TLV = 59
+    REQUESTED_IP_ADDRESS_TLV = 50
+    PARAMETERS_LIST_TLV = 55
+    IP_ADDRESS_LEASE_TIME_TLV = 51
+    SUBNET_MASK_TLV = 1
+    ROUTER_TLV = 3
+    NTP_SERVERS_TLV = 42
+    DNS_TLV = 6
+    END_OF_TLV = 255
+
+    PARAMETER_REQUEST_LIST =
+      [
+        SUBNET_MASK_TLV,
+        ROUTER_TLV,
+        DNS_TLV,
+        NTP_SERVERS_TLV
+      ]
+  end
+  DHCP = Dhcp
+end
+
+require 'bindata'
+require 'pio/dhcp/discover'
+require 'pio/dhcp/offer'
+require 'pio/dhcp/request'
+require 'pio/dhcp/ack'
+
+module Pio
+  # Dhcp parser and generator.
+  class Dhcp
+    MESSAGE_TYPE = {
+      Discover::TYPE => Discover,
+      Offer::TYPE => Offer,
+      Request::TYPE => Request,
+      Ack::TYPE => Ack
+    }
+
+    def self.read(raw_data)
+      begin
+        frame = const_get('Frame').read(raw_data)
+      rescue
+        raise Pio::ParseError, $ERROR_INFO.message
+      end
+
+      const_get('MESSAGE_TYPE')[frame.message_type].create_from(frame)
+    end
+  end
+end