aspera-cli 4.21.2 → 4.22.0

data/lib/aspera/cli/plugins/ats.rb

@@ -14,8 +14,10 @@ module Aspera
       # Access Aspera Transfer Service
       # https://developer.ibm.com/aspera/docs/ats-api-reference/creating-ats-api-keys/
       class Ats < Cli::Plugin
+        # columns for list of cloud providers
         CLOUD_TABLE = %w[id name].freeze
-        def initialize(**env)
+        private_constant :CLOUD_TABLE
+        def initialize(**_)
           super
           options.declare(:ibm_api_key, 'IBM API key, see https://cloud.ibm.com/iam/apikeys')
           options.declare(:instance, 'ATS instance in ibm cloud')
@@ -68,7 +70,7 @@ module Aspera
               when 'ibm-s3'
                 server_data2 = nil
                 if server_data.nil?
-                  server_data2 = @ats_api_pub.all_servers.find{|s|s['id'].eql?(params['transfer_server_id'])}
+                  server_data2 = @ats_api_pub.all_servers.find{ |s| s['id'].eql?(params['transfer_server_id'])}
                   raise "no such transfer server id: #{params['transfer_server_id']}" if server_data2.nil?
                 else
                   server_data2 = @ats_api_pub.all_servers.find do |s|
@@ -86,15 +88,15 @@ module Aspera
               end
             end
             res = ats_api_pub_v1.create('access_keys', params)
-            return {type: :single_object, data: res}
+            return Main.result_single_object(res)
             # TODO : action : modify, with "PUT"
           when :list
             params = options.get_option(:params) || {'offset' => 0, 'max_results' => 1000}
             res = ats_api_pub_v1.read('access_keys', params)
-            return {type: :object_list, data: res['data'], fields: ['name', 'id', 'created.at', 'modified.at']}
+            return Main.result_object_list(res['data'], fields: ['name', 'id', 'created.at', 'modified.at'])
           when :show
             res = ats_api_pub_v1.read("access_keys/#{access_key_id}")
-            return {type: :single_object, data: res}
+            return Main.result_single_object(res)
           when :modify
             params = value_create_modify(command: command)
             params['id'] = access_key_id
@@ -103,13 +105,13 @@ module Aspera
           when :entitlement
             ak = ats_api_pub_v1.read("access_keys/#{access_key_id}")
             api_bss = Api::Alee.new(ak['license']['entitlement_id'], ak['license']['customer_id'])
-            return {type: :single_object, data: api_bss.read('entitlement')}
+            return Main.result_single_object(api_bss.read('entitlement'))
           when :delete
             ats_api_pub_v1.delete("access_keys/#{access_key_id}")
             return Main.result_status("deleted #{access_key_id}")
           when :node
             ak_data = ats_api_pub_v1.read("access_keys/#{access_key_id}")
-            server_data = @ats_api_pub.all_servers.find {|i| i['id'].start_with?(ak_data['transfer_server_id'])}
+            server_data = @ats_api_pub.all_servers.find{ |i| i['id'].start_with?(ak_data['transfer_server_id'])}
             raise Cli::Error, 'no such server found' if server_data.nil?
             node_url = server_data['transfer_setup_url']
             api_node = Api::Node.new(
@@ -130,7 +132,7 @@ module Aspera
                 username: access_key_id,
                 password: config.lookup_secret(url: ats_url, username: access_key_id)
               })
-            return {type: :single_object, data: api_ak_auth.read('servers')}
+            return Main.result_single_object(api_ak_auth.read('servers'))
           else Aspera.error_unexpected_value(command)
           end
         end
@@ -139,18 +141,18 @@ module Aspera
           command = options.get_next_command(%i[clouds list show])
           case command
           when :clouds
-            return {type: :object_list, data: @ats_api_pub.cloud_names.map { |k, v| CLOUD_TABLE.zip([k, v]).to_h }}
+            return Main.result_object_list(@ats_api_pub.cloud_names.map{ |k, v| CLOUD_TABLE.zip([k, v]).to_h})
           when :list
