Module: Rex::Ui::Text::Shell

Includes:
Text::Color
Included in:
DispatcherShell, PseudoShell
Defined in:
lib/rex/ui/text/shell.rb

Overview

The shell class provides a command-prompt style interface in a generic fashion.

Defined Under Namespace

Modules: InputShell

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cont_flag ⇒ Object (protected)

:nodoc:


487
488
489
 
# File 'lib/rex/ui/text/shell.rb', line 487

def cont_flag
  @cont_flag
end

#cont_prompt ⇒ Object (protected)

:nodoc:


482
483
484
 
# File 'lib/rex/ui/text/shell.rb', line 482

def cont_prompt
  @cont_prompt
end

#disable_output ⇒ Object

Whether or not output has been disabled.


279
280
281
 
# File 'lib/rex/ui/text/shell.rb', line 279

def disable_output
  @disable_output
end

#framework ⇒ Object

Returns the value of attribute framework


292
293
294
 
# File 'lib/rex/ui/text/shell.rb', line 292

def framework
  @framework
end

#hist_last_saved ⇒ Object

the number of history lines when last saved/loaded


293
294
295
 
# File 'lib/rex/ui/text/shell.rb', line 293

def hist_last_saved
  @hist_last_saved
end

#histfile ⇒ Object (protected)

:nodoc:


484
485
486
 
# File 'lib/rex/ui/text/shell.rb', line 484

def histfile
  @histfile
end

#input ⇒ Object

The input handle to read user input from.


283
284
285
 
# File 'lib/rex/ui/text/shell.rb', line 283

def input
  @input
end

#local_hostname ⇒ Object (protected)

:nodoc:


486
487
488
 
# File 'lib/rex/ui/text/shell.rb', line 486

def local_hostname
  @local_hostname
end

#local_username ⇒ Object (protected)

:nodoc:


486
487
488
 
# File 'lib/rex/ui/text/shell.rb', line 486

def local_username
  @local_username
end

#log_source ⇒ Object (protected)

:nodoc:


485
486
487
 
# File 'lib/rex/ui/text/shell.rb', line 485

def log_source
  @log_source
end

#on_command_proc ⇒ Object

Returns the value of attribute on_command_proc


290
291
292
 
# File 'lib/rex/ui/text/shell.rb', line 290

def on_command_proc
  @on_command_proc
end

#on_print_proc ⇒ Object

Returns the value of attribute on_print_proc


291
292
293
 
# File 'lib/rex/ui/text/shell.rb', line 291

def on_print_proc
  @on_print_proc
end

#output ⇒ Object

The output handle to write output to.


287
288
289
 
# File 'lib/rex/ui/text/shell.rb', line 287

def output
  @output
end

#prompt ⇒ Object

Returns the value of attribute prompt


289
290
291
 
# File 'lib/rex/ui/text/shell.rb', line 289

def prompt
  @prompt
end

#prompt_char ⇒ Object

Returns the value of attribute prompt_char


289
290
291
 
# File 'lib/rex/ui/text/shell.rb', line 289

def prompt_char
  @prompt_char
end

#stop_count ⇒ Object (protected)

:nodoc:


485
486
487
 
# File 'lib/rex/ui/text/shell.rb', line 485

def stop_count
  @stop_count
end

#stop_flag ⇒ Object (protected)

:nodoc:


482
483
484
 
# File 'lib/rex/ui/text/shell.rb', line 482

def stop_flag
  @stop_flag
end

#tab_complete_proc ⇒ Object (protected)

:nodoc:


483
484
485
 
# File 'lib/rex/ui/text/shell.rb', line 483

def tab_complete_proc
  @tab_complete_proc
end

Instance Method Details

#_print_prompt(prompt) ⇒ Object (protected)

Print the prompt, but do not log it.


361
362
363
 
# File 'lib/rex/ui/text/shell.rb', line 361

def _print_prompt(prompt)
  output.print(prompt)
end

#format_prompt(str) ⇒ Object (protected)

Handle prompt substitutions


394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/rex/ui/text/shell.rb', line 394

