browserstack-local 1.4.3 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8908a1d1804c2e04da139de1fc8a3bb7631780f0a8ee99753cd78f5c4e8134
-  data.tar.gz: 2d113c112835b279292b5aac0042efa5d77fce7fbc2d3bf775b817bea0b7b440
+  metadata.gz: e32e052d39ddb27d0c6d4e65796a8d7155896124874e6b98cb7a187f8ac2580b
+  data.tar.gz: a3708dc83e2be4f34aa09efb80a3a7a414449fecef23f19d2cf58db933f114fb
 SHA512:
-  metadata.gz: aad48f4723959de92ee40fc564167aea7d78ea98423557feda42e793d75acb57bb26a9f2944595693460aaae273c5b7058ebdcf6bbae8a70923335efa6ad742f
-  data.tar.gz: bd759d61834aacc1647e0c21caf07fc274a5aef426ec92ee71836153cf9f6d312dfd480c9392527c81d3b018e32b60be544dbacebbdfa6ccb90f015d254a0d59
+  metadata.gz: dfc70f0d1c49f0aeda327cd85bb6ebdd2e920c3757cfea81098a35b1c28925d7b2c621c2b7bb630d781f9a80b8bc003feccb675958594a97b66c50e79842c76a
+  data.tar.gz: 21b7f15d270f6163aa930f424831f5b286ad36560416cfe602ac559c4e13ee62177824e52680aaa94f19f7c70ed0132fd13fa980e999a29da6c2ba87351cc41c

data/lib/browserstack/fetch_download_source_url.rb

@@ -0,0 +1,63 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'openssl'
+require 'browserstack/localexception'
+
+module BrowserStack
+  module FetchDownloadSourceUrl
+    BS_HOST = 'local.browserstack.com'.freeze
+    ENDPOINT_PATH = '/binary/api/v1/endpoint'.freeze
+
+    def self.call(auth_token:, user_agent:, fallback: false, error_message: nil,
+                  proxy_host: nil, proxy_port: nil)
+      uri = URI::HTTPS.build(host: BS_HOST, path: ENDPOINT_PATH)
+
+      body = { 'auth_token' => auth_token }
+      body['error_message'] = error_message if fallback && error_message
+
+      http_class = if proxy_host && proxy_port
+                     Net::HTTP::Proxy(proxy_host, proxy_port.to_i)
+                   else
+                     Net::HTTP
+                   end
+
+      http = http_class.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.open_timeout = 10
+      http.read_timeout = 15
+
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req['Content-Type'] = 'application/json'
+      req['User-Agent'] = user_agent
+      req['X-Local-Fallback-Cloudflare'] = 'true' if fallback
+      req.body = JSON.dump(body)
+
+      res = http.request(req)
+
+      begin
+        parsed = JSON.parse(res.body.to_s)
+      rescue JSON::ParserError => e
+        raise BrowserStack::LocalException.new(
+          "Failed to parse binary endpoint API response (HTTP #{res.code}): #{e.message}"
+        )
+      end
+
+      if parsed.is_a?(Hash) && parsed['error']
+        raise BrowserStack::LocalException.new(
+          "Binary endpoint API returned error: #{parsed['error']}"
+        )
+      end
+
+      endpoint = parsed.is_a?(Hash) ? parsed.dig('data', 'endpoint') : nil
+      if endpoint.nil? || endpoint.to_s.empty?
+        raise BrowserStack::LocalException.new(
+          "Binary endpoint API returned no endpoint (HTTP #{res.code})"
+        )
+      end
+
+      endpoint
+    end
+  end
+end

data/lib/browserstack/local.rb

@@ -1,6 +1,7 @@
 require 'browserstack/localbinary'
 require 'browserstack/localexception'
 require 'json'
+require 'fileutils'
 
 module BrowserStack
 
@@ -64,15 +65,25 @@ class Local
     end
 
     @binary_path = if @binary_path.nil?
