Class: RubySMB::Client

Inherits:
Object
  • Object
show all
Includes:
Authentication, Echo, Encryption, Negotiation, TreeConnect, Utils, Winreg, Signing
Defined in:
lib/ruby_smb/client.rb,
lib/ruby_smb/client/echo.rb,
lib/ruby_smb/client/utils.rb,
lib/ruby_smb/client/winreg.rb,
lib/ruby_smb/client/encryption.rb,
lib/ruby_smb/client/negotiation.rb,
lib/ruby_smb/client/tree_connect.rb,
lib/ruby_smb/client/authentication.rb

Overview

This module holds all of the methods backing the #open_file method

Defined Under Namespace

Modules: Authentication, Echo, Encryption, Negotiation, TreeConnect, Utils, Winreg

Constant Summary collapse

SMB1_DIALECT_SMB1_DEFAULT =

The Default SMB1 Dialect string used in an SMB1 Negotiate Request

'NT LM 0.12'.freeze
SMB1_DIALECT_SMB2_DEFAULT =

The Default SMB2 Dialect string used in an SMB1 Negotiate Request

'SMB 2.002'.freeze
SMB1_DIALECT_SMB2_WILDCARD =

The SMB2 wildcard revision number Dialect string used in an SMB1 Negotiate Request It indicates that the server implements SMB 2.1 or future dialect revisions Note that this must be used for SMB3

'SMB 2.???'.freeze
SMB2_DIALECT_DEFAULT =

Dialect values for SMB2

['0x0202', '0x0210']
SMB3_DIALECT_DEFAULT =

Dialect values for SMB3

['0x0300', '0x0302', '0x0311']
MAX_BUFFER_SIZE =

The default maximum size of a SMB message that the Client accepts (in bytes)

64512
SERVER_MAX_BUFFER_SIZE =

The default maximum size of a SMB message that the Server accepts (in bytes)

4356

Instance Attribute Summary collapse

Attributes included from Utils

#auth_user, #evasion_opts, #last_file_id, #native_lm, #native_os, #open_files, #send_lm, #send_ntlm, #spnopt, #tree_connects, #use_lanman_key, #use_ntlmv2, #usentlm2_session, #verify_signature

Attributes included from Signing

#session_key

Instance Method Summary collapse

Methods included from Encryption

#smb3_decrypt, #smb3_encrypt

Methods included from Winreg

#connect_to_winreg, #enum_registry_key, #enum_registry_values, #has_registry_key?, #read_registry_key_value

Methods included from Utils

#close, #create_pipe, #delete, #last_file, #last_tree, #last_tree_id, #open, #read, #tree_disconnect, #write

Methods included from Echo

#smb1_echo, #smb2_echo

Methods included from TreeConnect

#smb1_tree_connect, #smb1_tree_from_response, #smb2_tree_connect, #smb2_tree_from_response

Methods included from Authentication

#authenticate, #extract_os_version, #smb1_anonymous_auth, #smb1_anonymous_auth_request, #smb1_anonymous_auth_response, #smb1_authenticate, #smb1_ntlmssp_auth_packet, #smb1_ntlmssp_authenticate, #smb1_ntlmssp_challenge_packet, #smb1_ntlmssp_final_packet, #smb1_ntlmssp_negotiate, #smb1_ntlmssp_negotiate_packet, #smb1_type2_message, #smb2_authenticate, #smb2_ntlmssp_auth_packet, #smb2_ntlmssp_authenticate, #smb2_ntlmssp_challenge_packet, #smb2_ntlmssp_final_packet, #smb2_ntlmssp_negotiate, #smb2_ntlmssp_negotiate_packet, #smb2_type2_message, #store_target_info

Methods included from Negotiation

#add_smb3_to_negotiate_request, #negotiate, #negotiate_request, #negotiate_response, #parse_negotiate_response, #parse_smb3_capabilities, #smb1_negotiate_request, #smb2_3_negotiate_request

Methods included from Signing

#smb1_sign, #smb2_sign, smb2_sign, #smb3_sign, smb3_sign

Constructor Details

#initialize(dispatcher, smb1: true, smb2: true, smb3: true, username:, password:, domain: '.', local_workstation: 'WORKSTATION', always_encrypt: true, ntlm_flags: NTLM::DEFAULT_CLIENT_FLAGS) ⇒ Client

Returns a new instance of Client.

Raises:

  • (ArgumentError) 


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
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
 
# File 'lib/ruby_smb/client.rb', line 286

