aspera-cli 4.28.0 → 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 (237) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +143 -2
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +135 -56
  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 +9 -6
  13. data/docs/README.md +1633 -609
  14. data/docs/test-mcp-with-ai.md +8 -8
  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 +20 -19
  19. data/lib/aspera/agent/factory.rb +6 -3
  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 +7 -4
  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 +20 -20
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +71 -65
  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 +16 -8
  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 +12 -19
  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 -33
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +6 -1
  50. data/lib/aspera/cli/command_spec.rb +34 -7
  51. data/lib/aspera/cli/completion/ascli.bash +19 -5
  52. data/lib/aspera/cli/completion/ascli.fish +13 -2
  53. data/lib/aspera/cli/completion/ascli.ps1 +31 -9
  54. data/lib/aspera/cli/completion/ascli.zsh +22 -6
  55. data/lib/aspera/cli/completion_actions.rb +303 -69
  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 +3 -0
  59. data/lib/aspera/cli/extended_value.rb +61 -27
  60. data/lib/aspera/cli/formatter.rb +29 -22
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -10
  63. data/lib/aspera/cli/http.rb +12 -9
  64. data/lib/aspera/cli/info.rb +12 -7
  65. data/lib/aspera/cli/mailer.rb +6 -3
  66. data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
  67. data/lib/aspera/cli/mcp/secrets.rb +8 -5
  68. data/lib/aspera/cli/mcp/tool.rb +15 -14
  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 +65 -12
  73. data/lib/aspera/cli/options.schema.yaml +487 -63
  74. data/lib/aspera/cli/parser.rb +56 -32
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +244 -35
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +17 -12
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +198 -103
  81. data/lib/aspera/cli/plugins/console.rb +6 -3
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +21 -7
  84. data/lib/aspera/cli/plugins/faspex5.rb +28 -25
  85. data/lib/aspera/cli/plugins/faspio.rb +7 -5
  86. data/lib/aspera/cli/plugins/httpgw.rb +7 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +28 -22
  88. data/lib/aspera/cli/plugins/node.rb +31 -30
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +63 -11
  93. data/lib/aspera/cli/plugins/shares.rb +86 -16
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +144 -30
  96. data/lib/aspera/cli/preset_manager.rb +52 -18
  97. data/lib/aspera/cli/prompt.rb +4 -1
  98. data/lib/aspera/cli/result.rb +12 -8
  99. data/lib/aspera/cli/runner.rb +69 -46
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +79 -9
  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 +3 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +9 -6
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +29 -20
  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 +188 -42
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.rb +12 -10
  113. data/lib/aspera/cli/wizard.rb +42 -39
  114. data/lib/aspera/command_line_builder.rb +9 -5
  115. data/lib/aspera/command_line_converter.rb +4 -1
  116. data/lib/aspera/coverage.rb +103 -33
  117. data/lib/aspera/data_repository.rb +4 -1
  118. data/lib/aspera/dot_container.rb +4 -1
  119. data/lib/aspera/duration.rb +5 -2
  120. data/lib/aspera/environment.rb +21 -12
  121. data/lib/aspera/exec_spec.rb +3 -0
  122. data/lib/aspera/faspex_gw.rb +13 -9
  123. data/lib/aspera/faspex_postproc.rb +15 -12
  124. data/lib/aspera/formatter_interface.rb +4 -1
  125. data/lib/aspera/graphql.rb +5 -1
  126. data/lib/aspera/hash_ext.rb +3 -0
  127. data/lib/aspera/id_generator.rb +4 -2
  128. data/lib/aspera/json_rpc/client.rb +6 -5
  129. data/lib/aspera/json_rpc/version.rb +3 -0
  130. data/lib/aspera/line_logger.rb +4 -1
  131. data/lib/aspera/link_header.rb +4 -1
  132. data/lib/aspera/log.rb +18 -5
  133. data/lib/aspera/markdown.rb +5 -2
  134. data/lib/aspera/mime.rb +3 -0
  135. data/lib/aspera/nagios.rb +6 -4
  136. data/lib/aspera/node_emulator.rb +15 -13
  137. data/lib/aspera/oauth/client/base.rb +91 -70
  138. data/lib/aspera/oauth/client/boot.rb +7 -4
  139. data/lib/aspera/oauth/client/factory.rb +6 -3
  140. data/lib/aspera/oauth/client/generic.rb +5 -1
  141. data/lib/aspera/oauth/client/json_credentials.rb +4 -1
  142. data/lib/aspera/oauth/client/jwt.rb +6 -3
  143. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  144. data/lib/aspera/oauth/client/url_json.rb +4 -1
  145. data/lib/aspera/oauth/client/web.rb +39 -12
  146. data/lib/aspera/oauth/server/pkce.rb +6 -5
  147. data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
  148. data/lib/aspera/persistency_action_once.rb +5 -3
  149. data/lib/aspera/persistency_folder.rb +6 -3
  150. data/lib/aspera/preview/file_types.rb +6 -3
  151. data/lib/aspera/preview/generator.rb +9 -5
  152. data/lib/aspera/preview/options.schema.yaml +3 -3
  153. data/lib/aspera/preview/terminal.rb +8 -4
  154. data/lib/aspera/preview/utils.rb +6 -4
  155. data/lib/aspera/products/connect.rb +5 -2
  156. data/lib/aspera/products/desktop.rb +4 -1
  157. data/lib/aspera/products/other.rb +4 -2
  158. data/lib/aspera/products/transferd.rb +6 -2
  159. data/lib/aspera/products/transferd_service.rb +610 -0
  160. data/lib/aspera/proxy_auto_config.js +2 -2
  161. data/lib/aspera/proxy_auto_config.rb +5 -2
  162. data/lib/aspera/rainbow.rb +3 -0
  163. data/lib/aspera/rest/aspera_errors.rb +4 -1
  164. data/lib/aspera/rest/call_error.rb +3 -0
  165. data/lib/aspera/rest/client.rb +22 -29
  166. data/lib/aspera/rest/error_analyzer.rb +5 -2
  167. data/lib/aspera/rest/list.rb +8 -4
  168. data/lib/aspera/rest/parameters.rb +3 -0
  169. data/lib/aspera/rest/util.rb +8 -5
  170. data/lib/aspera/rest.rb +9 -6
  171. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
  172. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
  173. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  174. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  175. data/lib/aspera/schema/async_tables.yaml +11 -10
  176. data/lib/aspera/schema/documentation.rb +8 -2
  177. data/lib/aspera/schema/reader.rb +7 -0
  178. data/lib/aspera/schema/registry.rb +43 -28
  179. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  180. data/lib/aspera/schema/validator.rb +4 -1
  181. data/lib/aspera/sealed_hash.rb +166 -0
  182. data/lib/aspera/secret/hider.rb +201 -0
  183. data/lib/aspera/secret/reference.rb +150 -0
  184. data/lib/aspera/secret/resolver.rb +212 -0
  185. data/lib/aspera/secret/store/base.rb +153 -0
  186. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  187. data/lib/aspera/secret/store/factory.rb +103 -0
  188. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  189. data/lib/aspera/secret/store/keeper.rb +141 -0
  190. data/lib/aspera/secret/store/macos_security.rb +284 -0
  191. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  192. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  193. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  194. data/lib/aspera/secret/store/secret_service.rb +125 -0
  195. data/lib/aspera/secret/strength.rb +119 -0
  196. data/lib/aspera/servlet_helpers.rb +5 -2
  197. data/lib/aspera/ssh.rb +10 -7
  198. data/lib/aspera/ssl.rb +5 -2
  199. data/lib/aspera/string_ext.rb +3 -0
  200. data/lib/aspera/sync/args.schema.yaml +3 -0
  201. data/lib/aspera/sync/conf.schema.yaml +9 -4
  202. data/lib/aspera/sync/database.rb +3 -0
  203. data/lib/aspera/sync/operations.rb +16 -14
  204. data/lib/aspera/temp_file_manager.rb +8 -4
  205. data/lib/aspera/timer_limiter.rb +3 -0
  206. data/lib/aspera/transfer/error.rb +4 -1
  207. data/lib/aspera/transfer/faux_file.rb +4 -1
  208. data/lib/aspera/transfer/parameters.rb +17 -14
  209. data/lib/aspera/transfer/result.rb +3 -0
  210. data/lib/aspera/transfer/resumer.rb +6 -4
  211. data/lib/aspera/transfer/spec.rb +9 -22
  212. data/lib/aspera/transfer/units.rb +75 -0
  213. data/lib/aspera/uri_reader.rb +57 -7
  214. data/lib/aspera/web_auth/index.html.erb +6 -2
  215. data/lib/aspera/web_auth/paste.rb +109 -0
  216. data/lib/aspera/web_auth/receiver.rb +50 -0
  217. data/lib/aspera/web_auth/relay.rb +76 -0
  218. data/lib/aspera/web_auth/reply.html.erb +150 -0
  219. data/lib/aspera/web_auth/server.rb +47 -10
  220. data/lib/aspera/web_page.rb +7 -2
  221. data/lib/aspera/web_server_simple.rb +6 -3
  222. data/lib/aspera/yaml.rb +5 -1
  223. data/llms.txt +81 -0
  224. data/skills/ascli/SKILL.md +88 -0
  225. data.tar.gz.sig +0 -0
  226. metadata +72 -19
  227. metadata.gz.sig +0 -0
  228. data/lib/aspera/keychain/base.rb +0 -30
  229. data/lib/aspera/keychain/encrypted_hash.rb +0 -192
  230. data/lib/aspera/keychain/factory.rb +0 -58
  231. data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
  232. data/lib/aspera/keychain/macos_security.rb +0 -277
  233. data/lib/aspera/keychain/one_password_api.rb +0 -91
  234. data/lib/aspera/keychain/one_password_base.rb +0 -39
  235. data/lib/aspera/keychain/one_password_cli.rb +0 -100
  236. data/lib/aspera/secret_hider.rb +0 -196
  237. data/lib/aspera/secret_strength.rb +0 -114
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../log'
7
+ require_relative '../assert'
8
+ require_relative '../transfer/units'
3
9
  require 'monitor'
