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
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative 'base'
|
|
7
|
+
require_relative '../info'
|
|
8
|
+
require_relative '../special_values'
|
|
9
|
+
require_relative '../../ascp/installation'
|
|
10
|
+
require_relative '../../products/transferd_service'
|
|
11
|
+
require_relative '../../schema/documentation'
|
|
12
|
+
require_relative '../../log'
|
|
13
|
+
require_relative '../../assert'
|
|
14
|
+
|
|
15
|
+
module Aspera
|
|
16
|
+
module Cli
|
|
17
|
+
module Plugins
|
|
18
|
+
# Install the Transfer Daemon (`transferd`), run it as a system service, and query a running daemon
|
|
19
|
+
class Transferd < Base
|
|
20
|
+
application_name 'Transfer Daemon'
|
|
21
|
+
|
|
22
|
+
class << self
|
|
23
|
+
# Seam for the client commands: object that gives `info(params)`, `transfer_status(id, params)` and `transfer_cancel(id, params)`,
|
|
24
|
+
# with `params` a Hash with `url`, and optional `api_key`, `ca_file`.
|
|
25
|
+
# `nil` (default): `Agent::Transferd`, loaded on first use, because it requires the optional gem `grpc`.
|
|
26
|
+
# @return [#info, #transfer_status, #transfer_cancel, nil]
|
|
27
|
+
attr_accessor :daemon_client
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
command :install, description: 'Install the transfer daemon',
|
|
31
|
+
arguments: [{name: :version, mandatory: false, default: nil}]
|
|
32
|
+
command :list, description: 'List available SDK locations'
|
|
33
|
+
command :service, description: 'Manage the transfer daemon as a system service'
|
|
34
|
+
commands_under :service do
|
|
35
|
+
service_config_arg = {name: :config, type: Hash, mandatory: false, default: {}, schema: Schema::Registry::TRANSFERD_SERVICE_CONFIG}
|
|
36
|
+
command(
|
|
37
|
+
:spec, description: 'Show the transfer daemon configuration schema',
|
|
38
|
+
action: lambda do |**|
|
|
39
|
+
builder = Schema::Documentation.new(TerminalFormatter, Schema::Registry.instance.reader('transferd')).build
|
|
40
|
+
Result::ObjectList.new(builder.rows, fields: builder.columns)
|
|
41
|
+
end
|
|
42
|
+
)
|
|
43
|
+
command(
|
|
44
|
+
:install, description: 'Install the SDK if needed, then configure and start the service',
|
|
45
|
+
arguments: [service_config_arg],
|
|
46
|
+
action: ->(config:, **) { transferd_service_install(config) }
|
|
47
|
+
)
|
|
48
|
+
command(
|
|
49
|
+
:configure, description: 'Configure the transfer daemon service',
|
|
50
|
+
arguments: [service_config_arg],
|
|
51
|
+
action: lambda do |config:, **|
|
|
52
|
+
transferd_service do |host, sdk_folder, dry_run|
|
|
53
|
+
steps = Products::TransferdService.configure(config, sdk_folder, host: host, dry_run: dry_run)
|
|
54
|
+
Products::TransferdService.check_version(sdk_folder, host: host)
|
|
55
|
+
transferd_service_steps(steps)
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
)
|
|
59
|
+
command(
|
|
60
|
+
:status, description: 'Show the state of the service (the API key is not shown)',
|
|
61
|
+
arguments: [service_config_arg],
|
|
62
|
+
action: lambda do |config:, **|
|
|
63
|
+
transferd_service { |host, sdk_folder, _dry_run| Result::SingleObject.new(Products::TransferdService.status(config, sdk_folder, host: host)) }
|
|
64
|
+
end
|
|
65
|
+
)
|
|
66
|
+
command(
|
|
67
|
+
:uninstall, description: 'Stop and remove the service (service.purge: also remove configuration and logs)',
|
|
68
|
+
arguments: [service_config_arg],
|
|
69
|
+
action: lambda do |config:, **|
|
|
70
|
+
transferd_service do |host, _sdk_folder, dry_run|
|
|
71
|
+
purge = Products::TransferdService.service_options(config)['purge'].eql?(true)
|
|
72
|
+
transferd_service_steps(Products::TransferdService.uninstall(config, host: host, dry_run: dry_run, purge: purge))
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
)
|
|
76
|
+
command(
|
|
77
|
+
:use, description: 'Use an installed version of the SDK (SDK folder named current), and restart the service',
|
|
78
|
+
arguments: [{name: :version}, service_config_arg],
|
|
79
|
+
action: lambda do |version:, config:, **|
|
|
80
|
+
transferd_service do |host, sdk_folder, dry_run|
|
|
81
|
+
transferd_service_steps(Products::TransferdService.use(config, sdk_folder, version, host: host, dry_run: dry_run))
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
)
|
|
85
|
+
command(
|
|
86
|
+
:versions, description: 'List the installed versions of the SDK (SDK folder named current)',
|
|
87
|
+
action: lambda do |**|
|
|
88
|
+
sdk_folder = options.get_option(:sdk_folder, mandatory: true)
|
|
89
|
+
Result::ObjectList.new(Products::TransferdService.versions(sdk_folder), fields: %w[version folder current])
|
|
90
|
+
end
|
|
91
|
+
)
|
|
92
|
+
end
|
|
93
|
+
command :info, description: 'Show information on a running daemon',
|
|
94
|
+
action: ->(**) { Result::SingleObject.new(daemon_client.info(daemon_params)) }
|
|
95
|
+
command :transfers, description: 'Query the transfers of a running daemon'
|
|
96
|
+
commands_under :transfers do
|
|
97
|
+
command(
|
|
98
|
+
:show, description: 'Show the status of a transfer (the daemon keeps it for some time after its end)',
|
|
99
|
+
arguments: [{name: :transfer_id}],
|
|
100
|
+
action: ->(transfer_id:, **) { Result::SingleObject.new(daemon_client.transfer_status(transfer_id, daemon_params)) }
|
|
101
|
+
)
|
|
102
|
+
command(
|
|
103
|
+
:cancel, description: 'Stop a transfer',
|
|
104
|
+
arguments: [{name: :transfer_id}],
|
|
105
|
+
action: lambda do |transfer_id:, **|
|
|
106
|
+
daemon_client.transfer_cancel(transfer_id, daemon_params)
|
|
107
|
+
Result::Status.new("Transfer #{transfer_id} stopped")
|
|
108
|
+
end
|
|
109
|
+
)
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
option :url, description: 'Client commands: endpoint of the running daemon, e.g. 127.0.0.1:55002'
|
|
113
|
+
option :api_key, description: 'Client commands: API key of the daemon, if its authentication is enabled'
|
|
114
|
+
option :ca_file, description: 'Client commands: certificate authority (PEM file) of the daemon, if its TLS is enabled'
|
|
115
|
+
|
|
116
|
+
# Install the transfer SDK (ascp + transferd) from a URL or using the default source.
|
|
117
|
+
# Version defaults to `Info::SDK_VERSION`; pass `LATEST` as argument to install the latest available version.
|
|
118
|
+
# Nothing is done if this version is already installed in the SDK folder (not checked if option `sdk_url` is set).
|
|
119
|
+
# Also called by the deprecated command `config ascp install`.
|
|
120
|
+
# @param version [String, nil] version to install; nil means use the default SDK version
|
|
121
|
+
# @return [Result::Status] installation result message
|
|
122
|
+
def action_install(version: nil, **)
|
|
123
|
+
asked_version = version.nil? ? Info::SDK_VERSION : version
|
|
124
|
+
asked_version = nil if asked_version.eql?(SpecialValues::LATEST)
|
|
125
|
+
installation = Ascp::Installation.instance
|
|
126
|
+
url = sdk_url_option
|
|
127
|
+
if url.nil?
|
|
128
|
+
wanted_version = installation.sdk_location_for_platform(version: asked_version)['version']
|
|
129
|
+
return Result::Status.new("Version #{wanted_version} is already installed in #{Products::Transferd.sdk_directory}") if installation.installed_sdk_version.eql?(wanted_version)
|
|
130
|
+
end
|
|
131
|
+
name, ver, folder = installation.install_sdk(url: url, version: asked_version)
|
|
132
|
+
return Result::Status.new("Installed #{name} version #{ver} in #{folder}")
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# @return [Result::ObjectList] The SDK locations
|
|
136
|
+
def action_list(**)
|
|
137
|
+
sdk_list = Ascp::Installation.instance.sdk_locations
|
|
138
|
+
Result::ObjectList.new(sdk_list, fields: sdk_list.first.keys - ['url'])
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
private
|
|
142
|
+
|
|
143
|
+
# @return [#info, #transfer_status, #transfer_cancel] The client of the daemon
|
|
144
|
+
# @raise [Cli::Error] if the optional gem `grpc` is missing
|
|
145
|
+
def daemon_client
|
|
146
|
+
injected = self.class.daemon_client
|
|
147
|
+
return injected unless injected.nil?
|
|
148
|
+
begin
|
|
149
|
+
require_relative '../../agent/transferd'
|
|
150
|
+
rescue LoadError => e
|
|
151
|
+
raise Cli::Error, "Commands that query a running daemon require the gem grpc (#{e.message}). Install it with: gem install grpc"
|
|
152
|
+
end
|
|
153
|
+
Agent::Transferd
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# Parameters of the connection to the daemon: option `url` is mandatory, `api_key` and `ca_file` are optional.
|
|
157
|
+
# Options `url`, `api_key` and `ca_file` have priority, else the same keys of option `transfer` are used, if its agent is `transferd`.
|
|
158
|
+
# @return [Hash]
|
|
159
|
+
def daemon_params
|
|
160
|
+
from_transfer = transfer_agent_params
|
|
161
|
+
params = %w[url api_key ca_file].to_h { |key| [key, options.get_option(key.to_sym) || from_transfer[key]] }.compact
|
|
162
|
+
Aspera.assert(params.key?('url'), type: Cli::BadArgument) do
|
|
163
|
+
"Missing option #{Parser.option_name_to_line(:url)} (or #{Parser.option_name_to_line(:transfer)} with agent transferd and key url)"
|
|
164
|
+
end
|
|
165
|
+
return params
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# @return [Hash] Keys `url`, `api_key`, `ca_file` of option `transfer`, only if its agent is `transferd`, else empty
|
|
169
|
+
def transfer_agent_params
|
|
170
|
+
transfer_options = transfer.transfer_options
|
|
171
|
+
return {} unless transfer_options['agent'].to_s.eql?('transferd')
|
|
172
|
+
return transfer_options.slice('url', 'api_key', 'ca_file')
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# @return [String, nil] Value of option `sdk_url`, or nil to select the archive from the SDK locations (`DEF`)
|
|
176
|
+
def sdk_url_option
|
|
177
|
+
sdk_url = options.get_option(:sdk_url, mandatory: true)
|
|
178
|
+
return sdk_url.eql?(SpecialValues::DEF) ? nil : sdk_url
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# Common processing of the commands of `transferd service` that act on the system.
|
|
182
|
+
# Refuses to run if the system is not supported or the user is not root, unless `--dry-run=yes`.
|
|
183
|
+
# @yieldparam host [Products::TransferdService::Host] Access to the system
|
|
184
|
+
# @yieldparam sdk_folder [String] Option `sdk_folder`, or link `current` of the layout
|
|
185
|
+
# @yieldparam dry_run [Boolean] Option `dry_run`
|
|
186
|
+
def transferd_service
|
|
187
|
+
host = Products::TransferdService::Host.new
|
|
188
|
+
dry_run = options.get_option(:dry_run)
|
|
189
|
+
Products::TransferdService.assert_supported(host, dry_run: dry_run)
|
|
190
|
+
sdk_folder = options.get_option(:sdk_folder, mandatory: true)
|
|
191
|
+
Aspera.assert(!Ascp::Installation.product_selector?(sdk_folder), type: Cli::BadArgument) { 'The service requires a SDK folder, not a product' }
|
|
192
|
+
yield(host, sdk_folder, dry_run)
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
# @param steps [Array<String>] Actions done, or to do with `--dry-run=yes`
|
|
196
|
+
# @return [Result] The list of actions, or a message if there is nothing to do
|
|
197
|
+
def transferd_service_steps(steps)
|
|
198
|
+
steps.empty? ? Result::Status.new('Nothing to do') : Result::ValueList.new(steps, name: 'action')
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# Implementation of `transferd service install`
|
|
202
|
+
# With the layout (SDK folder named `current`), the SDK is installed in a folder of the version, next to the link.
|
|
203
|
+
# @param config [Hash] `CONFIG`
|
|
204
|
+
def transferd_service_install(config)
|
|
205
|
+
transferd_service do |host, sdk_folder, dry_run|
|
|
206
|
+
version = Products::TransferdService.service_options(config)['version'] || Info::SDK_VERSION
|
|
207
|
+
sdk_url = sdk_url_option
|
|
208
|
+
installation = Ascp::Installation.instance
|
|
209
|
+
install_sdk =
|
|
210
|
+
if Products::TransferdService.layout?(sdk_folder)
|
|
211
|
+
->(folder) { installation.install_sdk(url: sdk_url, version: version, folder: folder) }
|
|
212
|
+
else
|
|
213
|
+
-> { installation.install_sdk(url: sdk_url, version: version) }
|
|
214
|
+
end
|
|
215
|
+
steps = Products::TransferdService.install(config, sdk_folder, host: host, dry_run: dry_run, install_sdk: install_sdk, version: version)
|
|
216
|
+
Products::TransferdService.check_version(sdk_folder, host: host)
|
|
217
|
+
transferd_service_steps(steps)
|
|
218
|
+
end
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
end
|
|
222
|
+
end
|
|
223
|
+
end
|
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative '../assert'
|
|
7
|
+
require_relative '../dot_container'
|
|
8
|
+
require_relative '../hash_ext'
|
|
9
|
+
require_relative '../secret/hider'
|
|
10
|
+
require_relative 'security'
|
|
11
|
+
require_relative 'preset_manager'
|
|
12
|
+
require_relative 'deprecation'
|
|
13
|
+
require_relative 'info'
|
|
14
|
+
require 'json'
|
|
5
15
|
|
|
6
16
|
module Aspera
|
|
7
17
|
module Cli
|
|
@@ -11,12 +21,16 @@ module Aspera
|
|
|
11
21
|
GLOBAL_DEFAULT_KEYWORD = 'GLOBAL'
|
|
12
22
|
# Display columns for preset overview
|
|
13
23
|
CONF_OVERVIEW_KEYS = %w[preset parameter value].freeze
|
|
24
|
+
# Keys of the criteria for preset lookup
|
|
25
|
+
LOOKUP_KEYS = %w[url username].freeze
|
|
26
|
+
# Last released version without deprecation of preset commands `update`, `initialize` and `unset`
|
|
27
|
+
PRESET_DEPRECATED_LAST = '4.28.0'
|
|
28
|
+
# Default of an argument not given (`omit_absent`), different from `nil` (`@none:`)
|
|
29
|
+
NOT_GIVEN = Object.new.freeze
|
|
14
30
|
|
|
15
31
|
def action_preset_overview(**)
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
data = PresetManager.deep_clone(cp)
|
|
19
|
-
formatter.hide_secrets(data)
|
|
32
|
+
# Secrets hidden by key name here: the key becomes the value of column `parameter`
|
|
33
|
+
data = formatter.hide_secrets(presets.config_presets)
|
|
20
34
|
result = []
|
|
21
35
|
data.each do |config, preset|
|
|
22
36
|
preset.each do |parameter, value|
|
|
@@ -26,11 +40,10 @@ module Aspera
|
|
|
26
40
|
Result::ObjectList.new(result, fields: CONF_OVERVIEW_KEYS)
|
|
27
41
|
end
|
|
28
42
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
result = presets.lookup_preset(url: url, username: user)
|
|
43
|
+
# @param criteria [Hash] `url` and `username` of the preset to find
|
|
44
|
+
def action_preset_lookup(criteria:, **)
|
|
45
|
+
Aspera.assert((criteria.keys - LOOKUP_KEYS).empty? && (LOOKUP_KEYS - criteria.keys).empty?, type: BadArgument) { "Expected keys: #{LOOKUP_KEYS.join(', ')}" }
|
|
46
|
+
result = presets.lookup_preset(url: criteria['url'], username: criteria['username'])
|
|
34
47
|
Aspera.assert(!result.nil?, type: Error) { 'no such config found' }
|
|
35
48
|
Result::SingleObject.new(result)
|
|
36
49
|
end
|
|
@@ -65,6 +78,21 @@ module Aspera
|
|
|
65
78
|
# @param preset [Hash] the preset hash (modified in place)
|
|
66
79
|
# @param preset_name [String] name used as base for the vault label
|
|
67
80
|
# @param option_name [String] option key to inspect
|
|
81
|
+
# A preset is evaluated when used, maybe at a lower security level (e.g. on the command line): it cannot hold what the current level refuses.
|
|
82
|
+
# @param param_name [String, Symbol] Option name, or dot-path in an option (e.g. `ui.command`)
|
|
83
|
+
# @param param_value [Object] Value to store
|
|
84
|
+
# @raise [BadArgument] If the option, a sub-option (`x-security` in schema), or the value, is refused at current security level
|
|
85
|
+
def check_preset_entry(param_name, param_value)
|
|
86
|
+
path = param_name.to_s.tr('-', '_').split(DotContainer::SEPARATOR)
|
|
87
|
+
option_name = path.first.to_sym
|
|
88
|
+
if options.option_declared?(option_name)
|
|
89
|
+
# Value of the option, from the sub-option given by dot-path
|
|
90
|
+
option_value = path.drop(1).reverse.inject(param_value) { |value, key| {key => value} }
|
|
91
|
+
options.option_def(option_name).check_security(option_value)
|
|
92
|
+
end
|
|
93
|
+
Security.instance.check_stored_value(param_value, "preset option #{option_name}")
|
|
94
|
+
end
|
|
95
|
+
|
|
68
96
|
def secure_preset_option(preset, preset_name, option_name)
|
|
69
97
|
return unless SECRET_KEYWORDS.any? { |kw| option_name.end_with?(kw) }
|
|
70
98
|
# Vault password is not saved in vault
|
|
@@ -83,7 +111,7 @@ module Aspera
|
|
|
83
111
|
incr += 1
|
|
84
112
|
end
|
|
85
113
|
Log.log.info { "Securing #{preset_name}.#{option_name} -> vault label: #{vault_label}" }
|
|
86
|
-
vault.set({label: vault_label, password: value})
|
|
114
|
+
vault.set({label: vault_label, password: value}) # HashiCorpIgnore
|
|
87
115
|
preset[option_name] = "@vault:#{vault_label}.password"
|
|
88
116
|
end
|
|
89
117
|
|
|
@@ -93,20 +121,13 @@ module Aspera
|
|
|
93
121
|
name = preset_name(name)
|
|
94
122
|
cp = presets.config_presets
|
|
95
123
|
raise Cli::BadArgument, "no such preset: #{name}" unless cp.key?(name)
|
|
96
|
-
Result::SingleObject.new(
|
|
124
|
+
Result::SingleObject.new(cp[name])
|
|
97
125
|
end
|
|
98
126
|
|
|
99
127
|
def action_preset_delete(name:, **)
|
|
100
128
|
name = preset_name(name)
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
cp.delete(name)
|
|
104
|
-
# Remove default declarations referring to the deleted preset
|
|
105
|
-
defaults = cp[PresetManager::Key::DEFAULTS]
|
|
106
|
-
defaults&.select { |_, preset_name| preset_name.eql?(name) }&.each_key do |plugin|
|
|
107
|
-
defaults.delete(plugin)
|
|
108
|
-
Log.log.info { "Removed: #{PresetManager::Key::DEFAULTS}: #{plugin}" }
|
|
109
|
-
end
|
|
129
|
+
raise Cli::BadArgument, "no such preset: #{name}" unless presets.config_presets.key?(name)
|
|
130
|
+
delete_preset(name)
|
|
110
131
|
Result::Status.new("Deleted: #{name}")
|
|
111
132
|
end
|
|
112
133
|
|
|
@@ -117,12 +138,17 @@ module Aspera
|
|
|
117
138
|
value = cp[name][param_name]
|
|
118
139
|
raise Cli::BadArgument, "no such option in preset #{name}: #{param_name}" if value.nil?
|
|
119
140
|
case value
|
|
120
|
-
when Numeric, String
|
|
141
|
+
when Numeric, String
|
|
142
|
+
value = ExtendedValue.instance.evaluate(value.to_s, context: 'preset')
|
|
143
|
+
# A secret has no key name in a text result: declared, so that it is hidden
|
|
144
|
+
Secret::Hider.instance.add_secret_values(value) if Secret::Hider.instance.secret?(param_name, value)
|
|
145
|
+
return Result::Text.new(value)
|
|
121
146
|
end
|
|
122
147
|
Result::SingleObject.new(value)
|
|
123
148
|
end
|
|
124
149
|
|
|
125
150
|
def action_preset_unset(name:, param_name:, **)
|
|
151
|
+
Log.log.warn { "Command preset unset is #{Deprecation.new(last: PRESET_DEPRECATED_LAST, message: "use: #{Info::CMD_NAME} config preset set #{shell_word(name)} #{shell_word(param_name)} @none:")}" }
|
|
126
152
|
name = preset_name(name)
|
|
127
153
|
cp = presets.config_presets
|
|
128
154
|
raise Cli::BadArgument, "no such preset: #{name}" unless cp.key?(name)
|
|
@@ -130,31 +156,55 @@ module Aspera
|
|
|
130
156
|
Result::Status.new("Removed: #{name}: #{param_name}")
|
|
131
157
|
end
|
|
132
158
|
|
|
133
|
-
|
|
159
|
+
# Merge into presets (JSON Merge Patch: a value `nil` removes the key), with one of:
|
|
160
|
+
# - `name` is a Hash: presets by name (a preset `nil` is deleted)
|
|
161
|
+
# - `name` and `param_name` is a Hash: parameters of the preset
|
|
162
|
+
# - `name`, `param_name` and `param_value`: one parameter (dot-path), asked if not given
|
|
163
|
+
# @param name [String, Hash] Preset name, or presets
|
|
164
|
+
# @param param_name [String, Hash] Parameter name (dot-path), or parameters, not given for presets
|
|
165
|
+
# @param param_value [Object] Value of the parameter, `nil` removes it
|
|
166
|
+
def action_preset_set(name:, param_name: NOT_GIVEN, param_value: NOT_GIVEN, **)
|
|
167
|
+
if name.is_a?(Hash)
|
|
168
|
+
raise Cli::BadArgument, 'set <presets>: no other argument expected' unless param_name.equal?(NOT_GIVEN)
|
|
169
|
+
name.each { |preset, values| merge_preset(preset, values) }
|
|
170
|
+
return Result::Status.new("Updated: #{name.keys.join(', ')}")
|
|
171
|
+
end
|
|
172
|
+
raise Cli::BadArgument, 'set <name>: expecting <Hash> of parameters, or <param> <value>' if param_name.equal?(NOT_GIVEN)
|
|
173
|
+
if param_name.is_a?(Hash)
|
|
174
|
+
raise Cli::BadArgument, 'set <name> <Hash>: no other argument expected' unless param_value.equal?(NOT_GIVEN)
|
|
175
|
+
merge_preset(name, param_name)
|
|
176
|
+
return Result::Status.new("Updated: #{preset_name(name)}")
|
|
177
|
+
end
|
|
178
|
+
param_value = options.get_next_argument('param_value', validation: nil, evaluate: :smart) if param_value.equal?(NOT_GIVEN)
|
|
134
179
|
name = preset_name(name, create: true)
|
|
180
|
+
# Key names are not secrets: converted, or split with dot-notation, a secret would not be hidden in results
|
|
181
|
+
Security.instance.check_secret_processing('preset parameter name', hint: 'give a name that is not a secret') do
|
|
182
|
+
Secret::Hider.instance.contains_secret?(param_name)
|
|
183
|
+
end
|
|
135
184
|
param_name = Parser.option_line_to_name(param_name)
|
|
136
|
-
|
|
185
|
+
check_preset_entry(param_name, param_value) unless param_value.nil?
|
|
186
|
+
presets.set_key(name, param_name, param_value)
|
|
137
187
|
secure_preset_option(presets.config_presets[name], name, param_name)
|
|
138
188
|
Result::Nothing.new
|
|
139
189
|
end
|
|
140
190
|
|
|
141
191
|
def action_preset_initialize(name:, preset:, **)
|
|
192
|
+
Log.log.warn { "Command preset initialize is #{Deprecation.new(last: PRESET_DEPRECATED_LAST, message: "use: #{Info::CMD_NAME} config preset delete #{shell_word(name)}, then: #{Info::CMD_NAME} config preset set #{shell_word(name)} <Hash>")}" }
|
|
142
193
|
name = preset_name(name, create: true)
|
|
143
194
|
cp = presets.config_presets
|
|
144
195
|
Log.log.warn { "configuration already exists: #{name}, overwriting" } if cp.key?(name)
|
|
196
|
+
Aspera.assert_type(preset, Hash, type: Cli::BadArgument) { 'preset' }
|
|
197
|
+
preset.each { |k, v| check_preset_entry(k, v) }
|
|
145
198
|
cp[name] = preset
|
|
146
199
|
Result::Status.new("Initialized: #{name}")
|
|
147
200
|
end
|
|
148
201
|
|
|
202
|
+
# Deprecated: options placed after `update` are merged into the preset.
|
|
149
203
|
def action_preset_update(name:, **)
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
cp[name] ||= {}
|
|
155
|
-
cp[name].merge!(unprocessed_options)
|
|
156
|
-
unprocessed_options.each_key { |k| secure_preset_option(cp[name], name, k) }
|
|
157
|
-
Result::Status.new("Updated: #{name}")
|
|
204
|
+
values = options.unprocessed_options_with_value(after_command: true)
|
|
205
|
+
Log.log.warn { "Command preset update is #{Deprecation.new(last: PRESET_DEPRECATED_LAST, message: "use: #{set_command_hint(name, values)}")}" }
|
|
206
|
+
merge_preset(name, values)
|
|
207
|
+
Result::Status.new("Updated: #{preset_name(name)}")
|
|
158
208
|
end
|
|
159
209
|
|
|
160
210
|
def action_preset_ask(name:, option_names:, **)
|
|
@@ -171,6 +221,78 @@ module Aspera
|
|
|
171
221
|
end
|
|
172
222
|
Result::Status.new("Updated: #{name}")
|
|
173
223
|
end
|
|
224
|
+
|
|
225
|
+
private
|
|
226
|
+
|
|
227
|
+
# Merge parameters into a preset (JSON Merge Patch), or delete it.
|
|
228
|
+
# @param name [String] Preset name
|
|
229
|
+
# @param values [Hash, nil] Parameters: option names, a value `nil` removes the parameter. `nil`: delete the preset.
|
|
230
|
+
def merge_preset(name, values)
|
|
231
|
+
raise Cli::BadArgument, "section #{PresetManager::Key::CONFIG} is managed by #{Info::CMD_NAME}" if name.to_s.eql?(PresetManager::Key::CONFIG)
|
|
232
|
+
name = preset_name(name.to_s, create: !values.nil?)
|
|
233
|
+
return delete_preset(name) if values.nil?
|
|
234
|
+
Aspera.assert_type(values, Hash, type: Cli::BadArgument) { "parameters of preset #{name}" }
|
|
235
|
+
values = values.transform_keys { |k| Parser.option_line_to_name(k.to_s) }
|
|
236
|
+
Log.dump(:values, values)
|
|
237
|
+
values.each { |k, v| check_preset_entry(k, v) unless v.nil? }
|
|
238
|
+
cp = presets.config_presets
|
|
239
|
+
cp[name] ||= {}
|
|
240
|
+
Aspera.assert_type(cp[name], Hash, type: Cli::BadArgument) { "preset #{name}" }
|
|
241
|
+
merge_patch!(cp[name], PresetManager.stringify_secrets(nil, values))
|
|
242
|
+
values.each { |k, v| secure_preset_option(cp[name], name, k) unless v.nil? }
|
|
243
|
+
nil
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# Merge `patch` into `target` (RFC 7396 JSON Merge Patch): a value `nil` removes the key, a `Hash` is merged.
|
|
247
|
+
# @param target [Hash] Modified in place
|
|
248
|
+
# @param patch [Hash]
|
|
249
|
+
# @return [Hash] target
|
|
250
|
+
def merge_patch!(target, patch)
|
|
251
|
+
patch.each do |key, value|
|
|
252
|
+
if value.nil? then target.delete(key)
|
|
253
|
+
elsif value.is_a?(Hash) then target[key] = merge_patch!(target[key].is_a?(Hash) ? target[key] : {}, value)
|
|
254
|
+
else target[key] = value
|
|
255
|
+
end
|
|
256
|
+
end
|
|
257
|
+
target
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
# Delete a preset, and default declarations referring to it.
|
|
261
|
+
# @param name [String] Preset name
|
|
262
|
+
def delete_preset(name)
|
|
263
|
+
cp = presets.config_presets
|
|
264
|
+
cp.delete(name)
|
|
265
|
+
defaults = cp[PresetManager::Key::DEFAULTS]
|
|
266
|
+
defaults&.select { |_, preset_name| preset_name.eql?(name) }&.each_key do |plugin|
|
|
267
|
+
defaults.delete(plugin)
|
|
268
|
+
Log.log.info { "Removed: #{PresetManager::Key::DEFAULTS}: #{plugin}" }
|
|
269
|
+
end
|
|
270
|
+
nil
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# Command to use instead of the deprecated `preset update`, without secret values.
|
|
274
|
+
# Secret parameters are named after the command: in logs, the value of a secret parameter is hidden.
|
|
275
|
+
# @param name [String] Preset name
|
|
276
|
+
# @param values [Hash] Values taken from options
|
|
277
|
+
# @return [String] e.g. `ascli config preset set p1 @: url=https://example.com username=bob, and secret parameters: password`
|
|
278
|
+
def set_command_hint(name, values)
|
|
279
|
+
secrets, others = DotContainer.new(values).to_dotted.partition do |path, value|
|
|
280
|
+
Secret::Hider.instance.secret?(path.to_s.split(DotContainer::SEPARATOR).last, value)
|
|
281
|
+
end
|
|
282
|
+
assignments = others.map do |path, value|
|
|
283
|
+
value = "@json:#{JSON.generate(value)}" if value.is_a?(Array) || value.is_a?(Hash)
|
|
284
|
+
shell_word("#{path}=#{value}")
|
|
285
|
+
end
|
|
286
|
+
hint = [Info::CMD_NAME, 'config', 'preset', 'set', shell_word(name), '@:', *assignments].join(' ')
|
|
287
|
+
hint = "#{hint}, and secret parameters (e.g. with @secret: or @val:@vault:): #{secrets.map(&:first).join(', ')}" unless secrets.empty?
|
|
288
|
+
hint
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# @param word [String] Word of a command line
|
|
292
|
+
# @return [String] Word, quoted for a shell only if needed
|
|
293
|
+
def shell_word(word)
|
|
294
|
+
word.match?(%r{\A[\w@:/.,=+%-]+\z}) ? word : "'#{word.gsub("'") { %q('\\'') }}'"
|
|
295
|
+
end
|
|
174
296
|
end
|
|
175
297
|
end
|
|
176
298
|
end
|
|
@@ -1,15 +1,22 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative 'extended_value'
|
|
7
|
+
require_relative 'vault_manager'
|
|
8
|
+
require_relative '../dot_container'
|
|
9
|
+
require_relative 'version'
|
|
10
|
+
require_relative 'info'
|
|
11
|
+
require_relative '../environment'
|
|
12
|
+
require_relative '../log'
|
|
13
|
+
require_relative '../assert'
|
|
14
|
+
require_relative '../secret/hider'
|
|
15
|
+
require_relative '../yaml'
|
|
16
|
+
require_relative '../rainbow'
|
|
10
17
|
require 'digest'
|
|
18
|
+
require 'fileutils'
|
|
11
19
|
require 'yaml'
|
|
12
|
-
require 'aspera/rainbow'
|
|
13
20
|
using Rainbow
|
|
14
21
|
|
|
15
22
|
module Aspera
|
|
@@ -26,6 +33,8 @@ module Aspera
|
|
|
26
33
|
GLOBAL = 'global_common_defaults'
|
|
27
34
|
# Prefix for comment/meta keys ignored during preset parsing (e.g. _comment)
|
|
28
35
|
META_PREFIX = '_'
|
|
36
|
+
# Key of the free text describing a preset (ignored when the preset is applied)
|
|
37
|
+
COMMENT = "#{META_PREFIX}comment".freeze
|
|
29
38
|
end
|
|
30
39
|
|
|
31
40
|
GLOBAL_DEFAULT_KEYWORD = 'GLOBAL'
|
|
@@ -52,9 +61,9 @@ module Aspera
|
|
|
52
61
|
# File I/O
|
|
53
62
|
# ------------------------------------------------------------------
|
|
54
63
|
|
|
55
|
-
# @return [String]
|
|
64
|
+
# @return [String] SHA256 of current in-memory presets
|
|
56
65
|
def checksum
|
|
57
|
-
Digest::
|
|
66
|
+
Digest::SHA256.hexdigest(JSON.generate(@config_presets))
|
|
58
67
|
end
|
|
59
68
|
|
|
60
69
|
# Read and validate the YAML config file.
|
|
@@ -66,7 +75,8 @@ module Aspera
|
|
|
66
75
|
if File.exist?(@config_file)
|
|
67
76
|
Log.log.debug { "loading #{@config_file}" }
|
|
68
77
|
begin
|
|
69
|
-
|
|
78
|
+
# Before checksum: the conversion alone does not save the file
|
|
79
|
+
@config_presets = self.class.stringify_secrets(nil, Yaml.safe_load(File.read(@config_file)))
|
|
70
80
|
rescue Psych::SyntaxError
|
|
71
81
|
Log.log.error { "YAML error in config file: #{@config_file}" }
|
|
72
82
|
raise
|
|
@@ -91,6 +101,8 @@ module Aspera
|
|
|
91
101
|
end
|
|
92
102
|
raise Cli::Error, e.to_s
|
|
93
103
|
end
|
|
104
|
+
# Hidden wherever they appear (logs, results), also when copied under another key name
|
|
105
|
+
Secret::Hider.instance.add_secrets_in(@config_presets)
|
|
94
106
|
end
|
|
95
107
|
|
|
96
108
|
# Save to disk only if content changed since last load/save.
|
|
@@ -123,8 +135,8 @@ module Aspera
|
|
|
123
135
|
Log.log.error do
|
|
124
136
|
"Default config name [#{default_name}] specified for plugin [#{plugin_name_sym}], but it does not exist in config file.\n" \
|
|
125
137
|
"Please fix: either create preset:\n" \
|
|
126
|
-
"#{Info::CMD_NAME} config preset
|
|
127
|
-
"or remove default:\n#{Info::CMD_NAME} config preset
|
|
138
|
+
"#{Info::CMD_NAME} config preset set #{default_name} @: url=...\n" \
|
|
139
|
+
"or remove default:\n#{Info::CMD_NAME} config preset set #{Key::DEFAULTS} #{plugin_name_sym} @none:"
|
|
128
140
|
end
|
|
129
141
|
raise Cli::Error, "No such preset: #{default_name}"
|
|
130
142
|
end
|
|
@@ -152,7 +164,10 @@ module Aspera
|
|
|
152
164
|
end
|
|
153
165
|
current = self.class.deep_clone(current) unless current.is_a?(String)
|
|
154
166
|
current.delete_if { |k, _| k.to_s.start_with?(Key::META_PREFIX) } if current.is_a?(Hash)
|
|
155
|
-
ExtendedValue.instance.evaluate(current, context: 'preset')
|
|
167
|
+
current = ExtendedValue.instance.evaluate(current, context: 'preset')
|
|
168
|
+
# A secret read alone has no key name: declared, so that it is hidden wherever it appears
|
|
169
|
+
Secret::Hider.instance.add_secret_values(current) if Secret::Hider.instance.secret?(names.last, current)
|
|
170
|
+
current
|
|
156
171
|
end
|
|
157
172
|
|
|
158
173
|
# Set a single key in a preset hash (creates the preset if absent).
|
|
@@ -161,6 +176,7 @@ module Aspera
|
|
|
161
176
|
def set_key(preset, param_name, param_value)
|
|
162
177
|
Aspera.assert_type(param_name, String, Symbol) { 'parameter' }
|
|
163
178
|
param_name = param_name.to_s
|
|
179
|
+
param_value = self.class.stringify_secrets(param_name.split(DotContainer::SEPARATOR).last, param_value)
|
|
164
180
|
selected = @config_presets[preset]
|
|
165
181
|
if selected.nil?
|
|
166
182
|
Log.log.debug { "Unknown preset name: #{preset}, initializing" }
|
|
@@ -229,9 +245,9 @@ module Aspera
|
|
|
229
245
|
# Create / overwrite a preset and optionally set it as plugin default.
|
|
230
246
|
def defaults_set(plugin_name, preset_name, preset_values, option_default, option_override)
|
|
231
247
|
@config_presets[Key::DEFAULTS] ||= {}
|
|
232
|
-
raise Cli::Error, "A default configuration already exists for plugin '#{plugin_name}' (use
|
|
248
|
+
raise Cli::Error, "A default configuration already exists for plugin '#{plugin_name}' (use wizard key override=yes or default=no)" \
|
|
233
249
|
if !option_override && option_default && @config_presets[Key::DEFAULTS].key?(plugin_name)
|
|
234
|
-
raise Cli::Error, "Preset already exists: #{preset_name} (use
|
|
250
|
+
raise Cli::Error, "Preset already exists: #{preset_name} (use wizard key override=yes or provide alternate preset name)" \
|
|
235
251
|
if !option_override && @config_presets.key?(preset_name)
|
|
236
252
|
if option_default
|
|
237
253
|
Log.log.info("Setting config preset as default for #{plugin_name}")
|
|
@@ -276,6 +292,20 @@ module Aspera
|
|
|
276
292
|
end
|
|
277
293
|
dst
|
|
278
294
|
end
|
|
295
|
+
|
|
296
|
+
# A secret is a String: a number under a secret key name (e.g. password `12345678`, unquoted in YAML or set on command line)
|
|
297
|
+
# is converted, else it is not identified as a secret, and is shown in results
|
|
298
|
+
# @param key [String, nil] Key name of value
|
|
299
|
+
# @param value [Object] Value: containers are modified in place
|
|
300
|
+
# @return [Object] Value, or its String if it is a secret
|
|
301
|
+
def stringify_secrets(key, value)
|
|
302
|
+
case value
|
|
303
|
+
when Hash then value.each { |k, v| value[k] = stringify_secrets(k, v) }
|
|
304
|
+
when Array then value.map! { |v| stringify_secrets(nil, v) }
|
|
305
|
+
when Numeric then value = value.to_s if Secret::Hider.instance.secret?(key, value.to_s)
|
|
306
|
+
end
|
|
307
|
+
value
|
|
308
|
+
end
|
|
279
309
|
end
|
|
280
310
|
|
|
281
311
|
private
|
|
@@ -295,9 +325,35 @@ module Aspera
|
|
|
295
325
|
Log.log.debug { "conf version: #{version}" }
|
|
296
326
|
# Fix bug in 4.4 (creating key "true" in "default" preset)
|
|
297
327
|
@config_presets[Key::DEFAULTS].delete(true) if @config_presets[Key::DEFAULTS].is_a?(Hash)
|
|
328
|
+
# Migrate deprecated vault format in presets if present
|
|
329
|
+
migrate_vault_configs!
|
|
298
330
|
# Stamp with current version
|
|
299
331
|
@config_presets[Key::CONFIG][Key::VERSION] = Cli::VERSION
|
|
300
332
|
end
|
|
333
|
+
|
|
334
|
+
# Migrates deprecated vault options in presets to the new format (stores and default)
|
|
335
|
+
# and saves a backup of the original config file.
|
|
336
|
+
def migrate_vault_configs!
|
|
337
|
+
migrated = false
|
|
338
|
+
@config_presets.each_value do |preset|
|
|
339
|
+
next unless preset.is_a?(Hash)
|
|
340
|
+
vault_config = preset['vault'] || preset[:vault]
|
|
341
|
+
next unless vault_config.is_a?(Hash)
|
|
342
|
+
converted = VaultManager.convert_option(vault_config)
|
|
343
|
+
if converted != vault_config
|
|
344
|
+
preset['vault'] = converted
|
|
345
|
+
preset.delete(:vault) if preset.key?(:vault)
|
|
346
|
+
migrated = true
|
|
347
|
+
end
|
|
348
|
+
end
|
|
349
|
+
return unless migrated && File.exist?(@config_file)
|
|
350
|
+
backup_file = "#{@config_file}.pre#{Cli::VERSION}.bak"
|
|
351
|
+
FileUtils.cp(@config_file, backup_file)
|
|
352
|
+
Environment.restrict_file_access(backup_file)
|
|
353
|
+
Log.log.warn { "Migrated vault option in #{@config_file} (backup saved to #{backup_file})" }
|
|
354
|
+
Environment.write_file_restricted(@config_file, force: true) { @config_presets.to_yaml }
|
|
355
|
+
@checksum_on_disk = checksum
|
|
356
|
+
end
|
|
301
357
|
end
|
|
302
358
|
end
|
|
303
359
|
end
|