Class: PacketGen::PcapNG::EPB

Inherits:
Block show all
Defined in:
lib/packetgen/pcapng/epb.rb

Overview

EPB represents a Enhanced Packet Block (EPB) of a pcapng file.

EPB Definition

Int32   :type           Default: 0x00000006
Int32   :block_len
Int32   :interface_id
Int32   :tsh (timestamp high)
Int32   :tsl (timestamp low)
Int32   :cap_len
Int32   :orig_len
String  :data
String  :options
Int32   :block_len2

Author:

  • Sylvain Daubert

Constant Summary collapse

MIN_SIZE =

Minimum EPB size

8 * 4

Instance Attribute Summary collapse

Attributes inherited from Block

#block_len, #type

Instance Method Summary collapse

Methods inherited from Block

#options?, #pad_field, #recalc_block_len

Methods inherited from Types::Fields

#[], #[]=, #bits_on, define_bit_fields_on, define_field, define_field_after, define_field_before, #fields, fields, inherited, #inspect, #offset_of, #optional?, #optional_fields, #present?, remove_bit_fields_on, remove_field, #sz, #to_h, update_field

Constructor Details

#initialize(options = {}) ⇒ EPB

Returns a new instance of EPB.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :endian (:little, :big) —

    set block endianness

  • :type (Integer)
  • :block_len (Integer) —

    block total length

  • :interface_id (Integer) —

    specifies the interface this packet comes from

  • :tsh (Integer) —

    timestamp (high nibbles)

  • :tsl (Integer) —

    timestamp (low nibbles)

  • :cap_len (Integer) —

    number of octets captured from the packet

  • :orig_len (Integer) —

    actual length of the packet when it was transmitted on the network

  • :data (::String)
  • :options (::String)
  • :block_len2 (Integer) —

    block total length



75
76
77
78
79
80
 
# File 'lib/packetgen/pcapng/epb.rb', line 75

def initialize(options={})
  super
  endianness(options[:endian] || :little)
  recalc_block_len
  self.type = options[:type] || PcapNG::EPB_TYPE.to_i
end

Instance Attribute Details

#cap_len ⇒ Integer

32-bit capture length

Returns:

  • (Integer) 


49
 
# File 'lib/packetgen/pcapng/epb.rb', line 49

define_field_before :block_len2, :cap_len, Types::Int32, default: 0

#data ⇒ Types::String

Returns:



56
 
# File 'lib/packetgen/pcapng/epb.rb', line 56

define_field_before :block_len2, :data, Types::String

#endian ⇒ :little, :big

Returns:

  • (:little, :big) 


30
31
32
 
# File 'lib/packetgen/pcapng/epb.rb', line 30

def endian
  @endian
end

#interface ⇒ IPB

Returns:

  • (IPB) 


32
33
34
 
# File 'lib/packetgen/pcapng/epb.rb', line 32

def interface
  @interface
end

#interface_id ⇒ Integer

32-bit interface ID

Returns:

  • (Integer) 


37
 
# File 'lib/packetgen/pcapng/epb.rb', line 37

define_field_before :block_len2, :interface_id, Types::Int32, default: 0

#options ⇒ Types::String

Returns:



59
 
# File 'lib/packetgen/pcapng/epb.rb', line 59

define_field_before :block_len2, :options, Types::String

#orig_len ⇒ Integer

32-bit original length

Returns:

  • (Integer) 


53
 
# File 'lib/packetgen/pcapng/epb.rb', line 53

define_field_before :block_len2, :orig_len, Types::Int32, default: 0

#tsh ⇒ Integer

high 32-bit timestamp value

Returns:

  • (Integer) 


41
 
# File 'lib/packetgen/pcapng/epb.rb', line 41

define_field_before :block_len2, :tsh, Types::Int32, default: 0

#tsl ⇒ Integer

low 32-bit imestamp value

Returns:

  • (Integer) 


45
 
# File 'lib/packetgen/pcapng/epb.rb', line 45

define_field_before :block_len2, :tsl, Types::Int32, default: 0

Instance Method Details

#read(str_or_io) ⇒ self

Reads a String or a IO to populate the object

Parameters:

  • str_or_io (::String, IO)

Returns:

  • (self) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/packetgen/pcapng/epb.rb', line 85

def read(str_or_io)
  io = to_io(str_or_io)
  return self if io.eof?

  %i[type block_len interface_id tsh tsl cap_len orig_len].each do |attr|
    self[attr].read io.read(self[attr].sz)
  end
  self[:data].read io.read(self.cap_len)
  read_options(io)
  read_blocklen2_and_check(io)

  self
end

#timestamp ⇒ Time

Return timestamp as a Time object

Returns:

  • (Time) 


101
102
103
 
# File 'lib/packetgen/pcapng/epb.rb', line 101

def timestamp
  Time.at((self.tsh << 32 | self.tsl) * ts_resol)
end

#timestamp=(time) ⇒ Time

Set timestamp from a Time object

Parameters:

  • time (Time)

Returns:

  • (Time) —

    time



108
109
110
111
112
113
 
# File 'lib/packetgen/pcapng/epb.rb', line 108

def timestamp=(time)
  tstamp = (time.to_r / ts_resol).to_i
  self.tsh = (tstamp & 0xffffffff00000000) >> 32
  self.tsl = tstamp & 0xffffffff
  time
end

#to_s ⇒ String

Return the object as a String

Returns:

  • (String) 


117
118
119
120
121
 
# File 'lib/packetgen/pcapng/epb.rb', line 117

def to_s
  pad_field :data, :options
  recalc_block_len
  super
end