aspera-cli 4.28.0 → 4.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/BUGS.md +5 -10
- data/CHANGELOG.md +143 -2
- data/CODE_OF_CONDUCT.md +18 -0
- data/CONTRIBUTING.md +135 -56
- 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 +9 -6
- data/docs/README.md +1633 -609
- data/docs/test-mcp-with-ai.md +8 -8
- 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 +20 -19
- data/lib/aspera/agent/factory.rb +6 -3
- 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 +7 -4
- data/lib/aspera/api/faspex.rb +16 -9
- data/lib/aspera/api/httpgw.rb +9 -6
- data/lib/aspera/api/node.rb +20 -20
- data/lib/aspera/ascmd.rb +8 -5
- data/lib/aspera/ascp/installation.rb +71 -65
- 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 +16 -8
- data/lib/aspera/ascp/session_errors.rb +217 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +12 -19
- 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 -33
- data/lib/aspera/cli/command_line.rb +24 -6
- data/lib/aspera/cli/command_registry.rb +6 -1
- data/lib/aspera/cli/command_spec.rb +34 -7
- data/lib/aspera/cli/completion/ascli.bash +19 -5
- data/lib/aspera/cli/completion/ascli.fish +13 -2
- data/lib/aspera/cli/completion/ascli.ps1 +31 -9
- data/lib/aspera/cli/completion/ascli.zsh +22 -6
- data/lib/aspera/cli/completion_actions.rb +303 -69
- data/lib/aspera/cli/context.rb +9 -4
- data/lib/aspera/cli/deprecation.rb +5 -2
- data/lib/aspera/cli/error.rb +3 -0
- data/lib/aspera/cli/extended_value.rb +61 -27
- data/lib/aspera/cli/formatter.rb +29 -22
- data/lib/aspera/cli/gem_checker.rb +9 -6
- data/lib/aspera/cli/hints.rb +22 -10
- data/lib/aspera/cli/http.rb +12 -9
- data/lib/aspera/cli/info.rb +12 -7
- data/lib/aspera/cli/mailer.rb +6 -3
- data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
- data/lib/aspera/cli/mcp/secrets.rb +8 -5
- data/lib/aspera/cli/mcp/tool.rb +15 -14
- 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 +65 -12
- data/lib/aspera/cli/options.schema.yaml +487 -63
- data/lib/aspera/cli/parser.rb +56 -32
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +244 -35
- data/lib/aspera/cli/plugins/ats.rb +9 -8
- data/lib/aspera/cli/plugins/base.rb +17 -12
- data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
- data/lib/aspera/cli/plugins/config.rb +198 -103
- data/lib/aspera/cli/plugins/console.rb +6 -3
- data/lib/aspera/cli/plugins/cos.rb +8 -4
- data/lib/aspera/cli/plugins/factory.rb +21 -7
- data/lib/aspera/cli/plugins/faspex5.rb +28 -25
- data/lib/aspera/cli/plugins/faspio.rb +7 -5
- data/lib/aspera/cli/plugins/httpgw.rb +7 -4
- data/lib/aspera/cli/plugins/mcp.rb +28 -22
- data/lib/aspera/cli/plugins/node.rb +31 -30
- data/lib/aspera/cli/plugins/oauth.rb +5 -1
- data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
- data/lib/aspera/cli/plugins/preview.rb +69 -44
- data/lib/aspera/cli/plugins/server.rb +63 -11
- data/lib/aspera/cli/plugins/shares.rb +86 -16
- data/lib/aspera/cli/plugins/transferd.rb +223 -0
- data/lib/aspera/cli/preset_actions.rb +144 -30
- data/lib/aspera/cli/preset_manager.rb +52 -18
- data/lib/aspera/cli/prompt.rb +4 -1
- data/lib/aspera/cli/result.rb +12 -8
- data/lib/aspera/cli/runner.rb +69 -46
- data/lib/aspera/cli/secret_finder.rb +4 -1
- data/lib/aspera/cli/security.rb +79 -9
- 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 +3 -0
- data/lib/aspera/cli/terminal_formatter.rb +9 -6
- data/lib/aspera/cli/transfer_actions.rb +11 -8
- data/lib/aspera/cli/transfer_agent.rb +29 -20
- 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 +188 -42
- data/lib/aspera/cli/version.rb +4 -1
- data/lib/aspera/cli/web_secret.rb +12 -10
- data/lib/aspera/cli/wizard.rb +42 -39
- data/lib/aspera/command_line_builder.rb +9 -5
- data/lib/aspera/command_line_converter.rb +4 -1
- data/lib/aspera/coverage.rb +103 -33
- data/lib/aspera/data_repository.rb +4 -1
- data/lib/aspera/dot_container.rb +4 -1
- data/lib/aspera/duration.rb +5 -2
- data/lib/aspera/environment.rb +21 -12
- data/lib/aspera/exec_spec.rb +3 -0
- data/lib/aspera/faspex_gw.rb +13 -9
- data/lib/aspera/faspex_postproc.rb +15 -12
- data/lib/aspera/formatter_interface.rb +4 -1
- data/lib/aspera/graphql.rb +5 -1
- data/lib/aspera/hash_ext.rb +3 -0
- data/lib/aspera/id_generator.rb +4 -2
- data/lib/aspera/json_rpc/client.rb +6 -5
- data/lib/aspera/json_rpc/version.rb +3 -0
- data/lib/aspera/line_logger.rb +4 -1
- data/lib/aspera/link_header.rb +4 -1
- data/lib/aspera/log.rb +18 -5
- data/lib/aspera/markdown.rb +5 -2
- data/lib/aspera/mime.rb +3 -0
- data/lib/aspera/nagios.rb +6 -4
- data/lib/aspera/node_emulator.rb +15 -13
- data/lib/aspera/oauth/client/base.rb +91 -70
- data/lib/aspera/oauth/client/boot.rb +7 -4
- data/lib/aspera/oauth/client/factory.rb +6 -3
- data/lib/aspera/oauth/client/generic.rb +5 -1
- data/lib/aspera/oauth/client/json_credentials.rb +4 -1
- data/lib/aspera/oauth/client/jwt.rb +6 -3
- data/lib/aspera/oauth/client/shares_web.rb +85 -0
- data/lib/aspera/oauth/client/url_json.rb +4 -1
- data/lib/aspera/oauth/client/web.rb +39 -12
- data/lib/aspera/oauth/server/pkce.rb +6 -5
- data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
- 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 +8 -4
- 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 +3 -0
- data/lib/aspera/rest/aspera_errors.rb +4 -1
- data/lib/aspera/rest/call_error.rb +3 -0
- data/lib/aspera/rest/client.rb +22 -29
- data/lib/aspera/rest/error_analyzer.rb +5 -2
- data/lib/aspera/rest/list.rb +8 -4
- data/lib/aspera/rest/parameters.rb +3 -0
- data/lib/aspera/rest/util.rb +8 -5
- data/lib/aspera/rest.rb +9 -6
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
- 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/async_tables.yaml +11 -10
- data/lib/aspera/schema/documentation.rb +8 -2
- data/lib/aspera/schema/reader.rb +7 -0
- data/lib/aspera/schema/registry.rb +43 -28
- 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 +5 -2
- 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 +3 -0
- data/lib/aspera/sync/conf.schema.yaml +9 -4
- data/lib/aspera/sync/database.rb +3 -0
- data/lib/aspera/sync/operations.rb +16 -14
- data/lib/aspera/temp_file_manager.rb +8 -4
- 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 +17 -14
- data/lib/aspera/transfer/result.rb +3 -0
- data/lib/aspera/transfer/resumer.rb +6 -4
- data/lib/aspera/transfer/spec.rb +9 -22
- data/lib/aspera/transfer/units.rb +75 -0
- data/lib/aspera/uri_reader.rb +57 -7
- data/lib/aspera/web_auth/index.html.erb +6 -2
- 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 +47 -10
- data/lib/aspera/web_page.rb +7 -2
- data/lib/aspera/web_server_simple.rb +6 -3
- 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 +72 -19
- metadata.gz.sig +0 -0
- data/lib/aspera/keychain/base.rb +0 -30
- data/lib/aspera/keychain/encrypted_hash.rb +0 -192
- data/lib/aspera/keychain/factory.rb +0 -58
- data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
- data/lib/aspera/keychain/macos_security.rb +0 -277
- data/lib/aspera/keychain/one_password_api.rb +0 -91
- data/lib/aspera/keychain/one_password_base.rb +0 -39
- data/lib/aspera/keychain/one_password_cli.rb +0 -100
- data/lib/aspera/secret_hider.rb +0 -196
- data/lib/aspera/secret_strength.rb +0 -114
|
@@ -1,9 +1,17 @@
|
|
|
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 '../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'
|
|
7
15
|
|
|
8
16
|
module Aspera
|
|
9
17
|
module Cli
|
|
@@ -13,6 +21,12 @@ module Aspera
|
|
|
13
21
|
GLOBAL_DEFAULT_KEYWORD = 'GLOBAL'
|
|
14
22
|
# Display columns for preset overview
|
|
15
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
|
|
16
30
|
|
|
17
31
|
def action_preset_overview(**)
|
|
18
32
|
# Secrets hidden by key name here: the key becomes the value of column `parameter`
|
|
@@ -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
|
|
@@ -98,15 +126,8 @@ module Aspera
|
|
|
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
|
|
|
@@ -120,13 +141,14 @@ module Aspera
|
|
|
120
141
|
when Numeric, String
|
|
121
142
|
value = ExtendedValue.instance.evaluate(value.to_s, context: 'preset')
|
|
122
143
|
# A secret has no key name in a text result: declared, so that it is hidden
|
|
123
|
-
|
|
144
|
+
Secret::Hider.instance.add_secret_values(value) if Secret::Hider.instance.secret?(param_name, value)
|
|
124
145
|
return Result::Text.new(value)
|
|
125
146
|
end
|
|
126
147
|
Result::SingleObject.new(value)
|
|
127
148
|
end
|
|
128
149
|
|
|
129
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:")}" }
|
|
130
152
|
name = preset_name(name)
|
|
131
153
|
cp = presets.config_presets
|
|
132
154
|
raise Cli::BadArgument, "no such preset: #{name}" unless cp.key?(name)
|
|
@@ -134,35 +156,55 @@ module Aspera
|
|
|
134
156
|
Result::Status.new("Removed: #{name}: #{param_name}")
|
|
135
157
|
end
|
|
136
158
|
|
|
137
|
-
|
|
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)
|
|
138
179
|
name = preset_name(name, create: true)
|
|
139
180
|
# Key names are not secrets: converted, or split with dot-notation, a secret would not be hidden in results
|
|
140
181
|
Security.instance.check_secret_processing('preset parameter name', hint: 'give a name that is not a secret') do
|
|
141
|
-
|
|
182
|
+
Secret::Hider.instance.contains_secret?(param_name)
|
|
142
183
|
end
|
|
143
184
|
param_name = Parser.option_line_to_name(param_name)
|
|
144
|
-
|
|
185
|
+
check_preset_entry(param_name, param_value) unless param_value.nil?
|
|
186
|
+
presets.set_key(name, param_name, param_value)
|
|
145
187
|
secure_preset_option(presets.config_presets[name], name, param_name)
|
|
146
188
|
Result::Nothing.new
|
|
147
189
|
end
|
|
148
190
|
|
|
149
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>")}" }
|
|
150
193
|
name = preset_name(name, create: true)
|
|
151
194
|
cp = presets.config_presets
|
|
152
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) }
|
|
153
198
|
cp[name] = preset
|
|
154
199
|
Result::Status.new("Initialized: #{name}")
|
|
155
200
|
end
|
|
156
201
|
|
|
202
|
+
# Deprecated: options placed after `update` are merged into the preset.
|
|
157
203
|
def action_preset_update(name:, **)
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
cp[name] ||= {}
|
|
163
|
-
cp[name].merge!(unprocessed_options)
|
|
164
|
-
unprocessed_options.each_key { |k| secure_preset_option(cp[name], name, k) }
|
|
165
|
-
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)}")
|
|
166
208
|
end
|
|
167
209
|
|
|
168
210
|
def action_preset_ask(name:, option_names:, **)
|
|
@@ -179,6 +221,78 @@ module Aspera
|
|
|
179
221
|
end
|
|
180
222
|
Result::Status.new("Updated: #{name}")
|
|
181
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
|
|
182
296
|
end
|
|
183
297
|
end
|
|
184
298
|
end
|
|
@@ -1,16 +1,22 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
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'
|
|
11
17
|
require 'digest'
|
|
18
|
+
require 'fileutils'
|
|
12
19
|
require 'yaml'
|
|
13
|
-
require 'aspera/rainbow'
|
|
14
20
|
using Rainbow
|
|
15
21
|
|
|
16
22
|
module Aspera
|
|
@@ -27,6 +33,8 @@ module Aspera
|
|
|
27
33
|
GLOBAL = 'global_common_defaults'
|
|
28
34
|
# Prefix for comment/meta keys ignored during preset parsing (e.g. _comment)
|
|
29
35
|
META_PREFIX = '_'
|
|
36
|
+
# Key of the free text describing a preset (ignored when the preset is applied)
|
|
37
|
+
COMMENT = "#{META_PREFIX}comment".freeze
|
|
30
38
|
end
|
|
31
39
|
|
|
32
40
|
GLOBAL_DEFAULT_KEYWORD = 'GLOBAL'
|
|
@@ -53,9 +61,9 @@ module Aspera
|
|
|
53
61
|
# File I/O
|
|
54
62
|
# ------------------------------------------------------------------
|
|
55
63
|
|
|
56
|
-
# @return [String]
|
|
64
|
+
# @return [String] SHA256 of current in-memory presets
|
|
57
65
|
def checksum
|
|
58
|
-
Digest::
|
|
66
|
+
Digest::SHA256.hexdigest(JSON.generate(@config_presets))
|
|
59
67
|
end
|
|
60
68
|
|
|
61
69
|
# Read and validate the YAML config file.
|
|
@@ -94,7 +102,7 @@ module Aspera
|
|
|
94
102
|
raise Cli::Error, e.to_s
|
|
95
103
|
end
|
|
96
104
|
# Hidden wherever they appear (logs, results), also when copied under another key name
|
|
97
|
-
|
|
105
|
+
Secret::Hider.instance.add_secrets_in(@config_presets)
|
|
98
106
|
end
|
|
99
107
|
|
|
100
108
|
# Save to disk only if content changed since last load/save.
|
|
@@ -127,8 +135,8 @@ module Aspera
|
|
|
127
135
|
Log.log.error do
|
|
128
136
|
"Default config name [#{default_name}] specified for plugin [#{plugin_name_sym}], but it does not exist in config file.\n" \
|
|
129
137
|
"Please fix: either create preset:\n" \
|
|
130
|
-
"#{Info::CMD_NAME} config preset
|
|
131
|
-
"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:"
|
|
132
140
|
end
|
|
133
141
|
raise Cli::Error, "No such preset: #{default_name}"
|
|
134
142
|
end
|
|
@@ -158,7 +166,7 @@ module Aspera
|
|
|
158
166
|
current.delete_if { |k, _| k.to_s.start_with?(Key::META_PREFIX) } if current.is_a?(Hash)
|
|
159
167
|
current = ExtendedValue.instance.evaluate(current, context: 'preset')
|
|
160
168
|
# A secret read alone has no key name: declared, so that it is hidden wherever it appears
|
|
161
|
-
|
|
169
|
+
Secret::Hider.instance.add_secret_values(current) if Secret::Hider.instance.secret?(names.last, current)
|
|
162
170
|
current
|
|
163
171
|
end
|
|
164
172
|
|
|
@@ -237,9 +245,9 @@ module Aspera
|
|
|
237
245
|
# Create / overwrite a preset and optionally set it as plugin default.
|
|
238
246
|
def defaults_set(plugin_name, preset_name, preset_values, option_default, option_override)
|
|
239
247
|
@config_presets[Key::DEFAULTS] ||= {}
|
|
240
|
-
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)" \
|
|
241
249
|
if !option_override && option_default && @config_presets[Key::DEFAULTS].key?(plugin_name)
|
|
242
|
-
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)" \
|
|
243
251
|
if !option_override && @config_presets.key?(preset_name)
|
|
244
252
|
if option_default
|
|
245
253
|
Log.log.info("Setting config preset as default for #{plugin_name}")
|
|
@@ -294,7 +302,7 @@ module Aspera
|
|
|
294
302
|
case value
|
|
295
303
|
when Hash then value.each { |k, v| value[k] = stringify_secrets(k, v) }
|
|
296
304
|
when Array then value.map! { |v| stringify_secrets(nil, v) }
|
|
297
|
-
when Numeric then value = value.to_s if
|
|
305
|
+
when Numeric then value = value.to_s if Secret::Hider.instance.secret?(key, value.to_s)
|
|
298
306
|
end
|
|
299
307
|
value
|
|
300
308
|
end
|
|
@@ -317,9 +325,35 @@ module Aspera
|
|
|
317
325
|
Log.log.debug { "conf version: #{version}" }
|
|
318
326
|
# Fix bug in 4.4 (creating key "true" in "default" preset)
|
|
319
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!
|
|
320
330
|
# Stamp with current version
|
|
321
331
|
@config_presets[Key::CONFIG][Key::VERSION] = Cli::VERSION
|
|
322
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
|
|
323
357
|
end
|
|
324
358
|
end
|
|
325
359
|
end
|
data/lib/aspera/cli/prompt.rb
CHANGED
data/lib/aspera/cli/result.rb
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
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 'error'
|
|
7
|
+
require_relative '../assert'
|
|
8
|
+
require_relative '../nagios'
|
|
9
|
+
require_relative '../log'
|
|
10
|
+
require_relative '../environment'
|
|
11
|
+
require_relative '../uri_reader'
|
|
12
|
+
require_relative '../preview/terminal'
|
|
13
|
+
require_relative '../dot_container'
|
|
10
14
|
require 'base64'
|
|
11
15
|
require 'uri'
|
|
12
16
|
require 'pp'
|
|
@@ -187,7 +191,7 @@ module Aspera
|
|
|
187
191
|
|
|
188
192
|
# Text result
|
|
189
193
|
class Text < Result
|
|
190
|
-
# @param data [String, Numeric, Symbol, Boolean] The value, hidden if it is a secret declared to `
|
|
194
|
+
# @param data [String, Numeric, Symbol, Boolean] The value, hidden if it is a secret declared to `Secret::Hider`
|
|
191
195
|
def initialize(data)
|
|
192
196
|
Aspera.assert_type(data, *SCALAR_TYPES, type: ArgumentError) { 'text result data' }
|
|
193
197
|
super(data: data)
|