def initialize(dispatcher, smb1: true, smb2: true, smb3: true, username:, password:, domain: '.',
               local_workstation: 'WORKSTATION', always_encrypt: true, ntlm_flags: NTLM::DEFAULT_CLIENT_FLAGS)
  raise ArgumentError, 'No Dispatcher provided' unless dispatcher.is_a? RubySMB::Dispatcher::Base
  if smb1 == false && smb2 == false && smb3 == false
    raise ArgumentError, 'You must enable at least one Protocol'
  end
  @dispatcher        = dispatcher
  @pid               = rand(0xFFFF)
  @domain            = domain
  @local_workstation = local_workstation
  @password          = password.encode('utf-8') || ''.encode('utf-8')
  @sequence_counter  = 0
  @session_id        = 0x00
  @session_key       = ''
  @session_is_guest  = false
  @signing_required  = false
  @smb1              = smb1
  @smb2              = smb2
  @smb3              = smb3
  @username          = username.encode('utf-8') || ''.encode('utf-8')
  @max_buffer_size   = MAX_BUFFER_SIZE
  # These sizes will be modified during negotiation
  @server_max_buffer_size = SERVER_MAX_BUFFER_SIZE
  @server_max_read_size   = RubySMB::SMB2::File::MAX_PACKET_SIZE
  @server_max_write_size  = RubySMB::SMB2::File::MAX_PACKET_SIZE
  @server_max_transact_size = RubySMB::SMB2::File::MAX_PACKET_SIZE
  @server_supports_multi_credit = false

  # SMB 3.x options
  # this merely initializes the default value for session encryption, it may be changed as necessary when a
  # session setup response is received
  @session_encrypt_data = always_encrypt

  @ntlm_client = Net::NTLM::Client.new(
    @username,
    @password,
    workstation: @local_workstation,
    domain: @domain,
    flags: ntlm_flags
  )

  @tree_connects = []
  @open_files = {}

  @smb2_message_id = 0
end

Instance Attribute Details

#client_encryption_key ⇒ String 



225
226
227
 
# File 'lib/ruby_smb/client.rb', line 225

def client_encryption_key
  @client_encryption_key
end

#default_domain ⇒ String 



93
94
95
 
# File 'lib/ruby_smb/client.rb', line 93

def default_domain
  @default_domain
end

#default_name ⇒ String 



88
89
90
 
# File 'lib/ruby_smb/client.rb', line 88

def default_name
  @default_name
end

#dialect ⇒ Integer 



118
119
120
 
# File 'lib/ruby_smb/client.rb', line 118

def dialect
  @dialect
end

#dispatcher ⇒ RubySMB::Dispatcher::Socket 



44
45
46
 
# File 'lib/ruby_smb/client.rb', line 44

def dispatcher
  @dispatcher
end

#dns_domain_name ⇒ String 



103
104
105
 
# File 'lib/ruby_smb/client.rb', line 103

def dns_domain_name
  @dns_domain_name
end

#dns_host_name ⇒ String 



98
99
100
 
# File 'lib/ruby_smb/client.rb', line 98

def dns_host_name
  @dns_host_name
end

#dns_tree_name ⇒ String 



108
109
110
 
# File 'lib/ruby_smb/client.rb', line 108

def dns_tree_name
  @dns_tree_name
end

#domain ⇒ String 



49
50
51
 
# File 'lib/ruby_smb/client.rb', line 49

def domain
  @domain
end

#encryption_algorithm ⇒ String 



220
221
222
 
# File 'lib/ruby_smb/client.rb', line 220

def encryption_algorithm
  @encryption_algorithm
end

#local_workstation ⇒ String 



54
55
56
 
# File 'lib/ruby_smb/client.rb', line 54

def local_workstation
  @local_workstation
end

#max_buffer_size ⇒ Integer 



183
184
185
 
# File 'lib/ruby_smb/client.rb', line 183

def max_buffer_size
  @max_buffer_size
end

#negotiated_smb_version ⇒ Integer 



272
273
274
 
# File 'lib/ruby_smb/client.rb', line 272

def negotiated_smb_version
  @negotiated_smb_version
end

#ntlm_client ⇒ String 



59
60
61
 
# File 'lib/ruby_smb/client.rb', line 59

def ntlm_client
  @ntlm_client
end

#os_version ⇒ String 



113
114
115
 
# File 'lib/ruby_smb/client.rb', line 113

def os_version
  @os_version
end

#password ⇒ String 



64
65
66
 
# File 'lib/ruby_smb/client.rb', line 64

