aspera-cli 4.28.0 → 4.29.1

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 (242) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +217 -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 +122 -26
  10. data/SECURITY.md +84 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +9 -6
  13. data/docs/README.md +1895 -632
  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 +29 -22
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +95 -67
  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 +370 -0
  41. data/lib/aspera/ascp/log_locations.rb +163 -0
  42. data/lib/aspera/ascp/management.rb +16 -8
  43. data/lib/aspera/ascp/session_errors.rb +217 -0
  44. data/lib/aspera/assert.rb +4 -0
  45. data/lib/aspera/cli/ascp_actions.rb +12 -19
  46. data/lib/aspera/cli/ascp_logs_actions.rb +188 -0
  47. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  48. data/lib/aspera/cli/bootstrapper.rb +38 -33
  49. data/lib/aspera/cli/command_line.rb +63 -8
  50. data/lib/aspera/cli/command_registry.rb +9 -1
  51. data/lib/aspera/cli/command_spec.rb +47 -7
  52. data/lib/aspera/cli/completion/ascli.bash +19 -5
  53. data/lib/aspera/cli/completion/ascli.fish +13 -2
  54. data/lib/aspera/cli/completion/ascli.ps1 +31 -9
  55. data/lib/aspera/cli/completion/ascli.zsh +22 -6
  56. data/lib/aspera/cli/completion_actions.rb +303 -69
  57. data/lib/aspera/cli/context.rb +9 -4
  58. data/lib/aspera/cli/deprecation.rb +5 -2
  59. data/lib/aspera/cli/error.rb +6 -0
  60. data/lib/aspera/cli/extended_value.rb +66 -31
  61. data/lib/aspera/cli/formatter.rb +43 -30
  62. data/lib/aspera/cli/gem_checker.rb +9 -6
  63. data/lib/aspera/cli/hints.rb +22 -10
  64. data/lib/aspera/cli/http.rb +38 -10
  65. data/lib/aspera/cli/info.rb +12 -7
  66. data/lib/aspera/cli/mailer.rb +6 -3
  67. data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
  68. data/lib/aspera/cli/mcp/secrets.rb +8 -5
  69. data/lib/aspera/cli/mcp/tool.rb +20 -17
  70. data/lib/aspera/cli/option_declarator.rb +10 -4
  71. data/lib/aspera/cli/option_registry.rb +6 -3
  72. data/lib/aspera/cli/option_types.rb +17 -2
  73. data/lib/aspera/cli/option_value.rb +77 -18
  74. data/lib/aspera/cli/options.schema.yaml +641 -80
  75. data/lib/aspera/cli/parser.rb +71 -35
  76. data/lib/aspera/cli/plugins/alee.rb +7 -4
  77. data/lib/aspera/cli/plugins/aoc.rb +248 -37
  78. data/lib/aspera/cli/plugins/ats.rb +10 -9
  79. data/lib/aspera/cli/plugins/base.rb +50 -18
  80. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  81. data/lib/aspera/cli/plugins/config.rb +210 -104
  82. data/lib/aspera/cli/plugins/console.rb +6 -3
  83. data/lib/aspera/cli/plugins/cos.rb +8 -4
  84. data/lib/aspera/cli/plugins/factory.rb +21 -7
  85. data/lib/aspera/cli/plugins/faspex5.rb +31 -26
  86. data/lib/aspera/cli/plugins/faspio.rb +7 -5
  87. data/lib/aspera/cli/plugins/httpgw.rb +7 -4
  88. data/lib/aspera/cli/plugins/mcp.rb +42 -22
  89. data/lib/aspera/cli/plugins/node.rb +39 -38
  90. data/lib/aspera/cli/plugins/oauth.rb +23 -6
  91. data/lib/aspera/cli/plugins/orchestrator.rb +287 -83
  92. data/lib/aspera/cli/plugins/preview.rb +72 -45
  93. data/lib/aspera/cli/plugins/server.rb +66 -14
  94. data/lib/aspera/cli/plugins/shares.rb +87 -18
  95. data/lib/aspera/cli/plugins/transferd.rb +228 -0
  96. data/lib/aspera/cli/poll.rb +236 -0
  97. data/lib/aspera/cli/preset_actions.rb +144 -30
  98. data/lib/aspera/cli/preset_manager.rb +113 -35
  99. data/lib/aspera/cli/prompt.rb +157 -9
  100. data/lib/aspera/cli/result.rb +12 -8
  101. data/lib/aspera/cli/runner.rb +89 -48
  102. data/lib/aspera/cli/secret_finder.rb +4 -1
  103. data/lib/aspera/cli/security.rb +89 -9
  104. data/lib/aspera/cli/special_values.rb +4 -1
  105. data/lib/aspera/cli/sync_actions.rb +15 -10
  106. data/lib/aspera/cli/table_fitter.rb +3 -0
  107. data/lib/aspera/cli/terminal_formatter.rb +9 -6
  108. data/lib/aspera/cli/transfer_actions.rb +11 -8
  109. data/lib/aspera/cli/transfer_agent.rb +43 -20
  110. data/lib/aspera/cli/transfer_progress.rb +14 -45
  111. data/lib/aspera/cli/vault_actions.rb +45 -0
  112. data/lib/aspera/cli/vault_manager.rb +188 -42
  113. data/lib/aspera/cli/version.rb +4 -1
  114. data/lib/aspera/cli/web_secret.rb +12 -10
  115. data/lib/aspera/cli/wizard.rb +42 -39
  116. data/lib/aspera/command_line_builder.rb +9 -5
  117. data/lib/aspera/command_line_converter.rb +4 -1
  118. data/lib/aspera/coverage.rb +103 -33
  119. data/lib/aspera/data_repository.rb +4 -1
  120. data/lib/aspera/dot_container.rb +4 -1
  121. data/lib/aspera/environment.rb +23 -12
  122. data/lib/aspera/exec_spec.rb +3 -0
  123. data/lib/aspera/faspex_gw.rb +13 -9
  124. data/lib/aspera/faspex_postproc.rb +15 -12
  125. data/lib/aspera/formatter_interface.rb +4 -1
  126. data/lib/aspera/graphql.rb +5 -1
  127. data/lib/aspera/hash_ext.rb +3 -0
  128. data/lib/aspera/id_generator.rb +20 -5
  129. data/lib/aspera/inflate.rb +43 -0
  130. data/lib/aspera/json_rpc/client.rb +6 -5
  131. data/lib/aspera/json_rpc/version.rb +3 -0
  132. data/lib/aspera/line_logger.rb +4 -1
  133. data/lib/aspera/link_header.rb +4 -1
  134. data/lib/aspera/log.rb +18 -5
  135. data/lib/aspera/markdown.rb +5 -2
  136. data/lib/aspera/mime.rb +3 -0
  137. data/lib/aspera/nagios.rb +6 -4
  138. data/lib/aspera/node_emulator.rb +15 -13
  139. data/lib/aspera/oauth/client/base.rb +124 -73
  140. data/lib/aspera/oauth/client/boot.rb +7 -4
  141. data/lib/aspera/oauth/client/factory.rb +41 -18
  142. data/lib/aspera/oauth/client/generic.rb +5 -1
  143. data/lib/aspera/oauth/client/json_credentials.rb +7 -3
  144. data/lib/aspera/oauth/client/jwt.rb +6 -3
  145. data/lib/aspera/oauth/client/shares_web.rb +94 -0
  146. data/lib/aspera/oauth/client/url_json.rb +7 -3
  147. data/lib/aspera/oauth/client/web.rb +40 -13
  148. data/lib/aspera/oauth/server/pkce.rb +6 -5
  149. data/lib/aspera/orchestrator_workflow_checker.rb +129 -2
  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 +16 -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 +17 -2
  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 +3 -0
  165. data/lib/aspera/rest/aspera_errors.rb +4 -1
  166. data/lib/aspera/rest/call_error.rb +3 -0
  167. data/lib/aspera/rest/client.rb +45 -34
  168. data/lib/aspera/rest/error_analyzer.rb +5 -2
  169. data/lib/aspera/rest/list.rb +8 -4
  170. data/lib/aspera/rest/parameters.rb +3 -0
  171. data/lib/aspera/rest/util.rb +8 -5
  172. data/lib/aspera/rest.rb +9 -6
  173. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
  174. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
  175. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  176. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  177. data/lib/aspera/schema/async_tables.yaml +11 -10
  178. data/lib/aspera/schema/documentation.rb +8 -2
  179. data/lib/aspera/schema/reader.rb +7 -0
  180. data/lib/aspera/schema/registry.rb +44 -28
  181. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  182. data/lib/aspera/schema/validator.rb +4 -1
  183. data/lib/aspera/sealed_hash.rb +150 -0
  184. data/lib/aspera/secret/hider.rb +213 -0
  185. data/lib/aspera/secret/reference.rb +150 -0
  186. data/lib/aspera/secret/resolver.rb +212 -0
  187. data/lib/aspera/secret/store/base.rb +153 -0
  188. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  189. data/lib/aspera/secret/store/factory.rb +103 -0
  190. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  191. data/lib/aspera/secret/store/keeper.rb +141 -0
  192. data/lib/aspera/secret/store/macos_security.rb +284 -0
  193. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  194. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  195. data/lib/aspera/secret/store/one_password_cli.rb +112 -0
  196. data/lib/aspera/secret/store/secret_service.rb +125 -0
  197. data/lib/aspera/secret/strength.rb +119 -0
  198. data/lib/aspera/servlet_helpers.rb +5 -2
  199. data/lib/aspera/ssh.rb +10 -7
  200. data/lib/aspera/ssl.rb +5 -2
  201. data/lib/aspera/string_ext.rb +3 -0
  202. data/lib/aspera/sync/args.schema.yaml +3 -0
  203. data/lib/aspera/sync/conf.schema.yaml +9 -4
  204. data/lib/aspera/sync/database.rb +3 -0
  205. data/lib/aspera/sync/operations.rb +17 -15
  206. data/lib/aspera/temp_file_manager.rb +8 -4
  207. data/lib/aspera/timer_limiter.rb +3 -0
  208. data/lib/aspera/transfer/error.rb +4 -1
  209. data/lib/aspera/transfer/faux_file.rb +4 -1
  210. data/lib/aspera/transfer/parameters.rb +17 -14
  211. data/lib/aspera/transfer/result.rb +23 -0
  212. data/lib/aspera/transfer/resumer.rb +6 -4
  213. data/lib/aspera/transfer/spec.rb +9 -22
  214. data/lib/aspera/units/decimal.rb +67 -0
  215. data/lib/aspera/units/duration.rb +109 -0
  216. data/lib/aspera/uri_reader.rb +64 -9
  217. data/lib/aspera/web_auth/index.html.erb +6 -2
  218. data/lib/aspera/web_auth/paste.rb +109 -0
  219. data/lib/aspera/web_auth/receiver.rb +50 -0
  220. data/lib/aspera/web_auth/relay.rb +76 -0
  221. data/lib/aspera/web_auth/reply.html.erb +150 -0
  222. data/lib/aspera/web_auth/server.rb +47 -10
  223. data/lib/aspera/web_page.rb +7 -2
  224. data/lib/aspera/web_server_simple.rb +6 -3
  225. data/lib/aspera/yaml.rb +5 -1
  226. data/llms-install.md +88 -0
  227. data/llms.txt +87 -0
  228. data/skills/ascli/SKILL.md +94 -0
  229. data.tar.gz.sig +0 -0
  230. metadata +77 -20
  231. metadata.gz.sig +0 -0
  232. data/lib/aspera/duration.rb +0 -42
  233. data/lib/aspera/keychain/base.rb +0 -30
  234. data/lib/aspera/keychain/encrypted_hash.rb +0 -192
  235. data/lib/aspera/keychain/factory.rb +0 -58
  236. data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
  237. data/lib/aspera/keychain/macos_security.rb +0 -277
  238. data/lib/aspera/keychain/one_password_api.rb +0 -91
  239. data/lib/aspera/keychain/one_password_base.rb +0 -39
  240. data/lib/aspera/keychain/one_password_cli.rb +0 -100
  241. data/lib/aspera/secret_hider.rb +0 -196
  242. data/lib/aspera/secret_strength.rb +0 -114
