aspera-cli 4.8.0 → 4.9.0

data/lib/aspera/oauth.rb

@@ -56,7 +56,7 @@ module Aspera
           Log.log.debug('Not using persistency') # (use Aspera::Oauth.persist_mgr=Aspera::PersistencyFolder.new)
           # create NULL persistency class
           @persist = Class.new do
-            def get(_x);nil;end;def delete(_x);nil;end;def put(_x,_y);nil;end;def garbage_collect(_x,_y);nil;end
+            def get(_x);nil;end;def delete(_x);nil;end;def put(_x,_y);nil;end;def garbage_collect(_x,_y);nil;end # rubocop:disable Layout/EmptyLineBetweenDefs
           end.new
         end
         return @persist
@@ -121,9 +121,9 @@ module Aspera
 
     # Authentication using Web browser
     register_token_creator :web,lambda { |oauth|
-      verification_code = SecureRandom.uuid # used to check later
+      random_state = SecureRandom.uuid # used to check later
       login_page_url = Rest.build_uri("#{oauth.api[:base_url]}/#{oauth.sparams[:path_authorize]}",
-        oauth.optional_scope_client_id.merge(response_type: 'code', redirect_uri: oauth.sparams[:redirect_uri], state: verification_code))
+        oauth.optional_scope_client_id.merge(response_type: 'code', redirect_uri: oauth.sparams[:redirect_uri], state: random_state))
       # here, we need a human to authorize on a web page
       Log.log.info("login_page_url=#{login_page_url}".bg_red.gray)
       # start a web server to receive request code
@@ -132,7 +132,7 @@ module Aspera
       OpenApplication.instance.uri(login_page_url)
       # wait for code in request
       received_params = webserver.received_request