-        BrowserStack::LocalBinary.new.binary_path
+        BrowserStack::LocalBinary.new(
+          auth_token: @key,
+          proxy_host: @proxy_host,
+          proxy_port: @proxy_port
+        ).binary_path
       else
         @binary_path
       end
     
-    if @is_windows
-      system("echo > #{@logfile}")
-    else
-      system("echo '' > '#{@logfile}'")
+    # Create/truncate the logfile without a shell. The previous
+    # `system("echo ... > #{@logfile}")` passed @logfile to /bin/sh (or cmd.exe),
+    # so shell metacharacters in a caller-supplied logfile path executed as commands
+    # (CWE-78). File.write treats the path purely as a filename.
+    logfile_dir = File.dirname(@logfile)
+    FileUtils.mkdir_p(logfile_dir) unless File.directory?(logfile_dir)
+    begin
+      File.write(@logfile, "")
+    rescue SystemCallError => e
+      raise BrowserStack::LocalException.new("Unable to open logfile: #{e.message}")
     end
 
     if defined? spawn
@@ -117,12 +128,27 @@ class Local
     @pid = nil
   end
 
+  # Public accessor used by callers for debugging/logging. Return the command
+  # with the access key masked so it is never written to logs, CI artifacts or
+  # error trackers (CWE-312). The real key is still used for execution via
+  # start_command_args / start_command(false).
   def command
-    start_command
+    start_command(true)
+  end
+
+  # Prevent Ruby's default #inspect from dumping @key when a Local instance is
+  # logged or included in an exception payload (CWE-312).
+  def inspect
+    redacted = instance_variables.map do |var|
+      value = var == :@key && !@key.to_s.empty? ? "[REDACTED]" : instance_variable_get(var)
+      "#{var}=#{value.inspect}"
+    end.join(", ")
+    "#<#{self.class}:0x#{format('%016x', object_id << 1)} #{redacted}>"
   end
 
-  def start_command
-    cmd = "#{@binary_path} -d start -logFile '#{@logfile}' #{@folder_flag} #{@key} #{@folder_path} #{@force_local_flag}"
+  def start_command(redact = false)
+    key = redact && !@key.to_s.empty? ? "[REDACTED]" : @key
+    cmd = "#{@binary_path} -d start -logFile '#{@logfile}' #{@folder_flag} #{key} #{@folder_path} #{@force_local_flag}"
     cmd += " -localIdentifier #{@local_identifier_flag}" if @local_identifier_flag
     cmd += " #{@only_flag} #{@only_automate_flag}"
     cmd += " -proxyHost #{@proxy_host}" if @proxy_host

data/lib/browserstack/localbinary.rb

@@ -3,28 +3,27 @@ require 'net/https'
 require 'rbconfig'
 require 'openssl'
 require 'tmpdir'
+require 'fileutils'
 require 'browserstack/localexception'
+require 'browserstack/fetch_download_source_url'
+require 'browserstack/version'
 
 module BrowserStack
-  
+
 class LocalBinary
-  def initialize
-    host_os = RbConfig::CONFIG['host_os']
-    @http_path = case host_os
-    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-      @windows = true
-      "https://www.browserstack.com/local-testing/downloads/binaries/BrowserStackLocal.exe"
-    when /darwin|mac os/
-      "https://www.browserstack.com/local-testing/downloads/binaries/BrowserStackLocal-darwin-x64"
-    when /linux-musl/
-      "https://www.browserstack.com/local-testing/downloads/binaries/BrowserStackLocal-alpine"
-    when /linux/
-      if 1.size == 8
-        "https://www.browserstack.com/local-testing/downloads/binaries/BrowserStackLocal-linux-x64"
-      else
-        "https://www.browserstack.com/local-testing/downloads/binaries/BrowserStackLocal-linux-ia32"
-      end
-    end
+  BASE_RETRIES = 9
+  FALLBACK_TRIGGER_RETRY = 4
+
+  def initialize(conf = {})
+    @auth_token = conf[:auth_token] || ENV['BROWSERSTACK_ACCESS_KEY']
+    @proxy_host = conf[:proxy_host]
+    @proxy_port = conf[:proxy_port]
+    @user_agent = conf[:user_agent] || "browserstack-local-ruby/#{BrowserStack::VERSION}"
+
+    @windows = !!(RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/)
+    @binary_filename = compute_binary_filename
+    @source_url = nil
+    @download_error_message = nil
 
     @ordered_paths = [
       File.join(File.expand_path('~'), '.browserstack'),
@@ -33,79 +32,132 @@ class LocalBinary
     ]
   end
 
