Class: Msf::Serializer::ReadableText

Inherits:
Object
  • Object
show all
Defined in:
lib/msf/base/serializer/readable_text.rb

Overview

This class formats information in a plain-text format that is meant to be displayed on a console or some other non-GUI medium.

Constant Summary collapse

DefaultColumnWrap =

Default number of characters to wrap at.

70
DefaultIndent =

Default number of characters to indent.

2

Class Method Summary collapse

Class Method Details

.create_mdm_session_row(session, show_extended) ⇒ Array

Creates a table row that represents the specified session.

Parameters:

  • session (Mdm::Session)

    session used to create a table row.

  • show_extended (Boolean)

    Indicates if extended information will be included in the row.

Returns:

  • (Array)

    table row of session data.


865
866
867
868
869
870
871
872
873
874
875
876
877
878
# File 'lib/msf/base/serializer/readable_text.rb', line 865

def self.create_mdm_session_row(session, show_extended)
  row = []
  row << session.closed_at.to_s
  row << session.opened_at.to_s
  row << session.close_reason
  row << session.stype
  if session.respond_to?(:platform) && !session.platform.nil?
    row[-1] << " #{session.platform}"
  end
  row << (!session.host.nil? ? session.host.address : nil)

  # return complete row
  row
end

.create_msf_session_row(session, show_extended) ⇒ Array

Creates a table row that represents the specified session.

Parameters:

  • session (Msf::Session)

    session used to create a table row.

  • show_extended (Boolean)

    Indicates if extended information will be included in the row.

Returns:

  • (Array)

    table row of session data.


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
# File 'lib/msf/base/serializer/readable_text.rb', line 816

def self.create_msf_session_row(session, show_extended)
  row = []
  row << session.sid.to_s
  row << session.sname.to_s
  row << session.type.to_s
  if session.respond_to?(:session_type)
    row[-1] << " #{session.session_type}"
  elsif session.respond_to?(:platform)
    row[-1] << " #{session.platform}"
  end

  if show_extended
    if session.respond_to?(:last_checkin) && session.last_checkin
      row << "#{(Time.now.to_i - session.last_checkin.to_i)}s ago"
    else
      row << '?'
    end

    if session.respond_to?(:tlv_enc_key) && session.tlv_enc_key && session.tlv_enc_key[:key]
      row << 'Y'
    else
      row << 'N'
    end

    if session.exploit_datastore && session.exploit_datastore.has_key?('LURI') && !session.exploit_datastore['LURI'].empty?
      row << "(#{session.exploit_datastore['LURI']})"
    else
      row << '?'
    end
  end

  sinfo = session.info.to_s
  # Arbitrarily cut info at 80 columns
  if sinfo.length > 80
    sinfo = "#{sinfo[0,77]}..."
  end
  row << sinfo

  row << "#{session.tunnel_to_s} (#{session.session_host})"

  # return complete row
  row
end

.dump_advanced_options(mod, indent = '') ⇒ String

Dumps the advanced options associated with the supplied module.

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
# File 'lib/msf/base/serializer/readable_text.rb', line 593

def self.dump_advanced_options(mod, indent = '')
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Columns' =>
      [
        'Name',
        'Current Setting',
        'Required',
        'Description'
      ])

  mod.options.sorted.each do |name, opt|
    next unless opt.advanced?
    next unless Msf::OptCondition.show_option(mod, opt)
    val = mod.datastore[name].nil? ? opt.default : mod.datastore[name]
    tbl << [ name, opt.display_value(val), opt.required? ? "yes" : "no", opt.desc ]
  end

  return tbl.to_s
end

.dump_auxiliary_module(mod, indent = '') ⇒ String

Dumps information about an auxiliary module.

Parameters:

  • mod (Msf::Auxiliary)

    the auxiliary module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


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
349
350
351
352
# File 'lib/msf/base/serializer/readable_text.rb', line 304

