packetgen 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d08bf3611fcb1af6c5e794d4582fe373b4887c02
-  data.tar.gz: 7149de75ef5a5ebaca9d9b90239ffce8619c38c4
+SHA256:
+  metadata.gz: 1fde6bab111f7f367b7811089be8b96a9845dad53b7205d25db0931303654189
+  data.tar.gz: 06c46f06148846640ccfd123a21198c003ef2763c9ff78797fe27d9df4d25555
 SHA512:
-  metadata.gz: 82804e0c46bc17d30c6bc151a24b3fc415c476aa1159239330611d2b8ef3ef7d2013dc7078bb40e298d29c0e81f3e758f53e82ff280acc0548b37dc78ff7d8be
-  data.tar.gz: 6f4c84f64e8728af30a61d56b22dce9eb34fa574984eafe427d48cebdac1446344f1f5dd37370604d58b9df4bb1af587135348ad682e15d3ce97d45cfd769ed1
+  metadata.gz: 8b0283250922dcaa606652e96f6f159d4fa2a4ce895b5539234e01da155bb5e50aa6286aba7cbc33246650e6739ec98de65676423c5f4c36aa1050024966f6bf
+  data.tar.gz: 179e87a341e6ae7a95e0a9a408fbde3b82601e21c37d49bd64d6dee3bb4debf82f77898e6e9e93b3763b3695feec19eb87396b0c6adb956bcbac13a293df2aa3

data/.travis.yml

@@ -1,11 +1,20 @@
 language: ruby
 sudo: required
 rvm:
-  - 2.2.7
-  - 2.3.5
-  - 2.4.2
-  - 2.5.0
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
 
+matrix:
+  # allow 2.5 to fail until Travis CI is fixed.
+  # See travis-ci/travis-ci#8969
+  allow_failures:
+  - rvm: 2.5
+
+before_install:
+  # work around https://github.com/travis-ci/travis-ci/issues/8969
+  - travis_retry gem update --system
 install:
   - sudo apt-get update -qq
   - sudo apt-get install libpcap-dev -qq

data/lib/packetgen.rb

@@ -3,6 +3,8 @@
 # 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.
+
+# frozen_string_literal: true
 require 'packetgen/version'
 
 # PacketGen is a network packet generator and analyzor.
@@ -64,7 +66,7 @@ module PacketGen
   # @param [String] str
   # @return [String] binary encoded string
   def self.force_binary(str)
-    str.force_encoding Encoding::BINARY
+    str.dup.force_encoding(Encoding::BINARY)
   end
 
   # Get default network interface (ie. first non-loopback declared interface)

data/lib/packetgen/capture.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
 
   # Capture packets from wire

data/lib/packetgen/config.rb

@@ -3,6 +3,7 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
 require 'socket'
 require 'singleton'
 require 'network_interface'

data/lib/packetgen/header.rb

@@ -4,6 +4,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   # Namespace for protocol header classes
   # == Add a foreign header class
@@ -101,9 +103,12 @@ require_relative 'header/asn1_base'
 require_relative 'header/snmp'
 require_relative 'header/bootp'
 require_relative 'header/dhcp'
+require_relative 'header/dhcpv6'
 require_relative 'header/http'
 require_relative 'header/tftp'
 require_relative 'header/igmp'
 require_relative 'header/igmpv3'
 require_relative 'header/mld'
 require_relative 'header/mldv2'
+require_relative 'header/ospfv2'
+require_relative 'header/ospfv3'

data/lib/packetgen/header/arp.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 

data/lib/packetgen/header/asn1_base.rb

@@ -2,6 +2,8 @@
 # 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.
+
+# frozen_string_literal: true
 require 'rasn1'
 
 module PacketGen

data/lib/packetgen/header/base.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 
@@ -185,6 +187,20 @@ module PacketGen
         self.new.protocol_name
       end
 