-  def download(dest_parent_dir)
-    unless File.exist? dest_parent_dir
-      Dir.mkdir dest_parent_dir
-    end
-    uri = URI.parse(@http_path)
-    binary_path = File.join(dest_parent_dir, "BrowserStackLocal#{".exe" if @windows}")
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true
-    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-    res = http.get(uri.path)
-    file = open(binary_path, 'wb')
-    file.write(res.body)
-    file.close
-    FileUtils.chmod 0755, binary_path
-
-    binary_path
-  end
+  def binary_path
+    dest_parent_dir = get_available_dirs
+    bin_path = File.join(dest_parent_dir, dest_binary_name)
 
-  def verify_binary(binary_path)
-    binary_response = IO.popen(binary_path + " --version").readline
-    binary_response =~ /BrowserStack Local version \d+\.\d+/
-  rescue Exception => e
-    false
+    return bin_path if File.exist?(bin_path) && verify_binary(bin_path)
+
+    File.delete(bin_path) if File.exist?(bin_path)
+    download_with_retries(bin_path)
   end
 
-  def binary_path
-    dest_parent_dir = get_available_dirs
-    binary_path = File.join(dest_parent_dir, "BrowserStackLocal#{".exe" if @windows}")
+  private
 
-    if File.exist? binary_path
-      binary_path
+  def dest_binary_name
+    @windows ? 'BrowserStackLocal.exe' : 'BrowserStackLocal'
+  end
+
+  def compute_binary_filename
+    host_os = RbConfig::CONFIG['host_os']
+    host_cpu = RbConfig::CONFIG['host_cpu']
+    case host_os
+    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+      'BrowserStackLocal.exe'
+    when /darwin|mac os/
+      'BrowserStackLocal-darwin-x64'
+    when /linux/
+      if host_cpu =~ /arm64|aarch64/
+        'BrowserStackLocal-linux-arm64'
+      elsif host_os =~ /linux-musl/
+        'BrowserStackLocal-alpine'
+      elsif 1.size == 8
+        'BrowserStackLocal-linux-x64'
+      else
+        'BrowserStackLocal-linux-ia32'
+      end
     else
-      binary_path = download(dest_parent_dir)
+      raise BrowserStack::LocalException.new("Unsupported host OS: #{host_os}")
     end
+  end
 
-    valid_binary = verify_binary(binary_path)
-
-    if valid_binary
-      binary_path
-    else
-      binary_path = download(dest_parent_dir)
-      valid_binary = verify_binary(binary_path)
-      if valid_binary
-        binary_path
-      else
-        raise BrowserStack::LocalException.new('BrowserStack Local binary is corrupt')
+  def download_with_retries(bin_path)
+    retries = BASE_RETRIES
+    while retries > 0
+      refresh_source_url(retries) if retries == BASE_RETRIES || retries == FALLBACK_TRIGGER_RETRY
+      begin
+        download_to(@source_url + '/' + @binary_filename, bin_path)
+        return bin_path if verify_binary(bin_path)
+        @download_error_message = 'Downloaded binary failed verification'
+      rescue StandardError => e
+        @download_error_message = "Download failed: #{e.message}"
       end
