packetgen 0.3.0 → 1.0.0

data/lib/packetgen/header/udp.rb

@@ -1,9 +1,35 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module Header
 
-    # UDP header class
+    # A UDP header consists of:
+    # * a source port field ({#sport}, {Int16} type),
+    # * a destination port field ({#dport}, +Int16+ type),
+    # * a UDP length field ({#length}, +Int16+ type),
+    # * a {#checksum} field (+Int16+ type),
+    # * and a {#body}.
+    #
+    # == Create a UDP header
+    #  # standalone
+    #  udp = PacketGen::Header::UDP.new
+    #  # in a packet
+    #  pkt = PAcketGen.gen('IP').eadd('UDP')
+    #  # access to IP header
+    #  pkt.udp    # => PacketGen::Header::UDP
+    #
+    # == UDP attributes
+    #  udp.sport = 65432
+    #  udp.dport = 53
+    #  udp.length = 43
+    #  udp.checksum = 0xffff
+    #  udp.body.read 'this is a UDP body'
+    #
     # @author Sylvain Daubert
-    class UDP < Struct.new(:sport, :dport, :length, :sum, :body)
+    class UDP < Struct.new(:sport, :dport, :length, :checksum, :body)
       include StructFu
       include HeaderMethods
       extend HeaderClassMethods
@@ -15,12 +41,12 @@ module PacketGen
       # @option options [Integer] :sport source port
       # @option options [Integer] :dport destination port
       # @option options [Integer] :length UDP length. Default: calculated
-      # @option options [Integer] :sum. UDP checksum. Default: 0
+      # @option options [Integer] :checksum. UDP checksum. Default: 0
       def initialize(options={})
         super Int16.new(options[:sport]),
               Int16.new(options[:dport]),
               Int16.new(options[:length]),
-              Int16.new(options[:sum]),
+              Int16.new(options[:checksum]),
               StructFu::String.new.read(options[:body])
         unless options[:length]
           calc_length
@@ -32,20 +58,20 @@ module PacketGen
       # @return [self]
       def read(str)
         return self if str.nil?
-        raise ParseError, 'string too short for Eth' if str.size < self.sz
+        raise ParseError, 'string too short for UDP' if str.size < self.sz
         force_binary str
         self[:sport].read str[0, 2]
         self[:dport].read str[2, 2]
         self[:length].read str[4, 2]
-        self[:sum].read str[6, 2]
+        self[:checksum].read str[6, 2]
         self[:body].read str[8..-1]
       end
 
-      # Compute checksum and set +sum+ field
+      # Compute checksum and set +checksum+ field
       # @return [Integer]
-      def calc_sum
+      def calc_checksum
         ip = ip_header(self)
-        sum = ip.pseudo_header_sum
+        sum = ip.pseudo_header_checksum
         sum += IP_PROTOCOL
         sum += length
         sum += sport
@@ -59,7 +85,7 @@ module PacketGen
           sum = (sum & 0xffff) + (sum >> 16)
         end
         sum = ~sum & 0xffff
-        self[:sum].value = (sum == 0) ? 0xffff : sum
+        self[:checksum].value = (sum == 0) ? 0xffff : sum
       end
 
       # Compute length and set +length+ field
@@ -105,27 +131,27 @@ module PacketGen
       end
 
       # Setter for length attribuute
-      # @param [Integer] port
+      # @param [Integer] len
       # @return [Integer]
       def length=(len)
         self[:length].read len
       end
 
-      # Getter for sum attribuute
+      # Getter for checksum attribuute
       # @return [Integer]
-      def sum
-        self[:sum].to_i
+      def checksum
+        self[:checksum].to_i
       end
 
-      # Setter for sum attribuute
-      # @param [Integer] sum
+      # Setter for checksum attribuute
+      # @param [Integer] checksum
       # @return [Integer]
-      def sum=(sum)
-        self[:sum].read sum
+      def checksum=(checksum)
+        self[:checksum].read checksum
       end
     end
 
-    IP.bind_header UDP, proto: UDP::IP_PROTOCOL
+    IP.bind_header UDP, protocol: UDP::IP_PROTOCOL
     IPv6.bind_header UDP, next: UDP::IP_PROTOCOL
   end
 end

data/lib/packetgen/header.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   # Namespace for protocol header classes
   # @author Sylvain Daubert
@@ -21,3 +26,4 @@ require_relative 'header/arp'
 require_relative 'header/ipv6'
 require_relative 'header/icmpv6'
 require_relative 'header/udp'
+require_relative 'header/tcp'

data/lib/packetgen/inspect.rb