+      # Helper method to calculate length of +hdr+ and set its +length+ field.
+      # To be used by +#calc_length+ in Base subclasses.
+      # @param [Base] hdr
+      # @param [Boolean] header_in_size if +true+ header is included in length,
+      #   if +false+, only +body+ is taken into account
+      def self.calculate_and_set_length(hdr, header_in_size: true)
+        length = if header_in_size
+                   hdr.sz
+                 else
+                   hdr.body.sz
+                 end
+        hdr.length = length
+      end
+
       # @api private
       # Get knwon headers
       # @return [Hash] keys: header classes, values: hashes

data/lib/packetgen/header/bootp.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     

data/lib/packetgen/header/crypto.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PacketGen
   module Header
 

data/lib/packetgen/header/dhcp.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     

data/lib/packetgen/header/dhcp/option.rb

@@ -3,6 +3,9 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
+
 module PacketGen
   module Header
     class DHCP

data/lib/packetgen/header/dhcp/options.rb

@@ -3,6 +3,8 @@
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
+# frozen_string_literal: true
+
 module PacketGen
   module Header
     class DHCP

data/lib/packetgen/header/dhcpv6.rb

@@ -0,0 +1,109 @@
+# 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.
+
+# frozen_string_literal: true
+
+module PacketGen
+  module Header
+    
+    # Dynamic Host Configuration Protocol for IPv6, {https://tools.ietf.org/html/rfc3315 
+    # RFC 3315}
+    #
+    #    0                   1                   2                   3
+    #    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |    msg-type   |               transaction-id                  |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   .                            options                            .
+    #   .                           (variable)                          .
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # A DHCPv6 header is made of:
+    # * a {#msg_type} field ({Types::Int8Enum}),
+    # * a {#transaction_id} field ({Types::Int24}),
+    # * and an {#options} field ({DHCPv6::Options}).
+    #
+    # == Create a DHCPv6 header
+    #   # standalone
+    #  dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
+    #  # in a packet
+    #  pkt = PacketGen.gen('IPv6').add('DHCPv6', msg_type: 'SOLLICIT')
+    #  # access to DHCPv6 header from packet
+    #  pkt.dhcpv6    #=> PacketGen::Header::DHCPv6
+    #
+    # == Add options
+    # DHCPv6 options are defined by subclasses of {DHCPv6::Option}.
+    #
+    # Options may be added by pushing a hash to {#options}:
+    #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
+    #   dhcpv6.options << { type: 'Preference', value: 1 }
+    # @author Sylvain Daubert
+    class DHCPv6 < Base;end
+
+    require_relative 'dhcpv6/duid'
+    require_relative 'dhcpv6/option'
+    require_relative 'dhcpv6/options'
+
+    class DHCPv6 
+      # DHCPv6 UDP client port
+      UDP_CLIENT_PORT = 546
+      # DHCPv6 UDP client port
+      UDP_SERVER_PORT = 547
+
+      # DHCPv6 message types
+      MESSAGE_TYPES = {
+        'SOLLICIT'            => 1,
+        'ADVERTISE'           => 2,
+        'REQUEST'             => 3,
+        'CONFIRM'             => 4,
+        'RENEW'               => 5,
+        'REBIND'              => 6,
+        'REPLY'               => 7,
+        'RELEASE'             => 8,
+        'DECLINE'             => 9,
+        'RECONFIGURE'         => 10,
+        'INFORMATION-REQUEST' =>  11
+      }
+      
+      # @!attribute msg_type
+      #   8-bit message type
+      #   @return [Integer]
+      define_field :msg_type, Types::Int8Enum, enum: MESSAGE_TYPES
+      # @!attribute transaction_id
+      #   24-bit transaction ID
+      # @return [Integer]
+      define_field :transaction_id, Types::Int24
+      # @!attribute options
+      #   @return [DHCPv6::Options]
+      define_field :options, DHCPv6::Options
+
+      # Populate object from string
+      # @param [String] str
+      # @return [DHCPv6,DHCPv6::Relay]
+      def read(str)
+        msg_type = Types::Int8.new.read(str)
+        
+        case msg_type
+        when 12, 13
+          DHCPv6::Relay.new.read(str)
+        else
+          super
+        end
+      end
+
+      # Get human readable message type
+      # @return [String]
+      def human_msg_type
+        self[:msg_type].to_human
+      end
+    end
+
+    UDP.bind_header DHCPv6, sport: DHCPv6::UDP_CLIENT_PORT, dport: DHCPv6::UDP_SERVER_PORT
+    UDP.bind_header DHCPv6, sport: DHCPv6::UDP_SERVER_PORT, dport: DHCPv6::UDP_CLIENT_PORT
+  end
+end
+
+require_relative 'dhcpv6/relay'