@@ -1,21 +1,23 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore csvt jsonpp stdbin
4
- require 'aspera/uri_reader'
5
- require 'aspera/environment'
6
- require 'aspera/yaml'
7
- require 'aspera/log'
8
- require 'aspera/assert'
9
- require 'aspera/secret_hider'
10
- require 'aspera/cli/error'
11
- require 'aspera/cli/prompt'
12
- require 'aspera/cli/security'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../uri_reader'
7
+ require_relative '../environment'
8
+ require_relative '../yaml'
9
+ require_relative '../log'
10
+ require_relative '../assert'
11
+ require_relative '../secret/hider'
12
+ require_relative 'error'
13
+ require_relative 'prompt'
14
+ require_relative 'security'
15
+ require_relative '../rainbow'
13
16
  require 'json'
14
17
  require 'base64'
15
18
  require 'zlib'
16
19
  require 'csv'
17
20
  require 'singleton'
18
- require 'aspera/rainbow'
19
21
  using Rainbow
20
22
 
21
23
  module Aspera
@@ -29,7 +31,7 @@ module Aspera
29
31
  include Singleton
30
32
 
31
33
  # First is default
32
- DEFAULT_DECODERS = %i[none json ruby yaml]
34
+ DEFAULT_DECODERS = %i[none json ruby yaml].freeze
33
35
 