+      File.delete(bin_path) if File.exist?(bin_path)
+      retries -= 1
     end
+
+    raise BrowserStack::LocalException.new(
+      "Failed to download BrowserStack Local binary after #{BASE_RETRIES} attempts. " \
+      "Last error: #{@download_error_message}"
+    )
   end
 
-  private
+  def refresh_source_url(retries)
+    is_fallback = (retries == FALLBACK_TRIGGER_RETRY) && !@download_error_message.nil?
+    begin
+      @source_url = BrowserStack::FetchDownloadSourceUrl.call(
+        auth_token: @auth_token,
+        user_agent: @user_agent,
+        fallback: is_fallback,
+        error_message: @download_error_message,
+        proxy_host: @proxy_host,
+        proxy_port: @proxy_port
+      )
+    rescue StandardError => e
+      raise if @source_url.nil?
+      @download_error_message = "Source URL refresh failed: #{e.message}"
+    end
+  end
+
+  def download_to(url, bin_path)
+    uri = URI.parse(url)
+    http_class = if @proxy_host && @proxy_port
+                   Net::HTTP::Proxy(@proxy_host, @proxy_port.to_i)
+                 else
+                   Net::HTTP
+                 end
+    http = http_class.new(uri.host, uri.port)
+    http.use_ssl = (uri.scheme == 'https')
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.open_timeout = 10
+    http.read_timeout = 30
+
+    req = Net::HTTP::Get.new(uri.request_uri)
+    req['User-Agent'] = @user_agent
+
+    res = http.request(req)
+    raise "HTTP #{res.code}" unless res.is_a?(Net::HTTPSuccess)
+
+    File.open(bin_path, 'wb') { |f| f.write(res.body) }
+    FileUtils.chmod 0755, bin_path
+  end
+
+  def verify_binary(bin_path)
+    # Array form: exec's the binary directly, so a path containing shell
+    # metacharacters or spaces is never interpreted by /bin/sh (CWE-78).
+    #
+    # The scanner rule below fires on any non-static first argument to IO.popen
+    # and does not model the array form -- which is exactly the fix here, since
+    # no shell is spawned at all. Suppressed for this rule only.
+    # nosemgrep: ruby.lang.security.dangerous-exec.dangerous-exec
+    binary_response = IO.popen([bin_path, '--version']).readline
+    !!(binary_response =~ /BrowserStack Local version \d+\.\d+/)
+  rescue StandardError
+    false
+  end
 
   def get_available_dirs
-    i = 0
-    while i < @ordered_paths.size
-      path = @ordered_paths[i]
-      if make_path(path)
-        return path
-      else
-        i += 1
-      end
+    @ordered_paths.each do |path|
+      return path if make_path(path)
     end
     raise BrowserStack::LocalException.new('Error trying to download BrowserStack Local binary')
   end
 
   def make_path(path)
-    begin
-      FileUtils.mkdir_p path if !File.directory?(path)
-      return true
-    rescue Exception
-      return false
-    end
+    FileUtils.mkdir_p(path) unless File.directory?(path)
+    true
+  rescue StandardError
+    false
   end
 end
 

data/lib/browserstack/version.rb

@@ -0,0 +1,3 @@
+module BrowserStack
+  VERSION = '1.5.1'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserstack-local
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.1
 platform: ruby
 authors:
 - BrowserStack
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2026-06-01 00:00:00.000000000 Z
 dependencies: []
 description: Ruby bindings for BrowserStack Local
 email: support@browserstack.com
@@ -16,14 +16,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/browserstack/fetch_download_source_url.rb
 - lib/browserstack/local.rb
 - lib/browserstack/localbinary.rb
 - lib/browserstack/localexception.rb
+- lib/browserstack/version.rb
 homepage: http://rubygems.org/gems/browserstack-local
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -39,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: BrowserStack Local
 test_files: []