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,98 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require 'aspera/environment'
|
|
4
|
-
require 'aspera/keychain/one_password_base'
|
|
5
|
-
require 'json'
|
|
6
|
-
|
|
7
|
-
module Aspera
|
|
8
|
-
module Keychain
|
|
9
|
-
# Manage secrets using the 1Password CLI (`op`)
|
|
10
|
-
# https://developer.1password.com/docs/cli/
|
|
11
|
-
class OnePasswordCli < Base
|
|
12
|
-
include OnePasswordBase
|
|
13
|
-
|
|
14
|
-
OP_EXECUTABLE = 'op'
|
|
15
|
-
private_constant :OP_EXECUTABLE
|
|
16
|
-
|
|
17
|
-
# @param vault [String, nil] Name or ID of the 1Password vault (optional, uses default vault if omitted)
|
|
18
|
-
# @param account [String, nil] Account shorthand for `op` (optional, uses default account if omitted)
|
|
19
|
-
def initialize(vault: nil, account: nil)
|
|
20
|
-
super()
|
|
21
|
-
@vault = vault
|
|
22
|
-
@account = account
|
|
23
|
-
end
|
|
24
|
-
|
|
25
|
-
def info
|
|
26
|
-
h = {}
|
|
27
|
-
h[:vault] = @vault unless @vault.nil?
|
|
28
|
-
h[:account] = @account unless @account.nil?
|
|
29
|
-
h
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
def all
|
|
33
|
-
items = op_json('item', 'list', '--categories', ITEM_CATEGORY)
|
|
34
|
-
return items.map do |item|
|
|
35
|
-
item_to_secret(op_json('item', 'get', item['id'])).merge(id: item['id'])
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
|
|
39
|
-
def ids
|
|
40
|
-
op_json('item', 'list', '--categories', ITEM_CATEGORY).map { |item| {id: item['id'], label: item['title']} }
|
|
41
|
-
end
|
|
42
|
-
|
|
43
|
-
def set(options)
|
|
44
|
-
validate_set(options)
|
|
45
|
-
args = ['item', 'create', '--category', ITEM_CATEGORY, "--title=#{options[:label]}"]
|
|
46
|
-
args << "#{FIELD_USERNAME}=#{options[:username]}" if options[:username]
|
|
47
|
-
args << "#{FIELD_PASSWORD}[password]=#{options[:password]}" if options[:password]
|
|
48
|
-
args << "#{FIELD_URL}[url]=#{options[:url]}" if options[:url]
|
|
49
|
-
args << "#{FIELD_NOTES_ID}=#{options[:description]}" if options[:description]
|
|
50
|
-
op_run(*args)
|
|
51
|
-
nil
|
|
52
|
-
end
|
|
53
|
-
|
|
54
|
-
def get(label:, id: nil, exception: true)
|
|
55
|
-
identifier = id || label
|
|
56
|
-
stdout, _stderr, status = op_capture('item', 'get', identifier, '--format=json')
|
|
57
|
-
if !status.success?
|
|
58
|
-
raise "Secret '#{label}' not found" if exception
|
|
59
|
-
return
|
|
60
|
-
end
|
|
61
|
-
full = JSON.parse(stdout)
|
|
62
|
-
return item_to_secret(full).merge(id: full['id'])
|
|
63
|
-
end
|
|
64
|
-
|
|
65
|
-
def delete(label:, id: nil)
|
|
66
|
-
op_run('item', 'delete', id || label)
|
|
67
|
-
nil
|
|
68
|
-
end
|
|
69
|
-
|
|
70
|
-
private
|
|
71
|
-
|
|
72
|
-
def common_flags
|
|
73
|
-
flags = []
|
|
74
|
-
flags.push('--vault', @vault) unless @vault.nil?
|
|
75
|
-
flags.push('--account', @account) unless @account.nil?
|
|
76
|
-
flags
|
|
77
|
-
end
|
|
78
|
-
|
|
79
|
-
def op_json(*args)
|
|
80
|
-
stdout, = op_capture(*args, '--format=json', exception: true)
|
|
81
|
-
JSON.parse(stdout)
|
|
82
|
-
end
|
|
83
|
-
|
|
84
|
-
def op_run(*args)
|
|
85
|
-
op_capture(*args, exception: true)
|
|
86
|
-
nil
|
|
87
|
-
end
|
|
88
|
-
|
|
89
|
-
def op_capture(*args, exception: true)
|
|
90
|
-
Environment.instance.class.secure_execute(
|
|
91
|
-
OP_EXECUTABLE, *args, *common_flags,
|
|
92
|
-
mode: :capture,
|
|
93
|
-
exception: exception
|
|
94
|
-
)
|
|
95
|
-
end
|
|
96
|
-
end
|
|
97
|
-
end
|
|
98
|
-
end
|
data/lib/aspera/oauth/base.rb
DELETED
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require 'aspera/oauth/factory'
|
|
4
|
-
require 'aspera/log'
|
|
5
|
-
require 'aspera/assert'
|
|
6
|
-
require 'aspera/mime'
|
|
7
|
-
require 'date'
|
|
8
|
-
require 'aspera/rainbow'
|
|
9
|
-
using Rainbow
|
|
10
|
-
|
|
11
|
-
module Aspera
|
|
12
|
-
module OAuth
|
|
13
|
-
# OAuth 2 client for the REST client
|
|
14
|
-
# Generate bearer token
|
|
15
|
-
# Bearer tokens are cached in memory and in a file cache for later re-use
|
|
16
|
-
# OAuth 2.0 Authorization Framework: https://tools.ietf.org/html/rfc6749
|
|
17
|
-
# Bearer Token Usage: https://tools.ietf.org/html/rfc6750
|
|
18
|
-
class Base
|
|
19
|
-
Aspera.require_method!(:create_token)
|
|
20
|
-
# @param params [Hash] Parameters for token creation (client_id, client_secret, scope, etc...)
|
|
21
|
-
# @param path_token [String] API end point to create a token from base URL
|
|
22
|
-
# @param use_query [Boolean] Provide parameters in query instead of body
|
|
23
|
-
# @param token_field [String] Field in result that contains the token
|
|
24
|
-
# @param cache_ids [Array] List of unique identifiers for cache id generation
|
|
25
|
-
# @param **rest_params [Hash] Parameters for REST
|
|
26
|
-
def initialize(
|
|
27
|
-
params: {},
|
|
28
|
-
path_token: 'token',
|
|
29
|
-
use_query: false,
|
|
30
|
-
token_field: Factory::TOKEN_FIELD,
|
|
31
|
-
cache_ids: [],
|
|
32
|
-
**rest_params
|
|
33
|
-
)
|
|
34
|
-
Aspera.assert_type(params, Hash)
|
|
35
|
-
Aspera.assert_type(cache_ids, Array)
|
|
36
|
-
# This is the OAuth API
|
|
37
|
-
@api = Rest::Client.new(**rest_params)
|
|
38
|
-
@params = params.dup.freeze
|
|
39
|
-
@path_token = path_token
|
|
40
|
-
@token_field = token_field
|
|
41
|
-
@use_query = use_query
|
|
42
|
-
# TODO: :username and :scope shall be done in class, using cache_ids
|
|
43
|
-
@token_cache_id = Factory.cache_id(@api.base_url, self.class, cache_ids, rest_params[:username], @params[:scope])
|
|
44
|
-
end
|
|
45
|
-
|
|
46
|
-
# The OAuth API Object
|
|
47
|
-
attr_reader :api
|
|
48
|
-
# Parameters to generate token
|
|
49
|
-
attr_reader :params
|
|
50
|
-
# Sub path to generate token
|
|
51
|
-
attr_reader :path_token
|
|
52
|
-
|
|
53
|
-
# Parameters for token creation call
|
|
54
|
-
# @param include_secret [Boolean] Add secret in default call parameters
|
|
55
|
-
# @param other_params [Hash] Other parameters to merge
|
|
56
|
-
# @return [Hash] Token creation parameters
|
|
57
|
-
def base_parameters(include_secret: false, **other_params)
|
|
58
|
-
call_params = @params.dup
|
|
59
|
-
call_params.delete(:client_secret) unless include_secret
|
|
60
|
-
call_params.merge(other_params)
|
|
61
|
-
end
|
|
62
|
-
|
|
63
|
-
# Helper method to create token as per RFC
|
|
64
|
-
# @param other_params [Hash] Additional parameter to base parameters
|
|
65
|
-
# @return [Net::HTTPResponse] Raw HTTP response with token
|
|
66
|
-
# @raise [Rest::CallError] If not 2XX code
|
|
67
|
-
def create_token_base(include_secret: false, **other_params)
|
|
68
|
-
Log.log.debug { 'Generating a new token'.bg(:green) }
|
|
69
|
-
creation_params = base_parameters(include_secret: include_secret, **other_params)
|
|
70
|
-
return @api.create(@path_token, nil, query: creation_params, ret: :resp) if @use_query
|
|
71
|
-
return @api.create(@path_token, creation_params, content_type: Mime::WWW, ret: :resp)
|
|
72
|
-
end
|
|
73
|
-
|
|
74
|
-
# @return [String] Value suitable for Authorization header: adds `Bearer `
|
|
75
|
-
def authorization(**kwargs)
|
|
76
|
-
return OAuth::Factory.bearer_authorization(token(**kwargs))
|
|
77
|
-
end
|
|
78
|
-
|
|
79
|
-
# Get a OAuth v2 token (generated, cached, refreshed)
|
|
80
|
-
# If a token is expired (api returns 4xx), call again token(refresh: true)
|
|
81
|
-
# @param cache [Boolean] set to false to disable cache
|
|
82
|
-
# @param refresh [Boolean] set to true to force refresh or re-generation (if previous failed)
|
|
83
|
-
# @return [String] The bearer token
|
|
84
|
-
def token(cache: true, refresh: false)
|
|
85
|
-
# Get token info from cache (or nil), decoded with date and expiration status
|
|
86
|
-
token_info = Factory.instance.get_token_info(@token_cache_id, token_field: @token_field) if cache
|
|
87
|
-
token_data = nil
|
|
88
|
-
unless token_info.nil?
|
|
89
|
-
token_data = token_info[:data]
|
|
90
|
-
# Optional optimization:
|
|
91
|
-
# Check if token is expired based on decoded content then force refresh if close enough
|
|
92
|
-
# might help in case the transfer agent cannot refresh himself
|
|
93
|
-
# `direct` agent is equipped with refresh code
|
|
94
|
-
# an API was already called, but failed, we need to regenerate or refresh
|
|
95
|
-
if refresh || token_info[:expired]
|
|
96
|
-
Log.log.trace1 { "refresh: #{refresh} expired: #{token_info[:expired]}" }
|
|
97
|
-
refresh_token = nil
|
|
98
|
-
if token_data.key?('refresh_token') && !token_data['refresh_token'].eql?('not_supported')
|
|
99
|
-
# Save possible refresh token, before deleting the cache
|
|
100
|
-
refresh_token = token_data['refresh_token']
|
|
101
|
-
end
|
|
102
|
-
# Delete cache
|
|
103
|
-
Factory.instance.persist_mgr.delete(@token_cache_id)
|
|
104
|
-
token_data = nil
|
|
105
|
-
# Lets try the existing refresh token
|
|
106
|
-
# NOTE: AoC admin token has no refresh, and lives by default 1800secs
|
|
107
|
-
if !refresh_token.nil?
|
|
108
|
-
begin
|
|
109
|
-
http = create_token_base(
|
|
110
|
-
include_secret: true,
|
|
111
|
-
grant_type: 'refresh_token',
|
|
112
|
-
refresh_token: refresh_token
|
|
113
|
-
)
|
|
114
|
-
# Save only if success
|
|
115
|
-
json_data = http.body
|
|
116
|
-
token_data = JSON.parse(json_data)
|
|
117
|
-
Factory.instance.persist_mgr.put(@token_cache_id, json_data)
|
|
118
|
-
rescue StandardError => e
|
|
119
|
-
# Refresh token can fail.
|
|
120
|
-
Log.log.warn { "Refresh failed: #{e}" }
|
|
121
|
-
end
|
|
122
|
-
end
|
|
123
|
-
end
|
|
124
|
-
end
|
|
125
|
-
|
|
126
|
-
# no cache, nor refresh: generate a token
|
|
127
|
-
if token_data.nil?
|
|
128
|
-
# Call the method-specific token creation
|
|
129
|
-
# which returns the result of create_token_base
|
|
130
|
-
json_data = create_token.body
|
|
131
|
-
token_data = JSON.parse(json_data)
|
|
132
|
-
Factory.instance.persist_mgr.put(@token_cache_id, json_data)
|
|
133
|
-
Factory.instance.get_token_info(@token_cache_id, token_field: @token_field)
|
|
134
|
-
end
|
|
135
|
-
Aspera.assert(token_data.key?(@token_field)) { "API error: No such field in answer: #{@token_field}" } unless token_data.nil?
|
|
136
|
-
# Ok we shall have a token here
|
|
137
|
-
return token_data[@token_field]
|
|
138
|
-
end
|
|
139
|
-
end
|
|
140
|
-
end
|
|
141
|
-
end
|
data/lib/aspera/oauth/web.rb
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require 'aspera/oauth/base'
|
|
4
|
-
require 'aspera/environment'
|
|
5
|
-
require 'aspera/web_auth/server'
|
|
6
|
-
require 'aspera/assert'
|
|
7
|
-
module Aspera
|
|
8
|
-
module OAuth
|
|
9
|
-
# Authentication using Web browser
|
|
10
|
-
class Web < Base
|
|
11
|
-
class << self
|
|
12
|
-
attr_accessor :additional_info
|
|
13
|
-
end
|
|
14
|
-
# @param redirect_uri [String] url to receive the code after auth (to be exchanged for token)
|
|
15
|
-
# @param path_authorize [String] path to login page on web app
|
|
16
|
-
def initialize(
|
|
17
|
-
redirect_uri:,
|
|
18
|
-
path_authorize: 'authorize',
|
|
19
|
-
**base_params
|
|
20
|
-
)
|
|
21
|
-
super(**base_params)
|
|
22
|
-
@redirect_uri = redirect_uri
|
|
23
|
-
@path_authorize = path_authorize
|
|
24
|
-
uri = URI.parse(@redirect_uri)
|
|
25
|
-
Aspera.assert_values(uri.scheme, %w[http https]) { 'redirect_uri scheme must be http or https' }
|
|
26
|
-
Aspera.assert(!uri.port.nil?, 'redirect_uri must have a port')
|
|
27
|
-
Aspera.assert(%w[127.0.0.1 ::1 localhost].include?(uri.host)) { 'redirect_uri host must be localhost or loopback address' }
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
def create_token
|
|
31
|
-
# generate secure state to check later
|
|
32
|
-
random_state = SecureRandom.uuid
|
|
33
|
-
login_page_url = Rest.build_uri(
|
|
34
|
-
"#{api.base_url}/#{@path_authorize}",
|
|
35
|
-
base_parameters(response_type: 'code', redirect_uri: @redirect_uri, state: random_state)
|
|
36
|
-
)
|
|
37
|
-
# here, we need a human to authorize on a web page
|
|
38
|
-
Log.log.debug { "login_page_url=#{login_page_url}" }
|
|
39
|
-
# start a web server to receive request code
|
|
40
|
-
web_server = WebAuth::Server.new(@redirect_uri, self.class.additional_info)
|
|
41
|
-
# start browser on login page
|
|
42
|
-
Environment.instance.open_uri(login_page_url)
|
|
43
|
-
# wait for code in request
|
|
44
|
-
received_params = web_server.received_request
|
|
45
|
-
Aspera.assert(random_state.eql?(received_params['state'])) { 'wrong received state' }
|
|
46
|
-
# exchange code for token
|
|
47
|
-
create_token_base(
|
|
48
|
-
include_secret: true,
|
|
49
|
-
grant_type: 'authorization_code',
|
|
50
|
-
code: received_params['code'],
|
|
51
|
-
redirect_uri: @redirect_uri
|
|
52
|
-
)
|
|
53
|
-
end
|
|
54
|
-
end
|
|
55
|
-
Factory.instance.register_token_creator(Web)
|
|
56
|
-
end
|
|
57
|
-
end
|
data/lib/aspera/oauth.rb
DELETED