pio 0.1.0

data/lib/pio/lldp/system-capabilities-value.rb

@@ -0,0 +1,22 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # TLV value field of system capabilities TLV
+    class SystemCapabilitiesValue < BinData::Record
+      endian :big
+
+      uint16be :system_capabilities
+      uint16be :enabled_capabilities
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/system-description-value.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # TLV value field of system description TLV
+    class SystemDescriptionValue < BinData::Record
+      endian :big
+
+      stringz :system_description
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/system-name-value.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # TLV value field of system name TLV
+    class SystemNameValue < BinData::Record
+      endian :big
+
+      stringz :system_name
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/ttl-tlv.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # Time to live TLV
+    class TtlTlv < BinData::Primitive
+      endian :big
+
+      bit7 :tlv_type, :value => 3
+      bit9 :tlv_info_length, :value => 2
+      string :ttl, :read_length => :tlv_info_length
+
+
+      def get
+        BinData::Int16be.read( ttl )
+      end
+
+
+      def set value
+        self.ttl = BinData::Int16be.new( value ).to_binary_s
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/version.rb

@@ -0,0 +1,30 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+# Base module.
+module Pio
+  # gem version.
+  VERSION = "0.1.0"
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/pio.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path( "../lib", __FILE__ )
+$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
+require "pio/version"
+
+
+Gem::Specification.new do | gem |
+  gem.name = "pio"
+  gem.version = Pio::VERSION
+  gem.summary = "Packet parser and generator."
+  gem.description = "Pure ruby packet parser and generator."
+
+  gem.license = "GPL3"
+
+  gem.authors = [ "Yasuhito Takamiya" ]
+  gem.email = [ "yasuhito@gmail.com" ]
+  gem.homepage = "http://github.com/trema/pio"
+
+  gem.files = `git ls-files`.split( "\n" )
+
+  gem.require_paths = [ "lib" ]
+
+  gem.extra_rdoc_files = [ "README.md" ]
+  gem.test_files = `git ls-files -- {spec,features}/*`.split( "\n" )
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/chassis-id-tlv_spec.rb

@@ -0,0 +1,27 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/chassis-id-tlv"
+
+
+module Pio
+  class Lldp
+    describe ChassisIdTlv do
+      subject { ChassisIdTlv.read( data.pack( "C*" ) ) }
+
+      context "parsing a raw data" do
+        let( :data ) { [ 0x02, 0x07, 0x04, 0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d ] }
+
+        its( :tlv_type ) { should eq 1 }
+        its( :tlv_info_length ) { should eq 7 }
+        its( :subtype ) { should eq 4 }
+        its( :chassis_id ) { should eq data[ -6..-1 ].pack( "C*" ) }
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/end-of-lldpdu-value_spec.rb

@@ -0,0 +1,20 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/end-of-lldpdu-value"
+
+
+module Pio
+  class Lldp
+    describe EndOfLldpduValue do
+      subject { EndOfLldpduValue.new }
+
+      its( :tlv_info_string ) { should be_empty }
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/frame_spec.rb

