packet-protocols 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a27a85186048ae13c3b0c93579424cc9cae14e5b
+  data.tar.gz: b0e13d20586455d3346fd7aad8fe9105e3d4fc80
+SHA512:
+  metadata.gz: 47b6ba39ff586bb1c66a33f66901ec981cca9a8253e0ca0516813e92f904c541c537767f7baee9e5f3a1affa11019ea5c73ddbec3245dc8d8bb9603a9c9756fb
+  data.tar.gz: edb2f47836f18c0a8d7cd4d732566ca8365e6c61ed433f01932f1c480b1e554cedb4567fbb35f0fc037a52a83ae0343ee44b99f0866e3a9de90eb2dce036a972

data/lib/arp.rb

@@ -0,0 +1,28 @@
+require 'bindata-contrib'
+require_relative 'mac_address'
+require_relative 'ipv4_address'
+
+class Arp < BinData::Record
+  HARDWARES = { ethernet: 1 }
+  PROTOCOLS = { ipv4: 0x0800 }
+  OPERATIONS = { request: 1, reply: 2 }
+
+  endian :big
+  enum16 :hardware, list: HARDWARES, initial_value: -> { :ethernet }
+  enum16 :protocol, list: PROTOCOLS, initial_value: -> { :ipv4 }
+  uint8 :hardware_length, initial_value: 6
+  uint8 :protocol_length, initial_value: 4
+  enum16 :operation, list: OPERATIONS, initial_value: -> { :request }
+  mac_address :mac_source, onlyif: :ipv4_in_ethernet?
+  ipv4_address :ip_source, onlyif: :ipv4_in_ethernet?
+  mac_address :mac_destination, onlyif: :ipv4_in_ethernet?
+  ipv4_address :ip_destination, onlyif: :ipv4_in_ethernet?
+
+  virtual assert: (proc do
+    !ipv4_in_ethernet? || (hardware_length == 6 && protocol_length == 4)
+  end)
+
+  def ipv4_in_ethernet?
+    hardware == :ethernet && protocol == :ipv4
+  end
+end

data/lib/ethernet.rb

@@ -0,0 +1,40 @@
+require_relative 'ipv4'
+require_relative 'arp'
+
+class Ethernet < BinData::Record
+  PROTOCOLS = {
+    ipv4: 0x0800,
+    arp: 0x0806,
+    vlan: 0x8100
+  }
+
+  endian :big
+  mac_address 'mac_destination'
+  mac_address 'mac_source'
+  enum16 :protocol_internal, list: PROTOCOLS, initial_value: -> { :ipv4 }
+
+  struct :vlan, onlyif: :has_vlan? do
+    bit3 :pcp, initial_value: 0
+    bit1 :cfi, initial_value: 0
+    bit12 :id, initial_value: 0
+    enum16 :protocol, list: PROTOCOLS, initial_value: -> { :ipv4 }
+  end
+
+  choice :payload, selection: -> { protocol.to_s } do
+    ipv4 'ipv4'
+    arp 'arp'
+    rest :default
+  end
+
+  def has_vlan?
+    protocol_internal == :vlan
+  end
+
+  def protocol
+    has_vlan? ? vlan.protocol : protocol_internal
+  end
+
+  def length
+    14 + (has_vlan? ? 4 : 0) + payload.length
+  end
+end

data/lib/icmp.rb

@@ -0,0 +1,22 @@
+require 'bindata-contrib'
+
+class Icmp < BinData::Record
+  TYPES = { echo_reply: 0, echo_request: 8 }
+
+  endian :big
+  enum8 :type, list: TYPES, initial_value: -> { :echo_request }
+  uint8 :code, initial_value: 0
+  uint16 :checksum
+
+  uint16 :identifier, onlyif: :echo?
+  uint16 :sequence_number, onlyif: :echo?
+  rest :data, onlyif: :echo?
+
+  def echo?
+    type == :echo_request || type == :echo_reply
+  end
+
+  def length
+    4 + (echo? ? 4 + data.length : 0)
+  end
+end

data/lib/ipv4.rb