def password
  @password
end

#peer_native_lm ⇒ String 



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

def peer_native_lm
  @peer_native_lm
end

#peer_native_os ⇒ String 



70
71
72
 
# File 'lib/ruby_smb/client.rb', line 70

def peer_native_os
  @peer_native_os
end

#pid ⇒ Integer 



177
178
179
 
# File 'lib/ruby_smb/client.rb', line 177

def pid
  @pid
end

#preauth_integrity_hash_algorithm ⇒ String 



210
211
212
 
# File 'lib/ruby_smb/client.rb', line 210

def preauth_integrity_hash_algorithm
  @preauth_integrity_hash_algorithm
end

#preauth_integrity_hash_value ⇒ String 



215
216
217
 
# File 'lib/ruby_smb/client.rb', line 215

def preauth_integrity_hash_value
  @preauth_integrity_hash_value
end

#primary_domain ⇒ String 



83
84
85
 
# File 'lib/ruby_smb/client.rb', line 83

def primary_domain
  @primary_domain
end

#sequence_counter ⇒ Integer 



125
126
127
 
# File 'lib/ruby_smb/client.rb', line 125

def sequence_counter
  @sequence_counter
end

#server_compression_algorithms ⇒ Array<Integer> 



247
248
249
 
# File 'lib/ruby_smb/client.rb', line 247

def server_compression_algorithms
  @server_compression_algorithms
end

#server_encryption_algorithms ⇒ Array<Integer> 



241
242
243
 
# File 'lib/ruby_smb/client.rb', line 241

def server_encryption_algorithms
  @server_encryption_algorithms
end

#server_encryption_key ⇒ String 



230
231
232
 
# File 'lib/ruby_smb/client.rb', line 230

def server_encryption_key
  @server_encryption_key
end

#server_guid ⇒ String 



252
253
254
 
# File 'lib/ruby_smb/client.rb', line 252

def server_guid
  @server_guid
end

#server_max_buffer_size ⇒ Object

The maximum size SMB message that the Server accepts (in bytes) The default value is small by default



189
190
191
 
# File 'lib/ruby_smb/client.rb', line 189

def server_max_buffer_size
  @server_max_buffer_size
end

#server_max_read_size ⇒ Integer 



199
200
201
 
# File 'lib/ruby_smb/client.rb', line 199

def server_max_read_size
  @server_max_read_size
end

#server_max_transact_size ⇒ Integer 



205
206
207
 
# File 'lib/ruby_smb/client.rb', line 205

def server_max_transact_size
  @server_max_transact_size
end

#server_max_write_size ⇒ Integer 



194
195
196
 
# File 'lib/ruby_smb/client.rb', line 194

def server_max_write_size
  @server_max_write_size
end

#server_start_time ⇒ Time 



259
260
261
 
# File 'lib/ruby_smb/client.rb', line 259

def server_start_time
  @server_start_time
end

#server_supports_multi_credit ⇒ Boolean

false otherwise



280
281
282
 
# File 'lib/ruby_smb/client.rb', line 280

def server_supports_multi_credit
  @server_supports_multi_credit
end

#server_system_time ⇒ Time 



266
267
268
 
# File 'lib/ruby_smb/client.rb', line 266

def server_system_time
  @server_system_time
end

#session_encrypt_data ⇒ Boolean 



235
236
237
 
# File 'lib/ruby_smb/client.rb', line 235

def session_encrypt_data
  @session_encrypt_data
end

#session_id ⇒ Integer 



130
131
132
 
# File 'lib/ruby_smb/client.rb', line 130

def session_id
  @session_id
end

#session_is_guest ⇒ Boolean 



135
136
137
 
# File 'lib/ruby_smb/client.rb', line 135

def session_is_guest
  @session_is_guest
end

#signing_enabled ⇒ Boolean 



140
 
# File 'lib/ruby_smb/client.rb', line 140

attr_accessor :signing_required

#signing_required ⇒ Object

Whether or not the Server requires signing



140
141
142
 
# File 'lib/ruby_smb/client.rb', line 140

def signing_required
  @signing_required
end

#smb1 ⇒ Boolean 



145
146
147
 
# File 'lib/ruby_smb/client.rb', line 145

def smb1
  @smb1
end

#smb2 ⇒ Boolean 



150
151
152
 
# File 'lib/ruby_smb/client.rb', line 150

def smb2
  @smb2
end

#smb2_message_id ⇒ Integer 



160
161
162
 
# File 'lib/ruby_smb/client.rb', line 160

