aspera-cli 4.15.0 → 4.16.0

data/lib/aspera/rest.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'aspera/log'
+require 'aspera/assert'
 require 'aspera/oauth'
 require 'aspera/rest_error_analyzer'
 require 'aspera/hash_ext'
@@ -58,10 +59,11 @@ module Aspera
       # build URI from URL and parameters and check it is http or https
       def build_uri(url, params=nil)
         uri = URI.parse(url)
-        raise "REST endpoint shall be http/s not #{uri.scheme}" unless %w[http https].include?(uri.scheme)
+        assert(%w[http https].include?(uri.scheme)){"REST endpoint shall be http/s not #{uri.scheme}"}
         return uri if params.nil?
         Log.log.debug{Log.dump('params', params)}
-        raise 'Internal Error: param must be Hash' unless params.is_a?(Hash)
+        assert_type(params, Hash)
+        return uri if params.empty?
         query = []
         params.each do |k, v|
           case v
@@ -103,17 +105,31 @@ module Aspera
       # little hack, handy because HTTP debug, proxy, etc... will be available
       # used implement web sockets after `start_http_session`
       def io_http_session(http_session)
-        raise "wring type #{http_session.class}" unless http_session.is_a?(Net::HTTP)
+        assert_type(http_session, Net::HTTP)
         # Net::BufferedIO in net/protocol.rb
         result = http_session.instance_variable_get(:@socket)
-        raise "no socket for #{http_session}" if result.nil?
+        assert(!result.nil?){"no socket for #{http_session}"}
         return result
       end
 
+      # @return [String] PEM certificates of remote server
+      def remote_certificates(url)
+        # initiate a session to retrieve remote certificate
+        http_session = Rest.start_http_session(url)
+        begin
+          # retrieve underlying openssl socket
+          return Rest.io_http_session(http_session).io.peer_cert_chain.reverse.map(&:to_pem).join("\n")
+        rescue
+          return http_session.peer_cert.to_pem
+        ensure
+          http_session.finish
+        end
+      end
+
       # set global parameters
       def set_parameters(**options)
         options.each do |key, value|
-          raise "ERROR: unknown Rest option #{key}" unless @@global.key?(key)
+          assert(@@global.key?(key)){"unknown Rest option #{key}"}
           @@global[key] = value
         end
       end
@@ -140,7 +156,7 @@ module Aspera
 
     def oauth
       if @oauth.nil?
-        raise 'ERROR: no OAuth defined' unless @params[:auth][:type].eql?(:oauth2)
+        assert(@params[:auth][:type].eql?(:oauth2)){'no OAuth defined'}
         @oauth = Oauth.new(@params[:auth])
       end
       return @oauth
@@ -148,8 +164,8 @@ module Aspera
 
     # @param a_rest_params [Hash] default call parameters (merged at call)
     def initialize(a_rest_params)
-      raise 'ERROR: expecting Hash' unless a_rest_params.is_a?(Hash)
-      raise 'ERROR: expecting base_url' unless a_rest_params[:base_url].is_a?(String)
+      assert_type(a_rest_params, Hash)
+      assert_type(a_rest_params[:base_url], String)
       @params = a_rest_params.clone
       Log.log.debug{Log.dump('REST params', @params)}
       # base url without trailing slashes (note: string may be frozen)
@@ -163,7 +179,7 @@ module Aspera
     end
 
     def oauth_token(force_refresh: false)
-      raise "ERROR: expecting boolean, have #{force_refresh}" unless [true, false].include?(force_refresh)
+      assert_values(force_refresh, [true, false])
       return oauth.get_authorization(use_refresh_token: force_refresh)
     end
 
@@ -227,7 +243,7 @@ module Aspera
     # :url_query  [:url] a hash
     # :*          [:oauth2] see Oauth class
     def call(call_data)
-      raise "Hash call parameter is required (#{call_data.class})" unless call_data.is_a?(Hash)
+      assert_type(call_data, Hash)
       call_data[:subpath] = '' if call_data[:subpath].nil?
       Log.log.debug{"accessing #{call_data[:subpath]}".red.bold.bg_green}
       call_data[:headers] ||= {}
@@ -247,7 +263,7 @@ module Aspera
         call_data[:auth][:url_query].each do |key, value|
           call_data[:url_params][key] = value
         end
-      else raise "unsupported auth type: [#{call_data[:auth][:type]}]"
+      else error_unexpected_value(call_data[:auth][:type])
       end
       req = build_request(call_data)
       Log.log.debug{"call_data = #{call_data}"}
@@ -332,7 +348,7 @@ module Aspera
           # special case: relative redirect
           if URI.parse(new_url).host.nil?
             # we don't manage relative redirects with non-absolute path
-            raise "Error: redirect location is relative: #{new_url}, but does not start with /." unless new_url.start_with?('/')
+            assert(new_url.start_with?('/')){"redirect location is relative: #{new_url}, but does not start with /."}
             new_url = current_uri.scheme + '://' + current_uri.host + new_url
           end
           Log.log.info{"URL is moved: #{new_url}"}
