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

Instance Attribute Summary collapse

Attributes inherited from Tlv

#compress, #type, #value

Instance Method Summary collapse

Methods inherited from Tlv

#inspect, #meta_type?, #type?, #value?

Constructor Details

#initialize(type) ⇒ GroupTlv

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



346
347
348
349
350
 
# File 'lib/rex/post/meterpreter/packet.rb', line 346

def initialize(type)
	super(type)

	self.tlvs = [ ]
end

Instance Attribute Details

#tlvs ⇒ Object

Returns the value of attribute tlvs.



334
335
336
 
# File 'lib/rex/post/meterpreter/packet.rb', line 334

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.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/rex/post/meterpreter/packet.rb', line 414

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

	return tlv
end

#add_tlvs(tlvs) ⇒ Object

Adds zero or more TLVs to the packet.



439
440
441
442
443
444
445
 
# File 'lib/rex/post/meterpreter/packet.rb', line 439

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

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

Enumerates TLVs of the supplied type.



361
362
363
 
# File 'lib/rex/post/meterpreter/packet.rb', line 361

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

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

Synonym for each.



368
369
370
 
# File 'lib/rex/post/meterpreter/packet.rb', line 368

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.



382
383
384
 
# File 'lib/rex/post/meterpreter/packet.rb', line 382

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.



375
376
377
 
# File 'lib/rex/post/meterpreter/packet.rb', line 375

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.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/rex/post/meterpreter/packet.rb', line 514

def from_r(raw)
	offset = 8

	# 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+8].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.



450
451
452
453
454
455
456
457
458
 
# File 'lib/rex/post/meterpreter/packet.rb', line 450

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

	if (type_tlvs.length > index)
		return type_tlvs[index]
	end

	return nil
end

#get_tlv_value(type, index = 0) ⇒ Object

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



463
464
465
466
467
 
# File 'lib/rex/post/meterpreter/packet.rb', line 463

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

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

#get_tlv_values(type) ⇒ Object

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



472
473
474
 
# File 'lib/rex/post/meterpreter/packet.rb', line 472

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.



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/rex/post/meterpreter/packet.rb', line 389

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

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

		return type_tlvs
	end
end

#has_tlv?(type) ⇒ Boolean

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

Returns:

  • (Boolean) 


479
480
481
 
# File 'lib/rex/post/meterpreter/packet.rb', line 479

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

#reset ⇒ Object

Zeros out the array of TLVs.



486
487
488
 
# File 'lib/rex/post/meterpreter/packet.rb', line 486

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.



500
501
502
503
504
505
506
507
508
 
# File 'lib/rex/post/meterpreter/packet.rb', line 500

def to_r
	raw = ''

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

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