packetgen 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 543fd7ef2efee43e0bf0d61c8a6520d178c869a2
-  data.tar.gz: bcdd42ce36fc83c202abe8c2fd6f820a13a1b588
+  metadata.gz: ed1c35530cd3ce2e62507e1a78c92fb5f764a49b
+  data.tar.gz: 77d4baf7bc094aa0b04d7e6035e9420233135008
 SHA512:
-  metadata.gz: 04c3d376f587f745972f534655f83e5fa12c30e039a58854411f89c57d769c235f9fa8faf1f6bfb37bf2deba639f45ea96a1eea8706dda77ea3c01a753aac502
-  data.tar.gz: ed8d4002df84be1f0e1ddbcf19dd29bbf8290ed05606648421af3e7914b6288f9aacd8ec252bec6edd1357e5c42923f84400088c0fd2bc744c06e88c179d16b0
+  metadata.gz: dbe78e47c236179d9d866ce997778c1b2b65633b751d47d72948bcb0f7f56ccb8bf52fbdd1dd1292844d064493502a11392a7c4c9582552b452522d235bf22b7
+  data.tar.gz: 8c972a697a5bbd5c4654c973b1da378c8e733fb8c1887310b281acd0e36ef5de2e83259da0dfdca75a6da54f3c5af510d7cdc943af338aea839f661663ada014

data/.travis.yml

@@ -8,10 +8,10 @@ rvm:
 install:
   - sudo apt-get update -qq
   - sudo apt-get install libpcap-dev -qq
-  - bundler install --path vendor/bundle --jobs=3 --retry=3
+  - bundle install --path vendor/bundle --jobs=3 --retry=3
 before_script:
   - openssl version
   - ruby -ropenssl -e 'puts OpenSSL::VERSION'
 script:
-  - bundler exec rake
+  - bundle exec rake
   - rvmsudo bundle exec rake spec:sudo

data/lib/packetgen/header.rb

@@ -102,3 +102,4 @@ require_relative 'header/snmp'
 require_relative 'header/bootp'
 require_relative 'header/dhcp'
 require_relative 'header/http'
+require_relative 'header/tftp'

data/lib/packetgen/header/eap/md5.rb

@@ -13,6 +13,8 @@ module PacketGen
       # @since 2.1.4
       class MD5 < EAP
         delete_field :body
+        undef body
+
         # @!attribute value_size
         #  @return [Integer] 8-bit value size
         define_field :value_size, Types::Int8

data/lib/packetgen/header/http/headers.rb

@@ -16,7 +16,7 @@ module PacketGen
         end
 
         # Populate object from a string or directly from a hash.
-        # @param [String, Hash]
+        # @param [String, Hash] s_or_h
         # @return [self]
         def read(s_or_h)
           case s_or_h
@@ -51,7 +51,7 @@ module PacketGen
         end
 
         # Read human-readable data to populate header data.
-        # @param [String, Hash]
+        # @param [String, Hash] data
         # @return [self]
         def from_human(data)
           read(data)

data/lib/packetgen/header/ike/sa.rb

@@ -534,6 +534,8 @@ module PacketGen
         PAYLOAD_TYPE = 33
 
         delete_field :content
+        undef content
+
         # @!attribute proposals
         #  Set of SA proposals
         #  @return [SAProposals]

data/lib/packetgen/header/ike/ts.rb

@@ -221,6 +221,8 @@ module PacketGen
         PAYLOAD_TYPE = 44
 
         delete_field :content
+        undef content
+
         # @!attribute num_ts
         #   8-bit Number of TSs
         #   @return [Integer]

data/lib/packetgen/header/snmp.rb

@@ -11,6 +11,8 @@ module PacketGen
     class DissectError < ParseError; end
 
     # Simple Network Management Protocol (SNMP)
+    #
+    # See https://github.com/sdaubert/packetgen/wiki/SNMP
     # @author Sylvain Daubert
     # @since 2.0.0
     class SNMP < ASN1Base
@@ -110,14 +112,9 @@ module PacketGen
         sequence :pdu,
                  implicit: SNMP::PDU_GET, constructed: true,
                  content: [integer(:id, value: 0),
-                           enumerated(:error, enum: ERRORS),
-                           integer(:error_index),
+                           enumerated(:error, value: 0, enum: ERRORS),
+                           integer(:error_index, value: 0),
                            model(:varbindlist, VariableBindings)]
-
-        # @return [String]
-        def inspect
-          Inspect.inspect_body(to_der, self.class)
-        end
       end
 
       # Class to handle GetNextRequest PDU
@@ -195,11 +192,6 @@ module PacketGen
                            integer(:non_repeaters),
                            integer(:max_repetitions),
                            model(:varbindlist, VariableBindings)]