@@ -390,7 +406,7 @@ module Aspera
       # API style: {totalcount:, ...} cspell: disable-line
       # TODO: not generic enough ? move somewhere ? inheritance ?
       matching_items = matching_items[subpath] if matching_items.is_a?(Hash)
-      raise "Internal error: expecting array, have #{matching_items.class}" unless matching_items.is_a?(Array)
+      assert_type(matching_items, Array)
       case matching_items.length
       when 1 then return matching_items.first
       when 0 then raise %Q{#{ENTITY_NOT_FOUND} #{subpath}: "#{search_name}"}

data/lib/aspera/rest_error_analyzer.rb

@@ -90,6 +90,7 @@ module Aspera
       # @param msg one error message  to add to list
       def add_error(call_context, type, msg)
         call_context[:messages].push(msg)
+        Log.log.trace1{"Found error: #{type}: #{msg}"}
         log_file = instance.log_file
         # log error for further analysis (file must exist to activate)
         return if log_file.nil? || !File.exist?(log_file)

data/lib/aspera/rest_errors_aspera.rb

@@ -21,6 +21,8 @@ module Aspera
         RestErrorAnalyzer.instance.add_simple_handler(name: 'Type 6', path: ['message'])
         RestErrorAnalyzer.instance.add_handler('Type 7: errors[]') do |type, call_context|
           next unless call_context[:data].is_a?(Hash) && call_context[:data]['errors'].is_a?(Hash)
+          # special for Shares: false positive ? (update global transfer_settings)
+          next if call_context[:data].key?('min_connect_version')
           call_context[:data]['errors'].each do |k, v|
             RestErrorAnalyzer.add_error(call_context, type, "#{k}: #{v}")
           end

data/lib/aspera/secret_hider.rb

@@ -6,6 +6,8 @@ require 'logger'
 module Aspera
   # remove secret from logs and output
   class SecretHider
+    # configurable:
+    ADDITIONAL_KEYS_TO_HIDE = []
     # display string for hidden secrets
     HIDDEN_PASSWORD = '🔑'
     # env vars for ascp with secrets
@@ -14,7 +16,7 @@ module Aspera
     KEY_SECRETS = %w[password secret passphrase _key apikey crn token].freeze
     HTTP_SECRETS = %w[Authorization].freeze
     ALL_SECRETS = [ASCP_ENV_SECRETS, KEY_SECRETS, HTTP_SECRETS].flatten.freeze
-    KEY_FALSE_POSITIVES = [/^access_key$/].freeze
+    KEY_FALSE_POSITIVES = [/^access_key$/, /^fallback_private_key$/].freeze
     # regex that define named captures :begin and :end
     REGEX_LOG_REPLACES = [
       # CLI manager get/set options
@@ -32,7 +34,7 @@ module Aspera
       # cred in http dump
       /(?<begin>(?:#{HTTP_SECRETS.join('|')}): )[^\\]+(?<end>\\)/i
     ].freeze
-    private_constant :HIDDEN_PASSWORD, :ASCP_ENV_SECRETS, :KEY_SECRETS, :ALL_SECRETS, :REGEX_LOG_REPLACES
+    private_constant :HIDDEN_PASSWORD, :ASCP_ENV_SECRETS, :KEY_SECRETS, :HTTP_SECRETS, :ALL_SECRETS, :KEY_FALSE_POSITIVES, :REGEX_LOG_REPLACES
     @log_secrets = false
     class << self
       attr_accessor :log_secrets
@@ -56,6 +58,7 @@ module Aspera
         return false unless keyword.is_a?(String) && value.is_a?(String)
         # those are not secrets
         return false if KEY_FALSE_POSITIVES.any?{|f|f.match?(keyword)}
+        return true if ADDITIONAL_KEYS_TO_HIDE.include?(keyword)
         # check if keyword (name) contains an element that designate it as a secret
         ALL_SECRETS.any?{|kw|keyword.include?(kw)}
       end

data/lib/aspera/ssh.rb

@@ -2,15 +2,17 @@
 
 require 'net/ssh'
 
-# HACK: deactivate ed25519 and ecdsa private keys from ssh identities, as it usually cause problems
-old_verbose = $VERBOSE
-$VERBOSE = nil
-begin
-  module Net; module SSH; module Authentication; class Session; private; def default_keys; %w[~/.ssh/id_dsa ~/.ssh/id_rsa ~/.ssh2/id_dsa ~/.ssh2/id_rsa]; end; end; end; end; end # rubocop:disable Layout/AccessModifierIndentation, Layout/EmptyLinesAroundAccessModifier, Layout/LineLength, Style/Semicolon
-rescue StandardError
-  # ignore errors
+if ENV.fetch('ASCLI_ENABLE_ED25519', 'false').eql?('false')
+  # HACK: deactivate ed25519 and ecdsa private keys from ssh identities, as it usually cause problems
+  old_verbose = $VERBOSE
+  $VERBOSE = nil
+  begin
+    module Net; module SSH; module Authentication; class Session; private; def default_keys; %w[~/.ssh/id_dsa ~/.ssh/id_rsa ~/.ssh2/id_dsa ~/.ssh2/id_rsa]; end; end; end; end; end # rubocop:disable Layout/AccessModifierIndentation, Layout/EmptyLinesAroundAccessModifier, Layout/LineLength, Style/Semicolon
+  rescue StandardError
+    # ignore errors
+  end
+  $VERBOSE = old_verbose
 end
-$VERBOSE = old_verbose
 
 module Aspera
   # A simple wrapper around Net::SSH

data/lib/aspera/temp_file_manager.rb

@@ -42,7 +42,7 @@ module Aspera
       new_file
     end
 
-    # same as above but in global temp folder
+    # same as above but in global temp folder, with user's name
     def new_file_path_global(base_name)
       username =
         begin

data/lib/aspera/web_server_simple.rb

@@ -3,6 +3,7 @@
 require 'webrick'
 require 'webrick/https'
 require 'aspera/log'
+require 'aspera/assert'
 require 'openssl'
 
 module Aspera
@@ -52,7 +53,7 @@ module Aspera
         if certificate.nil?
           webrick_options[:SSLCertName] = [['CN', WEBrick::Utils.getservername]]
         else
-          raise 'certificate must be Hash' unless certificate.is_a?(Hash)
+          assert_type(certificate, Hash)
           certificate = certificate.symbolize_keys
           raise "unexpected key in certificate config: only: #{CERT_PARAMETERS.join(', ')}" if certificate.keys.any?{|k|!CERT_PARAMETERS.include?(k)}
           webrick_options[:SSLPrivateKey] = if certificate.key?(:key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -37,8 +37,42 @@ cert_chain:
   eTf9kxhVM40wGQOECVNA8UsEEZHD48eF+csUYZtAJOF5oxTI8UyV9T/o6CgO0c9/
   Gzz+Qm5ULOUcPiJLjSpaiTrkiIVYiDGnqNSr6R1Hb1c=
   -----END CERTIFICATE-----
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2024-02-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.6
 - !ruby/object:Gem::Dependency
   name: blankslate
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +87,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +129,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +157,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -208,61 +284,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: mimemagic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: rmagick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -339,28 +387,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.44'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.44'
+        version: '0.50'
 description: Command line interface for IBM Aspera products
 email:
 - laurent.martin.aspera@fr.ibm.com
@@ -381,6 +429,7 @@ files:
 - examples/rubyc
 - lib/aspera/aoc.rb
 - lib/aspera/ascmd.rb
+- lib/aspera/assert.rb
 - lib/aspera/ats_api.rb
 - lib/aspera/cli/basic_auth_plugin.rb
 - lib/aspera/cli/error.rb
@@ -412,6 +461,7 @@ files:
 - lib/aspera/colors.rb
 - lib/aspera/command_line_builder.rb
 - lib/aspera/cos_node.rb
+- lib/aspera/coverage.rb
 - lib/aspera/data/1
 - lib/aspera/data/2
 - lib/aspera/data/3
@@ -420,7 +470,7 @@ files:
 - lib/aspera/data/6
 - lib/aspera/data_repository.rb
 - lib/aspera/environment.rb
-- lib/aspera/fasp/agent_aspera.rb
+- lib/aspera/fasp/agent_alpha.rb
 - lib/aspera/fasp/agent_base.rb
 - lib/aspera/fasp/agent_connect.rb
 - lib/aspera/fasp/agent_direct.rb
@@ -436,6 +486,7 @@ files:
 - lib/aspera/fasp/parameters.yaml
 - lib/aspera/fasp/products.rb
 - lib/aspera/fasp/resume_policy.rb
+- lib/aspera/fasp/sync.rb
 - lib/aspera/fasp/transfer_spec.rb
 - lib/aspera/fasp/uri.rb
 - lib/aspera/faspex_gw.rb
@@ -449,6 +500,7 @@ files:
 - lib/aspera/log.rb
 - lib/aspera/nagios.rb
 - lib/aspera/node.rb
+- lib/aspera/node_simulator.rb
 - lib/aspera/oauth.rb
 - lib/aspera/open_application.rb
 - lib/aspera/persistency_action_once.rb
@@ -468,7 +520,6 @@ files:
 - lib/aspera/rest_errors_aspera.rb
 - lib/aspera/secret_hider.rb
 - lib/aspera/ssh.rb
-- lib/aspera/sync.rb
 - lib/aspera/temp_file_manager.rb
 - lib/aspera/timer_limiter.rb
 - lib/aspera/uri_reader.rb
@@ -480,8 +531,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/IBM/aspera-cli
-  source_code_uri: https://github.com/IBM/aspera-cli
-  changelog_uri: https://github.com/IBM/aspera-cli
+  source_code_uri: https://github.com/IBM/aspera-cli/tree/main/lib/aspera
+  changelog_uri: https://github.com/IBM/aspera-cli/CHANGELOG.md
   rubygems_uri: https://rubygems.org/gems/aspera-cli
   documentation_uri: https://www.rubydoc.info/gems/aspera-cli
 post_install_message: 
@@ -500,7 +551,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Read the manual for any requirement
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: 'Execute actions using command line on IBM Aspera Server products: Aspera