aspera-cli 4.27.5 → 4.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (249) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +301 -4
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +139 -58
  7. data/GOVERNANCE.md +30 -0
  8. data/LICENSE +201 -0
  9. data/README.md +103 -26
  10. data/SECURITY.md +70 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +10 -7
  13. data/docs/README.md +2551 -772
  14. data/docs/test-mcp-with-ai.md +13 -11
  15. data/lib/aspera/agent/base.rb +23 -2
  16. data/lib/aspera/agent/connect.rb +16 -12
  17. data/lib/aspera/agent/desktop.rb +10 -7
  18. data/lib/aspera/agent/direct.rb +34 -22
  19. data/lib/aspera/agent/factory.rb +8 -4
  20. data/lib/aspera/agent/httpgw.rb +7 -5
  21. data/lib/aspera/agent/node.rb +15 -7
  22. data/lib/aspera/agent/transferd.rb +167 -43
  23. data/lib/aspera/api/alee.rb +4 -1
  24. data/lib/aspera/api/aoc.rb +14 -11
  25. data/lib/aspera/api/ats.rb +4 -2
  26. data/lib/aspera/api/cos_node.rb +8 -5
  27. data/lib/aspera/api/faspex.rb +16 -9
  28. data/lib/aspera/api/httpgw.rb +9 -6
  29. data/lib/aspera/api/node.rb +23 -19
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +84 -42
  32. data/lib/aspera/ascp/log.schema.yaml +1084 -0
  33. data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
  34. data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
  35. data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
  36. data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
  37. data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
  38. data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
  39. data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
  40. data/lib/aspera/ascp/log_analyzer.rb +354 -0
  41. data/lib/aspera/ascp/management.rb +102 -48
  42. data/lib/aspera/ascp/session_errors.rb +217 -0
  43. data/lib/aspera/assert.rb +4 -0
  44. data/lib/aspera/cli/ascp_actions.rb +16 -37
  45. data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
  46. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  47. data/lib/aspera/cli/bootstrapper.rb +37 -34
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +49 -4
  50. data/lib/aspera/cli/command_spec.rb +34 -4
  51. data/lib/aspera/cli/completion/ascli.bash +53 -5
  52. data/lib/aspera/cli/completion/ascli.fish +27 -8
  53. data/lib/aspera/cli/completion/ascli.ps1 +63 -0
  54. data/lib/aspera/cli/completion/ascli.zsh +36 -4
  55. data/lib/aspera/cli/completion_actions.rb +594 -0
  56. data/lib/aspera/cli/context.rb +9 -4
  57. data/lib/aspera/cli/deprecation.rb +5 -2
  58. data/lib/aspera/cli/error.rb +45 -0
  59. data/lib/aspera/cli/extended_value.rb +83 -24
  60. data/lib/aspera/cli/formatter.rb +142 -73
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -11
  63. data/lib/aspera/cli/http.rb +17 -13
  64. data/lib/aspera/cli/info.rb +17 -6
  65. data/lib/aspera/cli/mailer.rb +7 -4
  66. data/lib/aspera/cli/mcp/http_servlet.rb +155 -0
  67. data/lib/aspera/cli/mcp/secrets.rb +146 -0
  68. data/lib/aspera/cli/mcp/tool.rb +232 -0
  69. data/lib/aspera/cli/option_declarator.rb +10 -4
  70. data/lib/aspera/cli/option_registry.rb +6 -3
  71. data/lib/aspera/cli/option_types.rb +17 -2
  72. data/lib/aspera/cli/option_value.rb +72 -11
  73. data/lib/aspera/cli/options.schema.yaml +856 -81
  74. data/lib/aspera/cli/parser.rb +64 -31
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +250 -44
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +51 -25
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +207 -141
  81. data/lib/aspera/cli/plugins/console.rb +9 -4
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +22 -8
  84. data/lib/aspera/cli/plugins/faspex5.rb +37 -44
  85. data/lib/aspera/cli/plugins/faspio.rb +41 -8
  86. data/lib/aspera/cli/plugins/httpgw.rb +8 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +186 -121
  88. data/lib/aspera/cli/plugins/node.rb +41 -34
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +572 -59
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +66 -12
  93. data/lib/aspera/cli/plugins/shares.rb +288 -48
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +155 -33
  96. data/lib/aspera/cli/preset_manager.rb +72 -16
  97. data/lib/aspera/cli/prompt.rb +7 -2
  98. data/lib/aspera/cli/result.rb +28 -11
  99. data/lib/aspera/cli/runner.rb +193 -80
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +204 -0
  102. data/lib/aspera/cli/special_values.rb +4 -1
  103. data/lib/aspera/cli/sync_actions.rb +13 -10
  104. data/lib/aspera/cli/table_fitter.rb +119 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +32 -40
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +31 -19
  108. data/lib/aspera/cli/transfer_progress.rb +13 -45
  109. data/lib/aspera/cli/vault_actions.rb +45 -0
  110. data/lib/aspera/cli/vault_manager.rb +197 -50
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.html.erb +61 -0
  113. data/lib/aspera/cli/web_secret.rb +222 -0
  114. data/lib/aspera/cli/wizard.rb +58 -45
  115. data/lib/aspera/command_line_builder.rb +35 -5
  116. data/lib/aspera/command_line_converter.rb +4 -1
  117. data/lib/aspera/coverage.rb +103 -33
  118. data/lib/aspera/data_repository.rb +42 -25
  119. data/lib/aspera/dot_container.rb +4 -1
  120. data/lib/aspera/duration.rb +45 -0
  121. data/lib/aspera/environment.rb +106 -33
  122. data/lib/aspera/exec_spec.rb +9 -5
  123. data/lib/aspera/faspex_gw.rb +105 -35
  124. data/lib/aspera/faspex_postproc.rb +193 -47
  125. data/lib/aspera/formatter_interface.rb +4 -2
  126. data/lib/aspera/graphql.rb +5 -1
  127. data/lib/aspera/hash_ext.rb +3 -0
  128. data/lib/aspera/id_generator.rb +6 -3
  129. data/lib/aspera/json_rpc/client.rb +55 -35
  130. data/lib/aspera/json_rpc/version.rb +4 -0
  131. data/lib/aspera/line_logger.rb +4 -1
  132. data/lib/aspera/link_header.rb +4 -1
  133. data/lib/aspera/log.rb +20 -10
  134. data/lib/aspera/markdown.rb +155 -115
  135. data/lib/aspera/mime.rb +9 -0
  136. data/lib/aspera/nagios.rb +9 -5
  137. data/lib/aspera/node_emulator.rb +111 -112
  138. data/lib/aspera/oauth/client/base.rb +163 -0
  139. data/lib/aspera/oauth/{boot.rb → client/boot.rb} +8 -4
  140. data/lib/aspera/oauth/{factory.rb → client/factory.rb} +13 -3
  141. data/lib/aspera/oauth/{generic.rb → client/generic.rb} +5 -1
  142. data/lib/aspera/oauth/{json_credentials.rb → client/json_credentials.rb} +4 -1
  143. data/lib/aspera/oauth/{jwt.rb → client/jwt.rb} +6 -3
  144. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  145. data/lib/aspera/oauth/{url_json.rb → client/url_json.rb} +4 -1
  146. data/lib/aspera/oauth/client/web.rb +84 -0
  147. data/lib/aspera/oauth/server/authorize.html.erb +34 -0
  148. data/lib/aspera/oauth/server/pkce.rb +427 -0
  149. data/lib/aspera/orchestrator_workflow_checker.rb +679 -0
  150. data/lib/aspera/persistency_action_once.rb +5 -3
  151. data/lib/aspera/persistency_folder.rb +6 -3
  152. data/lib/aspera/preview/file_types.rb +6 -3
  153. data/lib/aspera/preview/generator.rb +9 -5
  154. data/lib/aspera/preview/options.schema.yaml +3 -3
  155. data/lib/aspera/preview/terminal.rb +11 -6
  156. data/lib/aspera/preview/utils.rb +6 -4
  157. data/lib/aspera/products/connect.rb +5 -2
  158. data/lib/aspera/products/desktop.rb +4 -1
  159. data/lib/aspera/products/other.rb +4 -2
  160. data/lib/aspera/products/transferd.rb +6 -2
  161. data/lib/aspera/products/transferd_service.rb +610 -0
  162. data/lib/aspera/proxy_auto_config.js +2 -2
  163. data/lib/aspera/proxy_auto_config.rb +5 -2
  164. data/lib/aspera/rainbow.rb +30 -1
  165. data/lib/aspera/rest/aspera_errors.rb +55 -60
  166. data/lib/aspera/rest/call_error.rb +3 -0
  167. data/lib/aspera/rest/client.rb +42 -42
  168. data/lib/aspera/rest/error_analyzer.rb +14 -2
  169. data/lib/aspera/rest/list.rb +14 -10
  170. data/lib/aspera/rest/parameters.rb +3 -0
  171. data/lib/aspera/rest/util.rb +13 -4
  172. data/lib/aspera/rest.rb +9 -7
  173. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -11
  174. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +4089 -0
  175. data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0-enhanced.yaml +1097 -0
  176. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  177. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  178. data/lib/aspera/schema/IBM_Aspera_Shares.yaml +819 -7
  179. data/lib/aspera/schema/async_tables.yaml +11 -10
  180. data/lib/aspera/schema/documentation.rb +56 -78
  181. data/lib/aspera/schema/reader.rb +46 -11
  182. data/lib/aspera/schema/registry.rb +45 -24
  183. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  184. data/lib/aspera/schema/validator.rb +4 -1
  185. data/lib/aspera/sealed_hash.rb +166 -0
  186. data/lib/aspera/secret/hider.rb +201 -0
  187. data/lib/aspera/secret/reference.rb +150 -0
  188. data/lib/aspera/secret/resolver.rb +212 -0
  189. data/lib/aspera/secret/store/base.rb +153 -0
  190. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  191. data/lib/aspera/secret/store/factory.rb +103 -0
  192. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  193. data/lib/aspera/secret/store/keeper.rb +141 -0
  194. data/lib/aspera/secret/store/macos_security.rb +284 -0
  195. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  196. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  197. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  198. data/lib/aspera/secret/store/secret_service.rb +125 -0
  199. data/lib/aspera/secret/strength.rb +119 -0
  200. data/lib/aspera/servlet_helpers.rb +114 -0
  201. data/lib/aspera/ssh.rb +10 -7
  202. data/lib/aspera/ssl.rb +5 -2
  203. data/lib/aspera/string_ext.rb +3 -0
  204. data/lib/aspera/sync/args.schema.yaml +6 -1
  205. data/lib/aspera/sync/conf.schema.yaml +25 -10
  206. data/lib/aspera/sync/database.rb +3 -0
  207. data/lib/aspera/sync/operations.rb +34 -12
  208. data/lib/aspera/temp_file_manager.rb +85 -22
  209. data/lib/aspera/timer_limiter.rb +3 -0
  210. data/lib/aspera/transfer/error.rb +4 -1
  211. data/lib/aspera/transfer/faux_file.rb +4 -1
  212. data/lib/aspera/transfer/parameters.rb +22 -14
  213. data/lib/aspera/transfer/result.rb +3 -0
  214. data/lib/aspera/transfer/resumer.rb +6 -4
  215. data/lib/aspera/transfer/spec.rb +45 -18
  216. data/lib/aspera/transfer/spec.schema.yaml +8 -5
  217. data/lib/aspera/transfer/units.rb +75 -0
  218. data/lib/aspera/uri_reader.rb +57 -7
  219. data/lib/aspera/web_auth/index.html.erb +20 -0
  220. data/lib/aspera/web_auth/paste.rb +109 -0
  221. data/lib/aspera/web_auth/receiver.rb +50 -0
  222. data/lib/aspera/web_auth/relay.rb +76 -0
  223. data/lib/aspera/web_auth/reply.html.erb +150 -0
  224. data/lib/aspera/web_auth/server.rb +59 -14
  225. data/lib/aspera/web_page.html.erb +262 -0
  226. data/lib/aspera/web_page.rb +66 -0
  227. data/lib/aspera/web_server_simple.rb +82 -13
  228. data/lib/aspera/yaml.rb +5 -1
  229. data/llms.txt +81 -0
  230. data/skills/ascli/SKILL.md +88 -0
  231. data.tar.gz.sig +0 -0
  232. metadata +116 -48
  233. metadata.gz.sig +0 -0
  234. data/lib/aspera/cli/mcp_tool.rb +0 -189
  235. data/lib/aspera/keychain/base.rb +0 -25
  236. data/lib/aspera/keychain/encrypted_hash.rb +0 -188
  237. data/lib/aspera/keychain/factory.rb +0 -59
  238. data/lib/aspera/keychain/hashicorp_vault.rb +0 -74
  239. data/lib/aspera/keychain/macos_security.rb +0 -171
  240. data/lib/aspera/keychain/one_password_api.rb +0 -86
  241. data/lib/aspera/keychain/one_password_base.rb +0 -34
  242. data/lib/aspera/keychain/one_password_cli.rb +0 -98
  243. data/lib/aspera/oauth/base.rb +0 -141
  244. data/lib/aspera/oauth/web.rb +0 -57
  245. data/lib/aspera/oauth.rb +0 -9
  246. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +0 -1784
  247. data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml +0 -249
  248. data/lib/aspera/secret_hider.rb +0 -117
  249. data/lib/aspera/web_auth/index.html +0 -147