34
36
  class << self
35
37
  # Decode comma separated table text
@@ -82,7 +84,7 @@ module Aspera
82
84
  def read_secret(prompt)
83
85
  prompt = 'secret' if prompt.empty?
84
86
  return Prompt.prompt_user_input(prompt, sensitive: true) unless Environment.instance.url_method.eql?(:graphical)
85
- require 'aspera/cli/web_secret'
87
+ require_relative 'web_secret'
86
88
  WebSecret.ask(prompt)
87
89
  end
88
90
 
@@ -108,7 +110,7 @@ module Aspera
108
110
  base64: lambda { |i| Base64.decode64(i) },
109
111
  csvt: lambda { |i| ExtendedValue.decode_csvt(i) },
110
112
  env: lambda { |i| ENV.fetch(i, nil) },
111
- file: lambda { |i| File.read(Security.instance.readable_path(i)) },
113
+ file: lambda { |i| Security.instance.read_file(i) },
112
114
  uri: lambda { |i| UriReader.read(i) },
113
115
  json: lambda { |i| ExtendedValue.JSON_parse(i) },
114
116
  lines: lambda { |i| i.split("\n") },
@@ -124,18 +126,42 @@ module Aspera
124
126
  zlib: lambda { |i| Zlib::Inflate.inflate(i) },
125
127
  extend: lambda { |i| ExtendedValue.instance.evaluate_extend(i) }
126
128
  }
129
+ # Descriptions of handlers, for shell completion
130
+ # @type [Hash{Symbol => String}]
131
+ @descriptions = {
132
+ val: 'Value as is: modifiers on the right are not evaluated',
133
+ base64: 'Decode Base64',
134
+ csvt: 'Decode titled CSV: Array of Hash',
135
+ env: 'Value of environment variable',
136
+ file: 'Content of local file',
137
+ uri: 'Content of URL: http:, https:, data:, file:',
138
+ json: 'Decode JSON',
139
+ lines: 'Split lines: Array',
140
+ list: 'Split on first character: Array',
141
+ none: 'Null value',
142
+ path: 'Local path, with ~ expanded',
143
+ re: 'Regular expression',
144
+ ruby: 'Evaluate Ruby code',
145
+ s: 'Convert to String',
146
+ secret: 'Ask secret, with prompt',
147
+ stdin: 'Read standard input: empty, bin or chomp',
148
+ yaml: 'Decode YAML',
149
+ zlib: 'Decompress zlib',
150
+ extend: 'Evaluate embedded @<modifier>:<value>@'
151
+ }
127
152
  @regex_single = nil