def smb2_message_id
  @smb2_message_id
end

#smb3 ⇒ Boolean 



155
156
157
 
# File 'lib/ruby_smb/client.rb', line 155

def smb3
  @smb3
end

#user_id ⇒ Integer 



170
171
172
 
# File 'lib/ruby_smb/client.rb', line 170

def user_id
  @user_id
end

#username ⇒ String 



165
166
167
 
# File 'lib/ruby_smb/client.rb', line 165

def username
  @username
end

Instance Method Details

#can_be_encrypted?(packet) ⇒ Boolean

Check if the request packet can be encrypted. Per the SMB2 spec, SessionSetupRequest and NegotiateRequest must not be encrypted.



511
512
513
514
515
516
 
# File 'lib/ruby_smb/client.rb', line 511

def can_be_encrypted?(packet)
  return false if packet.packet_smb_version == 'SMB1'
  [RubySMB::SMB2::Packet::SessionSetupRequest, RubySMB::SMB2::Packet::NegotiateRequest].none? do |klass|
    packet.is_a?(klass)
  end
end

#disconnect! ⇒ void

This method returns an undefined value.

Logs off any currently open session on the server and closes the TCP socket connection.



337
338
339
340
341
342
343
344
 
# File 'lib/ruby_smb/client.rb', line 337

def disconnect!
  begin
    logoff!
  rescue
    wipe_state!
  end
  dispatcher.tcp_socket.close
end

#echo(count: 1, data: '') ⇒ WindowsError::ErrorCode

Sends an Echo request to the server and returns the NTStatus of the last response packet received.



352
353
354
355
356
357
358
359
 
# File 'lib/ruby_smb/client.rb', line 352

def echo(count: 1, data: '')
  response = if smb2 || smb3
               smb2_echo
             else
               smb1_echo(count: count, data: data)
             end
  response.status_code
end

#encryption_supported? ⇒ Boolean

Check if the current dialect supports encryption.



521
522
523
 
# File 'lib/ruby_smb/client.rb', line 521

def encryption_supported?
  ['0x0300', '0x0302', '0x0311'].include?(@dialect)
end

#increment_smb_message_id(packet) ⇒ RubySMB::GenericPacket

Sets the message id field in an SMB2 packet's header to the one tracked by the client. It then increments the counter on the client.



367
368
369
370
371
 
# File 'lib/ruby_smb/client.rb', line 367

def increment_smb_message_id(packet)
  packet.smb2_header.message_id = self.smb2_message_id
  self.smb2_message_id += 1
  packet
end

#is_status_pending?(smb2_header) ⇒ Boolean

Check if the response is an asynchronous operation with STATUS_PENDING status code.



499
500
501
502
503
504
 
# File 'lib/ruby_smb/client.rb', line 499

def is_status_pending?(smb2_header)
  value = smb2_header.nt_status.value
  status_code = WindowsError::NTStatus.find_by_retval(value).first
  status_code == WindowsError::NTStatus::STATUS_PENDING &&
    smb2_header.flags.async_command == 1
end

#login(username: self.username, password: self.password, domain: self.domain, local_workstation: self.local_workstation, ntlm_flags: NTLM::DEFAULT_CLIENT_FLAGS) ⇒ Object

Performs protocol negotiation and session setup. It defaults to using the credentials supplied during initialization, but can take a new set of credentials if needed.



375
376
377
378
379
380
381
382
 
# File 'lib/ruby_smb/client.rb', line 375

def (username: self.username, password: self.password,
          domain: self.domain, local_workstation: self.local_workstation,
          ntlm_flags: NTLM::DEFAULT_CLIENT_FLAGS)
  negotiate
  session_setup(username, password, domain,
                local_workstation: local_workstation,
                ntlm_flags: ntlm_flags)
end

#logoff! ⇒ WindowsError::ErrorCode

Sends a LOGOFF command to the remote server to terminate the session

Raises:



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
 
# File 'lib/ruby_smb/client.rb', line 406