-            return {type: :object_list, data: @ats_api_pub.all_servers, fields: %w[id cloud region]}
+            return Main.result_object_list(@ats_api_pub.all_servers, fields: %w[id cloud region])
           when :show
             if options.get_option(:cloud) || options.get_option(:region)
               server_data = server_by_cloud_region
             else
               server_id = instance_identifier
-              server_data = @ats_api_pub.all_servers.find {|i| i['id'].eql?(server_id)}
+              server_data = @ats_api_pub.all_servers.find{ |i| i['id'].eql?(server_id)}
               raise 'no such server id' if server_data.nil?
             end
-            return {type: :single_object, data: server_data}
+            return Main.result_single_object(server_data)
           end
         end
 
@@ -189,16 +191,16 @@ module Aspera
           when :instances
             instances = ats_ibm_api.read('instances')
             Log.log.warn{"more instances remaining: #{instances['remaining']}"} unless instances['remaining'].to_i.eql?(0)
-            return {type: :value_list, data: instances['data'], name: 'instance'}
+            return Main.result_value_list(instances['data'], name: 'instance')
           when :create
             created_key = ats_ibm_api.create('api_keys', value_create_modify(command: command, default: {}))
-            return {type: :single_object, data: created_key}
+            return Main.result_single_object(created_key)
           when :list # list known api keys in ATS (this require an api_key ...)
             res = ats_ibm_api.read('api_keys', {'offset' => 0, 'max_results' => 1000})
-            return {type: :value_list, data: res['data'], name: 'ats_id'}
+            return Main.result_value_list(res['data'], name: 'ats_id')
           when :show # show one of api_key in ATS
             res = ats_ibm_api.read("api_keys/#{concerned_id}")
-            return {type: :single_object, data: res}
+            return Main.result_single_object(res)
           when :delete
             ats_ibm_api.delete("api_keys/#{concerned_id}")
             return Main.result_status("deleted #{concerned_id}")
@@ -225,7 +227,7 @@ module Aspera
             return execute_action_api_key
           when :aws_trust_policy
             res = ats_api_pub_v1.read('aws/trustpolicy', {region: options.get_option(:region, mandatory: true)})
-            return {type: :single_object, data: res}
+            return Main.result_single_object(res)
           else Aspera.error_unexpected_value(command)
           end
         end

data/lib/aspera/cli/plugins/config.rb

@@ -13,6 +13,7 @@ require 'aspera/products/transferd'
 require 'aspera/transfer/error_info'
 require 'aspera/transfer/parameters'
 require 'aspera/transfer/spec'
+require 'aspera/transfer/spec_doc'
 require 'aspera/keychain/macos_security'
 require 'aspera/proxy_auto_config'
 require 'aspera/environment'
@@ -39,7 +40,6 @@ module Aspera
         ASPERA_HOME_FOLDER_NAME = '.aspera'
         # default config file
         DEFAULT_CONFIG_FILENAME = 'config.yaml'
-        DEFAULT_VAULT_FILENAME = 'vault.bin'
         # reserved preset names
         CONF_PRESET_CONFIG = 'config'
         CONF_PRESET_VERSION = 'version'
@@ -76,6 +76,7 @@ module Aspera
         # for testing only
         SELF_SIGNED_CERT = OpenSSL::SSL.const_get(:enon_yfirev.to_s.upcase.reverse) # cspell: disable-line
         CONF_OVERVIEW_KEYS = %w[preset parameter value].freeze
+        SMTP_CONF_PARAMS = %i[server tls ssl port domain username password from_name from_email].freeze
         private_constant :DEFAULT_CONFIG_FILENAME,
           :CONF_PRESET_CONFIG,
           :CONF_PRESET_VERSION,
@@ -97,7 +98,8 @@ module Aspera
           :SELF_SIGNED_CERT,
           :PERSISTENCY_FOLDER,
           :DEFAULT_PRIV_KEY_LENGTH,
