Module: Msf::Post::Common

Instance Method Summary collapse

Instance Method Details

#clear_screenObject



21
22
23
# File 'lib/msf/core/post/common.rb', line 21

def clear_screen
  Gem.win_platform? ? (system "cls") : (system "clear")
end

#cmd_exec(cmd, args = nil, time_out = 15, opts = {}) ⇒ Object

Executes cmd on the remote system

On Windows meterpreter, this will go through CreateProcess as the “commandLine” parameter. This means it will follow the same rules as Windows' path disambiguation. For example, if you were to call this method thusly:

cmd_exec("c:\\program files\\sub dir\\program name")

Windows would look for these executables, in this order, passing the rest of the line as arguments:

c:\program.exe
c:\program files\sub.exe
c:\program files\sub dir\program.exe
c:\program files\sub dir\program name.exe

On POSIX meterpreter, if args is set or if cmd contains shell metacharacters, the server will run the whole thing in /bin/sh. Otherwise, (cmd is a single path and there are no arguments), it will execve the given executable.

On Java, it is passed through Runtime.getRuntime().exec(String) and PHP uses proc_open() both of which have similar semantics to POSIX.

On shell sessions, this passes cmd directly the session's shell_command_token method.

Returns a (possibly multi-line) String.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
129
# File 'lib/msf/core/post/common.rb', line 80

def cmd_exec(cmd, args=nil, time_out=15, opts = {})
  case session.type
  when 'meterpreter'
    #
    # The meterpreter API requires arguments to come separately from the
    # executable path. This has no effect on Windows where the two are just
    # blithely concatenated and passed to CreateProcess or its brethren. On
    # POSIX, this allows the server to execve just the executable when a
    # shell is not needed. Determining when a shell is not needed is not
    # always easy, so it assumes anything with arguments needs to go through
    # /bin/sh.
    #
    # This problem was originally solved by using Shellwords.shellwords but
    # unfortunately, it is unsuitable. When a backslash occurs inside double
    # quotes (as is often the case with Windows commands) it inexplicably
    # removes them. So. Shellwords is out.
    #
    # By setting +args+ to an empty string, we can get POSIX to send it
    # through /bin/sh, solving all the pesky parsing troubles, without
    # affecting Windows.
    #
    if args.nil? and cmd =~ /[^a-zA-Z0-9\/._-]/
      args = ""
    end

    session.response_timeout = time_out
    opts = {
      'Hidden' => true,
      'Channelized' => true,
      'Subshell' => true
    }.merge(opts)
    o = session.sys.process.capture_output(cmd, args, opts, time_out)
  when 'powershell'
    if args.nil? || args.empty?
      o = session.shell_command("#{cmd}", time_out)
    else
      o = session.shell_command("#{cmd} #{args}", time_out)
    end
    o.chomp! if o
  when 'shell'
    if args.nil? || args.empty?
      o = session.shell_command_token("#{cmd}", time_out)
    else
      o = session.shell_command_token("#{cmd} #{args}", time_out)
    end
    o.chomp! if o
  end
  return "" if o.nil?
  return o
end

#cmd_exec_get_pid(cmd, args = nil, time_out = 15) ⇒ Object



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/msf/core/post/common.rb', line 131

def cmd_exec_get_pid(cmd, args=nil, time_out=15)
  case session.type
    when 'meterpreter'
      if args.nil? and cmd =~ /[^a-zA-Z0-9\/._-]/
        args = ""
      end
      session.response_timeout = time_out
      process = session.sys.process.execute(cmd, args, {'Hidden' => true, 'Channelized' => true, 'Subshell' => true })
      process.channel.close
      pid = process.pid
      process.close
      pid
    else
      print_error "cmd_exec_get_pid is incompatible with non-meterpreter sessions"
  end
end

#command_exists?(cmd) ⇒ Boolean

Checks if the specified command can be executed by the session. It should be noted that not all commands correspond to a binary file on disk. For example, a bash shell session will provide the `eval` command when there is no `eval` binary on disk. Likewise, a Powershell session will provide the `Get-Item` command when there is no `Get-Item` executable on disk.

Parameters:

  • cmd (String)

    the command to check

Returns:

  • (Boolean)

    true when the command exists



224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/msf/core/post/common.rb', line 224

def command_exists?(cmd)
  verification_token = Rex::Text.rand_text_alpha_upper(8)
  if session.type == 'powershell'
    cmd_exec("try {if(Get-Command #{cmd}) {echo #{verification_token}}} catch {}").include?(verification_token)
  elsif session.platform == 'windows'
    # https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/where_1
    # https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/if
    cmd_exec("cmd /c where /q #{cmd} & if not errorlevel 1 echo #{verification_token}").to_s.include?(verification_token)
  else
    cmd_exec("command -v #{cmd} || which #{cmd} && echo #{verification_token}").include?(verification_token)
  end
rescue
  raise "Unable to check if command `#{cmd}' exists"
end

#get_env(env) ⇒ Object

Returns the value of the environment variable env



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
193
194
# File 'lib/msf/core/post/common.rb', line 167

def get_env(env)
  case session.type
  when 'meterpreter'
    return session.sys.config.getenv(env)
  when 'powershell'
    return cmd_exec("echo $env:#{env}").strip
  when 'shell'
    if session.platform == 'windows'
      if env[0,1] == '%'
        unless env[-1,1] == '%'
          env << '%'
        end
      else
        env = "%#{env}%"
      end

      return cmd_exec("echo #{env}")
    else
      unless env[0,1] == '$'
        env = "$#{env}"
      end

      return cmd_exec("echo \"#{env}\"")
    end
  end

  nil
end

#get_envs(*envs) ⇒ Object

Returns a hash of environment variables envs



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/msf/core/post/common.rb', line 199

def get_envs(*envs)
  case session.type
  when 'meterpreter'
    return session.sys.config.getenvs(*envs)
  when 'shell', 'powershell'
    result = {}
    envs.each do |env|
      res = get_env(env)
      result[env] = res unless res.blank?
    end

    return result
  end

  nil
end

#initialize(info = {}) ⇒ Object



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# File 'lib/msf/core/post/common.rb', line 5

def initialize(info = {})
  super(
    update_info(
      info,
      'Compat' => {
        'Meterpreter' => {
          'Commands' => %w[
            stdapi_sys_config_getenv
            stdapi_sys_process_execute
          ]
        }
      }
    )
  )
end

#peerObject



45
46
47
# File 'lib/msf/core/post/common.rb', line 45

def peer
  "#{rhost}:#{rport}"
end

#report_virtualization(virt) ⇒ Object

Reports to the database that the host is using virtualization and reports the type of virtualization it is (e.g VirtualBox, VMware, Xen, Docker)



152
153
154
155
156
157
158
159
160
161
162
# File 'lib/msf/core/post/common.rb', line 152

def report_virtualization(virt)
  return unless session
  return unless virt
  virt_normal = virt.to_s.strip
  return if virt_normal.empty?
  virt_data = {
    :host => session.target_host,
    :virtual_host => virt_normal
  }
  report_host(virt_data)
end

#rhostObject



25
26
27
28
29
30
31
32
33
34
# File 'lib/msf/core/post/common.rb', line 25

def rhost
  return nil unless session

  case session.type
  when 'meterpreter'
    session.sock.peerhost
  when 'shell', 'powershell'
    session.session_host
  end
end

#rportObject



36
37
38
39
40
41
42
43
# File 'lib/msf/core/post/common.rb', line 36

def rport
  case session.type
  when 'meterpreter'
    session.sock.peerport
  when 'shell', 'powershell'
    session.session_port
  end
end