data/lib/packetgen/header/dhcpv6/duid.rb

@@ -0,0 +1,147 @@
+# 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.
+
+# frozen_string_literal: true
+
+module PacketGen
+  module Header
+    class DHCPv6
+      # @abstract Base class for DUID (DHCP Unique ID)
+      # @author Sylvain Daubert
+      class DUID < Types::Fields
+        
+        TYPES = {
+          'DUID-LLT' => 1,
+          'DUID-EN'  => 2,
+          'DUID-LL'  => 3
+        }
+
+        # @!attribute type
+        #  16-bit DUID type
+        #  @return [Integer]
+        define_field :type, Types::Int16Enum, enum: TYPES
+        # @!attribute body
+        #  @abstract replaced by specific fields in subclasses
+        #  DUID data.
+        #  @return [String]
+        define_field :body, Types::String
+
+        alias private_read read
+        private :private_read
+
+        # Populate object from binary string
+        # @param [String] str
+        # @return [DUID]
+        def read(str)
+          if self.class == DUID
+            super
+            case type
+            when 1
+              DUID_LLT.new.read(str)
+            when 2
+              DUID_EN.new.read(str)
+            when 3
+              DUID_LL.new.read(str)
+            else
+              self
+            end
+          else
+            private_read str
+          end
+        end
+
+        # Get human-readable DUID description
+        # @return [String]
+        def to_human
+          "DUID<#{type},#{body.inspect}>"
+        end
+      end
+
+      # DUID Based on Link-layer Address Plus Time
+      # @author Sylvain Daubert
+      class DUID_LLT < DUID
+        delete_field :body
+        undef body
+        undef body=
+
+        # Base time for time computation
+        BASE_TIME = Time.utc(2000, 1, 1)
+
+        # @!attribute htype
+        #  16-bit hardware protocol type
+        #  @return [Integer]
+        define_field :htype, Types::Int16, default: 1
+        # @!attribute time
+        #  32-bit time information
+        #  @return [Time]
+        define_field :time, Types::Int32, default: (Time.now - BASE_TIME).to_i
+        # @!attribute link_addr
+        #  @return [Eth::MacAddr]
+        define_field :link_addr, Eth::MacAddr
+
+        # @return [Time]
+        def time
+          BASE_TIME + self[:time].to_i
+        end
+
+        # @param [Time] time
+        # @return [Time]
+        def time=(time)
+          self[:time].value = time - BASE_TIME
+        end
+
+        # Get human-readable DUID description
+        # @return [String]
+        def to_human
+          "DUID_LLT<#{time},#{link_addr}>"
+        end
+      end
+
+      # DUID Based on Enterprise Number
+      # @author Sylvain Daubert
+      class DUID_EN < DUID
+        delete_field :body
+        undef body
+        undef body=
+
+        # @!attribute en
+        #  32-bit entreprise number
+        #  @return [Integer]
+        define_field :en, Types::Int32
+        # @!attribute identifier
+        #  @return [String]
+        define_field :identifier, Types::String
+
+        # Get human-readable DUID description
+        # @return [String]
+        def to_human
+          "DUID_EN<%#x,%s>" % [en, identifier]
+        end
+      end
+
+      # DUID Based on Link-layer
+      # @author Sylvain Daubert
+      class DUID_LL < DUID
+        delete_field :body
+        undef body
+        undef body=
+
+        # @!attribute htype
+        #  16-bit hardware protocol type
+        #  @return [Integer]
+        define_field :htype, Types::Int16, default: 1
+        # @!attribute link_addr
+        #  @return [Eth::MacAddr]
+        define_field :link_addr, Eth::MacAddr
+
+        # Get human-readable DUID description
+        # @return [String]
+        def to_human
+          "DUID_LL<#{link_addr}>"
+        end
+      end
+    end
+  end
+end