Class: Rex::Post::Meterpreter::GroupTlv
- Defined in:
- lib/rex/post/meterpreter/packet.rb
Overview
Group TLVs contain zero or more TLVs
Direct Known Subclasses
Instance Attribute Summary collapse
-
#tlvs ⇒ Object
Returns the value of attribute tlvs.
Attributes inherited from Tlv
Instance Method Summary collapse
-
#add_tlv(type, value = nil, replace = false, compress = false) ⇒ Object
Adds a TLV of a given type and value.
-
#add_tlvs(tlvs) ⇒ Object
Adds zero or more TLVs to the packet.
-
#each(type = TLV_TYPE_ANY, &block) ⇒ Object
Enumerates TLVs of the supplied type.
-
#each_tlv(type = TLV_TYPE_ANY, &block) ⇒ Object
Synonym for each.
-
#each_tlv_with_index(type = TLV_TYPE_ANY, &block) ⇒ Object
Synonym for each_with_index.
-
#each_with_index(type = TLV_TYPE_ANY, &block) ⇒ Object
Enumerates TLVs of a supplied type with indexes.
-
#from_r(raw) ⇒ Object
Converts the TLV group container from raw to all of the individual TLVs.
-
#get_tlv(type, index = 0) ⇒ Object
Gets the first TLV of a given type.
-
#get_tlv_value(type, index = 0) ⇒ Object
Returns the value of a TLV if it exists, otherwise nil.
-
#get_tlv_values(type) ⇒ Object
Returns an array of values for all tlvs of type type.
-
#get_tlvs(type) ⇒ Object
Returns an array of TLVs for the given type.
-
#has_tlv?(type) ⇒ Boolean
Checks to see if the container has a TLV of a given type.
-
#initialize(type) ⇒ GroupTlv
constructor
Initializes the group TLV container to the supplied type and creates an empty TLV array.
-
#reset ⇒ Object
Zeros out the array of TLVs.
-
#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.
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.
397 398 399 400 401 |
# File 'lib/rex/post/meterpreter/packet.rb', line 397 def initialize(type) super(type) self.tlvs = [ ] end |
Instance Attribute Details
#tlvs ⇒ Object
Returns the value of attribute tlvs.
385 386 387 |
# File 'lib/rex/post/meterpreter/packet.rb', line 385 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.
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
# File 'lib/rex/post/meterpreter/packet.rb', line 465 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.
490 491 492 493 494 495 496 |
# File 'lib/rex/post/meterpreter/packet.rb', line 490 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.
412 413 414 |
# File 'lib/rex/post/meterpreter/packet.rb', line 412 def each(type = TLV_TYPE_ANY, &block) get_tlvs(type).each(&block) end |
#each_tlv(type = TLV_TYPE_ANY, &block) ⇒ Object
Synonym for each.
419 420 421 |
# File 'lib/rex/post/meterpreter/packet.rb', line 419 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.
433 434 435 |
# File 'lib/rex/post/meterpreter/packet.rb', line 433 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.
426 427 428 |
# File 'lib/rex/post/meterpreter/packet.rb', line 426 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.
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/rex/post/meterpreter/packet.rb', line 565 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.
501 502 503 504 505 506 507 508 509 |
# File 'lib/rex/post/meterpreter/packet.rb', line 501 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.
514 515 516 517 518 |
# File 'lib/rex/post/meterpreter/packet.rb', line 514 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.
523 524 525 |
# File 'lib/rex/post/meterpreter/packet.rb', line 523 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.
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
# File 'lib/rex/post/meterpreter/packet.rb', line 440 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.
530 531 532 |
# File 'lib/rex/post/meterpreter/packet.rb', line 530 def has_tlv?(type) return get_tlv(type) != nil end |
#reset ⇒ Object
Zeros out the array of TLVs.
537 538 539 |
# File 'lib/rex/post/meterpreter/packet.rb', line 537 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.
551 552 553 554 555 556 557 558 559 |
# File 'lib/rex/post/meterpreter/packet.rb', line 551 def to_r raw = '' self.each() { |tlv| raw << tlv.to_r } return [raw.length + 8, self.type].pack("NN") + raw end |