ruby_smb 3.3.19 → 3.3.20

data/examples/read_file_encryption.rb

@@ -1,24 +1,11 @@
 #!/usr/bin/ruby
 
-# This example script is used for testing the reading of a file.
+# This example script is used for testing the reading of a file with SMBv3 encryption.
 # It will attempt to connect to a specific share and then read a specified file.
-# Example usage: ruby read_file.rb 192.168.172.138 msfadmin msfadmin TEST_SHARE short.txt
+# Example usage: ruby read_file_encryption.rb --username msfadmin --password msfadmin 192.168.172.138 TEST_SHARE short.txt
 # This will try to connect to \\192.168.172.138\TEST_SHARE with the msfadmin:msfadmin credentials
 # and read the file short.txt
 
-require 'bundler/setup'
-require 'ruby_smb'
-
-address  = ARGV[0]
-username = ARGV[1]
-password = ARGV[2]
-share    = ARGV[3]
-filename = ARGV[4]
-path     = "\\\\#{address}\\#{share}"
-
-sock = TCPSocket.new address, 445
-dispatcher = RubySMB::Dispatcher::Socket.new(sock)
-
 # To require encryption on the server, run this in an elevated Powershell:
 # C:\> Set-SmbServerConfiguration -EncryptData $true
 
@@ -26,20 +13,78 @@ dispatcher = RubySMB::Dispatcher::Socket.new(sock)
 # C:\ Set-SmbServerConfiguration -EncryptData $false
 # C:\ Set-SmbShare -Name <share name> -EncryptData 1
 
-# For this encryption to work, it has to be SMBv3. By only setting smb3 to true,
-# we make sure the server will negotiate this version, if it supports it
-opts = {
-  smb1: false,
-  smb2: false,
-  smb3: true,
-  username: username,
-  password: password,
+# For this encryption to work, it has to be SMBv3. By default, SMBv1 and SMBv2
+# are disabled here so the server will negotiate SMBv3 if it supports it.
+
+require 'bundler/setup'
+require 'optparse'
+require 'ruby_smb'
+
+args = ARGV.dup
+options = {
+  domain: '.',
+  username: '',
+  password: '',
+  smbv1: false,
+  smbv2: false,
+  smbv3: true,
+  target: nil,
+  share: nil,
+  file: nil
 }
+options[:file] = args.pop
+options[:share] = args.pop
+options[:target] = args.pop
+optparser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] target share file"
+  opts.on("--[no-]smbv1", "Enable or disable SMBv1 (default: #{options[:smbv1] ? 'Enabled' : 'Disabled'})") do |smbv1|
+    options[:smbv1] = smbv1
+  end
+  opts.on("--[no-]smbv2", "Enable or disable SMBv2 (default: #{options[:smbv2] ? 'Enabled' : 'Disabled'})") do |smbv2|
+    options[:smbv2] = smbv2
+  end
+  opts.on("--[no-]smbv3", "Enable or disable SMBv3 (default: #{options[:smbv3] ? 'Enabled' : 'Disabled'})") do |smbv3|
+    options[:smbv3] = smbv3
+  end
+  opts.on("--username USERNAME", "The account's username (default: #{options[:username]})") do |username|
+    if username.include?('\\')
+      options[:domain], options[:username] = username.split('\\', 2)
+    else
+      options[:username] = username
+    end
+  end
+  opts.on("--password PASSWORD", "The account's password (default: #{options[:password]})") do |password|
+    options[:password] = password
+  end
+end
+optparser.parse!(args)
+
+if [options[:target], options[:share], options[:file]].any? { |a| a == '-h' || a == '--help' }
+  puts optparser.help
+  exit
+end
+
+if options[:target].nil? || options[:share].nil? || options[:file].nil?
+  abort(optparser.help)
+end
+
+path = "\\\\#{options[:target]}\\#{options[:share]}"
+
+sock = TCPSocket.new options[:target], 445
+dispatcher = RubySMB::Dispatcher::Socket.new(sock)
 
 # By default, the client uses encryption even if it is not required by the server. Disable this by setting always_encrypt to false
-#opts[:always_encrypt] = false
+client_opts = {
+  smb1: options[:smbv1],
+  smb2: options[:smbv2],
+  smb3: options[:smbv3],
+  username: options[:username],
+  password: options[:password],
+  domain: options[:domain]
+}
+#client_opts[:always_encrypt] = false
 