-      raise 'state does not match' unless verification_code.eql?(received_params['state'])
+      raise 'wrong received state' unless random_state.eql?(received_params['state'])
       # exchange code for token
       return oauth.create_token(oauth.optional_scope_client_id(add_secret: true).merge(
         grant_type:   'authorization_code',

data/lib/aspera/open_application.rb

@@ -11,27 +11,29 @@ module Aspera
   # if method is "graphical", then the URL will be opened with the default browser.
   class OpenApplication
     include Singleton
-    # User Interfaces
-    def self.user_interfaces; %i[text graphical]; end
+    class << self
+      # User Interfaces
+      def user_interfaces; %i[text graphical]; end
 
-    def self.default_gui_mode
-      return :graphical if [Aspera::Environment::OS_WINDOWS,Aspera::Environment::OS_X].include?(Aspera::Environment.os)
-      # unix family
-      return :graphical if ENV.has_key?('DISPLAY') && !ENV['DISPLAY'].empty?
-      return :text
-    end
+      def default_gui_mode
+        return :graphical if [Aspera::Environment::OS_WINDOWS,Aspera::Environment::OS_X].include?(Aspera::Environment.os)
+        # unix family
+        return :graphical if ENV.has_key?('DISPLAY') && !ENV['DISPLAY'].empty?
+        return :text
+      end
 
-    # command must be non blocking
-    def self.uri_graphical(uri)
-      case Aspera::Environment.os
-      when Aspera::Environment::OS_X
-        return system('open',uri.to_s)
-      when Aspera::Environment::OS_WINDOWS
-        return system('start explorer "' + uri.to_s + '"')
-      when Aspera::Environment::OS_LINUX
-        return system("xdg-open '#{uri}'")
-      else
-        raise "no graphical open method for #{Aspera::Environment.os}"
+      # command must be non blocking
+      def uri_graphical(uri)
+        case Aspera::Environment.os
+        when Aspera::Environment::OS_X
+          return system('open',uri.to_s)
+        when Aspera::Environment::OS_WINDOWS
+          return system('start explorer "' + uri.to_s + '"')
+        when Aspera::Environment::OS_LINUX
+          return system("xdg-open '#{uri}'")
+        else
+          raise "no graphical open method for #{Aspera::Environment.os}"
+        end
       end
     end
 

data/lib/aspera/persistency_folder.rb

@@ -36,7 +36,9 @@ module Aspera
       raise 'value: only String supported' unless value.is_a?(String)
       persist_filepath = id_to_filepath(object_id)
       Log.log.debug("persistency saving: #{persist_filepath}")
+      File.delete(persist_filepath) if File.exist?(persist_filepath)
       File.write(persist_filepath,value)
+      File.chmod(0400,persist_filepath)
       @cache[object_id] = value
     end
 
@@ -66,6 +68,7 @@ module Aspera
     def id_to_filepath(object_id)
       raise 'object_id: only String supported' unless object_id.is_a?(String)
       FileUtils.mkdir_p(@folder)
+      File.chmod(0700,@folder)
       return File.join(@folder,"#{object_id}#{FILE_SUFFIX}")
       #.gsub(/[^a-z]+/,FILE_FIELD_SEPARATOR)
     end

data/lib/aspera/proxy_auto_config.rb

@@ -7,10 +7,12 @@ module URI
   class Generic
     # save original method that finds proxy in URI::Generic, it uses env var http_proxy
     alias_method :find_proxy_orig, :find_proxy
-    def self.register_proxy_finder
-      raise 'mandatory block missing' unless Kernel.block_given?
-      # overload the method in URI : call user's provided block and fallback to original method
-      define_method(:find_proxy) {|envars=ENV| yield(to_s) || find_proxy_orig(envars)}
+    class << self
+      def register_proxy_finder
+        raise 'mandatory block missing' unless Kernel.block_given?
+        # overload the method in URI : call user's provided block and fallback to original method
+        define_method(:find_proxy) {|envars=ENV| yield(to_s) || find_proxy_orig(envars)}
+      end
     end
   end
 end

data/lib/aspera/rest_error_analyzer.rb

@@ -80,19 +80,21 @@ module Aspera
       end
     end # add_simple_handler
 
-    # used by handler to add an error description to list of errors
-    # for logging and tracing : collect error descriptions (create file to activate)
-    # @param call_context a Hash containing the result call_context, provided to handler
-    # @param type a string describing type of exception, for logging purpose
-    # @param msg one error message  to add to list
-    def self.add_error(call_context,type,msg)
-      call_context[:messages].push(msg)
-      logfile = instance.log_file
-      # log error for further analysis (file must exist to activate)
-      return if logfile.nil? || !File.exist?(logfile)
-      File.open(logfile,'a+') do |f|
-        f.write("\n=#{type}=====\n#{call_context[:request].method} #{call_context[:request].path}\n#{call_context[:response].code}\n"\
-          "#{JSON.generate(call_context[:data])}\n#{call_context[:messages].join("\n")}")
+    class << self
+      # used by handler to add an error description to list of errors
+      # for logging and tracing : collect error descriptions (create file to activate)
+      # @param call_context a Hash containing the result call_context, provided to handler
+      # @param type a string describing type of exception, for logging purpose
+      # @param msg one error message  to add to list
+      def add_error(call_context,type,msg)
+        call_context[:messages].push(msg)
+        logfile = instance.log_file
+        # log error for further analysis (file must exist to activate)
+        return if logfile.nil? || !File.exist?(logfile)
+        File.open(logfile,'a+') do |f|
+          f.write("\n=#{type}=====\n#{call_context[:request].method} #{call_context[:request].path}\n#{call_context[:response].code}\n"\
+            "#{JSON.generate(call_context[:data])}\n#{call_context[:messages].join("\n")}")
+        end
       end
     end
   end

data/lib/aspera/rest_errors_aspera.rb

@@ -6,55 +6,57 @@ require 'aspera/log'
 module Aspera
   # REST error handlers for various Aspera REST APIs
   class RestErrorsAspera
-    # handlers should probably be defined by plugins for modularity
-    def self.register_handlers
-      Log.log.debug('registering Aspera REST error handlers')
-      # Faspex 4: both user_message and internal_message, and code 200
-      # example: missing meta data on package creation
-      RestErrorAnalyzer.instance.add_simple_handler('Type 1: error:user_message','error','user_message',true)
-      RestErrorAnalyzer.instance.add_simple_handler('Type 2: error:description','error','description')
-      RestErrorAnalyzer.instance.add_simple_handler('Type 3: error:internal_message','error','internal_message')
-      # AoC Automation
-      RestErrorAnalyzer.instance.add_simple_handler('AoC Automation','error')
-      RestErrorAnalyzer.instance.add_simple_handler('Type 5','error_description')
-      RestErrorAnalyzer.instance.add_simple_handler('Type 6','message')
-      RestErrorAnalyzer.instance.add_handler('Type 7: errors[]') do |name,call_context|
-        if call_context[:data].is_a?(Hash) && call_context[:data]['errors'].is_a?(Hash)
-          call_context[:data]['errors'].each do |k,v|
-            RestErrorAnalyzer.add_error(call_context,name,"#{k}: #{v}")
+    class << self
+      # handlers should probably be defined by plugins for modularity
+      def register_handlers
+        Log.log.debug('registering Aspera REST error handlers')
+        # Faspex 4: both user_message and internal_message, and code 200
+        # example: missing meta data on package creation
+        RestErrorAnalyzer.instance.add_simple_handler('Type 1: error:user_message','error','user_message',true)
+        RestErrorAnalyzer.instance.add_simple_handler('Type 2: error:description','error','description')
+        RestErrorAnalyzer.instance.add_simple_handler('Type 3: error:internal_message','error','internal_message')
+        # AoC Automation
+        RestErrorAnalyzer.instance.add_simple_handler('AoC Automation','error')
+        RestErrorAnalyzer.instance.add_simple_handler('Type 5','error_description')
+        RestErrorAnalyzer.instance.add_simple_handler('Type 6','message')
+        RestErrorAnalyzer.instance.add_handler('Type 7: errors[]') do |name,call_context|
+          if call_context[:data].is_a?(Hash) && call_context[:data]['errors'].is_a?(Hash)
+            call_context[:data]['errors'].each do |k,v|
+              RestErrorAnalyzer.add_error(call_context,name,"#{k}: #{v}")
+            end
           end
         end
-      end
-      # call to upload_setup and download_setup of node api
-      RestErrorAnalyzer.instance.add_handler('T8:node: *_setup') do |type,call_context|
-        if call_context[:data].is_a?(Hash)
-          d_t_s = call_context[:data]['transfer_specs']
-          if d_t_s.is_a?(Array)
-            d_t_s.each do |res|
-              #r_err=res['transfer_spec']['error']
-              r_err = res['error']
-              if r_err.is_a?(Hash)
-                RestErrorAnalyzer.add_error(call_context,type,"#{r_err['code']}: #{r_err['reason']}: #{r_err['user_message']}")
+        # call to upload_setup and download_setup of node api
+        RestErrorAnalyzer.instance.add_handler('T8:node: *_setup') do |type,call_context|
+          if call_context[:data].is_a?(Hash)
+            d_t_s = call_context[:data]['transfer_specs']
+            if d_t_s.is_a?(Array)
+              d_t_s.each do |res|
+                #r_err=res['transfer_spec']['error']
+                r_err = res['error']
+                if r_err.is_a?(Hash)
+                  RestErrorAnalyzer.add_error(call_context,type,"#{r_err['code']}: #{r_err['reason']}: #{r_err['user_message']}")
+                end
               end
             end
           end
         end
-      end
-      RestErrorAnalyzer.instance.add_simple_handler('T9:IBM cloud IAM','errorMessage')
-      RestErrorAnalyzer.instance.add_simple_handler('T10:faspex v4','user_message')
-      RestErrorAnalyzer.instance.add_handler('bss graphql') do |type,call_context|
-        if call_context[:data].is_a?(Hash)
-          d_t_s = call_context[:data]['errors']
-          if d_t_s.is_a?(Array)
-            d_t_s.each do |res|
-              r_err = res['message']
-              if r_err.is_a?(String)
-                RestErrorAnalyzer.add_error(call_context,type,r_err)
+        RestErrorAnalyzer.instance.add_simple_handler('T9:IBM cloud IAM','errorMessage')
+        RestErrorAnalyzer.instance.add_simple_handler('T10:faspex v4','user_message')
+        RestErrorAnalyzer.instance.add_handler('bss graphql') do |type,call_context|
+          if call_context[:data].is_a?(Hash)
+            d_t_s = call_context[:data]['errors']
+            if d_t_s.is_a?(Array)
+              d_t_s.each do |res|
+                r_err = res['message']
+                if r_err.is_a?(String)
+                  RestErrorAnalyzer.add_error(call_context,type,r_err)
+                end
               end
             end
           end
         end
-      end
-    end # registerErrorTypes
+      end # register_handlers
+    end
   end
 end

data/lib/aspera/secret_hider.rb

@@ -8,11 +8,17 @@ module Aspera
     # display string for hidden secrets
     HIDDEN_PASSWORD = '🔑'
     # keys in hash that contain secrets
-    SECRET_KEYWORDS = %w[password secret private_key passphrase].freeze
+    ASCP_SECRETS=%w[ASPERA_SCP_PASS ASPERA_SCP_KEY ASPERA_SCP_FILEPASS ASPERA_PROXY_PASS].freeze
+    KEY_SECRETS =%w[password secret private_key passphrase].freeze
+    ALL_SECRETS =[ASCP_SECRETS,KEY_SECRETS].flatten.freeze
     # regex that define namec captures :begin and :end
     REGEX_LOG_REPLACES=[
-      # replace values in logs with rendered JSON
-      /(?<begin>["':][^"]*(#{SECRET_KEYWORDS.join('|')})[^"]*["']?[=>: ]+")[^"]+(?<end>")/,
+      # CLI manager get/set options
+      /(?<begin>[sg]et (#{KEY_SECRETS.join('|')})=).*(?<end>)/,
+      # env var ascp exec
+      /(?<begin> (#{ASCP_SECRETS.join('|')})=)[^ ]*(?<end> )/,
+      # rendered JSON
+      /(?<begin>["':][^"]*(#{ALL_SECRETS.join('|')})[^"]*["']?[=>: ]+")[^"]+(?<end>")/,
       # option "secret"
       /(?<begin>"[^"]*(secret)[^"]*"=>{)[^}]+(?<end>})/,
       # option "secrets"
@@ -20,7 +26,7 @@ module Aspera
       # private key values
       /(?<begin>--+BEGIN .+ KEY--+)[[:ascii:]]+?(?<end>--+?END .+ KEY--+)/
     ].freeze
-    private_constant :HIDDEN_PASSWORD,:SECRET_KEYWORDS
+    private_constant :HIDDEN_PASSWORD,:ASCP_SECRETS,:KEY_SECRETS,:ALL_SECRETS,:REGEX_LOG_REPLACES
     @log_secrets = false
     class << self
       attr_accessor :log_secrets
@@ -40,7 +46,7 @@ module Aspera
       def secret?(keyword,value)
         keyword=keyword.to_s if keyword.is_a?(Symbol)
         # only Strings can be secrets, not booleans, or hash, arrays
-        keyword.is_a?(String) && SECRET_KEYWORDS.any?{|kw|keyword.include?(kw)} && value.is_a?(String)
+        keyword.is_a?(String) && ALL_SECRETS.any?{|kw|keyword.include?(kw)} && value.is_a?(String)
       end
 
       def deep_remove_secret(obj,is_name_value: false)

data/lib/aspera/ssh.rb

@@ -17,6 +17,7 @@ module Aspera
     # see: https://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
     def initialize(host,username,ssh_options)
       Log.log.debug("ssh:#{username}@#{host}")
+      Log.log.debug("ssh_options:#{ssh_options}")
       @host = host
       @username = username
       @ssh_options = ssh_options

data/lib/aspera/uri_reader.rb

@@ -5,19 +5,21 @@ require 'aspera/rest'
 
 module Aspera
   module UriReader
-    # read some content from some URI, support file: , http: and https: schemes
-    def self.read(uri_to_read)
-      proxy_uri = URI.parse(uri_to_read)
-      case proxy_uri.scheme
-      when 'http','https'
-        return Rest.new(base_url: uri_to_read,redirect_max: 5).call(operation: 'GET', subpath: '', headers: {'Accept' => 'text/plain'})[:data]
-      when 'file',NilClass
-        local_file_path = proxy_uri.path
-        raise 'URL shall have a path, check syntax' if local_file_path.nil?
-        local_file_path = File.expand_path(local_file_path.gsub(/^\//,'')) if /^\/(~|.|..)\//.match?(local_file_path)
-        return File.read(local_file_path)
-      else
-        raise "unknown scheme: [#{proxy_uri.scheme}] for [#{uri_to_read}]"
+    class << self
+      # read some content from some URI, support file: , http: and https: schemes
+      def read(uri_to_read)
+        proxy_uri = URI.parse(uri_to_read)
+        case proxy_uri.scheme
+        when 'http','https'
+          return Rest.new(base_url: uri_to_read,redirect_max: 5).call(operation: 'GET', subpath: '', headers: {'Accept' => 'text/plain'})[:data]
+        when 'file',NilClass
+          local_file_path = proxy_uri.path
+          raise 'URL shall have a path, check syntax' if local_file_path.nil?
+          local_file_path = File.expand_path(local_file_path.gsub(/^\//,'')) if /^\/(~|.|..)\//.match?(local_file_path)
+          return File.read(local_file_path)
+        else
+          raise "unknown scheme: [#{proxy_uri.scheme}] for [#{uri_to_read}]"
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -35,7 +35,7 @@ cert_chain:
   ZjkOWbUc1aLIsfaQFHWyNfisY9X2RgkFHjX0p5493wnoA7aWh52MUhc145npFh8z
   v4P9xwkT02Shkert4B4iwNvVjoAUGk+J4090svZCroAyXBjon5LV7MJ4fyw=
   -----END CERTIFICATE-----
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -395,8 +395,9 @@ files:
 - examples/aoc.rb
 - examples/dascli
 - examples/faspex4.rb
+- examples/node.rb
 - examples/proxy.pac
-- examples/transfer.rb
+- examples/server.rb
 - lib/aspera/aoc.rb
 - lib/aspera/ascmd.rb
 - lib/aspera/ats_api.rb