-          :CONF_OVERVIEW_KEYS
+          :CONF_OVERVIEW_KEYS,
+          :SMTP_CONF_PARAMS
 
         class << self
           def generate_rsa_private_key(path:, length: DEFAULT_PRIV_KEY_LENGTH)
@@ -142,13 +144,13 @@ module Aspera
           end
         end
 
-        def initialize(**env)
+        def initialize(**_)
           # we need to defer parsing of options until we have the config file, so we can use @extend with @preset
           super
           @use_plugin_defaults = true
           @config_presets = nil
           @config_checksum_on_disk = nil
-          @vault = nil
+          @vault_instance = nil
           @pac_exec = nil
           @sdk_default_location = false
           @option_insecure = false
@@ -172,8 +174,8 @@ module Aspera
             default: self.class.default_app_main_folder(app_name: Info::CMD_NAME))
           options.parse_options!
           Log.log.debug{"#{Info::CMD_NAME} folder: #{@main_folder}"}
-          # data persistency manager, created by config plugin
-          @persistency = PersistencyFolder.new(File.join(@main_folder, PERSISTENCY_FOLDER))
+          # data persistency manager, created by config plugin, set for global object
+          @broker.persistency = PersistencyFolder.new(File.join(@main_folder, PERSISTENCY_FOLDER))
           # set folders for plugin lookup
           PluginFactory.instance.add_lookup_folder(self.class.gem_plugins_folder)
           PluginFactory.instance.add_lookup_folder(File.join(@main_folder, ASPERA_PLUGINS_FOLDERNAME))
@@ -186,19 +188,19 @@ module Aspera
           # read config file (set @config_presets)
           read_config_file
           # add preset handler (needed for smtp)
-          ExtendedValue.instance.set_handler(EXTEND_PRESET, lambda{|v|preset_by_name(v)})
-          ExtendedValue.instance.set_handler(EXTEND_VAULT, lambda{|v|vault_value(v)})
+          ExtendedValue.instance.set_handler(EXTEND_PRESET, lambda{ |v| preset_by_name(v)})
+          ExtendedValue.instance.set_handler(EXTEND_VAULT, lambda{ |v| vault_value(v)})
           # load defaults before it can be overridden
           add_plugin_default_preset(CONF_GLOBAL_SYM)
           # vault options
           options.declare(:secret, 'Secret for access keys')
-          options.declare(:vault, 'Vault for secrets', types: Hash)
+          options.declare(:vault, 'Vault for secrets', types: Hash, default: {})
           options.declare(:vault_password, 'Vault password')
           options.parse_options!
           # declare generic plugin options only after handlers are declared
           Plugin.declare_generic_options(options)
           # configuration options
-          options.declare(:no_default, 'Do not load default configuration for plugin', values: :none, short: 'N') { @use_plugin_defaults = false }
+          options.declare(:no_default, 'Do not load default configuration for plugin', values: :none, short: 'N'){@use_plugin_defaults = false}
           options.declare(:preset, 'Load the named option preset from current config file', short: 'P', handler: {o: self, m: :option_preset})
           options.declare(:version_check_days, 'Period in days to check new version (zero to disable)', coerce: Integer, default: DEFAULT_CHECK_NEW_VERSION_DAYS)
           options.declare(:plugin_folder, 'Folder where to find additional plugins', handler: {o: self, m: :option_plugin_folder})
@@ -261,8 +263,8 @@ module Aspera
           end
           RestParameters.instance.user_agent = Info::CMD_NAME
           RestParameters.instance.progress_bar = @progress_bar
-          RestParameters.instance.session_cb = lambda{|http_session|update_http_session(http_session)}
-          @option_http_options.keys.select{|i|RestParameters.instance.respond_to?(i)}.each do |k|
+          RestParameters.instance.session_cb = lambda{ |http_session| update_http_session(http_session)}
+          @option_http_options.keys.select{ |i| RestParameters.instance.respond_to?(i)}.each do |k|
             method = "#{k}=".to_sym
             RestParameters.instance.send(method, @option_http_options[k])
             @option_http_options.delete(k)
@@ -299,7 +301,7 @@ module Aspera
               paths_to_add = [OpenSSL::X509::DEFAULT_CERT_DIR]
               # JRuby cert file seems not to be PEM
               paths_to_add.push(OpenSSL::X509::DEFAULT_CERT_FILE) unless defined?(JRUBY_VERSION)
-              paths_to_add.select!{|f|File.exist?(f)}
+              paths_to_add.select!{ |f| File.exist?(f)}
             elsif File.file?(path)
               @certificate_store.add_file(path)
             elsif File.directory?(path)
@@ -311,8 +313,8 @@ module Aspera
               pp = [File.realpath(p)]
               if File.directory?(p)
                 pp = Dir.entries(p)
-                  .map{|e|File.realpath(File.join(p, e))}
-                  .select{|entry|File.file?(entry)}
+                  .map{ |e| File.realpath(File.join(p, e))}
+                  .select{ |entry| File.file?(entry)}
               end
               @certificate_paths.concat(pp)
             end
@@ -519,7 +521,7 @@ module Aspera
           Aspera.assert_values(value.class, [String, Array]){'plugin folder'}
           value = [value] if value.is_a?(String)
           Aspera.assert(value.all?(String)){'plugin folder'}
-          value.each{|f|PluginFactory.instance.add_lookup_folder(f)}
+          value.each{ |f| PluginFactory.instance.add_lookup_folder(f)}
         end
 
         def option_plugin_folder
@@ -549,7 +551,7 @@ module Aspera
           # files search for configuration, by default the one given by user
           search_files = [@option_config_file]
           # find first existing file (or nil)
-          conf_file_to_load = search_files.find{|f| File.exist?(f)}
+          conf_file_to_load = search_files.find{ |f| File.exist?(f)}
           # if no file found, create default config
           if conf_file_to_load.nil?
             Log.log.warn{"No config file found. New configuration file: #{@option_config_file}"}
@@ -632,7 +634,7 @@ module Aspera
             found_apps.push({product: plugin_name_sym, name: app_name, url: app_url, version: 'unknown'}.merge(detection_info))
           end
           raise "No known application found at #{app_url}" if found_apps.empty?
-          Aspera.assert(found_apps.all?{|a|a.keys.all?(Symbol)})
+          Aspera.assert(found_apps.all?{ |a| a.keys.all?(Symbol)})
           return found_apps
         end
 
@@ -640,8 +642,8 @@ module Aspera
           command = options.get_next_command(%i[list info version])
           if %i[info version].include?(command)
             connect_id = options.get_next_argument('id or title')
-            one_res = Products::Connect.instance.versions.find{|i|i['id'].eql?(connect_id) || i['title'].eql?(connect_id)}
-            raise Cli::NoSuchIdentifier.new(:connect, connect_id) if one_res.nil?
+            one_res = Products::Connect.instance.versions.find{ |i| i['id'].eql?(connect_id) || i['title'].eql?(connect_id)}
+            raise Cli::BadIdentifier.new(:connect, connect_id) if one_res.nil?
           end
           case command
           when :list
@@ -654,7 +656,7 @@ module Aspera
             command = options.get_next_command(%i[list download open])
             if %i[download open].include?(command)
               link_title = options.get_next_argument('title or rel')
-              one_link = all_links.find {|i| i['title'].eql?(link_title) || i['rel'].eql?(link_title)}
+              one_link = all_links.find{ |i| i['title'].eql?(link_title) || i['rel'].eql?(link_title)}
               raise "no such value: #{link_title}" if one_link.nil?
             end
             case command
@@ -673,7 +675,7 @@ module Aspera
         end
 
         def execute_action_ascp
-          command = options.get_next_command(%i[connect use show products info install spec errors])
+          command = options.get_next_command(%i[connect use show products info install spec schema errors])
           case command
           when :connect
             return execute_connect_action
@@ -691,7 +693,7 @@ module Aspera
             # add command line transfer spec
             data['ts'] = transfer.updated_ts
             # add keys
-            DataRepository::ELEMENTS.each_with_object(data){|i, h|h[i.to_s] = DataRepository.instance.item(i)}
+            DataRepository::ELEMENTS.each_with_object(data){ |i, h| h[i.to_s] = DataRepository.instance.item(i)}
             # declare those as secrets
             SecretHider::ADDITIONAL_KEYS_TO_HIDE.concat(DataRepository::ELEMENTS.map(&:to_s))
             return Main.result_single_object(data)
@@ -714,9 +716,15 @@ module Aspera
             return Main.result_status("Installed #{n} version #{v}")
           when :spec
             return Main.result_object_list(
-              Transfer::Parameters.man_table(formatter),
-              fields: [%w[name type], Transfer::Parameters::SUPPORTED_AGENTS_SHORT.map(&:to_s), %w[description]].flatten.freeze
+              Transfer::SpecDoc.man_table(formatter, cli: false),
+              fields: Transfer::SpecDoc::TABLE_COLUMNS.map(&:to_s)
             )
+          when :schema
+            schema = Transfer::Spec::SCHEMA.merge({'$comment'=>'DO NOT EDIT, this file was generated from the YAML.'})
+            agent = options.get_next_argument('transfer agent name', mandatory: false)
+            schema['properties'] = schema['properties'].select{ |_k, v| CommandLineBuilder.supported_by_agent(agent, v)} unless agent.nil?
+            schema['properties'] = schema['properties'].sort.to_h
+            return Main.result_single_object(schema)
           when :errors
             error_data = []
             Transfer::ERROR_INFO.each_pair do |code, prop|
@@ -754,7 +762,7 @@ module Aspera
         PRESET_EXIST_ACTIONS = %i[show delete get unset].freeze
         # require id
         PRESET_INSTANCE_ACTIONS = %i[initialize update ask set].concat(PRESET_EXIST_ACTIONS).freeze
-        PRESET_ALL_ACTIONS = [PRESET_GBL_ACTIONS, PRESET_INSTANCE_ACTIONS].flatten.freeze
+        PRESET_ALL_ACTIONS = (PRESET_GBL_ACTIONS + PRESET_INSTANCE_ACTIONS).freeze
 
         def execute_preset(action: nil, name: nil)
           action = options.get_next_command(PRESET_ALL_ACTIONS) if action.nil?
@@ -786,7 +794,7 @@ module Aspera
             value = @config_presets[name][param_name]
             raise "no such option in preset #{name} : #{param_name}" if value.nil?
             case value
-            when Numeric, String then return {type: :text, data: ExtendedValue.instance.evaluate(value.to_s)}
+            when Numeric, String then return Main.result_text(ExtendedValue.instance.evaluate(value.to_s))
             end
             return Main.result_single_object(value)
           when :unset
@@ -919,10 +927,10 @@ module Aspera
             when :only
               return Main.result_status(remote_chain.first.to_pem)
             when :name
-              return Main.result_status(remote_chain.first.subject.to_a.find { |name, _, _| name == 'CN' }[1])
+              return Main.result_status(remote_chain.first.subject.to_a.find{ |name, _, _| name == 'CN'}[1])
             end
           when :echo # display the content of a value given on command line
-            return Formatter.auto_type(options.get_next_argument('value', validation: nil))
+            return Main.result_auto(options.get_next_argument('value', validation: nil))
           when :download
             file_url = options.get_next_argument('source URL').chomp
             file_dest = options.get_next_argument('file path', mandatory: false)
@@ -1051,9 +1059,10 @@ module Aspera
           else
             formatter.display_status('Multiple applications detected, please select from:')
             formatter.display_results(type: :object_list, data: apps, fields: %w[product url version])
-            answer = options.prompt_user_input_in_list('product', apps.map{|a|a[:product]})
-            apps.find{|a|a[:product].eql?(answer)}
+            answer = options.prompt_user_input_in_list('product', apps.map{ |a| a[:product]})
+            apps.find{ |a| a[:product].eql?(answer)}
           end
+          wiz_preset_name = options.get_next_argument('preset name', default: '')
           Log.log.debug{Log.dump(:identification, identification)}
           wiz_url = identification[:url]
           formatter.display_status("Using: #{identification[:name]} at #{wiz_url}".bold)
@@ -1078,7 +1087,6 @@ module Aspera
             if private_key_path.nil?
               formatter.display_status('Please provide the path to your private RSA key, or nothing to generate one:')
               private_key_path = options.get_option(:key_path, mandatory: true).to_s
-              # private_key_path = File.expand_path(private_key_path)
             end
             # else generate path
             if private_key_path.empty?
@@ -1103,13 +1111,12 @@ module Aspera
           Log.log.debug{"wizard result: #{wizard_result}"}
           Aspera.assert(WIZARD_RESULT_KEYS.eql?(wizard_result.keys.sort)){"missing or extra keys in wizard result: #{wizard_result.keys}"}
           # get preset name from user or default
-          wiz_preset_name = nil
-          if wiz_preset_name.nil?
+          if wiz_preset_name.empty?
             elements = [
               identification[:product],
               URI.parse(wiz_url).host
             ]
-            elements.push(options.get_option(:username, mandatory: true)) unless wizard_result[:preset_value].key?(:link)
+            elements.push(options.get_option(:username, mandatory: true)) unless wizard_result[:preset_value].key?(:link) rescue nil
             wiz_preset_name = elements.join('_').strip.downcase.gsub(/[^a-z0-9]/, '_').squeeze('_')
           end
           # test mode does not change conf file
@@ -1138,9 +1145,12 @@ module Aspera
         # @return [Hash] email server setting with defaults if not defined
         def email_settings
           smtp = options.get_option(:smtp, mandatory: true)
-          # change string keys into symbol keys
+          # change keys from string into symbol
           smtp = smtp.symbolize_keys
+          unsupported = smtp.keys - SMTP_CONF_PARAMS
+          raise Cli::Error, "Unsupported SMTP parameter: #{unsupported.join(', ')}, use: #{SMTP_CONF_PARAMS.join(', ')}" unless unsupported.empty?
           # defaults
+          # smtp[:ssl] = nil (false)
           smtp[:tls] = !smtp[:ssl] unless smtp.key?(:tls)
           smtp[:port] ||= if smtp[:tls]
             587
@@ -1169,8 +1179,8 @@ module Aspera
           mail_conf = email_settings
           values[:from_name] ||= mail_conf[:from_name]
           values[:from_email] ||= mail_conf[:from_email]
-          %i[from_name from_email].each do |n|
-            Aspera.assert(values.key?(n)){"Missing email parameter: #{n}"}
+          %i[to from_email].each do |n|
+            Aspera.assert_type(values[n], String){"Missing email parameter: #{n} in config"}
           end
           start_options = [mail_conf[:domain]]
           start_options.push(mail_conf[:username], mail_conf[:password], :login) if mail_conf.key?(:username) && mail_conf.key?(:password)
@@ -1204,7 +1214,7 @@ module Aspera
           Environment.restrict_file_access(@main_folder)
           Log.log.info{"Writing #{@option_config_file}"}
           formatter.display_status('Saving config file.')
-          Environment.write_file_restricted(@option_config_file, force: true) {@config_presets.to_yaml}
+          Environment.write_file_restricted(@option_config_file, force: true){@config_presets.to_yaml}
           @config_checksum_on_disk = current_checksum
           return true
         end
@@ -1234,15 +1244,15 @@ module Aspera
           return nil
         end
 
-        # TODO: delete: ALLOWED_KEYS = %i[password username description].freeze
         # @return [Hash] result of execution of vault command
         def execute_vault
           command = options.get_next_command(%i[info list show create delete password])
           case command
           when :info
-            return Main.result_single_object(vault_info)
+            return Main.result_single_object(vault.info)
           when :list
-            return Main.result_object_list(vault.list, fields: %w(label url username password description))
+            # , fields: %w(label url username password description)
+            return Main.result_object_list(vault.list)
           when :show
             return Main.result_single_object(vault.get(label: options.get_next_argument('label')))
           when :create
@@ -1251,17 +1261,15 @@ module Aspera
             info = info.symbolize_keys
             info[:label] = label
             vault.set(info)
-            return Main.result_status('Password added')
+            return Main.result_status('Secret added')
           when :delete
             label_to_delete = options.get_next_argument('label')
             vault.delete(label: label_to_delete)
-            return Main.result_status("Entry deleted: #{label_to_delete}")
+            return Main.result_status("Secret deleted: #{label_to_delete}")
           when :password
-            Aspera.assert(vault.respond_to?(:password=)){'Vault does not support password change'}
-            new_password = options.get_next_argument('new_password')
-            vault.password = new_password
-            vault.save
-            return Main.result_status('Password updated')
+            Aspera.assert(vault.respond_to?(:change_password)){'Vault does not support password change'}
+            vault.change_password(options.get_next_argument('new_password'))
+            return Main.result_status('Vault password updated')
           end
         end
 
@@ -1276,42 +1284,18 @@ module Aspera
           return value
         end
 
-        def vault_info
-          info = options.get_option(:vault) || {}
-          info = info.symbolize_keys
-          info[:type] ||= 'file'
-          info[:name] ||= (info[:type].eql?('file') ? DEFAULT_VAULT_FILENAME : Info::CMD_NAME)
-          Aspera.assert(info.keys.sort == %i[name type]) {"vault info shall have exactly keys 'type' and 'name'"}
-          Aspera.assert(info.values.all?(String)){'vault info shall have only string values'}
-          info[:password] = options.get_option(:vault_password, mandatory: true)
-          return info
-        end
-
         # @return [Object] vault, from options or cache
         def vault
-          if @vault.nil?
-            info = vault_info
-            case info[:type]
-            when 'file'
-              # this module requires comilation, so it is optinal
-              require 'aspera/keychain/encrypted_hash'
-              # absolute_path? introduced in ruby 2.7
-              @vault = Keychain::EncryptedHash.new(
-                info[:name].eql?(File.absolute_path(info[:name])) ? info[:name] : File.join(@main_folder, info[:name]),
-                info[:password])
-            when 'system'
-              case Environment.os
-              when Environment::OS_MACOS
-                @vault = Keychain::MacosSystem.new(info[:name], info[:password])
-              else
-                raise 'not implemented for this OS'
-              end
-            else
-              raise Cli::BadArgument, "Unknown vault type: #{info[:type]}"
-            end
-          end
-          raise 'No vault defined' if @vault.nil?
-          @vault
+          return @vault_instance unless @vault_instance.nil?
+          info = options.get_option(:vault).symbolize_keys
+          info[:type] ||= 'file'
+          require 'aspera/keychain/factory'
+          @vault_instance = Keychain::Factory.create(
+            info,
+            Info::CMD_NAME,
+            @main_folder,
+            options.get_option(:vault_password)
+          )
         end
 
         def execute_test

data/lib/aspera/cli/plugins/console.rb

@@ -40,7 +40,9 @@ module Aspera
             return nil
           end
 
-          def wizard(object:, private_key_path: nil, pub_key_pem: nil)
+          # @param object [Plugin] An instance of this class
+          # @return [Hash] :preset_value, :test_args
+          def wizard(object:)
             options = object.options
             return {
               preset_value: {
@@ -84,11 +86,11 @@ module Aspera
               command = options.get_next_command(%i[list submit])
               case command
               when :list
-                return {type: :object_list, data: api_console.read('smart_transfers')}
+                return Main.result_object_list(api_console.read('smart_transfers'))
               when :submit
                 smart_id = options.get_next_argument('smart_id')
                 params = options.get_next_argument('transfer parameters')
-                return {type: :object_list, data: api_console.create("smart_transfers/#{smart_id}", params)}
+                return Main.result_object_list(api_console.create("smart_transfers/#{smart_id}", params))
               end
             when :current
               command = options.get_next_command([:list])