def self.dump_auxiliary_module(mod, indent = '')
  output  = "\n"
  output << "       Name: #{mod.name}\n"
  output << "     Module: #{mod.fullname}\n"
  output << "    License: #{mod.license}\n"
  output << "       Rank: #{mod.rank_to_s.capitalize}\n"
  output << "  Disclosed: #{mod.disclosure_date}\n" if mod.disclosure_date
  output << "\n"

  # Authors
  output << "Provided by:\n"
  mod.each_author { |author|
    output << indent + author.to_s + "\n"
  }
  output << "\n"

  output << dump_traits(mod)

  # Actions
  if mod.action
    output << "Available actions:\n"
    output << dump_module_actions(mod, indent)
  end

  # Check
  has_check = mod.has_check?
  output << "Check supported:\n"
  output << "#{indent}#{has_check ? 'Yes' : 'No'}\n\n"

  # Options
  if (mod.options.has_options?)
    output << "Basic options:\n"
    output << dump_options(mod, indent)
    output << "\n"
  end

  # Description
  output << "Description:\n"
  output << word_wrap(Rex::Text.compress(mod.description))
  output << "\n"

  # References
  output << dump_references(mod, indent)

  # Notes
  output << dump_notes(mod, indent)

  return output
end

.dump_basic_module(mod, indent = '') ⇒ String

Dumps information about a module, just the basics.

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'lib/msf/base/serializer/readable_text.rb', line 504

def self.dump_basic_module(mod, indent = '')
  # General
  output  = "\n"
  output << "       Name: #{mod.name}\n"
  output << "     Module: #{mod.fullname}\n"
  output << "   Platform: #{mod.platform_to_s}\n"
  output << "       Arch: #{mod.arch_to_s}\n"
  output << "       Rank: #{mod.rank_to_s.capitalize}\n"
  output << "\n"

  # Authors
  output << "Provided by:\n"
  mod.each_author { |author|
    output << indent + author.to_s + "\n"
  }
  output << "\n"

  output << dump_traits(mod)

  # Description
  output << "Description:\n"
  output << word_wrap(Rex::Text.compress(mod.description))
  output << "\n"

  output << dump_references(mod, indent)

  output << "\n"

  return output

end

.dump_compatible_payloads(exploit, indent = '', h = nil) ⇒ String

Dumps the table of payloads that are compatible with the supplied exploit.

Parameters:

  • exploit (Msf::Exploit)

    the exploit module.

  • indent (String) (defaults to: '')

    the indentation to use (only the length matters)

  • h (String) (defaults to: nil)

    the string to display as the table heading.

Returns:

  • (String)

    the string form of the table.


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/msf/base/serializer/readable_text.rb', line 184

def self.dump_compatible_payloads(exploit, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Name',
        'Description',
      ])

  exploit.compatible_payloads.each { |entry|
    tbl << [ entry[0], entry[1].new.description ]
  }

  tbl.to_s + "\n"
end

.dump_datastore(name, ds, indent = DefaultIndent, col = DefaultColumnWrap) ⇒ String

Dumps the contents of a datastore.

Parameters:

  • name (String)

    displayed as the table header.

  • ds (Msf::DataStore)

    the DataStore to dump.

  • indent (Integer) (defaults to: DefaultIndent)

    the indentation size.

  • col (Integer) (defaults to: DefaultColumnWrap)

    the column width.

Returns:

  • (String)

    the formatted DataStore contents.


717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
# File 'lib/msf/base/serializer/readable_text.rb', line 717

def self.dump_datastore(name, ds, indent = DefaultIndent, col = DefaultColumnWrap)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent,
    'Header'  => name,
    'Columns' =>
      [
        'Name',
        'Value'
      ])

  ds.keys.sort.each { |k|
    tbl << [ k, (ds[k] != nil) ? ds[k].to_s : '' ]
  }

  return ds.length > 0 ? tbl.to_s : "#{tbl.header_to_s}No entries in data store.\n"
end

.dump_evasion_module(mod, indent = '') ⇒ String

Dumps information about an evasion module.

Parameters:

  • mod (Msf::Evasion)

    The evasion module instance.

  • indent (String) (defaults to: '')

    The indentation to use.

Returns:

  • (String)

    The string form of the information


419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
# File 'lib/msf/base/serializer/readable_text.rb', line 419

