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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ba71af1e93e41d6942ddcf6667980c1c4164fe36ad099b22745574a548bba66d
4
- data.tar.gz: 83326746bc3d07843de75565f78bf57e6678a706eb0b9a66e6405f46be07cc8c
3
+ metadata.gz: 22b08acc7dfd929269009bc08f4419d5097e3d170d5095777a099efa9778ba58
4
+ data.tar.gz: c517da2115165b0ee092783ff62753a3f96cbb853758ba9ef5bc56b008dc2983
5
5
  SHA512:
6
- metadata.gz: 7ec3c7a4174ae432743a3215e296738c2d7cecf9a27751558dc706c4b6098b885bb0ad7cc86aebc7b4fc6e75d4197ebba74e4df20dd6c4cde7505fb297331e81
7
- data.tar.gz: '04548d7fe93ac3256c1912ea39d9830c6e1ae35dd6c6d6ac470bcfbce5220ea2092a137aaf1c2d78662aaaa9dfbd05a7138933f1e8de9edabcd5ea6c069d83bf'
6
+ metadata.gz: 3eedce17b67bdfa8b838e3d283da26cc30c3d149542aa4e20ca4160698f8412fbf9751a0e20393d77c1a03748a506eaaba2418875057a0ddebe2797de5339b33
7
+ data.tar.gz: b02389f18f68d814fe55a2b2eb98b39d536c894bc8e9e4ede77f72d05861e01077b5f29e29aa43b81767ae4ea7817b9c6bd4463987bd5d5e54d2e64aa43dd625
checksums.yaml.gz.sig CHANGED
Binary file
data/BUGS.md CHANGED
@@ -1,6 +1,8 @@
1
- # Reporting bugs and security vulnerabilities
1
+ # Reporting bugs
2
2
 
