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.
Files changed (249) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +301 -4
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +139 -58
  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 +10 -7
  13. data/docs/README.md +2551 -772
  14. data/docs/test-mcp-with-ai.md +13 -11
  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 +34 -22
  19. data/lib/aspera/agent/factory.rb +8 -4
  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 +8 -5
  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 +23 -19
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +84 -42
  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 +102 -48
  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 +16 -37
  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 -34
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +49 -4
  50. data/lib/aspera/cli/command_spec.rb +34 -4
  51. data/lib/aspera/cli/completion/ascli.bash +53 -5
  52. data/lib/aspera/cli/completion/ascli.fish +27 -8
  53. data/lib/aspera/cli/completion/ascli.ps1 +63 -0
  54. data/lib/aspera/cli/completion/ascli.zsh +36 -4
  55. data/lib/aspera/cli/completion_actions.rb +594 -0
  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 +45 -0
  59. data/lib/aspera/cli/extended_value.rb +83 -24
  60. data/lib/aspera/cli/formatter.rb +142 -73
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -11
  63. data/lib/aspera/cli/http.rb +17 -13
  64. data/lib/aspera/cli/info.rb +17 -6
  65. data/lib/aspera/cli/mailer.rb +7 -4
  66. data/lib/aspera/cli/mcp/http_servlet.rb +155 -0
  67. data/lib/aspera/cli/mcp/secrets.rb +146 -0
  68. data/lib/aspera/cli/mcp/tool.rb +232 -0
  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 +72 -11
  73. data/lib/aspera/cli/options.schema.yaml +856 -81
  74. data/lib/aspera/cli/parser.rb +64 -31
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +250 -44
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +51 -25
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +207 -141
  81. data/lib/aspera/cli/plugins/console.rb +9 -4
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +22 -8
  84. data/lib/aspera/cli/plugins/faspex5.rb +37 -44
  85. data/lib/aspera/cli/plugins/faspio.rb +41 -8
  86. data/lib/aspera/cli/plugins/httpgw.rb +8 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +186 -121
  88. data/lib/aspera/cli/plugins/node.rb +41 -34
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +572 -59
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +66 -12
  93. data/lib/aspera/cli/plugins/shares.rb +288 -48
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +155 -33
  96. data/lib/aspera/cli/preset_manager.rb +72 -16
  97. data/lib/aspera/cli/prompt.rb +7 -2
  98. data/lib/aspera/cli/result.rb +28 -11
  99. data/lib/aspera/cli/runner.rb +193 -80
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +204 -0
  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 +119 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +32 -40
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +31 -19
  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 +197 -50
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.html.erb +61 -0
  113. data/lib/aspera/cli/web_secret.rb +222 -0
  114. data/lib/aspera/cli/wizard.rb +58 -45
  115. data/lib/aspera/command_line_builder.rb +35 -5
  116. data/lib/aspera/command_line_converter.rb +4 -1
  117. data/lib/aspera/coverage.rb +103 -33
  118. data/lib/aspera/data_repository.rb +42 -25
  119. data/lib/aspera/dot_container.rb +4 -1
  120. data/lib/aspera/duration.rb +45 -0
  121. data/lib/aspera/environment.rb +106 -33
  122. data/lib/aspera/exec_spec.rb +9 -5
  123. data/lib/aspera/faspex_gw.rb +105 -35
  124. data/lib/aspera/faspex_postproc.rb +193 -47
  125. data/lib/aspera/formatter_interface.rb +4 -2
  126. data/lib/aspera/graphql.rb +5 -1
  127. data/lib/aspera/hash_ext.rb +3 -0
  128. data/lib/aspera/id_generator.rb +6 -3
  129. data/lib/aspera/json_rpc/client.rb +55 -35
  130. data/lib/aspera/json_rpc/version.rb +4 -0
  131. data/lib/aspera/line_logger.rb +4 -1
  132. data/lib/aspera/link_header.rb +4 -1
  133. data/lib/aspera/log.rb +20 -10
  134. data/lib/aspera/markdown.rb +155 -115
  135. data/lib/aspera/mime.rb +9 -0
  136. data/lib/aspera/nagios.rb +9 -5
  137. data/lib/aspera/node_emulator.rb +111 -112
  138. data/lib/aspera/oauth/client/base.rb +163 -0
  139. data/lib/aspera/oauth/{boot.rb → client/boot.rb} +8 -4
  140. data/lib/aspera/oauth/{factory.rb → client/factory.rb} +13 -3
  141. data/lib/aspera/oauth/{generic.rb → client/generic.rb} +5 -1
  142. data/lib/aspera/oauth/{json_credentials.rb → client/json_credentials.rb} +4 -1
  143. data/lib/aspera/oauth/{jwt.rb → client/jwt.rb} +6 -3
  144. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  145. data/lib/aspera/oauth/{url_json.rb → client/url_json.rb} +4 -1
  146. data/lib/aspera/oauth/client/web.rb +84 -0
  147. data/lib/aspera/oauth/server/authorize.html.erb +34 -0
  148. data/lib/aspera/oauth/server/pkce.rb +427 -0
  149. data/lib/aspera/orchestrator_workflow_checker.rb +679 -0
  150. data/lib/aspera/persistency_action_once.rb +5 -3
  151. data/lib/aspera/persistency_folder.rb +6 -3
  152. data/lib/aspera/preview/file_types.rb +6 -3
  153. data/lib/aspera/preview/generator.rb +9 -5
  154. data/lib/aspera/preview/options.schema.yaml +3 -3
  155. data/lib/aspera/preview/terminal.rb +11 -6
  156. data/lib/aspera/preview/utils.rb +6 -4
  157. data/lib/aspera/products/connect.rb +5 -2
  158. data/lib/aspera/products/desktop.rb +4 -1
  159. data/lib/aspera/products/other.rb +4 -2
  160. data/lib/aspera/products/transferd.rb +6 -2
  161. data/lib/aspera/products/transferd_service.rb +610 -0
  162. data/lib/aspera/proxy_auto_config.js +2 -2
  163. data/lib/aspera/proxy_auto_config.rb +5 -2
  164. data/lib/aspera/rainbow.rb +30 -1
  165. data/lib/aspera/rest/aspera_errors.rb +55 -60
  166. data/lib/aspera/rest/call_error.rb +3 -0
  167. data/lib/aspera/rest/client.rb +42 -42
  168. data/lib/aspera/rest/error_analyzer.rb +14 -2
  169. data/lib/aspera/rest/list.rb +14 -10
  170. data/lib/aspera/rest/parameters.rb +3 -0
  171. data/lib/aspera/rest/util.rb +13 -4
  172. data/lib/aspera/rest.rb +9 -7
  173. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -11
  174. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +4089 -0
  175. data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0-enhanced.yaml +1097 -0
  176. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  177. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  178. data/lib/aspera/schema/IBM_Aspera_Shares.yaml +819 -7
  179. data/lib/aspera/schema/async_tables.yaml +11 -10
  180. data/lib/aspera/schema/documentation.rb +56 -78
  181. data/lib/aspera/schema/reader.rb +46 -11
  182. data/lib/aspera/schema/registry.rb +45 -24
  183. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  184. data/lib/aspera/schema/validator.rb +4 -1
  185. data/lib/aspera/sealed_hash.rb +166 -0
  186. data/lib/aspera/secret/hider.rb +201 -0
  187. data/lib/aspera/secret/reference.rb +150 -0
  188. data/lib/aspera/secret/resolver.rb +212 -0
  189. data/lib/aspera/secret/store/base.rb +153 -0
  190. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  191. data/lib/aspera/secret/store/factory.rb +103 -0
  192. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  193. data/lib/aspera/secret/store/keeper.rb +141 -0
  194. data/lib/aspera/secret/store/macos_security.rb +284 -0
  195. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  196. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  197. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  198. data/lib/aspera/secret/store/secret_service.rb +125 -0
  199. data/lib/aspera/secret/strength.rb +119 -0
  200. data/lib/aspera/servlet_helpers.rb +114 -0
  201. data/lib/aspera/ssh.rb +10 -7
  202. data/lib/aspera/ssl.rb +5 -2
  203. data/lib/aspera/string_ext.rb +3 -0
  204. data/lib/aspera/sync/args.schema.yaml +6 -1
  205. data/lib/aspera/sync/conf.schema.yaml +25 -10
  206. data/lib/aspera/sync/database.rb +3 -0
  207. data/lib/aspera/sync/operations.rb +34 -12
  208. data/lib/aspera/temp_file_manager.rb +85 -22
  209. data/lib/aspera/timer_limiter.rb +3 -0
  210. data/lib/aspera/transfer/error.rb +4 -1
  211. data/lib/aspera/transfer/faux_file.rb +4 -1
  212. data/lib/aspera/transfer/parameters.rb +22 -14
  213. data/lib/aspera/transfer/result.rb +3 -0
  214. data/lib/aspera/transfer/resumer.rb +6 -4
  215. data/lib/aspera/transfer/spec.rb +45 -18
  216. data/lib/aspera/transfer/spec.schema.yaml +8 -5
  217. data/lib/aspera/transfer/units.rb +75 -0
  218. data/lib/aspera/uri_reader.rb +57 -7
  219. data/lib/aspera/web_auth/index.html.erb +20 -0
  220. data/lib/aspera/web_auth/paste.rb +109 -0
  221. data/lib/aspera/web_auth/receiver.rb +50 -0
  222. data/lib/aspera/web_auth/relay.rb +76 -0
  223. data/lib/aspera/web_auth/reply.html.erb +150 -0
  224. data/lib/aspera/web_auth/server.rb +59 -14
  225. data/lib/aspera/web_page.html.erb +262 -0
  226. data/lib/aspera/web_page.rb +66 -0
  227. data/lib/aspera/web_server_simple.rb +82 -13
  228. data/lib/aspera/yaml.rb +5 -1
  229. data/llms.txt +81 -0
  230. data/skills/ascli/SKILL.md +88 -0
  231. data.tar.gz.sig +0 -0
  232. metadata +116 -48
  233. metadata.gz.sig +0 -0
  234. data/lib/aspera/cli/mcp_tool.rb +0 -189
  235. data/lib/aspera/keychain/base.rb +0 -25
  236. data/lib/aspera/keychain/encrypted_hash.rb +0 -188
  237. data/lib/aspera/keychain/factory.rb +0 -59
  238. data/lib/aspera/keychain/hashicorp_vault.rb +0 -74
  239. data/lib/aspera/keychain/macos_security.rb +0 -171
  240. data/lib/aspera/keychain/one_password_api.rb +0 -86
  241. data/lib/aspera/keychain/one_password_base.rb +0 -34
  242. data/lib/aspera/keychain/one_password_cli.rb +0 -98
  243. data/lib/aspera/oauth/base.rb +0 -141
  244. data/lib/aspera/oauth/web.rb +0 -57
  245. data/lib/aspera/oauth.rb +0 -9
  246. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +0 -1784
  247. data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml +0 -249
  248. data/lib/aspera/secret_hider.rb +0 -117
  249. data/lib/aspera/web_auth/index.html +0 -147