def self.dump_evasion_module(mod, indent = '')
  output  = "\n"
  output << "       Name: #{mod.name}\n"
  output << "     Module: #{mod.fullname}\n"
  output << "   Platform: #{mod.platform_to_s}\n"
  output << "       Arch: #{mod.arch_to_s}\n"
  output << " Privileged: " + (mod.privileged? ? "Yes" : "No") + "\n"
  output << "    License: #{mod.license}\n"
  output << "       Rank: #{mod.rank_to_s.capitalize}\n"
  output << "  Disclosed: #{mod.disclosure_date}\n" if mod.disclosure_date
  output << "\n"

  # Authors
  output << "Provided by:\n"
  mod.each_author { |author|
    output << indent + author.to_s + "\n"
  }
  output << "\n"

  # Check
  output << "Check supported:\n"
  output << "#{indent}#{mod.has_check? ? 'Yes' : 'No'}\n\n"

  # Options
  if (mod.options.has_options?)
    output << "Basic options:\n"
    output << dump_options(mod, indent)
    output << "\n"
  end

  # Description
  output << "Description:\n"
  output << word_wrap(Rex::Text.compress(mod.description))
  output << "\n"

  # References
  output << dump_references(mod, indent)

  return output
end

.dump_evasion_options(mod, indent = '') ⇒ String

Dumps the evasion options associated with the supplied module.

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'lib/msf/base/serializer/readable_text.rb', line 619

def self.dump_evasion_options(mod, indent = '')
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Columns' =>
      [
        'Name',
        'Current Setting',
        'Required',
        'Description'
      ])

  mod.options.sorted.each do |name, opt|
    next unless opt.evasion?
    val = mod.datastore[name].nil? ? opt.default : mod.datastore[name]
    tbl << [ name, opt.display_value(val), opt.required? ? "yes" : "no", opt.desc ]
  end

  return tbl.to_s
end

.dump_evasion_target(mod, indent = '', h = nil) ⇒ String

Dumps the evasion module's selected target

Parameters:

  • mod (Msf::Evasion)

    The evasion module.

  • indent (String) (defaults to: '')

    The indentation to use (only the length matters)

  • h (String) (defaults to: nil)

    The string to display as the table heading.

Returns:

  • (String)

    The strong form of the table.


115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/msf/base/serializer/readable_text.rb', line 115

def self.dump_evasion_target(mod, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Id',
        'Name',
      ])

  tbl << [ mod.target_index, mod.target.name || 'All' ]

  tbl.to_s + "\n"
end

.dump_evasion_targets(mod, indent = '', h = nil) ⇒ Object


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/msf/base/serializer/readable_text.rb', line 70

def self.dump_evasion_targets(mod, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Id',
        'Name',
      ])

  mod.targets.each_with_index { |target, idx|
    tbl << [ idx.to_s, target.name || 'All' ]
  }

  tbl.to_s + "\n"
end

.dump_exploit_module(mod, indent = '') ⇒ String

Dumps information about an exploit module.

Parameters:

  • mod (Msf::Exploit)

    the exploit module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
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
297
# File 'lib/msf/base/serializer/readable_text.rb', line 236

def self.dump_exploit_module(mod, indent = '')
  output  = "\n"
  output << "       Name: #{mod.name}\n"
  output << "     Module: #{mod.fullname}\n"
  output << "   Platform: #{mod.platform_to_s}\n"
  output << "       Arch: #{mod.arch_to_s}\n"
  output << " Privileged: " + (mod.privileged? ? "Yes" : "No") + "\n"
  output << "    License: #{mod.license}\n"
  output << "       Rank: #{mod.rank_to_s.capitalize}\n"
  output << "  Disclosed: #{mod.disclosure_date}\n" if mod.disclosure_date
  output << "\n"

  # Authors
  output << "Provided by:\n"
  mod.each_author { |author|
    output << indent + author.to_s + "\n"
  }
  output << "\n"

  output << dump_traits(mod)

  # Targets
  output << "Available targets:\n"
  output << dump_exploit_targets(mod, indent)

  # Check
  output << "Check supported:\n"
  output << "#{indent}#{mod.has_check? ? 'Yes' : 'No'}\n\n"

  # Options
  if (mod.options.has_options?)
    output << "Basic options:\n"
    output << dump_options(mod, indent)
    output << "\n"
  end

  # Payload information
  if (mod.payload_info.length)
    output << "Payload information:\n"
    if (mod.payload_space)
      output << indent + "Space: " + mod.payload_space.to_s + "\n"
    end
    if (mod.payload_badchars)
      output << indent + "Avoid: " + mod.payload_badchars.length.to_s + " characters\n"
    end
    output << "\n"
  end

  # Description
  output << "Description:\n"
  output << word_wrap(Rex::Text.compress(mod.description))
  output << "\n"

  # References
  output << dump_references(mod, indent)

  # Notes
  output << dump_notes(mod, indent)

  return output

