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.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/BUGS.md +5 -10
- data/CHANGELOG.md +301 -4
- data/CODE_OF_CONDUCT.md +18 -0
- data/CONTRIBUTING.md +139 -58
- data/GOVERNANCE.md +30 -0
- data/LICENSE +201 -0
- data/README.md +103 -26
- data/SECURITY.md +70 -0
- data/bin/ascli +8 -5
- data/bin/asession +10 -7
- data/docs/README.md +2551 -772
- data/docs/test-mcp-with-ai.md +13 -11
- data/lib/aspera/agent/base.rb +23 -2
- data/lib/aspera/agent/connect.rb +16 -12
- data/lib/aspera/agent/desktop.rb +10 -7
- data/lib/aspera/agent/direct.rb +34 -22
- data/lib/aspera/agent/factory.rb +8 -4
- data/lib/aspera/agent/httpgw.rb +7 -5
- data/lib/aspera/agent/node.rb +15 -7
- data/lib/aspera/agent/transferd.rb +167 -43
- data/lib/aspera/api/alee.rb +4 -1
- data/lib/aspera/api/aoc.rb +14 -11
- data/lib/aspera/api/ats.rb +4 -2
- data/lib/aspera/api/cos_node.rb +8 -5
- data/lib/aspera/api/faspex.rb +16 -9
- data/lib/aspera/api/httpgw.rb +9 -6
- data/lib/aspera/api/node.rb +23 -19
- data/lib/aspera/ascmd.rb +8 -5
- data/lib/aspera/ascp/installation.rb +84 -42
- data/lib/aspera/ascp/log.schema.yaml +1084 -0
- data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
- data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
- data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
- data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
- data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
- data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
- data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
- data/lib/aspera/ascp/log_analyzer.rb +354 -0
- data/lib/aspera/ascp/management.rb +102 -48
- data/lib/aspera/ascp/session_errors.rb +217 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +16 -37
- data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
- data/lib/aspera/cli/async_transfer_store.rb +7 -4
- data/lib/aspera/cli/bootstrapper.rb +37 -34
- data/lib/aspera/cli/command_line.rb +24 -6
- data/lib/aspera/cli/command_registry.rb +49 -4
- data/lib/aspera/cli/command_spec.rb +34 -4
- data/lib/aspera/cli/completion/ascli.bash +53 -5
- data/lib/aspera/cli/completion/ascli.fish +27 -8
- data/lib/aspera/cli/completion/ascli.ps1 +63 -0
- data/lib/aspera/cli/completion/ascli.zsh +36 -4
- data/lib/aspera/cli/completion_actions.rb +594 -0
- data/lib/aspera/cli/context.rb +9 -4
- data/lib/aspera/cli/deprecation.rb +5 -2
- data/lib/aspera/cli/error.rb +45 -0
- data/lib/aspera/cli/extended_value.rb +83 -24
- data/lib/aspera/cli/formatter.rb +142 -73
- data/lib/aspera/cli/gem_checker.rb +9 -6
- data/lib/aspera/cli/hints.rb +22 -11
- data/lib/aspera/cli/http.rb +17 -13
- data/lib/aspera/cli/info.rb +17 -6
- data/lib/aspera/cli/mailer.rb +7 -4
- data/lib/aspera/cli/mcp/http_servlet.rb +155 -0
- data/lib/aspera/cli/mcp/secrets.rb +146 -0
- data/lib/aspera/cli/mcp/tool.rb +232 -0
- data/lib/aspera/cli/option_declarator.rb +10 -4
- data/lib/aspera/cli/option_registry.rb +6 -3
- data/lib/aspera/cli/option_types.rb +17 -2
- data/lib/aspera/cli/option_value.rb +72 -11
- data/lib/aspera/cli/options.schema.yaml +856 -81
- data/lib/aspera/cli/parser.rb +64 -31
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +250 -44
- data/lib/aspera/cli/plugins/ats.rb +9 -8
- data/lib/aspera/cli/plugins/base.rb +51 -25
- data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
- data/lib/aspera/cli/plugins/config.rb +207 -141
- data/lib/aspera/cli/plugins/console.rb +9 -4
- data/lib/aspera/cli/plugins/cos.rb +8 -4
- data/lib/aspera/cli/plugins/factory.rb +22 -8
- data/lib/aspera/cli/plugins/faspex5.rb +37 -44
- data/lib/aspera/cli/plugins/faspio.rb +41 -8
- data/lib/aspera/cli/plugins/httpgw.rb +8 -4
- data/lib/aspera/cli/plugins/mcp.rb +186 -121
- data/lib/aspera/cli/plugins/node.rb +41 -34
- data/lib/aspera/cli/plugins/oauth.rb +5 -1
- data/lib/aspera/cli/plugins/orchestrator.rb +572 -59
- data/lib/aspera/cli/plugins/preview.rb +69 -44
- data/lib/aspera/cli/plugins/server.rb +66 -12
- data/lib/aspera/cli/plugins/shares.rb +288 -48
- data/lib/aspera/cli/plugins/transferd.rb +223 -0
- data/lib/aspera/cli/preset_actions.rb +155 -33
- data/lib/aspera/cli/preset_manager.rb +72 -16
- data/lib/aspera/cli/prompt.rb +7 -2
- data/lib/aspera/cli/result.rb +28 -11
- data/lib/aspera/cli/runner.rb +193 -80
- data/lib/aspera/cli/secret_finder.rb +4 -1
- data/lib/aspera/cli/security.rb +204 -0
- data/lib/aspera/cli/special_values.rb +4 -1
- data/lib/aspera/cli/sync_actions.rb +13 -10
- data/lib/aspera/cli/table_fitter.rb +119 -0
- data/lib/aspera/cli/terminal_formatter.rb +32 -40
- data/lib/aspera/cli/transfer_actions.rb +11 -8
- data/lib/aspera/cli/transfer_agent.rb +31 -19
- data/lib/aspera/cli/transfer_progress.rb +13 -45
- data/lib/aspera/cli/vault_actions.rb +45 -0
- data/lib/aspera/cli/vault_manager.rb +197 -50
- data/lib/aspera/cli/version.rb +4 -1
- data/lib/aspera/cli/web_secret.html.erb +61 -0
- data/lib/aspera/cli/web_secret.rb +222 -0
- data/lib/aspera/cli/wizard.rb +58 -45
- data/lib/aspera/command_line_builder.rb +35 -5
- data/lib/aspera/command_line_converter.rb +4 -1
- data/lib/aspera/coverage.rb +103 -33
- data/lib/aspera/data_repository.rb +42 -25
- data/lib/aspera/dot_container.rb +4 -1
- data/lib/aspera/duration.rb +45 -0
- data/lib/aspera/environment.rb +106 -33
- data/lib/aspera/exec_spec.rb +9 -5
- data/lib/aspera/faspex_gw.rb +105 -35
- data/lib/aspera/faspex_postproc.rb +193 -47
- data/lib/aspera/formatter_interface.rb +4 -2
- data/lib/aspera/graphql.rb +5 -1
- data/lib/aspera/hash_ext.rb +3 -0
- data/lib/aspera/id_generator.rb +6 -3
- data/lib/aspera/json_rpc/client.rb +55 -35
- data/lib/aspera/json_rpc/version.rb +4 -0
- data/lib/aspera/line_logger.rb +4 -1
- data/lib/aspera/link_header.rb +4 -1
- data/lib/aspera/log.rb +20 -10
- data/lib/aspera/markdown.rb +155 -115
- data/lib/aspera/mime.rb +9 -0
- data/lib/aspera/nagios.rb +9 -5
- data/lib/aspera/node_emulator.rb +111 -112
- data/lib/aspera/oauth/client/base.rb +163 -0
- data/lib/aspera/oauth/{boot.rb → client/boot.rb} +8 -4
- data/lib/aspera/oauth/{factory.rb → client/factory.rb} +13 -3
- data/lib/aspera/oauth/{generic.rb → client/generic.rb} +5 -1
- data/lib/aspera/oauth/{json_credentials.rb → client/json_credentials.rb} +4 -1
- data/lib/aspera/oauth/{jwt.rb → client/jwt.rb} +6 -3
- data/lib/aspera/oauth/client/shares_web.rb +85 -0
- data/lib/aspera/oauth/{url_json.rb → client/url_json.rb} +4 -1
- data/lib/aspera/oauth/client/web.rb +84 -0
- data/lib/aspera/oauth/server/authorize.html.erb +34 -0
- data/lib/aspera/oauth/server/pkce.rb +427 -0
- data/lib/aspera/orchestrator_workflow_checker.rb +679 -0
- data/lib/aspera/persistency_action_once.rb +5 -3
- data/lib/aspera/persistency_folder.rb +6 -3
- data/lib/aspera/preview/file_types.rb +6 -3
- data/lib/aspera/preview/generator.rb +9 -5
- data/lib/aspera/preview/options.schema.yaml +3 -3
- data/lib/aspera/preview/terminal.rb +11 -6
- data/lib/aspera/preview/utils.rb +6 -4
- data/lib/aspera/products/connect.rb +5 -2
- data/lib/aspera/products/desktop.rb +4 -1
- data/lib/aspera/products/other.rb +4 -2
- data/lib/aspera/products/transferd.rb +6 -2
- data/lib/aspera/products/transferd_service.rb +610 -0
- data/lib/aspera/proxy_auto_config.js +2 -2
- data/lib/aspera/proxy_auto_config.rb +5 -2
- data/lib/aspera/rainbow.rb +30 -1
- data/lib/aspera/rest/aspera_errors.rb +55 -60
- data/lib/aspera/rest/call_error.rb +3 -0
- data/lib/aspera/rest/client.rb +42 -42
- data/lib/aspera/rest/error_analyzer.rb +14 -2
- data/lib/aspera/rest/list.rb +14 -10
- data/lib/aspera/rest/parameters.rb +3 -0
- data/lib/aspera/rest/util.rb +13 -4
- data/lib/aspera/rest.rb +9 -7
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -11
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +4089 -0
- data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0-enhanced.yaml +1097 -0
- data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
- data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
- data/lib/aspera/schema/IBM_Aspera_Shares.yaml +819 -7
- data/lib/aspera/schema/async_tables.yaml +11 -10
- data/lib/aspera/schema/documentation.rb +56 -78
- data/lib/aspera/schema/reader.rb +46 -11
- data/lib/aspera/schema/registry.rb +45 -24
- data/lib/aspera/schema/transferd-config.schema.json +333 -0
- data/lib/aspera/schema/validator.rb +4 -1
- data/lib/aspera/sealed_hash.rb +166 -0
- data/lib/aspera/secret/hider.rb +201 -0
- data/lib/aspera/secret/reference.rb +150 -0
- data/lib/aspera/secret/resolver.rb +212 -0
- data/lib/aspera/secret/store/base.rb +153 -0
- data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
- data/lib/aspera/secret/store/factory.rb +103 -0
- data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
- data/lib/aspera/secret/store/keeper.rb +141 -0
- data/lib/aspera/secret/store/macos_security.rb +284 -0
- data/lib/aspera/secret/store/one_password_api.rb +99 -0
- data/lib/aspera/secret/store/one_password_base.rb +42 -0
- data/lib/aspera/secret/store/one_password_cli.rb +110 -0
- data/lib/aspera/secret/store/secret_service.rb +125 -0
- data/lib/aspera/secret/strength.rb +119 -0
- data/lib/aspera/servlet_helpers.rb +114 -0
- data/lib/aspera/ssh.rb +10 -7
- data/lib/aspera/ssl.rb +5 -2
- data/lib/aspera/string_ext.rb +3 -0
- data/lib/aspera/sync/args.schema.yaml +6 -1
- data/lib/aspera/sync/conf.schema.yaml +25 -10
- data/lib/aspera/sync/database.rb +3 -0
- data/lib/aspera/sync/operations.rb +34 -12
- data/lib/aspera/temp_file_manager.rb +85 -22
- data/lib/aspera/timer_limiter.rb +3 -0
- data/lib/aspera/transfer/error.rb +4 -1
- data/lib/aspera/transfer/faux_file.rb +4 -1
- data/lib/aspera/transfer/parameters.rb +22 -14
- data/lib/aspera/transfer/result.rb +3 -0
- data/lib/aspera/transfer/resumer.rb +6 -4
- data/lib/aspera/transfer/spec.rb +45 -18
- data/lib/aspera/transfer/spec.schema.yaml +8 -5
- data/lib/aspera/transfer/units.rb +75 -0
- data/lib/aspera/uri_reader.rb +57 -7
- data/lib/aspera/web_auth/index.html.erb +20 -0
- data/lib/aspera/web_auth/paste.rb +109 -0
- data/lib/aspera/web_auth/receiver.rb +50 -0
- data/lib/aspera/web_auth/relay.rb +76 -0
- data/lib/aspera/web_auth/reply.html.erb +150 -0
- data/lib/aspera/web_auth/server.rb +59 -14
- data/lib/aspera/web_page.html.erb +262 -0
- data/lib/aspera/web_page.rb +66 -0
- data/lib/aspera/web_server_simple.rb +82 -13
- data/lib/aspera/yaml.rb +5 -1
- data/llms.txt +81 -0
- data/skills/ascli/SKILL.md +88 -0
- data.tar.gz.sig +0 -0
- metadata +116 -48
- metadata.gz.sig +0 -0
- data/lib/aspera/cli/mcp_tool.rb +0 -189
- data/lib/aspera/keychain/base.rb +0 -25
- data/lib/aspera/keychain/encrypted_hash.rb +0 -188
- data/lib/aspera/keychain/factory.rb +0 -59
- data/lib/aspera/keychain/hashicorp_vault.rb +0 -74
- data/lib/aspera/keychain/macos_security.rb +0 -171
- data/lib/aspera/keychain/one_password_api.rb +0 -86
- data/lib/aspera/keychain/one_password_base.rb +0 -34
- data/lib/aspera/keychain/one_password_cli.rb +0 -98
- data/lib/aspera/oauth/base.rb +0 -141
- data/lib/aspera/oauth/web.rb +0 -57
- data/lib/aspera/oauth.rb +0 -9
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +0 -1784
- data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml +0 -249
- data/lib/aspera/secret_hider.rb +0 -117
- data/lib/aspera/web_auth/index.html +0 -147
|
@@ -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
|
-
|
|
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 =
|
|
232
|
+
rate_text = Transfer::Units.format_rate(bytes_per_second).rjust(11)
|
|
265
233
|
if total.nil?
|
|
266
|
-
fields.push(
|
|
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: #{
|
|
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(
|
|
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,61 +1,208 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
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
|
-
#
|
|
11
|
-
#
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
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))
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
|
|
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
|
|
70
|
+
end
|
|
71
|
+
|
|
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?
|
|
79
|
+
end
|
|
80
|
+
|
|
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)
|
|
86
|
+
# Label may contain dots (e.g. preset name)
|
|
87
|
+
label, _, param = name.rpartition('.')
|
|
88
|
+
Aspera.assert(!label.empty? && !param.empty?, type: BadArgument) { 'vault name shall match <name>.<param>' }
|
|
89
|
+
info = store(mandatory: true).get(label: label)
|
|
90
|
+
value = info[param.to_sym]
|
|
91
|
+
raise "no such entry value: #{param}" if value.nil?
|
|
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 []
|
|
18
200
|
end
|
|
19
201
|
end
|
|
20
202
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
v.delete(label: label, **kwargs)
|
|
25
|
-
Result::Status.new("Secret deleted: #{label}")
|
|
26
|
-
end
|
|
27
|
-
|
|
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
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# @return [String] value from vault matching <name>.<param>
|
|
35
|
-
def vault_value(name)
|
|
36
|
-
m = name.split('.')
|
|
37
|
-
Aspera.assert(m.length.eql?(2), type: BadArgument) { 'vault name shall match <name>.<param>' }
|
|
38
|
-
info = vault_required.get(label: m[0])
|
|
39
|
-
value = info[m[1].to_sym]
|
|
40
|
-
raise "no such entry value: #{m[1]}" if value.nil?
|
|
41
|
-
return value
|
|
42
|
-
end
|
|
43
|
-
|
|
44
|
-
# @return [Keychain::Base, nil] vault instance, lazily created from options, or nil if not configured
|
|
45
|
-
def vault
|
|
46
|
-
return @vault_instance if @vault_instance_initialized
|
|
47
|
-
@vault_instance_initialized = true
|
|
48
|
-
info = options.get_option(:vault, mandatory: false)
|
|
49
|
-
return @vault_instance = nil if info.nil? || (info.is_a?(Hash) && info.empty?)
|
|
50
|
-
info = info.symbolize_keys
|
|
51
|
-
info[:type] ||= 'file'
|
|
52
|
-
require 'aspera/keychain/factory'
|
|
53
|
-
@vault_instance = Keychain::Factory.create(
|
|
54
|
-
info,
|
|
55
|
-
Info::CMD_NAME,
|
|
56
|
-
context.main_folder,
|
|
57
|
-
options.get_option(:vault_password)
|
|
58
|
-
)
|
|
203
|
+
# @return [String] Reference `secret://...` of value of `@vault://...`
|
|
204
|
+
def reference_text(name)
|
|
205
|
+
"#{Secret::SCHEME}#{name.delete_prefix(REFERENCE_PREFIX)}"
|
|
59
206
|
end
|
|
60
207
|
end
|
|
61
208
|
end
|
data/lib/aspera/cli/version.rb
CHANGED
|
@@ -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.
|
|
10
|
+
VERSION = '4.29.0'
|
|
8
11
|
end
|
|
9
12
|
end
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
<%# Content of the secret page, in layout of Aspera::WebPage %>
|
|
2
|
+
<% if state.eql?(:form) %>
|
|
3
|
+
<div class="icon-circle">
|
|
4
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="28" height="28" viewBox="0 0 32 32" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round">
|
|
5
|
+
<rect x="6" y="13" width="20" height="15" rx="3"/>
|
|
6
|
+
<path d="M10 13V9a6 6 0 0 1 12 0v4"/>
|
|
7
|
+
<circle cx="16" cy="20.5" r="2" fill="currentColor"/>
|
|
8
|
+
</svg>
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
<h1>Secret request</h1>
|
|
12
|
+
<% if requester %>
|
|
13
|
+
<p><%= h name %> needs the secret <span class="client"><%= h prompt %></span> to execute a command requested by the <%= h requester %>.</p>
|
|
14
|
+
<p>The secret is sent to <%= h name %> only: the <%= h requester %> does not see it.</p>
|
|
15
|
+
<% else %>
|
|
16
|
+
<p><%= h name %> needs the secret <span class="client"><%= h prompt %></span> to execute your command.</p>
|
|
17
|
+
<% end %>
|
|
18
|
+
<% if error %>
|
|
19
|
+
<p class="error"><%= h error %></p>
|
|
20
|
+
<% end %>
|
|
21
|
+
|
|
22
|
+
<form method="POST" action="<%= h action_url %>">
|
|
23
|
+
<% if access_code_required %>
|
|
24
|
+
<label class="secret">Server access code
|
|
25
|
+
<input type="password" name="access_code" autocomplete="off" required autofocus>
|
|
26
|
+
</label>
|
|
27
|
+
<% end %>
|
|
28
|
+
<label class="secret">Secret: <%= h prompt %>
|
|
29
|
+
<input type="password" name="secret" autocomplete="off" required<%= ' autofocus' unless access_code_required %>>
|
|
30
|
+
</label>
|
|
31
|
+
<div class="actions">
|
|
32
|
+
<button class="allow" type="submit" name="decision" value="submit">Submit</button>
|
|
33
|
+
<button class="deny" type="submit" name="decision" value="cancel" formnovalidate>Cancel</button>
|
|
34
|
+
</div>
|
|
35
|
+
</form>
|
|
36
|
+
<% elsif state.eql?(:received) %>
|
|
37
|
+
<div class="icon-circle ok">
|
|
38
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 32 32" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round">
|
|
39
|
+
<polyline points="6 16 13 23 26 9"/>
|
|
40
|
+
</svg>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<h1>Secret received</h1>
|
|
44
|
+
<p>You can close this window and return to your <%= h(requester || 'terminal') %>.</p>
|
|
45
|
+
<% else %>
|
|
46
|
+
<div class="icon-circle ko">
|
|
47
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="28" height="28" viewBox="0 0 32 32" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round">
|
|
48
|
+
<line x1="9" y1="9" x2="23" y2="23"/>
|
|
49
|
+
<line x1="23" y1="9" x2="9" y2="23"/>
|
|
50
|
+
</svg>
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
<% if state.eql?(:cancelled) %>
|
|
54
|
+
<h1>Secret request cancelled</h1>
|
|
55
|
+
<p>The command will fail. You can close this window and return to your <%= h(requester || 'terminal') %>.</p>
|
|
56
|
+
<% else %>
|
|
57
|
+
<h1>Unknown secret request</h1>
|
|
58
|
+
<p>This request is unknown, expired, or already answered.</p>
|
|
59
|
+
<% end %>
|
|
60
|
+
<% end %>
|
|
61
|
+
|