packetgen 1.4.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b5b7c4c6b94e7e5e2323d99a06f687109495539
-  data.tar.gz: 363abe5a21f82d8f0fe8f791912109c55d795218
+  metadata.gz: 77561a943f0b532168700f1752631dd1f8080ebf
+  data.tar.gz: 36a505013a6ff0e37a35e64d62ec627dcba5dc22
 SHA512:
-  metadata.gz: 7782f886a780d71bd9e976bb9185742979f8a5d0a4818a07a9b8c249d4628616db690a4620e80a346ec19357df288c4d2b598804095b648e1373cf9f99c15a73
-  data.tar.gz: e8838e0e6ba458472090661066cdd90ac4358f02e4eea53adf4c2c09867ee83c0e4c318241a30f0cb255d91cf393319002b378c174161744596b2bd2f84e2e2d
+  metadata.gz: f72762403800113f9816892b1d7d0df0e5fa417a28afbbc7cf56a5b15d340100721ce46bdc2fcb003a2818dec57780bdb8d3172cbe4bdcad2ba8a2dc4ed8ab16
+  data.tar.gz: cae3e091c5423afd66ab45a2ebea34a265e9b5a751b14bfb42e9a04bb92deb6945af0c5a85ed9520d96e721f33c815817b9898aca74bb6e51277eb3855809ed5

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 sudo: required
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 
 install:
   - sudo apt-get update -qq

data/README.md

@@ -36,11 +36,11 @@ PacketGen.gen('IP').to_s
 ### Send packets on wire
 ```ruby
 # send Ethernet packet
-PacketGen.gen('Eth', src: '00:00:00:00:01', dst: '00:00:00:00:02').to_w
+PacketGen.gen('Eth', src: '00:00:00:00:00:01', dst: '00:00:00:00:00:02').to_w
 # send IP packet
 PacketGen.gen('IP', src: '192.168.1.1', dst: '192.168.1.2').to_w
 # send forged IP packet over Ethernet
-PacketGen.gen('Eth', src: '00:00:00:00:01', dst: '00:00:00:00:02').add('IP').to_w('eth1')
+PacketGen.gen('Eth', src: '00:00:00:00:00:01', dst: '00:00:00:00:00:02').add('IP').to_w('eth1')
 ```
 
 ### Parse packets from binary data
@@ -50,16 +50,16 @@ packet = PacketGen.parse(binary_data)
 
 ### Capture packets from wire
 ```ruby
-# Capture packets, action from a block
-PacketGen.capture('eth0') do |packet|
+# Capture packets from first network interface, action from a block
+PacketGen.capture do |packet|
   do_stuffs_with_packet
 end
 
 # Capture some packets, and act on them afterward
-packets = PacketGen.capture('eth0', max: 10)   # return when 10 packets were captured
+packets = PacketGen.capture(iface: 'eth0', max: 10)   # return when 10 packets were captured
 
 # Use filters
-packets = PacketGen.capture('eth0', filter: 'ip src 1.1.1.2', max: 1)
+packets = PacketGen.capture(iface: 'eth0', filter: 'ip src 1.1.1.2', max: 1)
 ```
 
 ### Easily manipulate packets

data/lib/packetgen.rb

@@ -38,7 +38,6 @@ module PacketGen
   end
 
   # Shortcut for {Packet.capture}
-  # @param [String] iface interface name
   # @param [Hash] options capture options. See {Packet.capture}.
   # @yieldparam [Packet] packet
   # @return [Array<Packet>]

data/lib/packetgen/capture.rb

@@ -25,49 +25,27 @@ module PacketGen
     # @return [String]
     attr_reader :iface
 