-client = RubySMB::Client.new(dispatcher, opts)
+client = RubySMB::Client.new(dispatcher, **client_opts)
 protocol = client.negotiate
 status = client.authenticate
 
@@ -49,7 +94,7 @@ rescue StandardError => e
   puts "Failed to connect to #{path}: #{e.message}"
 end
 
-file = tree.open_file(filename: filename)
+file = tree.open_file(filename: options[:file])
 
 data = file.read
 puts data

data/examples/read_registry_key_value.rb

@@ -2,23 +2,69 @@
 
 # This example script is used for testing the Winreg registry key value read functionality.
 # It will attempt to connect to a host and reads the value of a specified registry key.
-# Example usage: ruby enum_registry_key.rb 192.168.172.138 msfadmin msfadmin HKLM\\My\\Key ValueName
+# Example usage: ruby read_registry_key_value.rb --username msfadmin --password msfadmin 192.168.172.138 HKLM\\My\\Key ValueName
 # This will try to connect to \\192.168.172.138 with the msfadmin:msfadmin credentialas and reads the ValueName data corresponding to the HKLM\\My\\Key registry key.
 
 require 'bundler/setup'
+require 'optparse'
 require 'ruby_smb'
 
-address      = ARGV[0]
-username     = ARGV[1]
-password     = ARGV[2]
-registry_key = ARGV[3]
-value_name   = ARGV[4]
-smb_versions = ARGV[5]&.split(',') || ['1','2','3']
+args = ARGV.dup
+options = {
+  domain: '.',
+  username: '',
+  password: '',
+  smbv1: true,
+  smbv2: true,
+  smbv3: true,
+  target: nil,
+  registry_key: nil,
+  value_name: nil
+}
+options[:value_name] = args.pop
+options[:registry_key] = args.pop
+options[:target] = args.pop
+optparser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] target registry_key value_name"
+  opts.on("--[no-]smbv1", "Enable or disable SMBv1 (default: #{options[:smbv1] ? 'Enabled' : 'Disabled'})") do |smbv1|
+    options[:smbv1] = smbv1
+  end
+  opts.on("--[no-]smbv2", "Enable or disable SMBv2 (default: #{options[:smbv2] ? 'Enabled' : 'Disabled'})") do |smbv2|
+    options[:smbv2] = smbv2
+  end
+  opts.on("--[no-]smbv3", "Enable or disable SMBv3 (default: #{options[:smbv3] ? 'Enabled' : 'Disabled'})") do |smbv3|
+    options[:smbv3] = smbv3
+  end
+  opts.on("--username USERNAME", "The account's username (default: #{options[:username]})") do |username|
+    if username.include?('\\')
+      options[:domain], options[:username] = username.split('\\', 2)
+    else
+      options[:username] = username
+    end
+  end
+  opts.on("--password PASSWORD", "The account's password (default: #{options[:password]})") do |password|
+    options[:password] = password
+  end
+end
+optparser.parse!(args)
+
+if [options[:target], options[:registry_key], options[:value_name]].any? { |a| a == '-h' || a == '--help' }
+  puts optparser.help
+  exit
+end
+
+if options[:target].nil? || options[:registry_key].nil? || options[:value_name].nil?
+  abort(optparser.help)
+end
+
+address = options[:target]
+registry_key = options[:registry_key]
+value_name = options[:value_name]
 
 sock = TCPSocket.new address, 445
 dispatcher = RubySMB::Dispatcher::Socket.new(sock, read_timeout: 60)
 
-client = RubySMB::Client.new(dispatcher, smb1: smb_versions.include?('1'), smb2: smb_versions.include?('2'), smb3: smb_versions.include?('3'), username: username, password: password)
+client = RubySMB::Client.new(dispatcher, smb1: options[:smbv1], smb2: options[:smbv2], smb3: options[:smbv3], username: options[:username], password: options[:password], domain: options[:domain])
 protocol = client.negotiate
 status = client.authenticate
 
@@ -30,4 +76,3 @@ key_value = client.read_registry_key_value(address, registry_key, value_name)
 puts key_value
 
 client.disconnect!
-

data/examples/rename_file.rb

@@ -1,28 +1,71 @@
 #!/usr/bin/ruby
 
