pio 0.30.0 → 0.30.1

data/features/ethernet_header.feature

@@ -0,0 +1,149 @@
+Feature: EthernetHeader
+  Scenario: create an Ethernet header
+    When I create a packet with:
+      """ruby
+      Pio::EthernetHeader.new(
+        destination_mac: 'ff:ff:ff:ff:ff:ff',
+        source_mac: '00:26:82:eb:ea:d1',
+        ether_type: Pio::Ethernet::Type::IPV4
+      )
+      """
+    Then the packet has the following fields and values:
+      | field             | value               |
+      | class             | Pio::EthernetHeader |
+      | destination_mac   | ff:ff:ff:ff:ff:ff   |
+      | source_mac        | 00:26:82:eb:ea:d1   |
+      | ether_type.to_hex | 0x800               |
+
+  Scenario: create a VLAN-tagged Ethernet header
+    When I create a packet with:
+      """ruby
+      Pio::EthernetHeader.new(
+        destination_mac: 'ff:ff:ff:ff:ff:ff',
+        source_mac: '00:26:82:eb:ea:d1',
+        ether_type: Pio::Ethernet::Type::VLAN,
+        vlan_pcp: 5,
+        vlan_cfi: 0,
+        vlan_vid: 100
+      )
+      """
+    Then the packet has the following fields and values:
+      | field             | value               |
+      | class             | Pio::EthernetHeader |
+      | destination_mac   | ff:ff:ff:ff:ff:ff   |
+      | source_mac        | 00:26:82:eb:ea:d1   |
+      | ether_type.to_hex | 0x8100              |
+      | vlan_pcp          | 5                   |
+      | vlan_cfi          | 0                   |
+      | vlan_vid          | 100                 |
+
+  Scenario: read an Ethernet header
+    Given I use the fixture "ethernet_header"
+    When I create a packet with:
+      """ruby
+      Pio::EthernetHeader.read(eval(IO.read('ethernet_header.rb')))
+      """
+    Then the packet has the following fields and values:
+      | field             | value               |
+      | class             | Pio::EthernetHeader |
+      | destination_mac   | ff:ff:ff:ff:ff:ff   |
+      | source_mac        | 00:26:82:eb:ea:d1   |
+      | ether_type.to_hex | 0x800               |
+
+  Scenario: read a VLAN-tagged Ethernet header
+    Given I use the fixture "ethernet_header"
+    When I create a packet with:
+      """ruby
+      Pio::EthernetHeader.read(eval(IO.read('vlan_ethernet_header.rb')))
+      """
+    Then the packet has the following fields and values:
+      | field             | value               |
+      | class             | Pio::EthernetHeader |
+      | destination_mac   | ff:ff:ff:ff:ff:ff   |
+      | source_mac        | 00:26:82:eb:ea:d1   |
+      | ether_type.to_hex | 0x8100              |
+      | vlan_pcp          | 5                   |
+      | vlan_cfi          | 0                   |
+      | vlan_vid          | 100                 |
+
+  Scenario: convert Ethernet header to Ruby code
+    When I eval the following Ruby code:
+      """ruby
+      Pio::EthernetHeader.new(
+        destination_mac: 'ff:ff:ff:ff:ff:ff',
+        source_mac: '00:26:82:eb:ea:d1',
+        ether_type: Pio::Ethernet::Type::IPV4
+      ).to_ruby
+      """
+    Then the result of eval should be:
+      """ruby
+      [
+        0xff, 0xff, 0xff, 0xff, 0xff, 0xff, # destination_mac
+        0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1, # source_mac
+        0x08, 0x00, # ether_type
+      ].pack('C14')
+      """
+
+  Scenario: convert VLAN-tagged Ethernet header to Ruby code
+    When I eval the following Ruby code:
+      """ruby
+      Pio::EthernetHeader.new(
+        destination_mac: 'ff:ff:ff:ff:ff:ff',
+        source_mac: '00:26:82:eb:ea:d1',
+        ether_type: Pio::Ethernet::Type::VLAN,
+        vlan_pcp: 5,
+        vlan_cfi: 0,
+        vlan_vid: 100
+      ).to_ruby
+      """
+    Then the result of eval should be:
+      """ruby
+      [
+        0xff, 0xff, 0xff, 0xff, 0xff, 0xff, # destination_mac
+        0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1, # source_mac
+        0x81, 0x00, # ether_type
+        0b101_0_000001100100, # vlan_pcp, vlan_cfi, vlan_vid
+        0x81, 0x00, # ether_type_vlan
+      ].pack('C14nC2')
+      """
+
+  Scenario: EthernetHeader instance inspection
+    When I eval the following Ruby code:
+      """ruby
+      Pio::EthernetHeader.new(
+        destination_mac: 'ff:ff:ff:ff:ff:ff',
+        source_mac: '00:26:82:eb:ea:d1',
+        ether_type: Pio::Ethernet::Type::IPV4,
+      ).inspect
+      """
+    Then the result of eval should be:
+      """
+      #<Pio::EthernetHeader destination_mac: "ff:ff:ff:ff:ff:ff", source_mac: "00:26:82:eb:ea:d1", ether_type: 0x0800>
+      """
+
+  Scenario: VLAN-tagged EthernetHeader instance inspection
+    When I eval the following Ruby code:
+      """ruby
+      Pio::EthernetHeader.new(
+        destination_mac: 'ff:ff:ff:ff:ff:ff',
+        source_mac: '00:26:82:eb:ea:d1',
+        ether_type: Pio::Ethernet::Type::VLAN,
+        vlan_pcp: 5,
+        vlan_cfi: 0,
+        vlan_vid: 100
+      ).inspect
+      """
+    Then the result of eval should be:
+      """
+      #<Pio::EthernetHeader destination_mac: "ff:ff:ff:ff:ff:ff", source_mac: "00:26:82:eb:ea:d1", ether_type: 0x8100, vlan_pcp: 5, vlan_cfi: 0, vlan_vid: 100, ether_type_vlan: 0x8100>
+      """
+
+  Scenario: EthernetHeader class inspection
+    When I eval the following Ruby code:
+      """ruby
+      Pio::EthernetHeader.inspect
+      """
+    Then the result of eval should be:
+      """
+      Pio::EthernetHeader(destination_mac: mac_address, source_mac: mac_address, ether_type: ether_type, vlan_pcp: bit3, vlan_cfi: bit1, vlan_vid: bit12, ether_type_vlan: uint16)
+      """