def format_prompt(str)
  return str unless framework

  # find the active session
  session = framework.sessions.values.find { |session| session.interacting }
  default = 'unknown'

  formatted = ''
  skip_next = false
  for prefix, spec in str.split('').each_cons(2) do
    if skip_next
      skip_next = false
      next
    end

    unless prefix == '%'
      formatted << prefix
      skip_next = false
      next
    end

    skip_next = true
    if spec == 'T'
      # This %T is the strftime shorthand for %H:%M:%S
      strftime_format = framework.datastore['PromptTimeFormat'] || '%T'
      formatted << Time.now.strftime(strftime_format).to_s
    elsif spec == 'W' && framework.db.active
      formatted << framework.db.workspace.name
    elsif session
      sysinfo = session.respond_to?(:sys) ? session.sys.config.sysinfo : nil

      case spec
      when 'A'
        formatted << (sysinfo.nil? ? default : sysinfo['Architecture'])
      when 'D'
        formatted << (session.respond_to?(:fs) ? session.fs.dir.getwd(refresh: false) : default)
      when 'd'
        formatted << ::Dir.getwd
      when 'H'
        formatted << (sysinfo.nil? ? default : sysinfo['Computer'])
      when 'h'
        formatted << (self.local_hostname || default).chomp
      when 'I'
        formatted << session.tunnel_peer
      when 'i'
        formatted << session.tunnel_local
      when 'M'
        formatted << session.session_type
      when 'S'
        formatted << session.sid.to_s
      when 'U'
        formatted << (session.respond_to?(:sys) ? session.sys.config.getuid(refresh: false) : default)
      when 'u'
        formatted << (self.local_username || default).chomp
      else
        formatted << prefix
        skip_next = false
      end
    else
      case spec
      when 'H'
        formatted << (self.local_hostname || default).chomp
      when 'J'
        formatted << framework.jobs.length.to_s
      when 'U'
        formatted << (self.local_username || default).chomp
      when 'S'
        formatted << framework.sessions.length.to_s
      when 'L'
        formatted << Rex::Socket.source_address
      when 'D'
        formatted << ::Dir.getwd
      else
        formatted << prefix
        skip_next = false
      end
    end
  end

  if str.length > 0 && !skip_next
    formatted << str[-1]
  end

  formatted
end

#get_input_line ⇒ Object (protected)

Get a single line of input, following continuation directives as necessary.


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
 
# File 'lib/rex/ui/text/shell.rb', line 304

def get_input_line
  line = "\\\n"
  prompt_needs_reset = false

  self.cont_flag = false
  while line =~ /(^|[^\\])\\\s*$/
    # Strip \ and all the trailing whitespace
    line.sub!(/\\\s*/, '')

    if line.length > 0
      # Using update_prompt will overwrite the primary prompt
      input.prompt = output.update_prompt(self.cont_prompt)
      self.cont_flag = true
      prompt_needs_reset = true
    end

    output.input = input
    str = input.pgets
    if str
      line << str
    else
      line = nil
    end

    output.input = nil
    log_output(input.prompt)
  end
  self.cont_flag = false

  if prompt_needs_reset
    # The continuation prompt was used so reset the prompt
    update_prompt
  end

  line
end

#init_tab_complete ⇒ Object 


66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rex/ui/text/shell.rb', line 66

def init_tab_complete
  if (self.input and self.input.supports_readline)
    # Unless cont_flag because there's no tab complete for continuation lines
    self.input = Input::Readline.new(lambda { |str| tab_complete(str) unless cont_flag })
    if Readline::HISTORY.length == 0 and histfile and File.exist?(histfile)
      File.readlines(histfile).each { |e|
        Readline::HISTORY << e.chomp
      }
      self.hist_last_saved = Readline::HISTORY.length
    end
    self.input.output = self.output
  end
end

#init_ui(in_input = nil, in_output = nil) ⇒ Object

Initializes the user interface input/output classes.


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rex/ui/text/shell.rb', line 83