128
- @regex_extend = nil
153
+ @regex_inner = nil
129
154
  @default_decoder = nil
130
155
  update_regex
131
156
  end
132
157
 
133
158
  # Update the Regex to match an extended value based on @handlers
134
- # Anchored on the whole value (`\A`, `\z`), not on lines: a multi-line value is extended only if it starts with a modifier.
159
+ # Single: anchored on the whole value (`\A`, `\z`), not on lines: a multi-line value is extended only if it starts with a modifier.
160
+ # Inner: an extended value embedded in a text, for `@extend:`
135
161
  def update_regex
136
- handler_regex = "#{MARKER_START}(#{modifiers.join('|')})#{MARKER_END}"
162
+ handler_regex = "#{MARKER_START}(#{Regexp.union(modifiers.map(&:to_s)).source})#{MARKER_END}"
137
163
  @regex_single = Regexp.new("\\A#{handler_regex}(.*)\\z", Regexp::MULTILINE)
138
- @regex_extend = Regexp.new("\\A(.*)#{handler_regex}([^#{MARKER_IN_END}]*)#{MARKER_IN_END}(.*)\\z", Regexp::MULTILINE)
164
+ @regex_inner = Regexp.new("#{handler_regex}([^#{MARKER_IN_END}]*)#{MARKER_IN_END}")
139
165
  end
140
166
 
141
167
  public
@@ -152,12 +178,19 @@ module Aspera
152
178
  # List of Extended Value methods
153
179
  def modifiers; @handlers.keys; end
154
180
 
155
- # Add a new handler
156
- def on(name, &block)
181
+ # @param name [Symbol] Extended Value method
182
+ # @return [String, nil] description of the method, for shell completion
183
+ def description(name) = @descriptions[name]
184
+
185
+ # Add a new handler, or replace one
186
+ # @param name [Symbol] method, used as `@<name>:`
187
+ # @param description [String, nil] description, for shell completion; `nil` keeps the current one
188
+ def on(name, description: nil, &block)
157
189
  Aspera.assert_type(name, Symbol) { 'name' }
158
190
  Aspera.assert(block) { "block required when registering handler for #{name}" }
159
191
  Log.log.debug { "Setting handler for #{name}" }
160
192
  @handlers[name] = block
193
+ @descriptions[name] = description unless description.nil?
161
194
  update_regex
162
195
  end
163
196
 
@@ -180,36 +213,38 @@ module Aspera
180
213
  handler = m[1].to_sym
181
214
  handlers_reversed.unshift(handler)
182
215
  value = m[2]
183
- break if SPECIAL_HANDLERS.include?(handler)
216
+ # `@val:` keeps the rest as is; `@extend:` too, unless the rest is a single extended value (e.g. `@extend:@file:x`): decoded first, then extended
217
+ break if SPECIAL_HANDLERS.include?(handler) && (handler.eql?(:val) || @regex_inner.match?(value))
184
218
  end
185
- Log.log.trace1 { "evaluating: #{handlers_reversed}, value: #{value.class}:#{value}" }
219
+ Log.log.trace1 { "evaluating: #{handlers_reversed}, value: #{value.class}:#{Secret::Hider.instance.hidden_copy(value)}" }
186
220
  handlers_reversed.each_with_index do |handler, index|
187
221
  Security.instance.check_extended_value(handler)
188
222
  # The value read by the previous handler may be a secret
189
- Security.instance.check_secret_processing("@#{handler}") { SecretHider.instance.contains_secret?(value) } if index.positive?
223
+ Security.instance.check_secret_processing("@#{handler}") { Secret::Hider.instance.contains_secret?(value) } if index.positive?
190
224
  value = @handlers[handler].call(value)
191
225
  # Values read from a secret source are hidden wherever they appear: logs, results
192
226
  if SECRET_HANDLERS.include?(handler)
193
- value.is_a?(String) ? SecretHider.instance.add_secret_values(value) : SecretHider.instance.add_secrets_in(value)
227
+ value.is_a?(String) ? Secret::Hider.instance.add_secret_values(value) : Secret::Hider.instance.add_secrets_in(value)
194
228
  end
195
229
  rescue => e
196
- raise BadArgument, "Evaluation of #{handler} for #{context}: #{e.message}"
230
+ raise BadArgument, "Evaluation of #{MARKER_START}#{handler}#{MARKER_END} for #{context}: #{e.message}"
197
231
  end
198
232
  return value
199
233
  end
200
234
 
201
235
  # Find inner extended values
236
+ # Evaluated values are inserted as is: not evaluated again
202
237
  # Only used in above lambda
203
238
  def evaluate_extend(value)