-
-        # @return [String]
-        def inspect
-          Inspect.inspect_body(to_der, self.class)
-        end
       end
 
       # Class to handle InformRequest PDU
@@ -263,6 +255,16 @@ module PacketGen
         @elements[:data]
       end
 
+      # shortcut to PDU
+      # @return [GetRequest, Bulk, Trapv1, nil] return `nil` if no CHOICE was done
+      def pdu
+        if data.chosen.nil?
+          nil
+        else
+          data.root.chosen_value
+        end
+      end
+
       def inspect
         str = super
         str << Inspect.shift_level(2)
@@ -271,7 +273,14 @@ module PacketGen
         else
           data = self[:data]
           str << Inspect::FMT_ATTR % [data.type, :data, data.chosen_value.type]
-          str << data.chosen_value.inspect
+          str << Inspect.dashed_line('ASN.1 content', 2)
+          str << data.chosen_value.inspect(1)
+          begin
+            str << Inspect.inspect_body(self[:message].to_der, 'ASN.1 DER')
+          rescue StandardError => ex
+            raise unless ex.message =~ /TAG.*not handled/
+          end
+          str
         end
       end
     end

data/lib/packetgen/header/tftp.rb

@@ -0,0 +1,195 @@
+# 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
+
+    # A TFTP (Trivial File Transfer Protocol,
+    # {https://tools.ietf.org/html/rfc1350 RFC 1350}) header consists of:
+    # * a {#opcode} ({Types::Int16Enum}),
+    # * and a body. Its content depends on opcode.
+    #
+    # Specialized subclasses exists to handle {TFTP::RRQ Read Request},
+    # {TFTP::WRQ Write Request}, {TFTP::DATA DATA}, {TFTP::ACK ACK} and
+    # {TFTP::ERROR ERROR} packets.
+    #
+    # == Create a TFTP header
+    #  # standalone
+    #  tftp = PacketGen::Header::TFTP.new
+    #  # in a packet
+    #  pkt = PacketGen.gen('IP').add('UDP').add('TFTP')
+    #  # access to TFTP header
+    #  pkt.tftp   # => PacketGen::Header::TFTP
+    #
+    # == TFTP attributes
+    #  tftp.opcode = 'RRQ'
+    #  tftp.opcode = 1
+    #  tftp.body.read 'this is a body'
+    #
+    # == TFTP parsing
+    # When parsing, only first packet (read or write request) should be decoded
+    # as TFTP packet, as others uses custom UDP ports.
+    #
+    # So, to decode subsequent TFTP packets, a method {#decode!} is provided
+    # for this purpose. This method takes a single array argument. This array
+    # should contain all subsequent TFTP packets (others packet types may also
+    # be included in this array: they won't be modified). +#decode!+ will modify
+    # array in-place by replacing UDP packets by TFTP ones (if decoded as TFTP
+    # packets):
+    #   # packets is an array of packets: TFTP::RRQ, UDP (should be TFTP::DATA), UDP (not a TFTP packet) and UDP (TFTP::ACK)
+    #   packets.map { |pkt| pkt.headers.last.class.to_s }.join(',')  # => TFTP::RRQ,UDP,UDP,UDP
+    #   # Here, decoding TFTP packets
+    #   packets[0].tftp.decode!(packets[1..-1])
+    #   packets.map { |pkt| pkt.headers.last.class.to_s }.join(',')  # => TFTP::RRQ,TFTP::DATA,UDP,TFTP::ACK
+    # @author Sylvain Daubert
+    class TFTP < Base
+
+      # Known opcodes
+      OPCODES = {
+        'RRQ'   => 1,
+        'WRQ'   => 2,
+        'DATA'  => 3,
+        'ACK'   => 4,
+        'Error' => 5
+      }
+
+      # @!attribute opcode
+      #   16-bit operation code
+      #   @return [Integer]
+      define_field :opcode, Types::Int16Enum, enum: OPCODES
+      
+      # @!attribute body
+      #   @return [String]
+      define_field :body, Types::String
+      
+      def initialize(options={})
+        type = protocol_name.sub(/^.*::/, '')
+        opcode = OPCODES[type]
+        if self.class != TFTP and !opcode.nil?
+          super({opcode: opcode}.merge(options))
+        else
+          super
+        end
+      end
+
+      # @private
+      alias old_read read
+
+      # Populate object from binary string
+      # @param [String] str
+      # @return [TFTP]
+      def read(str)
+        if self.instance_of? TFTP
+          super
+          if OPCODES.values.include? opcode
+            TFTP.const_get(human_opcode).new.read str
+          else
+            self
+          end
+        else
+          old_read str
+        end
+      end
+      
+      # Decode subsequent TFTP packets to this one. Packets are modified
+      # in place in +ary+.
+      # @param [Array<Packet>] ary
+      # @return [void]
+      def decode!(ary)
+        client_tid = packet.udp.sport
+        server_tid = nil
+        ary.each do |pkt|
+          if server_tid.nil?
+            next unless pkt.is?('UDP') and pkt.udp.dport == client_tid
+            server_tid = pkt.udp.sport
+          else
+            next unless pkt.is?('UDP')
+            tids = [server_tid, client_tid]
+            ports = [pkt.udp.sport, pkt.udp.dport]
+            next unless (tids - ports).empty?
+          end
+          tftp = Packet.parse(pkt.body, first_header: 'TFTP')
+          udp_dport = pkt.udp.dport
+          pkt.encapsulate tftp
+          # need to fix it as #encapsulate force it to 69
+          pkt.udp.dport = udp_dport
+        end
+      end
+
+       # Get human readable opcode
+      # @return [String]
+      def human_opcode
+        self[:opcode].to_human
+      end
+
+      # Callback called when a TFTP header is added to a packet
+      # Here, add +#tftp+ method as a shortcut to existing
+      # +#tftp(rrq|wrq|data|ack|error)+.
+      # @param [Packet] packet
+      # @return [void]
+      def added_to_packet(packet)
+        unless packet.respond_to? :tftp
+          packet.instance_eval("def tftp(arg=nil); header(#{self.class}, arg); end")
+        end
+      end
+
+      # TFTP Read Request header
+      class RRQ < TFTP
+        delete_field :body
+        undef body
+        
+        # @!attribute filename
+        #   Filename to access
+        #   @return [String]
+        define_field :filename, Types::CString
+
+        # @!attribute mode
+        #   Mode used. Should be +netascii+, +octet+ or +mail+
+        #   @return [String]
+        define_field :mode, Types::CString
+      end
+
+      # TFTP Write Request header
+      class WRQ < RRQ; end
+
+      # TFTP DATA header
+      class DATA < TFTP
+        # @!attribute block_num
+        #   16-bit block number
+        #   @return [Integer]
+        define_field_before :body, :block_num, Types::Int16
+      end
+
+      # TFTP ACK header
+      class ACK < TFTP
+        delete_field :body
+        undef body
+        
+        # @!attribute block_num
+        #   16-bit block number
+        #   @return [Integer]
+        define_field :block_num, Types::Int16
+      end
+
+      # TFTP ERROR header
+      class ERROR < TFTP
+        delete_field :body
+        undef body
+
+        # @!attribute error_code
+        #   16-bit error code
+        #   @return [Integer]
+        define_field :error_code, Types::Int16
+
+        # @!attribute error_msg
+        #   Error message
+        #   @return [String]
+        define_field :error_msg, Types::CString
+        alias error_message error_msg
+      end
+    end
+    UDP.bind_header TFTP, dport: 69
+  end
+end