end

.dump_exploit_target(mod, indent = '', h = nil) ⇒ String

Dumps the exploit's selected target

Parameters:

  • mod (Msf::Exploit)

    the exploit module.

  • indent (String) (defaults to: '')

    the indentation to use (only the length matters)

  • h (String) (defaults to: nil)

    the string to display as the table heading.

Returns:

  • (String)

    the string form of the table.


94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/msf/base/serializer/readable_text.rb', line 94

def self.dump_exploit_target(mod, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Id',
        'Name',
      ])

  tbl << [ mod.target_index, mod.target.name || 'All' ]

  tbl.to_s + "\n"
end

.dump_exploit_targets(mod, indent = '', h = nil) ⇒ String

Dumps an exploit's targets.

Parameters:

  • mod (Msf::Exploit)

    the exploit module to dump targets for.

  • indent (String) (defaults to: '')

    the indentation to use (only the length matters).

  • h (String) (defaults to: nil)

    the string to display as the table heading.

Returns:

  • (String)

    the string form of the table.


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/msf/base/serializer/readable_text.rb', line 53

def self.dump_exploit_targets(mod, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Id',
        'Name',
      ])

  mod.targets.each_with_index { |target, idx|
    tbl << [ idx.to_s, target.name || 'All' ]
  }

  tbl.to_s + "\n"
end

.dump_generic_module(mod, indent = '') ⇒ Object

No current use


537
538
# File 'lib/msf/base/serializer/readable_text.rb', line 537

def self.dump_generic_module(mod, indent = '')
end

.dump_jobs(framework, verbose = false, indent = DefaultIndent, col = DefaultColumnWrap) ⇒ String

Dumps the list of running jobs.

Parameters:

  • framework (Msf::Framework)

    the framework.

  • verbose (Boolean) (defaults to: false)

    if true, also prints the payload, LPORT, URIPATH and start time, if they exist, for each job.

  • indent (Integer) (defaults to: DefaultIndent)

    the indentation amount.

  • col (Integer) (defaults to: DefaultColumnWrap)

    the column wrap width.

Returns:

  • (String)

    the formatted list of running jobs.


957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'lib/msf/base/serializer/readable_text.rb', line 957