4
- require 'aspera/environment'
5
- require 'aspera/log'
6
- require 'aspera/assert'
7
10
  require 'ruby-progressbar'
8
11
 
9
12
  module Aspera
@@ -18,42 +21,7 @@ module Aspera
18
21
  RATE_WINDOW_SEC = 5.0
19
22
  # Rate is not displayed on a shorter period
20
23
  RATE_MIN_SEC = 1.0
21
- # Decimal units, like `ascp`
22
- KILO = 1000
23
- BITS_PER_MEGABIT = KILO * KILO
24
- BYTE_UNITS = %w[B KB MB GB TB PB].freeze
25
- private_constant :RATE_WINDOW_SEC, :RATE_MIN_SEC, :KILO, :BITS_PER_MEGABIT, :BYTE_UNITS
26
-
27
- class << self
28
- # @param bytes [Integer] Size in bytes
29
- # @return [String] Size with decimal unit, e.g. `12.3 MB`
30
- def format_bytes(bytes)
31
- value = bytes.to_f
32
- index = 0
33
- while value >= KILO && index < BYTE_UNITS.length - 1
34
- value /= KILO
35
- index += 1
36
- end
37
- return "#{bytes} B" if index.zero?
38
- format('%.1f %s', value, BYTE_UNITS[index])
39
- end
40
-
41
- # @param bytes_per_second [Float, nil] Rate, `nil` if unknown
42
- # @return [String] Rate in megabits per second (decimal, like `ascp`)
43
- def format_rate(bytes_per_second)
44
- return '-- Mbps' if bytes_per_second.nil?
45
- mbps = bytes_per_second * Environment::BITS_PER_BYTE / BITS_PER_MEGABIT
46
- mbps < 10 ? format('%.2f Mbps', mbps) : format('%.0f Mbps', mbps)
47
- end
48
-
49
- # @param seconds [Numeric, nil] Duration, `nil` if unknown
50
- # @return [String] Duration as `hh:mm:ss`
51
- def format_duration(seconds)
52
- return '--:--:--' if seconds.nil?
53
- seconds = seconds.round
54
- format('%02d:%02d:%02d', seconds / 3600, (seconds / 60) % 60, seconds % 60)
55
- end
56
- end
24
+ private_constant :RATE_WINDOW_SEC, :RATE_MIN_SEC
57
25
 
58
26
  # @param output [IO] Where the progress bar is displayed: not on `$stdout`, which may be redirected for command output
59
27
  def initialize(output: $stderr)
@@ -217,7 +185,7 @@ module Aspera
217
185
 
218
186
  # @return [Float] Monotonic time in seconds
219
187
  def now
220
- Process.clock_gettime(Process::CLOCK_MONOTONIC)
188
+ ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
221
189
  end
222
190
 
223
191
  # Record transferred bytes for rate computation
@@ -251,7 +219,7 @@ module Aspera
251
219
  # Update the progress bar with current state
252
220
  def display
253
221
  if @progress_bar.nil?
254
- @progress_bar = ProgressBar.create(output: @output, format: '%a %B', total: nil, autofinish: false, throttle_rate: 0)
222
+ @progress_bar = ProgressBar.create(output: @output, format: '%a %B', total: nil, autofinish: false, throttle_rate: 0) # cspell:disable-line
255
223
  @format = '%a %B'
256
224
  end
257
225
  current = current_bytes
@@ -261,12 +229,12 @@ module Aspera
261
229
  unless @sessions.empty?
262
230
  bytes_per_second = rate
263
231
  # Fixed width, so that bar does not change size
264
- rate_text = self.class.format_rate(bytes_per_second).rjust(11)
232
+ rate_text = Transfer::Units.format_rate(bytes_per_second).rjust(11)
265
233
  if total.nil?
266
- fields.push(self.class.format_bytes(current).rjust(8), rate_text)
234
+ fields.push(Transfer::Units.format_bytes(current).rjust(8), rate_text)
267
235
  else
268
236
  eta = bytes_per_second&.positive? ? (total - current) / bytes_per_second : nil
269
- fields.push('%j%%', rate_text, "ETA: #{self.class.format_duration(eta)}")
237
+ fields.push('%j%%', rate_text, "ETA: #{Transfer::Units.format_duration(eta)}")
270
238
  end
271
239
  end
272
240
  update_format(title_text(final: false), fields)
@@ -287,7 +255,7 @@ module Aspera
287
255
  update_bar(total, current)
288
256
  fields.push('%B', '%j%%')
289
257
  end
290
- fields.push(self.class.format_bytes(current), self.class.format_rate(average_rate)) unless @sessions.empty?
258
+ fields.push(Transfer::Units.format_bytes(current), Transfer::Units.format_rate(average_rate)) unless @sessions.empty?
291
259
  # Last status (e.g. `running`) is no more relevant
292
260
  @title = success ? nil : 'failed'
293
261
  # Final line may be shorter (no bar)
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'result'
7
+ require_relative '../assert'
8
+
9
+ module Aspera
10
+ module Cli
11
+ # Mixin for Config plugin: `config vault` actions, on the default store of `context.vault` (`VaultManager`)
12
+ module VaultActions
13
+ # Import secrets from a JSON array; skips entries missing :label
14
+ def action_vault_import(secrets:, **)
15
+ bulk_result(secrets, command: :import, id_result: 'label') do |entry|
16
+ vault_required.set(entry.symbolize_keys)
17
+ {'label' => entry['label'] || entry[:label]}
18
+ end
19
+ end
20
+
21
+ def action_vault_delete(label:, id: nil, **)
22
+ v = vault_required
23
+ kwargs = id && v.method(:delete).parameters.any? { |_t, n| n == :id } ? {id: id} : {}
24
+ v.delete(label: label, **kwargs)
25
+ Result::Status.new("Secret deleted: #{label}")
26
+ end
27
+
28
+ # Checks a reference to a store of option `vault`, without its value
29
+ # @param reference [String] `@vault://<store>/<path>[?<options>][#<field>]`, or without `@vault:`
30
+ def action_vault_check(reference:, **)
31
+ Result::SingleObject.new(context.vault.metadata(reference.delete_prefix('@vault:')))
32
+ end
33
+
34
+ # @return [Secret::Store::Base, nil] Default store of option `vault`, `nil` if not configured
35
+ def vault
36
+ context.vault.store
37
+ end
38
+
39
+ # @return [Secret::Store::Base] Default store of option `vault`, raises if not configured
40
+ def vault_required
41
+ context.vault.store(mandatory: true)
42
+ end
43
+ end
44
+ end
45
+ end
@@ -1,62 +1,208 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/error'
4
- require 'aspera/log'
5
- require 'aspera/assert'
6
- require 'json'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'error'
7
+ require_relative 'info'
8
+ require_relative 'security'
9
+ require_relative 'deprecation'
10
+ require_relative '../secret/reference'
11
+ require_relative '../log'
12
+ require_relative '../assert'
7
13
 
8
14
  module Aspera
9
15
  module Cli
10
- # Mixin providing vault/keychain functionality to Plugin::Config.
11
- # Depends on `options` and `context.main_folder` being available in the including class.
12
- module VaultManager
13
- # Import secrets from a JSON array; skips entries missing :label
14
- def action_vault_import(secrets:, **)
15
- bulk_result(secrets, command: :import, id_result: 'label') do |entry|
16
- vault_required.set(entry.symbolize_keys)
17
- {'label' => entry['label'] || entry[:label]}
16
+ # Secrets of the vault, shared in `Context#vault`: read by `@vault:`, managed by `config vault`, written by presets.
17
+ # Option `vault`: named stores (`stores`), the name of the default store (`default`) and the cache of references (`cache_ttl`), see `Secret::Resolver`.
18
+ # - `<label>.<field>`: secret of the default store, unlocked with option `vault_password`, managed by label
19
+ # - `//<store>/<path>[?<options>][#<field>]`: reference to a secret of a store, read only
20
+ #
21
+ # Values `@file:<path>` in these options (e.g. `token`) are read by `Secret::Bootstrap`, not by `ExtendedValue`:
22
+ # they are checked here as extended value `@file:`, so that option `security` applies (e.g. in MCP server mode).
23
+ class VaultManager
24
+ # Beginning of a reference after `@vault:`, `secret://` without `secret:`
25
+ REFERENCE_PREFIX = '//'
26
+ # File of type `file`, in the configuration folder
27
+ DEFAULT_FILE = 'vault.bin'
28
+ # Name of the default store, not given to `Secret::Resolver`
29
+ DEFAULT_KEY = 'default'
30
+ STORES_KEY = 'stores'
31
+ # Keys of option `vault`, others are parameters of a store (deprecated form)
32
+ OPTION_KEYS = [DEFAULT_KEY, 'cache_ttl', STORES_KEY].freeze
33
+ private_constant :DEFAULT_FILE, :DEFAULT_KEY, :STORES_KEY, :OPTION_KEYS
34
+
35
+ class << self
36
+ # Value of option `vault` when set (`convert` of option): the parameters of one store (deprecated) are
37
+ # a store named after its type, which is the default store.
38
+ # @param value [Hash] Value of option `vault`
39
+ # @return [Hash] Value with `stores`
40
+ def convert_option(value)
41
+ value = value.transform_keys(&:to_s)
42
+ params = value.except(*OPTION_KEYS)
43
+ return value if params.empty?
44
+ params['type'] ||= 'file'
45
+ name = params['type'].to_s
46
+ Log.log.warn do
47
+ "option vault: parameters of one store are #{Deprecation.new(last: '4.28.0', message: "set a store in #{STORES_KEY}, and its name in #{DEFAULT_KEY}: {\"#{DEFAULT_KEY}\":\"#{name}\",\"#{STORES_KEY}\":{\"#{name}\":{...}}}")}"
48
+ end
49
+ value.slice(*OPTION_KEYS).merge(DEFAULT_KEY => name, STORES_KEY => (value[STORES_KEY] || {}).merge(name => params))
18
50
  end
19
51
  end
20
52
 
21
- def action_vault_delete(label:, id: nil, **)
22
- v = vault_required
23
- kwargs = id && v.method(:delete).parameters.any? { |_t, n| n == :id } ? {id: id} : {}
24
- v.delete(label: label, **kwargs)
25
- Result::Status.new("Secret deleted: #{label}")
53
+ # @param options [Parser] Options `vault` and `vault_password`
54
+ # @param main_folder [String] Folder of relative paths of vault files
55
+ def initialize(options, main_folder)
56
+ @options = options
57
+ @main_folder = main_folder
58
+ @resolver = nil
59
+ # Name of the default store, `nil` if none
60
+ @default = nil
61
+ # Name and type of stores, without parameters (may contain secrets)
62
+ @stores = []
63
+ end
64
+
65
+ # Stores of option `vault`, without their parameters
66
+ # @return [Array<Hash>] `name`, `type`, `default` of each store, empty if not configured
67
+ def stores
68
+ resolver
69
+ @stores
26
70
  end
27
71
 
28
- # @return [Keychain::Base] vault instance, raises if not configured
29
- def vault_required
30
- Aspera.assert(!vault.nil?, type: Cli::BadArgument) { 'Missing mandatory option: vault' }
31
- vault
72
+ # Default store, opened when first used.
73
+ # @param mandatory [Boolean] Raise if not configured
74
+ # @return [Secret::Store::Base, nil] Store, `nil` if not configured
75
+ def store(mandatory: false)
76
+ return if resolver(mandatory: mandatory).nil?
77
+ Aspera.assert(!mandatory || !@default.nil?, type: BadArgument) { "option vault: no default store: set #{DEFAULT_KEY}" }
78
+ @resolver.store(@default) unless @default.nil?
32
79
  end
33
80
 
34
- # @return [String] value from vault matching <name>.<param>
35
- def vault_value(name)
81
+ # Value of `@vault:`
82
+ # @param name [String] `<label>.<field>` or `//<store>/<path>[?<options>][#<field>]`
83
+ # @return [String] Value of secret
84
+ def value(name)
85
+ return resolver(mandatory: true).resolve(reference_text(name)) if name.start_with?(REFERENCE_PREFIX)
36
86
  # Label may contain dots (e.g. preset name)
37
87
  label, _, param = name.rpartition('.')
38
88
  Aspera.assert(!label.empty? && !param.empty?, type: BadArgument) { 'vault name shall match <name>.<param>' }
39
- info = vault_required.get(label: label)
89
+ info = store(mandatory: true).get(label: label)
40
90
  value = info[param.to_sym]
41
91
  raise "no such entry value: #{param}" if value.nil?
42
- return value
43
- end
44
-
45
- # @return [Keychain::Base, nil] vault instance, lazily created from options, or nil if not configured
46
- def vault
47
- return @vault_instance if @vault_instance_initialized
48
- @vault_instance_initialized = true
49
- info = options.get_option(:vault, mandatory: false)
50
- return @vault_instance = nil if info.nil? || (info.is_a?(Hash) && info.empty?)
51
- info = info.symbolize_keys
52
- info[:type] ||= 'file'
53
- require 'aspera/keychain/factory'
54
- @vault_instance = Keychain::Factory.create(
55
- info,
56
- Info::CMD_NAME,
57
- context.main_folder,
58
- options.get_option(:vault_password)
59
- )
92
+ value
93
+ end
94
+
95
+ # Checks that a reference can be read, without its value
96
+ # @param name [String] `//<store>/<path>[?<options>][#<field>]`
97
+ # @return [Hash] `store`, `version`, `updated_time`
98
+ def metadata(name)
99
+ Aspera.assert(name.start_with?(REFERENCE_PREFIX), type: BadArgument) { "expecting a reference: @vault:#{REFERENCE_PREFIX}<store>/<path>[?<options>][#<field>]" }
100
+ resolver(mandatory: true).metadata(reference_text(name))
101
+ end
102
+
103
+ # Field names of a secret of the default store, without values
104
+ # @param label [String] Label of secret
105
+ # @return [Array<String>] Names of fields that a reference can read
106
+ def fields(label)
107
+ store(mandatory: true)
108
+ reference = Secret.reference_text(store: @default, path: label)
109
+ resolver(mandatory: true).fields(reference)[:fields]
110
+ end
111
+
112
+ private
113
+
114
+ # Resolver of the stores of option `vault`, created when first used.
115
+ # Not kept when not configured: options may be set later (e.g. by the global preset).
116
+ # @param mandatory [Boolean] Raise if not configured
117
+ # @return [Secret::Resolver, nil] Resolver, `nil` if not configured
118
+ def resolver(mandatory: false)
119
+ @resolver ||= create_resolver
120
+ Aspera.assert(!mandatory || !@resolver.nil?, type: BadArgument) { 'Missing mandatory option: vault' }
121
+ @resolver
122
+ end
123
+
124
+ # @return [Secret::Resolver, nil] Resolver of option `vault`, `nil` if not configured
125
+ def create_resolver
126
+ config = @options.get_option(:vault, mandatory: false)
127
+ return if config.nil? || (config.is_a?(Hash) && config.empty?)
128
+ Aspera.assert_type(config, Hash, type: BadArgument) { 'option vault' }
129
+ config = config.transform_keys(&:to_s)
130
+ stores = config[STORES_KEY]
131
+ Aspera.assert_type(stores, Hash, type: BadArgument) { "option vault: #{STORES_KEY}" }
132
+ stores = stores.to_h { |name, params| [name.to_s, store_parameters(params)] }
133
+ default = config.delete(DEFAULT_KEY)&.to_s
134
+ Aspera.assert(default.nil? || stores.key?(default), type: BadArgument) { "option vault: #{DEFAULT_KEY}: no store #{default}" }
135
+ check_file_values(:vault, stores)
136
+ add_vault_password(stores[default]) unless default.nil?
137
+ require_relative '../secret/resolver'
138
+ resolver = Secret::Resolver.new(config.merge(STORES_KEY => stores))
139
+ @default = default
140
+ @stores = stores.map { |name, params| {'name' => name, 'type' => params[:type], 'default' => name.eql?(default)} }
141
+ resolver
142
+ end
143
+
144
+ # Parameters of a store, with the defaults of `ascli`
145
+ # @param params [Hash] Parameters of a store of option `vault`
146
+ # @return [Hash] Parameters of `Secret::Store::Factory`, Symbol keys
147
+ def store_parameters(params)
148
+ Aspera.assert_type(params, Hash, type: BadArgument) { 'option vault: store' }
149
+ params = params.transform_keys(&:to_sym)
150
+ case params[:type]
151
+ when 'file'
152
+ # `name`: same as `file`, for compatibility
153
+ file = params.delete(:name) || params[:file] || DEFAULT_FILE
154
+ params[:file] = file.is_a?(String) && !File.absolute_path?(file) ? File.join(@main_folder, file) : file
155
+ when 'system', 'secret_service'
156
+ params[:name] ||= Info::CMD_NAME
157
+ end
158
+ params
159
+ end
160
+
161
+ # Option `vault_password` is the secret of the default store, if not in its parameters
162
+ # @param params [Hash] Parameters of the default store, modified
163
+ def add_vault_password(params)
164
+ key =
165
+ case params[:type]
166
+ when 'file' then :password
167
+ when 'vault' then :token unless params.key?(:approle)
168
+ when '1password' then :token unless params[:source].eql?('cli')
169
+ when 'keeper' then :config
170
+ end
171
+ return if key.nil? || params.key?(key)
172
+ password = @options.get_option(:vault_password)
173
+ Aspera.assert(!password.nil? || !params[:type].eql?('file'), type: BadArgument) { 'Missing mandatory option: vault_password' }
174
+ return if password.nil?
175
+ check_file_values(:vault_password, password)
176
+ params[key] = password
177
+ end
178
+
179
+ # Values `@file:<path>` are read like extended value `@file:`, see `Security`
180
+ # @param option [Symbol] Name of option, for errors
181
+ # @param value [Object] Value of option
182
+ # @raise [BadArgument] Reading a file is refused at current security level
183
+ def check_file_values(option, value)
184
+ file_paths(value).each do |path|
185
+ Security.instance.check_extended_value(:file)
186
+ Security.instance.readable_path(path)
187
+ end
188
+ rescue BadArgument => e
189
+ raise BadArgument, "option #{option}: #{e.message}"
190
+ end
191
+
192
+ # @param value [Object] Value of option
193
+ # @return [Array<String>] Paths of values `@file:<path>`, also in nested values
194
+ def file_paths(value)
195
+ case value
196
+ when Hash then value.values.flat_map { |v| file_paths(v) }
197
+ when Array then value.flat_map { |v| file_paths(v) }
198
+ when String then value.start_with?(Secret::Bootstrap::FILE_PREFIX) ? [value.delete_prefix(Secret::Bootstrap::FILE_PREFIX)] : []
199
+ else []
200
+ end
201
+ end
202
+
203
+ # @return [String] Reference `secret://...` of value of `@vault://...`
204
+ def reference_text(name)
205
+ "#{Secret::SCHEME}#{name.delete_prefix(REFERENCE_PREFIX)}"
60
206
  end
61
207
  end
62
208
  end
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
3
6
  module Aspera
4
7
  module Cli
5
8
  # For beta add extension : .beta1
6
9
  # For dev version add extension : .pre
7
- VERSION = '4.28.0'
10
+ VERSION = '4.29.0'
8
11
  end
9
12
  end
@@ -1,16 +1,18 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore urlsafe
4
-
5
- require 'aspera/log'
6
- require 'aspera/assert'
7
- require 'aspera/environment'
8
- require 'aspera/web_page'
9
- require 'aspera/servlet_helpers'
10
- require 'aspera/cli/error'
11
- require 'aspera/cli/info'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../log'
7
+ require_relative '../assert'
8
+ require_relative '../environment'
9
+ require_relative '../web_page'
10
+ require_relative '../servlet_helpers'
11
+ require_relative 'error'
12
+ require_relative 'info'
12
13
  require 'openssl'
13
14
  require 'securerandom'
15
+ require 'uri'
14
16
 
15
17
  module Aspera
16
18
  module Cli
@@ -198,7 +200,7 @@ module Aspera
198
200
  # Start a local web server for the pages
199
201
  # @return [String] URL of the local server
200
202
  def start_local_server
201
- require 'aspera/web_server_simple'
203
+ require_relative '../web_server_simple'
202
204
  servlet = Class.new(WEBrick::HTTPServlet::AbstractServlet) do
203
205
  include ServletHelpers
204
206
 
@@ -1,29 +1,24 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/oauth/client/jwt'
4
- require 'aspera/assert'
5
- require 'aspera/environment'
6
- require 'aspera/id_generator'
7
- require 'aspera/cli/option_declarator'
8
- require 'aspera/cli/plugins/factory'
9
- require 'aspera/rainbow'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../oauth/client/jwt'
7
+ require_relative '../assert'
8
+ require_relative '../environment'
9
+ require_relative '../id_generator'
10
+ require_relative 'plugins/factory'
11
+ require_relative '../rainbow'
10
12
  using Rainbow
11
13
 
12
14
  module Aspera
13
15
  module Cli
14
16
  # The wizard detects applications and generates a config
15
17
  class Wizard
16
- extend OptionDeclarator
17
-
18
18
  WIZARD_RESULT_KEYS = %i[preset_ids preset_value test_args].freeze
19
19
  DEFAULT_PRIV_KEY_FILENAME = 'my_private_key.pem' # pragma: allowlist secret
20
20
  private_constant :WIZARD_RESULT_KEYS, :DEFAULT_PRIV_KEY_FILENAME
21
21
 
22
- # Declared by the `config` plugin (`use_options Wizard`)
23
- option :override, description: 'Wizard: override existing value', allowed: Type::BOOLEAN, default: false
24
- option :default, description: 'Wizard: set as default configuration for specified plugin (also: update)', allowed: Type::BOOLEAN, default: true
25
- option :key_path, description: 'Wizard: path to private key for JWT'
26
-
27
22
  def initialize(parent, main_folder)
28
23
  @parent = parent
29
24
  @main_folder = main_folder
@@ -94,32 +89,37 @@ module Aspera
94
89
  nil
95
90
  end
96
91
 
97
- # To be called in public wizard method to get private key
92
+ # To be called in public wizard method to get private key.
93
+ # The key is the value of option `private_key` (e.g. `@file:<path>`): if empty or not provided, the default key is used, or generated.
98
94
  # @param user [String] User's email
99
95
  # @param url [String] Instance URL
100
96
  # @param page [Array<String>] Navigation steps to the page to enter the public key (see `display_navigation`)
101
- # @return [String] Private key path (can contain ~ for home)
97
+ # @return [String] Value of `private_key` for the preset: the key as provided, or a reference to the generated file
102
98
  def ask_private_key(user:, url:, page:)
103
- # Lets see if path to priv key is provided
104
- private_key_path = options.get_option(:key_path)
99
+ # Lets see if the private key is provided
100
+ private_key_pem = options.get_option(:private_key)
105
101
  # Give a chance to provide
106
- if private_key_path.nil?
107
- formatter.display_status('Path to private RSA key (leave empty to generate):')
108
- private_key_path = options.get_option(:key_path, mandatory: true).to_s
102
+ if private_key_pem.nil?
103
+ formatter.display_status('Private RSA key, e.g. @file:<path> (leave empty to generate):')
104
+ private_key_pem = options.get_option(:private_key, mandatory: true).to_s
109
105
  end
110
- # Else generate path
111
- private_key_path = File.join(@main_folder, DEFAULT_PRIV_KEY_FILENAME) if private_key_path.empty?
112
- if File.exist?(File.expand_path(private_key_path))
113
- formatter.display_status('Using existing key:')
106
+ if private_key_pem.empty?
107
+ private_key_path = File.join(@main_folder, DEFAULT_PRIV_KEY_FILENAME)
108
+ if File.exist?(File.expand_path(private_key_path))
109
+ formatter.display_status('Using existing key:')
110
+ else
111
+ formatter.display_status("Generating #{OAuth::Jwt::DEFAULT_PRIV_KEY_LENGTH} bit RSA key...")
112
+ OAuth::Jwt.generate_rsa_private_key(path: private_key_path)
113
+ formatter.display_status('Created key:')
114
+ end
115
+ formatter.display_status(private_key_path)
116
+ private_key_pem = File.read(File.expand_path(private_key_path))
117
+ options.set_option(:private_key, private_key_pem)
118
+ private_key_preset_value = "@file:#{private_key_path}"
114
119
  else
115
- formatter.display_status("Generating #{OAuth::Jwt::DEFAULT_PRIV_KEY_LENGTH} bit RSA key...")
116
- OAuth::Jwt.generate_rsa_private_key(path: private_key_path)
117
- formatter.display_status('Created key:')
120
+ private_key_preset_value = private_key_pem
118
121
  end