-    # @overload initialize(iface=Pcap.lookupdev, options={})
-    #  @param [String] iface interface on which capture packets
-    #  @param [Hash] options
-    #  @option options [Integer] :max maximum number of packets to capture.
-    #  @option options [Integer] :timeout maximum number of seconds before end
-    #     of capture. Default: +nil+ (no timeout)
-    #  @option options [String] :filter bpf filter
-    #  @option options [Boolean] :promiscuous (default: +false+)
-    #  @option options [Boolean] :parse parse raw data to generate packets before
-    #     yielding.  Default: +true+
-    #  @option options [Integer] :snaplen maximum number of bytes to capture for
-    #     each packet.
-    # @overload initialize(options={})
-    #  @param [Hash] options
-    #  @option options [String]  :iface interface on which capture
-    #     packets on. Default: Use default interface lookup. If no interface found,
-    #     use loopback one.
-    #  @option options [Integer] :max maximum number of packets to capture.
-    #  @option options [Integer] :timeout maximum number of seconds before end
-    #     of capture. Default: +nil+ (no timeout)
-    #  @option options [String] :filter bpf filter
-    #  @option options [Boolean] :promiscuous (default: +false+)
-    #  @option options [Boolean] :parse parse raw data to generate packets before
-    #     yielding.  Default: +true+
-    #  @option options [Integer] :snaplen maximum number of bytes to capture for
-    #     each packet.
-    def initialize(iface_or_options={}, options={})
+    # @param [Hash] options
+    # @option options [String]  :iface interface on which capture
+    #    packets on. Default: Use default interface lookup. If no interface found,
+    #    use loopback one.
+    # @option options [Integer] :max maximum number of packets to capture.
+    # @option options [Integer] :timeout maximum number of seconds before end
+    #    of capture. Default: +nil+ (no timeout)
+    # @option options [String] :filter bpf filter
+    # @option options [Boolean] :promiscuous (default: +false+)
+    # @option options [Boolean] :parse parse raw data to generate packets before
+    #    yielding.  Default: +true+
+    # @option options [Integer] :snaplen maximum number of bytes to capture for
+    #    each packet.
+    # @since 2.0.0 remove old 1.x API
+    def initialize(options={})
       begin
         @iface = Pcap.lookupdev
       rescue PCAPRUB::BindingError
         @iface = 'lo'
       end
 
-      case iface_or_options
-      when Hash
-        options = iface_or_options
-      else
-        warn "[deprecation] use of PacketGen::Capture#initialize with iface name as\n" \
-             "              first argument is deprecated. Instead, use:\n" \
-             '              PacketGen::Capture.new(iface: \'name\').'
-        @iface = iface_or_options.to_s
-      end
-
       @packets     = []
       @raw_packets = []
       @promisc = false

data/lib/packetgen/header.rb

@@ -48,7 +48,7 @@ module PacketGen
     # @return [void]
     # @since 1.1.0
     def self.add_class(klass)
-      protocol_name = klass.to_s.sub(/.*::/, '')
+      protocol_name = klass.new.protocol_name
       @added_header_classes[protocol_name] = klass
       @header_classes = nil
     end
@@ -59,7 +59,7 @@ module PacketGen
     # @return [void]
     # @since 1.1.0
     def self.remove_class(klass)
-      protocol_name = klass.to_s.sub(/.*::/, '')
+      protocol_name = klass.new.protocol_name
       @added_header_classes.delete protocol_name
       @header_classes = nil
     end
@@ -78,6 +78,7 @@ module PacketGen
   end
 end
 
+require_relative 'header/crypto'
 require_relative 'header/base'
 require_relative 'header/eth'
 require_relative 'header/dot11'
@@ -92,4 +93,7 @@ require_relative 'header/icmpv6'
 require_relative 'header/udp'
 require_relative 'header/tcp'
 require_relative 'header/esp'
+require_relative 'header/ike'
 require_relative 'header/dns'
+require_relative 'header/asn1_base'
+require_relative 'header/snmp'

data/lib/packetgen/header/asn1_base.rb

