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.
Files changed (237) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +143 -2
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +135 -56
  7. data/GOVERNANCE.md +30 -0
  8. data/LICENSE +201 -0
  9. data/README.md +103 -26
  10. data/SECURITY.md +70 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +9 -6
  13. data/docs/README.md +1633 -609
  14. data/docs/test-mcp-with-ai.md +8 -8
  15. data/lib/aspera/agent/base.rb +23 -2
  16. data/lib/aspera/agent/connect.rb +16 -12
  17. data/lib/aspera/agent/desktop.rb +10 -7
  18. data/lib/aspera/agent/direct.rb +20 -19
  19. data/lib/aspera/agent/factory.rb +6 -3
  20. data/lib/aspera/agent/httpgw.rb +7 -5
  21. data/lib/aspera/agent/node.rb +15 -7
  22. data/lib/aspera/agent/transferd.rb +167 -43
  23. data/lib/aspera/api/alee.rb +4 -1
  24. data/lib/aspera/api/aoc.rb +14 -11
  25. data/lib/aspera/api/ats.rb +4 -2
  26. data/lib/aspera/api/cos_node.rb +7 -4
  27. data/lib/aspera/api/faspex.rb +16 -9
  28. data/lib/aspera/api/httpgw.rb +9 -6
  29. data/lib/aspera/api/node.rb +20 -20
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +71 -65
  32. data/lib/aspera/ascp/log.schema.yaml +1084 -0
  33. data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
  34. data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
  35. data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
  36. data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
  37. data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
  38. data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
  39. data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
  40. data/lib/aspera/ascp/log_analyzer.rb +354 -0
  41. data/lib/aspera/ascp/management.rb +16 -8
  42. data/lib/aspera/ascp/session_errors.rb +217 -0
  43. data/lib/aspera/assert.rb +4 -0
  44. data/lib/aspera/cli/ascp_actions.rb +12 -19
  45. data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
  46. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  47. data/lib/aspera/cli/bootstrapper.rb +37 -33
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +6 -1
  50. data/lib/aspera/cli/command_spec.rb +34 -7
  51. data/lib/aspera/cli/completion/ascli.bash +19 -5
  52. data/lib/aspera/cli/completion/ascli.fish +13 -2
  53. data/lib/aspera/cli/completion/ascli.ps1 +31 -9
  54. data/lib/aspera/cli/completion/ascli.zsh +22 -6
  55. data/lib/aspera/cli/completion_actions.rb +303 -69
  56. data/lib/aspera/cli/context.rb +9 -4
  57. data/lib/aspera/cli/deprecation.rb +5 -2
  58. data/lib/aspera/cli/error.rb +3 -0
  59. data/lib/aspera/cli/extended_value.rb +61 -27
  60. data/lib/aspera/cli/formatter.rb +29 -22
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -10
  63. data/lib/aspera/cli/http.rb +12 -9
  64. data/lib/aspera/cli/info.rb +12 -7
  65. data/lib/aspera/cli/mailer.rb +6 -3
  66. data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
  67. data/lib/aspera/cli/mcp/secrets.rb +8 -5
  68. data/lib/aspera/cli/mcp/tool.rb +15 -14
  69. data/lib/aspera/cli/option_declarator.rb +10 -4
  70. data/lib/aspera/cli/option_registry.rb +6 -3
  71. data/lib/aspera/cli/option_types.rb +17 -2
  72. data/lib/aspera/cli/option_value.rb +65 -12
  73. data/lib/aspera/cli/options.schema.yaml +487 -63
  74. data/lib/aspera/cli/parser.rb +56 -32
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +244 -35
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +17 -12
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +198 -103
  81. data/lib/aspera/cli/plugins/console.rb +6 -3
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +21 -7
  84. data/lib/aspera/cli/plugins/faspex5.rb +28 -25
  85. data/lib/aspera/cli/plugins/faspio.rb +7 -5
  86. data/lib/aspera/cli/plugins/httpgw.rb +7 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +28 -22
  88. data/lib/aspera/cli/plugins/node.rb +31 -30
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +63 -11
  93. data/lib/aspera/cli/plugins/shares.rb +86 -16
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +144 -30
  96. data/lib/aspera/cli/preset_manager.rb +52 -18
  97. data/lib/aspera/cli/prompt.rb +4 -1
  98. data/lib/aspera/cli/result.rb +12 -8
  99. data/lib/aspera/cli/runner.rb +69 -46
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +79 -9
  102. data/lib/aspera/cli/special_values.rb +4 -1
  103. data/lib/aspera/cli/sync_actions.rb +13 -10
  104. data/lib/aspera/cli/table_fitter.rb +3 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +9 -6
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +29 -20
  108. data/lib/aspera/cli/transfer_progress.rb +13 -45
  109. data/lib/aspera/cli/vault_actions.rb +45 -0
  110. data/lib/aspera/cli/vault_manager.rb +188 -42
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.rb +12 -10
  113. data/lib/aspera/cli/wizard.rb +42 -39
  114. data/lib/aspera/command_line_builder.rb +9 -5
  115. data/lib/aspera/command_line_converter.rb +4 -1
  116. data/lib/aspera/coverage.rb +103 -33
  117. data/lib/aspera/data_repository.rb +4 -1
  118. data/lib/aspera/dot_container.rb +4 -1
  119. data/lib/aspera/duration.rb +5 -2
  120. data/lib/aspera/environment.rb +21 -12
  121. data/lib/aspera/exec_spec.rb +3 -0
  122. data/lib/aspera/faspex_gw.rb +13 -9
  123. data/lib/aspera/faspex_postproc.rb +15 -12
  124. data/lib/aspera/formatter_interface.rb +4 -1
  125. data/lib/aspera/graphql.rb +5 -1
  126. data/lib/aspera/hash_ext.rb +3 -0
  127. data/lib/aspera/id_generator.rb +4 -2
  128. data/lib/aspera/json_rpc/client.rb +6 -5
  129. data/lib/aspera/json_rpc/version.rb +3 -0
  130. data/lib/aspera/line_logger.rb +4 -1
  131. data/lib/aspera/link_header.rb +4 -1
  132. data/lib/aspera/log.rb +18 -5
  133. data/lib/aspera/markdown.rb +5 -2
  134. data/lib/aspera/mime.rb +3 -0
  135. data/lib/aspera/nagios.rb +6 -4
  136. data/lib/aspera/node_emulator.rb +15 -13
  137. data/lib/aspera/oauth/client/base.rb +91 -70
  138. data/lib/aspera/oauth/client/boot.rb +7 -4
  139. data/lib/aspera/oauth/client/factory.rb +6 -3
  140. data/lib/aspera/oauth/client/generic.rb +5 -1
  141. data/lib/aspera/oauth/client/json_credentials.rb +4 -1
  142. data/lib/aspera/oauth/client/jwt.rb +6 -3
  143. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  144. data/lib/aspera/oauth/client/url_json.rb +4 -1
  145. data/lib/aspera/oauth/client/web.rb +39 -12
  146. data/lib/aspera/oauth/server/pkce.rb +6 -5
  147. data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
  148. data/lib/aspera/persistency_action_once.rb +5 -3
  149. data/lib/aspera/persistency_folder.rb +6 -3
  150. data/lib/aspera/preview/file_types.rb +6 -3
  151. data/lib/aspera/preview/generator.rb +9 -5
  152. data/lib/aspera/preview/options.schema.yaml +3 -3
  153. data/lib/aspera/preview/terminal.rb +8 -4
  154. data/lib/aspera/preview/utils.rb +6 -4
  155. data/lib/aspera/products/connect.rb +5 -2
  156. data/lib/aspera/products/desktop.rb +4 -1
  157. data/lib/aspera/products/other.rb +4 -2
  158. data/lib/aspera/products/transferd.rb +6 -2
  159. data/lib/aspera/products/transferd_service.rb +610 -0
  160. data/lib/aspera/proxy_auto_config.js +2 -2
  161. data/lib/aspera/proxy_auto_config.rb +5 -2
  162. data/lib/aspera/rainbow.rb +3 -0
  163. data/lib/aspera/rest/aspera_errors.rb +4 -1
  164. data/lib/aspera/rest/call_error.rb +3 -0
  165. data/lib/aspera/rest/client.rb +22 -29
  166. data/lib/aspera/rest/error_analyzer.rb +5 -2
  167. data/lib/aspera/rest/list.rb +8 -4
  168. data/lib/aspera/rest/parameters.rb +3 -0
  169. data/lib/aspera/rest/util.rb +8 -5
  170. data/lib/aspera/rest.rb +9 -6
  171. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
  172. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
  173. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  174. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  175. data/lib/aspera/schema/async_tables.yaml +11 -10
  176. data/lib/aspera/schema/documentation.rb +8 -2
  177. data/lib/aspera/schema/reader.rb +7 -0
  178. data/lib/aspera/schema/registry.rb +43 -28
  179. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  180. data/lib/aspera/schema/validator.rb +4 -1
  181. data/lib/aspera/sealed_hash.rb +166 -0
  182. data/lib/aspera/secret/hider.rb +201 -0
  183. data/lib/aspera/secret/reference.rb +150 -0
  184. data/lib/aspera/secret/resolver.rb +212 -0
  185. data/lib/aspera/secret/store/base.rb +153 -0
  186. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  187. data/lib/aspera/secret/store/factory.rb +103 -0
  188. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  189. data/lib/aspera/secret/store/keeper.rb +141 -0
  190. data/lib/aspera/secret/store/macos_security.rb +284 -0
  191. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  192. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  193. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  194. data/lib/aspera/secret/store/secret_service.rb +125 -0
  195. data/lib/aspera/secret/strength.rb +119 -0
  196. data/lib/aspera/servlet_helpers.rb +5 -2
  197. data/lib/aspera/ssh.rb +10 -7
  198. data/lib/aspera/ssl.rb +5 -2
  199. data/lib/aspera/string_ext.rb +3 -0
  200. data/lib/aspera/sync/args.schema.yaml +3 -0
  201. data/lib/aspera/sync/conf.schema.yaml +9 -4
  202. data/lib/aspera/sync/database.rb +3 -0
  203. data/lib/aspera/sync/operations.rb +16 -14
  204. data/lib/aspera/temp_file_manager.rb +8 -4
  205. data/lib/aspera/timer_limiter.rb +3 -0
  206. data/lib/aspera/transfer/error.rb +4 -1
  207. data/lib/aspera/transfer/faux_file.rb +4 -1
  208. data/lib/aspera/transfer/parameters.rb +17 -14
  209. data/lib/aspera/transfer/result.rb +3 -0
  210. data/lib/aspera/transfer/resumer.rb +6 -4
  211. data/lib/aspera/transfer/spec.rb +9 -22
  212. data/lib/aspera/transfer/units.rb +75 -0
  213. data/lib/aspera/uri_reader.rb +57 -7
  214. data/lib/aspera/web_auth/index.html.erb +6 -2
  215. data/lib/aspera/web_auth/paste.rb +109 -0
  216. data/lib/aspera/web_auth/receiver.rb +50 -0
  217. data/lib/aspera/web_auth/relay.rb +76 -0
  218. data/lib/aspera/web_auth/reply.html.erb +150 -0
  219. data/lib/aspera/web_auth/server.rb +47 -10
  220. data/lib/aspera/web_page.rb +7 -2
  221. data/lib/aspera/web_server_simple.rb +6 -3
  222. data/lib/aspera/yaml.rb +5 -1
  223. data/llms.txt +81 -0
  224. data/skills/ascli/SKILL.md +88 -0
  225. data.tar.gz.sig +0 -0
  226. metadata +72 -19
  227. metadata.gz.sig +0 -0
  228. data/lib/aspera/keychain/base.rb +0 -30
  229. data/lib/aspera/keychain/encrypted_hash.rb +0 -192
  230. data/lib/aspera/keychain/factory.rb +0 -58
  231. data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
  232. data/lib/aspera/keychain/macos_security.rb +0 -277
  233. data/lib/aspera/keychain/one_password_api.rb +0 -91
  234. data/lib/aspera/keychain/one_password_base.rb +0 -39
  235. data/lib/aspera/keychain/one_password_cli.rb +0 -100
  236. data/lib/aspera/secret_hider.rb +0 -196
  237. data/lib/aspera/secret_strength.rb +0 -114
