Class: PacketGen::Header::IKE::TrafficSelector

Inherits:
Types::Fields show all
Defined in:
lib/packetgen/header/ike/ts.rb

Overview

TrafficSelector substructure, as defined in RFC 7296, §3.13.1:

                     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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   TS Type     |IP Protocol ID*|       Selector Length         |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|           Start Port*         |           End Port*           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
~                         Starting Address*                     ~
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
~                         Ending Address*                       ~
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Since:

  • 2.0.0

Constant Summary collapse

TS_IPV4_ADDR_RANGE =

IPv4 traffic selector type

Since:

  • 2.0.0

7
TS_IPV6_ADDR_RANGE =

IPv6 traffic selector type

Since:

  • 2.0.0

8

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Types::Fields

#[], #[]=, #bits_on, #body=, define_bit_fields_on, define_field, define_field_after, define_field_before, delete_field, fields, #fields, #force_binary, inherited, #inspect, #is_optional?, #is_present?, #offset_of, #optional?, #optional_fields, #present?, remove_bit_fields_on, remove_field, #sz, #to_h, #to_s, update_field

Constructor Details

#initialize(options = {}) ⇒ TrafficSelector

Returns a new instance of TrafficSelector.

Parameters:

  • options (Hash) (defaults to: {})
  • [Range] (Hash) —

    a customizable set of options

  • [Integer] (Hash) —

    a customizable set of options

Since:

  • 2.0.0



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/packetgen/header/ike/ts.rb', line 68

def initialize(options={})
  super
  select_addr options
  self[:start_addr].from_human(options[:start_addr]) if options[:start_addr]
  self[:end_addr].from_human(options[:end_addr]) if options[:end_addr]
  self[:length].value = sz unless options[:length]
  self.type = options[:type] if options[:type]
  self.protocol = options[:protocol] if options[:protocol]

  return unless options[:ports]
  self.start_port = options[:ports].begin
  self.end_port = options[:ports].end
end

Instance Attribute Details

#end_addr ⇒ IP::Addr, IPv6::Addr

starting address

Returns:



62
 
# File 'lib/packetgen/header/ike/ts.rb', line 62

define_field :end_addr, IP::Addr

#end_port ⇒ Integer

16-bit End port

Returns:

  • (Integer) 


54
 
# File 'lib/packetgen/header/ike/ts.rb', line 54

define_field :end_port, Types::Int16, default: 65_535

#length ⇒ Integer

16-bit Selector Length

Returns:

  • (Integer) 


46
 
# File 'lib/packetgen/header/ike/ts.rb', line 46

define_field :length, Types::Int16

#protocol ⇒ Integer

8-bit protocol ID

Returns:

  • (Integer) 


42
 
# File 'lib/packetgen/header/ike/ts.rb', line 42

define_field :protocol, Types::Int8, default: 0

#start_addr ⇒ IP::Addr, IPv6::Addr

starting address

Returns:



58
 
# File 'lib/packetgen/header/ike/ts.rb', line 58

define_field :start_addr, IP::Addr

#start_port ⇒ Integer

16-bit Start port

Returns:

  • (Integer) 


50
 
# File 'lib/packetgen/header/ike/ts.rb', line 50

define_field :start_port, Types::Int16, default: 0

#type ⇒ Integer

8-bit TS type

Returns:

  • (Integer) 


38
 
# File 'lib/packetgen/header/ike/ts.rb', line 38

define_field :type, Types::Int8, default: 7

Instance Method Details

#human_protocol ⇒ String

Get human readable protocol name. If protocol ID is 0, an empty string is returned.

Returns:

  • (String)

Since:

  • 2.0.0



135
136
137
138
139
140
141
 
# File 'lib/packetgen/header/ike/ts.rb', line 135

def human_protocol
  if protocol.zero?
    ''
  else
    Proto.getprotobynumber(protocol) || protocol.to_s
  end
end

#human_type ⇒ String

Get human readable TS type

Returns:

  • (String)

Since:

  • 2.0.0



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/packetgen/header/ike/ts.rb', line 145

def human_type
  case type
  when TS_IPV4_ADDR_RANGE
    'IPv4'
  when TS_IPV6_ADDR_RANGE
    'IPv6'
  else
    "type #{type}"
  end
end

#read(str) ⇒ self

Populate object from a string

Parameters:

  • str (String)

Returns:

  • (self)

Since:

  • 2.0.0



85
86
87
88
89
 
# File 'lib/packetgen/header/ike/ts.rb', line 85

def read(str)
  super
  select_addr_from_type type
  super
end

#to_human ⇒ String

Get a human readable string

Returns:

  • (String)

Since:

  • 2.0.0



123
124
125
126
127
128
129
130
 
# File 'lib/packetgen/header/ike/ts.rb', line 123

def to_human
  h = start_addr << '-' << end_addr
  unless human_protocol.empty?
    h << "/#{human_protocol}"
    h << "[#{start_port}-#{end_port}]" if (start_port..end_port) != (0..65_535)
  end
  h
end