def logoff!
  if smb2 || smb3
    request      = RubySMB::SMB2::Packet::LogoffRequest.new
    raw_response = send_recv(request)
    response     = RubySMB::SMB2::Packet::LogoffResponse.read(raw_response)
    unless response.valid?
      raise RubySMB::Error::InvalidPacket.new(
        expected_proto: RubySMB::SMB2::SMB2_PROTOCOL_ID,
        expected_cmd:   RubySMB::SMB2::Packet::LogoffResponse::COMMAND,
        packet:         response
      )
    end
  else
    request      = RubySMB::SMB1::Packet::LogoffRequest.new
    raw_response = send_recv(request)
    response     = RubySMB::SMB1::Packet::LogoffResponse.read(raw_response)
    unless response.valid?
      raise RubySMB::Error::InvalidPacket.new(
        expected_proto: RubySMB::SMB1::SMB_PROTOCOL_ID,
        expected_cmd:   RubySMB::SMB1::Packet::LogoffResponse::COMMAND,
        packet:         response
      )
    end
  end
  wipe_state!
  response.status_code
end

#net_share_enum_all(host) ⇒ Array

Returns array of shares



590
591
592
593
594
 
# File 'lib/ruby_smb/client.rb', line 590

def net_share_enum_all(host)
  tree = tree_connect("\\\\#{host}\\IPC$")
  named_pipe = tree.open_pipe(filename: "srvsvc", write: true, read: true)
  named_pipe.net_share_enum_all(host)
end

#recv_packet(encrypt: false) ⇒ String

Receives the raw response through the Dispatcher and decrypt the packet (if required).



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/ruby_smb/client.rb', line 544

def recv_packet(encrypt: false)
  begin
    raw_response = dispatcher.recv_packet
  rescue RubySMB::Error::CommunicationError => e
    if encrypt
      raise RubySMB::Error::EncryptionError, "Communication error with the "\
        "remote host: #{e.message}. The server supports encryption but was "\
        "not able to handle the encrypted request."
    else
      raise e
    end
  end
  if encrypt
    begin
      transform_response = RubySMB::SMB2::Packet::TransformHeader.read(raw_response)
    rescue IOError
      raise RubySMB::Error::InvalidPacket, 'Not a SMB2 TransformHeader packet'
    end
    begin
      raw_response = smb3_decrypt(transform_response)
    rescue RubySMB::Error::RubySMBError => e
      raise RubySMB::Error::EncryptionError, "Error while decrypting #{transform_response.class.name} packet (SMB #@dialect}): #{e}"
    end
  end
  raw_response
end

#send_packet(packet, encrypt: false) ⇒ Object

Encrypt (if required) and send a packet.



529
530
531
532
533
534
535
536
537
538
 
# File 'lib/ruby_smb/client.rb', line 529

def send_packet(packet, encrypt: false)
  if encrypt
    begin
      packet = smb3_encrypt(packet.to_binary_s)
    rescue RubySMB::Error::RubySMBError => e
      raise RubySMB::Error::EncryptionError, "Error while encrypting #{packet.class.name} packet (SMB #{@dialect}): #{e}"
    end
  end
  dispatcher.send_packet(packet)
end

#send_recv(packet, encrypt: false) ⇒ String

Sends a packet and receives the raw response through the Dispatcher. It will also sign the packet if necessary.



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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/ruby_smb/client.rb', line 442

def send_recv(packet, encrypt: false)
  version = packet.packet_smb_version
  case version
  when 'SMB1'
    packet.smb_header.uid = self.user_id if self.user_id
    packet.smb_header.pid_low = self.pid if self.pid
    packet = smb1_sign(packet) if signing_required && !session_key.empty?
  when 'SMB2'
    packet = increment_smb_message_id(packet)
    packet.smb2_header.session_id = session_id
    unless packet.is_a?(RubySMB::SMB2::Packet::SessionSetupRequest) || session_key.empty?
      if self.smb2 && signing_required
        packet = smb2_sign(packet)
      elsif self.smb3
        # see: https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-smb2/652e0c14-5014-4470-999d-b174d7b2da87
        if @dialect == '0x0311' && (signing_required || (!@session_is_guest && packet.is_a?(RubySMB::SMB2::Packet::TreeConnectRequest)))
          packet = smb3_sign(packet)
        elsif signing_required
          packet = smb3_sign(packet)
        end
      end
    end
  else
    packet = packet
  end

  encrypt_data = false
  if can_be_encrypted?(packet) && encryption_supported? && (@session_encrypt_data || encrypt)
    encrypt_data = true
  end
  send_packet(packet, encrypt: encrypt_data)
  raw_response = recv_packet(encrypt: encrypt_data)
  smb2_header = nil
  loop do
    smb2_header = RubySMB::SMB2::SMB2Header.read(raw_response)
    break unless is_status_pending?(smb2_header)
    sleep 1
    raw_response = recv_packet(encrypt: encrypt_data)
  rescue IOError
    # We're expecting an SMB2 packet, but the server sent an SMB1 packet
    # instead. This behavior has been observed with older versions of Samba
    # when something goes wrong on the server side. So, we just ignore it
    # and expect the caller to handle this wrong response packet.
    break
  end unless version == 'SMB1'

  self.sequence_counter += 1 if signing_required && !session_key.empty?
  # update the SMB2 message ID according to the received Credit Charged
  self.smb2_message_id += smb2_header.credit_charge - 1 if smb2_header && self.server_supports_multi_credit
  raw_response