@@ -1,58 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Aspera
4
- module Keychain
5
- # Factory to create vault/keychain instances
6
- class Factory
7
- LIST = %i[file system vault 1password].freeze
8
- class << self
9
- # Create a vault instance
10
- # @param info [Hash] vault options
11
- # @param name [String] name of the vault
12
- # @param folder [String] folder to store the vault (if needed)
13
- # @param password [String] password to open the vault
14
- def create(info, name, folder, password)
15
- Aspera.assert_hash_all(info, Symbol, String) { 'vault info shall have only string values' }
16
- info = info.symbolize_keys
17
- vault_type = info.delete(:type)
18
- case vault_type
19
- when 'file'
20
- # `name` (or `file`), default: `vault.bin`
21
- info[:file] = info.delete(:name) || info[:file] || 'vault.bin'
22
- info[:file] = File.join(folder, info[:file]) unless File.absolute_path?(info[:file])
23
- Aspera.assert(!password.nil?, 'please provide password')
24
- info[:password] = password
25
- # this module requires compilation, so it is optional
26
- require 'aspera/keychain/encrypted_hash'
27
- Keychain::EncryptedHash.new(**info)
28
- when 'system'
29
- case Environment.instance.os
30
- when Environment::OS_MACOS
31
- info[:name] ||= name
32
- Keychain::MacosSystem.new(**info)
33
- else
34
- raise Error, 'not implemented for this OS'
35
- end
36
- when 'vault'
37
- require 'aspera/keychain/hashicorp_vault'
38
- info[:token] ||= password
39
- Keychain::HashicorpVault.new(**info)
40
- when '1password'
41
- source = info.delete(:source) || 'api'
42
- case source
43
- when 'api'
44
- require 'aspera/keychain/one_password_api'
45
- info[:token] ||= password
46
- Keychain::OnePasswordApi.new(**info)
47
- when 'cli'
48
- require 'aspera/keychain/one_password_cli'
49
- Keychain::OnePasswordCli.new(**info)
50
- else Aspera.error_unexpected_value(source, type: ParameterError) { 'vault.source' }
51
- end
52
- else Aspera.error_unexpected_value(vault_type, type: ParameterError) { 'vault.type' }
53
- end
54
- end
55
- end
56
- end
57
- end
58
- end
@@ -1,77 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'aspera/environment'
4
- require 'aspera/log'
5
- require 'aspera/assert'
6
- require 'aspera/keychain/base'
7
- require 'vault'
8
-
9
- module Aspera
10
- module Keychain
11
- # Manage secrets in a Hashicorp Vault
12
- class HashicorpVault < Base
13
- STORE_PATH = 'secret/data/'
14
-
15
- private_constant :STORE_PATH
16
-
17
- def initialize(url:, token:)
18
- super()
19
- Vault.configure do |config|
20
- config.address = url
21
- config.token = token
22
- end
23
- end
24
-
25
- def info
26
- {
27
- url: Vault.address,
28
- password: Vault.auth_token
29
- }
30
- end
31
-
32
- def all
33
- metadata_path = STORE_PATH.sub('/data/', '/metadata/')
34
- return Vault.logical.list(metadata_path).filter_map do |label|
35
- # KV v2: deleted secrets are still listed in metadata
36
- get(label: label, exception: false)&.merge(label: label)
37
- end
38
- end
39
-
40
- # Set a secret
41
- # @param options [Hash] with keys :label, :username, :password, :url, :description
42
- def set(options)
43
- validate_set(options)
44
- label = options.fetch(:label)
45
- assert_new_label(label)
46
- data = {
47
- username: options[:username],
48
- password: options[:password],
49
- url: options[:url],
50
- description: options[:description]
51
- }.compact
52
- Vault.logical.write(path(label), data: data)
53
- end
54
-
55
- def get(label:, exception: true)
56
- # KV v2: a deleted secret may have metadata but no data
57
- data = Vault.logical.read(path(label))&.data&.[](:data)
58
- if data.nil?
59
- raise "Secret '#{label}' not found" if exception
60
- return
61
- end
62
- return data
63
- end
64
-
65
- def delete(label:)
66
- path = path(label)
67
- Vault.logical.delete(path)
68
- end
69
-
70
- private
71
-
72
- def path(label)
73
- "#{STORE_PATH}#{label}"
74
- end
75
- end
76
- end
77
- end
@@ -1,277 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # https://github.com/fastlane-community/security
4
- require 'aspera/cli/info'
5
- require 'aspera/log'
6
- require 'aspera/assert'
7
- require 'aspera/environment'
8
- require 'aspera/keychain/base'
9
-
10
- # enhance the gem to support other key chains
11
- module Aspera
12
- module Keychain
13
- module MacosSecurity
14
- # keychain based on macOS keychain, using `security` command line
15
- class Keychain
16
- # https://www.unix.com/man-page/osx/1/security/
17
- SECURITY_UTILITY = 'security'
18
- DOMAINS = %i[user system common dynamic].freeze
19
- LIST_OPTIONS = {
20
- domain: :c
21
- }.freeze
22
- KEYCHAIN_OPTIONS = {
23
- password: :p
24
- }.freeze
25
- ADD_PASS_OPTIONS = {
26
- account: :a,
27
- creator: :c,
28
- type: :C,
29
- domain: :d,
30
- kind: :D,
31
- value: :G,
32
- comment: :j,
33
- label: :l,
34
- path: :p,
35
- port: :P,
36
- protocol: :r,
37
- server: :s,
38
- service: :s,
39
- auth: :t,
40
- password: :w,
41
- getpass: :g
42
- }.freeze
43
- # Exit code of `security` when the item is not found
44
- EXIT_ITEM_NOT_FOUND = 44
45
- class << self
46
- # Execute a `security` CLI command with given options
47
- # @param command [String] The security sub-command
48
- # @param options [Hash, nil] Command options
49
- # @param supported [Hash, nil] Mapping of option keys to CLI flags
50
- # @param last_opt [String, nil] Trailing argument (e.g. keychain path)
51
- # @param exception [Boolean] Whether to raise on non-zero exit
52
- # @return [Array(String, String, Process::Status)] stdout, stderr, status
53
- def execute(command, options = nil, supported = nil, last_opt = nil, exception: true)
54
- url = options&.delete(:url)
55
- if !url.nil?
56
- uri = URI.parse(url)
57
- Aspera.assert(uri.scheme.eql?('https'), 'only https')
58
- options[:protocol] = 'htps' # cspell: disable-line
59
- Aspera.assert(!uri.host.nil?, type: Error) { 'host required in URL' }
60
- options[:server] = uri.host
61
- options[:path] = uri.path unless ['', '/'].include?(uri.path)
62
- options[:port] = uri.port unless uri.port.eql?(443) && !url.include?(':443/')
63
- end
64
- command_args = [SECURITY_UTILITY, command]
65
- options&.each do |k, v|
66
- Aspera.assert(supported.key?(k)) { "unknown option: #{k}" }
67
- next if v.nil?
68
- command_args.push("-#{supported[k]}")
69
- # No shell is involved: value is passed as is
70
- command_args.push(v.to_s) unless v.to_s.empty?
71
- end
72
- command_args.push(last_opt) unless last_opt.nil?
73
- Environment.secure_execute(*command_args, mode: :capture, exception: exception)
74
- end
75
-
76
- # Parse output of list command into Keychain objects
77
- # @param output [String] Raw CLI output
78
- # @return [Array<Keychain>] List of keychain instances
79
- def key_chains(output)
80
- output.split("\n").collect { |line| new(line.strip.gsub(/^"|"$/, '')) }
81
- end
82
-
83
- # Get the macOS default keychain
84
- # @return [Keychain] Default keychain instance
85
- def default
86
- key_chains(execute('default-keychain').first).first
87
- end
88
-
89
- # Get the macOS login keychain
90
- # @return [Keychain] Login keychain instance
91
- def login
92
- key_chains(execute('login-keychain').first).first
93
- end
94
-
95
- # List keychains in the search list or domain
96
- # @param options [Hash] Domain options
97
- # @return [Array<Keychain>] List of keychains
98
- def list(options = {})
99
- Aspera.assert_values(options[:domain], DOMAINS, type: ParameterError) { 'domain' } unless options[:domain].nil?
100
- key_chains(execute('list-keychains', options, LIST_OPTIONS).first)
101
- end
102
-
103
- # Find a keychain by its short name (without `.keychain-db` extension)
104
- # @param name [String] Keychain name
105
- # @return [Keychain, nil] Matching keychain or nil
106
- def by_name(name)
107
- list.find { |kc| kc.path.end_with?("/#{name}.keychain-db") }
108
- end
109
-
110
- # Create a new macOS keychain file
111
- # @param path [String] File path for the new keychain
112
- # @param password [String] Password for the new keychain
113
- # @return [Keychain] Created keychain instance
114
- def create(path, password:)
115
- execute('create-keychain', {password: password}, KEYCHAIN_OPTIONS, path)
116
- new(path)
117
- end
118
-
119
- # Set the keychain search list
120
- # @param keychain_list [Array<Keychain>] Ordered list of keychains
121
- # @return [Array(String, String, Process::Status)] Execution result
122
- def search_list=(keychain_list)
123
- Environment.secure_execute(SECURITY_UTILITY, 'list-keychains', '-s', *keychain_list.map(&:path), mode: :capture)
124
- end
125
- end
126
- attr_reader :path
127
-
128
- # @param path [String] File path of the keychain
129
- def initialize(path)
130
- @path = path
131
- end
132
-
133
- # Decode a hexadecimal encoded string into UTF-8
134
- # @param string [String] Hex string
135
- # @return [String] Decoded string
136
- def decode_hex_blob(string)
137
- [string].pack('H*').force_encoding('UTF-8')
138
- end
139
-
140
- # Perform generic or internet password operation (add, find, delete)
141
- # @param operation [Symbol] :add, :find, or :delete
142
- # @param pass_type [Symbol] :generic or :internet
143
- # @param options [Hash] Operation options (account, service, password, label, etc.)
144
- # @return [Hash, nil] Parsed attributes for :find, or nil
145
- def password(operation, pass_type, options)
146
- Aspera.assert_values(operation, %i[add find delete]) { 'operation' }
147
- Aspera.assert_values(pass_type, %i[generic internet]) { 'pass_type' }
148
- Aspera.assert_type(options, Hash)
149
- missing = (operation.eql?(:add) ? %i[account service password] : %i[label]) - options.keys
150
- Aspera.assert(missing.empty?) { "missing options: #{missing}" }
151
- options[:getpass] = '' if operation.eql?(:find)
152
- stdout, stderr, status = self.class.execute("#{operation}-#{pass_type}-password", options, ADD_PASS_OPTIONS, @path, exception: false)
153
- unless status.success?
154
- return if operation.eql?(:find) && status.exitstatus.eql?(EXIT_ITEM_NOT_FOUND)
155
- raise Error, stderr.strip.gsub(/^.*: /, '')
156
- end
157
- return unless operation.eql?(:find)
158
- attributes = {}
159
- # Attributes are on stdout, password (option -g) is on stderr
160
- "#{stdout}\n#{stderr}".split("\n").each do |line|
161
- case line
162
- when /^keychain: "(.+)"/
163
- # ignore
164
- when /0x00000007 .+="(.+)"/
165
- attributes['label'] = Regexp.last_match(1)
166
- when /"(\w{4})".+="(.+)"/
167
- attributes[Regexp.last_match(1)] = Regexp.last_match(2)
168
- when /"(\w{4})"<blob>=0x([[:xdigit:]]+)/
169
- attributes[Regexp.last_match(1)] = decode_hex_blob(Regexp.last_match(2))
170
- when /^password: "(.+)"/
171
- attributes['password'] = Regexp.last_match(1)
172
- when /^password: 0x([[:xdigit:]]+)/
173
- attributes['password'] = decode_hex_blob(Regexp.last_match(1))
174
- end
175
- end
176
- return attributes
177
- end
178
-
179
- # Unlock this keychain with its password
180
- # @param password [String] Password of the keychain
181
- # @return [Array(String, String, Process::Status)] Execution result
182
- def unlock(password:)
183
- self.class.execute('unlock-keychain', {password: password}, KEYCHAIN_OPTIONS, @path)
184
- end
185
-
186
- # Lock this keychain
187
- # @return [Array(String, String, Process::Status)] Execution result
188
- def lock
189
- self.class.execute('lock-keychain', nil, nil, @path)
190
- end
191
-
192
- # Delete this keychain file from disk
193
- # @return [Array(String, String, Process::Status)] Execution result
194
- def delete
195
- self.class.execute('delete-keychain', nil, nil, @path)
196
- end
197
-
198
- # Configure settings for this keychain (lock timeout, lock on sleep)
199
- # @param timeout [Integer, nil] Inactivity timeout in seconds
200
- # @param lock_on_sleep [Boolean] Whether to lock when system sleeps
201
- # @return [Array(String, String, Process::Status)] Execution result
202
- def set_settings(timeout: nil, lock_on_sleep: false)
203
- args = [SECURITY_UTILITY, 'set-keychain-settings']
204
- args.push('-l') if lock_on_sleep
205
- args.push('-u', '-t', timeout.to_s) if timeout
206
- args.push(@path)
207
- Environment.secure_execute(*args, mode: :capture)
208
- end
209
- end
210
- end
211
-
212
- # Vault backend implementation wrapping macOS system keychain
213
- class MacosSystem < Base
214
- # Account is mandatory in keychain: used when no username is provided
215
- NO_ACCOUNT = 'none'
216
- private_constant :NO_ACCOUNT
217
-
218
- # @param name [String, nil] Specific keychain name, or nil for default
219
- def initialize(name: nil)
220
- super()
221
- @keychain_name = name.nil? ? 'default keychain' : name
222
- @keychain = name.nil? ? MacosSecurity::Keychain.default : MacosSecurity::Keychain.by_name(name)
223
- Aspera.assert(!@keychain.nil?) { "no such keychain #{name}" }
224
- end
225
-
226
- # @return [Hash] Vault information metadata
227
- def info
228
- return {
229
- keychain: @keychain_name
230
- }
231
- end
232
-
233
- # Overview of all secrets (not supported on macOS due to OS restrictions)
234
- # @raise [Error] Always raised
235
- def all
236
- # the only way to list is `dump-keychain` which triggers security alert
237
- raise Error, 'overview not implemented, use macos keychain app'
238
- end
239
-
240
- # Store a secret in the keychain
241
- # @param options [Hash] Secret attributes (label, password, username, description)
242
- # @return [Hash, nil] Result
243
- def set(options)
244
- validate_set(options)
245
- @keychain.password(
246
- :add, :generic, service: options[:label],
247
- account: options[:username] || NO_ACCOUNT, password: options[:password], comment: options[:description]
248
- )
249
- end
250
-
251
- # Retrieve a secret by label
252
- # @param label [String] Secret label identifier
253
- # @param exception [Boolean] Whether to raise if not found
254
- # @return [Hash, nil] Secret attributes or nil
255
- def get(label:, exception: true)
256
- info = @keychain.password(:find, :generic, label: label)
257
- if info.nil?
258
- raise "Secret '#{label}' not found" if exception
259
- return
260
- end
261
- return {
262
- label: label,
263
- username: (info['acct'] unless info['acct'].eql?(NO_ACCOUNT)),
264
- password: info['password'],
265
- description: info['icmt'] # cspell: disable-line
266
- }.compact
267
- end
268
-
269
- # Delete a secret by label
270
- # @param label [String] Secret label identifier
271
- # @return [Hash, nil] Result
272
- def delete(label:)
273
- @keychain.password(:delete, :generic, label: label)
274
- end
275
- end
276
- end
277
- end
@@ -1,91 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'aspera/rest'
4
- require 'aspera/keychain/one_password_base'
5
-
6
- module Aspera
7
- module Keychain
8
- # Manage secrets using the 1Password Connect REST API
9
- # https://developer.1password.com/docs/connect/connect-api-reference/
10
- class OnePasswordApi < Base
11
- include OnePasswordBase
12
-
13
- # @param url [String] Base URL of the 1Password Connect server (e.g. http://localhost:8080)
14
- # @param token [String] Bearer token (Connect token or service-account token)
15
- # @param vault_id [String] ID of the 1Password vault to operate on
16
- def initialize(url:, token:, vault_id:)
17
- super()
18
- @vault_id = vault_id
19
- @api = Rest::Client.new(
20
- base_url: url,
21
- headers: {'Authorization' => "Bearer #{token}"}
22
- )
23
- end
24
-
25
- def info
26
- {
27
- url: @api.base_url,
28
- vault_id: @vault_id
29
- }
30
- end
31
-
32
- def all
33
- items = @api.read("v1/vaults/#{@vault_id}/items")
34
- return items.map do |item|
35
- item_to_secret(@api.read("v1/vaults/#{@vault_id}/items/#{item['id']}")).merge(id: item['id'])
36
- end
37
- end
38
-
39
- def ids
40
- @api.read("v1/vaults/#{@vault_id}/items").map { |item| {id: item['id'], label: item['title']} }
41
- end
42
-
43
- def set(options)
44
- validate_set(options)
45
- Aspera.assert(resolve_id(options[:label], exception: false).nil?) { "secret #{options[:label]} already exist, delete first" }
46
- @api.create("v1/vaults/#{@vault_id}/items", build_item(options))
47
- nil
48
- end
49
-
50
- def get(label:, id: nil, exception: true)
51
- iid = id || resolve_id(label, exception: exception)
52
- return if iid.nil?
53
- return item_to_secret(@api.read("v1/vaults/#{@vault_id}/items/#{iid}")).merge(id: iid)
54
- end
55
-
56
- def delete(label:, id: nil)
57
- iid = id || resolve_id(label, exception: true)
58
- @api.delete("v1/vaults/#{@vault_id}/items/#{iid}")
59
- nil
60
- end
61
-
62
- private
63
-
64
- # Resolve an item id from its title, or else from its id; raises if ambiguous or missing
65
- def resolve_id(label, exception: true)
66
- items = @api.read("v1/vaults/#{@vault_id}/items", {filter: "title eq \"#{label}\""})
67
- raise "Multiple secrets found with label '#{label}': use id to disambiguate" if items.length > 1
68
- # No title matches: the identifier may be an item id
69
- items = @api.read("v1/vaults/#{@vault_id}/items").select { |item| item['id'] == label } if items.empty?
70
- raise "Secret '#{label}' not found" if items.empty? && exception
71
- items.first&.fetch('id')
72
- end
73
-
74
- def build_item(options)
75
- fields = []
76
- fields << {'id' => FIELD_USERNAME, 'type' => 'STRING', 'value' => options[:username]} if options[:username]
77
- fields << {'id' => FIELD_PASSWORD, 'type' => 'CONCEALED', 'value' => options[:password]} if options[:password]
78
- fields << {'id' => FIELD_NOTES_ID, 'type' => 'STRING', 'value' => options[:description]} if options[:description]
79
- item = {
80
- 'title' => options[:label],
81
- 'category' => ITEM_CATEGORY.upcase,
82
- 'vault' => {'id' => @vault_id},
83
- 'fields' => fields
84
- }
85
- # Website of the item
86
- item['urls'] = [{'href' => options[:url], 'primary' => true}] if options[:url]
87
- item
88
- end
89
- end
90
- end
91
- end
@@ -1,39 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'aspera/keychain/base'
4
-
5
- module Aspera
6
- module Keychain
7
- # Shared field constants and item_to_secret conversion for 1Password backends.
8
- # Both the REST (Connect) and CLI (`op`) backends use the same JSON item schema.
9
- module OnePasswordBase
10
- FIELD_USERNAME = 'username'
11
- FIELD_PASSWORD = 'password'
12
- FIELD_URL = 'url'
13
- FIELD_NOTES_ID = 'notesPlain'
14
- ITEM_CATEGORY = 'Login'
15
-
16
- private_constant :FIELD_USERNAME, :FIELD_PASSWORD, :FIELD_URL, :FIELD_NOTES_ID, :ITEM_CATEGORY
17
-
18
- private
19
-
20
- # Convert a 1Password item JSON object to a keychain secret Hash.
21
- # Same JSON schema for API Connect and CLI items.
22
- # Built-in fields are found by `id`, custom fields (generated `id`) by `label`.
23
- # URL is the website of the item, or a custom field `url` (created by previous versions).
24
- def item_to_secret(item)
25
- fields = Array(item['fields'])
26
- by_id = fields.to_h { |f| [f['id'], f['value']] }
27
- by_label = fields.to_h { |f| [f['label'], f['value']] }
28
- urls = Array(item['urls'])
29
- values = {
30
- username: by_id[FIELD_USERNAME] || by_label[FIELD_USERNAME],
31
- password: by_id[FIELD_PASSWORD] || by_label[FIELD_PASSWORD],
32
- url: (urls.find { |u| u['primary'] } || urls.first)&.[]('href') || by_id[FIELD_URL] || by_label[FIELD_URL],
33
- description: by_id[FIELD_NOTES_ID] || by_label[FIELD_NOTES_ID]
34
- }
35
- return {label: item['title']}.merge(values.compact)
36
- end
37
- end
38
- end
39
- end
@@ -1,100 +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
- assert_new_label(options[:label])
46
- args = ['item', 'create', '--category', ITEM_CATEGORY, "--title=#{options[:label]}"]
47
- args << "--url=#{options[:url]}" if options[:url]
48
- args << "#{FIELD_USERNAME}=#{options[:username]}" if options[:username]
49
- args << "#{FIELD_PASSWORD}[password]=#{options[:password]}" if options[:password]
50
- args << "#{FIELD_NOTES_ID}=#{options[:description]}" if options[:description]
51
- op_run(*args)
52
- nil
53
- end
54
-
55
- def get(label:, id: nil, exception: true)
56
- identifier = id || label
57
- stdout, stderr, status = op_capture('item', 'get', identifier, '--format=json', exception: false)
58
- if !status.success?
59
- raise "Multiple secrets found with label '#{label}': use id to disambiguate, or option vault to restrict" if stderr.to_s.match?(/more than one item/i)
60
- raise "Secret '#{label}' not found" if exception
61
- return
62
- end
63
- full = JSON.parse(stdout)
64
- return item_to_secret(full).merge(id: full['id'])
65
- end
66
-
67
- def delete(label:, id: nil)
68
- op_run('item', 'delete', id || label)
69
- nil
70
- end
71
-
72
- private
73
-
74
- def common_flags
75
- flags = []
76
- flags.push('--vault', @vault) unless @vault.nil?
77
- flags.push('--account', @account) unless @account.nil?
78
- flags
79
- end
80
-
81
- def op_json(*args)
82
- stdout, = op_capture(*args, '--format=json', exception: true)
83
- JSON.parse(stdout)
84
- end
85
-
86
- def op_run(*args)
87
- op_capture(*args, exception: true)
88
- nil
89
- end
90
-
91
- def op_capture(*args, exception: true)
92
- Environment.instance.class.secure_execute(
93
- OP_EXECUTABLE, *args, *common_flags,
94
- mode: :capture,
95
- exception: exception
96
- )
97
- end
98
- end
99
- end
100
- end