@@ -0,0 +1,65 @@
+require 'bindata-contrib'
+require_relative 'ipv4_address'
+require_relative 'icmp'
+require_relative 'tcp'
+require_relative 'udp'
+
+class Ipv4 < BinData::Record
+  PROTOCOLS = { icmp: 1, tcp: 6, udp: 17 }
+
+  endian :big
+  bit4 :version, asserted_value: 4
+  bit4 :header_length, initial_value: 5
+  uint8 :tos
+  uint16 :total_length, initial_value: -> { header_length_in_bytes + payload.length }
+  uint16 :identifier
+  bit1 :reserved
+  bool :df
+  bool :mf
+  bit13 :fragment_offset
+  uint8 :time_to_live, initial_value: 64
+  enum8 :protocol, list: PROTOCOLS, initial_value: -> { :tcp }
+  uint16 :checksum#, initial_value: :compute_checksum
+  ipv4_address :ip_source
+  ipv4_address :ip_destination
+  string :options, read_length: :options_length_in_bytes
+  choice :payload, selection: -> { protocol.to_s } do
+    icmp 'icmp'
+    tcp 'tcp'
+    udp 'udp'
+    rest :default
+  end
+
+  # virtual assert: :checksum_valid?
+
+  def header_length_in_bytes
+    header_length * 4
+  end
+
+  def options_length_in_bytes
+    header_length_in_bytes - options.rel_offset
+  end
+
+  def length
+    total_length
+  end
+
+  # def compute_checksum
+  #   self.checksum = 0
+  #   self.checksum = checksum_function
+  # end
+  #
+  # def checksum_valid?
+  #   checksum_function == 0
+  # end
+
+  # private
+  #
+  # def checksum_function
+  #   bin = to_binary_s
+  #   dbytes = bin.unpack('S>*')
+  #   acc = dbytes.inject(:+)
+  #   acc = ((acc >> 16) & 0xffff) + (acc & 0xffff)
+  #   ~acc & 0xffff
+  # end
+end

data/lib/ipv4_address.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+class Ipv4Address < BinData::Primitive
+  endian :big
+  array :octets, type: :uint8, initial_length: 4
+
+  def get
+    octets.map(&:to_s).join('.')
+  end
+
+  def set(value)
+    self.octets = value.split('.').map(&:to_i)
+  end
+end

data/lib/ipv6_address.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+class Ipv6Address < BinData::Primitive
+  endian :big
+  array :octets, type: :uint8, initial_length: 16
+
+  def get
+    octets.map { |o| o.to_s(16) }.join(':')
+  end
+
+  def set(value)
+    self.octets = value.split(':').map { |o| o.to_i(16) }
+  end
+end

data/lib/mac_address.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+class MacAddress < BinData::Primitive
+  endian :big
+  array :octets, type: :uint8, initial_length: 6
+
+  def get
+    octets.map { |octet| format('%02x', octet) }.join(':')
+  end
+
+  def set(value)
+    self.octets = value.split(':').map(&:hex)
+  end
+end

data/lib/packet-protocols.rb

@@ -0,0 +1 @@
+require_relative 'ethernet'

data/lib/tcp.rb

@@ -0,0 +1,61 @@
+require 'bindata'
+require 'bindata-contrib'
+
+class Tcp < BinData::Record
+  endian :big
+  uint16 :source_port
+  uint16 :destination_port
+  uint32 :sequence_number
+  uint32 :acknowledge_number
+  bit4 :data_offset, initial_value: -> { 5 + options.length / 4 }
+  bit3 :reserved
+  bool :ns
+  bool :cwr
+  bool :ece
+  bool :urg
+  bool :ack
+  bool :psh
+  bool :rst
+  bool :syn
+  bool :fin
+  uint16 :window_size
+  uint16 :checksum#, initial_value: :compute_checksum
+  uint16 :urgent_pointer
+  string :options, read_length: :options_length_in_bytes
+  rest :payload
+
+  # virtual assert: :checksum_valid?
+
+  def header_length_in_bytes
+    data_offset * 4
+  end
+
+  def options_length_in_bytes
+    header_length_in_bytes - options.rel_offset
+  end
+
+  def length
+    header_length_in_bytes + options_length_in_bytes + payload.length
+  end
+
+  # def compute_checksum
+  #   self.checksum = 0
+  #   self.checksum = checksum_function
+  # end
+  #
+  # def checksum_valid?
+  #   checksum_function == 0
+  # end
+  #
+  # private
+  #
+  # def checksum_function
+  #   bin = to_binary_s
+  #   dbytes = bin.unpack('S>*')
+  #   acc = dbytes.inject(:+)
+  #   acc = ((acc >> 16) & 0xffff) + (acc & 0xffff)
+  #   ~acc & 0xffff
+  # end
+
+  # TODO: need IP parent for checksum
+end

data/lib/udp.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+class Udp < BinData::Record
+  endian :big
+  uint16 :source_port
+  uint16 :destination_port
+  uint16 :len, initial_value: -> { 8 + payload.length }
+  uint16 :checksum
+  rest :payload
+
+  def length
+    len
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: packet-protocols
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jérémy Pagé
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-18 00:00:00.000000000 Z
+dependencies: []
+description: A Parser/Serializer for Packet protocols.
+email:
+- contact@jeremypage.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/arp.rb
+- lib/ethernet.rb
+- lib/icmp.rb
+- lib/ipv4.rb
+- lib/ipv4_address.rb
+- lib/ipv6_address.rb
+- lib/mac_address.rb
+- lib/packet-protocols.rb
+- lib/tcp.rb
+- lib/udp.rb
+homepage: https://github.com/jejepage/packet-protocols
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Packet Protocols
+test_files: []