def self.dump_jobs(framework, verbose = false, indent = DefaultIndent, col = DefaultColumnWrap)
  columns = [ 'Id', 'Name', "Payload", "Payload opts"]

  if (verbose)
    columns += [ "URIPATH", "Start Time", "Handler opts", "Persist" ]
  end

  tbl = Rex::Text::Table.new(
    'Indent'  => indent,
    'Header'  => "Jobs",
    'Columns' => columns
    )

  # Get the persistent job info.
  if verbose
    begin
      persist_list = JSON.parse(File.read(Msf::Config.persist_file))
    rescue Errno::ENOENT, JSON::ParserError
      persist_list = []
    end
  end

  # jobs are stored as a hash with the keys being a numeric String job_id.
  framework.jobs.keys.sort_by(&:to_i).each do |job_id|
    # Job context is stored as an Array with the 0th element being
    # the running module. If that module is an exploit, ctx will also
    # contain its payload.
    exploit_mod, _payload_mod = framework.jobs[job_id].ctx
    row = []
    row[0] = job_id
    row[1] = framework.jobs[job_id].name

    pinst = exploit_mod.respond_to?(:payload_instance) ? exploit_mod.payload_instance : nil
    payload_uri = ''

    if pinst.nil?
      row[2] = ""
      row[3] = ""
    else
      row[2] = pinst.refname
      row[3] = ""
      if pinst.respond_to?(:payload_uri)
        payload_uri = pinst.payload_uri.strip
        row[3] << payload_uri
      end
      if pinst.respond_to?(:luri)
        row[3] << pinst.luri
      end
    end

    if verbose
      uripath = exploit_mod.get_resource if exploit_mod.respond_to?(:get_resource)
      uripath ||= exploit_mod.datastore['URIPATH']
      row[4] = uripath
      row[5] = framework.jobs[job_id].start_time
      row[6] = ''
      row[7] = 'false'

      if pinst.respond_to?(:listener_uri)
        listener_uri = pinst.listener_uri.strip
        row[6] = listener_uri unless listener_uri == payload_uri
      end

      persist_list.each do |e|
        if framework.jobs[job_id.to_s].ctx[1]
           row[7] = 'true' if e['mod_options']['Options'] == framework.jobs[job_id.to_s].ctx[1].datastore
        end
      end

    end
    tbl << row
  end

  return framework.jobs.keys.length > 0 ? tbl.to_s : "#{tbl.header_to_s}No active jobs.\n"
end

.dump_module(mod, indent = " ") ⇒ String

Returns a formatted string that contains information about the supplied module instance.

Parameters:

  • mod (Msf::Module)

    the module to dump information for.

  • indent (String) (defaults to: " ")

    the indentation to use.

Returns:

  • (String)

    formatted text output of the dump.


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/msf/base/serializer/readable_text.rb', line 24

def self.dump_module(mod, indent = "  ")
  case mod.type
    when Msf::MODULE_PAYLOAD
      return dump_payload_module(mod, indent)
    when Msf::MODULE_NOP
      return dump_basic_module(mod, indent)
    when Msf::MODULE_ENCODER
      return dump_basic_module(mod, indent)
    when Msf::MODULE_EXPLOIT
      return dump_exploit_module(mod, indent)
    when Msf::MODULE_AUX
      return dump_auxiliary_module(mod, indent)
    when Msf::MODULE_POST
      return dump_post_module(mod, indent)
    when Msf::MODULE_EVASION
      return dump_evasion_module(mod, indent)
    else
      return dump_generic_module(mod, indent)
  end
end

.dump_module_action(mod, indent = '', h = nil) ⇒ String

Dumps the module's selected action

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use (only the length matters)

  • h (String) (defaults to: nil)

    the string to display as the table heading.

Returns:

  • (String)

    the string form of the table.


161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/msf/base/serializer/readable_text.rb', line 161

def self.dump_module_action(mod, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Name',
        'Description',
      ])

  tbl << [ mod.action.name || 'All', mod.action.description || '' ]

  tbl.to_s + "\n"
end

.dump_module_actions(mod, indent = '', h = nil) ⇒ String

Dumps a module's actions

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use (only the length matters)

  • h (String) (defaults to: nil)

    the string to display as the table heading.

Returns:

  • (String)

    the string form of the table.


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/msf/base/serializer/readable_text.rb', line 137

def self.dump_module_actions(mod, indent = '', h = nil)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Header'  => h,
    'Columns' =>
      [
        'Name',
        'Description'
      ])

  mod.actions.each_with_index { |target, idx|
    tbl << [ target.name || 'All' , target.description || '' ]
  }

  tbl.to_s + "\n"
end

.dump_notes(mod, indent = '') ⇒ String

Dumps the notes associated with the supplied module.

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


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
# File 'lib/msf/base/serializer/readable_text.rb', line 671