@@ -1,9 +1,13 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/plugins/base'
4
- require 'aspera/cli/plugins/node'
5
- require 'aspera/api/cos_node'
6
- require 'aspera/assert'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'base'
7
+ require_relative 'node'
8
+ require_relative '../error'
9
+ require_relative '../../api/cos_node'
10
+ require_relative '../../assert'
7
11
 
8
12
  module Aspera
9
13
  module Cli
@@ -1,10 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../../assert'
7
+ require_relative '../error'
8
+ require_relative '../security'
9
+ require_relative '../../environment'
10
+ require_relative '../../string_ext'
3
11
  require 'singleton'
4
- require 'aspera/assert'
5
- require 'aspera/cli/error'
6
- require 'aspera/environment'
7
- require 'aspera/string_ext'
8
12
 
9
13
  module Aspera
10
14
  module Cli
@@ -20,6 +24,8 @@ module Aspera
20
24
 
21
25
  def initialize
22
26
  @lookup_folders = []
27
+ # Security level (see `Security`) of each folder: a plugin is code
28
+ @folder_security = {}
23
29
  # information on plugins
24
30
  @plugins = {}
25
31
  end
@@ -31,8 +37,12 @@ module Aspera
31
37
 
32
38
  # add a folder to the list of folders to look for plugins
