Class: Rex::Proto::SMB::SimpleClient

Inherits:
Object
  • Object
show all
Defined in:
lib/rex/proto/smb/simpleclient.rb,
lib/rex/proto/smb/simpleclient/open_file.rb,
lib/rex/proto/smb/simpleclient/open_pipe.rb

Direct Known Subclasses

SimpleClientPipe

Defined Under Namespace

Classes: OpenFile, OpenPipe

Constant Summary collapse

CONST =

Some short-hand class aliases

Rex::Proto::SMB::Constants
CRYPT =
Rex::Proto::SMB::Crypt
UTILS =
Rex::Proto::SMB::Utils
XCEPT =
Rex::Proto::SMB::Exceptions
EVADE =
Rex::Proto::SMB::Evasions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(socket, direct = false, versions = [1, 2, 3], always_encrypt: true) ⇒ SimpleClient

Pass the socket object and a boolean indicating whether the socket is netbios or cifs


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/rex/proto/smb/simpleclient.rb', line 34

def initialize(socket, direct = false, versions = [1, 2, 3], always_encrypt: true)
  self.socket = socket
  self.direct = direct
  self.versions = versions
  self.shares = {}
  self.server_max_buffer_size = 1024 # 4356 (workstation) or 16644 (server) expected

  if self.versions == [1]
    self.client = Rex::Proto::SMB::Client.new(socket)
  else
    self.client = RubySMB::Client.new(RubySMB::Dispatcher::Socket.new(self.socket, read_timeout: 60),
                                      username: '',
                                      password: '',
                                      smb1: self.versions.include?(1),
                                      smb2: self.versions.include?(2),
                                      smb3: self.versions.include?(3),
                                      always_encrypt: always_encrypt
                  )
    self.client.evasion_opts = {
      # Padding is performed between packet headers and data
      'pad_data' => EVADE::EVASION_NONE,
      # File path padding is performed on all open/create calls
      'pad_file' => EVADE::EVASION_NONE,
      # Modify the \PIPE\ string in trans_named_pipe calls
      'obscure_trans_pipe' => EVADE::EVASION_NONE,
    }
  end
end

Instance Attribute Details

#clientObject

Private accessors


31
32
33
# File 'lib/rex/proto/smb/simpleclient.rb', line 31

def client
  @client
end

#directObject

Private accessors


31
32
33
# File 'lib/rex/proto/smb/simpleclient.rb', line 31

def direct
  @direct
end

#last_errorObject

Public accessors


28
29
30
# File 'lib/rex/proto/smb/simpleclient.rb', line 28

def last_error
  @last_error
end

#last_shareObject

Private accessors


31
32
33
# File 'lib/rex/proto/smb/simpleclient.rb', line 31

def last_share
  @last_share
end

#server_max_buffer_sizeObject

Public accessors


28
29
30
# File 'lib/rex/proto/smb/simpleclient.rb', line 28

def server_max_buffer_size
  @server_max_buffer_size
end

#sharesObject

Private accessors


31
32
33
# File 'lib/rex/proto/smb/simpleclient.rb', line 31

def shares
  @shares
end

#socketObject

Private accessors


31
32
33
# File 'lib/rex/proto/smb/simpleclient.rb', line 31

def socket
  @socket
end

#versionsObject

Private accessors


31
32
33
# File 'lib/rex/proto/smb/simpleclient.rb', line 31

def versions
  @versions
end

Instance Method Details

#connect(share) ⇒ Object


175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/rex/proto/smb/simpleclient.rb', line 175

def connect(share)
  ok = self.client.tree_connect(share)

  if self.client.is_a?(RubySMB::Client)
    tree_id = ok.id
  else
    tree_id = ok['Payload']['SMB'].v['TreeID']
  end

  self.shares[share] = tree_id
  self.last_share = share
end

#create_pipe(path, perm = 'o') ⇒ Object


238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/rex/proto/smb/simpleclient.rb', line 238

def create_pipe(path, perm = 'o')
  disposition = UTILS.create_mode_to_disposition(perm)
  ok = self.client.create_pipe(path, disposition)

  if self.client.is_a?(RubySMB::Client)
    file_id = ok
  else
    file_id = ok['Payload'].v['FileID']
  end

  fh = OpenPipe.new(self.client, path, self.client.last_tree_id, file_id, self.versions)
end

#delete(*args) ⇒ Object


230
231
232
233
234
235
236
# File 'lib/rex/proto/smb/simpleclient.rb', line 230

def delete(*args)
  if self.client.is_a?(RubySMB::Client)
    self.client.delete(args[0])
  else
    self.client.delete(*args)
  end
end

#disconnect(share) ⇒ Object


188
189
190
191
192
193
194
195
# File 'lib/rex/proto/smb/simpleclient.rb', line 188

def disconnect(share)
  if self.shares[share]
    ok = self.client.tree_disconnect(self.shares[share])
    self.shares.delete(share)
    return ok
  end
  false
end

#login(name = '', user = '', pass = '', domain = '', verify_signature = false, usentlmv2 = false, usentlm2_session = true, send_lm = true, use_lanman_key = false, send_ntlm = true, native_os = 'Windows 2000 2195', native_lm = 'Windows 2000 5.0', spnopt = {}) ⇒ Object


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
# File 'lib/rex/proto/smb/simpleclient.rb', line 63