def self.dump_notes(mod, indent = '')
  output = ''

  mod.notes.each do |name, val|
    next unless val.present?

    case name
    when 'AKA'
      output << "Also known as:\n"
      val.each { |aka| output << "#{indent}#{aka}\n" }
    when 'NOCVE'
      output << "CVE not available for the following reason:\n" \
                "#{indent}#{val}\n"
    when 'RelatedModules'
      output << "Related modules:\n"
      val.each { |related| output << "#{indent}#{related}\n" }
    when 'Stability', 'SideEffects', 'Reliability'
      # Handled by dump_traits
      next
    else
      output << "#{name}:\n"

      case val
      when Array
        val.each { |v| output << "#{indent}#{v}\n" }
      when Hash
        val.each { |k, v| output << "#{indent}#{k}: #{v}\n" }
      else
        # Display the raw note
        output << "#{indent}#{val}\n"
      end
    end

    output << "\n"
  end

  output
end

.dump_options(mod, indent = '', missing = false) ⇒ String

Dumps the list of options associated with the supplied module.

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use.

  • missing (Boolean) (defaults to: false)

    dump only empty required options.

Returns:

  • (String)

    the string form of the information.


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/msf/base/serializer/readable_text.rb', line 547

def self.dump_options(mod, indent = '', missing = false)
  tbl = Rex::Text::Table.new(
    'Indent'  => indent.length,
    'Columns' =>
      [
        'Name',
        'Current Setting',
        'Required',
        'Description'
      ])

  mod.options.sorted.each do |name, opt|
    val = mod.datastore[name].nil? ? opt.default : mod.datastore[name]

    next unless Msf::OptCondition.show_option(mod, opt)
    next if (opt.advanced?)
    next if (opt.evasion?)
    next if (missing && opt.valid?(val))

    desc = opt.desc.dup

    # Hint at RPORT proto by regexing mixins
    if name == 'RPORT' && opt.kind_of?(Msf::OptPort)
      mod.class.included_modules.each do |m|
        case m.name
        when /tcp/i, /HttpClient$/
          desc << ' (TCP)'
          break
        when /udp/i
          desc << ' (UDP)'
          break
        end
      end
    end

    tbl << [ name, opt.display_value(val), opt.required? ? "yes" : "no", desc ]
  end

  return tbl.to_s
end

.dump_payload_module(mod, indent = '') ⇒ String

Dumps information about a payload module.

Parameters:

  • mod (Msf::Payload)

    the payload module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
# File 'lib/msf/base/serializer/readable_text.rb', line 465

def self.dump_payload_module(mod, indent = '')
  # General
  output  = "\n"
  output << "       Name: #{mod.name}\n"
  output << "     Module: #{mod.fullname}\n"
  output << "   Platform: #{mod.platform_to_s}\n"
  output << "       Arch: #{mod.arch_to_s}\n"
  output << "Needs Admin: " + (mod.privileged? ? "Yes" : "No") + "\n"
  output << " Total size: #{mod.size}\n"
  output << "       Rank: #{mod.rank_to_s.capitalize}\n"
  output << "\n"

  # Authors
  output << "Provided by:\n"
  mod.each_author { |author|
    output << indent + author.to_s + "\n"
  }
  output << "\n"

  # Options
  if (mod.options.has_options?)
    output << "Basic options:\n"
    output << dump_options(mod)
    output << "\n"
  end

  # Description
  output << "Description:\n"
  output << word_wrap(Rex::Text.compress(mod.description))
  output << "\n\n"

  return output
end

.dump_post_module(mod, indent = '') ⇒ String

Dumps information about a post module.

Parameters:

  • mod (Msf::Post)

    the post module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/msf/base/serializer/readable_text.rb', line 359

def self.dump_post_module(mod, indent = '')
  output  = "\n"
  output << "       Name: #{mod.name}\n"
  output << "     Module: #{mod.fullname}\n"
  output << "   Platform: #{mod.platform_to_s}\n"
  output << "       Arch: #{mod.arch_to_s}\n"
  output << "       Rank: #{mod.rank_to_s.capitalize}\n"
  output << "  Disclosed: #{mod.disclosure_date}\n" if mod.disclosure_date
  output << "\n"

  # Authors
  output << "Provided by:\n"
  mod.each_author.each do |author|
    output << indent + author.to_s + "\n"
  end
  output << "\n"

  output << dump_traits(mod)

  # Compatible session types
  if mod.session_types
    output << "Compatible session types:\n"
    mod.session_types.sort.each do |type|
      output << indent + type.capitalize + "\n"
    end
    output << "\n"
  end

  # Actions
  if mod.action
    output << "Available actions:\n"
    output << dump_module_actions(mod, indent)
  end

  # Options
  if (mod.options.has_options?)
    output << "Basic options:\n"
    output << dump_options(mod, indent)
    output << "\n"
  end

  # Description
  output << "Description:\n"
  output << word_wrap(Rex::Text.compress(mod.description))
  output << "\n"

  # References
  output << dump_references(mod, indent)

  # Notes
  output << dump_notes(mod, indent)

  return output