data/lib/packetgen/packet.rb

@@ -235,8 +235,8 @@ module PacketGen
     # Encapulate another packet in +self+
     # @param [Packet] other
     # @param [Boolean] parsing set to +true+ to not update last current header field
-    #    from binding with first other's one. Use only when current heade field as
-    #    its value set accordingly.
+    #    from binding with first other's one. Use only when current header field
+    #    has its value set accordingly.
     # @return [self] +self+ with new headers from +other+
     # @since 1.1.0
     def encapsulate(other, parsing: false)

data/lib/packetgen/types/cstring.rb

@@ -11,7 +11,6 @@ module PacketGen
     # @author Sylvain Daubert
     class CString < ::String
 
-      # @param [String] str
       # @param [Hash] options
       # @option options [Integer] :static_length set a static length for this string
       def initialize(options={})

data/lib/packetgen/types/string.rb

@@ -12,7 +12,6 @@ module PacketGen
     # @author Sylvain Daubert
     class String < ::String
 
-      # @param [String] str
       # @param [Hash] options
       # @option options [Types::Int,Proc] :length_from object or proc from which
       #   takes length when reading

data/lib/packetgen/version.rb

@@ -8,5 +8,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/packetgen.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'pcaprub', '~>0.12.4'
   spec.add_dependency 'network_interface'
-  spec.add_dependency 'rasn1', '~>0.3', '>= 0.3.1'
+  spec.add_dependency 'rasn1', '~>0.5', '>= 0.6.0'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub
@@ -44,20 +44,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +205,7 @@ files:
 - lib/packetgen/header/tcp.rb
 - lib/packetgen/header/tcp/option.rb
 - lib/packetgen/header/tcp/options.rb
+- lib/packetgen/header/tftp.rb
 - lib/packetgen/header/udp.rb
 - lib/packetgen/inspect.rb
 - lib/packetgen/packet.rb