204
- while (m = value.match(@regex_extend))
205
- sub_value = "@#{m[2]}:#{m[3]}"
239
+ value.gsub(@regex_inner) do
240
+ m = Regexp.last_match
241
+ sub_value = "@#{m[1]}:#{m[2]}"
206
242
  Log.log.debug { "evaluating #{sub_value}" }
207
243
  sub_value = evaluate(sub_value, context: 'composite extended value')
208
244
  # In a text, a secret is not the whole value
209
- Security.instance.check_secret_processing('@extend') { SecretHider.instance.contains_secret?(sub_value) }
210
- value = "#{m[1]}#{sub_value}#{m[4]}"
245
+ Security.instance.check_secret_processing('@extend') { Secret::Hider.instance.contains_secret?(sub_value) }
246
+ sub_value.to_s
211
247
  end
212
- return value
213
248
  end
214
249
  # marker "@"
215
250
  MARKER_START = '@'
@@ -219,7 +254,7 @@ module Aspera
219
254
  MARKER_IN_END = '@'
220
255
 
221
256
  # Special handlers stop processing of handlers on right
222
- # :extend includes processing of other handlers in itself
257
+ # :extend includes processing of other handlers in itself, except if the value on right has no embedded value
223
258
  # :val keeps the value intact
224
259
  SPECIAL_HANDLERS = %i[extend val].freeze
225
260
  # Handlers that read a secret
@@ -1,24 +1,26 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore jsonpp
4
- require 'aspera/schema/registry'
5
- require 'aspera/cli/option_declarator'
6
- require 'aspera/cli/special_values'
7
- require 'aspera/cli/terminal_formatter'
8
- require 'aspera/cli/table_fitter'
9
- require 'aspera/preview/terminal'
10
- require 'aspera/secret_hider'
11
- require 'aspera/environment'
12
- require 'aspera/log'
13
- require 'aspera/assert'
14
- require 'aspera/markdown'
15
- require 'aspera/dot_container'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../schema/registry'
7
+ require_relative 'option_declarator'
8
+ require_relative 'special_values'
9
+ require_relative 'terminal_formatter'
10
+ require_relative 'table_fitter'
11
+ require_relative '../preview/terminal'
12
+ require_relative '../secret/hider'
13
+ require_relative '../environment'
14
+ require_relative '../log'
15
+ require_relative '../assert'
16
+ require_relative '../markdown'
17
+ require_relative '../dot_container'
18
+ require_relative '../rainbow'
16
19
  require 'tty-spinner'
17
20
  require 'json'
18
21
  require 'yaml'
19
22
  require 'pp'
20
23
  require 'csv'
21
- require 'aspera/rainbow'
22
24
  using Rainbow
23
25
 
24
26
  module Aspera
@@ -45,7 +47,7 @@ module Aspera
45
47
  option :out, description: "Output rendering options (dot-notation: #{OUT_SUB_OPTIONS})", schema: Schema::Registry::OUT_OPTIONS
46
48
  option :display, description: 'Output only some information', allowed: DISPLAY_LEVELS, default: :data, deprecation: {last: '4.27.0', message: 'use --out.level'}
47
49
  option :format, description: 'Output format (also: --out.format)', allowed: DISPLAY_FORMATS, default: :table
48
- option :output, description: 'Destination for results', deprecation: {last: '4.27.0', message: 'use --out.file'}
50
+ option :output, description: 'Destination for results', deprecation: {last: '4.27.0', message: 'use --out.file'}, complete: :file, security: :low
49
51
  option :fields, description: "Comma separated list of: fields, or #{SpecialValues::ALL}, or #{SpecialValues::DEF} (also: --out.fields)", allowed: [String, Array, Regexp, Proc], default: SpecialValues::DEF
50
52
  option :select, description: 'Select only some items in lists: column, value (also: --out.select)', allowed: [Hash, Proc]
51
53
  option :table_style, description: '(Table) Display style', allowed: [Hash], deprecation: {last: '4.27.0', message: 'use --out.table'}
@@ -79,6 +81,19 @@ module Aspera
79
81
  end
80
82
  end
81
83
 
84
+ # Check the syntax of a JMESPath expression, e.g. of `--out.query`, before the command is executed
85
+ # @param expression [String] JMESPath expression
86
+ # @param label [String, nil] Name of the option, for the error message
87
+ # @raise [Cli::BadArgument] if the syntax is invalid
88
+ # @return [nil]
89
+ def check_jmespath(expression, label = nil)
90
+ require 'jmespath'
91
+ JMESPath::Parser.new.parse(expression)
92
+ nil
93
+ rescue JMESPath::Errors::SyntaxError => e
94
+ raise Cli::BadArgument, "#{"#{label}: " if label}JMESPath: #{e.message}"
95
+ end
96
+
82
97
  # @param fields [Array<String>] List of fields to not display
83
98
  # @return [Array<String>] List of fields to display, including special values (`ALL`) and tagged (`-`) fields
84
99
  def all_but(*fields)
@@ -200,7 +215,7 @@ module Aspera
200
215
  $stdout = if @output_to_file
201
216
  File.open(value, 'w')
202
217
  else
203
- STDOUT # rubocop:disable Style/GlobalStdStream
218
+ STDOUT
204
219
  end
205
220
  apply_colors
206
221
  when :image
