Class: Msf::RPC::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/msfrpc-client/client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(info = {}) ⇒ void

Initializes the RPC client to connect to: 127.0.0.1:3790 (TLS1) The connection information is overridden through the optional info hash.

Parameters:

  • info (Hash) (defaults to: {}) —

    Information needed for the initialization.

Options Hash (info):

  • :token (String) —

    A token used by the client.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/msfrpc-client/client.rb', line 36

def initialize(info = {})
  @user = nil
  @pass = nil

  self.info = {
    host:  '127.0.0.1',
    port:  3790,
    uri:   '/api/',
    ssl:   true,
    ssl_version: 'TLS1.2',
  }.merge(info)

  self.token = self.info[:token]
end

Instance Attribute Details

#info ⇒ Hash

Returns Login information.

Returns:

  • (Hash) —

    Login information.



27
28
29
 
# File 'lib/msfrpc-client/client.rb', line 27

def info
  @info
end

#token ⇒ String

Returns A login token.

Returns:

  • (String) —

    A login token.



23
24
25
 
# File 'lib/msfrpc-client/client.rb', line 23

def token
  @token
end

Class Method Details

.option_handler(options = {}) ⇒ Object

Load options from the command-line, environment. and any configuration files specified



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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/msfrpc-client/client.rb', line 198

def self.option_handler(options = {})
  options[:host]   ||= ENV['MSFRPC_HOST']
  options[:port]   ||= ENV['MSFRPC_PORT']
  options[:uri]    ||= ENV['MSFRPC_URI']
  options[:user]   ||= ENV['MSFRPC_USER']
  options[:pass]   ||= ENV['MSFRPC_PASS']
  options[:ssl]    ||= ENV['MSFRPC_SSL']
  options[:token]  ||= ENV['MSFRPC_TOKEN']
  options[:config] ||= ENV['MSFRPC_CONFIG']

  empty_keys = options.keys.select { |k| options[k].nil? }
  empty_keys.each { |k| options.delete(k) }

  config_file = options.delete(:config)

  if config_file
    yaml_data = ::File.read(config_file) rescue nil
    if yaml_data
      yaml = ::YAML.load(yaml_data) rescue nil
      if yaml && yaml.is_a?(::Hash) && yaml['options']
        yaml['options'].each_pair do |k, v|
          case k
          when 'ssl'
            options[k.intern] = !!(v.to_s =~ /^(t|y|1)/i)
          when 'port'
            options[k.intern] = v.to_i
          else
            options[k.intern] = v
          end
        end
      else
        $stderr.puts "Could not parse configuration file: #{config_file}"
        exit(1)
      end
    else
      $stderr.puts "Could not read configuration file: #{config_file}"
      exit(1)
    end
  end

  options[:port] = options[:port].to_i if options[:port]

  options[:ssl] = !!(options[:ssl].to_s =~ /^(t|y|1)/i) if options[:ssl]

  options
end

.option_parser(options) ⇒ Object

Provides a parser object that understands the RPC specific options



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/msfrpc-client/client.rb', line 145

def self.option_parser(options)
  parser = OptionParser.new

  parser.banner = "Usage: #{$PROGRAM_NAME} [options]"
  parser.separator('')
  parser.separator('RPC Options:')

  parser.on('--rpc-host HOST') do |v|
    options[:host] = v
  end

  parser.on('--rpc-port PORT') do |v|
    options[:port] = v.to_i
  end

  parser.on('--rpc-ssl <true|false>') do |v|
    options[:ssl] = v
  end

  parser.on('--rpc-uri URI') do |v|
    options[:uri] = v
  end

  parser.on('--rpc-user USERNAME') do |v|
    options[:user] = v
  end

  parser.on('--rpc-pass PASSWORD') do |v|
    options[:pass] = v
  end

  parser.on('--rpc-token TOKEN') do |v|
    options[:token] = v
  end

  parser.on('--rpc-config CONFIG-FILE') do |v|
    options[:config] = v
  end

  parser.on('--rpc-help') do
    $stderr.puts parser
    exit(1)
  end

  parser.separator('')

  parser
end

Instance Method Details

#call(meth, *args) ⇒ Hash

Calls an API.

Examples:

# This will return something like this:
# {"version"=>"4.11.0-dev",
#  "ruby"=>"2.1.5 x86_64-darwin14.0 2014-11-13", "api"=>"1.0"}
rpc.call('core.version')

Parameters:

  • meth (String) —

    The RPC API to call.

  • args (Array<string>) —

    The arguments to pass.

Returns:

  • (Hash) —

    The API response. It contains the following keys:

    • 'version' [String] Framework version.

    • 'ruby' [String] Ruby version.

    • 'api' [String] API version.

Raises:

  • (RuntimeError) —

    Something is wrong while calling the remote API, including:

    • A missing token (your client needs to authenticate).

    • A unexpected response from the server, such as a timeout or unexpected HTTP code.

  • (Msf::RPC::ServerException) —

    The RPC service returns an error.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/msfrpc-client/client.rb', line 102

def call(meth, *args)
  if meth == 'auth.logout'
    do_logout_cleanup
  end

  unless meth == 'auth.login'
    unless self.token
      raise Msf::RPC::Exception.new('Client not authenticated')
    end
    args.unshift(self.token)
  end

  args.unshift(meth)

  begin
    send_rpc_request(args)
  rescue Msf::RPC::ServerException => e
    if e.message =~ /Invalid Authentication Token/i &&
       meth != 'auth.login' && @user && @pass
      
      args[1] = self.token
      retry
    else
      raise e
    end
  end
end

#close ⇒ void

This method returns an undefined value.

Closes the client.



133
134
135
 
# File 'lib/msfrpc-client/client.rb', line 133

def close
  @cli = nil
end

#login(user, pass) ⇒ TrueClass

Logs in by calling the ‘auth.login’ API. The authentication token will expire after 5 minutes, but will automatically be rewnewed when you make a new RPC request.

Parameters:

  • user (String) —

    Username.

  • pass (String) —

    Password.

Returns:

  • (TrueClass) —

    Indicating a successful login.

Raises:

  • RuntimeError Indicating a failed authentication.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/msfrpc-client/client.rb', line 60

def (user, pass)
  @user = user
  @pass = pass
  res = self.call('auth.login', user, pass)
  unless res && res['result'] == 'success'
    raise Msf::RPC::Exception.new('Authentication failed')
  end
  self.token = res['token']
  true
end

#re_login ⇒ TrueClass

Attempts to login again with the last known user name and password.

Returns:

  • (TrueClass) —

    Indicating a successful login.



76
77
78
 
# File 'lib/msfrpc-client/client.rb', line 76

def 
  (@user, @pass)
end