@@ -1,188 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'aspera/hash_ext'
4
- require 'aspera/environment'
5
- require 'aspera/log'
6
- require 'aspera/assert'
7
- require 'aspera/keychain/base'
8
- require 'aspera/yaml'
9
- require 'openssl'
10
- require 'yaml'
11
-
12
- module Aspera
13
- module Keychain
14
- # Manage secrets in a simple Hash
15
- class EncryptedHash < Base
16
- LEGACY_CIPHER_NAME = 'aes-256-cbc'
17
- DEFAULT_CIPHER_NAME = 'aes-256-cbc'
18
- FILE_TYPE = 'encrypted_hash_vault'
19
- FILE_KEYS = %w[version type cipher data].sort.freeze
20
- FILE_KEYS_KDF = (%w[kdf] + FILE_KEYS).sort.freeze
21
- # PBKDF2 parameters for new vaults
22
- KDF_ITERATIONS = 200_000
23
- KDF_DIGEST = 'SHA256'
24
- KDF_SALT_BYTES = 16
25
- private_constant :LEGACY_CIPHER_NAME, :DEFAULT_CIPHER_NAME, :FILE_TYPE, :FILE_KEYS, :FILE_KEYS_KDF,
26
- :KDF_ITERATIONS, :KDF_DIGEST, :KDF_SALT_BYTES
27
-
28
- def initialize(file:, password:)
29
- super()
30
- Aspera.assert_type(file, String) { 'path to vault file' }
31
- @path = file
32
- Log.dump(:vault_file, @path)
33
- @all_secrets = {}
34
- @cipher_name = DEFAULT_CIPHER_NAME
35
- @kdf_params = nil
36
- # true when the vault was created by v4.26.0 (password padded with zeros, no KDF)
37
- @legacy_key = false
38
- vault_encrypted_data = nil
39
- Log.dump(:vault_file, File.expand_path(@path))
40
- if File.exist?(@path)
41
- vault_file = File.read(@path)
42
- if vault_file.start_with?('---')
43
- vault_info = YAML.parse(vault_file).to_ruby
44
- sorted_keys = vault_info.keys.sort
45
- Aspera.assert(sorted_keys == FILE_KEYS || sorted_keys == FILE_KEYS_KDF) { "Invalid vault file: #{@path}: #{sorted_keys}" }
46
- @cipher_name = vault_info['cipher']
47
- @kdf_params = vault_info['kdf']
48
- # vault created before PBKDF2 was introduced (v4.26.0 format: no kdf field)
49
- @legacy_key = @kdf_params.nil?
50
- vault_encrypted_data = vault_info['data']
51
- else
52
- # legacy vault file (binary, pre-YAML format)
53
- @cipher_name = LEGACY_CIPHER_NAME
54
- @legacy_key = true
55
- vault_encrypted_data = File.read(@path, mode: 'rb')
56
- end
57
- end
58
- # setting password also creates the cipher
59
- @cipher = cipher(password)
60
- @all_secrets = Yaml.safe_load(@cipher.decrypt(vault_encrypted_data)) || {} if !vault_encrypted_data.nil?
61
- end
62
-
63
- def info
64
- return {
65
- file: @path
66
- }
67
- end
68
-
69
- def all
70
- result = []
71
- @all_secrets.each do |label, values|
72
- normal = values.symbolize_keys
73
- normal[:label] = label
74
- CONTENT_KEYS.each { |k| normal[k] = '' unless normal.key?(k) }
75
- result.push(normal)
76
- end
77
- return result
78
- end
79
-
80
- # set a secret
81
- # @param options [Hash] with keys :label, :username, :password, :url, :description
82
- def set(options)
83
- validate_set(options)
84
- label = options.delete(:label)
85
- Aspera.assert(!@all_secrets.key?(label)) { "secret #{label} already exist, delete first" }
86
- @all_secrets[label] = options.symbolize_keys
87
- save
88
- end
89
-
90
- def get(label:, exception: true)
91
- Aspera.assert(@all_secrets.key?(label)) { "Label not found: #{label}" } if exception
92
- result = @all_secrets[label].clone
93
- result[:label] = label if result.is_a?(Hash)
94
- return result
95
- end
96
-
97
- def delete(label:)
98
- @all_secrets.delete(label)
99
- save
100
- end
101
-
102
- def change_password(password)
103
- # Generate new KDF params so a password change also re-salts the vault
104
- @kdf_params = nil
105
- @cipher = cipher(password)
106
- save
107
- end
108
-
109
- private
110
-
111
- # Minimal cipher wrapper using OpenSSL, compatible with the SymmetricEncryption
112
- # binary format: a 6-byte header "@EnC\x00\x00" followed by AES ciphertext
113
- # produced with a zero IV (encoding: :none, no random IV in header).
114
- class OsslCipher
115
- HEADER = "@EnC\x00\x00".b.freeze
116
- HEADER_SIZE = HEADER.bytesize
117
-
118
- def initialize(cipher_name, key)
119
- @cipher_name = cipher_name
120
- @key = key
121
- end
122
-
123
- def encrypt(plaintext)
124
- c = OpenSSL::Cipher.new(@cipher_name)
125
- c.encrypt
126
- c.key = @key
127
- c.iv = "\x00".b * c.iv_len
128
- HEADER + c.update(plaintext.b) + c.final
129
- end
130
-
131
- def decrypt(ciphertext)
132
- body = ciphertext.b[HEADER_SIZE..]
133
- c = OpenSSL::Cipher.new(@cipher_name)
134
- c.decrypt
135
- c.key = @key
136
- c.iv = "\x00".b * c.iv_len
137
- (c.update(body) + c.final).force_encoding(Encoding::UTF_8)
138
- end
139
- end
140
-
141
- # Derive an AES key from `new_password`.
142
- # @legacy_key is true for vaults created by v4.26.0 or earlier (no kdf field):
143
- # key = password truncated/zero-padded to key_bytes (same as symmetric-encryption did).
144
- # Otherwise PBKDF2 is used. When @kdf_params is nil (new vault or password change)
145
- # a fresh salt is generated; when already set (existing vault) it is reused.
146
- def cipher(new_password)
147
- key_bytes = @cipher_name.split('-')[1].to_i / Environment::BITS_PER_BYTE
148
- key =
149
- if @legacy_key
150
- # Replicate the v4.26.0 key derivation: password + NUL padding, truncated to key_bytes
151
- (new_password + ("\x00" * key_bytes))[0, key_bytes]
152
- else
153
- if @kdf_params.nil?
154
- # New vault or password change: generate a fresh salt
155
- salt = OpenSSL::Random.random_bytes(KDF_SALT_BYTES)
156
- @kdf_params = {
157
- 'algo' => 'PBKDF2',
158
- 'digest' => KDF_DIGEST,
159
- 'iterations' => KDF_ITERATIONS,
160
- 'salt' => [salt].pack('m0') # base64, no newlines
161
- }
162
- end
163
- salt = @kdf_params['salt'].unpack1('m0')
164
- OpenSSL::KDF.pbkdf2_hmac(
165
- new_password,
166
- salt: salt,
167
- iterations: @kdf_params['iterations'],
168
- length: key_bytes,
169
- hash: @kdf_params['digest']
170
- )
171
- end
172
- OsslCipher.new(@cipher_name, key)
173
- end
174
-
175
- # save current data to file with format
176
- def save
177
- vault_info = {
178
- 'version' => '1.1.0',
179
- 'type' => FILE_TYPE,
180
- 'cipher' => @cipher_name,
181
- 'kdf' => @kdf_params,
182
- 'data' => @cipher.encrypt(YAML.dump(@all_secrets))
183
- }
184
- Environment.write_file_restricted(@path, force: true) { YAML.dump(vault_info) }
185
- end
186
- end
187
- end
188
- end
@@ -1,59 +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
- Aspera.assert_values(vault_type, LIST.map(&:to_s)) { 'vault.type' }
19
- case vault_type
20
- when 'file'
21
- # `name` (or `file`), default: `vault.bin`
22
- info[:file] = info.delete(:name) || info[:file] || 'vault.bin'
23
- info[:file] = File.join(folder, info[:file]) unless File.absolute_path?(info[:file])
24
- Aspera.assert(!password.nil?, 'please provide password')
25
- info[:password] = password
26
- # this module requires compilation, so it is optional
27
- require 'aspera/keychain/encrypted_hash'
28
- Keychain::EncryptedHash.new(**info)
29
- when 'system'
30
- case Environment.instance.os
31
- when Environment::OS_MACOS
32
- info[:name] ||= name
33
- Keychain::MacosSystem.new(**info)
34
- else
35
- raise Error, 'not implemented for this OS'
36
- end
37
- when 'vault'
38
- require 'aspera/keychain/hashicorp_vault'
39
- info[:token] ||= password
40
- Keychain::HashicorpVault.new(**info)
41
- when '1password'
42
- source = info.delete(:source) || 'api'
43
- Aspera.assert_values(source, %w[api cli]) { 'vault.source' }
44
- case source
45
- when 'api'
46
- require 'aspera/keychain/one_password_api'
47
- info[:token] ||= password
48
- Keychain::OnePasswordApi.new(**info)
49
- when 'cli'
50
- require 'aspera/keychain/one_password_cli'
51
- Keychain::OnePasswordCli.new(**info)
52
- end
53
- else Aspera.error_unexpected_value(vault_type)
54
- end
55
- end
56
- end
57
- end
58
- end
59
- end
@@ -1,74 +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
- get(label: label).merge(label: label)
36
- end
37
- end
38
-
39
- # Set a secret
40
- # @param options [Hash] with keys :label, :username, :password, :url, :description
41
- def set(options)
42
- validate_set(options)
43
- label = options.fetch(:label)
44
- data = {
45
- username: options[:username],
46
- password: options[:password],
47
- url: options[:url],
48
- description: options[:description]
49
- }.compact
50
- Vault.logical.write(path(label), data: data)
51
- end
52
-
53
- def get(label:, exception: true)
54
- secret = Vault.logical.read(path(label))
55
- if secret.nil?
56
- raise "Secret '#{label}' not found" if exception
57
- return
58
- end
59
- return secret.data[:data]
60
- end
61
-
62
- def delete(label:)
63
- path = path(label)
64
- Vault.logical.delete(path)
65
- end
66
-
67
- private
68
-
69
- def path(label)
70
- "#{STORE_PATH}#{label}"
71
- end
72
- end
73
- end
74
- end
@@ -1,171 +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
- }
22
- ADD_PASS_OPTIONS = {
23
- account: :a,
24
- creator: :c,
25
- type: :C,
26
- domain: :d,
27
- kind: :D,
28
- value: :G,
29
- comment: :j,
30
- label: :l,
31
- path: :p,
32
- port: :P,
33
- protocol: :r,
34
- server: :s,
35
- service: :s,
36
- auth: :t,
37
- password: :w,
38
- getpass: :g
39
- }.freeze
40
- class << self
41
- def execute(command, options = nil, supported = nil, last_opt = nil)
42
- url = options&.delete(:url)
43
- if !url.nil?
44
- uri = URI.parse(url)
45
- Aspera.assert(uri.scheme.eql?('https'), 'only https')
46
- options[:protocol] = 'htps' # cspell: disable-line
47
- Aspera.assert(!uri.host.nil?, type: Error) { 'host required in URL' }
48
- options[:server] = uri.host
49
- options[:path] = uri.path unless ['', '/'].include?(uri.path)
50
- options[:port] = uri.port unless uri.port.eql?(443) && !url.include?(':443/')
51
- end
52
- command_args = [SECURITY_UTILITY, command]
53
- options&.each do |k, v|
54
- Aspera.assert(supported.key?(k)) { "unknown option: #{k}" }
55
- next if v.nil?
56
- command_args.push("-#{supported[k]}")
57
- command_args.push(v.shellescape) unless v.empty?
58
- end
59
- command_args.push(last_opt) unless last_opt.nil?
60
- Environment.secure_execute(*command_args, mode: :capture).first
61
- end
62
-
63
- def key_chains(output)
64
- output.split("\n").collect { |line| new(line.strip.gsub(/^"|"$/, '')) }
65
- end
66
-
67
- def default
68
- key_chains(execute('default-keychain')).first
69
- end
70
-
71
- def login
72
- key_chains(execute('login-keychain')).first
73
- end
74
-
75
- def list(options = {})
76
- Aspera.assert_values(options[:domain], DOMAINS, type: ParameterError) { 'domain' } unless options[:domain].nil?
77
- key_chains(execute('list-keychains', options, LIST_OPTIONS))
78
- end
79
-
80
- def by_name(name)
81
- list.find { |kc| kc.path.end_with?("/#{name}.keychain-db") }
82
- end
83
- end
84
- attr_reader :path
85
-
86
- def initialize(path)
87
- @path = path
88
- end
89
-
90
- def decode_hex_blob(string)
91
- [string].pack('H*').force_encoding('UTF-8')
92
- end
93
-
94
- def password(operation, pass_type, options)
95
- Aspera.assert_values(operation, %i[add find delete]) { 'operation' }
96
- Aspera.assert_values(pass_type, %i[generic internet]) { 'pass_type' }
97
- Aspera.assert_type(options, Hash)
98
- missing = (operation.eql?(:add) ? %i[account service password] : %i[label]) - options.keys
99
- Aspera.assert(missing.empty?) { "missing options: #{missing}" }
100
- options[:getpass] = '' if operation.eql?(:find)
101
- output = self.class.execute("#{operation}-#{pass_type}-password", options, ADD_PASS_OPTIONS, @path)
102
- raise output.gsub(/^.*: /, '') if output.start_with?('security: ')
103
- return unless operation.eql?(:find)
104
- attributes = {}
105
- output.split("\n").each do |line|
106
- case line
107
- when /^keychain: "(.+)"/
108
- # ignore
109
- when /0x00000007 .+="(.+)"/
110
- attributes['label'] = Regexp.last_match(1)
111
- when /"(\w{4})".+="(.+)"/
112
- attributes[Regexp.last_match(1)] = Regexp.last_match(2)
113
- when /"(\w{4})"<blob>=0x([[:xdigit:]]+)/
114
- attributes[Regexp.last_match(1)] = decode_hex_blob(Regexp.last_match(2))
115
- when /^password: "(.+)"/
116
- attributes['password'] = Regexp.last_match(1)
117
- when /^password: 0x([[:xdigit:]]+)/
118
- attributes['password'] = decode_hex_blob(Regexp.last_match(1))
119
- end
120
- end
121
- return attributes
122
- end
123
- end
124
- end
125
-
126
- class MacosSystem < Base
127
- def initialize(name: nil)
128
- super()
129
- @keychain_name = name.nil? ? 'default keychain' : name
130
- @keychain = name.nil? ? MacosSecurity::Keychain.default : MacosSecurity::Keychain.by_name(name)
131
- Aspera.assert(!@keychain.nil?) { "no such keychain #{name}" }
132
- end
133
-
134
- def info
135
- return {
136
- keychain: @keychain_name
137
- }
138
- end
139
-
140
- def all
141
- # the only way to list is `dump-keychain` which triggers security alert
142
- raise Error, 'overview not implemented, use macos keychain app'
143
- end
144
-
145
- def set(options)
146
- validate_set(options)
147
- @keychain.password(
148
- :add, :generic, service: options[:label],
149
- account: options[:username] || 'none', password: options[:password], comment: options[:description]
150
- )
151
- end
152
-
153
- def get(label:, exception: true)
154
- info = @keychain.password(:find, :generic, label: label)
155
- if info.nil?
156
- raise "Secret '#{label}' not found" if exception
157
- return
158
- end
159
- return {
160
- label: label,
161
- password: info['password'],
162
- description: info['icmt'] # cspell: disable-line
163
- }
164
- end
165
-
166
- def delete(label:)
167
- raise Error, 'delete not implemented, use macos keychain app'
168
- end
169
- end
170
- end
171
- end
@@ -1,86 +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
- @api.create("v1/vaults/#{@vault_id}/items", build_item(options))
46
- nil
47
- end
48
-
49
- def get(label:, id: nil, exception: true)
50
- iid = id || resolve_id(label, exception: exception)
51
- return if iid.nil?
52
- return item_to_secret(@api.read("v1/vaults/#{@vault_id}/items/#{iid}")).merge(id: iid)
53
- end
54
-
55
- def delete(label:, id: nil)
56
- iid = id || resolve_id(label, exception: true)
57
- @api.delete("v1/vaults/#{@vault_id}/items/#{iid}")
58
- nil
59
- end
60
-
61
- private
62
-
63
- # Resolve an item id from its title; raises if ambiguous or missing
64
- def resolve_id(label, exception: true)
65
- items = @api.read("v1/vaults/#{@vault_id}/items", {filter: "title eq \"#{label}\""})
66
- raise "Multiple secrets found with label '#{label}': use id to disambiguate" if items.length > 1
67
- raise "Secret '#{label}' not found" if items.empty? && exception
68
- items.first&.fetch('id')
69
- end
70
-
71
- def build_item(options)
72
- fields = []
73
- fields << {'id' => FIELD_USERNAME, 'type' => 'STRING', 'value' => options[:username]} if options[:username]
74
- fields << {'id' => FIELD_PASSWORD, 'type' => 'CONCEALED', 'value' => options[:password]} if options[:password]
75
- fields << {'id' => FIELD_URL, 'type' => 'URL', 'value' => options[:url]} if options[:url]
76
- fields << {'id' => FIELD_NOTES_ID, 'type' => 'STRING', 'value' => options[:description]} if options[:description]
77
- {
78
- 'title' => options[:label],
79
- 'category' => ITEM_CATEGORY.upcase,
80
- 'vault' => {'id' => @vault_id},
81
- 'fields' => fields
82
- }
83
- end
84
- end
85
- end
86
- end
@@ -1,34 +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
- # Accepts both API Connect items (field keyed by 'id') and CLI items
22
- # (field keyed by 'id' falling back to 'label').
23
- def item_to_secret(item)
24
- fields = Array(item['fields']).to_h { |f| [f['id'] || f['label'], f['value']] }
25
- secret = {label: item['title']}
26
- secret[:username] = fields[FIELD_USERNAME] unless fields[FIELD_USERNAME].nil?
27
- secret[:password] = fields[FIELD_PASSWORD] unless fields[FIELD_PASSWORD].nil?
28
- secret[:url] = fields[FIELD_URL] unless fields[FIELD_URL].nil?
29
- secret[:description] = fields[FIELD_NOTES_ID] unless fields[FIELD_NOTES_ID].nil?
30
- return secret
31
- end
32
- end
33
- end
34
- end