data/features/icmp/icmp.feature

@@ -0,0 +1,47 @@
+Feature: Icmp
+  Background:
+    Given I use the fixture "icmp"
+
+  Scenario: read an ICMP request
+    When I create a packet with:
+      """ruby
+      Pio::Icmp.read(eval(IO.read('icmp_request.rb')))
+      """
+    Then the packet has the following fields and values:
+      | field                  |                      value |
+      | class                  |         Pio::Icmp::Request |
+      | destination_mac        |          11:22:33:44:55:66 |
+      | source_mac             |          66:55:44:33:22:11 |
+      | ether_type.to_hex      |                      0x800 |
+      | ip_total_length        |                         54 |
+      | ip_protocol            |                          1 |
+      | source_ip_address      |               192.168.83.3 |
+      | destination_ip_address |             192.168.83.254 |
+      | icmp_type              |                          8 |
+      | icmp_code              |                          0 |
+      | icmp_checksum          |                      26613 |
+      | icmp_identifier        |                        256 |
+      | icmp_sequence_number   |                        111 |
+      | echo_data              | abcdefghijklmnopqrstuvwxyz |
+
+  Scenario: read an ICMP reply
+    When I create a packet with:
+      """ruby
+      Pio::Icmp.read(eval(IO.read('icmp_reply.rb')))
+      """
+    Then the packet has the following fields and values:
+      | field                  |                      value |
+      | class                  |           Pio::Icmp::Reply |
+      | destination_mac        |          11:22:33:44:55:66 |
+      | source_mac             |          66:55:44:33:22:11 |
+      | ether_type.to_hex      |                      0x800 |
+      | ip_total_length        |                         54 |
+      | ip_protocol            |                          1 |
+      | source_ip_address      |             192.168.83.254 |
+      | destination_ip_address |               192.168.83.3 |
+      | icmp_type              |                          0 |
+      | icmp_code              |                          0 |
+      | icmp_checksum          |                      28661 |
+      | icmp_identifier        |                        256 |
+      | icmp_sequence_number   |                        111 |
+      | echo_data              | abcdefghijklmnopqrstuvwxyz |

data/features/icmp/icmp_reply.feature

