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.



589
590
591
592
593
 
# File 'lib/rex/post/meterpreter/packet.rb', line 589

def initialize(type)
  super(type)

  self.tlvs = []
end

Instance Attribute Details

#tlvs ⇒ Object

Returns the value of attribute tlvs.



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

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.



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/rex/post/meterpreter/packet.rb', line 657

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.



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

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.



604
605
606
 
# File 'lib/rex/post/meterpreter/packet.rb', line 604

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

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

Synonym for each.



611
612
613
 
# File 'lib/rex/post/meterpreter/packet.rb', line 611

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.



625
626
627
 
# File 'lib/rex/post/meterpreter/packet.rb', line 625

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.



618
619
620
 
# File 'lib/rex/post/meterpreter/packet.rb', line 618

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.



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/rex/post/meterpreter/packet.rb', line 758

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.



693
694
695
696
697
698
699
700
701
702
 
# File 'lib/rex/post/meterpreter/packet.rb', line 693

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.



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

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.



716
717
718
 
# File 'lib/rex/post/meterpreter/packet.rb', line 716

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.



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/rex/post/meterpreter/packet.rb', line 632

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) 


723
724
725
 
# File 'lib/rex/post/meterpreter/packet.rb', line 723

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

#reset ⇒ Object

Zeros out the array of TLVs.



730
731
732
 
# File 'lib/rex/post/meterpreter/packet.rb', line 730

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.



744
745
746
747
748
749
750
751
752
 
# File 'lib/rex/post/meterpreter/packet.rb', line 744

def to_r
  raw = ''

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

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