aspera-cli 4.4.0 → 4.7.0

data/lib/aspera/fasp/installation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+require 'English'
 require 'singleton'
 require 'aspera/log'
 require 'aspera/environment'
@@ -6,11 +8,12 @@ require 'xmlsimple'
 require 'zlib'
 require 'base64'
 require 'fileutils'
+require 'openssl'
 
 module Aspera
   module Fasp
     # Singleton that tells where to find ascp and other local resources (keys..) , using the "path(symb)" method.
-    # It is used by object : Fasp::Local to find necessary resources
+    # It is used by object : AgentDirect to find necessary resources
     # By default it takes the first Aspera product found specified in product_locations
     # but the user can specify ascp location by calling:
     # Installation.instance.use_ascp_from_product(product_name)
@@ -18,26 +21,56 @@ module Aspera
     # Installation.instance.ascp_path=""
     class Installation
       include Singleton
+      # known product names
       PRODUCT_CONNECT='Aspera Connect'
       PRODUCT_CLI_V1='Aspera CLI'
       PRODUCT_DRIVE='Aspera Drive'
       PRODUCT_ENTSRV='Enterprise Server'
-      MAX_REDIRECT_SDK=2
-      private_constant :MAX_REDIRECT_SDK
+      # protobuf generated files from sdk
+      EXT_RUBY_PROTOBUF='_pb.rb'
+      RB_SDK_FOLDER='lib'
+      ONE_YEAR_SECONDS=365 * 24 * 60 * 60
+      DEFAULT_ASPERA_CONF=<<~END_OF_CONFIG_FILE
+        <?xml version='1.0' encoding='UTF-8'?>
+        <CONF version="2">
+        <default>
+            <file_system>
+                <resume_suffix>.aspera-ckpt</resume_suffix>
+                <partial_file_suffix>.partial</partial_file_suffix>
+            </file_system>
+        </default>
+        </CONF>
+      END_OF_CONFIG_FILE
+      private_constant :PRODUCT_CONNECT,:PRODUCT_CLI_V1,:PRODUCT_DRIVE,:PRODUCT_ENTSRV,:EXT_RUBY_PROTOBUF,:RB_SDK_FOLDER,:ONE_YEAR_SECONDS,:DEFAULT_ASPERA_CONF
       # set ascp executable path
       def ascp_path=(v)
         @path_to_ascp=v
       end
 
-      # filename for ascp with optional extension (Windows)
-      def ascp_filename
-        return 'ascp'+Environment.exe_extension
+      def ascp_path
+        path(:ascp)
+      end
+
+      def sdk_ruby_folder
+        ruby_pb_folder=File.join(sdk_folder,RB_SDK_FOLDER)
+        FileUtils.mkdir_p(ruby_pb_folder) unless Dir.exist?(ruby_pb_folder)
+        return ruby_pb_folder
       end
 
       # location of SDK files
-      def folder=(v)
-        @sdk_folder=v
-        folder_path
+      def sdk_folder=(v)
+        @sdk_dir=v
+        sdk_folder
+      end
+
+      # backward compatibility in sample program
+      alias folder= sdk_folder=
+
+      # @return the path to folder where SDK is installed
+      def sdk_folder
+        raise 'SDK path was ot initialized' if @sdk_dir.nil?
+        FileUtils.mkdir_p(@sdk_dir) unless Dir.exist?(@sdk_dir)
+        @sdk_dir
       end
 
       # find ascp in named product (use value : FIRST_FOUND='FIRST' to just use first one)
@@ -60,9 +93,9 @@ module Aspera
           scan_locations=product_locations.clone
           # add SDK as first search path
           scan_locations.unshift({
-            :expected =>'SDK',
-            :app_root =>folder_path,
-            :sub_bin =>''
+            expected: 'SDK',
+            app_root: sdk_folder,
+            sub_bin: ''
           })
           # search installed products: with ascp
           @found_products=scan_locations.select! do |item|
@@ -100,46 +133,39 @@ module Aspera
           file=@path_to_ascp
           # note that there might be a .exe at the end
           file=file.gsub('ascp','ascp4') if k.eql?(:ascp4)
+        when :transferd
+          file=transferd_filepath
         when :ssh_bypass_key_dsa
