packetgen 2.1.2 → 2.1.3

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

@@ -40,70 +40,44 @@ module PacketGen
       #   pkt = PacketGen.gen('IP').add('UDP').add('IKE').add('IKE::Notify', protocol: 'ESP', spi_size: 4, type: 'INVALID_SYNTAX')
       #   pkt.ike_notify.spi.read PacketGen::Types::Int32.new(0x12345678).to_s
       #   pkt.calc_length
-      # @author Sylvain Daubert
+      #   @author Sylvain Daubert
       class Notify < Payload
 
         # Payload type number
         PAYLOAD_TYPE = 41
 
-        # Unsupported critical payload
-        TYPE_UNSUPPORTED_CRITICAL_PAYLOAD = 1
-        # Invalid IKE SPI
-        TYPE_INVALID_IKE_SPI = 4
-        # Invalid major version
-        TYPE_INVALID_MAJOR_VERSION = 5
-        # Invalid syntax
-        TYPE_INVALID_SYNTAX = 7
-        # Invalid message ID
-        TYPE_INVALID_MESSAGE_ID = 9
-        # Invalid SPI
-        TYPE_INVALID_SPI = 11
-        # No proposal chosen (none of the proposed crypto suites was acceptable)
-        TYPE_NO_PROPOSAL_CHOSEN = 14
-        # Invalid KE payload
-        TYPE_INVALID_KE_PAYLOAD = 17
-        # Authentication failed
-        TYPE_AUTHENTICATION_FAILED = 24
-        # Single pair required
-        TYPE_SINGLE_PAIR_REQUIRED = 34
-        # No additional SAs
-        TYPE_NO_ADDITIONAL_SAS = 35
-        # Internal address failture
-        TYPE_INTERNAL_ADDRESS_FAILURE = 36
-        # Failed CP required
-        TYPE_FAILED_CP_REQUIRED = 37
-        # traffic selectors unacceptable
-        TYPE_TS_UNACCEPTABLE  = 38
-        # invalid selectors
-        TYPE_INVALID_SELECTORS = 39
-        # Temporary failure
-        TYPE_TEMPORARY_FAILURE = 43
-        # Child SA not found
-        TYPE_CHILD_SA_NOT_FOUND = 44
-        # Initial contact
-        TYPE_INITIAL_CONTACT = 16384
-        # Set window size
-        TYPE_SET_WINDOW_SIZE = 16385
-        # Additional traffic selector possible
-        TYPE_ADDITIONAL_TS_POSSIBLE = 16386
-        # IPcomp supported
-        TYPE_IPCOMP_SUPPORTED = 16387
-        # NAT detection source IP
-        TYPE_NAT_DETECTION_SOURCE_IP = 16388
-        # NAT detection destination IP
-        TYPE_NAT_DETECTION_DESTINATION_IP = 16389
-        # Cookie
-        TYPE_COOKIE = 16390
-        # Use transport mode (tunnel mode is default)
-        TYPE_USE_TRANSPORT_MODE = 16391
-        # HTTP certificate look up supported
-        TYPE_HTTP_CERT_LOOKUP_SUPPORTED = 16392
-        # Rekey SA
-        TYPE_REKEY_SA = 16393
-        # ESP TFC paddin not supported
-        TYPE_ESP_TFC_PADDING_NOT_SUPPORTED = 16394
-        # Non-first fragment also
-        TYPE_NON_FIRST_FRAGMENTS_ALSO = 16395
+        # Message types
+        TYPES = {
+          'UNSUPPORTED_CRITICAL_PAYLOAD'  => 1,
+          'INVALID_IKE_SPI'               => 4,
+          'INVALID_MAJOR_VERSION'         => 5,
+          'INVALID_SYNTAX'                => 7,
+          'INVALID_MESSAGE_ID'            => 9,
+          'INVALID_SPI'                   => 11,
+          'NO_PROPOSAL_CHOSEN'            => 14,
+          'INVALID_KE_PAYLOAD'            => 17,
+          'AUTHENTICATION_FAILED'         => 24,
+          'SINGLE_PAIR_REQUIRED'          => 34,
+          'NO_ADDITIONAL_SAS'             => 35,
+          'INTERNAL_ADDRESS_FAILURE'      => 36,
+          'FAILED_CP_REQUIRED'            => 37,
+          'TS_UNACCEPTABLE'               => 38,
+          'INVALID_SELECTORS'             => 39,
+          'TEMPORARY_FAILURE'             => 43,
+          'CHILD_SA_NOT_FOUND'            => 44,
+          'INITIAL_CONTACT'               => 16384,
+          'SET_WINDOW_SIZE'               => 16385,
+          'ADDITIONAL_TS_POSSIBLE'        => 16386,
+          'IPCOMP_SUPPORTED'              => 16387,
+          'NAT_DETECTION_SOURCE_IP'       => 16388,
+          'NAT_DETECTION_DESTINATION_IP'  => 16389,
+          'COOKIE'                        => 16390,
+          'USE_TRANSPORT_MODE'            => 16391,
+          'HTTP_CERT_LOOKUP_SUPPORTED'    => 16392,
+          'REKEY_SA'                      => 16393,
+          'ESP_TFC_PADDING_NOT_SUPPORTED' => 16394,
+          'NON_FIRST_FRAGMENTS_ALSO'      => 16395,
+        }.freeze
 
         # @!attribute [r] protocol
         #  8-bit protocol ID. If this notification concerns an existing
