Class: PacketGen::Header::Dot1x

Inherits:
Base show all
Defined in:
lib/packetgen/header/dot1x.rb

Overview

IEEE 802.1X / EAPOL

A IEEE 802.1X header consists of:

Create a Dot1x header

pkt1 = PacketGen.gen('Eth').add('Dot1x', type: 1)
pkt2 = PacketGen.gen('Eth').add('Dot1x')
pkt2.dot1x.type = 'EAP Packet'
pkt2.dot1x.body.read 'body'

Author:

  • Sylvain Daubert

Since:

  • 1.4.0

Constant Summary collapse

ETHERTYPE =

IEEE 802.1x Ether type

Since:

  • 1.4.0

0x888e
TYPES =

IEEE 802.1X packet types

Since:

  • 1.4.0

{
  'EAP Packet'      => 0,
  'Start'           => 1,
  'Logoff'          => 2,
  'Key'             => 3,
  'Encap-ASF-Alert' => 4
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

bind, calculate_and_set_length, #header_id, inherited, #initialize, #ip_header, known_headers, #ll_header

Methods included from PacketGen::Headerable

#added_to_packet, included, #method_name, #packet, #packet=, #parse?, #protocol_name

Methods inherited from Types::Fields

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

Constructor Details

This class inherits a constructor from PacketGen::Header::Base

Instance Attribute Details

#body ⇒ Types::String, Header::Base

Returns:



48
 
# File 'lib/packetgen/header/dot1x.rb', line 48

define_field :body, Types::String

#length ⇒ Integer

Returns 16-bit body length.

Returns:

  • (Integer) —

    16-bit body length



45
 
# File 'lib/packetgen/header/dot1x.rb', line 45

define_field :length, Types::Int16

#type ⇒ Integer

Returns 8-bit Packet Type.

Returns:

  • (Integer) —

    8-bit Packet Type



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

define_field :type, Types::Int8Enum, enum: TYPES

#version ⇒ Integer

Returns 8-bit Protocol Version.

Returns:

  • (Integer) —

    8-bit Protocol Version



39
 
# File 'lib/packetgen/header/dot1x.rb', line 39

define_field :version, Types::Int8, default: 1

Instance Method Details

#calc_length ⇒ Integer

Calculate and set body length

Returns:

  • (Integer)

Since:

  • 2.1.4



72
73
74
 
# File 'lib/packetgen/header/dot1x.rb', line 72

def calc_length
  Base.calculate_and_set_length self, header_in_size: false
end

#human_type ⇒ String

Get human readable type

Returns:

  • (String)

Since:

  • 1.4.0



65
66
67
 
# File 'lib/packetgen/header/dot1x.rb', line 65

def human_type
  self[:type].to_human
end

#read(str) ⇒ self

Populate object from string

Parameters:

  • str (String)

Returns:

  • (self)

Since:

  • 1.4.0



53
54
55
56
57
58
59
60
61
 
# File 'lib/packetgen/header/dot1x.rb', line 53

def read(str)
  return self if str.nil?

  self[:version].read(str[0, 1])
  self[:type].read(str[1, 1])
  self[:length].read(str[2, 2])
  self[:body].read(str[4, self.length])
  self
end