-          file=File.join(folder_path,'aspera_bypass_dsa.pem')
+          file=File.join(sdk_folder,'aspera_bypass_dsa.pem')
           File.write(file,get_key('dsa',1)) unless File.exist?(file)
           File.chmod(0400,file)
         when :ssh_bypass_key_rsa
-          file=File.join(folder_path,'aspera_bypass_rsa.pem')
+          file=File.join(sdk_folder,'aspera_bypass_rsa.pem')
           File.write(file,get_key('rsa',2)) unless File.exist?(file)
           File.chmod(0400,file)
         when :aspera_license
-          file=File.join(folder_path,'aspera-license')
-          File.write(file,Base64.strict_encode64("#{Zlib::Inflate.inflate(DataRepository.instance.get_bin(6))}==SIGNATURE==\n#{Base64.strict_encode64(DataRepository.instance.get_bin(7))}")) unless File.exist?(file)
+          file=File.join(sdk_folder,'aspera-license')
+          File.write(file,Base64.strict_encode64("#{Zlib::Inflate.inflate(DataRepository.instance.data(6))}==SIGNATURE==\n#{Base64.strict_encode64(DataRepository.instance.data(7))}")) unless File.exist?(file)
           File.chmod(0400,file)
         when :aspera_conf
-          file=File.join(folder_path,'aspera.conf')
-          File.write(file,%Q{<?xml version='1.0' encoding='UTF-8'?>
-<CONF version="2">
-<default>
-    <file_system>
-        <resume_suffix>.aspera-ckpt</resume_suffix>
-        <partial_file_suffix>.partial</partial_file_suffix>
-    </file_system>
-</default>
-</CONF>
-}) unless File.exist?(file)
+          file=File.join(sdk_folder,'aspera.conf')
+          File.write(file,DEFAULT_ASPERA_CONF) unless File.exist?(file)
           File.chmod(0400,file)
         when :fallback_cert,:fallback_key
-          file_key=File.join(folder_path,'aspera_fallback_key.pem')
-          file_cert=File.join(folder_path,'aspera_fallback_cert.pem')
-          if !File.exist?(file_key) or !File.exist?(file_cert)
+          file_key=File.join(sdk_folder,'aspera_fallback_key.pem')
+          file_cert=File.join(sdk_folder,'aspera_fallback_cert.pem')
+          if !File.exist?(file_key) || !File.exist?(file_cert)
             require 'openssl'
             # create new self signed certificate for http fallback
             private_key = OpenSSL::PKey::RSA.new(1024)
             cert = OpenSSL::X509::Certificate.new
-            cert.subject = cert.issuer = OpenSSL::X509::Name.parse("/C=US/ST=California/L=Emeryville/O=Aspera Inc./OU=Corporate/CN=Aspera Inc./emailAddress=info@asperasoft.com")
+            cert.subject = cert.issuer = OpenSSL::X509::Name.parse('/C=US/ST=California/L=Emeryville/O=Aspera Inc./OU=Corporate/CN=Aspera Inc./emailAddress=info@asperasoft.com')
             cert.not_before = Time.now
-            cert.not_after = Time.now + 365 * 24 * 60 * 60
+            cert.not_after = Time.now + ONE_YEAR_SECONDS
             cert.public_key = private_key.public_key
             cert.serial = 0x0
             cert.version = 2
-            cert.sign(private_key, OpenSSL::Digest::SHA1.new)
+            cert.sign(private_key, OpenSSL::Digest.new('SHA1'))
             File.write(file_key,private_key.to_pem)
             File.write(file_cert,cert.to_pem)
             File.chmod(0400,file_key)
@@ -161,7 +187,7 @@ module Aspera
           uri_file=File.join(folder,"http#{ext}.uri")
           Log.log.debug("checking connect port file: #{uri_file}")
           if File.exist?(uri_file)
-            return File.open(uri_file){|f|f.gets}.strip
+            return File.open(uri_file, &:gets).strip
           end
         end
         raise "no connect uri file found in #{folder}"
@@ -175,23 +201,29 @@ module Aspera
 
       # default bypass key phrase
       def bypass_pass