def init_ui(in_input = nil, in_output = nil)
  # Initialize the input and output methods
  self.input  = in_input
  self.output = in_output

  if (self.input)
    # Extend the input medium as an input shell if the input medium
    # isn't intrinsicly a shell.
    if (self.input.intrinsic_shell? == false)
      self.input.extend(InputShell)
    end

    self.input.output = self.output
  end
end

#initialize(prompt, prompt_char = '>', histfile = nil, framework = nil) ⇒ Object

Initializes a shell that has a prompt and can be interacted with.


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rex/ui/text/shell.rb', line 44

def initialize(prompt, prompt_char = '>', histfile = nil, framework = nil)
  # Set the stop flag to false
  self.stop_flag      = false
  self.disable_output = false
  self.stop_count     = 0

  # Initialize the prompt
  self.cont_prompt = ' > '
  self.cont_flag = false
  self.prompt = prompt
  self.prompt_char = prompt_char

  self.histfile = histfile
  self.hist_last_saved = 0

  # Static prompt variables
  self.local_hostname = ENV['HOSTNAME'] || `hostname`.split('.')[0] || ENV['COMPUTERNAME']
  self.local_username = ENV['USER'] || `whoami` || ENV['USERNAME']

  self.framework = framework
end

#log_input(buf) ⇒ Object (protected)

Writes the supplied input to the log source if one has been registered.


368
369
370
 
# File 'lib/rex/ui/text/shell.rb', line 368

def log_input(buf)
  rlog(buf, log_source) if (log_source)
end

#log_output(buf) ⇒ Object (protected)

Writes the supplied output to the log source if one has been registered.


375
376
377
 
# File 'lib/rex/ui/text/shell.rb', line 375

def log_output(buf)
  rlog(buf, log_source) if (log_source)
end

#parse_line(line) ⇒ Object (protected)

Parse a line into an array of arguments.


344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/rex/ui/text/shell.rb', line 344

def parse_line(line)
  log_input(line)

  line.gsub!(/(\r|\n)/, '')

  begin
    return args = Rex::Parser::Arguments.from_s(line)
  rescue ::ArgumentError
    print_error("Parse error: #{$!}")
  end

  return []
end

#print(msg = '') ⇒ Object

Prints a raw message to the output handle.


270
271
272
273
274
 
# File 'lib/rex/ui/text/shell.rb', line 270

def print(msg='')
  return if (disable_output == true)
  self.on_print_proc.call(msg) if self.on_print_proc
  log_output(output.print(msg))
end

#print_error(msg = '') ⇒ Object Also known as: print_bad

Prints an error message to the output handle.


216
217
218
219
220
221
222
223
 
# File 'lib/rex/ui/text/shell.rb', line 216

def print_error(msg='')
  return if (output.nil?)
  return if (msg.nil?)

  self.on_print_proc.call(msg) if self.on_print_proc
  # Errors are not subject to disabled output
  log_output(output.print_error(msg))
end

#print_good(msg = '') ⇒ Object

Prints a good message to the output handle.


240
241
242
243
244
245
 
# File 'lib/rex/ui/text/shell.rb', line 240

def print_good(msg='')
  return if (disable_output == true)

  self.on_print_proc.call(msg) if self.on_print_proc
  log_output(output.print_good(msg))
end

#print_line(msg = '') ⇒ Object

Prints a line of text to the output handle.


250
251
252
253
254
255
 
# File 'lib/rex/ui/text/shell.rb', line 250

def print_line(msg='')
  return if (disable_output == true)

  self.on_print_proc.call(msg) if self.on_print_proc
  log_output(output.print_line(msg))
end

#print_status(msg = '') ⇒ Object

Prints a status message to the output handle.


230
231
232
233
234
235
 
# File 'lib/rex/ui/text/shell.rb', line 230

def print_status(msg='')
  return if (disable_output == true)

  self.on_print_proc.call(msg) if self.on_print_proc
  log_output(output.print_status(msg))
end

#print_warning(msg = '') ⇒ Object

Prints a warning message to the output handle.


260
261
262
263
264
265
 
# File 'lib/rex/ui/text/shell.rb', line 260