33
39
  # (absolute, as `require` resolves a relative path against $LOAD_PATH)
34
- def add_lookup_folder(folder)
40
+ # @param folder [String] Folder
41
+ # @param security [Symbol, nil] Most restrictive security level at which plugins of this folder are used, `nil` for all levels (folder of the gem).
42
+ # A folder that a user or a client can write is `:low`: a file written there would be loaded as code.
43
+ def add_lookup_folder(folder, security: nil)
35
44
  folder = File.expand_path(folder)
45
+ @folder_security[folder] = security
36
46
  @lookup_folders.unshift(folder) unless @lookup_folders.include?(folder)
37
47
  end
38
48
 
@@ -40,16 +50,18 @@ module Aspera
40
50
  def add_plugins_from_lookup_folders
41
51
  @lookup_folders.each do |folder|
42
52
  next unless File.directory?(folder)
53
+ # Plugins registered at start (level low) stay, but files that appear later are not
54
+ next unless Security.instance.allowed?(@folder_security[folder])
43
55
  # TODO: add gem root to load path ? and require short folder ?
44
56
  # $LOAD_PATH.push(folder) if i[:add_path]
45
- Dir.entries(folder).each do |source|
57
+ Dir.children(folder).each do |source|
46
58
  next unless source.end_with?(Environment::RB_EXT)