-        return "%08x-%04x-%04x-%04x-%04x%08x" % DataRepository.instance.get_bin(3).unpack("NnnnnN")
+        return format('%08x-%04x-%04x-%04x-%04x%08x',*DataRepository.instance.data(3).unpack('NnnnnN'))
       end
 
       def bypass_keys
         return [:ssh_bypass_key_dsa,:ssh_bypass_key_rsa].map{|i|Installation.instance.path(i)}
       end
 
+      # use in plugin `config`
+      def get_ascp_version(exe_path)
+        return get_exe_version(exe_path,'-A')
+      end
+
       # Check that specified path is ascp and get version
-      def get_ascp_version(ascp_path)
-        raise "File basename of #{ascp_path} must be #{ascp_filename}" unless File.basename(ascp_path).eql?(ascp_filename)
-        ascp_version='n/a'
-        raise "error in sdk: no ascp included" if ascp_path.nil?
-        cmd_out=%x{"#{ascp_path}" -A}
-        raise "An error occured when testing #{ascp_filename}: #{cmd_out}" unless $? == 0
+      def get_exe_version(exe_path,vers_arg)
+        raise 'ERROR: nil arg' if exe_path.nil?
+        return nil unless File.exist?(exe_path)
+        exe_version=nil
+        cmd_out=%x("#{exe_path}" #{vers_arg})
+        raise "An error occured when testing #{ascp_filename}: #{cmd_out}" unless $CHILD_STATUS == 0
         # get version from ascp, only after full extract, as windows requires DLLs (SSL/TLS/etc...)
-        m=cmd_out.match(/ascp version (.*)/)
-        ascp_version=m[1] unless m.nil?
+        m=cmd_out.match(/ version ([0-9.]+)/)
+        exe_version=m[1] unless m.nil?
+        return exe_version
       end
 
       # download aspera SDK or use local file
@@ -205,54 +237,48 @@ module Aspera
           raise 'use format: file:///<path>' unless sdk_url.start_with?('file:///')
           sdk_zip_path=sdk_url.gsub(%r{^file:///},'')
         else
-          redirect_remain=MAX_REDIRECT_SDK
-          begin
-            Aspera::Rest.new(base_url: sdk_url).call(operation: 'GET',save_to_file: sdk_zip_path)
-          rescue Aspera::RestCallError => e
-            if e.response.is_a?(Net::HTTPRedirection)
-              if redirect_remain > 0
-                redirect_remain-=1
-                sdk_url=e.response['location']
-                retry
-              else
-                raise "Too many redirect"
-              end
-            else
-              raise e
-            end
-          end
+          Aspera::Rest.new(base_url: sdk_url, redirect_max: 3).call(operation: 'GET',save_to_file: sdk_zip_path)
         end
-        # SDK is organized by architecture
-        filter="/#{Environment.architecture}/"
-        ascp_path=nil
-        sdk_path=folder_path
         # rename old install
-        if File.exist?(File.join(sdk_path,ascp_filename))
-          Log.log.warn("Previous install exists, renaming.")
-          File.rename(sdk_path,"#{sdk_path}.#{Time.now.strftime("%Y%m%d%H%M%S")}")
+        if !Dir.empty?(sdk_folder)
+          Log.log.warn('Previous install exists, renaming folder.')
+          File.rename(sdk_folder,"#{sdk_folder}.#{Time.now.strftime('%Y%m%d%H%M%S')}")
+          # TODO: delete old archives ?
         end
-        # first ensure license file is here so that ascp invokation for version works
-        self.path(:aspera_license)
-        self.path(:aspera_conf)
+        # SDK is organized by architecture
+        arch_filter="#{Environment.architecture}/"
+        # extract files from archive
         Zip::File.open(sdk_zip_path) do |zip_file|
           zip_file.each do |entry|
-            # get only specified arch, but not folder, only files
-            if entry.name.include?(filter) and !entry.name.end_with?('/')
-              archive_file=File.join(sdk_path,File.basename(entry.name))
-              File.open(archive_file, 'wb') do |output_stream|
-                IO.copy_stream(entry.get_input_stream, output_stream)
-              end
-              if File.basename(entry.name).eql?(ascp_filename)
-                FileUtils.chmod(0755,archive_file)
-                ascp_path=archive_file
-              end
+            # skip folder entries
+            next if entry.name.end_with?('/')
+            dest_folder=nil
+            # binaries
+            dest_folder=sdk_folder if entry.name.include?(arch_filter)
+            # ruby adapters
+            dest_folder=sdk_ruby_folder if entry.name.end_with?(EXT_RUBY_PROTOBUF)
+            next if dest_folder.nil?
+            File.open(File.join(dest_folder,File.basename(entry.name)), 'wb') do |output_stream|
+              IO.copy_stream(entry.get_input_stream, output_stream)
             end
           end
         end
         File.unlink(sdk_zip_path) rescue nil # Windows may give error
-        ascp_version=get_ascp_version(ascp_path)
-        File.write(File.join(folder_path,PRODUCT_INFO),"<product><name>IBM Aspera SDK</name><version>#{ascp_version}</version></product>")
-        return ascp_version
+        # ensure license file are generated so that ascp invokation for version works
+        path(:aspera_license)
+        path(:aspera_conf)
+        ascp_path=File.join(sdk_folder,ascp_filename)
+        raise "No #{ascp_filename} found in SDK archive" unless File.exist?(ascp_path)
+        FileUtils.chmod(0755,ascp_path)
+        FileUtils.chmod(0755,ascp_path.gsub('ascp','ascp4'))
+        ascp_version=get_ascp_version(File.join(sdk_folder,ascp_filename))
+        trd_path=transferd_filepath
+        Log.log.warn("No #{trd_path} in SDK archive") unless File.exist?(trd_path)
+        FileUtils.chmod(0755,trd_path) if File.exist?(trd_path)
+        transferd_version=get_exe_version(trd_path,'version')
+        sdk_version = transferd_version||ascp_version
+        File.write(File.join(sdk_folder,PRODUCT_INFO),"<product><name>IBM Aspera SDK</name><version>#{sdk_version}</version></product>")
+        return sdk_version
       end
 
       private
@@ -269,7 +295,7 @@ module Aspera
 
       def initialize
         @path_to_ascp=nil
-        @sdk_folder=nil
+        @sdk_dir=nil
         @found_products=nil
       end
 
@@ -281,11 +307,13 @@ module Aspera
         return found.first
       end
 
-      # @return the path to folder where SDK is installed
-      def folder_path
-        raise "Undefined path to SDK" if @sdk_folder.nil?
-        FileUtils.mkdir_p(@sdk_folder) unless Dir.exist?(@sdk_folder)
-        @sdk_folder
+      # filename for ascp with optional extension (Windows)
+      def ascp_filename
+        return 'ascp'+Environment.exe_extension
+      end
+
+      def transferd_filepath
+        return File.join(sdk_folder,'asperatransferd'+Environment.exe_extension)
       end
 
       # @return product folders depending on OS fields
@@ -297,49 +325,49 @@ module Aspera
       def product_locations
         case Aspera::Environment.os
         when Aspera::Environment::OS_WINDOWS; return [{
-            :expected =>PRODUCT_CONNECT,
-            :app_root =>File.join(ENV['LOCALAPPDATA'],'Programs','Aspera','Aspera Connect'),
-            :log_root =>File.join(ENV['LOCALAPPDATA'],'Aspera','Aspera Connect','var','log'),
-            :run_root =>File.join(ENV['LOCALAPPDATA'],'Aspera','Aspera Connect')
+            expected: PRODUCT_CONNECT,
+            app_root: File.join(ENV['LOCALAPPDATA'],'Programs','Aspera','Aspera Connect'),
+            log_root: File.join(ENV['LOCALAPPDATA'],'Aspera','Aspera Connect','var','log'),
+            run_root: File.join(ENV['LOCALAPPDATA'],'Aspera','Aspera Connect')
             },{
-            :expected =>PRODUCT_CLI_V1,
-            :app_root =>File.join('C:','Program Files','Aspera','cli'),
-            :log_root =>File.join('C:','Program Files','Aspera','cli','var','log'),
+            expected: PRODUCT_CLI_V1,
+            app_root: File.join('C:','Program Files','Aspera','cli'),
+            log_root: File.join('C:','Program Files','Aspera','cli','var','log')
             },{
-            :expected =>PRODUCT_ENTSRV,
-            :app_root =>File.join('C:','Program Files','Aspera','Enterprise Server'),
-            :log_root =>File.join('C:','Program Files','Aspera','Enterprise Server','var','log'),
+            expected: PRODUCT_ENTSRV,
+            app_root: File.join('C:','Program Files','Aspera','Enterprise Server'),
+            log_root: File.join('C:','Program Files','Aspera','Enterprise Server','var','log')
             }]
         when Aspera::Environment::OS_X; return [{
-            :expected =>PRODUCT_CONNECT,
-            :app_root =>File.join(Dir.home,'Applications','Aspera Connect.app'),
-            :log_root =>File.join(Dir.home,'Library','Logs','Aspera_Connect'),
-            :run_root =>File.join(Dir.home,'Library','Application Support','Aspera','Aspera Connect'),
-            :sub_bin  =>File.join('Contents','Resources'),
+            expected: PRODUCT_CONNECT,
+            app_root: File.join(Dir.home,'Applications','Aspera Connect.app'),
+            log_root: File.join(Dir.home,'Library','Logs','Aspera_Connect'),
+            run_root: File.join(Dir.home,'Library','Application Support','Aspera','Aspera Connect'),
+            sub_bin: File.join('Contents','Resources')
             },{
-            :expected =>PRODUCT_CLI_V1,
-            :app_root =>File.join(Dir.home,'Applications','Aspera CLI'),
-            :log_root =>File.join(Dir.home,'Library','Logs','Aspera')
+            expected: PRODUCT_CLI_V1,
+            app_root: File.join(Dir.home,'Applications','Aspera CLI'),
+            log_root: File.join(Dir.home,'Library','Logs','Aspera')
             },{
-            :expected =>PRODUCT_ENTSRV,
-            :app_root =>File.join('','Library','Aspera'),
-            :log_root =>File.join(Dir.home,'Library','Logs','Aspera'),
+            expected: PRODUCT_ENTSRV,
+            app_root: File.join('','Library','Aspera'),
+            log_root: File.join(Dir.home,'Library','Logs','Aspera')
             },{
-            :expected =>PRODUCT_DRIVE,
-            :app_root =>File.join('','Applications','Aspera Drive.app'),
-            :log_root =>File.join(Dir.home,'Library','Logs','Aspera_Drive'),
-            :sub_bin  =>File.join('Contents','Resources'),
+            expected: PRODUCT_DRIVE,
+            app_root: File.join('','Applications','Aspera Drive.app'),
+            log_root: File.join(Dir.home,'Library','Logs','Aspera_Drive'),
+            sub_bin: File.join('Contents','Resources')
             }]
-        else; return [{  # other: Linux and Unix family
-            :expected =>PRODUCT_CONNECT,
-            :app_root =>File.join(Dir.home,'.aspera','connect'),
-            :run_root =>File.join(Dir.home,'.aspera','connect')
+        else; return [{ # other: Linux and Unix family
+            expected: PRODUCT_CONNECT,
+            app_root: File.join(Dir.home,'.aspera','connect'),
+            run_root: File.join(Dir.home,'.aspera','connect')
             },{
-            :expected =>PRODUCT_CLI_V1,
-            :app_root =>File.join(Dir.home,'.aspera','cli'),
+            expected: PRODUCT_CLI_V1,
+            app_root: File.join(Dir.home,'.aspera','cli')
             },{
-            :expected =>PRODUCT_ENTSRV,
-            :app_root =>File.join('','opt','aspera'),
+            expected: PRODUCT_ENTSRV,
+            app_root: File.join('','opt','aspera')
             }]
         end
       end
@@ -349,10 +377,10 @@ module Aspera
       # @param id in repository 1 for dsa, 2 for rsa
       def get_key(type,id)
         hf=['begin','end'].map{|t|"-----#{t} #{type} private key-----".upcase}
-        bin=Base64.strict_encode64(DataRepository.instance.get_bin(id))
-        hf.insert(1,bin).join("\n")
+        bin=Base64.strict_encode64(DataRepository.instance.data(id))
+        # validate valie and generate key in connonical format
+        OpenSSL::PKey.const_get(type.upcase).send(:new,hf.insert(1,bin).join("\n")).to_pem
       end
-
     end # Installation
   end
 end

data/lib/aspera/fasp/listener.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aspera
   module Fasp
     # imlement this class to get transfer events