Class: Rex::Script::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/rex/script/base.rb

Direct Known Subclasses

Meterpreter, Shell

Defined Under Namespace

Classes: OutputSink

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, path) ⇒ Base

Returns a new instance of Base.



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/rex/script/base.rb', line 16

def initialize(client, path)
	self.client    = client
	self.framework = client.framework
	self.path      = path
	self.sink      = OutputSink.new

	if(client.framework.db and client.framework.db.active)
		self.workspace = client.framework.db.find_workspace( client.workspace.to_s ) || client.framework.db.workspace
	end

	# Convenience aliases
	self.session   = self.client
end

Instance Attribute Details

#args ⇒ Object

Returns the value of attribute args.



13
14
15
 
# File 'lib/rex/script/base.rb', line 13

def args
  @args
end

#client ⇒ Object

Returns the value of attribute client.



13
14
15
 
# File 'lib/rex/script/base.rb', line 13

def client
  @client
end

#error ⇒ Object

Returns the value of attribute error.



13
14
15
 
# File 'lib/rex/script/base.rb', line 13

def error
  @error
end

#framework ⇒ Object

Returns the value of attribute framework.



13
14
15
 
# File 'lib/rex/script/base.rb', line 13

def framework
  @framework
end

#path ⇒ Object

Returns the value of attribute path.



13
14
15
 
# File 'lib/rex/script/base.rb', line 13

def path
  @path
end

#session ⇒ Object

Returns the value of attribute session.



14
15
16
 
# File 'lib/rex/script/base.rb', line 14

def session
  @session
end

#sink ⇒ Object

Returns the value of attribute sink.



14
15
16
 
# File 'lib/rex/script/base.rb', line 14

def sink
  @sink
end

#workspace ⇒ Object

Returns the value of attribute workspace.



14
15
16
 
# File 'lib/rex/script/base.rb', line 14

def workspace
  @workspace
end

Instance Method Details

#completed ⇒ Object

Raises:



34
35
36
 
# File 'lib/rex/script/base.rb', line 34

def completed
	raise Rex::Script::Completed
end

#output ⇒ Object 



30
31
32
 
# File 'lib/rex/script/base.rb', line 30

def output
	client.user_output || self.sink
end

#print(*args) ⇒ Object 



50
 
# File 'lib/rex/script/base.rb', line 50

def print(*args);         output.print(*args);          end

#print_error(*args) ⇒ Object 



52
 
# File 'lib/rex/script/base.rb', line 52

def print_error(*args);   output.print_error(*args);    end

#print_good(*args) ⇒ Object 



53
 
# File 'lib/rex/script/base.rb', line 53

def print_good(*args);    output.print_good(*args);     end

#print_line(*args) ⇒ Object 



54
 
# File 'lib/rex/script/base.rb', line 54

def print_line(*args);    output.print_line(*args);     end

#print_status(*args) ⇒ Object 



51
 
# File 'lib/rex/script/base.rb', line 51

def print_status(*args);  output.print_status(*args);   end

#run(args = []) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rex/script/base.rb', line 38

def run(args=[])
	self.args = args = args.flatten
	begin
		eval(::File.read(self.path, ::File.size(self.path)), binding )
	rescue ::Interrupt
	rescue ::Rex::Script::Completed
	rescue ::Exception => e
		self.error = e
		raise e
	end
end