@@ -0,0 +1,93 @@
+Feature: Icmp::Reply
+  Scenario: create an ICMP reply
+    When I create a packet with:
+      """
+      Pio::Icmp::Reply.new(
+        destination_mac: '11:22:33:44:55:66',
+        source_mac: '66:55:44:33:22:11',
+        source_ip_address: '192.168.83.254',
+        destination_ip_address: '192.168.83.3',
+        icmp_identifier: 256,
+        icmp_sequence_number: 111,
+        echo_data: 'hello world'
+      )
+      """
+    Then the packet has the following fields and values:
+      | field                  |             value |
+      | destination_mac        | 11:22:33:44:55:66 |
+      | source_mac             | 66:55:44:33:22:11 |
+      | ether_type.to_hex      |             0x800 |
+      | ip_total_length        |                50 |
+      | ip_protocol            |                 1 |
+      | source_ip_address      |    192.168.83.254 |
+      | destination_ip_address |      192.168.83.3 |
+      | icmp_type              |                 0 |
+      | icmp_code              |                 0 |
+      | icmp_checksum          |             53442 |
+      | icmp_identifier        |               256 |
+      | icmp_sequence_number   |               111 |
+      | echo_data              |       hello world |
+
+  Scenario: convert an ICMP reply to Ruby code
+    When I eval the following Ruby code:
+      """ruby
+      Pio::Icmp::Reply.new(
+        destination_mac: '11:22:33:44:55:66',
+        source_mac: '66:55:44:33:22:11',
+        source_ip_address: '192.168.83.254',
+        destination_ip_address: '192.168.83.3',
+        icmp_identifier: 256,
+        icmp_sequence_number: 0
+      ).to_ruby
+      """
+    Then the result of eval should be:
+      """ruby
+      [
+        0x11, 0x22, 0x33, 0x44, 0x55, 0x66, # destination_mac
+        0x66, 0x55, 0x44, 0x33, 0x22, 0x11, # source_mac
+        0x08, 0x00, # ether_type
+        0b0100_0101, # ip_version, ip_header_length
+        0x00, # ip_type_of_service
+        0x00, 0x32, # ip_total_length
+        0x00, 0x00, # ip_identifier
+        0b000_0000000000000, # ip_flag, ip_fragment
+        0x80, # ip_ttl
+        0x01, # ip_protocol
+        0x12, 0x79, # ip_header_checksum
+        0xc0, 0xa8, 0x53, 0xfe, # source_ip_address
+        0xc0, 0xa8, 0x53, 0x03, # destination_ip_address
+        0x00, # icmp_type
+        0x00, # icmp_code
+        0xfe, 0xff, # icmp_checksum
+        0x01, 0x00, # icmp_identifier
+        0x00, 0x00, # icmp_sequence_number
+        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # padding
+      ].pack('C20nC42')
+      """
+
+  Scenario: Icmp::Reply instance inspection
+    When I create a packet with:
+      """
+      Pio::Icmp::Reply.new(
+        destination_mac: '00:26:82:eb:ea:d1',
+        source_mac: '00:16:9d:1d:9c:c4',
+        source_ip_address: '1.2.3.4',
+        destination_ip_address: '4.3.2.1',
+        icmp_identifier: 256,
+        icmp_sequence_number: 0
+      ).inspect
+      """
+    Then the result of eval should be:
+      """
+      #<Pio::Icmp::Reply destination_mac: "00:26:82:eb:ea:d1", source_mac: "00:16:9d:1d:9c:c4", ether_type: 0x0800, ip_version: 4, ip_header_length: 5, ip_type_of_service: 0, ip_total_length: 50, ip_identifier: 0, ip_flag: 0, ip_fragment: 0, ip_ttl: 128, ip_protocol: 1, ip_header_checksum: 12482, source_ip_address: "1.2.3.4", destination_ip_address: "4.3.2.1", ip_option: "", icmp_type: 0, icmp_code: 0, icmp_checksum: 65279, icmp_identifier: 256, icmp_sequence_number: 0, echo_data: "">
+      """
+
+  Scenario: Icmp::Reply class inspection
+    When I eval the following Ruby code:
+      """ruby
+      Pio::Icmp::Reply.inspect
+      """
+    Then the result of eval should be:
+      """
+      Pio::Icmp::Reply(destination_mac: mac_address, source_mac: mac_address, ether_type: ether_type, vlan_pcp: bit3, vlan_cfi: bit1, vlan_vid: bit12, ether_type_vlan: uint16, ip_version: bit4, ip_header_length: bit4, ip_type_of_service: uint8, ip_total_length: uint16, ip_identifier: uint16, ip_flag: bit3, ip_fragment: bit13, ip_ttl: uint8, ip_protocol: uint8, ip_header_checksum: uint16, source_ip_address: ip_address, destination_ip_address: ip_address, ip_option: string, icmp_type: uint8, icmp_code: uint8, icmp_checksum: uint16, icmp_identifier: uint16, icmp_sequence_number: uint16, echo_data: string)
+      """