3
- Report bug, including vulnerability issues following this:
3
+ Report a bug in a [GitHub issue](https://github.com/IBM/aspera-cli/issues).
4
+
5
+ **Do not report a security vulnerability in a public issue**: see [SECURITY.md](SECURITY.md).
4
6
 
5
7
  Please, make sure to include the following information:
6
8
 
@@ -17,7 +19,7 @@ IMPORTANT: Remove any confidential information from the logs before posting them
17
19
  ## Scope of Support
18
20
 
19
21
  Architecture of `ascli` :
20
- ![architecture](docs/architecture.png)
22
+ ![architecture](docs/architecture.svg)
21
23
 
22
24
  The scope is exclusively the Ruby gem `aspera-cli` (green) and its **_interactions_** with IBM components:
23
25
 
@@ -36,10 +38,3 @@ For example, if `ascp` fails to transfer a file, there are two possibilities:
36
38
 
37
39
  * `ascp` cannot transfer due to a configuration on the server side, in which case the bug should be reported to IBM
38
40
  * `ascli` is not using it correctly (missing or wrong parameter provided to `ascp`), in which case the bug should be reported to this project
39
-
40
- ## Security Policy
41
-
42
- | Version | Supported |
43
- | ------- | ------------------ |
44
- | >= 4.0 | :white_check_mark: |
45
- | < 4.0 | :x: |
data/CHANGELOG.md CHANGED
@@ -1,5 +1,302 @@
1
1
  # Changes (Release notes)
2
2
 
3
+ ## 4.29.0
4
+
5
+ Released: 2026-11-17
6
+
7
+ Highlights:
8
+
9
+ * `ascli` as a tool for AI assistants: `mcp server` is hardened (the AI client can neither execute code nor write files where it chooses) and no longer experimental; commands describe themselves (schema of structured arguments with `help`, development guides of Orchestrator and Aspera on Cloud Automation read by section); new file `llms.txt` (also as an agent skill) that tells an AI how to drive IBM Aspera products with `ascli`.
10
+ * Analysis of `ascp` logs, local (`config ascp logs`) or on a server (`server logs`): statistics, sessions, diagnostics with recommendations.
11
+ * Named secret stores for `vault`, new types `keeper` and `secret_service`, HashiCorp AppRole and token file, secrets inspected without their value.
12
+ * Web login without local port (`--ui.web_auth=paste`), SAML web authentication for `shares` (`--auth=web`).
13
+ * New plugin `transferd`: Transfer Daemon as a service. Export and import of Aspera on Cloud Automation workflows. Many new `orchestrator` commands. Improved shell completion.
14
+ * Project: OpenSSF Best Practices silver badge, test coverage 96.6%.
15
+
16
+ **This version has several breaking changes**: read the **Breaking Changes** section below before upgrading and validate production workflows before deployment. In particular: Ruby 3.3 or later is required, `config wizard`, `config detect` and `config preset lookup` take their arguments as a `Hash` (`@: url=...`), and some `orchestrator` commands are renamed.
17
+
18
+ ### New Features
19
+
20
+ * `ascli`:
21
+ * New file `llms.txt` (in the gem and in the repository): what `ascli` does with IBM Aspera products, and how to discover commands, arguments and options, on the command line or through `mcp server`. Same content as an agent skill in folder `skills/ascli`. The repository is also a Claude Code plugin marketplace: `/plugin install ascli --marketplace IBM/aspera-cli`.
22
+ * Web authentication (`--auth=web`): new key `web_auth` of option `ui`. With `--ui.web_auth=paste`, no local port is opened: after login, the user pastes in the terminal the URL the browser was redirected to. It allows SSO when the browser cannot reach the host that runs `ascli` (e.g. jump server). If `ascli` is also installed on the workstation, it displays a command `ascli config web_login <code>` to run there instead. Default: `port` (unchanged).
23
+ * Improved shell completion: structures, extended values, local files and folders, presets (with their `_comment`), transfer jobs and `--query`.
24
+ * SSH keys of type `ed25519` are supported without additional gem. Gem `bcrypt_pbkdf` is only needed for OpenSSH keys protected by a passphrase.
25
+ * `config`:
26
+ * New command `ascp logs`: analysis of `ascp` log files (`ascp` 4.0 and later), of client and server (joined by session). Sub-commands: statistics, `sessions` (with context columns: product, transport, authentication, proxy, FIPS), `diagnostics` (severity, category, hint and recommended `ascp` options or `aspera.conf` parameters), `health` (Nagios format), multi-session transfers, rates per period, errors by peer, files, licenses, and parsed `records` for `--out.query`. Accepts gzip files, folders and the standard input (`-`). New option `ascp_logs`: thresholds of diagnostics, `timezone`, `health_minutes`.
27
+ * `ascp errors`: optional argument `session` lists error codes found in logs, with category and the corresponding error of the management port.
28
+ * `vault`: option `vault` declares several named stores: `{"default":"<name>","cache_ttl":60,"stores":{"<name>":{"type":...}}}`. A secret can be read from any store with `@vault://<store>/<path>[?<options>][#<field>]`; `@vault:<label>.<field>` uses the default store. New commands `vault stores`, `check`, `overview` and `field <label>`: they inspect stores and secrets without showing values. The former single-store form of option `vault` is deprecated, and converted when the configuration file is loaded (a backup is saved). `@file:` in options `vault` and `vault_password` is restricted by option `security` (refused by default in `mcp server`).
29
+ * `vault` type `file`: parameter `password` (value, or `@file:<path>`) replaces option `vault_password`.
30
+ * `vault` type HashiCorp: `token` accepts `@file:<path>` (read again when modified, e.g. by Vault Agent). New parameters `approle`, `namespace` and `ca_file`.
31
+ * `vault`: new types `keeper` (Keeper Secrets Manager, optional gem `keeper_secrets_manager`) and `secret_service` (Linux Secret Service: GNOME Keyring, KWallet, KeePassXC, with `secret-tool`).
32
+ * `wizard` adds `_comment: "wizard: <application>"` to the preset it creates.
33
+ * Asynchronous transfer jobs (`list`, `status`, `cleanup`) are managed by `agents jobs`. `config transfer` is deprecated.
34
+ * `transferd` (`install`, `list`) and `ascp install` are deprecated, use the new plugin `transferd`.
35
+ * `preset set` merges into the configuration at three levels (see Breaking Changes below). `preset update`, `initialize` and `unset` are deprecated, and show the command to use.
36
+ * `transferd`: new plugin for the Transfer Daemon.
37
+ * `install [version]` and `list`. `install` does nothing if the version is already installed.
38
+ * `info` and `transfers show|cancel <transfer_id>` for a running daemon (options `--url`, `--api-key`, `--ca-file`; requires gem `grpc`).
39
+ * `service` (`spec`, `install`, `configure`, `status`, `uninstall`, `use`, `versions`): run `transferd` as a `systemd` service, with its configuration validated, and SDK versions side by side (`use` for rollback). New global option `--dry-run` shows the actions without change.
40
+ * `server`: new command `logs`: same analysis as `config ascp logs`, on the log files of the server, read over SSH (size limited by key `remote_max_size` of option `ascp_logs`, default 256 MB).
41
+ * `aoc`:
42
+ * `automation` is no longer beta. New commands `automation workflows details`, `export`, `import` and `duplicate`.
43
+ * New command `automation guide` (`toc`, `full`, `section <anchor>`): the Aspera on Cloud Automation Development Guide.
44
+ * `faspex5`: web authentication (`--auth=web`) uses PKCE (`S256`), checked by Faspex 5.0.16 and later. Nothing to change in the configuration.
45
+ * `shares`: new option `--auth=web`: SAML authentication with the web browser, with `--ui.web_auth=port` (default) or `paste`. It requires a patch of Shares, provided in `docs/shares` until it is part of a Shares release (see manual).
46
+ * `node`: `asperabrowser` opens the new Aspera Browser web application (option `asperabrowserurl`), as the former one is no longer available. The node credentials are given in the fragment of the URL, which the browser does not send to the web server.
47
+ * `orchestrator`:
48
+ * New commands: `tasks`, `alerts list`, `queues`, `pools`, `plugins` (`reload`, `enable`, `import`), `workflows` (`parents`, `steps`, `test_step`, `test_status`), `portlets`, `users create`, `workorders delete`, `workorders worksteps`, `worksteps reset`, `monitors activate|deactivate`, statistics (`stats` of `workorders`, `worksteps` and `queues`), and `control` (engine, monitor and workers).
49
+ * `workflows check_import` detects more problems that make a workflow unusable (steps that never start, loops, invalid links or lookups).
50
+ * `workflows development` and `plugins spec` are read by section (`toc`, `full`, `section <anchor>`), so that an AI assistant reads only what it needs.
51
+ * `connect`: IBM Aspera Connect will be deprecated in 2027: the transfer agent `connect` displays a warning that recommends IBM Aspera for Desktop (`--transfer=desktop`).
52
+ * `mcp`: no longer experimental: the plugin follows the same compatibility rules as other plugins.
53
+ * **library**:
54
+ * New class `Aspera::Secret::Resolver`: references `secret://<store>/<path>[?<options>][#<field>]` to secrets of named stores, read when used, with a cache. It can also write secrets (`writable: true`) and inspect stores and references without reading values.
55
+ * `Aspera::Log#logger=` sends logs to the logger of the application.
56
+ * `Aspera::SealedHash.seal` and `unseal`: new parameters `encrypt:` and `reverse:`.
57
+ * New token creator `Aspera::OAuth::SharesWeb` (`grant_method: :shares_web`).
58
+ * Transfer agents: new optional method `transfer_cancel`. Agent `transferd`: parameters `api_key` and `ca_file` for an existing daemon, methods `info` and `create_client`, new fields in `transfer_status`, reader `transfer_id`.
59
+ * **project**:
60
+ * OpenSSF Best Practices: silver badge (<https://www.bestpractices.dev/projects/5861>).
61
+ * Test coverage: 96.6% of lines (was 85%), badge in `README.md`. Branch coverage is also measured.
62
+ * New `GOVERNANCE.md` and `docs/ASSURANCE_CASE.md` (security requirements, threat model). Code review requirements in `CONTRIBUTING.md`.
63
+ * Each source file has an SPDX copyright and license header.
64
+
65
+ ### Issues Fixed
66
+
67
+ * Security:
68
+ * `mcp server` (security level `high`): a client could execute code, or write a file where it chooses, through some options (`notify_template`, `fpac`, `ui` key `command`, `out` key `file`, `output`, `pid_file`, `home`, `plugin_folder`, `sdk_url`, `locations_url`), the folder `plugins` of the configuration folder, `config plugins create` and `faspex5 postprocessing`. They are now available only at level `low`, on the command line and in presets. At levels `medium` and `high`, `config preset set` refuses them, `config commands` does not list refused commands, and local files are written only in the new key `writable_paths` of option `security` (none by default).
69
+ * `config transferd install`, `config ascp install`: a file or a link of the SDK archive cannot be written outside of the installation folder. Reported by [@thesmartshadow](https://github.com/thesmartshadow).
70
+ * `config plugins create` refuses a plugin name that is not made of lowercase letters, digits and underscores.
71
+ * `ascli`:
72
+ * `--out.select` with a dot-path key (e.g. `directory_user.type`) selected no item with formats `json`, `jsonpp`, `yaml` and `ruby`. Matching no item displayed a table with headings only, instead of `<empty>`.
73
+ * An argument without `=` collected by `@:` is reported as a bad argument, instead of an assertion failure. Errors of extended values name their modifier (e.g. `@file:`).
74
+ * `@extend:` no longer evaluates again the values it inserts (e.g. read by `@env:` or `@file:`).
75
+ * An unknown key of a `Hash` option in dot notation (e.g. `--ui.foo=1`) gave an extra `unprocessed values` error.
76
+ * When the renewal of an expired OAuth token fails, the error of the renewal is reported, instead of the original authorization error.
77
+ * In debug logs, a command argument that contains a single quote was quoted wrongly.
78
+ * Gem dependency: excludes `regexp_parser` 2.13.2, with which `json_schemer` fails to load.
79
+ * `config`:
80
+ * `preset update` saved all the options of the command line in the preset, also those placed before `update` (e.g. `--home`, `--log-level`, `--format`).
81
+ * `preset set`: the value is evaluated once: `@val:@file:<path>` stores `@file:<path>`, as documented, not the content of the file. The result of an evaluation is no longer evaluated again.
82
+ * `initdemo`: the demo server preset allows the SSH host key `ssh-rsa`, the only one offered by the demo server, so that `server browse` and other file operations work. To fix a preset created by an earlier version: recreate it, or add `--ssh-options=@json:'{"host_key":["ssh-rsa"]}'`.
83
+ * `vault` type `file`: the vault keeps its owner, group and mode when it is changed by another user, e.g. root.
84
+ * `vault` type HashiCorp: responses of Vault failed with `wrong number of arguments` with gem `json` 3.
85
+ * `aoc`:
86
+ * `automation instances show` did not return. It now accepts the numeric identifier or the UUID.
87
+ * `packages receive` with option `package_folder`: two fields (e.g. `{"fld":["name","id"]}`) gave `<name>.id` instead of `<name>.<id>`, and with `seq` or `opt` the existence of the folder was checked in the current folder instead of `to_folder`.
88
+ * `faspex5`: web authentication (`--auth=web`) failed when HTTP basic authentication is enabled on the API client: option `client_secret` is now sent.
89
+ * `orchestrator`: authentication with option `apikey` was rejected (HTTP 401): the API requires `username` with the API key. Option `username` is now required with `apikey`.
90
+ * `node`:
91
+ * Browsing a folder with `--query.per_page` or `--query.page` failed when API v4 is not used.
92
+ * `telemetry`: an integer value of key `interval` (e.g. `0`, as documented) was refused. Same for keys `spawn_timeout_sec` and `spawn_delay_sec` of `transfer_info` (agent `direct`), and `font_ratio` of option `out` (key `img`).
93
+ * `access_keys do <id> show` and `thumbnail` ask the node not to use its cache.
94
+ * `preview`:
95
+ * `events` generated no preview: it now generates previews of new and modified files (option `filter` applies), and deletes the previews of deleted files.
96
+ * Option `skip_format` failed with `FrozenError`.
97
+ * An existing preview is also detected with the preview of the file (`files/<id>/preview`), when the information of the file has no `preview`.
98
+ * **library**: agent `transferd`:
99
+ * `transfer_status` no longer blocks on an ended transfer. When the daemon cannot be reached, does not answer in time, or does not know the transfer, the status is `unknown` instead of `running`. Calls have a timeout: key `timeout` of `agent_params`, default 10 seconds.
100
+ * A process that attaches to an external daemon for each transfer (e.g. Orchestrator) accumulated `at_exit` handlers.
101
+
102
+ ### Breaking Changes
103
+
104
+ * Ruby 3.3 or later is required (3.2 reached end of life in March 2026). Future minimum is 3.4. Policy: a Ruby version is supported until 6 months after its end of official support. Gem dependencies: `net-ssh` 8, `marcel` 2.
105
+ * `orchestrator`:
106
+ * Command `workstep` is renamed `worksteps` (e.g. `worksteps status`), consistent with `workorders`.
107
+ * `workflows development`: document `authoring` is replaced by `guide` (the Aspera Orchestrator Development Guide, which includes the Workflow Authoring Guide): `workflows development authoring toc` is now `workflows development guide toc`, and `workflows development templates customruby` is now `workflows development templates section customruby`.
108
+ * `plugins spec` is now `plugins spec toc`, and `plugins spec <plugin> [section]` is now `plugins spec show <plugin> [section]`.
109
+ * `config`: arguments given in a fixed order are replaced by a `Hash`, usually given with `@:` (items `key=value` in any order):
110
+ * `detect <url> [<plugin>]` is now `detect @: url=<url> plugin=<plugin>`. `url` is still asked if not given.
111
+ * `wizard <url> [<plugin> [<preset>]]` is now `wizard @: url=<url> plugin=<plugin> preset=<preset>`. `url` is still asked if not given. Options `--override` and `--default` are replaced by keys `override` and `default` of the `Hash`. Options of the plugin (`--username`, `--password`, `--private-key`, `--client-id`, `--use-generic-client`...) are unchanged. Option `--key-path` is removed: give the key itself with `--private-key=@file:<path>`. The wizard still uses the default key, or generates one, if `--private-key` is empty.
112
+ * `preset lookup --url=<url> --username=<user>` is now `preset lookup @: url=<url> username=<user>`. Options `--url` and `--username` are no longer used by this command.
113
+ * `preset set` merges into the configuration (JSON Merge Patch: deep merge, `@none:` removes a key) at one of three levels: `set <Hash>` (presets by name, e.g. `set @: p1.url=https://example.com default.server=p1`, `set @: p1=@none:` deletes preset `p1`), `set <name> <Hash>` (parameters of a preset, e.g. `set p1 @: url=https://example.com username=bob`), or `set <name> <param> <value>` (unchanged). Options of the command line are not saved in the preset. Commands `update`, `initialize` and `unset` are deprecated, and show the command to use: `update <name> --url=...` is `set <name> @: url=...` (it now saves only the options placed after `update`), `initialize <name> <Hash>` is `delete <name>` then `set <name> <Hash>`, `unset <name> <param>` is `set <name> <param> @none:`.
114
+ * `config completion`: completion scripts saved in a file must be saved again (see manual). Keys of an option are proposed with a trailing `=` or `.`.
115
+ * **library**: Modules about secrets are in `Aspera::Secret`: `SecretHider` is now `Secret::Hider`, `SecretStrength` is now `Secret::Strength`, `Keychain` is now `Secret::Store`. `Secret::Store::Factory.create` takes only the parameters of the store, and `Factory::LIST` is replaced by `Factory.types`.
116
+
117
+ ### Server Versions
118
+
119
+ Tested with Ruby 4.0.9 on osx-arm64.
120
+
121
+ | Plugin | Product | Version |
122
+ | ------------ | ------------------------------------------------ | ---------------- |
123
+ | `aoc` | IBM Aspera on Cloud | SaaS |
124
+ | `console` | IBM Aspera Console | 3.4.11 |
125
+ | `faspex5` | IBM Aspera Faspex | 5.0.19 |
126
+ | `faspio` | IBM Aspera faspio Gateway | 1.3.7 |
127
+ | `httpgw` | IBM Aspera HTTP Gateway | 2.3.4 |
128
+ | `node` | IBM Aspera High-Speed Transfer Server (Node API) | 4.4.9.3472 |
129
+ | `orchestrator` | IBM Aspera Orchestrator | 4.1.6.2036-00000 |
130
+ | `server` | IBM Aspera High-Speed Transfer Server (SSH) | 4.4.9.3472 |
131
+ | `shares` | IBM Aspera Shares | 1.11.5 |
132
+
133
+ ### Transfer Agent Versions
134
+
135
+ | Agent | Product | Version |
136
+ | --------- | ------------------------------------------------ | ---------- |
137
+ | `connect` | IBM Aspera Connect | 4.2.16 |
138
+ | `desktop` | IBM Aspera for Desktop | 1.1.2 |
139
+ | `direct` | IBM Aspera ascp | 4.4.8.2592 |
140
+ | `httpgw` | IBM Aspera HTTP Gateway | 2.3.4 |
141
+ | `node` | IBM Aspera High-Speed Transfer Server (Node API) | 4.4.9.3472 |
142
+ | `transferd` | IBM Aspera Transfer Daemon | 1.1.9 |
143
+
144
+ ## 4.28.0
145
+
146
+ Released: 2026-10-22
147
+
148
+ Highlights: security hardening of local web servers (authentication, minimum secret strength, cross-site requests refused), new option `security`, `mcp server` over HTTPS with token or OAuth authentication, JMESPath queries (`--out.query`), exit code by category of error, context-aware shell completion (also PowerShell), tables fitted to the terminal width. Ruby 3.2 or later is required.
149
+
150
+ ### New Features
151
+
152
+ * `ascli`:
153
+ * Local web servers refuse a weak secret at startup (`auth_token` of `mcp server`, `secret_token` of `faspex5 postprocessing`, `password` of `node emulator` and gateways): minimum strength set by parameter `*_min_bits` (default `80`, `0` disables), estimated with gem `zxcvbn` if installed.
154
+ * New option `security`: level `medium` or `high` restricts extended values `@ruby:`, `@uri:`, `@env:` and `@file:` (see manual).
155
+ * `@secret:` asks for the secret on a local web page in the browser when option `ui` is `graphical`.
156
+ * Local web pages (authentication, secret request, OAuth consent) follow the light or dark theme of the system or browser.
157
+ * Option `ui` is extended (still compatible: `--ui=text|graphical`): sub-option `mode` (`auto`, `terminal`, `browser`) and `command` (array: browser command, URL appended). It replaces the environment variables `ASPERA_BROWSER` and `BROWSER`, which are no longer used.
158
+ * New option `--out.query`: [JMESPath](https://jmespath.org) expression (or `@ruby:` lambda) to filter and reshape results, as `--query` of the AWS and Azure CLIs. New gem dependency: `jmespath`.
159
+ * The exit code indicates the category of error (e.g. `3` authentication, `4` not found, `5` transfer, `6` network): see `ascli -h` or the manual.
160
+ * Tables fit the terminal width: text columns are wrapped. Parameter `width` of `--out.table` sets the maximum width.
161
+ * Schema tables (value `help` of an option or argument, `config ascp spec`, `config sync spec`, `config agents parameters`, manual) indicate required fields.
162
+ * Shell completion follows the context: options of plugin and command, values and types of options and arguments, keys of structures, aliases and abbreviations, local files for uploads, with descriptions in Zsh, Fish and PowerShell.
163
+ * New composite option `--temp` with sub-options `folder`, `clean` and `expiry`: age of `ascp` file lists left by interrupted commands, deleted when a command starts (a duration, e.g. `30d`, default `5d`, `false`: never, `0`: all). Options `--temp-folder` and `--clean-temp` are deprecated.
164
+ * `config`:
165
+ * New command `completion powershell` displays the completion script of PowerShell (see manual).
166
+ * `ascp spec`: Optional argument: name of agent, to display only the parameters it supports (as `config ascp schema`), or `overview`, for one column per agent.
167
+ * `mcp`:
168
+ * `server`: Authentication of transport `http` with a static token (`auth_token`) or OAuth 2.0 (`oauth`), new option `public_url`.
169
+ * `server`: HTTPS for transport `http` with options `url`, `cert`, `key` and `chain`. Options `bind` and `port` are deprecated: use `url`.
170
+ * `server`: `@secret:` asks the user on a web page (MCP URL mode elicitation): the secret is not sent to the AI model.
171
+ * `faspex5`:
172
+ * `postprocessing`: New parameters `secret_token` (`?token=` in URL) and `allowed_ips` (addresses or CIDR) restrict callers.
173
+ * `postprocessing`: Parameter `lambda` of the URL query evaluates a Ruby script returning a lambda, called with the webhook values (was ignored).
174
+ * `gateway` (and `aoc gateway`): New parameters `username` and `password` (HTTP Basic, as Faspex 4).
175
+ * `orchestrator`:
176
+ * New command `workflows development` displays the Workflow Authoring Guide, the Action Template Reference and the Plugin Manual (from GitHub), also used by AI assistants through `mcp server`: whole document, one section, or table of contents up to a level (default per document, or optional argument).
177
+ * `workflows export` with option `dependencies` saves a package (`.wkf`) with sub-workflows and remote nodes.
178
+ * `workflows import` takes an optional argument with options `folder_id`, `publish` and `link_to_subworkflows`. `workflows list` displays `folder_id`.
179
+ * New commands `monitors list` (monitors of a type: remote node monitors give the names of remote nodes), `queues list`, `pools status` and `journal files` (files recorded in a journal book). `--query=help` displays the query parameters of each API call, from the OpenAPI description of Orchestrator (corrected from the source code of Orchestrator 4.1.6, OpenAPI 3.1).
180
+ * New command `workflows check_import` checks a workflow file (`.yml` or `.wkf`) locally before import, and reports problems with a severity, a code and a location (as the web UI import does). `workflows import` logs these problems as warnings.
181
+ * New command `plugins spec` displays the specifications of action plugins (from GitHub, option `plugin_specs`): template attributes with their allowed values, inputs and outputs with the template settings they depend on. Used by AI assistants through `mcp server`, and by `workflows check_import` to check action templates and the inputs of steps (attributes and values, required inputs not mapped, inputs and outputs the plugin does not have).
182
+ * New command `workflows find_constraints` lists the conflicts and missing plugins found by Orchestrator for a file already on the server. `workflows import_with_constraints` refuses an import that Orchestrator would handle incorrectly (plugins not enabled, partial resolution of conflicts).
183
+ * `shares`:
184
+ * New commands `share list`, `share event create`, `admin directory`, `admin user|group search`, `admin group local users`, `admin authenticate`, and `admin user|group all transfer_settings delete` (reset to global settings).
185
+ * `health` uses the `/health_check` endpoint: status of each license and node.
186
+ * Help of `admin share user_permissions|group_permissions create|modify` shows the request body.
187
+ * `sync`:
188
+ * `target_rate` in `sync_info` accepts suffixes `k`, `m` and `g` (e.g. `100m`).
189
+
190
+ ### Issues Fixed
191
+
192
+ * `ascli`:
193
+ * Tokens displayed by `bearer_token`, `bearer_token_node` (`aoc`, `faspex5`, `node`), `aoc admin node bearer_token` and `node basic_token` were returned to the AI client by `mcp server`. They are now hidden.
194
+ * Secrets are also hidden by value, wherever they appear in logs, results and `mcp server` responses (e.g. in an error message, or as a key name): values of secret options (e.g. `password`) and of presets (e.g. read alone with `@preset:<name>.password`), of `@secret:` and `@vault:`, OAuth tokens, generated bearer and basic tokens, secrets of transfer specs. In `mcp server` responses, a value shorter than 8 characters is also hidden as a word in a text.
195
+ * With option `security` level `medium` or `high` (default of `mcp server`), a secret read by `@secret:`, `@vault:` or `@preset:` cannot be processed by another extended value (e.g. `@list:`, `@json:`, or in a text with `@extend:`), nor be a parameter name of `config preset set`: the result could reveal it to the AI client.
196
+ * Secret values of URL query parameters (e.g. `token`, `client_secret`) are hidden in logs.
197
+ * Logs: secrets in a Ruby `Struct` or object (`password="..."`) were shown. Secrets of a dumped structure are now hidden by field name before it is rendered, whatever `log.format`.
198
+ * Local web servers (`faspex5 postprocessing`, `faspex5 gateway`, `aoc gateway`, `node emulator`, `mcp server`, `--auth=web`):
199
+ * Requests that a web page in the browser can send are refused: `Host` not loopback on a loopback server (DNS rebinding), `Origin` of another site.
200
+ * A `url` with an IPv6 address, or parameter `chain`, failed at startup.
201
+ * WEBrick messages are logged at debug level.
202
+ * `--auth=web`:
203
+ * Login could wait forever when the browser called back early, or when `redirect_uri` has a path (HTTP 404).
204
+ * A `redirect_uri` on loopback other than `127.0.0.1` (e.g. `[::1]`) was refused.
205
+ * Ctrl-C ended with an internal error instead of stopping the command.
206
+ * The page after login, whose URL contains the authorization code, could be cached, framed, or sent as referrer.
207
+ * Error messages of servers in Ruby (e.g. Orchestrator) included the backtrace of the exception: it is in the debug log only.
208
+ * Network errors and resources not found by name were reported as `Other(<exception class>)`.
209
+ * Terminal output:
210
+ * Unicode (`--out.utf8`): detection follows the precedence of locale variables (`LC_ALL=C` disables it), and supports Windows Terminal, VS Code, Git Bash, ConEmu and terminals setting `TERM`.
211
+ * Colors (`--out.colors`): `NO_COLOR`, `CLICOLOR` and `CLICOLOR_FORCE` follow conventions, and results written with `--out.file` no longer contain ANSI codes.
212
+ * Without Unicode, symbols are replaced with ASCII (e.g. hidden secret `🔑` becomes `***`).
213
+ * A boolean or decimal result (e.g. `config echo @json:true`) failed with an internal error.
214
+ * `--out.select` refused a Ruby lambda (`@ruby:`).
215
+ * Help and manual: a parameter with alternatives (`oneOf`) had no type (which broke the PDF manual), and alternatives had no title.
216
+ * Value `help` of an option or argument displays the schema as `config sync spec`: with fields of alternatives (`oneOf`), deprecations and examples, and for `--ts=help` the supported agents and `ascp` options. `config agents parameters` displays allowed values and defaults.
217
+ * Removed gem dependencies `blankslate` and `word_wrap`: descriptions in schema tables are wrapped to the terminal width instead of cut at 120 characters.
218
+ * Transfer spec parameter `target_rate` is in bps as documented (without suffix or with `k` it was taken as kbps, an integer was rejected), and `sync` ignored it (and `target_rate_kbps` with format `args`).
219
+ * An asynchronous transfer with agent `direct` (default of `mcp server`) failed with `failed to open input file list`: the file list was deleted at the end of the command. Temporary files of `ascp` are now deleted when the transfer ends.
220
+ * `--clean-temp=no` also kept the old `ascp` file lists left by interrupted commands, and two commands starting at the same time could fail when deleting the same old file list.
221
+ * `config`:
222
+ * `preset get`: The value of a secret option (e.g. `password`) was displayed, and returned to the AI client by `mcp server`. It is now hidden, unless `--out.secrets=yes` (command line only, never in `mcp server`).
223
+ * `preset`: A secret made of digits only (e.g. `password`, set with `config preset set`, or not quoted in the YAML file) was a number, shown in results and `mcp server` responses: it is now a `String`, hidden.
224
+ * `vault`:
225
+ * `system` (macOS): the password and `username` were not returned, and special characters were stored escaped.
226
+ * `file`: `password` did not migrate a vault of version 4.26.0 or earlier to PBKDF2. The file is loaded with YAML safe loading.
227
+ * `vault` (HashiCorp): `list` failed after a secret was deleted.
228
+ * `1password`: `url` is read from the website of the item.
229
+ * `preset secure` failed on a missing secret (`system`, `1password`), and `@vault:` on a label containing dots.
230
+ * `completion words`: Extended values on the command line were evaluated at each `Tab` (e.g. `@ruby:` code executed, `@stdin:` waiting for input).
231
+ * `completion`: Bash: words containing `=` or `:` (e.g. a URL) broke completion of the next words, and each `Tab` checked for a newer gem version on the network.
232
+ * `documentation`: In `toc`, lines of code blocks (e.g. shell comments) were taken as headings, and they ended the extracted section. `--select` did not apply to `toc` (keys were symbols).
233
+ * `transfer status`: For agent `direct`, `bytes_transferred` (sum of `TransferBytes` of the sessions) and `ended_at` were not set.
234
+ * `sync translate`: Options `-C`, `--ws-connect`, `-D`, `--scan-interval` and `--remote-scan-interval` were translated incorrectly.
235
+ * `mcp`:
236
+ * REST error messages were repeated once more at each tool call.
237
+ * `server`: Option `--out.query` was ignored.
238
+ * `faspex5`:
239
+ * `postprocessing`, `gateway` (and `aoc gateway`): Invalid requests return HTTP 400, 403 or 404 instead of 500, without stack trace or path of the script.
240
+ * `packages send` (and `aoc packages send`): In asynchronous mode, the job id of the transfer was not returned: it is in field `transfer` of the result.
241
+ * `node`:
242
+ * `emulator`: A symbolic link in the `docroot` leading out of it was followed by transfers.
243
+ * `emulator`: A `POST` with an empty body returned HTTP 500 instead of 400.
244
+ * `orchestrator`:
245
+ * `workflows import_with_constraints` failed with an internal error of Orchestrator (plugins not enabled), or silently imported copies (partial resolution of conflicts). The OpenAPI description of `find_constraints` and `import_with_constraints` was wrong.
246
+ * `workflows import`, `import_with_constraints` and `publish` sent requests rejected by Orchestrator, `import` did not report workflows not imported, and `start` with `synchronous` failed to display the work order.
247
+ * `workstep status` displayed fields that are YAML dumps of Orchestrator objects (`prerequisites`, `work_outputs`...): they are removed, inputs and outputs are in `inputs` and `outputs`.
248
+ * `shares`:
249
+ * The manual and the description of `admin user|group all share_permissions` (read-only) did not tell that permissions are granted with `admin share user_permissions|group_permissions`: AI assistants concluded that it was not possible. The argument of `show` is named `share_id`.
250
+
251
+ ### Breaking Changes
252
+
253
+ * `ascli`:
254
+ * Secrets are hidden in results, whatever the output level or format (`--out.level=data`, `--format=json`...), unless `--out.secrets=yes`: before, `--out.level=data` (default with `--format=json`, `csv`...) showed them. This includes tokens displayed by `bearer_token`, `bearer_token_node`, `basic_token` and `config preset get <secret>`. Add `--out.secrets=yes` to scripts that use them (e.g. `$(ascli aoc bearer_token --out.secrets=yes)`).
255
+ * Ruby 3.2 or later is required (3.1 reached end of life in March 2025). Future minimum is 3.3. Policy: a Ruby version is supported until 18 months after its end of official support.
256
+ * The exit code on error indicates its category instead of always `1`: scripts shall test for a non-zero code. With `--format=nagios`, a failed command exits with `3` (UNKNOWN). Value `help` of a structured value exits with `0`.
257
+ * Local web servers on an address that is not loopback require authentication: `auth_token` for `mcp server`, `secret_token` or `allowed_ips` for `faspex5 postprocessing`, `username` and `password` for `node emulator`, `faspex5 gateway` and `aoc gateway`.
258
+ * Local web servers: a JSON body requires header `Content-Type: application/json`, else HTTP 415.
259
+ * `@secret:` asks in the browser by default on Windows and macOS (option `ui` is `graphical`): use `--ui=text` for the terminal.
260
+ * `config`:
261
+ * `completion`: Completion scripts saved in a folder shall be saved again (they call new command `config completion candidates`).
262
+ * `vault`: `create` fails if the label exists (`vault`, `1password`), `delete` fails if the secret does not exist (`file`). `1password`: `url` is stored as website of the item.
263
+ * `ascp spec`, `sync spec`, `agents parameters`, value `help` of an option or argument: Columns are `name`, `type` and `description` (no `required`), and `description` is a list of lines (formats `json`, `yaml`), absent when empty.
264
+ * `ascp spec`: Columns per agent are displayed with argument `overview`. By default, the description lists the supported agents, if not all (e.g. `(A, N)`).
265
+ * `agents show`: Displays only the agent description: parameters are displayed by `config agents parameters`.
266
+ * `mcp`:
267
+ * `server`: Option `security` is `high` by default and cannot be changed by the client, and `@stdin:` is refused: a preset reading a private key with `@file:` requires level `medium` or `low`.
268
+ * `server`: Keys of transport `http` are refused with `stdio` (the default), and `max_line_bytes` with `http`: they were ignored.
269
+ * `faspex5`:
270
+ * `postprocessing`, `gateway` (and `aoc gateway`): Parameters are validated at startup: unknown keys are refused instead of ignored, and a missing `script_folder` is reported.
271
+ * `postprocessing`: Only webhook values whose key starts with `faspex_` are passed to the script as environment variables, and a structured value as JSON.
272
+ * `orchestrator`:
273
+ * `workflows import` takes a file created by `workflows export`, and `workflows import_with_constraints` takes keys `filename`, `add_as_revision`, `subwf_constraints`, ... (see help).
274
+ * `monitors` is now `monitors snapshot`, with an optional type of monitors.
275
+ * `workorders output` displays values of variables as plain values instead of single-element arrays, and an empty value as `null`.
276
+
277
+ ### Server Versions
278
+
279
+ | Plugin | Product | Version |
280
+ | -------------- | -------------------- | ------------------ |
281
+ | `aoc` | Aspera on Cloud | SaaS |
282
+ | `console` | IBM Aspera Console | 3.4.11 |
283
+ | `faspex5` | Faspex v5 | F5.0.17 |
284
+ | `httpgw` | HTTP Gateway | 2.3.4 |
285
+ | `node` | HSTS Node API | 4.4.8.2596 |
286
+ | `orchestrator` | Orchestrator | 4.1.6.2036-00000 |
287
+ | `shares` | IBM Aspera Shares | 1.11.5 |
288
+
289
+ ### Transfer Agent Versions
290
+
291
+ | Agent | Product | Version |
292
+ | ----------- | -------------------------------- | --------- |
293
+ | `connect` | IBM Aspera Connect Client | 4.2.14 |
294
+ | `desktop` | IBM Aspera Desktop Client | 4.4.3 |
295
+ | `direct` | IBM Aspera Transfer SDK (ascp) | 1.1.9 |
296
+ | `httpgw` | IBM Aspera HTTP Gateway Agent | 1.3.0 |
297
+ | `node` | IBM Aspera Node API Agent | 4.4.3 |
298
+ | `transferd` | IBM Aspera transferd daemon | 1.1.9 |
299
+
3
300
  ## 4.27.5
4
301
 
5
302
  Released: 2026-10-06
@@ -15,7 +312,7 @@ Released: 2026-10-06
15
312
  ### Server Versions
16
313
 
17
314
  | Plugin | Product | Version |
18
- |--------------|--------------------|------------------|
315
+ | -------------- | -------------------- | ------------------ |
19
316
  | `aoc` | Aspera on Cloud | SaaS |
20
317
  | `console` | IBM Aspera Console | 3.4.4 |
21
318
  | `faspex5` | Faspex v5 | F5.0.17 |
@@ -27,7 +324,7 @@ Released: 2026-10-06
27
324
  ### Transfer Agent Versions
28
325
 
29
326
  | Agent | Product | Version |
30
- |-----------|--------------------------------|---------|
327
+ | ----------- | -------------------------------- | --------- |
31
328
  | `connect` | IBM Aspera Connect Client | 4.2.14 |
32
329
  | `desktop` | IBM Aspera Desktop Client | 4.4.3 |
33
330
  | `direct` | IBM Aspera Transfer SDK (ascp) | 1.1.9 |
@@ -98,7 +395,7 @@ Released: 2026-10-05
98
395
  ### Server Versions
99
396
 
100
397
  | Plugin | Product | Version |
101
- |--------------|--------------------|------------------|
398
+ | -------------- | -------------------- | ------------------ |
102
399
  | `aoc` | Aspera on Cloud | SaaS |
103
400
  | `console` | IBM Aspera Console | 3.4.4 |
104
401
  | `faspex5` | Faspex v5 | F5.0.17 |
@@ -110,7 +407,7 @@ Released: 2026-10-05
110
407
  ### Transfer Agent Versions
111
408
 
112
409
  | Agent | Product | Version |
113
- |-----------|--------------------------------|---------|
410
+ | ----------- | -------------------------------- | --------- |
114
411
  | `connect` | IBM Aspera Connect Client | 4.2.14 |
115
412
  | `desktop` | IBM Aspera Desktop Client | 4.4.3 |
116
413
  | `direct` | IBM Aspera Transfer SDK (ascp) | 1.1.9 |
@@ -0,0 +1,18 @@
1
+ # Code of Conduct
2
+
3
+ This project follows the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
4
+
5
+ Contributors and maintainers pledge to make participation in this project a harassment-free experience for everyone, and to behave in a respectful and constructive way.
6
+
7
+ Unacceptable behavior includes harassment, insulting or derogatory comments, personal or political attacks, and publishing the private information of others without permission.
8
+
9
+ ## Reporting
10
+
11
+ Report unacceptable behavior privately to the maintainers at laurent.martin.aspera@fr.ibm.com.
12
+ All reports are reviewed and investigated promptly and fairly, and the privacy of the reporter is respected.
13
+
14
+ ## Enforcement
15
+
16
+ Maintainers can remove, edit or reject comments, commits, issues and other contributions that do not follow this Code of Conduct, and can temporarily or permanently ban a contributor for behavior they consider inappropriate.
17
+
18
+ The [enforcement guidelines](https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines) of the Contributor Covenant apply.