@@ -0,0 +1,76 @@
+module PacketGen
+
+  # {Inspect} module provides methods to help writing +inspect+
+  # @api private
+  # @author Sylvain Daubert
+  module Inspect
+
+    # Maximum number of characters on a line for INSPECT
+    INSPECT_MAX_WIDTH = 70
+
+    # Format to inspect attribute
+    INSPECT_FMT_ATTR = "%7s %12s: %s\n"
+
+    # Create a dashed line with +obj+ class writing in it
+    # @param [String] name
+    # @param [Integer] level
+    # @return [String]
+    def self.dashed_line(name, level=1)
+      str = '--' * level << " #{name} "
+      str << '-' * (INSPECT_MAX_WIDTH - str.length) << "\n"
+    end
+
+    # @return [String]
+    def self.shift_level(level=1)
+      '  ' + '  ' * level
+    end
+
+    # @param [#to_i] value
+    # @param [Integer] hex_size
+    # @return [String]
+    def self.int_dec_hex(value, hexsize)
+      "%-10s (0x%0#{hexsize}x)" % [value.to_i, value.to_i]
+    end
+
+    # Format an attribute for +#inspect+.
+    # 3 cases are handled:
+    # * attribute value is a {StructFu::Int}: show value as integer and in
+    #   hexdecimal format,
+    # * attribute value responds to +#to_human+: call it,
+    # * else, +#to_s+ is used to format attribute value.
+    # @param [Symbol] attr attribute name
+    # @param [Object] value attribute value
+    # @param [Integer] level
+    # @return [String]
+    def self.inspect_attribute(attr, value, level=1)
+      str = shift_level(level)
+      val = if value.is_a? StructFu::Int
+              int_dec_hex(value, value.to_s.size * 2)
+            elsif value.respond_to? :to_human
+              value.to_human
+            else
+              value.to_s
+            end
+      str << INSPECT_FMT_ATTR % [value.class.to_s.sub(/.*::/, ''), attr, val]
+    end
+
+    # @param [#to_s] body
+    # @return [String]
+    def self.inspect_body(body)
+      str = dashed_line('Body', 2)
+      str << (0..15).to_a.map { |v| " %02d" % v}.join << "\n"
+      str << '-' * INSPECT_MAX_WIDTH << "\n"
+      if body.size > 0
+        (body.size / 16 + 1).times do |i|
+          octets = body.to_s[i*16, 16].unpack('C*')
+          o_str = octets.map { |v| " %02x" % v}.join
+          str << o_str
+          str << ' ' * (3*16 - o_str.size) unless o_str.size >= 3*16
+          str << '  ' << octets.map { |v| v < 128 && v > 13 ? v.chr : '.' }.join
+          str << "\n"
+        end
+      end
+      str << '-' * INSPECT_MAX_WIDTH << "\n"
+    end
+  end
+end

data/lib/packetgen/packet.rb

@@ -1,3 +1,7 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
 require 'pcaprub'
 
 module PacketGen
@@ -42,9 +46,6 @@ module PacketGen
     # @return [Array<Header::Base]
     attr_reader :headers
 
-    # @private maximum number of characters on a line for INSPECT
-    INSPECT_MAX_WIDTH = 70
-
     # Create a new Packet
     # @param [String] protocol base protocol for packet
     # @param [Hash] options specific options for +protocol+
@@ -194,9 +195,9 @@ module PacketGen
 
     # Recalculate all packet checksums
     # @return [void]
-    def calc_sum
+    def calc_checksum
       @headers.reverse.each do |header|
-        header.calc_sum if header.respond_to? :calc_sum
+        header.calc_checksum if header.respond_to? :calc_checksum
       end
     end
 
@@ -208,11 +209,11 @@ module PacketGen
       end
     end
 
-    # Recalculate all calculatable fields (for now: length and sum)
+    # Recalculate all calculatable fields (for now: length and checksum)
     # @return [void]
     def calc
       calc_length
-      calc_sum
+      calc_checksum
     end
 
     # Get packet body
@@ -222,7 +223,7 @@ module PacketGen
     end
 
     # Set packet body
-    # @param [String]
+    # @param [String] str
     # @return [void]
     def body=(str)
       @headers.last.body = str
@@ -258,15 +259,11 @@ module PacketGen
 
     # @return [String]
     def inspect
-      str = dashed_line(self.class)
+      str = Inspect.dashed_line(self.class)
       @headers.each do |header|
-        str << dashed_line(header.class, 2)
-        header.to_h.each do |attr, value|
-          next if attr == :body
-          str << inspect_line(attr, value, 2)
-        end
+        str << header.inspect
       end