@@ -0,0 +1,82 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/frame"
+
+
+module Pio
+  class Lldp
+    describe Frame do
+      it "should parse a minimal LLDP" do
+        sample_packet = [
+                          0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e,  # Destination MAC
+                          0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d,  # Source MAC
+                          0x88, 0xcc,  # Ethertype
+                          0x02, 0x07, 0x04, 0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d,  # Chassis ID TLV
+                          0x04, 0x0d, 0x01, 0x55, 0x70, 0x6c, 0x69, 0x6e, 0x6b, 0x20, 0x74, 0x6f, 0x20, 0x53, 0x31,  # Port ID TLV
+                          0x06, 0x02, 0x00, 0x78,  # Time to live TLV
+                          0x00, 0x00,  # End of LLDPDU TLV
+                        ].pack( "C*" )
+
+        lldp = Frame.read( sample_packet )
+      end
+
+
+      it "should parse LLDP" do
+        sample_packet = [
+                          0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e,  # Destination MAC
+                          0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d,  # Source MAC
+                          0x88, 0xcc,  # Ethertype
+                          0x02, 0x07, 0x04, 0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d,  # Chassis ID TLV
+                          0x04, 0x0d, 0x01, 0x55, 0x70, 0x6c, 0x69, 0x6e, 0x6b, 0x20, 0x74, 0x6f, 0x20, 0x53, 0x31,  # Port ID TLV
+                          0x06, 0x02, 0x00, 0x78,  # Time to live TLV
+                          0x08, 0x17, 0x53, 0x75, 0x6d, 0x6d, 0x69, 0x74, 0x33, 0x30, 0x30, 0x2d, 0x34, 0x38, 0x2d, 0x50, 0x6f, 0x72, 0x74, 0x20, 0x31, 0x30, 0x30, 0x31, 0x00,  # Port Description
+                          0x0a, 0x0d, 0x53, 0x75, 0x6d, 0x6d, 0x69, 0x74, 0x33, 0x30, 0x30, 0x2d, 0x34, 0x38, 0x00,  # System Name
+                          0x0c, 0x4c, 0x53, 0x75, 0x6d, 0x6d, 0x69, 0x74, 0x33, 0x30, 0x30, 0x2d, 0x34, 0x38, 0x20, 0x2d, 0x20, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x20, 0x37, 0x2e, 0x34, 0x65, 0x2e, 0x31, 0x20, 0x28, 0x42, 0x75, 0x69, 0x6c, 0x64, 0x20, 0x35, 0x29, 0x20, 0x62, 0x79, 0x20, 0x52, 0x65, 0x6c, 0x65, 0x61, 0x73, 0x65, 0x5f, 0x4d, 0x61, 0x73, 0x74, 0x65, 0x72, 0x20, 0x30, 0x35, 0x2f, 0x32, 0x37, 0x2f, 0x30, 0x35, 0x20, 0x30, 0x34, 0x3a, 0x35, 0x33, 0x3a, 0x31, 0x31, 0x00,  # System Description
+                          0x0e, 0x04, 0x00, 0x14, 0x00, 0x14, # System Capabilities
+                          0x10, 0x0e, 0x07, 0x06, 0x00, 0x01, 0x30, 0xf9, 0xad, 0xa0, 0x02, 0x00, 0x00, 0x03, 0xe9, 0x00,  # Management Address
+                          0xfe, 0x07, 0x00, 0x12, 0x0f, 0x02, 0x07, 0x01, 0x00,
+                          0x00, 0x00,  # End of LLDPDU TLV
+                        ].pack( "C*" )
+
+        lldp = Frame.read( sample_packet )
+        lldp.optional_tlv[ 0 ][ :tlv_type ].should eq 4
+        lldp.optional_tlv[ 1 ][ :tlv_type ].should eq 5
+        lldp.optional_tlv[ 2 ][ :tlv_type ].should eq 6
+        lldp.optional_tlv[ 3 ][ :tlv_type ].should eq 7
+        lldp.optional_tlv[ 4 ][ :tlv_type ].should eq 8
+        lldp.optional_tlv[ 5 ][ :tlv_type ].should eq 0
+      end
+
+
+      it "should create a valid LLDP packet" do
+        # sample packet taken from http://www.cloudshark.org/captures/05a981251df9
+        sample_packet = [
+                          0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e,  # Destination MAC
+                          0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d,  # Source MAC
+                          0x88, 0xcc,  # Ethertype
+                          0x02, 0x07, 0x04, 0x00, 0x19, 0x2f, 0xa7, 0xb2, 0x8d,  # Chassis ID TLV
+                          0x04, 0x0d, 0x01, 0x55, 0x70, 0x6c, 0x69, 0x6e, 0x6b, 0x20, 0x74, 0x6f, 0x20, 0x53, 0x31,  # Port ID TLV
+                          0x06, 0x02, 0x00, 0x78,  # Time to live TLV
+                          0x00, 0x00  # End of LLDPDU TLV
+                        ].pack( "C*" )
+
+        lldp_frame = Frame.new
+        lldp_frame.destination_mac = "01:80:c2:00:00:0e"
+        lldp_frame.source_mac = "00:19:2f:a7:b2:8d"
+        lldp_frame.chassis_id.subtype = 4
+        lldp_frame.chassis_id = "\x00\x19\x2f\xa7\xb2\x8d"
+        lldp_frame.port_id.subtype = 1
+        lldp_frame.port_id = "Uplink to S1"
+        lldp_frame.ttl = 120
+
+        ( lldp_frame.to_binary_s.unpack( "H*" )[ 0 ] + "0000" ).should == sample_packet.unpack( "H*" )[ 0 ]
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/mac-address_spec.rb

@@ -0,0 +1,20 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/mac-address"
+
+
+module Pio
+  class Lldp
+    describe MacAddress do
+      subject { MacAddress.new( "01:80:c2:00:00:0e" ) }
+
+      its( :to_binary_s ) { should eq "\001\200\302\000\000\016" }
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/optional-tlv_spec.rb