end

#session_request(name = '*SMBSERVER') ⇒ TrueClass

Requests a NetBIOS Session Service using the provided name.

Raises:



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/ruby_smb/client.rb', line 619

def session_request(name = '*SMBSERVER')
  session_request = session_request_packet(name)
  dispatcher.send_packet(session_request, nbss_header: false)
  raw_response = dispatcher.recv_packet(full_response: true)
  begin
    session_header = RubySMB::Nbss::SessionHeader.read(raw_response)
    if session_header.session_packet_type == RubySMB::Nbss::NEGATIVE_SESSION_RESPONSE
      negative_session_response =  RubySMB::Nbss::NegativeSessionResponse.read(raw_response)
      raise RubySMB::Error::NetBiosSessionService, "Session Request failed: #{negative_session_response.error_msg}"
    end
  rescue IOError
    raise RubySMB::Error::InvalidPacket, 'Not a NBSS packet'
  end

  return true
end

#session_request_packet(name = '*SMBSERVER') ⇒ RubySMB::Nbss::SessionRequest

Crafts the NetBIOS SessionRequest packet to be sent for session request operations.



640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/ruby_smb/client.rb', line 640

def session_request_packet(name = '*SMBSERVER')
  called_name = "#{name.upcase.ljust(15)}\x20"
  calling_name = "#{''.ljust(15)}\x00"

  session_request = RubySMB::Nbss::SessionRequest.new
  session_request.session_header.session_packet_type = RubySMB::Nbss::SESSION_REQUEST
  session_request.called_name  = called_name
  session_request.calling_name = calling_name
  session_request.session_header.stream_protocol_length =
    session_request.num_bytes - session_request.session_header.num_bytes
  session_request
end

#session_setup(user, pass, domain, do_recv = true, local_workstation: self.local_workstation, ntlm_flags: NTLM::DEFAULT_CLIENT_FLAGS) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ruby_smb/client.rb', line 384

def session_setup(user, pass, domain, do_recv=true,
                  local_workstation: self.local_workstation, ntlm_flags: NTLM::DEFAULT_CLIENT_FLAGS)
  @domain            = domain
  @local_workstation = local_workstation
  @password          = pass.encode('utf-8') || ''.encode('utf-8')
  @username          = user.encode('utf-8') || ''.encode('utf-8')

  @ntlm_client = Net::NTLM::Client.new(
      @username,
      @password,
      workstation: @local_workstation,
      domain: @domain,
      flags: ntlm_flags
  )

  authenticate
end

#tree_connect(share) ⇒ RubySMB::SMB1::Tree, RubySMB::SMB2::Tree

Connects to the supplied share



576
577
578
579
580
581
582
583
584
 
# File 'lib/ruby_smb/client.rb', line 576

def tree_connect(share)
  connected_tree = if smb2 || smb3
    smb2_tree_connect(share)
  else
    smb1_tree_connect(share)
  end
  @tree_connects << connected_tree
  connected_tree
end

#update_preauth_hash(data) ⇒ Object 



653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/ruby_smb/client.rb', line 653

def update_preauth_hash(data)
  unless @preauth_integrity_hash_algorithm
    raise RubySMB::Error::EncryptionError.new(
      'Cannot compute the Preauth Integrity Hash value: Preauth Integrity Hash Algorithm is nil'
    )
  end
  @preauth_integrity_hash_value = OpenSSL::Digest.digest(
    @preauth_integrity_hash_algorithm,
    @preauth_integrity_hash_value + data.to_binary_s
  )
end

#wipe_state! ⇒ void

This method returns an undefined value.

Resets all of the session state on the client, setting it back to scratch. Should only be called when a session is no longer valid.



601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/ruby_smb/client.rb', line 601

def wipe_state!
  self.session_id       = 0x00
  self.user_id          = 0x00
  self.session_key      = ''
  self.session_is_guest = false
  self.sequence_counter = 0
  self.smb2_message_id  = 0
  self.client_encryption_key = nil
  self.server_encryption_key = nil
  self.server_supports_multi_credit = false
end