47
59
  path = File.join(folder, source)
48
60
  plugin_symbol = File.basename(path, Environment::RB_EXT).to_sym
49
61
  next if IGNORE_PLUGINS.include?(plugin_symbol)
50
62
  req = path.sub(/#{Environment::RB_EXT}$/o, '')
51
63
  next if @plugins.key?(plugin_symbol)
52
- @plugins[plugin_symbol] = {source: path, require_stanza: req}
64
+ @plugins[plugin_symbol] = {source: path, require_stanza: req, security: @folder_security[folder]}
53
65
  end
54
66
  end
55
67
  end
@@ -63,6 +75,8 @@ module Aspera
63
75
  # @return [Class] class object for plugin
64
76
  def plugin_class(plugin_name_sym)
65
77
  Aspera.assert(@plugins.key?(plugin_name_sym), type: NoSuchElement) { "plugin not found: #{plugin_name_sym}" }
78
+ # A plugin registered at start can be replaced by a file written since: it is code
79
+ Security.instance.check_level(@plugins[plugin_name_sym][:security], "plugin #{plugin_name_sym}")
66
80
  require @plugins[plugin_name_sym][:require_stanza]
67
81
  # Module.nesting[1] is Aspera::Cli::Plugins
68
82
  return Object.const_get("#{Module.nesting[1]}::#{plugin_name_sym.to_s.snake_to_capital}")
@@ -76,7 +90,7 @@ module Aspera
76
90
  plugin_class(plugin_name_sym).new(**args)
77
91
  end
78
92
 
79
- IGNORE_PLUGINS = %i[factory base basic_auth oauth]
93
+ IGNORE_PLUGINS = %i[factory base basic_auth oauth].freeze
80
94
  private_constant :IGNORE_PLUGINS
81
95
  end
82
96
  end
@@ -1,24 +1,27 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
3
6
  # spellchecker: ignore workgroups mypackages passcode
4
7
 
5
- require 'aspera/schema/registry'
6
- require 'aspera/cli/plugins/oauth'
7
- require 'aspera/cli/extended_value'
8
- require 'aspera/cli/formatter'
9
- require 'aspera/transfer/result'
10
- require 'aspera/cli/special_values'
11
- require 'aspera/cli/wizard'
12
- require 'aspera/api/faspex'
13
- require 'aspera/persistency_action_once'
14
- require 'aspera/id_generator'
15
- require 'aspera/nagios'
16
- require 'aspera/environment'
17
- require 'aspera/assert'
8
+ require_relative '../../schema/registry'
9
+ require_relative 'oauth'
10
+ require_relative '../extended_value'
11
+ require_relative '../formatter'
12
+ require_relative '../../transfer/result'
13
+ require_relative '../special_values'
14
+ require_relative '../wizard'
15
+ require_relative '../../api/faspex'
16
+ require_relative '../../persistency_action_once'
17
+ require_relative '../../id_generator'
18
+ require_relative '../../nagios'
19
+ require_relative '../../environment'
20
+ require_relative '../../assert'
21
+ require_relative '../../rainbow'
18
22
  require 'securerandom'
19
23
  require 'digest'
20
24
  require 'json'
21
- require 'aspera/rainbow'
22
25
  using Rainbow
23
26
 
24
27
  module Aspera
@@ -69,7 +72,7 @@ module Aspera
69
72
  formatter.display_status('Ask the ascli client id and secret to your Administrator.'.red)
70
73
  formatter.display_status("Log in as an admin user at: #{app_url}")
71
74
  Environment.instance.open_uri(app_url)
72
- formatter.display_status('Navigate to: 𓃑 → Admin → Configurations → API clients')
75
+ wizard.display_navigation(Environment.char('𓃑'), 'Admin', 'Configurations', 'API clients')
73
76
  formatter.display_status('Create an API client with:')
74
77
  formatter.display_status('- name: ascli')
75
78
  formatter.display_status('- JWT: enabled')
@@ -79,17 +82,18 @@ module Aspera
79
82
  end
80
83
  wiz_username = options.get_option(:username, mandatory: true)
81
84
  wizard.check_email(wiz_username)
82
- private_key_path = wizard.ask_private_key(
85
+ private_key = wizard.ask_private_key(
83
86
  user: wiz_username,
84
87
  url: app_url,
85
- page: '👤 → Account Settings → Preferences → Public Key in PEM'
88
+ page: [Environment.char('👤'), 'Account Settings', 'Preferences', 'Public Key in PEM']
86
89
  )
87
90
  return {
91
+ preset_ids: [wiz_username, client_id].compact,
88
92
  preset_value: {
89
93
  url: app_url,
90
94
  username: wiz_username,
91
95
  auth: :jwt.to_s,
92
- private_key: "@file:#{private_key_path}",
96
+ private_key: private_key,
93
97
  client_id: client_id,
94
98
  client_secret: client_secret
95
99
  },
@@ -108,9 +112,8 @@ module Aspera
108
112
  Aspera.assert_type(parameters[type], Array) { type }
109
113
  recipient_types = Api::Faspex::RECIPIENT_TYPES
110
114
  if parameters.key?('recipient_types')
111
- recipient_types = parameters['recipient_types']
112
- parameters.delete('recipient_types')
113
- recipient_types = [recipient_types] unless recipient_types.is_a?(Array)
115
+ recipient_types = Array(parameters.delete('recipient_types'))
116
+ Aspera.assert_array_all(recipient_types, String) { 'recipient_types' }
114
117
  end
115
118
  parameters[type].map! do |recipient_data|
116
119
  # If just a string, make a general lookup and build expected name/type hash
@@ -250,7 +253,7 @@ module Aspera
250
253
  Log.dump(:package_ids, level: :trace1) { packages.map { |p| p['id'] } }
251
254
  else
252
255
  # a single id was provided, or a list of ids
253
- package_ids = [package_ids] unless package_ids.is_a?(Array)
256
+ package_ids = Array(package_ids)
254
257
  Aspera.assert_array_all(package_ids, String) { 'Package id(s)' }
255
258
  # packages = package_ids.map{|pkg_id|api_v5.read("packages/#{pkg_id}")}
256
259
  packages = package_ids.map { |pkg_id| {'id'=>pkg_id} }
@@ -321,8 +324,7 @@ module Aspera
321
324
  )
322
325
  # well, we asked a TS for connect, but we actually want a generic one
323
326
  transfer_spec.delete('authentication')
324
- Runner.result_transfer(transfer.start(transfer_spec))
325
- return Result::SingleObject.new(package)
327
+ return Runner.result_object_transfer(package, transfer.start(transfer_spec))
326
328
  else
327
329
  # send from remote shared folder
328
330
  if (m = Parser.percent_selector(shared_folder))
@@ -529,9 +531,9 @@ module Aspera
529
531
  command :user, description: 'Manage current user'
530
532
  command :shared_folders, description: 'Browse shared folders'
531
533
  command :gateway, description: 'Start Faspex 4 gateway emulation',
532
- arguments: [{name: :parameters, type: Hash, mandatory: false, default: {}}]
533
- command :postprocessing, description: 'Start Faspex 4 post-processing server',
534
- arguments: [{name: :parameters, type: Hash, mandatory: false, default: {}}]
534
+ arguments: [{name: :parameters, type: Hash, mandatory: false, default: {}, schema: Schema::Registry::GATEWAY_OPTIONS}]
535
+ command :postprocessing, description: 'Start Faspex 4 post-processing server', security: :low,
536
+ arguments: [{name: :parameters, type: Hash, mandatory: false, default: {}, schema: Schema::Registry::POSTPROC_OPTIONS}]
535
537
  command :invitations, description: 'Manage invitations'
536
538
 
537
539
  commands_under :invitations do
@@ -833,7 +835,8 @@ module Aspera
833
835
  # @param users [Array] raw user ids or percent-selector strings
834
836
  # @return [Array<String>] resolved user ids
835
837
  def resolve_member_user_ids(users)
836
- users = [users] unless users.is_a?(Array)
838
+ users = Array(users)
839
+ Aspera.assert_array_all(users, String) { 'users' }
837
840
  users.map do |user|
838
841
  if (m = Parser.percent_selector(user))
839
842
  api_v5.lookup_entity_by_field(entity: 'accounts', field: m[:field], value: m[:value], query: Rest.php_style({type: ACCOUNT_TYPES}))['id']
@@ -977,30 +980,20 @@ module Aspera
977
980
  end
978
981
 
979
982
  def action_gateway(parameters: {}, **)
980
- require 'aspera/faspex_gw'
981
- parameters = parameters.symbolize_keys
982
- uri = URI.parse(parameters.delete(:url) { WebServerSimple::DEFAULT_URL })
983
- server = WebServerSimple.new(uri, **parameters.slice(*WebServerSimple::PARAMS))
984
- Aspera.assert(parameters.except(*WebServerSimple::PARAMS).empty?) { "unexpected parameters: #{parameters.except(*WebServerSimple::PARAMS).keys}" }
985
- server.mount(uri.path, Faspex4GWServlet, api_v5, nil)
986
- server.start
983
+ require_relative '../../faspex_gw'
984
+ Faspex4GWServlet.serve(parameters.symbolize_keys, type: Cli::BadArgument) { [api_v5, nil] }
987
985
  Result::Status.new('Gateway terminated')
988
986
  end
989
987
 
990
988
  def action_postprocessing(parameters: {}, **)
991
- require 'aspera/faspex_postproc' # cspell:disable-line
992
- parameters = parameters.symbolize_keys
993
- uri = URI.parse(parameters.delete(:url) { WebServerSimple::DEFAULT_URL })
994
- parameters[:root] = uri.path
995
- server = WebServerSimple.new(uri, **parameters.slice(*WebServerSimple::PARAMS))
996
- server.mount(uri.path, Faspex4PostProcServlet, parameters.except(*WebServerSimple::PARAMS))
997
- server.start
998
- Result::Status.new('Gateway terminated')
989
+ require_relative '../../faspex_postproc'
990
+ Faspex4PostProcServlet.serve(parameters.symbolize_keys, type: Cli::BadArgument)
991
+ Result::Status.new('Post-processing terminated')
999
992
  end
1000
993
  ACCOUNT_TYPES = %w{local_user saml_user self_registered_user external_user}.freeze
1001
994
  WORKGROUP_TYPES = %w{workgroup shared_inbox}.freeze
1002
995
  CONTACT_TYPES = (WORKGROUP_TYPES + %w{distribution_list user external_user}).freeze
1003
- PACKAGE_RECIPIENT_TYPES = %i{recipients private_recipients notified_on_upload notified_on_download notified_on_receipt}
996
+ PACKAGE_RECIPIENT_TYPES = %i{recipients private_recipients notified_on_upload notified_on_download notified_on_receipt}.freeze
1004
997
  private_constant :ACCOUNT_TYPES, :CONTACT_TYPES, :PACKAGE_RECIPIENT_TYPES,
1005
998
  :CRUD_NO_SHOW, :CRUD_NO_LIST
1006
999
  end
@@ -1,8 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/rest'
4
- require 'aspera/nagios'
5
- require 'aspera/cli/plugins/basic_auth'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../../rest'
7
+ require_relative '../../nagios'
8
+ require_relative 'basic_auth'
6
9
 
7
10
  module Aspera
8
11
  module Cli
@@ -29,23 +32,47 @@ module Aspera
29
32
  # @param app_url [String] Tested URL
30
33
  # @return [Hash] :preset_value, :test_args
31
34
  def wizard(wizard, app_url)
35
+ auth_type = options.get_option(:auth, mandatory: wizard.required) || :basic
36
+ preset_value = {
37
+ url: app_url,
38
+ auth: auth_type.to_s
39
+ }
40
+ preset_ids = []
41
+ case auth_type
42
+ when :none
43
+ # No credentials needed
44
+ when :basic
45
+ username = options.get_option(:username, mandatory: true)
46
+ preset_value[:username] = username
47
+ preset_value[:password] = options.get_option(:password, mandatory: true)
48
+ preset_ids.push(username)
49
+ when :jwt
50
+ client_id = options.get_option(:client_id, mandatory: true)
51
+ preset_value[:client_id] = client_id
52
+ preset_value[:private_key] = options.get_option(:private_key, mandatory: true)
53
+ passphrase = options.get_option(:passphrase)
54
+ preset_value[:passphrase] = passphrase unless passphrase.nil?
55
+ preset_ids.push(client_id)
56
+ end
32
57
  return {
33
- preset_value: {
34
- url: app_url
35
- },
58
+ preset_ids: preset_ids,
59
+ preset_value: preset_value,
36
60
  test_args: 'bridges list'
37
61
  }
38
62
  end
39
63
 
40
- command :health, description: 'Check faspio Gateway health'
64
+ command :health, description: 'Check faspio Gateway health'
65
+ command :metrics, description: 'Get Prometheus metrics'
41
66
 
42
67
  commands_under :bridges do
43
68
  crud_commands entity: 'bridges',
44
69
  api: :build_api,
70
+ operations: %i[create list show delete],
71
+ lookup: %w[name],
45
72
  body_component: Schema::Registry::FASPIO
46
73
  end
47
74
 
48
- option :auth, description: 'OAuth type of authentication', allowed: %i[jwt basic]
75
+ option :auth, description: 'Type of authentication', allowed: %i[basic jwt none]
49
76
  option :client_id, description: 'OAuth client identifier'
50
77
  option :private_key, description: 'OAuth JWT RSA private key PEM **value**'
51
78
  option :passphrase, description: 'OAuth JWT RSA private key passphrase'
@@ -55,6 +82,8 @@ module Aspera
55
82
  def build_api
56
83
  base_url = options.get_option(:url, mandatory: true)
57
84
  case options.get_option(:auth, mandatory: true)
85
+ when :none
86
+ Rest::Client.new(base_url: base_url)
58
87
  when :basic
59
88
  basic_auth_api
60
89
  when :jwt
@@ -94,6 +123,10 @@ module Aspera
94
123
  end
95
124
  Result::ObjectList.new(nagios.status_list)
96
125
  end
126
+
127
+ def action_metrics(**)
128
+ Result::Text.new(build_api.read('metrics', headers: {'Accept' => 'text/plain'}))
129
+ end
97
130
  end
98
131
  end
99
132
  end
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/plugins/base'
4
- require 'aspera/rest'
5
- require 'aspera/api/httpgw'
6
- require 'aspera/nagios'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'base'
7
+ require_relative '../../rest'
8
+ require_relative '../../api/httpgw'
9
+ require_relative '../../nagios'
7
10
 
8
11
  module Aspera
9
12
  module Cli
@@ -29,6 +32,7 @@ module Aspera
29
32
  # @return [Hash] :preset_value, :test_args
30
33
  def wizard(wizard, app_url)
31
34
  return {
35
+ preset_ids: [],
32
36
  preset_value: {
33
37
  url: app_url
34
38
  },