Class: Rex::Post::Meterpreter::Tlv
- Inherits:
-
Object
- Object
- Rex::Post::Meterpreter::Tlv
- Defined in:
- lib/rex/post/meterpreter/packet.rb
Overview
Base TLV (Type-Length-Value) class
Direct Known Subclasses
Constant Summary collapse
- HEADER_SIZE =
8
Instance Attribute Summary collapse
-
#compress ⇒ Object
Returns the value of attribute compress.
-
#type ⇒ Object
Returns the value of attribute type.
-
#value ⇒ Object
Returns the value of attribute value.
Instance Method Summary collapse
-
#from_r(raw) ⇒ Object
Translates the raw format of the TLV into a sanitize version.
- #htonq(value) ⇒ Object protected
-
#initialize(type, value = nil, compress = false) ⇒ Tlv
constructor
Returns an instance of a TLV.
- #inspect ⇒ Object
-
#meta_type?(meta) ⇒ Boolean
Checks to see if a TLVs meta type is equivalent to the meta type passed.
- #ntohq(value) ⇒ Object protected
-
#to_r ⇒ Object
Converts the TLV to raw.
-
#type?(type) ⇒ Boolean
Checks to see if the TLVs type is equivalent to the type passed.
-
#value?(value) ⇒ Boolean
Checks to see if the TLVs value is equivalent to the value passed.
Constructor Details
#initialize(type, value = nil, compress = false) ⇒ Tlv
Returns an instance of a TLV.
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'lib/rex/post/meterpreter/packet.rb', line 650 def initialize(type, value = nil, compress=false) @type = type @compress = compress if (value != nil) if (type & TLV_META_TYPE_STRING == TLV_META_TYPE_STRING) if (value.kind_of?(Integer)) @value = value.to_s else @value = value.dup end else @value = value end end end |
Instance Attribute Details
#compress ⇒ Object
Returns the value of attribute compress
637 638 639 |
# File 'lib/rex/post/meterpreter/packet.rb', line 637 def compress @compress end |
#type ⇒ Object
Returns the value of attribute type
637 638 639 |
# File 'lib/rex/post/meterpreter/packet.rb', line 637 def type @type end |
#value ⇒ Object
Returns the value of attribute value
637 638 639 |
# File 'lib/rex/post/meterpreter/packet.rb', line 637 def value @value end |
Instance Method Details
#from_r(raw) ⇒ Object
Translates the raw format of the TLV into a sanitize version.
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'lib/rex/post/meterpreter/packet.rb', line 838 def from_r(raw) self.value = nil length, self.type = raw.unpack("NN"); # check if the tlv value has been compressed... if( self.type & TLV_META_TYPE_COMPRESSED == TLV_META_TYPE_COMPRESSED ) # set this TLV as using compression @compress = true # remove the TLV_META_TYPE_COMPRESSED flag from the tlv type to restore the # tlv type to its origional, allowing for transparent data compression. self.type = self.type ^ TLV_META_TYPE_COMPRESSED # decompress the compressed data (skipping the length and type DWORD's) raw_decompressed = Rex::Text.zlib_inflate( raw[HEADER_SIZE..length-1] ) # update the length to reflect the decompressed data length (+HEADER_SIZE for the length and type DWORD's) length = raw_decompressed.length + HEADER_SIZE # update the raw buffer with the new length, decompressed data and updated type. raw = [length, self.type].pack("NN") + raw_decompressed end if (self.type & TLV_META_TYPE_STRING == TLV_META_TYPE_STRING) if (raw.length > 0) self.value = raw[HEADER_SIZE..length-2] else self.value = nil end elsif (self.type & TLV_META_TYPE_UINT == TLV_META_TYPE_UINT) self.value = raw.unpack("NNN")[2] elsif (self.type & TLV_META_TYPE_QWORD == TLV_META_TYPE_QWORD) self.value = raw.unpack("NNQ<")[2] self.value = self.ntohq( self.value ) elsif (self.type & TLV_META_TYPE_BOOL == TLV_META_TYPE_BOOL) self.value = raw.unpack("NNc")[2] if (self.value == 1) self.value = true else self.value = false end else self.value = raw[HEADER_SIZE..length-1] end length end |
#htonq(value) ⇒ Object (protected)
886 887 888 889 890 891 892 |
# File 'lib/rex/post/meterpreter/packet.rb', line 886 def htonq(value) if [1].pack( 's' ) == [1].pack('n') return value else [value].pack('Q<').reverse.unpack('Q<').first end end |
#inspect ⇒ Object
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 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 748 749 750 751 752 753 754 755 756 757 758 759 |
# File 'lib/rex/post/meterpreter/packet.rb', line 667 def inspect utype = type ^ TLV_META_TYPE_COMPRESSED group = false = case (utype & TLV_META_MASK) when TLV_META_TYPE_STRING; "STRING" when TLV_META_TYPE_UINT; "INT" when TLV_META_TYPE_RAW; "RAW" when TLV_META_TYPE_BOOL; "BOOL" when TLV_META_TYPE_QWORD; "QWORD" when TLV_META_TYPE_GROUP; group=true; "GROUP" when TLV_META_TYPE_COMPLEX; "COMPLEX" else; 'unknown-meta-type' end stype = case type when PACKET_TYPE_REQUEST; "Request" when PACKET_TYPE_RESPONSE; "Response" when TLV_TYPE_REQUEST_ID; "REQUEST-ID" when TLV_TYPE_COMMAND_ID; "COMMAND-ID" when TLV_TYPE_RESULT; "RESULT" when TLV_TYPE_EXCEPTION; "EXCEPTION" when TLV_TYPE_STRING; "STRING" when TLV_TYPE_UINT; "UINT" when TLV_TYPE_BOOL; "BOOL" when TLV_TYPE_LENGTH; "LENGTH" when TLV_TYPE_DATA; "DATA" when TLV_TYPE_FLAGS; "FLAGS" when TLV_TYPE_CHANNEL_ID; "CHANNEL-ID" when TLV_TYPE_CHANNEL_TYPE; "CHANNEL-TYPE" when TLV_TYPE_CHANNEL_DATA; "CHANNEL-DATA" when TLV_TYPE_CHANNEL_DATA_GROUP; "CHANNEL-DATA-GROUP" when TLV_TYPE_CHANNEL_CLASS; "CHANNEL-CLASS" when TLV_TYPE_CHANNEL_PARENTID; "CHANNEL-PARENTID" when TLV_TYPE_SEEK_WHENCE; "SEEK-WHENCE" when TLV_TYPE_SEEK_OFFSET; "SEEK-OFFSET" when TLV_TYPE_SEEK_POS; "SEEK-POS" when TLV_TYPE_EXCEPTION_CODE; "EXCEPTION-CODE" when TLV_TYPE_EXCEPTION_STRING; "EXCEPTION-STRING" when TLV_TYPE_LIBRARY_PATH; "LIBRARY-PATH" when TLV_TYPE_TARGET_PATH; "TARGET-PATH" when TLV_TYPE_MIGRATE_PID; "MIGRATE-PID" when TLV_TYPE_MIGRATE_PAYLOAD; "MIGRATE-PAYLOAD" when TLV_TYPE_MIGRATE_ARCH; "MIGRATE-ARCH" when TLV_TYPE_MIGRATE_BASE_ADDR; "MIGRATE-BASE-ADDR" when TLV_TYPE_MIGRATE_ENTRY_POINT; "MIGRATE-ENTRY-POINT" when TLV_TYPE_MIGRATE_STUB; "MIGRATE-STUB" when TLV_TYPE_MIGRATE_SOCKET_PATH; "MIGRATE-SOCKET-PATH" when TLV_TYPE_LIB_LOADER_NAME; "LIB-LOADER-NAME" when TLV_TYPE_LIB_LOADER_ORDINAL; "LIB-LOADER-ORDINAL" when TLV_TYPE_TRANS_TYPE; "TRANS-TYPE" when TLV_TYPE_TRANS_URL; "TRANS-URL" when TLV_TYPE_TRANS_COMM_TIMEOUT; "TRANS-COMM-TIMEOUT" when TLV_TYPE_TRANS_SESSION_EXP; "TRANS-SESSION-EXP" when TLV_TYPE_TRANS_CERT_HASH; "TRANS-CERT-HASH" when TLV_TYPE_TRANS_PROXY_HOST; "TRANS-PROXY-HOST" when TLV_TYPE_TRANS_PROXY_USER; "TRANS-PROXY-USER" when TLV_TYPE_TRANS_PROXY_PASS; "TRANS-PROXY-PASS" when TLV_TYPE_TRANS_RETRY_TOTAL; "TRANS-RETRY-TOTAL" when TLV_TYPE_TRANS_RETRY_WAIT; "TRANS-RETRY-WAIT" when TLV_TYPE_MACHINE_ID; "MACHINE-ID" when TLV_TYPE_UUID; "UUID" when TLV_TYPE_SESSION_GUID; "SESSION-GUID" when TLV_TYPE_RSA_PUB_KEY; "RSA-PUB-KEY" when TLV_TYPE_SYM_KEY_TYPE; "SYM-KEY-TYPE" when TLV_TYPE_SYM_KEY; "SYM-KEY" when TLV_TYPE_ENC_SYM_KEY; "ENC-SYM-KEY" when TLV_TYPE_PIVOT_ID; "PIVOT-ID" when TLV_TYPE_PIVOT_STAGE_DATA; "PIVOT-STAGE-DATA" when TLV_TYPE_PIVOT_NAMED_PIPE_NAME; "PIVOT-NAMED-PIPE-NAME" else; "unknown-#{type}" end val = value.inspect if val.length > 50 val = val[0,50] + ' ..."' end group ||= (self.class.to_s =~ /Packet/) if group tlvs_inspect = "tlvs=[\n" @tlvs.each { |t| tlvs_inspect << " #{t.inspect}\n" } tlvs_inspect << "]" else tlvs_inspect = "meta=#{.ljust(10)} value=#{val}" end "#<#{self.class} type=#{stype.ljust(15)} #{tlvs_inspect}>" end |
#meta_type?(meta) ⇒ Boolean
Checks to see if a TLVs meta type is equivalent to the meta type passed.
770 771 772 |
# File 'lib/rex/post/meterpreter/packet.rb', line 770 def () return (self.type & == ) end |
#ntohq(value) ⇒ Object (protected)
894 895 896 |
# File 'lib/rex/post/meterpreter/packet.rb', line 894 def ntohq(value) htonq(value) end |
#to_r ⇒ Object
Converts the TLV to raw.
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 |
# File 'lib/rex/post/meterpreter/packet.rb', line 797 def to_r # Forcibly convert to ASCII-8BIT encoding raw = value.to_s.unpack("C*").pack("C*") if (self.type & TLV_META_TYPE_STRING == TLV_META_TYPE_STRING) raw += "\x00" elsif (self.type & TLV_META_TYPE_UINT == TLV_META_TYPE_UINT) raw = [value].pack("N") elsif (self.type & TLV_META_TYPE_QWORD == TLV_META_TYPE_QWORD) raw = [ self.htonq( value.to_i ) ].pack("Q<") elsif (self.type & TLV_META_TYPE_BOOL == TLV_META_TYPE_BOOL) if (value == true) raw = [1].pack("c") else raw = [0].pack("c") end end # check if the tlv is to be compressed... if @compress raw_uncompressed = raw # compress the raw data raw_compressed = Rex::Text.zlib_deflate( raw_uncompressed ) # check we have actually made the raw data smaller... # (small blobs often compress slightly larger then the origional) # if the compressed data is not smaller, we dont use the compressed data if( raw_compressed.length < raw_uncompressed.length ) # if so, set the TLV's type to indicate compression is used self.type = self.type | TLV_META_TYPE_COMPRESSED # update the raw data with the uncompressed data length + compressed data # (we include the uncompressed data length as the C side will need to know this for decompression) raw = [ raw_uncompressed.length ].pack("N") + raw_compressed end end [raw.length + HEADER_SIZE, self.type].pack("NN") + raw end |
#type?(type) ⇒ Boolean
Checks to see if the TLVs type is equivalent to the type passed.
777 778 779 |
# File 'lib/rex/post/meterpreter/packet.rb', line 777 def type?(type) return self.type == type end |
#value?(value) ⇒ Boolean
Checks to see if the TLVs value is equivalent to the value passed.
784 785 786 |
# File 'lib/rex/post/meterpreter/packet.rb', line 784 def value?(value) return self.value == value end |