@@ -0,0 +1,86 @@
+# 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 'rasn1'
+
+module PacketGen
+  module Header
+
+    # @abstract Base class for ASN.1 header types.
+    #    Subclasses may define magic methods:
+    #    * {#parse?}.
+    # @author Sylvain Daubert
+    class ASN1Base < RASN1::Model
+
+      # @api private
+      # Reference on packet which owns this header
+      attr_accessor :packet
+
+      # Give protocol name for this class
+      # @return [String]
+      # @since 2.0.0
+      def self.protocol_name
+        self.new.protocol_name
+      end
+
+      # Define some methods from given ASN.1 fields to mimic {Base} attributes
+      # @param [Array<Symbol>] attributes
+      # @return [void]
+      def self.define_attributes(*attributes)
+        @attributes = attributes
+        attributes.each do |attr|
+          class_eval "def #{attr}; @elements[:#{attr}].value; end\n" \
+                     "def #{attr}=(v); @elements[:#{attr}].value = v; end"
+        end
+      end
+
+      # Return header protocol name
+      # @return [String]
+      def protocol_name
+        return @protocol_name if @protocol_name
+
+        classname = self.class.to_s
+        @protocol_name = if classname.start_with?('PacketGen::Header')
+                           classname.sub(/.*Header::/, '')
+                         else
+                           classname.sub(/.*::/, '')
+                         end
+      end
+      # return header method name
+      # @return [String]
+      # @since 2.0.0
+      def method_name
+        return @method_name if @method_name
+
+        @method_name = protocol_name.downcase.sub(/::/, '_')
+      end
+
+      # @return [true]
+      def parse?
+        true
+      end
+
+      alias :parse :parse!
+      alias :to_s :to_der
+
+      # Read a BER string
+      # @param [String] str
+      # @return [ASN1Base] self
+      def read(str)
+        parse(str, ber: true)
+        self
+      end
+
+      # Common inspect method for ASN.1 headers
+      # @return [String]
+      def inspect
+        str = Inspect.dashed_line(self.class, 2)
+        self.class.class_eval { @attributes }.each do |attr|
+          str << Inspect.inspect_asn1_attribute(attr, self[attr], 2)
+        end
+        str
+      end
+    end
+  end
+end

data/lib/packetgen/header/base.rb

@@ -6,8 +6,9 @@
 module PacketGen
   module Header
 
-    # @abstract
-    # Base class for all header types
+    # @abstract Base class for all header types.
+    #    Subclasses may define magic methods:
+    #    * {#parse?}.
     # @author Sylvain Daubert
     class Base < Types::Fields
 
@@ -39,6 +40,32 @@ module PacketGen
         end
       end
 
+      # @api private
+      # Class to handle a header association from procs
+      class ProcBinding
+
+        # @param [Array<Proc>] procs first proc is used to set fields, second proc is
+        #  used to check binding
+        def initialize(procs)
+          @set = procs.shift
+          @check = procs.shift
+        end
+
+        # Check +fields+ responds to binding
+        # @param [Types::Fields] fields
+        # @return [Boolean]
+        def check?(fields)
+          @check.call(fields)
+        end
+
+        # Set +fields+ field to binding value
+        # @param [Types::Fields] fields
+        # @return [void]
+        def set(fields)
+          @set.call(fields)
+        end
+      end
+
       # @api private
       # Class to handle header associations
       class Bindings
@@ -100,41 +127,6 @@ module PacketGen
         end
       end
 
-      # @api private
-      # Class to handle header associations
-      class Bindings
-        include Enumerable
-
-        # op type
-        # @return [:or,:and]
-        attr_accessor :op
-        # @return [Array<Binding>]
-        attr_accessor :bindings
-
-        # @param [:or, :and] op
-        def initialize(op)
-          @op = op
-          @bindings = []
-        end
-
-        # @param [Object] arg
-        # @return [Bindings] self
-        def <<(arg)
-          @bindings << arg
-        end
-
-        # each iterator
-        # @return [void]
-        def each
-          @bindings.each { |b| yield b }
-        end
-
-        # @return [Boolean]
-        def empty?
-          @bindings.empty?
-        end
-      end
-
       # @api private
       # Reference on packet which owns this header
       attr_accessor :packet
@@ -149,9 +141,10 @@ module PacketGen
 
       # Bind a upper header to current class
       #   Header1.bind_header Header2, field1: 43
