Class: Rex::Post::Meterpreter::GroupTlv

Inherits:
Tlv
  • Object
show all
Defined in:
lib/rex/post/meterpreter/packet.rb

Overview

Group TLVs contain zero or more TLVs

Direct Known Subclasses

Packet

Constant Summary

Constants inherited from Tlv

Tlv::HEADER_SIZE

Instance Attribute Summary collapse

Attributes inherited from Tlv

#compress, #type, #value

Instance Method Summary collapse

Methods inherited from Tlv

#_tlv_type_string, #htonq, #inspect, #meta_type?, #ntohq, #type?, #value?

Constructor Details

#initialize(type) ⇒ GroupTlv

Initializes the group TLV container to the supplied type and creates an empty TLV array.



549
550
551
552
553
 
# File 'lib/rex/post/meterpreter/packet.rb', line 549

def initialize(type)
  super(type)

  self.tlvs = []
end

Instance Attribute Details

#tlvs ⇒ Object

Returns the value of attribute tlvs.



537
538
539
 
# File 'lib/rex/post/meterpreter/packet.rb', line 537

def tlvs
  @tlvs
end

Instance Method Details

#add_tlv(type, value = nil, replace = false, compress = false) ⇒ Object

Adds a TLV of a given type and value.



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/rex/post/meterpreter/packet.rb', line 617

def add_tlv(type, value = nil, replace = false, compress=false)

  # If we should replace any TLVs with the same type...remove them first
  if replace
    each(type) { |tlv|
      if (tlv.type == type)
        self.tlvs.delete(tlv)
      end
    }
  end

  if (type & TLV_META_TYPE_GROUP == TLV_META_TYPE_GROUP)
    tlv = GroupTlv.new(type)
  else
    tlv = Tlv.new(type, value, compress)
  end

  self.tlvs << tlv

  tlv
end

#add_tlvs(tlvs) ⇒ Object

Adds zero or more TLVs to the packet.



642
643
644
645
646
647
648
 
# File 'lib/rex/post/meterpreter/packet.rb', line 642

def add_tlvs(tlvs)
  if tlvs
    tlvs.each { |tlv|
      add_tlv(tlv['type'], tlv['value'])
    }
  end
end

#each(type = TLV_TYPE_ANY, &block) ⇒ Object

Enumerates TLVs of the supplied type.



564
565
566
 
# File 'lib/rex/post/meterpreter/packet.rb', line 564

def each(type = TLV_TYPE_ANY, &block)
  get_tlvs(type).each(&block)
end

#each_tlv(type = TLV_TYPE_ANY, &block) ⇒ Object

Synonym for each.



571
572
573
 
# File 'lib/rex/post/meterpreter/packet.rb', line 571

def each_tlv(type = TLV_TYPE_ANY, &block)
  each(type, &block)
end

#each_tlv_with_index(type = TLV_TYPE_ANY, &block) ⇒ Object

Synonym for each_with_index.



585
586
587
 
# File 'lib/rex/post/meterpreter/packet.rb', line 585

def each_tlv_with_index(type = TLV_TYPE_ANY, &block)
  each_with_index(type, block)
end

#each_with_index(type = TLV_TYPE_ANY, &block) ⇒ Object

Enumerates TLVs of a supplied type with indexes.



578
579
580
 
# File 'lib/rex/post/meterpreter/packet.rb', line 578

def each_with_index(type = TLV_TYPE_ANY, &block)
  get_tlvs(type).each_with_index(&block)
end

#from_r(raw) ⇒ Object

Converts the TLV group container from raw to all of the individual TLVs.



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/rex/post/meterpreter/packet.rb', line 718

def from_r(raw)
  offset = HEADER_SIZE

  # Reset the TLVs array
  self.tlvs = []
  self.type = raw.unpack("NN")[1]

  # Enumerate all of the TLVs
  while offset < raw.length-1

    tlv = nil

    # Get the length and type
    length, type = raw[offset..offset+HEADER_SIZE].unpack("NN")

    if (type & TLV_META_TYPE_GROUP == TLV_META_TYPE_GROUP)
      tlv = GroupTlv.new(type)
    else
      tlv = Tlv.new(type)
    end

    tlv.from_r(raw[offset..offset+length])

    # Insert it into the list of TLVs
    tlvs << tlv

    # Move up
    offset += length
  end
end

#get_tlv(type, index = 0) ⇒ Object

Gets the first TLV of a given type.



653
654
655
656
657
658
659
660
661
662
 
# File 'lib/rex/post/meterpreter/packet.rb', line 653

def get_tlv(type, index = 0)
  type_tlvs = get_tlvs(type)

  if type_tlvs.length > index
    type_tlvs[index]
  else
    nil
  end

end

#get_tlv_value(type, index = 0) ⇒ Object

Returns the value of a TLV if it exists, otherwise nil.



667
668
669
670
671
 
# File 'lib/rex/post/meterpreter/packet.rb', line 667

def get_tlv_value(type, index = 0)
  tlv = get_tlv(type, index)

  (tlv != nil) ? tlv.value : nil
end

#get_tlv_values(type) ⇒ Object

Returns an array of values for all tlvs of type type.



676
677
678
 
# File 'lib/rex/post/meterpreter/packet.rb', line 676

def get_tlv_values(type)
  get_tlvs(type).collect { |a| a.value }
end

#get_tlvs(type) ⇒ Object

Returns an array of TLVs for the given type.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/rex/post/meterpreter/packet.rb', line 592

def get_tlvs(type)
  if type == TLV_TYPE_ANY
    self.tlvs
  else
    type_tlvs = []

    self.tlvs.each() { |tlv|
      if (tlv.type?(type))
        type_tlvs << tlv
      end
    }

    type_tlvs
  end
end

#has_tlv?(type) ⇒ Boolean

Checks to see if the container has a TLV of a given type.

Returns:

  • (Boolean) 


683
684
685
 
# File 'lib/rex/post/meterpreter/packet.rb', line 683

def has_tlv?(type)
  get_tlv(type) != nil
end

#reset ⇒ Object

Zeros out the array of TLVs.



690
691
692
 
# File 'lib/rex/post/meterpreter/packet.rb', line 690

def reset
  self.tlvs = []
end

#to_r ⇒ Object

Converts all of the TLVs in the TLV array to raw and prefixes them with a container TLV of this instance's TLV type.



704
705
706
707
708
709
710
711
712
 
# File 'lib/rex/post/meterpreter/packet.rb', line 704

def to_r
  raw = ''

  self.each() { |tlv|
    raw << tlv.to_r
  }

  [raw.length + HEADER_SIZE, self.type].pack("NN") + raw
end