119
- formatter.display_status(private_key_path)
120
- private_key_pem = File.read(File.expand_path(private_key_path))
121
122
  pub_key_pem = OpenSSL::PKey::RSA.new(private_key_pem).public_key.to_s
122
- options.set_option(:private_key, private_key_pem)
123
123
  formatter.display_status("Please Log in as user #{user.red} at: #{url.red}")
124
124
  display_navigation(*page)
125
125
  formatter.display_status("Check or update the value to (#{'including BEGIN/END lines'.red}):".blink)
@@ -127,18 +127,22 @@ module Aspera
127
127
  formatter.display_status('Once updated or validated, press [Enter].')
128
128
  Environment.instance.open_uri(url)
129
129
  $stdin.gets if required
130
- private_key_path
130
+ private_key_preset_value
131
131
  end
132
132
 
133
133
  # Wizard function, creates configuration
134
- # @param apps [Array] list of detected apps
135
- def find(apps, preset_name: '')
134
+ # Options of the plugin (e.g. `--username`, `--password`, `--private-key`) are read from the command line, once the plugin has declared them.
135
+ # @param apps [Array] list of detected apps
136
+ # @param preset_name [String] name of the preset to create (default: generated)
137
+ # @param override [Boolean] override the existing default preset of the plugin, if it exists
138
+ # @param default [Boolean] set the preset as default configuration for the plugin
139
+ def find(apps, preset_name: '', override: false, default: true)
136
140
  identification = if apps.length.eql?(1)
137
141
  Log.log.debug { "Detected: #{identification}" }
138
142
  apps.first
139
143
  else
140
144
  formatter.display_status('Multiple applications detected, please select from:')
141
- require 'aspera/cli/result'
145
+ require_relative 'result'
142
146
  formatter.display_results(Result::ObjectList.new(apps, fields: %w[product url version]))
143
147
  answer = options.prompt_user_input_in_list('product', apps.map { |a| a[:product] })
144
148
  apps.find { |a| a[:product].eql?(answer) }
@@ -168,11 +172,10 @@ module Aspera
168
172
  # Write configuration file
169
173
  formatter.display_status("Preparing preset: #{wiz_preset_name}")
170
174
  # Init defaults if necessary
171
- option_override = options.get_option(:override, mandatory: true)
172
- option_default = options.get_option(:default, mandatory: true)
173
- @parent.context.presets.defaults_set(identification[:product], wiz_preset_name, wizard_result[:preset_value].stringify_keys, option_default, option_override)
175
+ preset_value = {PresetManager::Key::COMMENT => "wizard: #{identification[:name]}"}.merge(wizard_result[:preset_value].stringify_keys)
176
+ @parent.context.presets.defaults_set(identification[:product], wiz_preset_name, preset_value, default, override)
174
177
  test_args = wizard_result[:test_args]
175
- test_args = "-P#{wiz_preset_name} #{test_args}" unless option_default
178
+ test_args = "-P#{wiz_preset_name} #{test_args}" unless default
176
179
  # TODO: actually test the command
177
180
  test_cmd = "#{Info::CMD_NAME} #{identification[:product]} #{test_args}"
178
181
  return Result::Status.new("You can test with:\n#{test_cmd.red}")
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/log'
4
- require 'aspera/assert'
5
- require 'aspera/schema/registry'
6
- require 'aspera/exec_spec'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'log'
7
+ require_relative 'assert'
8
+ require_relative 'schema/registry'
9
+ require_relative 'exec_spec'
7
10
  require 'yaml'
8
11
  module Aspera
9
12
  # Helper class to build command line from a parameter list (key-value hash)
@@ -28,6 +31,7 @@ module Aspera
28
31
  'x-cli-switch', # [Boolean] `true` if option has no arg, else by default option has a value
29
32
  'x-cli-special', # [Boolean] `true` if special handling (deferred)
30
33
  'x-cli-convert', # [String,Hash] Method name for Convert object or Conversion for enum ts to arg
34
+ 'x-cli-complete', # [String] Values proposed by shell completion: `file`, `folder` (see `Cli::Complete::KINDS`)
31
35
  'x-agents', # [Array] Supported agents (for doc only), if not specified: all
32
36
  'x-ts-name', # [Boolean,String] (async) true if same name in transfer spec, else real name in transfer spec, else ignored
33
37
  'x-ts-convert', # [String] (async) Name of methods to convert value from transfer spec to `conf` API.
@@ -231,7 +235,7 @@ module Aspera
231
235
  else
232
236
  # transform into command line option with value
233
237
  # parameter_value=parameter_value.to_s if parameter_value.is_a?(Integer)
234
- parameter_value = [parameter_value] unless parameter_value.is_a?(Array)
238
+ parameter_value = Array(parameter_value)
235
239
  # if transfer_spec value is an array, applies option many times
236
240
  parameter_value.each { |v| add_command_line_options(properties['x-cli-option'], v) }
237
241
  end
@@ -1,6 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/assert'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'assert'
4
7
  module Aspera
5
8
  # conversion class for transfer spec values to CLI values (ascp)
6
9
  class CommandLineConverter