@@ -127,7 +101,7 @@ module PacketGen
         # @!attribute message_type
         #  16-bit notify message type. Specifies the type of notification message.
         #  @return [Integer]
-        define_field_before :content, :message_type, Types::Int16
+        define_field_before :content, :message_type, Types::Int16Enum, enum: TYPES, default: 0
         # @!attribute spi
         #   the sending entity's SPI. When the {#spi_size} field is zero,
         #   this field is not present in the proposal.
@@ -162,20 +136,6 @@ module PacketGen
           self[:protocol].value = proto
         end
 
-        # Set message type
-        # @param [Integer,String] value
-        # @return [Integer]
-        def message_type=(value)
-          type = case value
-               when Integer
-                 value
-               else
-                 c = self.class.constants.grep(/TYPE_#{value}/).first
-                 c ? self.class.const_get(c) : nil
-               end
-          raise ArgumentError, "unknown message type #{value.inspect}" unless type
-          self[:message_type].value = type
-        end
         alias type= message_type=
 
         # Get protocol name
@@ -190,10 +150,7 @@ module PacketGen
         # Get message type name
         # @return [String]
         def human_message_type
-          name = self.class.constants.grep(/TYPE_/).
-                 select { |c| self.class.const_get(c) == type }.
-                 first || "type #{type}"
-          name.to_s.sub(/TYPE_/, '')
+          self[:message_type].to_human
         end
         alias human_type human_message_type
 

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

@@ -122,11 +122,13 @@ module PacketGen
       # @author Sylvain Daubert
       class Transform < Types::Fields
 
-        TYPE_ENCR = 1
-        TYPE_PRF  = 2
-        TYPE_INTG = 3
-        TYPE_DH   = 4
-        TYPE_ESN  = 5
+        TYPES = {
+          'ENCR' => 1,
+          'PRF'  => 2,
+          'INTG' => 3,
+          'DH'   => 4,
+          'ESN'  => 5
+        }.freeze
 
         ENCR_DES_IV64          = 1
         ENCR_DES               = 2
@@ -215,7 +217,7 @@ module PacketGen
         #  8-bit transform type. The Transform Type is the cryptographic
         #  algorithm type (i.e. encryption, PRF, integrity, etc.)
         #  @return [Integer]
-        define_field :type, Types::Int8
+        define_field :type, Types::Int8Enum, enum: TYPES
         # @!attribute rsv2
         #  8-bit reserved field
         #  @return [Integer]
@@ -237,21 +239,6 @@ module PacketGen
           self.id = options[:id] if options[:id]
         end
 
-        # Set transform type
-        # @param [Integer,String] value
-        # @return [Integer]
-        def type=(value)
-          type = case value
-                 when Integer
-                   value
-                 else
-                   c = self.class.constants.grep(/TYPE_#{value}/).first
-                   c ? self.class.const_get(c) : nil
-                 end
-          raise ArgumentError, "unknown type #{value.inspect}" unless type
-          self[:type].value = type
-        end
-
         # Set transform ID
         # @param [Integer,String] value
         # @return [Integer]
@@ -295,10 +282,11 @@ module PacketGen
         # Get human-readable type
         # @return [String]
         def human_type
-          name = self.class.constants.grep(/TYPE/).
-                 select { |c| self.class.const_get(c) == type }.
-                 first || "type[#{type}]"
-          name.to_s.sub(/TYPE_/, '')
+          if self[:type].enum.has_value? self.type
+            self[:type].to_human
+          else
+            "type[#{self.type}]"
+          end
         end
 
         # Get human-readable ID

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

@@ -203,7 +203,8 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # These specific fields are:
       # * {#num_ts},
-      # * {#reserved},
+      # * {#rsv1},
+      # * {#rsv2},
       # * and {#traffic_selectors}.
       #
       # == Create a TSi payload
@@ -228,7 +229,7 @@ module PacketGen
         #   First 8-bit RESERVED field
         #   @return [Integer]
         define_field_before :body, :rsv1, Types::Int8
-        # @!attribute rsv1
+        # @!attribute rsv2
         #   Last 16-bit RESERVED field
         #   @return [Integer]
         define_field_before :body, :rsv2, Types::Int16
@@ -276,7 +277,7 @@ module PacketGen
           end
           str
         end
-     end
+      end
 
       class TSr < TSi
         # Payload type number

data/lib/packetgen/inspect.rb

@@ -60,10 +60,12 @@ module PacketGen
     end
 
     # Format a ASN.1 attribute for +#inspect+.
-    # 3 cases are handled:
-    # * attribute value is a {Types::Int}: show value as integer and in
+    # 4 cases are handled:
+    # * attribute value is a =RANS1::Types::Enumerated+: show named value and
+    #   its integer value as hexdecimal format,
+    # * attribute value is a +RASN1::Types::Integer+: show value as integer and in
     #   hexdecimal format,
-    # * attribute value responds to +#to_human+: call it,
+    # * attribute value is a +RASN1::Model+: only show its root type,
     # * else, +#to_s+ is used to format attribute value.
     # @param [Symbol] name attribute name
     # @param [RASN1::Types::Base,RASN1::Model] attr attribute
@@ -98,7 +100,7 @@ module PacketGen
           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 << '  ' << octets.map { |v| v < 128 && v > 31 ? v.chr : '.' }.join
           str << "\n"
         end
       end

data/lib/packetgen/packet.rb

@@ -99,7 +99,7 @@ module PacketGen
 
     # Read packets from +filename+. Mays read Pcap and Pcap-NG formats.
     #
-    # For more control, see {PcapNG::File} or {PCAPRUB::Pcap}.
+    # For more control, see {PcapNG::File} or +PCAPRUB::Pcap+.
     # @param [String] filename PcapNG or Pcap file.
     # @return [Array<Packet>]
     # @author Sylvain Daubert

data/lib/packetgen/pcapng/epb.rb

@@ -119,7 +119,7 @@ module PacketGen
       def to_s
         pad_field :data, :options
         recalc_block_len
-        fields.map { |f| @fields[f].to_s }.join
+        super
       end
 
 

data/lib/packetgen/pcapng/idb.rb

@@ -89,7 +89,7 @@ module PacketGen
         check_len_coherency
         self
       end
-      
+
       # Add a xPB to this section
       # @param [EPB,SPB] xpb
       # @return [self]
@@ -137,7 +137,7 @@ module PacketGen
       def to_s
         pad_field :options
         recalc_block_len
-        fields.map { |f| @fields[f].to_s }.join << @packets.map(&:to_s).join
+        super << @packets.map(&:to_s).join
       end
 
     end

data/lib/packetgen/pcapng/shb.rb

@@ -154,7 +154,7 @@ module PacketGen
         end
         pad_field :options
         recalc_block_len
-        fields.map { |f| @fields[f].to_s }.join + body
+        super + body
       end
 
 

data/lib/packetgen/pcapng/spb.rb

@@ -91,7 +91,7 @@ module PacketGen
       def to_s
         pad_field :data
         recalc_block_len
-        fields.map { |f| @fields[f].to_s }.join
+        super
       end
 
     end

data/lib/packetgen/pcapng/unknown_block.rb

@@ -54,7 +54,7 @@ module PacketGen
         self[:block_len].read io.read(4)
         self[:body].read io.read(self[:block_len].to_i - MIN_SIZE)
         self[:block_len2].read io.read(4)
-        
+
         unless self[:block_len].to_i == self[:block_len2].to_i
           raise InvalidFileError, 'Incoherency in Header Block'
         end
@@ -67,7 +67,7 @@ module PacketGen
       def to_s
         pad_field :body
         recalc_block_len
-        @fields.values.map(&:to_s).join
+        super
       end
 
     end

data/lib/packetgen/proto.rb

@@ -33,7 +33,7 @@ module PacketGen
     end
 
     # Get protocol name from its number
-    # @param [Integer] number
+    # @param [Integer] num
     # @return [String,nil] return nil for unknown protocol numbers
     def self.getprotobynumber(num)
       @cache.key(num)

data/lib/packetgen/types.rb

@@ -10,6 +10,7 @@ module PacketGen
 end
 
 require_relative 'types/int'
+require_relative 'types/enum'
 require_relative 'types/string'
 require_relative 'types/int_string'
 require_relative 'types/fields'

data/lib/packetgen/types/enum.rb

@@ -0,0 +1,165 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2032 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+module PacketGen
+  module Types
+
+    # @abstract Base enum class to handle binary integers with limited
+    #   authorized values
+    # An {Enum} type is used to handle an {Int} field with limited
+    # and named values.
+    #
+    # == Simple example
+    #  enum = Int8Enum.new(0, 'low' => 0, 'medium' => 1, 'high' => 2})
+    # In this example, +enum+ is a 8-bit field which may take one
+    # among three values: +low+, +medium+ or +high+:
+    #  enum.value = 'high'
+    #  enum.value              # => 2
+    #  enum.value = 1
+    #  enum.value              # => 1
+    #  enum.to_human           # => "medium"
+    # Setting an unknown value will raise an exception:
+    #  enum.value = 4          # => raise!
+    #  enum.value = 'unknown'  # => raise!
+    # But {#read} will not raise when reading an outbound value. This
+    # to enable decoding (or forging) of bad packets.
+    # @since 2.1.3
+    # @author Sylvain Daubert
+    class Enum < Int
+
+      # @return [Hash]
+      attr_reader :enum
+
+      # @param [Hash] enum enumerated values. Default value is taken from
+      #   first element unless given.
+      # @param [:little,:big,nil] endian
+      # @param [Integer,nil] width
+      # @param [Integer,nil] default default value
+      def initialize(enum, endian=nil, width=nil, default=nil)
+        default ||= enum[enum.keys.first]
+        super(nil, endian, width, default)
+        @enum = enum
+      end
+
+      # Setter for value attribute
+      # @param [Integer, String,nil] v value as an Integer or as a String
+      #   from enumration
+      # @return [Integer]
+      def value=(v)
+        ival = case v
+               when NilClass
+                 nil
+               when ::String
+                 raise ArgumentError, "#{v.inspect} not in enumeration" unless @enum.has_key? v
+                 @enum[v]
+               else
+                 raise ArgumentError, "#{v.inspect} not in enumeration" unless @enum.has_value? v
+                 v
+               end
+        @value = ival
+      end
+
+      # To handle human API: set value from a String
+      alias :from_human :value=
+
+      # Get human readable value (enum name)
+      # @return [String]
+      def to_human
+        @enum.key(to_i) || "<unknown:#{@value}>"
+      end
+    end
+
+    # Enumeration on one byte. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int8Enum < Enum
+      # @param [Integer] default
+      # @param [Hash] enum
+      def initialize(enum, default=nil)
+        super(enum, nil, 1, default)
+        @packstr = { nil => 'C' }
+      end
+    end
+
+    # Enumeration on 2-byte integer. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int16Enum < Enum
+      # @param [Hash] enum
+      # @param [:big, :little] endian
+      # @param [Integer,nil] default default value
+      def initialize(enum, endian=:big, default=nil)
+        super(enum, endian, 2, default)
+        @packstr = { big: 'n', little: 'v' }
+      end
+    end
+
+    # Enumeration on big endian 2-byte integer. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int16beEnum < Int16Enum
+      undef endian=
+
+      # @param [Hash] enum
+      # @param [Integer,nil] default default value
+      def initialize(enum, default=nil)
+        super(enum, :big, default)
+      end
+    end
+
+    # Enumeration on big endian 2-byte integer. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int16leEnum < Int16Enum
+      undef endian=
+
+      # @param [Hash] enum
+      # @param [Integer,nil] default default value
+      def initialize(enum, default=nil)
+        super(enum, :little, default)
+      end
+    end
+
+    # Enumeration on 4-byte integer. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int32Enum < Enum
+      # @param [Hash] enum
+      # @param [:big, :little] endian
+      # @param [Integer,nil] default default value
+      def initialize(enum, endian=:big, default=nil)
+        super(enum, endian, 4, default)
+        @packstr = { big: 'N', little: 'V' }
+      end
+    end
+
+    # Enumeration on big endian 4-byte integer. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int32beEnum < Int32Enum
+      undef endian=
+
+      # @param [Hash] enum
+      # @param [Integer,nil] default default value
+      def initialize(enum, default=nil)
+        super(enum, :big, default)
+      end
+    end
+
+    # Enumeration on big endian 4-byte integer. See {Enum}.
+    # @author Sylvain Daubert
+    # @since 2.1.3
+    class Int32leEnum < Int32Enum
+      undef endian=
+
+      # @param [Hash] enum
+      # @param [Integer,nil] default default value
+      def initialize(enum, default=nil)
+        super(enum, :little, default)
+      end
+    end
+  end
+end