@@ -0,0 +1,81 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/optional-tlv"
+
+
+module Pio
+  class Lldp
+    describe OptionalTlv do
+      subject { OptionalTlv.read( data ) }
+
+
+      context "when parsing End Of LLDPDU TLV" do
+        let( :data ) { [ 0x00, 0x00 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 0 }
+        its( :tlv_info_length ) { should eq 0 }
+        its( :tlv_value ) { should eq "tlv_info_string" => "" }
+      end
+
+
+      context "when parsing Port Description TLV" do
+        let( :data ) { [ 0x08, 0x17, 0x53, 0x75, 0x6d, 0x6d, 0x69, 0x74, 0x33, 0x30, 0x30, 0x2d, 0x34, 0x38, 0x2d, 0x50, 0x6f, 0x72, 0x74, 0x20, 0x31, 0x30, 0x30, 0x31, 0x00 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 4 }
+        its( :tlv_info_length ) { should eq 23 }
+        its( :tlv_value ) { should eq( { "port_description" => "Summit300-48-Port 1001" } ) }
+      end
+
+
+      context "when parsing System Name TLV" do
+        let( :data ) { [ 0x0a, 0x0d, 0x53, 0x75, 0x6d, 0x6d, 0x69, 0x74, 0x33, 0x30, 0x30, 0x2d, 0x34, 0x38, 0x00 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 5 }
+        its( :tlv_info_length ) { should eq 13 }
+        its( :tlv_value ) { should eq( { "system_name" => "Summit300-48" } ) }
+      end
+
+
+      context "when parsing System Description TLV" do
+        let( :data ) { [ 0x0c, 0x4c, 0x53, 0x75, 0x6d, 0x6d, 0x69, 0x74, 0x33, 0x30, 0x30, 0x2d, 0x34, 0x38, 0x20, 0x2d, 0x20, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x20, 0x37, 0x2e, 0x34, 0x65, 0x2e, 0x31, 0x20, 0x28, 0x42, 0x75, 0x69, 0x6c, 0x64, 0x20, 0x35, 0x29, 0x20, 0x62, 0x79, 0x20, 0x52, 0x65, 0x6c, 0x65, 0x61, 0x73, 0x65, 0x5f, 0x4d, 0x61, 0x73, 0x74, 0x65, 0x72, 0x20, 0x30, 0x35, 0x2f, 0x32, 0x37, 0x2f, 0x30, 0x35, 0x20, 0x30, 0x34, 0x3a, 0x35, 0x33, 0x3a, 0x31, 0x31, 0x00 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 6 }
+        its( :tlv_info_length ) { should eq 76 }
+        its( :tlv_value ) { should eq( { "system_description"=>"Summit300-48 - Version 7.4e.1 (Build 5) by Release_Master 05/27/05 04:53:11" } ) }
+      end
+
+
+      context "when parsing System Capabilities TLV" do
+        let( :data ) { [ 0x0e, 0x04, 0x00, 0x14, 0x00, 0x14 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 7 }
+        its( :tlv_info_length ) { should eq 4 }
+        its( :tlv_value ) { should eq( { "system_capabilities" => 20, "enabled_capabilities" => 20 } ) }
+      end
+
+
+      context "when parsing Management Address TLV" do
+        let( :data ) { [ 0x10, 0x0e, 0x07, 0x06, 0x00, 0x01, 0x30, 0xf9, 0xad, 0xa0, 0x02, 0x00, 0x00, 0x03, 0xe9, 0x00 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 8 }
+        its( :tlv_info_length ) { should eq 14 }
+        its( :tlv_value ) { should eq( { "management_address" => "\a\006" } ) }  # FIXME
+      end
+
+
+      context "when parsing Organizationally Specific TLV" do
+        let( :data ) { [ 0xfe, 0x07, 0x00, 0x12, 0x0f, 0x02, 0x07, 0x01, 0x00 ].pack( "C*" ) }
+
+        its( :tlv_type ) { should eq 127 }
+        its( :tlv_info_length ) { should eq 7 }
+        its( :tlv_value ) { should eq "" }  # FIXME
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/port-id-tlv_spec.rb

@@ -0,0 +1,27 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/port-id-tlv"
+
+
+module Pio
+  class Lldp
+    describe PortIdTlv do
+      subject { PortIdTlv.read( data.pack( "C*" ) ) }
+
+      context "parsing a raw data" do
+        let( :data ) { [ 0x04, 0x0d, 0x01, 0x55, 0x70, 0x6c, 0x69, 0x6e, 0x6b, 0x20, 0x74, 0x6f, 0x20, 0x53, 0x31 ] }
+
+        its( :tlv_type ) { should eq 2 }
+        its( :tlv_info_length ) { should eq 13 }
+        its( :subtype ) { should eq 1 }
+        its( :port_id ) { should eq data[ -12..-1 ].pack( "C*" ) }
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/pio/lldp/ttl-tlv_spec.rb

@@ -0,0 +1,26 @@
+require File.join( File.dirname( __FILE__ ), "..", "..", "spec_helper" )
+require "pio/lldp/ttl-tlv"
+
+
+module Pio
+  class Lldp
+    describe TtlTlv do
+      subject { TtlTlv.read( data.pack( "C*" ) ) }
+
+      context "parsing a raw data" do
+        let( :data ) { [ 0x06, 0x02, 0x00, 0x78 ] }
+
+        its( :tlv_type ) { should eq 3 }
+        its( :tlv_info_length ) { should eq 2 }
+        its( :ttl ) { should eq data[ -2..-1 ].pack( "C*" ) }
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: