packetgen-plugin-ipsec 1.0.2 → 1.1.0

data/lib/packetgen/plugin/ike/id.rb

@@ -6,94 +6,93 @@
 
 # frozen_string_literal: true
 
-module PacketGen
-  module Plugin
-    class IKE
-      # This class handles Identification - Initiator payloads, denoted IDi
-      # (see RFC 7296, §3.5).
-      #
-      # A ID payload consists of the IKE generic payload Plugin (see {Payload})
-      # and some specific fields:
-      #                        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
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   | Next Payload  |C|  RESERVED   |         Payload Length        |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   |   ID Type     |                 RESERVED                      |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   |                                                               |
-      #   ~                   Identification Data                         ~
-      #   |                                                               |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      # These specific fields are:
-      # * {#type} (ID type),
-      # * {#reserved},
-      # * and {#content} (Identification Data).
-      #
-      # == Create a IDi payload
-      #   # Create a IKE packet with a IDi payload
-      #   pkt = PacketGen.gen('IP').add('UDP').add('IKE').add('IKE::IDi', type: 'FQDN')
-      #   pkt.ike_idi.content.read 'fqdn.example.org'
-      #   pkt.calc_length
-      # @author Sylvain Daubert
-      class IDi < Payload
-        # Payload type number
-        PAYLOAD_TYPE = 35
+module PacketGen::Plugin
+  class IKE
+    # This class handles Identification - Initiator payloads, denoted IDi
+    # (see RFC 7296, §3.5).
+    #
+    # A ID payload consists of the IKE generic payload Plugin (see {Payload})
+    # and some specific fields:
+    #                        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
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   | Next Payload  |C|  RESERVED   |         Payload Length        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |   ID Type     |                 RESERVED                      |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   ~                   Identification Data                         ~
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # These specific fields are:
+    # * {#type} (ID type),
+    # * {#reserved},
+    # * and {#content} (Identification Data).
+    #
+    # == Create a IDi payload
+    #   # Create a IKE packet with a IDi payload
+    #   pkt = PacketGen.gen('IP').add('UDP').add('IKE').add('IKE::IDi', type: 'FQDN')
+    #   pkt.ike_idi.content.read 'fqdn.example.org'
+    #   pkt.calc_length
+    # @author Sylvain Daubert
+    class IDi < Payload
+      # Payload type number
+      PAYLOAD_TYPE = 35
 
-        TYPES = {
-          'IPV4_ADDR'   => 1,
-          'FQDN'        => 2,
-          'RFC822_ADDR' => 3,
-          'IPV6_ADDR'   => 5,
-          'DER_ASN1_DN' => 9,
-          'DER_ASN1_GN' => 10,
-          'KEY_ID'      => 11
-        }.freeze
+      # ID types
+      TYPES = {
+        'IPV4_ADDR' => 1,
+        'FQDN' => 2,
+        'RFC822_ADDR' => 3,
+        'IPV6_ADDR' => 5,
+        'DER_ASN1_DN' => 9,
+        'DER_ASN1_GN' => 10,
+        'KEY_ID' => 11
+      }.freeze
 
-        # @attribute [r] type
-        #   8-bit ID type
-        #   @return [Integer]
-        define_field_before :content, :type, PacketGen::Types::Int8Enum, enum: TYPES
-        # @attribute reserved
-        #   24-bit reserved field
-        #   @return [Integer]
-        define_field_before :content, :reserved, PacketGen::Types::Int24
+      # @attribute [r] type
+      #   8-bit ID type
+      #   @return [Integer]
+      define_attr_before :content, :type, BinStruct::Int8Enum, enum: TYPES
+      # @attribute reserved
+      #   24-bit reserved field
+      #   @return [Integer]
+      define_attr_before :content, :reserved, BinStruct::Int24
 
-        # Get ID type name
-        # @return [String]
-        def human_type
-          self[:type].to_human
-        end
-
-        # Get human readable content, from {#type}
-        # @return [String]
-        def human_content
-          case type
-          when TYPES['IPV4_ADDR'], TYPES['IPV4_ADDR']
-            IPAddr.ntop(content)
-          when TYPES['DER_ASN1_DN'], TYPES['DER_ASN1_GN']
-            OpenSSL::X509::Name.new(content).to_s
-          else
-            content.inspect
-          end
-        end
+      # Get ID type name
+      # @return [String]
+      def human_type
+        self[:type].to_human
       end
 
-      # This class handles Identification - Responder payloads, denoted IDr.
-      # See {IDi}.
-      #
-      # == Create a IDr payload
-      #   # Create a IKE packet with a IDr payload
-      #   pkt = PacketGen.gen('IP').add('UDP').add('IKE').add('IKE::IDr', type: 'FQDN')
-      #   pkt.ike_idr.content.read 'fqdn.example.org'
-      # @author Sylvain Daubert
-      class IDr < IDi
-        # Payload type number
-        PAYLOAD_TYPE = 36
+      # Get human readable content, from {#type}
+      # @return [String]
+      def human_content
+        case type
+        when TYPES['IPV4_ADDR'], TYPES['IPV6_ADDR']
+          IPAddr.ntop(content)
+        when TYPES['DER_ASN1_DN'], TYPES['DER_ASN1_GN']
+          OpenSSL::X509::Name.new(content).to_s
+        else
+          content.inspect
+        end
       end
     end
 
-    Header.add_class IKE::IDi
-    Header.add_class IKE::IDr
+    # This class handles Identification - Responder payloads, denoted IDr.
+    # See {IDi}.
+    #
+    # == Create a IDr payload
+    #   # Create a IKE packet with a IDr payload
+    #   pkt = PacketGen.gen('IP').add('UDP').add('IKE').add('IKE::IDr', type: 'FQDN')
+    #   pkt.ike_idr.content.read 'fqdn.example.org'
+    # @author Sylvain Daubert
+    class IDr < IDi
+      # Payload type number
+      PAYLOAD_TYPE = 36
+    end
   end
+
+  PacketGen::Header.add_class IKE::IDi
+  PacketGen::Header.add_class IKE::IDr
 end

data/lib/packetgen/plugin/ike/ke.rb

@@ -1,79 +1,78 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # This file is part of IPsec packetgen plugin.
 # See https://github.com/sdaubert/packetgen-plugin-ipsec for more informations
 # Copyright (c) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
+module PacketGen::Plugin
+  class IKE
+    # This class handles Key Exchange payloads, as defined in RFC 7296 §3.4
+    #
+    # A KE payload contains a generic payload Plugin (see {Payload}) and some
+    # specific fields:
+    #                        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
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   | Next Payload  |C|  RESERVED   |         Payload Length        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |   Diffie-Hellman Group Num    |           RESERVED            |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   ~                       Key Exchange Data                       ~
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    # These specific fields are:
+    # * {#group_num} (type {BinStruct::Int16}),
+    # * {#reserved} (type {BinStruct::Int16}),
+    # * and {#content} (type {BinStruct::String}).
+    #
+    # == Create a KE payload
+    #   # Create a IKE packet with a KE payload
+    #   pkt = PacketGen.gen('IP').add('UDP').add('IKE')
+    #   # group name is taken from Transform::DH_* constants
+    #   pkt.add('IKE::KE', group: 'MODP4096')
+    #   # group number may also be used
+    #   pkt.ike_ke.group = 1
+    #   pkt.calc_length
+    # @author Sylvain Daubert
+    class KE < Payload
+      # Payload type number
+      PAYLOAD_TYPE = 34
 
-module PacketGen
-  module Plugin
-    class IKE
-      # This class handles Key Exchange payloads, as defined in RFC 7296 §3.4
-      #
-      # A KE payload contains a generic payload Plugin (see {Payload}) and some
-      # specific fields:
-      #                        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
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   | Next Payload  |C|  RESERVED   |         Payload Length        |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   |   Diffie-Hellman Group Num    |           RESERVED            |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   |                                                               |
-      #   ~                       Key Exchange Data                       ~
-      #   |                                                               |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      # These specific fields are:
-      # * {#group_num} (type {PacketGen::Types::Int16}),
-      # * {#reserved} (type {PacketGen::Types::Int16}),
-      # * and {#content} (type {PacketGen::Types::String}).
-      #
-      # == Create a KE payload
-      #   # Create a IKE packet with a KE payload
-      #   pkt = PacketGen.gen('IP').add('UDP').add('IKE')
-      #   # group name is taken from Transform::DH_* constants
-      #   pkt.add('IKE::KE', group: 'MODP4096')
-      #   # group number may also be used
-      #   pkt.ike_ke.group = 1
-      #   pkt.calc_length
-      # @author Sylvain Daubert
-      class KE < Payload
-        # Payload type number
-        PAYLOAD_TYPE = 34
+      # @!attribute group_num
+      #  16-bit DH group number
+      #  @return [Integer]
+      define_attr_before :content, :group_num, BinStruct::Int16
+      # @!attribute reserved
+      #  16-bit reserved field
+      #  @return [Integer]
+      define_attr_before :content, :reserved, BinStruct::Int16, default: 0
 
-        # @!attribute group_num
-        #  16-bit DH group number
-        #  @return [Integer]
-        define_field_before :content, :group_num, PacketGen::Types::Int16
-        # @!attribute reserved
-        #  16-bit reserved field
-        #  @return [Integer]
-        define_field_before :content, :reserved, PacketGen::Types::Int16, default: 0
+      def initialize(options={})
+        super
+        self.group = options[:group] if options[:group]
+      end
 
-        def initialize(options={})
-          super
-          self.group = options[:group] if options[:group]
-        end
+      # Set group
+      # @param [Integer,String] value may be a String taken from
+      #   {Transform}+::DH_*+ constant names.
+      # @return [Integer]
+      def group=(value)
+        group = case value
+                when Integer
+                  value
+                else
+                  cname = "DH_#{value}"
+                  Transform.const_defined?(cname) ? Transform.const_get(cname) : nil
+                end
+        raise ArgumentError, "unknown group #{value.inspect}" unless group
 
-        # Set group
-        # @param [Integer,String] value may be a String taken from
-        #   {Transform}+::DH_*+ constant names.
-        # @return [Integer]
-        def group=(value)
-          group = case value
-                  when Integer
-                    value
-                  else
-                    cname = "DH_#{value}"
-                    Transform.const_defined?(cname) ? Transform.const_get(cname) : nil
-                  end
-          raise ArgumentError, "unknown group #{value.inspect}" unless group
-          self[:group_num].value = group
-        end
+        self[:group_num].value = group
       end
     end
-
-    Header.add_class IKE::KE
   end
+
+  PacketGen::Header.add_class IKE::KE
 end

data/lib/packetgen/plugin/ike/nonce.rb

@@ -1,40 +1,38 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 # This file is part of IPsec packetgen plugin.
 # See https://github.com/sdaubert/packetgen-plugin-ipsec for more informations
 # Copyright (c) 2018 Sylvain Daubert <sylvain.daubert@laposte.net>
 # This program is published under MIT license.
 
-# frozen_string_literal: true
-
-module PacketGen
-  module Plugin
-    class IKE
-      # This class handles Nonce payloads, as defined in RFC 7296 §3.9.
-      #
-      # A Nonce payload contains a generic payload Plugin (see {Payload}) and
-      # data field (type {PacketGen::Types::String}):
-      #                        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
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   | Next Payload  |C|  RESERVED   |         Payload Length        |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #   |                                                               |
-      #   ~                            Nonce Data                         ~
-      #   |                                                               |
-      #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      #
-      # == Create a Nonce payload
-      #   # Create a IKE packet with a Nonce payload
-      #   pkt = PacketGen.gen('IP').add('UDP').add('IKE')
-      #   pkt.add('IKE::Nonce', data: "abcdefgh")
-      #   pkt.calc_length
-      # @author Sylvain Daubert
-      class Nonce < Payload
-        # Payload type number
-        PAYLOAD_TYPE = 40
-      end
+module PacketGen::Plugin
+  class IKE
+    # This class handles Nonce payloads, as defined in RFC 7296 §3.9.
+    #
+    # A Nonce payload contains a generic payload Plugin (see {Payload}) and
+    # data field (type {BinStruct::String}):
+    #                        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
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   | Next Payload  |C|  RESERVED   |         Payload Length        |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #   |                                                               |
+    #   ~                            Nonce Data                         ~
+    #   |                                                               |
+    #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    #
+    # == Create a Nonce payload
+    #   # Create a IKE packet with a Nonce payload
+    #   pkt = PacketGen.gen('IP').add('UDP').add('IKE')
+    #   pkt.add('IKE::Nonce', data: "abcdefgh")
+    #   pkt.calc_length
+    # @author Sylvain Daubert
+    class Nonce < Payload
+      # Payload type number
+      PAYLOAD_TYPE = 40
     end
-
-    Header.add_class IKE::Nonce
   end
+
+  PacketGen::Header.add_class IKE::Nonce
 end