end

.dump_references(mod, indent = '') ⇒ String

Dumps the references associated with the supplied module.

Parameters:

  • mod (Msf::Module)

    the module.

  • indent (String) (defaults to: '')

    the indentation to use.

Returns:

  • (String)

    the string form of the information.


644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
# File 'lib/msf/base/serializer/readable_text.rb', line 644

def self.dump_references(mod, indent = '')
  output = ''

  if (mod.respond_to?(:references) && mod.references && mod.references.length > 0)
    output << "References:\n"

    mod.references.each do |ref|
      case ref.ctx_id
      when 'LOGO', 'SOUNDTRACK'
        output << indent + ref.to_s + "\n"
        Rex::Compat.open_browser(ref.ctx_val) if Rex::Compat.getenv('FUEL_THE_HYPE_MACHINE')
      else
        output << indent + ref.to_s + "\n"
      end
    end

    output << "\n"
  end

  output
end

.dump_sessions(framework, opts = {}) ⇒ String

Dumps the list of sessions.

Parameters:

  • framework (Msf::Framework)

    the framework to dump.

  • opts (Hash) (defaults to: {})

    the options to dump with.

Options Hash (opts):

  • :verbose (Boolean)

    gives more information if set to true.

  • :indent (Integer)

    set the indentation amount.

Returns:

  • (String)

    the formatted list of sessions.


742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
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
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
# File 'lib/msf/base/serializer/readable_text.rb', line 742

def self.dump_sessions(framework, opts={})
  output = ""
  verbose = opts[:verbose] || false
  show_active = opts[:show_active] || false
  show_inactive = opts[:show_inactive] || false
  # if show_active and show_inactive are false the caller didn't
  # specify either flag; default to displaying active sessions
  show_active = true if !(show_active || show_inactive)
  show_extended = opts[:show_extended] || false
  indent = opts[:indent] || DefaultIndent

  return dump_sessions_verbose(framework, opts) if verbose

  if show_active
    columns = []
    columns << 'Id'
    columns << 'Name'
    columns << 'Type'
    columns << 'Checkin?' if show_extended
    columns << 'Enc?' if show_extended
    columns << 'Local URI' if show_extended
    columns << 'Information'
    columns << 'Connection'

    tbl = Rex::Text::Table.new(
        'Header' => "Active sessions",
        'Columns' => columns,
        'Indent' => indent)
    framework.sessions.each_sorted { |k|
      session = framework.sessions[k]
      row = create_msf_session_row(session, show_extended)
      tbl << row
    }

    output << (tbl.rows.count > 0 ? tbl.to_s : "#{tbl.header_to_s}No active sessions.\n")
  end

  if show_inactive
    output << "\n" if show_active

    columns = []
    columns << 'Closed'
    columns << 'Opened'
    columns << 'Reason Closed'
    columns << 'Type'
    columns << 'Address'

    tbl = Rex::Text::Table.new(
        'Header' => "Inactive sessions",
        'Columns' => columns,
        'Indent' => indent,
        'SortIndex' => 1)

    if framework.db.active
      framework.db.sessions.each do |session|
        unless session.closed_at.nil?
          row = create_mdm_session_row(session, show_extended)
          tbl << row
        end
      end
    end

    output << (tbl.rows.count > 0 ? tbl.to_s : "#{tbl.header_to_s}No inactive sessions.\n")
  end

  # return formatted listing of sessions
  output
end

.dump_sessions_verbose(framework, opts = {}) ⇒ String