def print_warning(msg='')
  return if (disable_output == true)

  self.on_print_proc.call(msg) if self.on_print_proc
  log_output(output.print_warning(msg))
end

#prompt_yesno(query) ⇒ Object (protected)

Prompt the user for input if possible. Special edition for use inside commands.


382
383
384
385
386
387
388
389
 
# File 'lib/rex/ui/text/shell.rb', line 382

def prompt_yesno(query)
  p = "#{query} [y/N]"
  old_p = [self.prompt, self.prompt_char]
  update_prompt p, ' '
  /^y/i === get_input_line
ensure
  update_prompt *old_p
end

#reset_ui ⇒ Object

Resets the user interface handles.


102
103
104
 
# File 'lib/rex/ui/text/shell.rb', line 102

def reset_ui
  init_ui
end

#run(&block) ⇒ Object

Run the command processing loop.


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/rex/ui/text/shell.rb', line 130

def run(&block)

  begin

    while true
      # If the stop flag was set or we've hit EOF, break out
      break if self.stop_flag || self.stop_count > 1

      init_tab_complete
      update_prompt

      line = get_input_line

      # If you have sessions active, this will give you a shot to exit
      # gracefully. If you really are ambitious, 2 eofs will kick this out
      if input.eof? || line == nil
        self.stop_count += 1
        next if self.stop_count > 1
        run_single("quit")

      # If a block was passed in, pass the line to it.  If it returns true,
      # break out of the shell loop.
      elsif block
        break if block.call(line)

      # Otherwise, call what should be an overriden instance method to
      # process the line.
      else
        ret = run_single(line)
        # don't bother saving lines that couldn't be found as a
        # command, create the file if it doesn't exist, don't save dupes
        if ret && self.histfile && line != @last_line
          File.open(self.histfile, "a+") { |f| f.puts(line) }
          @last_line = line
        end
        self.stop_count = 0
      end

    end
  # Prevent accidental console quits
  rescue ::Interrupt
    output.print("Interrupt: use the 'exit' command to quit\n")
    retry
  end
end

#set_log_source(log_source) ⇒ Object

Sets the log source that should be used for logging input and output.


109
110
111
 
# File 'lib/rex/ui/text/shell.rb', line 109

def set_log_source(log_source)
  self.log_source = log_source
end

#stop ⇒ Object

Stop processing user input.


179
180
181
 
# File 'lib/rex/ui/text/shell.rb', line 179

def stop
  self.stop_flag = true
end

#stopped? ⇒ Boolean

Checks to see if the shell has stopped.

Returns:

  • (Boolean) 

186
187
188
 
# File 'lib/rex/ui/text/shell.rb', line 186

def stopped?
  self.stop_flag
end

#supports_color? ⇒ Boolean (protected)

Returns:

  • (Boolean) 

297
298
299
 
# File 'lib/rex/ui/text/shell.rb', line 297

def supports_color?
  true
end

#tab_complete(str) ⇒ Object

Performs tab completion on the supplied string.


123
124
125
 
# File 'lib/rex/ui/text/shell.rb', line 123

def tab_complete(str)
  return tab_complete_proc(str) if (tab_complete_proc)
end

#unset_log_source ⇒ Object

Unsets the log source so that logging becomes disabled.


116
117
118
 
# File 'lib/rex/ui/text/shell.rb', line 116

def unset_log_source
  set_log_source(nil)
end

#update_prompt(new_prompt = self.prompt, new_prompt_char = self.prompt_char) ⇒ Object

Change the input prompt.

prompt - the actual prompt new_prompt_char the char to append to the prompt


195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/rex/ui/text/shell.rb', line 195

def update_prompt(new_prompt = self.prompt, new_prompt_char = self.prompt_char)
  if (self.input)
    p = substitute_colors(new_prompt + ' ' + new_prompt_char + ' ', true)

    # Save the prompt before any substitutions
    self.prompt = new_prompt
    self.prompt_char  = new_prompt_char

    # Set the actual prompt to the saved prompt with any substitutions
    # or updates from our output driver, be they color or whatever
    self.input.prompt = self.output.update_prompt(format_prompt(p))
  end
end