@@ -224,14 +239,7 @@ module Aspera
224
239
  # @param expression [String, Proc, nil] JMESPath expression, or Ruby lambda, or `nil` for none
225
240
  def query=(expression)
226
241
  Aspera.assert_type(expression, String, Proc, NilClass, type: Cli::BadArgument) { 'out.query' }
227
- if expression.is_a?(String)
228
- require 'jmespath'
229
- begin
230
- JMESPath::Parser.new.parse(expression)
231
- rescue JMESPath::Errors::SyntaxError => e
232
- raise Cli::BadArgument, "JMESPath: #{e.message}"
233
- end
234
- end
242
+ self.class.check_jmespath(expression) if expression.is_a?(String)
235
243
  @options[:query] = expression
236
244
  end
237
245
 
@@ -246,7 +254,7 @@ module Aspera
246
254
  # - `:info` messages are only displayed when display level is `:info`
247
255
  # - `:error` messages are always displayed on `stderr`
248
256
  def display_message(message_level, message, hide_secrets: true)
249
- message = SecretHider.instance.hide_secrets_in_string(message) if hide_secrets && message.is_a?(String) && hide_secrets?
257
+ message = Secret::Hider.instance.hide_secrets_in_string(message) if hide_secrets && message.is_a?(String) && hide_secrets?
250
258
  case message_level
251
259
  when :data then $stdout.puts(message) unless @options[:display].eql?(:error)
252
260
  when :info then $stdout.puts(message) if @options[:display].eql?(:info)
@@ -267,7 +275,7 @@ module Aspera
267
275
  # @param data [Object] Data of a result
268
276
  # @return [Object] Copy of data with secrets hidden (by key name, and declared values), or data itself if secrets are shown
269
277
  def hide_secrets(data)
270
- hide_secrets? ? SecretHider.instance.hidden_copy(data) : data
278
+ hide_secrets? ? Secret::Hider.instance.hidden_copy(data) : data
271
279
  end
272
280
 
273
281
  # Display results using the Visitor pattern
@@ -275,7 +283,7 @@ module Aspera
275
283
  # formatter method, eliminating the need for type checking in the formatter.
276
284
  # @param result [Result] Result object to display
277
285
  def display_results(result)
278
- require 'aspera/cli/result'
286
+ require_relative 'result'
279
287
  Aspera.assert_type(result, Cli::Result) { 'result must be a Result object' }
280
288
 
281
289
  Log.log.debug { "display_results: result class=#{result.class.name}" }
@@ -304,7 +312,7 @@ module Aspera
304
312
 
305
313
  # Hide secrets in a string
306
314
  def hide_secrets_in_string(string)
307
- SecretHider.instance.hide_secrets_in_string(string)
315
+ Secret::Hider.instance.hide_secrets_in_string(string)
308
316
  end
309
317
 
310
318
  # Get special format string
@@ -402,7 +410,11 @@ module Aspera
402
410
  raise Cli::BadArgument, "Error in user-provided ruby lambda code during select: #{e.message}"
403
411
  end
404
412
  when Hash
405
- @options[:select].reduce(data) { |items, (k, v)| items.select { |i| i[k].eql?(v) } }
413
+ data.select do |item|
414
+ # Not flattened with a structured format: a dot-path key is looked up in the flattened item, as in a table
415
+ flat = nil
416
+ @options[:select].all? { |k, v| (item.key?(k) ? item[k] : (flat ||= DotContainer.new(item).to_dotted)[k]).eql?(v) }
417
+ end
406
418
  else data
407
419
  end
408
420
  end
@@ -449,12 +461,13 @@ module Aspera
449
461
  def display_table(object_array, fields, single: false)
450
462
  Aspera.assert_array_all(object_array, Hash)
451
463
  Aspera.assert_array_all(fields, String)
464
+ # select before the empty check: no item may remain
465
+ object_array = filter_columns_on_select(object_array)
452
466
  if object_array.empty?
453
467
  # no display for csv
454
468
  display_message(:info, TerminalFormatter.special_format('empty')) if @options[:format].eql?(:table)
455
469
  return
456
470
  end
457
- object_array = filter_columns_on_select(object_array)
458
471
  format_style = @options[:table_style].symbolize_keys
459
472
  string_list_separator = format_style.delete(:str_lst_sep) || STR_LST_SEP_VERT
460
473
  # convert data to string, and keep only display fields
@@ -1,11 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/version'
4
- require 'aspera/cli/info'
5
- require 'aspera/environment'
6
- require 'aspera/persistency_action_once'
7
- require 'aspera/rest'
8
- require 'aspera/log'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'version'
7
+ require_relative 'info'
8
+ require_relative '../environment'
9
+ require_relative '../persistency_action_once'
10
+ require_relative '../rest'
11
+ require_relative '../log'
9
12
  require 'date'
10
13
 
11
14
  module Aspera
@@ -1,13 +1,15 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/transfer/error'
4
- require 'aspera/rest'
5
- require 'aspera/log'
6
- require 'aspera/ssh'
7
- require 'aspera/assert'
8
- require 'aspera/cli/info'
9
- require 'aspera/cli/terminal_formatter'
10
- require 'net/ssh'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../transfer/error'
7
+ require_relative '../rest'
8
+ require_relative '../log'
9
+ require_relative '../ssh'
10
+ require_relative '../assert'
11
+ require_relative 'info'
12
+ require_relative 'terminal_formatter'
11
13
  require 'openssl'