Dumps the list of active sessions in verbose mode

Parameters:

  • framework (Msf::Framework)

    the framework to dump.

  • opts (Hash) (defaults to: {})

    the options to dump with.

Returns:

  • (String)

    the formatted list of sessions.


885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
# File 'lib/msf/base/serializer/readable_text.rb', line 885

def self.dump_sessions_verbose(framework, opts={})
  out = "Active sessions\n" +
        "===============\n\n"

  if framework.sessions.length == 0
    out << "No active sessions.\n"
    return out
  end

  framework.sessions.each_sorted do |k|
    session = framework.sessions[k]

    sess_info    = session.info.to_s
    sess_id      = session.sid.to_s
    sess_name    = session.sname.to_s
    sess_tunnel  = session.tunnel_to_s + " (#{session.session_host})"
    sess_via     = session.via_exploit.to_s
    sess_type    = session.type.to_s
    sess_uuid    = session.payload_uuid.to_s
    sess_luri    = session.exploit_datastore['LURI'] || "" if session.exploit_datastore
    sess_enc     = 'No'
    if session.respond_to?(:tlv_enc_key) && session.tlv_enc_key && session.tlv_enc_key[:key]
      sess_enc   = "Yes (AES-#{session.tlv_enc_key[:key].length * 8}-CBC)"
    end

    sess_checkin = "<none>"
    sess_registration = "No"

    if session.respond_to?(:platform) && session.platform
      sess_type << " #{session.platform}"
    end

    if session.respond_to?(:last_checkin) && session.last_checkin
      sess_checkin = "#{(Time.now.to_i - session.last_checkin.to_i)}s ago @ #{session.last_checkin.to_s}"
    end

    if !session.payload_uuid.nil? && session.payload_uuid.registered
      sess_registration = "Yes"
      if session.payload_uuid.name
        sess_registration << " - Name=\"#{session.payload_uuid.name}\""
      end
    end

    out << "  Session ID: #{sess_id}\n"
    out << "        Name: #{sess_name}\n"
    out << "        Type: #{sess_type}\n"
    out << "        Info: #{sess_info}\n"
    out << "      Tunnel: #{sess_tunnel}\n"
    out << "         Via: #{sess_via}\n"
    out << "   Encrypted: #{sess_enc}\n"
    out << "        UUID: #{sess_uuid}\n"
    out << "     CheckIn: #{sess_checkin}\n"
    out << "  Registered: #{sess_registration}\n"
    unless (sess_luri || '').empty?
      out << "        LURI: #{sess_luri}\n"
    end

    out << "\n"
  end

  out << "\n"
  return out
end

.dump_traits(mod, indent = ' ') ⇒ Object


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/msf/base/serializer/readable_text.rb', line 201

def self.dump_traits(mod, indent=' ')
  output = ''

  unless mod.side_effects.empty?
    output << "Module side effects:\n"
    mod.side_effects.each { |side_effect|
      output << indent + side_effect + "\n"
    }
    output << "\n"
  end

  unless mod.stability.empty?
    output << "Module stability:\n"
    mod.stability.each { |stability|
      output << indent + stability + "\n"
    }
    output << "\n"
  end

  unless mod.reliability.empty?
    output << "Module reliability:\n"
    mod.reliability.each { |reliability|
      output << indent + reliability + "\n"
    }
    output << "\n"
  end

  output
end

.word_wrap(str, indent = DefaultIndent, col = DefaultColumnWrap) ⇒ String

Jacked from Ernest Ellingson <erne [at] powernav.com>, modified a bit to add indention

Parameters:

  • str (String)

    the string to wrap.

  • indent (Integer) (defaults to: DefaultIndent)

    the indentation amount.

  • col (Integer) (defaults to: DefaultColumnWrap)

    the column wrap width.

Returns:

  • (String)

    the wrapped string.


1040
1041
1042
# File 'lib/msf/base/serializer/readable_text.rb', line 1040

def self.word_wrap(str, indent = DefaultIndent, col = DefaultColumnWrap)
  return Rex::Text.wordwrap(str, indent, col)
end