-      str << inspect_body
+      str << Inspect.inspect_body(body)
     end
 
     # @param [Packet] other
@@ -315,42 +312,6 @@ module PacketGen
       raise ArgumentError, "unknown #{protocol} protocol" unless klass.is_a? Class
       klass
     end
-
-    def dashed_line(name, level=1)
-      str = '--' * level << " #{name} "
-      str << '-' * (INSPECT_MAX_WIDTH - str.length) << "\n"
-    end
-
-    def inspect_line(attr, value, level=1)
-      str = '  ' + '  ' * level
-      val = if value.is_a? StructFu::Int
-              sz = value.to_s.size
-              "%-10s (0x%0#{2*sz}x)" % [value.to_i, value.to_i]
-            elsif value.respond_to? :to_x
-              value.to_x
-            else
-              value.to_s
-            end
-      str << "%7s %10s: %s" % [value.class.to_s.sub(/.*::/, ''), attr, val]
-      str << "\n"
-    end
-
-    def inspect_body
-      str = dashed_line('Body', 2)
-      str << (0..15).to_a.map { |v| " %02d" % v}.join << "\n"
-      str << '-' * INSPECT_MAX_WIDTH << "\n"
-      if body.size > 0
-        (body.size / 16 + 1).times do |i|
-          octets = body.to_s[i*16, 16].unpack('C*')
-          o_str = octets.map { |v| " %02x" % v}.join
-          str << o_str
-          str << ' ' * (3*16 - o_str.size) unless o_str.size >= 3*16
-          str << '  ' << octets.map { |v| v < 128 && v > 13 ? v.chr : '.' }.join
-          str << "\n"
-        end
-      end
-      str << '-' * INSPECT_MAX_WIDTH << "\n"
-    end
   end
 end
 

data/lib/packetgen/pcapng/block.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/epb.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/file.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/idb.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/shb.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/spb.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng/unknown_block.rb

@@ -1,3 +1,8 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 module PacketGen
   module PcapNG
 

data/lib/packetgen/pcapng.rb

@@ -1,3 +1,7 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
 require 'stringio'
 
 module PacketGen

data/lib/packetgen/structfu.rb

@@ -1,10 +1,10 @@
-# -*- coding: binary -*-
+# -*- coding: utf-8 -*-
 module PacketGen
+  # Copied from PacketFu:
+  #
   # StructFu, a nifty way to leverage Ruby's built in Struct class
   # to create meaningful binary data.
   #
-  # Copied from PacketFu:
-  #
   # Copyright (c) 2008-2014, Tod Beardsley
   # All rights reserved.
   #
@@ -30,6 +30,7 @@ module PacketGen
   # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  # @author Tod Beardsley
   module StructFu
   
     # Normally, self.size and self.length will refer to the Struct
@@ -82,6 +83,7 @@ module PacketGen
 
     # Get binary string
     # @return [String]
+    # @author Sylvain Daubert
     def to_s
       to_a.map { |field| field.to_s }.join
     end

data/lib/packetgen/version.rb

@@ -1,7 +1,12 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
 # PacketGen is a network packet generator and analyzor.
 #
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/packetgen.rb

@@ -1,5 +1,10 @@
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
 require 'packetgen/version'
 
+# PacketGen is a network packet generator and analyzor.
 # @author Sylvain Daubert
 module PacketGen
 
@@ -28,7 +33,7 @@ module PacketGen
   # @param [String] first_header First protocol header
   # @return [Packet]
   def self.parse(binary_str, first_header: nil)
-    Packet.parse binary_str, first_header
+    Packet.parse binary_str, first_header: first_header
   end
 
   # Shortcut for {Packet.capture}
@@ -78,6 +83,7 @@ module PacketGen
 end
 
 require 'packetgen/structfu'
+require 'packetgen/inspect'
 require 'packetgen/packet'
 require 'packetgen/capture'
 require 'packetgen/pcapng'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -118,7 +118,11 @@ files:
 - lib/packetgen/header/icmpv6.rb
 - lib/packetgen/header/ip.rb
 - lib/packetgen/header/ipv6.rb
+- lib/packetgen/header/tcp.rb
+- lib/packetgen/header/tcp/option.rb
+- lib/packetgen/header/tcp/options.rb
 - lib/packetgen/header/udp.rb
+- lib/packetgen/inspect.rb
 - lib/packetgen/packet.rb
 - lib/packetgen/pcapng.rb
 - lib/packetgen/pcapng/block.rb
@@ -150,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Network packet generator and analyzor