-# This example script is used for testing the deleting of a file.
+# This example script is used for testing the renaming of a file.
 # It will attempt to connect to a specific share and then rename a specified file.
-# Example usage: ruby rename_file.rb 192.168.172.138 msfadmin msfadmin TEST_SHARE short.txt shortrenamed.txt
+# Example usage: ruby rename_file.rb --username msfadmin --password msfadmin 192.168.172.138 TEST_SHARE short.txt shortrenamed.txt
 # This will try to connect to \\192.168.172.138\TEST_SHARE with the msfadmin:msfadmin credentials
-# and rename the file short.txt
+# and rename the file short.txt to shortrenamed.txt
 
 require 'bundler/setup'
+require 'optparse'
 require 'ruby_smb'
 
-address      = ARGV[0]
-username     = ARGV[1]
-password     = ARGV[2]
-share        = ARGV[3]
-file         = ARGV[4]
-new_name     = ARGV[5]
-smb_versions = ARGV[6]&.split(',') || ['1','2','3']
+args = ARGV.dup
+options = {
+  domain: '.',
+  username: '',
+  password: '',
+  smbv1: true,
+  smbv2: true,
+  smbv3: true,
+  target: nil,
+  share: nil,
+  file: nil,
+  new_name: nil
+}
+options[:new_name] = args.pop
+options[:file] = args.pop
+options[:share] = args.pop
+options[:target] = args.pop
+optparser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] target share file new_name"
+  opts.on("--[no-]smbv1", "Enable or disable SMBv1 (default: #{options[:smbv1] ? 'Enabled' : 'Disabled'})") do |smbv1|
+    options[:smbv1] = smbv1
+  end
+  opts.on("--[no-]smbv2", "Enable or disable SMBv2 (default: #{options[:smbv2] ? 'Enabled' : 'Disabled'})") do |smbv2|
+    options[:smbv2] = smbv2
+  end
+  opts.on("--[no-]smbv3", "Enable or disable SMBv3 (default: #{options[:smbv3] ? 'Enabled' : 'Disabled'})") do |smbv3|
+    options[:smbv3] = smbv3
+  end
+  opts.on("--username USERNAME", "The account's username (default: #{options[:username]})") do |username|
+    if username.include?('\\')
+      options[:domain], options[:username] = username.split('\\', 2)
+    else
+      options[:username] = username
+    end
+  end
+  opts.on("--password PASSWORD", "The account's password (default: #{options[:password]})") do |password|
+    options[:password] = password
+  end
+end
+optparser.parse!(args)
+
+if [options[:target], options[:share], options[:file], options[:new_name]].any? { |a| a == '-h' || a == '--help' }
+  puts optparser.help
+  exit
+end
+
+if options[:target].nil? || options[:share].nil? || options[:file].nil? || options[:new_name].nil?
+  abort(optparser.help)
+end
 
-path     = "\\\\#{address}\\#{share}"
+path = "\\\\#{options[:target]}\\#{options[:share]}"
 
-sock = TCPSocket.new address, 445
+sock = TCPSocket.new options[:target], 445
 dispatcher = RubySMB::Dispatcher::Socket.new(sock)
 
-client = RubySMB::Client.new(dispatcher, smb1: smb_versions.include?('1'), smb2: smb_versions.include?('2'), smb3: smb_versions.include?('3'), username: username, password: password)
+client = RubySMB::Client.new(dispatcher, smb1: options[:smbv1], smb2: options[:smbv2], smb3: options[:smbv3], username: options[:username], password: options[:password], domain: options[:domain])
 
 protocol = client.negotiate
 status = client.authenticate
@@ -36,8 +79,8 @@ rescue StandardError => e
   puts "Failed to connect to #{path}: #{e.message}"
 end
 
-file = tree.open_file(filename: file, write: true, delete: true)
+file = tree.open_file(filename: options[:file], write: true, delete: true)
 
-data = file.rename(new_name)
+data = file.rename(options[:new_name])
 puts data
 file.close

data/examples/write_file.rb

@@ -2,27 +2,70 @@
 
 # This example script is used for testing the writing to a file.
 # It will attempt to connect to a specific share and then write to a specified file.
