Class: Metasploit::Aggregator::Tlv::Tlv

Inherits:
Object
  • Object
show all
Defined in:
lib/metasploit/aggregator/tlv/packet.rb

Overview

Base TLV (Type-Length-Value) class

Direct Known Subclasses

GroupTlv

Constant Summary collapse

HEADER_SIZE = 
8

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, value = nil, compress = false) ⇒ Tlv

Returns an instance of a TLV.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 171

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.



158
159
160
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 158

def compress
  @compress
end

#type ⇒ Object

Returns the value of attribute type.



158
159
160
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 158

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



158
159
160
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 158

def value
  @value
end

Instance Method Details

#from_r(raw) ⇒ Object

Translates the raw format of the TLV into a sanitize version.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 301

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 original, allowing for transparent data compression.
    self.type = self.type ^ TLV_META_TYPE_COMPRESSED
    # decompress the compressed data (skipping the length and type DWORD's)

    # disable raw_decompression for now - not needed by aggregator at this time
    # 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

#inspect ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 188

def inspect
  utype = type ^ TLV_META_TYPE_COMPRESSED
  group = false
  meta = 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 = "unknown-#{type}"
  Metasploit::Aggregator::Tlv.constants.each do |value|
    next unless Metasploit::Aggregator::Tlv.const_get(value) == type
    stype = value.to_s
    break
  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=#{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.

Returns:

  • (Boolean) 


233
234
235
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 233

def meta_type?(meta)
  return (self.type & meta == meta)
end

#to_r ⇒ Object

Converts the TLV to raw.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 260

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.

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 240

def type?(type)
  return self.type == type
end

#value?(value) ⇒ Boolean

Checks to see if the TLVs value is equivalent to the value passed.

Returns:

  • (Boolean) 


247
248
249
 
# File 'lib/metasploit/aggregator/tlv/packet.rb', line 247

def value?(value)
  return self.value == value
end