data/features/icmp/icmp_request.feature

@@ -0,0 +1,89 @@
+Feature: Icmp::Request
+  Scenario: create an ICMP request
+    When I create a packet with:
+      """ruby
+      Pio::Icmp::Request.new(
+        source_mac: '11:22:33:44:55:66',
+        destination_mac: '66:55:44:33:22:11',
+        source_ip_address: '192.168.83.3',
+        destination_ip_address: '192.168.83.254',
+        icmp_identifier: 256,
+        icmp_sequence_number: 111,
+        echo_data: 'hello world'
+      )
+      """
+    Then the packet has the following fields and values:
+      | field                  |             value |
+      | source_mac             | 11:22:33:44:55:66 |
+      | destination_mac        | 66:55:44:33:22:11 |
+      | ether_type.to_hex      |             0x800 |
+      | ip_total_length        |                50 |
+      | ip_protocol            |                 1 |
+      | source_ip_address      |      192.168.83.3 |
+      | destination_ip_address |    192.168.83.254 |
+      | icmp_type              |                 8 |
+      | icmp_code              |                 0 |
+      | icmp_checksum          |             51394 |
+      | icmp_identifier        |               256 |
+      | icmp_sequence_number   |               111 |
+      | echo_data              |       hello world |
+
+  Scenario: convert an ICMP request to Ruby code
+    When I eval the following Ruby code:
+      """ruby
+      Pio::Icmp::Request.new(
+        destination_mac: '11:22:33:44:55:66',
+        source_mac: '66:55:44:33:22:11',
+        source_ip_address: '192.168.83.3',
+        destination_ip_address: '192.168.83.254'
+      ).to_ruby
+      """
+    Then the result of eval should be:
+      """ruby
+      [
+        0x11, 0x22, 0x33, 0x44, 0x55, 0x66, # destination_mac
+        0x66, 0x55, 0x44, 0x33, 0x22, 0x11, # source_mac
+        0x08, 0x00, # ether_type
+        0b0100_0101, # ip_version, ip_header_length
+        0x00, # ip_type_of_service
+        0x00, 0x32, # ip_total_length
+        0x00, 0x00, # ip_identifier
+        0b000_0000000000000, # ip_flag, ip_fragment
+        0x80, # ip_ttl
+        0x01, # ip_protocol
+        0x12, 0x79, # ip_header_checksum
+        0xc0, 0xa8, 0x53, 0x03, # source_ip_address
+        0xc0, 0xa8, 0x53, 0xfe, # destination_ip_address
+        0x08, # icmp_type
+        0x00, # icmp_code
+        0xf7, 0xff, # icmp_checksum
+        0x00, 0x00, # icmp_identifier
+        0x00, 0x00, # icmp_sequence_number
+        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # padding
+      ].pack('C20nC42')
+      """
+
+  Scenario: Icmp::Request instance inspection
+    When I create a packet with:
+      """ruby
+      Pio::Icmp::Request.new(
+        destination_mac: '00:26:82:eb:ea:d1',
+        source_mac: '00:16:9d:1d:9c:c4',
+        source_ip_address: '1.2.3.4',
+        destination_ip_address: '4.3.2.1'
+      ).inspect
+      """
+    Then the result of eval should be:
+      """
+      #<Pio::Icmp::Request destination_mac: "00:26:82:eb:ea:d1", source_mac: "00:16:9d:1d:9c:c4", ether_type: 0x0800, ip_version: 4, ip_header_length: 5, ip_type_of_service: 0, ip_total_length: 50, ip_identifier: 0, ip_flag: 0, ip_fragment: 0, ip_ttl: 128, ip_protocol: 1, ip_header_checksum: 12482, source_ip_address: "1.2.3.4", destination_ip_address: "4.3.2.1", ip_option: "", icmp_type: 8, icmp_code: 0, icmp_checksum: 63487, icmp_identifier: 0, icmp_sequence_number: 0, echo_data: "">
+      """
+
+  Scenario: Icmp::Request class inspection
+    When I eval the following Ruby code:
+      """ruby
+      Pio::Icmp::Request.inspect
+      """
+    Then the result of eval should be:
+      """
+      Pio::Icmp::Request(destination_mac: mac_address, source_mac: mac_address, ether_type: ether_type, vlan_pcp: bit3, vlan_cfi: bit1, vlan_vid: bit12, ether_type_vlan: uint16, ip_version: bit4, ip_header_length: bit4, ip_type_of_service: uint8, ip_total_length: uint16, ip_identifier: uint16, ip_flag: bit3, ip_fragment: bit13, ip_ttl: uint8, ip_protocol: uint8, ip_header_checksum: uint16, source_ip_address: ip_address, destination_ip_address: ip_address, ip_option: string, icmp_type: uint8, icmp_code: uint8, icmp_checksum: uint16, icmp_identifier: uint16, icmp_sequence_number: uint16, echo_data: string)
+      """