12
14
 
13
15
  module Aspera
@@ -117,6 +119,16 @@ module Aspera
117
119
  'Check your public key in your AoC user profile.'
118
120
  ]
119
121
  },
122
+ {
123
+ exception: StandardError,
124
+ match: /1Password CLI failed.*(not currently signed in|no active session)/m,
125
+ remediation: [
126
+ 'The 1Password CLI (`op`) has no active session',
127
+ 'Check with: op whoami',
128
+ 'Sign in with: eval $(op signin)',
129
+ 'or enable "Integrate with 1Password CLI" in the 1Password desktop application (Settings > Developer)'
130
+ ]
131
+ },
120
132
  {
121
133
  exception: Aspera::Rest::CallError,
122
134
  match: /Please configure ACLs for this URI/,
@@ -124,7 +136,7 @@ module Aspera
124
136
  'server must have: asnodeadmin -mu <node user> --acl-add=internal --internal'
125
137
  ]
126
138
  }
127
- ]
139
+ ].freeze
128
140
  private_constant :ERROR_HINTS
129
141
 
130
142
  class << self
@@ -135,7 +147,7 @@ module Aspera
135
147
  next unless error.is_a?(hint[:exception])
136
148
  message = error.message
137
149
  matches = hint[:match]
138
- matches = [matches] unless matches.is_a?(Array)
150
+ matches = Array(matches)
139
151
  matches.each do |m|
140
152
  case m
141
153
  when String
@@ -1,14 +1,18 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/special_values'
4
- require 'aspera/log'
5
- require 'aspera/assert'
6
- require 'aspera/line_logger'
7
- require 'aspera/schema/registry'
8
- require 'aspera/cli/option_declarator'
9
- require 'aspera/rest'
10
- require 'aspera/oauth/client/factory'
11
- require 'aspera/ssl'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'special_values'
7
+ require_relative '../log'
8
+ require_relative '../assert'
9
+ require_relative '../line_logger'
10
+ require_relative '../units/duration'
11
+ require_relative '../schema/registry'
12
+ require_relative 'option_declarator'
13
+ require_relative '../rest'
14
+ require_relative '../oauth/client/factory'
15
+ require_relative '../ssl'
12
16
  require 'openssl'
13
17
 
14
18
  module Aspera
@@ -24,7 +28,24 @@ module Aspera
24
28
  # OpenSSL constant that disables peer verification (VERIFY_NONE)
25
29
  SELF_SIGNED_CERT = OpenSSL::SSL.const_get(:enon_yfirev.to_s.upcase.reverse) # cspell: disable-line
26
30
 
27
- private_constant :CERT_EXT, :SELF_SIGNED_CERT
31
+ # Keys of `http_options` that are durations in seconds: a number, or a string decoded by {Units::Duration}
32
+ DURATION_KEYS = %i[
33
+ read_timeout write_timeout open_timeout keep_alive_timeout
34
+ retry_sleep
35
+ token_cache_max_age token_refresh_threshold token_refresh_max_age jwt_accepted_offset_sec jwt_expiry_offset_sec
36
+ ].freeze
37
+
38
+ private_constant :CERT_EXT, :SELF_SIGNED_CERT, :DURATION_KEYS
39
+
40
+ class << self
41
+ # @param value [Numeric, String] Duration: number of seconds, or string, e.g. `12h`, `1d`, `1h 30m`, `0.5`
42
+ # @return [Numeric] Number of seconds (integer, unless the string has milliseconds)
43
+ def duration_seconds(value)
44
+ return value if value.is_a?(Numeric)
45
+ milliseconds = Units::Duration.new(value).to_unit('ms')
46
+ (milliseconds % 1000).zero? ? milliseconds / 1000 : milliseconds / 1000.0
47
+ end
48
+ end
28
49
 
29
50
  # `on_set` callbacks are methods of the instance given as `target:` to `declare_options`
30
51
  option :insecure, description: 'HTTP/S: Do not validate any certificate', allowed: Type::BOOLEAN, default: false, on_set: :insecure=
@@ -53,12 +74,19 @@ module Aspera
53
74
  # in @http_options for Net::HTTP session configuration in update_session.
54
75
  # This runs on every assignment (JSON hash, dotted notation, preset merge) so timing
55
76
  # of option parsing never matters.
77
+ # Durations (`DURATION_KEYS`) are converted to seconds first.
56
78
  # @param new_options [Hash] merged http_options hash
57
79
  # @return [nil]
80
+ # @raise [BadArgument] if a duration is invalid
58
81
  def http_options=(new_options)
59
82
  Aspera.assert_type(new_options, Hash)
60
83
  kept = {}
61
84
  new_options.each do |k, v|
85
+ begin
86
+ v = self.class.duration_seconds(v) if DURATION_KEYS.include?(k.to_sym)
87
+ rescue ParameterError => e
88
+ raise BadArgument, "Option http_options: #{k}: #{e.message}"
89
+ end
62
90
  method = "#{k}=".to_sym
63
91
  if Rest::Parameters.instance.respond_to?(method)
64
92
  Rest::Parameters.instance.send(method, v)
