Class: PacketGen::Header::EAP::TTLS

Inherits:
PacketGen::Header::EAP show all
Defined in:
lib/packetgen/header/eap/ttls.rb

Overview

Extensible Authentication Protocol (EAP) - Tunneled-TLS, RFC 5281

TTLS has following fields:

Author:

  • Sylvain Daubert

Since:

  • 2.1.4

Direct Known Subclasses

FAST

Constant Summary

Constants inherited from PacketGen::Header::EAP

CODES, TYPES

Instance Attribute Summary collapse

Attributes inherited from PacketGen::Header::EAP

#body, #code, #id, #length, #type, #vendor_id, #vendor_type

Attributes inherited from Base

#packet

Instance Method Summary collapse

Methods inherited from PacketGen::Header::EAP

#added_to_packet, #calc_length, #desired_auth_type, #failure?, #has_type?, #human_code, #human_type, #old_read, #read, #reply!, #request?, #response?, #success?, #type?

Methods inherited from Base

#added_to_packet, bind, bind_header, calculate_and_set_length, #header_id, inherited, #ip_header, known_headers, #ll_header, #method_name, #parse?, #protocol_name, protocol_name

Methods inherited from Types::Fields

#[], #[]=, #body=, define_bit_fields_on, define_field, define_field_after, define_field_before, delete_field, #fields, #force_binary, inherited, #is_optional?, #is_present?, #offset_of, #optional_fields, #read, #sz, #to_h, #to_s

Constructor Details

#initialize(options = {}) ⇒ EAP::TTLS

Since:

  • 2.1.4



52
53
54
 
# File 'lib/packetgen/header/eap/ttls.rb', line 52

def initialize(options={})
  super({ type: 21 }.merge!(options))
end

Instance Attribute Details

#flags ⇒ Integer

Returns 8-bit flags.

Returns:

  • (Integer) —

    8-bit flags



23
 
# File 'lib/packetgen/header/eap/ttls.rb', line 23

define_field_before :body, :flags, Types::Int8

#l ⇒ Boolean

Say if length field is included. Defined on #flags field.

Returns:

  • (Boolean) 


38
 
# File 'lib/packetgen/header/eap/ttls.rb', line 38

define_bit_fields_on :flags, :l, :m, :s, :reserved, 2, :version, 3

#m ⇒ Boolean

Say if there are more fragments. Defined on #flags field.

Returns:

  • (Boolean) 


38
 
# File 'lib/packetgen/header/eap/ttls.rb', line 38

define_bit_fields_on :flags, :l, :m, :s, :reserved, 2, :version, 3

#message_length ⇒ Integer

Message length. This field provides the total length of the raw data message sequence prior to fragmentation. So, it cannot be automatically calculated (no #calc_length method).

Returns:

  • (Integer) —

    32-bit message length



48
49
 
# File 'lib/packetgen/header/eap/ttls.rb', line 48

define_field_before :body, :message_length, Types::Int32,
optional: ->(h) { h.l? }

#reserved ⇒ Integer

Returns 2-bit reserved integer.

Returns:

  • (Integer) —

    2-bit reserved integer



38
 
# File 'lib/packetgen/header/eap/ttls.rb', line 38

define_bit_fields_on :flags, :l, :m, :s, :reserved, 2, :version, 3

#s ⇒ Boolean

If set, this message is a TLS-Start. Defined on #flags field.

Returns:

  • (Boolean) 


38
 
# File 'lib/packetgen/header/eap/ttls.rb', line 38

define_bit_fields_on :flags, :l, :m, :s, :reserved, 2, :version, 3

#version ⇒ Integer

Returns 3-bit version.

Returns:

  • (Integer) —

    3-bit version



38
 
# File 'lib/packetgen/header/eap/ttls.rb', line 38

define_bit_fields_on :flags, :l, :m, :s, :reserved, 2, :version, 3

Instance Method Details

#inspect ⇒ String

Returns:

  • (String)

Since:

  • 2.1.4



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/packetgen/header/eap/ttls.rb', line 57

def inspect
  str = Inspect.dashed_line(self.class, 2)
  fields.each do |attr|
    next if attr == :body
    next unless is_present?(attr)
    if attr == :flags
      shift = Inspect.shift_level(2)
      value = i[l m s].map { |f| send("#{f}?") ? f.to_s : '.' }.join
      value = '%-10s (0x%02x)' % [value, self.flags]
      str << shift
      str << Inspect::FMT_ATTR % [self[attr].class.to_s.sub(/.*::/, ''),
                                  attr, value]
      str << Inspect::FMT_ATTR % ['', 'version', self.version]
    else
      str << Inspect.inspect_attribute(attr, self[attr], 2)
    end
  end
  str
end