data/features/ipv4_header.feature

@@ -0,0 +1,89 @@
+Feature: IPv4Header
+  Scenario: create an IPv4 header
+    When I create a packet with:
+      """ruby
+      IPv4Header.new(source_ip_address: '1.2.3.4',
+                     destination_ip_address: '4.3.2.1')
+      """
+    Then the packet has the following fields and values:
+      | field                  |           value |
+      | class                  | Pio::IPv4Header |
+      | ip_version             |               4 |
+      | ip_header_length       |               5 |
+      | ip_type_of_service     |               0 |
+      | ip_total_length        |              20 |
+      | ip_identifier          |               0 |
+      | ip_flag                |               0 |
+      | ip_fragment            |               0 |
+      | ip_ttl                 |             128 |
+      | ip_protocol            |               0 |
+      | ip_header_checksum     |           12513 |
+      | source_ip_address      |         1.2.3.4 |
+      | destination_ip_address |         4.3.2.1 |
+      | ip_option              |                 |
+
+  Scenario: read an IPv4 header
+    Given I use the fixture "ipv4_header"
+    When I create a packet with:
+      """ruby
+      Pio::IPv4Header.read(eval(IO.read('ipv4_header.rb')))
+      """
+    Then the packet has the following fields and values:
+      | field                  |           value |
+      | class                  | Pio::IPv4Header |
+      | ip_version             |               4 |
+      | ip_header_length       |               5 |
+      | ip_type_of_service     |               0 |
+      | ip_total_length        |              20 |
+      | ip_identifier          |               0 |
+      | ip_flag                |               0 |
+      | ip_fragment            |               0 |
+      | ip_ttl                 |             128 |
+      | ip_protocol            |               0 |
+      | ip_header_checksum     |           12513 |
+      | source_ip_address      |         1.2.3.4 |
+      | destination_ip_address |         4.3.2.1 |
+      | ip_option              |                 |
+
+  Scenario: convert IPv4 header to Ruby code
+    When I eval the following Ruby code:
+      """ruby
+      IPv4Header.new(source_ip_address: '1.2.3.4',
+                     destination_ip_address: '4.3.2.1').to_ruby
+      """
+    Then the result of eval should be:
+      """ruby
+      [
+        0b0100_0101, # ip_version, ip_header_length
+        0x00, # ip_type_of_service
+        0x00, 0x14, # ip_total_length
+        0x00, 0x00, # ip_identifier
+        0b000_0000000000000, # ip_flag, ip_fragment
+        0x80, # ip_ttl
+        0x00, # ip_protocol
+        0x30, 0xe1, # ip_header_checksum
+        0x01, 0x02, 0x03, 0x04, # source_ip_address
+        0x04, 0x03, 0x02, 0x01, # destination_ip_address
+      ].pack('C6nC12')
+      """
+
+  Scenario: IPv4Header instance inspection
+    When I eval the following Ruby code:
+      """ruby
+      IPv4Header.new(source_ip_address: '1.2.3.4',
+                     destination_ip_address: '4.3.2.1').inspect
+      """
+    Then the result of eval should be:
+      """
+      #<Pio::IPv4Header ip_version: 4, ip_header_length: 5, ip_type_of_service: 0, ip_total_length: 20, ip_identifier: 0, ip_flag: 0, ip_fragment: 0, ip_ttl: 128, ip_protocol: 0, ip_header_checksum: 12513, source_ip_address: "1.2.3.4", destination_ip_address: "4.3.2.1", ip_option: "">
+      """
+
+  Scenario: IPv4Header class inspection
+    When I eval the following Ruby code:
+      """ruby
+      Pio::IPv4Header.inspect
+      """
+    Then the result of eval should be:
+      """
+      IPv4Header(ip_version: bit4, ip_header_length: bit4, ip_type_of_service: uint8, ip_total_length: uint16, ip_identifier: uint16, ip_flag: bit3, ip_fragment: bit13, ip_ttl: uint8, ip_protocol: uint8, ip_header_checksum: uint16, source_ip_address: ip_address, destination_ip_address: ip_address, ip_option: string)
+      """