@@ -1,5 +1,8 @@
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
  module Info
@@ -8,24 +11,26 @@ module Aspera
8
11
  # Name of the containing gem, same as in <gem name>.gemspec
9
12
  GEM_NAME = 'aspera-cli'
10
13
  DOC_URL = 'https://ibm.biz/ascli-doc'
11
- RUBYDOC_URL = "https://www.rubydoc.info/gems/#{GEM_NAME}"
12
- GEM_URL = "https://rubygems.org/gems/#{GEM_NAME}"
14
+ RUBYDOC_URL = "https://www.rubydoc.info/gems/#{GEM_NAME}".freeze
15
+ GEM_URL = "https://rubygems.org/gems/#{GEM_NAME}".freeze
13
16
  SRC_URL = 'https://github.com/IBM/aspera-cli'
17
+ SITE_URL = 'https://ibm.github.io/aspera-cli/'
18
+ LLMS_URL = "#{SITE_URL}llms.txt".freeze
14
19
  CONTAINER = 'docker.io/martinlaurent/ascli'
15
20
  # Minimum required Ruby version: single reference, used by `required_ruby_version` in gemspec file and by the documentation
16
- # Policy: a Ruby version is supported until 18 months after its end of official support
21
+ # Policy: a Ruby version is supported until 6 months after its end of official support
17
22
  # Consistency with other files: `rake tools:check_ruby`
18
- RUBY_MINIMUM_VERSION = '3.2'
23
+ RUBY_MINIMUM_VERSION = '3.3'
19
24
  # Set this to warn in advance when minimum required ruby version will increase
20
- RUBY_FUTURE_MINIMUM_VERSION = '3.3'
25
+ RUBY_FUTURE_MINIMUM_VERSION = '3.4'
21
26
  # Version with which this version of CLI was tested
22
27
  SDK_VERSION = '1.1.9'
23
28
  # Ruby version with which this version of CLI was tested, packaged in container image and portable packages
24
- RUBY_TESTED_VERSION = '4.0.7'
29
+ RUBY_TESTED_VERSION = '4.0.10'
25
30
  # Suffix of the RubyInstaller release of `RUBY_TESTED_VERSION`, packaged in the Windows zip
26
31
  # (release tag: `RubyInstaller-<Ruby version><suffix>`)
27
32
  # https://github.com/oneclick/rubyinstaller2/releases
28
- WINDOWS_RUBY_INSTALLER_EXT = '-2'
33
+ WINDOWS_RUBY_INSTALLER_EXT = '-1'
29
34
  end
30
35
  end
31
36
  end
@@ -1,8 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/environment'
4
- require 'aspera/log'
5
- require 'aspera/assert'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../environment'
7
+ require_relative '../log'
8
+ require_relative '../assert'
6
9
  require 'erb'
7
10
 
8
11
  module Aspera
@@ -1,11 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore webrick
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
4
5
 
5
- require 'aspera/log'
6
- require 'aspera/servlet_helpers'
7
- require 'aspera/cli/web_secret'
8
- require 'json'
6
+ require_relative '../../log'
7
+ require_relative '../../servlet_helpers'
8
+ require_relative '../web_secret'
9
9
  require 'openssl'
10
10
  require 'stringio'
11
11
  require 'webrick'
@@ -57,6 +57,8 @@ module Aspera
57
57
 
58
58
  def dispatch(req, res)
59
59
  check_request(req, json: JSON_PATHS.include?(req.path), **@allowed)
60
+ # Page opened by the user in a browser (no bearer token), protected by the access code
61
+ return @web_secret.handle(req, res) if req.path.start_with?(WebSecret::PATH_PREFIX)
60
62
  case req.path
61
63
  when '/'
62
64
  # Discovery endpoint (server metadata, no auth required)
@@ -65,9 +67,6 @@ module Aspera
65
67
  when '/oauth/register' then oauth(req, res, :handle_register, post_only: true)
66
68
  when '/oauth/authorize' then oauth(req, res, :handle_authorize)
67
69
  when '/oauth/token' then oauth(req, res, :handle_token, post_only: true)
68
- when ->(path) { path.start_with?(WebSecret::PATH_PREFIX) }
69
- # Page opened by the user in a browser (no bearer token), protected by the access code
70
- @web_secret.handle(req, res)
71
70
  else
72
71
  # All other paths are MCP endpoints: require authorization
73
72
  return unauthorized(res) unless authorized?(req)
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/secret_hider'
4
- require 'aspera/cli/error'
5
- require 'aspera/cli/info'
6
- require 'aspera/cli/web_secret'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../../secret/hider'
7
+ require_relative '../error'
8
+ require_relative '../info'
9
+ require_relative '../web_secret'
7
10
  require 'json'
8
11
 
9
12
  module Aspera
@@ -79,7 +82,7 @@ module Aspera
79
82
  # Clients of protocol 2025-11-25: completion of the out-of-band interaction
80
83
  @server_context.notify_elicitation_complete(elicitation_id: id) unless action.nil? || @server_context.modern?
81
84
  # Never reaches the client, even if displayed by the command
82
- SecretHider.instance.add_secret_values(value)
85
+ Secret::Hider.instance.add_secret_values(value)
83
86
  value
84
87
  end
85
88