def (name = '', user = '', pass = '', domain = '',
    verify_signature = false, usentlmv2 = false, usentlm2_session = true,
    send_lm = true, use_lanman_key = false, send_ntlm = true,
    native_os = 'Windows 2000 2195', native_lm = 'Windows 2000 5.0', spnopt = {})

  begin

    if (self.direct != true)
      self.client.session_request(name)
    end
    self.client.native_os = native_os
    self.client.native_lm = native_lm
    self.client.verify_signature = verify_signature
    self.client.use_ntlmv2 = usentlmv2
    self.client.usentlm2_session = usentlm2_session
    self.client.send_lm = send_lm
    self.client.use_lanman_key =  use_lanman_key
    self.client.send_ntlm = send_ntlm

    dlog("SMB version(s) to negotiate: #{self.versions}")
    ok = self.client.negotiate
    dlog("Negotiated SMB version: SMB#{negotiated_smb_version}")

    if self.client.is_a?(RubySMB::Client)
      self.server_max_buffer_size = self.client.server_max_buffer_size
    else
      self.server_max_buffer_size = ok['Payload'].v['MaxBuff']
    end

    # Disable NTLMv2 Session for Windows 2000 (breaks authentication on some systems)
    # XXX: This in turn breaks SMB auth for Windows 2000 configured to enforce NTLMv2
    # XXX: Tracked by ticket #4785#4785
    if self.client.native_lm =~ /Windows 2000 5\.0/ and usentlm2_session
    #	self.client.usentlm2_session = false
    end

    self.client.spnopt = spnopt

    # In case the user unsets the password option, we make sure this is
    # always a string
    pass ||= ''

    res = self.client.session_setup(user, pass, domain)
  rescue ::Interrupt
    raise $!
  rescue ::Exception => e
    n = XCEPT::LoginError.new
    n.source = e
    if(e.respond_to?('error_code'))
      n.error_code   = e.error_code
      n.error_reason = e.get_error(e.error_code)
    end
    raise n
  end

  # RubySMB does not raise any exception if the Session Setup fails
  if self.client.is_a?(RubySMB::Client) && res != WindowsError::NTStatus::STATUS_SUCCESS
    n = XCEPT::LoginError.new
    n.source       = res
    n.error_code   = res.value
    n.error_reason = res.name
    raise n
  end

  return true
end

#login_split_next_ntlm1(user, domain, hash_lm, hash_nt) ⇒ Object


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/rex/proto/smb/simpleclient.rb', line 157

def (user, domain, hash_lm, hash_nt)
  begin
    ok = self.client.session_setup_no_ntlmssp_prehash(user, domain, hash_lm, hash_nt)
  rescue ::Interrupt
    raise $!
  rescue ::Exception => e
    n = XCEPT::LoginError.new
    n.source = e
    if(e.respond_to?('error_code'))
      n.error_code   = e.error_code
      n.error_reason = e.get_error(e.error_code)
    end
    raise n
  end

  return true
end

#login_split_start_ntlm1(name = '') ⇒ Object


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/rex/proto/smb/simpleclient.rb', line 131

def (name = '')

  begin

    if (self.direct != true)
      self.client.session_request(name)
    end

    # Disable extended security
    self.client.negotiate(false)
  rescue ::Interrupt
    raise $!
  rescue ::Exception => e
    n = XCEPT::LoginError.new
    n.source = e
    if(e.respond_to?('error_code'))
      n.error_code   = e.error_code
      n.error_reason = e.get_error(e.error_code)
    end
    raise n
  end

  return true
end

#negotiated_smb_versionObject


255
256
257
258
# File 'lib/rex/proto/smb/simpleclient.rb', line 255

def negotiated_smb_version
  return 1 if self.client.is_a?(Rex::Proto::SMB::Client)
  self.client.negotiated_smb_version || -1
end

#open(path, perm, chunk_size = 48000, read: true, write: false) ⇒ Object


197
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
# File 'lib/rex/proto/smb/simpleclient.rb', line 197

def open(path, perm, chunk_size = 48000, read: true, write: false)
  if self.client.is_a?(RubySMB::Client)
    mode = 0
    if perm.include?('c')
      if perm.include?('o')
        mode = RubySMB::Dispositions::FILE_OPEN_IF
      elsif perm.include?('t')
        mode = RubySMB::Dispositions::FILE_OVERWRITE_IF
      else
        mode = RubySMB::Dispositions::FILE_CREATE
      end
    else
      if perm.include?('o')
        mode = RubySMB::Dispositions::FILE_OPEN
      elsif perm.include?('t')
        mode = RubySMB::Dispositions::FILE_OVERWRITE
      end
    end

    file_id = self.client.open(path, mode, read: true, write: write || perm.include?('w'))
  else
    mode = UTILS.open_mode_to_mode(perm)
    access = UTILS.open_mode_to_access(perm)

    ok = self.client.open(path, mode, access)
    file_id = ok['Payload'].v['FileID']
  end

  fh = OpenFile.new(self.client, path, self.client.last_tree_id, file_id, self.versions)
  fh.chunk_size = chunk_size
  fh
end

#trans_pipe(fid, data, no_response = nil) ⇒ Object


251
252
253
# File 'lib/rex/proto/smb/simpleclient.rb', line 251

def trans_pipe(fid, data, no_response = nil)
  client.trans_named_pipe(fid, data, no_response)
end