-# Example usage: ruby write_file.rb 192.168.172.138 msfadmin msfadmin TEST_SHARE test.txt "data to write"
+# Example usage: ruby write_file.rb --username msfadmin --password msfadmin 192.168.172.138 TEST_SHARE test.txt "data to write"
 # This will try to connect to \\192.168.172.138\TEST_SHARE with the msfadmin:msfadmin credentials
-# and write "data to write" the file test.txt
+# and write "data to write" to the file test.txt
 
 require 'bundler/setup'
+require 'optparse'
 require 'ruby_smb'
 
-address      = ARGV[0]
-username     = ARGV[1]
-password     = ARGV[2]
-share        = ARGV[3]
-file         = ARGV[4]
-data         = ARGV[5]
-smb_versions = ARGV[6]&.split(',') || ['1','2','3']
+args = ARGV.dup
+options = {
+  domain: '.',
+  username: '',
+  password: '',
+  smbv1: true,
+  smbv2: true,
+  smbv3: true,
+  target: nil,
+  share: nil,
+  file: nil,
+  data: nil
+}
+options[:data] = args.pop
+options[:file] = args.pop
+options[:share] = args.pop
+options[:target] = args.pop
+optparser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] target share file data"
+  opts.on("--[no-]smbv1", "Enable or disable SMBv1 (default: #{options[:smbv1] ? 'Enabled' : 'Disabled'})") do |smbv1|
+    options[:smbv1] = smbv1
+  end
+  opts.on("--[no-]smbv2", "Enable or disable SMBv2 (default: #{options[:smbv2] ? 'Enabled' : 'Disabled'})") do |smbv2|
+    options[:smbv2] = smbv2
+  end
+  opts.on("--[no-]smbv3", "Enable or disable SMBv3 (default: #{options[:smbv3] ? 'Enabled' : 'Disabled'})") do |smbv3|
+    options[:smbv3] = smbv3
+  end
+  opts.on("--username USERNAME", "The account's username (default: #{options[:username]})") do |username|
+    if username.include?('\\')
+      options[:domain], options[:username] = username.split('\\', 2)
+    else
+      options[:username] = username
+    end
+  end
+  opts.on("--password PASSWORD", "The account's password (default: #{options[:password]})") do |password|
+    options[:password] = password
+  end
+end
+optparser.parse!(args)
+
+if [options[:target], options[:share], options[:file], options[:data]].any? { |a| a == '-h' || a == '--help' }
+  puts optparser.help
+  exit
+end
+
+if options[:target].nil? || options[:share].nil? || options[:file].nil? || options[:data].nil?
+  abort(optparser.help)
+end
 
-path     = "\\\\#{address}\\#{share}"
+path = "\\\\#{options[:target]}\\#{options[:share]}"
 
-sock = TCPSocket.new address, 445
+sock = TCPSocket.new options[:target], 445
 dispatcher = RubySMB::Dispatcher::Socket.new(sock)
 
-client = RubySMB::Client.new(dispatcher, smb1: smb_versions.include?('1'), smb2: smb_versions.include?('2'), smb3: smb_versions.include?('3'), username: username, password: password)
+client = RubySMB::Client.new(dispatcher, smb1: options[:smbv1], smb2: options[:smbv2], smb3: options[:smbv3], username: options[:username], password: options[:password], domain: options[:domain])
 protocol = client.negotiate
 status = client.authenticate
 
@@ -32,11 +75,11 @@ begin
   tree = client.tree_connect(path)
   puts "Connected to #{path} successfully!"
 rescue StandardError => e
-  puts "Failed to connect to #{path}: #{e.message}"
+  abort("Failed to connect to #{path}: #{e.message}")
 end
 
-file = tree.open_file(filename: file, write: true, disposition: RubySMB::Dispositions::FILE_OVERWRITE_IF)
+file = tree.open_file(filename: options[:file], write: true, disposition: RubySMB::Dispositions::FILE_OVERWRITE_IF)
 
-result = file.write(data: data)
+result = file.write(data: options[:data])
 puts result.to_s
 file.close

data/lib/ruby_smb/version.rb

@@ -1,3 +1,3 @@
 module RubySMB
-  VERSION = '3.3.19'.freeze
+  VERSION = '3.3.20'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_smb
 version: !ruby/object:Gem::Version
-  version: 3.3.19
+  version: 3.3.20
 platform: ruby
 authors:
 - Metasploit Hackers
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet