Class: Aspera::Cli::Plugins::Config

Inherits:
Aspera::Cli::Plugin show all
Defined in:
lib/aspera/cli/plugins/config.rb

Overview

manage the CLI config file

Constant Summary collapse

ASPERA_HOME_FOLDER_NAME =

folder in $HOME for application files (config, cache)

'.aspera'
DEFAULT_VAULT_FILENAME = 
'vault.bin'
GLOBAL_DEFAULT_KEYWORD =

special name to identify value of default

'GLOBAL'
CONF_GLOBAL_SYM = 
:config
APP_NAME_SDK = 
'sdk'
CONNECT_WEB_URL = 
'https://d3gcli72yxqn2z.cloudfront.net/connect'
CONNECT_VERSIONS =

cspell: disable-line

'connectversions.js'
GEM_CHECK_DATE_FMT = 
'%Y/%m/%d'
PRESET_GBL_ACTIONS =

legacy actions available globally

%i[list overview lookup secure].freeze
PRESET_EXIST_ACTIONS =

operations requiring that preset exists

%i[show delete get unset].freeze
PRESET_INSTANCE_ACTIONS =

require id

%i[initialize update ask set].concat(PRESET_EXIST_ACTIONS).freeze
PRESET_ALL_ACTIONS = 
[PRESET_GBL_ACTIONS, PRESET_INSTANCE_ACTIONS].flatten.freeze
ACTIONS = 
%i[
  preset
  open
  documentation
  genkey
  pubkey
  remote_certificate
  gem
  plugins
  flush_tokens
  echo
  wizard
  detect
  coffee
  image
  ascp
  email_test
  smtp_settings
  proxy_check
  folder
  file
  check_update
  initdemo
  vault
  throw
  platform
].freeze

Constants inherited from Aspera::Cli::Plugin

Aspera::Cli::Plugin::ALL_OPS, Aspera::Cli::Plugin::GLOBAL_OPS, Aspera::Cli::Plugin::INIT_PARAMS, Aspera::Cli::Plugin::INSTANCE_OPS, Aspera::Cli::Plugin::MAX_ITEMS, Aspera::Cli::Plugin::MAX_PAGES, Aspera::Cli::Plugin::REGEX_LOOKUP_ID_BY_FIELD

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Aspera::Cli::Plugin

declare_generic_options, #do_bulk_operation, #entity_action, #entity_command, #init_params, #instance_identifier, #query_option, #query_read_delete, #value_create_modify

Constructor Details

#initialize(gem:, name:, help:, version:, **env) ⇒ Config

Returns a new instance of Config.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/aspera/cli/plugins/config.rb', line 148

def initialize(gem:, name:, help:, version:, **env)
  # we need to defer parsing of options until we have the config file, so we can use @extend with @preset
  super(**env)
  @gem = gem
  @name = name
  @help = help
  @version = version
  @use_plugin_defaults = true
  @config_presets = nil
  @config_checksum_on_disk = nil
  @connect_versions = nil
  @vault = nil
  @pac_exec = nil
  @sdk_default_location = false
  @option_insecure = false
  @option_warn_insecure_cert = true
  @option_ignore_cert_host_port = []
  @option_http_options = {}
  @ssl_warned_urls = []
  @option_cache_tokens = true
  @main_folder = nil
  @option_config_file = nil
  # store is used for ruby https
  @certificate_store = nil
  # paths are used for ascp
  @certificate_paths = nil
  @progress_bar = nil
  # option to set main folder
  options.declare(
    :home, 'Home folder for tool',
    handler: {o: self, m: :main_folder},
    types: String,
    default: self.class.default_app_main_folder(app_name: @name))
  options.parse_options!
  Log.log.debug{"#{@name} folder: #{@main_folder}"}
  # data persistency manager, created by config plugin
  @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))
  # option to set config file
  options.declare(
    :config_file, 'Path to YAML file with preset configuration',
    handler: {o: self, m: :option_config_file},
    default: File.join(@main_folder, DEFAULT_CONFIG_FILENAME))
  options.parse_options!
  # 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)})
  # 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_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(: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})
  # wizard options
  options.declare(:override, 'Wizard: override existing value', values: :bool, default: :no)
  options.declare(:default, 'Wizard: set as default configuration for specified plugin (also: update)', values: :bool, default: true)
  options.declare(:test_mode, 'Wizard: skip private key check step', values: :bool, default: false)
  options.declare(:key_path, 'Wizard: path to private key for JWT')
  # Transfer SDK options
  options.declare(:ascp_path, 'Path to ascp', handler: {o: Ascp::Installation.instance, m: :ascp_path})
  options.declare(:use_product, 'Use ascp from specified product', handler: {o: self, m: :option_use_product})
  options.declare(:sdk_url, 'URL to get SDK', default: TRANSFER_SDK_ARCHIVE_URL)
  options.declare(:sdk_folder, 'SDK folder path', handler: {o: Ascp::Installation.instance, m: :sdk_folder})
  options.declare(:progress_bar, 'Display progress bar', values: :bool, default: Environment.terminal?)
  # email options
  options.declare(:smtp, 'SMTP configuration', types: Hash)
  options.declare(:notify_to, 'Email recipient for notification of transfers')
  options.declare(:notify_template, 'Email ERB template for notification of transfers')
  # HTTP options
  options.declare(:insecure, 'Do not validate any HTTPS certificate', values: :bool, handler: {o: self, m: :option_insecure}, default: :no)
  options.declare(:ignore_certificate, 'Do not validate HTTPS certificate for these URLs', types: Array, handler: {o: self, m: :option_ignore_cert_host_port})
  options.declare(:silent_insecure, 'Issue a warning if certificate is ignored', values: :bool, handler: {o: self, m: :option_warn_insecure_cert}, default: :yes)
  options.declare(:cert_stores, 'List of folder with trusted certificates', types: [Array, String], handler: {o: self, m: :trusted_cert_locations})
  options.declare(:http_options, 'Options for HTTP/S socket', types: Hash, handler: {o: self, m: :option_http_options}, default: {})
  options.declare(:http_proxy, 'URL for HTTP proxy with optional credentials', types: String, handler: {o: self, m: :option_http_proxy})
  options.declare(:cache_tokens, 'Save and reuse OAuth tokens', values: :bool, handler: {o: self, m: :option_cache_tokens})
  options.declare(:fpac, 'Proxy auto configuration script')
  options.declare(:proxy_credentials, 'HTTP proxy credentials for fpac. Array: user,password', types: Array)
  options.parse_options!
  @progress_bar = TransferProgress.new if options.get_option(:progress_bar)
  # Check SDK folder is set or not, for compatibility, we check in two places
  sdk_folder = Ascp::Installation.instance.sdk_folder rescue nil
  if sdk_folder.nil?
    @sdk_default_location = true
    Log.log.debug('SDK folder is not set, checking default')
    # new location
    sdk_folder = self.class.default_app_main_folder(app_name: APP_NAME_SDK)
    Log.log.debug{"checking: #{sdk_folder}"}
    if !Dir.exist?(sdk_folder)
      Log.log.debug{"not exists: #{sdk_folder}"}
      # former location
      former_sdk_folder = File.join(self.class.default_app_main_folder(app_name: @name), APP_NAME_SDK)
      Log.log.debug{"checking: #{former_sdk_folder}"}
      sdk_folder = former_sdk_folder if Dir.exist?(former_sdk_folder)
    end
    Log.log.debug{"using: #{sdk_folder}"}
    Ascp::Installation.instance.sdk_folder = sdk_folder
  end
  pac_script = options.get_option(:fpac)
  # create PAC executor
  if !pac_script.nil?
    @pac_exec = ProxyAutoConfig.new(pac_script).register_uri_generic
    proxy_user_pass = options.get_option(:proxy_credentials)
    if !proxy_user_pass.nil?
      Aspera.assert(proxy_user_pass.length.eql?(2), exception_class: Cli::BadArgument){"proxy_credentials shall have two elements (#{proxy_user_pass.length})"}
      @pac_exec.proxy_user = proxy_user_pass[0]
      @pac_exec.proxy_pass = proxy_user_pass[1]
    end
  end
  Rest.set_parameters(
    user_agent:  PROGRAM_NAME,
    session_cb:  lambda{|http_session|update_http_session(http_session)},
    progress_bar: @progress_bar)
  OAuth::Factory.instance.persist_mgr = persistency if @option_cache_tokens
  Transfer::Parameters.file_list_folder = File.join(@main_folder, 'filelists')
  RestErrorAnalyzer.instance.log_file = File.join(@main_folder, 'rest_exceptions.log')
  # register aspera REST call error handlers
  RestErrorsAspera.register_handlers
end

Instance Attribute Details

#gem_url ⇒ Object (readonly)

$HOME/.aspera/‘program_name`



509
510
511
 
# File 'lib/aspera/cli/plugins/config.rb', line 509

def gem_url
  @gem_url
end

#main_folder ⇒ Object

Returns the value of attribute main_folder.



280
281
282
 
# File 'lib/aspera/cli/plugins/config.rb', line 280

def main_folder
  @main_folder
end

#option_cache_tokens ⇒ Object

Returns the value of attribute option_cache_tokens.



280
281
282
 
# File 'lib/aspera/cli/plugins/config.rb', line 280

def option_cache_tokens
  @option_cache_tokens
end

#option_config_file ⇒ Object

Returns the value of attribute option_config_file.



510
511
512
 
# File 'lib/aspera/cli/plugins/config.rb', line 510

def option_config_file
  @option_config_file
end

#option_http_options ⇒ Object

Returns the value of attribute option_http_options.



280
281
282
 
# File 'lib/aspera/cli/plugins/config.rb', line 280

def option_http_options
  @option_http_options
end

#option_ignore_cert_host_port ⇒ Object

Returns the value of attribute option_ignore_cert_host_port.



281
282
283
 
# File 'lib/aspera/cli/plugins/config.rb', line 281

def option_ignore_cert_host_port
  @option_ignore_cert_host_port
end

#option_insecure ⇒ Object

Returns the value of attribute option_insecure.



280
281
282
 
# File 'lib/aspera/cli/plugins/config.rb', line 280

def option_insecure
  @option_insecure
end

#option_warn_insecure_cert ⇒ Object

Returns the value of attribute option_warn_insecure_cert.



280
281
282
 
# File 'lib/aspera/cli/plugins/config.rb', line 280

def option_warn_insecure_cert
  @option_warn_insecure_cert
end

#progress_bar ⇒ Object (readonly)

Returns the value of attribute progress_bar.



281
282
283
 
# File 'lib/aspera/cli/plugins/config.rb', line 281

def progress_bar
  @progress_bar
end

Class Method Details

.default_app_main_folder(app_name:) ⇒ Object

return product config folder (~/.aspera/<name>)



141
142
143
144
145
 
# File 'lib/aspera/cli/plugins/config.rb', line 141

def default_app_main_folder(app_name:)
  Aspera.assert_type(app_name, String)
  Aspera.assert(!app_name.empty?)
  return File.join(module_family_folder, app_name)
end

.gem_plugins_folder ⇒ Object

folder containing plugins in the gem’s main folder



117
118
119
 
# File 'lib/aspera/cli/plugins/config.rb', line 117

def gem_plugins_folder
  File.dirname(File.expand_path(__FILE__))
end

.gem_src_root ⇒ Object

go up as many times as englobing modules (not counting class, as it is a file)

Returns:

  • main folder where code is, i.e. …/lib



123
124
125
126
 
# File 'lib/aspera/cli/plugins/config.rb', line 123

def gem_src_root
  # Module.nesting[2] is Cli::Plugins
  File.expand_path(Module.nesting[2].to_s.gsub('::', '/').gsub(%r{[^/]+}, '..'), gem_plugins_folder)
end

.generate_rsa_private_key(path:, length: DEFAULT_PRIV_KEY_LENGTH) ⇒ Object 



106
107
108
109
110
111
112
113
114
 
# File 'lib/aspera/cli/plugins/config.rb', line 106

def generate_rsa_private_key(path:, length: DEFAULT_PRIV_KEY_LENGTH)
  require 'openssl'
  priv_key = OpenSSL::PKey::RSA.new(length)
  File.write(path, priv_key.to_s)
  File.write("#{path}.pub", priv_key.public_key.to_s)
  Environment.restrict_file_access(path)
  Environment.restrict_file_access("#{path}.pub")
  nil
end

.module_family_folder ⇒ Object

return product family folder (~/.aspera)



134
135
136
137
138
 
# File 'lib/aspera/cli/plugins/config.rb', line 134

def module_family_folder
  user_home_folder = Dir.home
  Aspera.assert(Dir.exist?(user_home_folder), exception_class: Cli::Error){"Home folder does not exist: #{user_home_folder}. Check your user environment."}
  return File.join(user_home_folder, ASPERA_HOME_FOLDER_NAME)
end

.protect_presets(val) ⇒ Object

deep clone hash so that it does not get modified in case of display and secret hide



129
130
131
 
# File 'lib/aspera/cli/plugins/config.rb', line 129

def protect_presets(val)
  return JSON.parse(JSON.generate(val))
end

Instance Method Details

#add_plugin_default_preset(plugin_name_sym) ⇒ Object

loads default parameters of plugin if no -P parameter and if there is a section defined for the plugin in the “default” section try to find: conf[conf[plugin_str]]

Parameters:

  • plugin_name_sym —

    : symbol for plugin name



463
464
465
466
467
468
 
# File 'lib/aspera/cli/plugins/config.rb', line 463

def add_plugin_default_preset(plugin_name_sym)
  default_config_name = get_plugin_default_config_name(plugin_name_sym)
  Log.log.debug{"add_plugin_default_preset:#{plugin_name_sym}:#{default_config_name}"}
  options.add_option_preset(preset_by_name(default_config_name), 'default_plugin', override: false) unless default_config_name.nil?
  return nil
end

#canonical_url(url) ⇒ Object

version of URL without trailing “/” and removing default port



1293
1294
1295
 
# File 'lib/aspera/cli/plugins/config.rb', line 1293

def canonical_url(url)
  url.sub(%r{/+$}, '').sub(%r{^(https://[^/]+):443$}, '\1')
end

#check_gem_version ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aspera/cli/plugins/config.rb', line 394

def check_gem_version
  latest_version =
    begin
      Rest.new(base_url: 'https://rubygems.org/api/v1').read("versions/#{@gem}/latest.json")[:data]['version']
    rescue StandardError
      Log.log.warn('Could not retrieve latest gem version on rubygems.')
      '0'
    end
  if Gem::Version.new(Environment.ruby_version) < Gem::Version.new(RUBY_FUTURE_MINIMUM_VERSION)
    Log.log.warn do
      "Note that a future version will require Ruby version #{RUBY_FUTURE_MINIMUM_VERSION} at minimum, " \
        "you are using #{Environment.ruby_version}"
    end
  end
  return {
    name:        @gem,
    current:     Cli::VERSION,
    latest:      latest_version,
    need_update: Gem::Version.new(Cli::VERSION) < Gem::Version.new(latest_version)
  }
end

#config_checksum ⇒ Object 



561
562
563
 
# File 'lib/aspera/cli/plugins/config.rb', line 561

def config_checksum
  JSON.generate(@config_presets).hash
end

#connect_versions ⇒ Object

retrieve structure from cloud (CDN) with all versions available



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/aspera/cli/plugins/config.rb', line 443

def connect_versions
  if @connect_versions.nil?
    api_connect_cdn = Rest.new(base_url: CONNECT_WEB_URL)
    javascript = api_connect_cdn.call(operation: 'GET', subpath: CONNECT_VERSIONS)
    # get result on one line
    connect_versions_javascript = javascript[:http].body.gsub(/\r?\n\s*/, '')
    Log.log.debug{"javascript=[\n#{connect_versions_javascript}\n]"}
    # get javascript object only
    found = connect_versions_javascript.match(/^.*? = (.*);/)
    raise Cli::Error, 'Problem when getting connect versions from internet' if found.nil?
    all_data = JSON.parse(found[1])
    @connect_versions = all_data['entries']
  end
  return @connect_versions
end

#email_settings ⇒ Hash

Returns email server setting with defaults if not defined.

Returns:

  • (Hash) —

    email server setting with defaults if not defined



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/aspera/cli/plugins/config.rb', line 1119

def email_settings
  smtp = options.get_option(:smtp, mandatory: true)
  # change string keys into symbol keys
  smtp = smtp.symbolize_keys
  # defaults
  smtp[:tls] = !smtp[:ssl] unless smtp.key?(:tls)
  smtp[:port] ||= if smtp[:tls]
    587
  elsif smtp[:ssl]
    465
  else
    25
  end
  smtp[:from_email] ||= smtp[:username] if smtp.key?(:username)
  smtp[:from_name] ||= smtp[:from_email].sub(/@.*$/, '').gsub(/[^a-zA-Z]/, ' ').capitalize if smtp.key?(:username)
  smtp[:domain] ||= smtp[:from_email].sub(/^.*@/, '') if smtp.key?(:from_email)
  # check minimum required
  %i[server port domain].each do |n|
    Aspera.assert(smtp.key?(n)){"Missing mandatory smtp parameter: #{n}"}
  end
  Log.log.debug{"smtp=#{smtp}"}
  return smtp
end

#execute_action ⇒ Object

Main action procedure for plugin



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aspera/cli/plugins/config.rb', line 880

def execute_action
  action = options.get_next_command(ACTIONS)
  case action
  when :preset # newer syntax
    return execute_preset
  when :open
    Environment.open_editor(@option_config_file.to_s)
    return Main.result_nothing
  when :documentation
    section = options.get_next_argument('private key file path', mandatory: false)
    section = "##{section}" unless section.nil?
    Environment.instance.open_uri("#{@help}#{section}")
    return Main.result_nothing
  when :genkey # generate new rsa key
    private_key_path = options.get_next_argument('private key file path')
    private_key_length = options.get_next_argument('size in bits', mandatory: false, validation: Integer, default: DEFAULT_PRIV_KEY_LENGTH)
    self.class.generate_rsa_private_key(path: private_key_path, length: private_key_length)
    return Main.result_status("Generated #{private_key_length} bit RSA key: #{private_key_path}")
  when :pubkey # get pub key
    private_key_pem = options.get_next_argument('private key PEM value')
    return Main.result_status(OpenSSL::PKey::RSA.new(private_key_pem).public_key.to_s)
  when :remote_certificate
    cert_action = options.get_next_command(%i[chain only name])
    remote_url = options.get_next_argument('remote URL')
    remote_chain = Rest.remote_certificate_chain(remote_url, as_string: false)
    raise "No certificate found for #{remote_url}" unless remote_chain&.first
    case cert_action
    when :chain
      return Main.result_status(remote_chain.map(&:to_pem).join("\n"))
    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])
    end
  when :echo # display the content of a value given on command line
    return Formatter.auto_type(options.get_next_argument('value', validation: nil))
  when :flush_tokens
    deleted_files = OAuth::Factory.instance.flush_tokens
    return {type: :value_list, data: deleted_files, name: 'file'}
  when :plugins
    case options.get_next_command(%i[list create])
    when :list
      result = []
      PluginFactory.instance.plugin_list.each do |name|
        plugin_class = PluginFactory.instance.plugin_class(name)
        result.push({
          plugin: name,
          detect: Formatter.tick(plugin_class.respond_to?(:detect)),
          wizard: Formatter.tick(plugin_class.respond_to?(:wizard)),
          path:   PluginFactory.instance.plugin_source(name)
        })
      end
      return {type: :object_list, data: result, fields: %w[plugin detect wizard path]}
    when :create
      plugin_name = options.get_next_argument('name').downcase
      destination_folder = options.get_next_argument('folder', mandatory: false) || File.join(@main_folder, ASPERA_PLUGINS_FOLDERNAME)
      plugin_file = File.join(destination_folder, "#{plugin_name}.rb")
      content = <<~END_OF_PLUGIN_CODE
        require 'aspera/cli/plugin'
        module Aspera
          module Cli
            module Plugins
              class #{plugin_name.capitalize} < Plugin
                ACTIONS=[]
                def execute_action; return Main.result_status('You called plugin #{plugin_name}'); end
              end # #{plugin_name.capitalize}
            end # Plugins
          end # Cli
        end # Aspera
      END_OF_PLUGIN_CODE
      File.write(plugin_file, content)
      return Main.result_status("Created #{plugin_file}")
    end
  when :detect, :wizard
    # interactive mode
    options.ask_missing_mandatory = true
    # detect plugins by url and optional query
    apps = identify_plugins_for_url.freeze
    return {
      type: :object_list,
      data: apps
    } if action.eql?(:detect)
    return wizard_find(apps)
  when :coffee
    return Main.result_image(COFFEE_IMAGE, formatter: formatter)
  when :image
    return Main.result_image(options.get_next_argument('image uri or blob'), formatter: formatter)
  when :ascp
    execute_action_ascp
  when :gem
    case options.get_next_command(%i[path version name])
    when :path then return Main.result_status(self.class.gem_src_root)
    when :version then return Main.result_status(Cli::VERSION)
    when :name then return Main.result_status(@gem)
    end
  when :folder
    return Main.result_status(@main_folder)
  when :file
    return Main.result_status(@option_config_file)
  when :email_test
    send_email_template(email_template_default: EMAIL_TEST_TEMPLATE)
    return Main.result_nothing
  when :smtp_settings
    return {type: :single_object, data: email_settings}
  when :proxy_check
    # ensure fpac was provided
    options.get_option(:fpac, mandatory: true)
    server_url = options.get_next_argument('server url')
    return Main.result_status(@pac_exec.find_proxy_for_url(server_url))
  when :check_update
    return {type: :single_object, data: check_gem_version}
  when :initdemo
    if @config_presets.key?(DEMO_PRESET)
      Log.log.warn{"Demo server preset already present: #{DEMO_PRESET}"}
    else
      Log.log.info{"Creating Demo server preset: #{DEMO_PRESET}"}
      @config_presets[DEMO_PRESET] = {
        'url'                                    => "ssh://#{DEMO_SERVER}.asperasoft.com:33001",
        'username'                               => ASPERA,
        'ssAP'.downcase.reverse + 'drow'.reverse => DEMO_SERVER + ASPERA # cspell:disable-line
      }
    end
    @config_presets[CONF_PRESET_DEFAULTS] ||= {}
    if @config_presets[CONF_PRESET_DEFAULTS].key?(SERVER_COMMAND)
      Log.log.warn{"Server default preset already set to: #{@config_presets[CONF_PRESET_DEFAULTS][SERVER_COMMAND]}"}
      Log.log.warn{"Use #{DEMO_PRESET} for demo: -P#{DEMO_PRESET}"} unless
        DEMO_PRESET.eql?(@config_presets[CONF_PRESET_DEFAULTS][SERVER_COMMAND])
    else
      @config_presets[CONF_PRESET_DEFAULTS][SERVER_COMMAND] = DEMO_PRESET
      Log.log.info{"Setting server default preset to : #{DEMO_PRESET}"}
    end
    return Main.result_status('Done')
  when :vault then execute_vault
  when :throw
    # :type [String]
    options
    exception_class_name = options.get_next_argument('exception class name', mandatory: true)
    exception_text = options.get_next_argument('exception text', mandatory: true)
    exception_class = Object.const_get(exception_class_name)
    Aspera.assert(exception_class <= Exception){"#{exception_class} is not an exception: #{exception_class.class}"}
    raise exception_class, exception_text
  when :platform
    return Main.result_status(Environment.architecture)
  else Aspera.error_unreachable_line
  end
end

#execute_action_ascp ⇒ Object 



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/aspera/cli/plugins/config.rb', line 697

def execute_action_ascp
  command = options.get_next_command(%i[connect use show products info install spec errors])
  case command
  when :connect
    return execute_connect_action
  when :use
    ascp_path = options.get_next_argument('path to ascp')
    formatter.display_status("ascp version: #{Ascp::Installation.instance.get_ascp_version(ascp_path)}")
    set_global_default(:ascp_path, ascp_path)
    return Main.result_nothing
  when :show
    return {type: :status, data: Ascp::Installation.instance.path(:ascp)}
  when :info
    # collect info from ascp executable
    data = Ascp::Installation.instance.ascp_info
    # 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)}
    # declare those as secrets
    SecretHider::ADDITIONAL_KEYS_TO_HIDE.push(*DataRepository::ELEMENTS.map(&:to_s))
    return {type: :single_object, data: data}
  when :products
    command = options.get_next_command(%i[list use])
    case command
    when :list
      return {type: :object_list, data: Ascp::Products.installed_products, fields: %w[name app_root]}
    when :use
      default_product = options.get_next_argument('product name')
      Ascp::Installation.instance.use_ascp_from_product(default_product)
      set_global_default(:ascp_path, Ascp::Installation.instance.path(:ascp))
      return Main.result_nothing
    end
  when :install
    # reset to default location, if older default was used
    Ascp::Installation.instance.sdk_folder = self.class.default_app_main_folder(app_name: APP_NAME_SDK) if @sdk_default_location
    n, v = Ascp::Installation.instance.install_sdk(options.get_option(:sdk_url, mandatory: true))
    return Main.result_status("Installed #{n} version #{v}")
  when :spec
    return {
      type:   :object_list,
      data:   Transfer::Parameters.man_table(formatter),
      fields: [%w[name type], Transfer::Parameters::SUPPORTED_AGENTS_SHORT.map(&:to_s), %w[description]].flatten.freeze
    }
  when :errors
    error_data = []
    Transfer::ERROR_INFO.each_pair do |code, prop|
      error_data.push(code: code, mnemonic: prop[:c], retry: prop[:r], info: prop[:a])
    end
    return {type: :object_list, data: error_data}
  end
  raise "unexpected case: #{command}"
end

#execute_connect_action ⇒ Object 



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aspera/cli/plugins/config.rb', line 658

def execute_connect_action
  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 = connect_versions.find{|i|i['id'].eql?(connect_id) || i['title'].eql?(connect_id)}
    raise Cli::NoSuchIdentifier.new(:connect, connect_id) if one_res.nil?
  end
  case command
  when :list
    return {type: :object_list, data: connect_versions, fields: %w[id title version]}
  when :info
    one_res.delete('links')
    return {type: :single_object, data: one_res}
  when :version
    all_links = one_res['links']
    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)}
      raise 'no such value' if one_link.nil?
    end
    case command
    when :list
      return {type: :object_list, data: all_links}
    when :download
      folder_dest = transfer.destination_folder(Transfer::Spec::DIRECTION_RECEIVE)
      # folder_dest=self.options.get_next_argument('destination folder')
      api_connect_cdn = Rest.new(base_url: CONNECT_WEB_URL)
      file_url = one_link['href']
      filename = file_url.gsub(%r{.*/}, '')
      api_connect_cdn.call(operation: 'GET', subpath: file_url, save_to_file: File.join(folder_dest, filename))
      return Main.result_status("Downloaded: #{filename}")
    when :open
      Environment.instance.open_uri(one_link['href'])
      return Main.result_status("Opened: #{one_link['href']}")
    end
  end
end

#execute_preset(action: nil, name: nil) ⇒ Object 



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/aspera/cli/plugins/config.rb', line 759

def execute_preset(action: nil, name: nil)
  action = options.get_next_command(PRESET_ALL_ACTIONS) if action.nil?
  name = instance_identifier if name.nil? && PRESET_INSTANCE_ACTIONS.include?(action)
  name = global_default_preset if name.eql?(GLOBAL_DEFAULT_KEYWORD)
  # those operations require existing option
  raise "no such preset: #{name}" if PRESET_EXIST_ACTIONS.include?(action) && !@config_presets.key?(name)
  case action
  when :list
    return {type: :value_list, data: @config_presets.keys, name: 'name'}
  when :overview
    # display process modifies the value (hide secrets): we do not want to save removed secrets
    return {type: :config_over, data: self.class.protect_presets(@config_presets)}
  when :show
    return {type: :single_object, data: self.class.protect_presets(@config_presets[name])}
  when :delete
    @config_presets.delete(name)
    return Main.result_status("Deleted: #{name}")
  when :get
    param_name = options.get_next_argument('parameter name')
    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)}
    end
    return {type: :single_object, data: value}
  when :unset
    param_name = options.get_next_argument('parameter name')
    @config_presets[name].delete(param_name)
    return Main.result_status("Removed: #{name}: #{param_name}")
  when :set
    param_name = options.get_next_argument('parameter name')
    param_name = Manager.option_line_to_name(param_name)
    param_value = options.get_next_argument('parameter value', validation: nil)
    set_preset_key(name, param_name, param_value)
    return Main.result_nothing
  when :initialize
    config_value = options.get_next_argument('extended value', validation: Hash)
    if @config_presets.key?(name)
      Log.log.warn{"configuration already exists: #{name}, overwriting"}
    end
    @config_presets[name] = config_value
    return Main.result_status("Modified: #{@option_config_file}")
  when :update
    #  get unprocessed options
    unprocessed_options = options.unprocessed_options_with_value
    Log.log.debug{"opts=#{unprocessed_options}"}
    @config_presets[name] ||= {}
    @config_presets[name].merge!(unprocessed_options)
    return Main.result_status("Updated: #{name}")
  when :ask
    options.ask_missing_mandatory = true
    @config_presets[name] ||= {}
    options.get_next_argument('option names', multiple: true).each do |option_name|
      option_value = options.get_interactive(option_name, option: true)
      @config_presets[name][option_name] = option_value
    end
    return Main.result_status("Updated: #{name}")
  when :lookup
    BasicAuthPlugin.declare_options(options)
    url = options.get_option(:url, mandatory: true)
    user = options.get_option(:username, mandatory: true)
    result = lookup_preset(url: url, username: user)
    raise 'no such config found' if result.nil?
    return {type: :single_object, data: result}
  when :secure
    identifier = options.get_next_argument('config name', mandatory: false)
    preset_names = identifier.nil? ? @config_presets.keys : [identifier]
    secret_keywords = %w[password secret].freeze
    preset_names.each do |preset_name|
      preset = @config_presets[preset_name]
      next unless preset.is_a?(Hash)
      preset.each_key do |option_name|
        secret_keywords.each do |keyword|
          next unless option_name.end_with?(keyword)
          vault_label = preset_name
          incr = 0
          until vault.get(label: vault_label, exception: false).nil?
            vault_label = "#{preset_name}#{incr}"
            incr += 1
          end
          to_set = {label: vault_label, password: preset[option_name]}
          puts "need to encode #{preset_name}.#{option_name} -> #{vault_label} -> #{to_set}"
          # to_copy=%i[]
          vault.set(to_set)
          preset[option_name] = "@vault:#{vault_label}.password"
        end
      end
    end
    return Main.result_status('Secrets secured in vault: Make sure to save the vault password securely.')
  end
end

#execute_vault ⇒ Hash

TODO: delete: ALLOWED_KEYS = %i[password username description].freeze

Returns:

  • (Hash) —

    result of execution of vault command



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
 
# File 'lib/aspera/cli/plugins/config.rb', line 1216

def execute_vault
  command = options.get_next_command(%i[info list show create delete password])
  case command
  when :info
    return {type: :single_object, data: vault_info}
  when :list
    return {type: :object_list, data: vault.list, fields: %w(label url username password description)}
  when :show
    return {type: :single_object, data: vault.get(label: options.get_next_argument('label'))}
  when :create
    label = options.get_next_argument('label', validation: String)
    info = options.get_next_argument('info', validation: Hash)
    info = info.symbolize_keys
    info[:label] = label
    vault.set(info)
    return Main.result_status('Password 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}")
  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')
  end
end

#get_plugin_default_config_name(plugin_name_sym) ⇒ Object

returns [String] name if config_presets has default returns nil if there is no config or bypass default params



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/aspera/cli/plugins/config.rb', line 1192

def get_plugin_default_config_name(plugin_name_sym)
  Aspera.assert(!@config_presets.nil?){'config_presets shall be defined'}
  if !@use_plugin_defaults
    Log.log.debug('skip default config')
    return nil
  end
  if @config_presets.key?(CONF_PRESET_DEFAULTS) &&
      @config_presets[CONF_PRESET_DEFAULTS].key?(plugin_name_sym.to_s)
    default_config_name = @config_presets[CONF_PRESET_DEFAULTS][plugin_name_sym.to_s]
    if !@config_presets.key?(default_config_name)
      Log.log.error do
        "Default config name [#{default_config_name}] specified for plugin [#{plugin_name_sym}], but it does not exist in config file.\n" \
          'Please fix the issue: either create preset with one parameter: ' \
          "(#{@name} config id #{default_config_name} init @json:'{}') or remove default (#{@name} config id default remove #{plugin_name_sym})."
      end
    end
    raise Cli::Error, "Config name [#{default_config_name}] must be a hash, check config file." if !@config_presets[default_config_name].is_a?(Hash)
    return default_config_name
  end
  return nil
end

#global_default_preset ⇒ Object

get the default global preset, or set default one



471
472
473
474
475
476
477
478
 
# File 'lib/aspera/cli/plugins/config.rb', line 471

def global_default_preset
  result = get_plugin_default_config_name(CONF_GLOBAL_SYM)
  if result.nil?
    result = CONF_PRESET_GLOBAL
    set_preset_key(CONF_PRESET_DEFAULTS, CONF_GLOBAL_SYM, result)
  end
  return result
end

#identify_plugins_for_url ⇒ Hash

Find a plugin, and issue the “require”

Returns:

  • (Hash) —

    plugin info: { product: , url:, version: }



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/aspera/cli/plugins/config.rb', line 620

def identify_plugins_for_url
  app_url = options.get_next_argument('url', mandatory: true)
  check_only = options.get_next_argument('plugin name', mandatory: false)
  check_only = check_only.to_sym unless check_only.nil?
  found_apps = []
  my_self_plugin_sym = self.class.name.split('::').last.downcase.to_sym
  PluginFactory.instance.plugin_list.each do |plugin_name_sym|
    # no detection for internal plugin
    next if plugin_name_sym.eql?(my_self_plugin_sym)
    next if check_only && !check_only.eql?(plugin_name_sym)
    # load plugin class
    detect_plugin_class = PluginFactory.instance.plugin_class(plugin_name_sym)
    # requires detection method
    next unless detect_plugin_class.respond_to?(:detect)
    detection_info = nil
    begin
      Log.log.debug{"detecting #{plugin_name_sym} at #{app_url}"}
      formatter.long_operation_running("#{plugin_name_sym}\r")
      detection_info = detect_plugin_class.detect(app_url)
    rescue OpenSSL::SSL::SSLError => e
      Log.log.warn(e.message)
      Log.log.warn('Use option --insecure=yes to allow unchecked certificate') if e.message.include?('cert')
    rescue StandardError => e
      Log.log.debug{"detect error: [#{e.class}] #{e}"}
      next
    end
    next if detection_info.nil?
    Aspera.assert_type(detection_info, Hash)
    Aspera.assert_type(detection_info[:url], String) if detection_info.key?(:url)
    app_name = detect_plugin_class.respond_to?(:application_name) ? detect_plugin_class.application_name : detect_plugin_class.name.split('::').last
    # if there is a redirect, then the detector can override the url.
    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)})
  return found_apps
end

#ignore_cert?(address, port) ⇒ Boolean

Returns:

  • (Boolean) 


355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/aspera/cli/plugins/config.rb', line 355

def ignore_cert?(address, port)
  endpoint = [address, port].freeze
  ignore_cert = false
  if @option_insecure || @option_ignore_cert_host_port.any?(endpoint)
    ignore_cert = true
    if @option_warn_insecure_cert
      base_url = "https://#{address}:#{port}"
      if !@ssl_warned_urls.include?(base_url)
        formatter.display_message(
          :error,
          "#{Formatter::WARNING_FLASH} Ignoring certificate for: #{base_url}. Do not deactivate certificate verification in production.")
        @ssl_warned_urls.push(base_url)
      end
    end
  end
  Log.log.debug{"ignore cert? #{endpoint} -> #{ignore_cert}"}
  return ignore_cert
end

#lookup_preset(url:, username:) ⇒ Object 



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/aspera/cli/plugins/config.rb', line 1297

def lookup_preset(url:, username:)
  # remove extra info to maximize match
  url = canonical_url(url)
  Log.log.debug{"Lookup preset for #{username}@#{url}"}
  @config_presets.each_value do |v|
    next unless v.is_a?(Hash)
    conf_url = v['url'].is_a?(String) ? canonical_url(v['url']) : nil
    return self.class.protect_presets(v) if conf_url.eql?(url) && v['username'].eql?(username)
  end
  nil
end

#lookup_secret(url:, username:, mandatory: false) ⇒ Object 



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/aspera/cli/plugins/config.rb', line 1309

def lookup_secret(url:, username:, mandatory: false)
  secret = options.get_option(:secret)
  if secret.nil?
    conf = lookup_preset(url: url, username: username)
    if conf.is_a?(Hash)
      Log.log.debug{"Found preset #{conf} with URL and username"}
      secret = conf['password']
    end
    raise "Please provide secret for #{username} using option: secret or by setting a preset for #{username}@#{url}." if secret.nil? && mandatory
  end
  return secret
end

#option_http_proxy ⇒ Object 



338
339
340
 
# File 'lib/aspera/cli/plugins/config.rb', line 338

def option_http_proxy
  return ENV['http_proxy']
end

#option_http_proxy=(value) ⇒ Object 



342
343
344
345
 
# File 'lib/aspera/cli/plugins/config.rb', line 342

def option_http_proxy=(value)
  URI.parse(value)
  ENV['http_proxy'] = value
end

#option_plugin_folder ⇒ Object 



544
545
546
 
# File 'lib/aspera/cli/plugins/config.rb', line 544

def option_plugin_folder
  return PluginFactory.instance.lookup_folders
end

#option_plugin_folder=(value) ⇒ Object 



537
538
539
540
541
542
 
# File 'lib/aspera/cli/plugins/config.rb', line 537

def option_plugin_folder=(value)
  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)}
end

#option_preset ⇒ Object 



548
 
# File 'lib/aspera/cli/plugins/config.rb', line 548

def option_preset; 'write-only option'; end

#option_preset=(value) ⇒ Object 



550
551
552
553
554
555
556
557
558
559
 
# File 'lib/aspera/cli/plugins/config.rb', line 550

def option_preset=(value)
  case value
  when Hash
    options.add_option_preset(value, 'set')
  when String
    options.add_option_preset(preset_by_name(value), 'set_by_name')
  else
    raise 'Preset definition must be a String for preset name, or Hash for set of values'
  end
end

#option_use_product ⇒ Object 



533
534
535
 
# File 'lib/aspera/cli/plugins/config.rb', line 533

def option_use_product
  'write-only option, see value of ascp_path'
end

#option_use_product=(value) ⇒ Object 



529
530
531
 
# File 'lib/aspera/cli/plugins/config.rb', line 529

def option_use_product=(value)
  Ascp::Installation.instance.use_ascp_from_product(value)
end

#periodic_check_newer_gem_version ⇒ Object 



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/aspera/cli/plugins/config.rb', line 416

def periodic_check_newer_gem_version
  # get verification period
  delay_days = options.get_option(:version_check_days, mandatory: true)
  # check only if not zero day
  return if delay_days.eql?(0)
  # get last date from persistency
  last_check_array = []
  check_date_persist = PersistencyActionOnce.new(
    manager: persistency,
    data:    last_check_array,
    id:      'version_last_check')
  # get persisted date or nil
  current_date = Date.today
  last_check_days = (current_date - Date.strptime(last_check_array.first, GEM_CHECK_DATE_FMT)) rescue nil
  Log.log.debug{"gem check new version: #{delay_days}, #{last_check_days}, #{current_date}, #{last_check_array}"}
  return if !last_check_days.nil? && last_check_days < delay_days
  # generate timestamp
  last_check_array[0] = current_date.strftime(GEM_CHECK_DATE_FMT)
  check_date_persist.save
  # compare this version and the one on internet
  check_data = check_gem_version
  Log.log.warn do
    "A new version is available: #{check_data[:latest]}. You have #{check_data[:current]}. Upgrade with: gem update #{check_data[:name]}"
  end if check_data[:need_update]
end

#preset_by_name(config_name, include_path = []) ⇒ Object

Returns the hash from name (also expands possible includes).

Parameters:

  • config_name —

    name of the preset in config file

  • include_path (defaults to: []) —

    used to detect and avoid include loops

Returns:

  • the hash from name (also expands possible includes)

Raises:



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/aspera/cli/plugins/config.rb', line 515

def preset_by_name(config_name, include_path=[])
  raise Cli::Error, 'loop in include' if include_path.include?(config_name)
  include_path = include_path.clone # avoid messing up if there are multiple branches
  current = @config_presets
  config_name.split(PRESET_DIG_SEPARATOR).each do |name|
    Aspera.assert_type(current, Hash, exception_class: Cli::Error){"sub key: #{include_path}"}
    include_path.push(name)
    current = current[name]
    raise Cli::Error, "No such config preset: #{include_path}" if current.nil?
  end
  current = self.class.protect_presets(current) unless current.is_a?(String)
  return ExtendedValue.instance.evaluate(current)
end

#read_config_file ⇒ Object

read config file and validate format



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aspera/cli/plugins/config.rb', line 566

def read_config_file
  Log.log.debug{"config file is: #{@option_config_file}".red}
  # 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)}
  # 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}"}
    @config_presets = {CONF_PRESET_CONFIG => {CONF_PRESET_VERSION => 'new file'}}
    # @config_checksum_on_disk is nil
  else
    Log.log.debug{"loading #{@option_config_file}"}
    @config_presets = YAML.load_file(conf_file_to_load)
    @config_checksum_on_disk = config_checksum
  end
  files_to_copy = []
  Log.log.trace1{Log.dump('Available_presets', @config_presets)}
  Aspera.assert_type(@config_presets, Hash){'config file YAML'}
  # check there is at least the config section
  Aspera.assert(@config_presets.key?(CONF_PRESET_CONFIG)){"Cannot find key: #{CONF_PRESET_CONFIG}"}
  version = @config_presets[CONF_PRESET_CONFIG][CONF_PRESET_VERSION]
  raise 'No version found in config section.' if version.nil?
  Log.log.debug{"conf version: #{version}"}
  # VVV if there are any conversion needed, those happen here.
  # fix bug in 4.4 (creating key "true" in "default" preset)
  @config_presets[CONF_PRESET_DEFAULTS].delete(true) if @config_presets[CONF_PRESET_DEFAULTS].is_a?(Hash)
  # ^^^ Place new compatibility code before this line
  # set version to current
  @config_presets[CONF_PRESET_CONFIG][CONF_PRESET_VERSION] = @version
  unless files_to_copy.empty?
    Log.log.warn('Copying referenced files')
    files_to_copy.each do |file|
      FileUtils.cp(file, @main_folder)
      Log.log.warn{"#{file} -> #{@main_folder}"}
    end
  end
rescue Psych::SyntaxError => e
  Log.log.error('YAML error in config file')
  raise e
rescue StandardError => e
  Log.log.debug{"-> #{e.class.name} : #{e}"}
  if File.exist?(@option_config_file)
    # then there is a problem with that file.
    new_name = "#{@option_config_file}.pre#{@version}.manual_conversion_needed"
    File.rename(@option_config_file, new_name)
    Log.log.warn{"Renamed config file to #{new_name}."}
    Log.log.warn('Manual Conversion is required. Next time, a new empty file will be created.')
  end
  raise Cli::Error, e.to_s
end

#save_config_file_if_needed ⇒ Object

Save current configuration to config file return true if file was saved



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/aspera/cli/plugins/config.rb', line 1177

def save_config_file_if_needed
  raise 'no configuration loaded' if @config_presets.nil?
  current_checksum = config_checksum
  return false if @config_checksum_on_disk.eql?(current_checksum)
  FileUtils.mkdir_p(@main_folder)
  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}
  @config_checksum_on_disk = current_checksum
  return true
end

#send_email_template(email_template_default: nil, values: {}) ⇒ Object

send email using ERB template



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/aspera/cli/plugins/config.rb', line 1144

def send_email_template(email_template_default: nil, values: {})
  values[:to] ||= options.get_option(:notify_to, mandatory: true)
  notify_template = options.get_option(:notify_template, mandatory: email_template_default.nil?) || email_template_default
  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}"}
  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)
  # create a binding with only variables defined in values
  template_binding = Environment.empty_binding
  # add variables to binding
  values.each do |k, v|
    Aspera.assert_type(k, Symbol)
    template_binding.local_variable_set(k, v)
  end
  # execute template
  msg_with_headers = ERB.new(notify_template).result(template_binding)
  Log.log.debug{Log.dump(:msg_with_headers, msg_with_headers)}
  require 'net/smtp'
  smtp = Net::SMTP.new(mail_conf[:server], mail_conf[:port])
  smtp.enable_starttls if mail_conf[:tls]
  smtp.enable_tls if mail_conf[:ssl]
  smtp.start(*start_options) do |smtp_session|
    smtp_session.send_message(msg_with_headers, values[:from_email], values[:to])
  end
  nil
end

#set_global_default(key, value) ⇒ Object

set parameter and value in global config creates one if none already created

Returns:

  • preset name that contains global default



504
505
506
 
# File 'lib/aspera/cli/plugins/config.rb', line 504

def set_global_default(key, value)
  set_preset_key(global_default_preset, key, value)
end

#set_preset_key(preset, param_name, param_value) ⇒ Object 



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/aspera/cli/plugins/config.rb', line 480

def set_preset_key(preset, param_name, param_value)
  Aspera.assert_values(param_name.class, [String, Symbol]){'parameter'}
  param_name = param_name.to_s
  selected_preset = @config_presets[preset]
  if selected_preset.nil?
    Log.log.debug{"No such preset name: #{preset}, initializing"}
    selected_preset = @config_presets[preset] = {}
  end
  Aspera.assert_type(selected_preset, Hash){"#{preset}.#{param_name}"}
  if selected_preset.key?(param_name)
    if selected_preset[param_name].eql?(param_value)
      Log.log.warn{"keeping same value for #{preset}: #{param_name}: #{param_value}"}
      return
    end
    Log.log.warn{"overwriting value: #{selected_preset[param_name]}"}
  end
  selected_preset[param_name] = param_value
  formatter.display_status("Updated: #{preset}: #{param_name} <- #{param_value}")
  nil
end

#trusted_cert_locations ⇒ Object

returns only files



326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/aspera/cli/plugins/config.rb', line 326

def trusted_cert_locations
  locations = @certificate_paths
  if locations.nil?
    # compute default locations
    self.trusted_cert_locations = SpecialValues::DEF
    locations = @certificate_paths
    # restore defaults
    @certificate_paths = @certificate_store = nil
  end
  return locations
end

#trusted_cert_locations=(path_list) ⇒ Object

add files, folders or default locations to the certificate store

Parameters:

  • path_list (Array<String>) —

    list of paths to add

Returns:

  • the list of paths



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/aspera/cli/plugins/config.rb', line 286

def trusted_cert_locations=(path_list)
  path_list = [path_list] unless path_list.is_a?(Array)
  Aspera.assert_type(path_list, Array){'cert locations'}
  if @certificate_store.nil?
    Log.log.debug('Creating SSL Cert store')
    @certificate_store = OpenSSL::X509::Store.new
    @certificate_paths = []
  end

  path_list.each do |path|
    Aspera.assert_type(path, String){'Expecting a String for certificate location'}
    paths_to_add = [path]
    Log.log.debug{"Adding cert location: #{path}"}
    if path.eql?(SpecialValues::DEF)
      @certificate_store.set_default_paths
      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)}
    elsif File.file?(path)
      @certificate_store.add_file(path)
    elsif File.directory?(path)
      @certificate_store.add_path(path)
    else
      raise "No such file or folder: #{path}"
    end
    paths_to_add.each do |p|
      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)}
      end
      @certificate_paths.concat(pp)
    end
  end
  @certificate_paths.uniq!
end

#update_http_session(http_session) ⇒ Object

called every time a new REST HTTP session is opened to set user-provided options

Parameters:

  • http_session (Net::HTTP) —

    the newly created HTTP/S session object



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/aspera/cli/plugins/config.rb', line 376

def update_http_session(http_session)
  http_session.set_debug_output(LineLogger.new(:trace2)) if Log.instance.logger.trace2?
  # Rest.io_http_session(http_session).debug_output = Log.log
  http_session.verify_mode = SELF_SIGNED_CERT if http_session.use_ssl? && ignore_cert?(http_session.address, http_session.port)
  http_session.cert_store = @certificate_store if @certificate_store
  Log.log.debug{"using cert store #{http_session.cert_store} (#{@certificate_store})"} unless http_session.cert_store.nil?
  @option_http_options.each do |k, v|
    method = "#{k}=".to_sym
    # check if accessor is a method of Net::HTTP
    # continue_timeout= read_timeout= write_timeout=
    if http_session.respond_to?(method)
      http_session.send(method, v)
    else
      Log.log.error{"no such HTTP session attribute: #{k}"}
    end
  end
end

#vault ⇒ Object

Returns vault, from options or cache.

Returns:

  • (Object) —

    vault, from options or cache



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/aspera/cli/plugins/config.rb', line 1268

def vault
  if @vault.nil?
    info = vault_info
    case info[:type]
    when 'file'
      # 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
end

#vault_info ⇒ Object 



1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/aspera/cli/plugins/config.rb', line 1256

def vault_info
  info = options.get_option(:vault) || {}
  info = info.symbolize_keys
  info[:type] ||= 'file'
  info[:name] ||= (info[:type].eql?('file') ? DEFAULT_VAULT_FILENAME : PROGRAM_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

#vault_value(name) ⇒ String

Returns value from vault matching <name>.<param>.

Returns:

  • (String) —

    value from vault matching <name>.<param>



1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/aspera/cli/plugins/config.rb', line 1246

def vault_value(name)
  m = name.split('.')
  raise 'vault name shall match <name>.<param>' unless m.length.eql?(2)
  # this raise exception if label not found:
  info = vault.get(label: m[0])
  value = info[m[1].to_sym]
  raise "no such entry value: #{m[1]}" if value.nil?
  return value
end

#wizard_find(apps) ⇒ Object

Raises:



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/aspera/cli/plugins/config.rb', line 1027

def wizard_find(apps)
  identification = if apps.length.eql?(1)
    Log.log.debug{"Detected: #{identification}"}
    apps.first
  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)}
  end
  Log.log.debug{Log.dump(:identification, identification)}
  wiz_url = identification[:url]
  formatter.display_status("Using: #{identification[:name]} at #{wiz_url}".bold)
  # set url for instantiation of plugin
  options.add_option_preset({url: wiz_url}, 'wizard')
  # instantiate plugin: command line options will be known and wizard can be called
  wiz_plugin_class = PluginFactory.instance.plugin_class(identification[:product])
  Aspera.assert(wiz_plugin_class.respond_to?(:wizard), exception_class: Cli::BadArgument) do
    "Detected: #{identification[:product]}, but this application has no wizard"
  end
  # instantiate plugin: command line options will be known, e.g. private_key
  plugin_instance = wiz_plugin_class.new(**init_params)
  wiz_params = {
    object: plugin_instance
  }
  # is private key needed ?
  if options.known_options.key?(:private_key) &&
      (!wiz_plugin_class.respond_to?(:private_key_required?) || wiz_plugin_class.private_key_required?(wiz_url))
    # lets see if path to priv key is provided
    private_key_path = options.get_option(:key_path)
    # give a chance to provide
    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?
      private_key_path = File.join(@main_folder, DEFAULT_PRIV_KEY_FILENAME)
    end
    if File.exist?(private_key_path)
      formatter.display_status('Using existing key:')
    else
      formatter.display_status("Generating #{DEFAULT_PRIV_KEY_LENGTH} bit RSA key...")
      self.class.generate_rsa_private_key(path: private_key_path)
      formatter.display_status('Created key:')
    end
    formatter.display_status(private_key_path)
    private_key_pem = File.read(private_key_path)
    options.set_option(:private_key, private_key_pem)
    wiz_params[:private_key_path] = private_key_path
    wiz_params[:pub_key_pem] = OpenSSL::PKey::RSA.new(private_key_pem).public_key.to_s
  end
  Log.log.debug{Log.dump(:wiz_params, wiz_params)}
  # finally, call the wizard
  wizard_result = wiz_plugin_class.wizard(**wiz_params)
  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?
    elements = [
      identification[:product],
      URI.parse(wiz_url).host
    ]
    elements.push(options.get_option(:username, mandatory: true)) unless wizard_result[:preset_value].key?(:link)
    wiz_preset_name = elements.join('_').strip.downcase.gsub(/[^a-z0-9]/, '_').squeeze('_')
  end
  # test mode does not change conf file
  return {type: :single_object, data: wizard_result} if options.get_option(:test_mode)
  # Write configuration file
  formatter.display_status("Preparing preset: #{wiz_preset_name}")
  # init defaults if necessary
  @config_presets[CONF_PRESET_DEFAULTS] ||= {}
  option_override = options.get_option(:override, mandatory: true)
  raise Cli::Error, "A default configuration already exists for plugin '#{identification[:product]}' (use --override=yes or --default=no)" \
    if !option_override && options.get_option(:default, mandatory: true) && @config_presets[CONF_PRESET_DEFAULTS].key?(identification[:product])
  raise Cli::Error, "Preset already exists: #{wiz_preset_name}  (use --override=yes or --id=<name>)" \
    if !option_override && @config_presets.key?(wiz_preset_name)
  @config_presets[wiz_preset_name] = wizard_result[:preset_value].stringify_keys
  test_args = wizard_result[:test_args]
  if options.get_option(:default, mandatory: true)
    formatter.display_status("Setting config preset as default for #{identification[:product]}")
    @config_presets[CONF_PRESET_DEFAULTS][identification[:product].to_s] = wiz_preset_name
  else
    test_args = "-P#{wiz_preset_name} #{test_args}"
  end
  # TODO: actually test the command
  return Main.result_status("You can test with:\n#{@name} #{identification[:product]} #{test_args}")
end