-      #   Header1.bind_header Header2, field1: 43, field2: 43
-      #   Header1.bind_header Header2, op: :and, field1: 43, field2: 43
-      #   Header1.bind_header Header2, field1: ->(v) { v.nil? ? 128 : v > 127 }
+      #   Header1.bind_header Header3, field1: 43, field2: 43
+      #   Header1.bind_header Header4, op: :and, field1: 43, field2: 43
+      #   Header1.bind_header Header5, field1: ->(v) { v.nil? ? 128 : v > 127 }
+      #   Header1.bind_header Header6, proc: ->(pkt) { pkt.header1.field1 == 1 && pkt.header1.body[0..1] == "\x00\x00" }
       # @param [Class] header_klass header class to bind to current class
       # @param [Hash] args current class fields and their value when +header_klass+
       #  is embedded in current class. Given value may be a lambda, whose alone argument
@@ -165,13 +158,28 @@ module PacketGen
       # @return [void]
       def self.bind_header(header_klass, args={})
         op = args.delete(:op) || :or
-        bindings = Bindings.new(op)
-        @known_headers[header_klass] = bindings
+        if @known_headers[header_klass].nil? || @known_headers[header_klass].op != op
+          bindings = Bindings.new(op)
+          @known_headers[header_klass] = bindings
+        else
+          bindings = @known_headers[header_klass]
+        end
         args.each do |key, value|
-          bindings << Binding.new(key, value)
+          if key == :procs
+            bindings << ProcBinding.new(value)
+          else
+            bindings << Binding.new(key, value)
+          end
         end
       end
 
+      # Give protocol name for this class
+      # @return [String]
+      # @since 2.0.0
+      def self.protocol_name
+        self.new.protocol_name
+      end
+
       # @api private
       # Get knwon headers
       # @return [Hash] keys: header classes, values: hashes
@@ -182,7 +190,23 @@ module PacketGen
       # Return header protocol name
       # @return [String]
       def protocol_name
-        self.class.to_s.sub(/.*::/, '')
+        return @protocol_name if @protocol_name
+
+        classname = self.class.to_s
+        @protocol_name = if classname.start_with?('PacketGen::Header')
+                           classname.sub(/.*Header::/, '')
+                         else
+                           classname.sub(/.*::/, '')
+                         end
+      end
+
+      # return header method name
+      # @return [String]
+      # @since 2.0.0
+      def method_name
+        return @method_name if @method_name
+
+        @method_name = protocol_name.downcase.sub(/::/, '_')
       end
 
       # @abstract Should be redefined by subclasses. This method should check invariant

data/lib/packetgen/header/crypto.rb

@@ -0,0 +1,62 @@
+module PacketGen
+  module Header
+
+    # Mixin for cryptographic classes
+    # @api private
+    # @author Sylvain Daubert
+    module Crypto
+
+      # Cryptographic error
+      class Error < PacketGen::Error; end
+
+      # Register cryptographic modes
+      # @param [OpenSSL::Cipher] conf
+      # @param [OpenSSL::HMAC] intg
+      # @return [void]
+      def set_crypto(conf, intg)
+        @conf, @intg = conf, intg
+        if conf.authenticated?
+          # #auth_tag_len only supported from ruby 2.4.0
+          @conf.auth_tag_len = @trunc if @conf.respond_to? :auth_tag_len
+        end
+      end
+
+      # Get confidentiality mode name
+      # @return [String]
+      def confidentiality_mode
+        mode = @conf.name.match(/-([^-]*)$/)[1]
+        raise Error, 'unknown cipher mode' if mode.nil?
+        mode.downcase
+      end
+
+      # Say if crypto modes permit authentication
+      # @return [Boolean]
+      def authenticated?
+        @conf.authenticated? or !!@intg
+      end
+
+      def authenticate!
+        @conf.final
+        if @intg
+          @intg.update @esn.to_s if @esn
+          @intg.digest[0, @icv_length] == @icv
+        else
+          true
+        end
+      rescue OpenSSL::Cipher::CipherError
+        false
+      end
+
+      def encipher(data)
+        enciphered_data = @conf.update(data)
+        @intg.update(enciphered_data) if @intg
+        enciphered_data
+      end
+
+      def decipher(data)
+        @intg.update(data) if @intg
+        @conf.update(data)
+      end
+    end
+  end
+end