aspera-cli 4.12.0 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b048647bb937cbea1f3bd8ef7e010c18b97456aa00b45ad8be45656472ae9f
-  data.tar.gz: c0f02324d8916a1ca5247a313da624e8365a57c438aefc58cc1301fd5ca5e0ff
+  metadata.gz: 98bd3e1d6ade2f96ff4ddbf4ae825e1926f56990b6552ff22aab6007546fd32e
+  data.tar.gz: edab64f8c8a7108a4614f4f5b7494ddb73611587c54bf6a4c270385303d9d53b
 SHA512:
-  metadata.gz: fca3097df5295eaf1f3fa67efe04c7d1226c5c050d01f3e3c7319210967addfa01d98fd7a7b67024cae0a085f56b0357cf4b9b7ee4eb7aedd027b7996dc59356
-  data.tar.gz: c45dc8053b73c26b7f0eaac877d35118aad007974ae61cb6b3e19aac373e8713f682513161e1af5250263bf461a03aa71846e4149fed411e81c771a2943c8e57
+  metadata.gz: 26c290fd4cd0d6d2a564b8e8dacaab4f584a0548c096999870b43dc755128faf23db58105ccbc16f424aac5384e79a51d07eada5e7a82e66b3d76abec69ad8e7
+  data.tar.gz: 1ee2fe285c913db6851ac97198d73c7159972c35c3c30e2b57342d226d0387e4940df19b7bd737769bfac3b2ab74fec3813d41a1f70c2d39e5202c20c35b8369

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changes (Release notes)
 
+* 4.14.0
+
+  * new: server: option `passphrase` for simpler command line (#114)
+  * new: percent selector for entities identifier
+  * new: faspex5: shared inbox and workgroup membership management
+  * new: faspex5: invite external user to shared inbox
+  * new: faspex5: package list and receive from workgroups and shared inboxes
+  * new: config: Command `ascp info` shows default transfer spec.
+  * new: httpgw: synchronous and asynchronous upload modes
+  * new: node: command `bandwidth_average` to get average bandwidth of node, per periods
+  * fix: option `ts`: deep add and remove of keys. (#117)
+  * fix: faspex5: user lookup for `packages send` shall be exact match (#120)
+  * fix: direct: if transfer spec contains "paths" and elements with "destination", but first element has only "source", then destinations were ignored. Now "destination" all or none is enforced.
+  * change: using `aoc files` or node gen4 operations (`browse`, `delete`) on a link will follow the link only if path ends with /
+  * change: shares: command `repository` is changed to `files` for consistency with aoc and upcoming faspex5, but is still available as alias
+  * change: aoc: better handling of shared links
+  * change: global: option `value` is deprecated. Use positional parameter for creation data and option `query` for list/delete operations.
+  * change: config: remove deprecated command: `export_to_cli`
+  * change: config: removed all legacy preset command, newer command `preset` shall be used now.
+  * change: config: SDK is now installed in $HOME/.aspera/sdk instead of $HOME/.aspera/ascli/sdk
+  * change(break): aoc/node: Simplification: gen4 operations: show modify permission thumbnail are now directly under node gen 4 command. Command `file` is suppressed. Option `path` is suppressed. The default expected argument is a path. To provide a file id, use selector syntax: %id:_file_id_
+  * change(break): node: option `token_type` is removed, as starting with HSTS 4.3 basic token is only allowed with access keys, so use gen4 operations: `acc do self`
+
+* 4.13.0
+
+  * new: preview: option `reencode_ffmpeg` allows overriding all re-encoding options
+  * new: faspex5: package delete (#107)
+  * new: faspex5: package recv for inboxes and regular users (#108)
+  * new: faspex5: smtp management
+  * new: faspex5: use public link for authorization of package download, using option `link`
+  * new: faspex5: list content of package, and allow partial download of package
+  * new: faspex5: list packages support multiple pages and items limitations (`max` and `pmax`)
+  * new: aoc: files operations with workspace-less user (#109)
+  * new: node: async with gen3 token (#110)
+  * new: node: display of preview of file in terminal for access keys
+  * change: option `transfer_info` is now cumulative, setting several times merge values
+  * change(deprecation): Removed support of Ruby 2.4 and 2.5 : too old, no security update since a long time. If you need older ruby version use older gem version.
+  * fix: cos: do not use refresh token when not supported
+  * fix: container: SDK installed in other folder than `ascli` (#106)
+
 * 4.12.0
 
   * new: docker: build image from official gem version, possibility to deploy beta as well
@@ -172,7 +212,7 @@
   * new: agent `http_gw` now supports upload
   * new: added option `sdk_url` to install SDK from local file for offline install
   * new: check new gem version periodically
-  * new: the --fields= option, support -_fieldname_ to remove a field from default fields
+  * new: the --fields= option, support -_field_name_ to remove a field from default fields
   * new: Oauth tokens are discarded automatically after 30 minutes (useful for COS delegated refresh tokens)
   * new: mimemagic is now optional, needs manual install for `preview`, compatible with version 0.4.x
   * new: AoC a password can be provided for a public link
@@ -192,7 +232,7 @@
 
 * 0.11.8
 
-  * Simplified to use `unoconv` instead of bare `libreoffice` for office conversion, as `unoconv` does not require a X server (previously using Xvfb)
+  * Simplified to use `unoconv` instead of bare `libreoffice` for office conversion, as `unoconv` does not require a X server (previously using `Xvfb`)
 
 * 0.11.7
 
@@ -313,7 +353,7 @@
 * 0.10.4
 
   * new options for AoC : `secrets`
-  * ACLI-533 temp file list folder to use file lists is set by default, and used by `asession`
+  * `ACLI-533` temp file list folder to use file lists is set by default, and used by `asession`
 
 * 0.10.3
 
@@ -353,13 +393,13 @@
 
   * new command to display basic token of node
   * new command to display bearer token of node in AoC
-  * the --fields= option, support +_fieldname_ to add a field to default fields
+  * the --fields= option, support +_field_name_ to add a field to default fields
   * many small changes
 
 * 0.9.32
 
   * all Faspex public links are now supported
-  * removed faspex operation recv_publink
+  * removed faspex operation `recv_publink`
   * replaced with option `link` (consistent with AoC)
 
 * 0.9.31

data/CONTRIBUTING.md

@@ -1,5 +1,5 @@
 # Contributing
-
+<!-- cspell:words passin GEMVERS -->
 ## Reporting Issues and Vulnerabilities
 
 You can report issues at <https://github.com/IBM/aspera-cli/issues>
@@ -34,6 +34,20 @@ If you want to contribute, please:
 - Send a pull request on GitHub.
 - run Rubocop to comply for coding standards
 
+## Architecture
+
+A list of classes are provided in <docs/ml.png>
+
+Architecture:
+
+![Architecture](docs/architecture.png)
+
+The entry point is lib/aspera/cli/main.rb
+
+Plugins are located in lib/aspera/cli/plugins
+
+Transfer agents: lib/aspera/fasp
+
 ## Running Tests
 
 First, a testing environment must be created:
@@ -73,51 +87,111 @@ It is also possible to build a non-signed version for development purpose: `make
 
 ### Gem Signature
 
-Refer to: <https://guides.rubygems.org/security/>
+Refer to:
 
-The gem is signed with the public certificate found in `certs` and a secret key (kept secret by maintainer).
+- <https://guides.rubygems.org/security/>
+- <https://ruby-doc.org/current/stdlibs/rubygems/Gem/Security.html>
+- `gem cert --help`
 
-To build the signed gem:
+Then procedure is as follows:
 
-```bash
-SIGNING_KEY=/path/to/signing_key.pem make
-```
+- The maintainer creates the initial certificate and a private key:
 
-The user can activate gem signature verification on installation:
+  ```bash
+  cd /path/to/vault
+  gem cert --build maintainer@example.com
+  ```
 
-- Add the certificate to gem trusted certificates:
+  > **Note:** the email must match the field `spec.email` in `aspera-cli.gemspec`
 
-```bash
-curl https://raw.githubusercontent.com/IBM/aspera-cli/main/certs/aspera-cli-public-cert.pem -so aspera-cli-certificate.pem
-gem cert --add aspera-cli-certificate.pem
-rm aspera-cli-certificate.pem
-```
+  This creates two files in folder `/path/to/vault` (e.g. $HOME/.ssh):
+  
+  - `gem-private_key.pem` : This file shall be kept secret in a vault.
+  - `gem-public_cert.pem` : This file is copied to a public place, here in folder `certs`
 
-- Install the gem with `HighSecurity` or `MediumSecurity`: this will succeed only of the gem is trusted.
+  > **Note:** Alternatively, use an existing key or generate one, and then `make new-cert`
 
-```bash
-gem install -P HighSecurity aspera-cli
-```
+- The maintainer build the signed gem.
+
+  The gem is signed with the public certificate found in `certs` and the private key (kept secret by maintainer).
+
+  To build the signed gem:
+
+  ```bash
+  SIGNING_KEY=/path/to/vault/gem-private_key.pem make
+  ```
+
+- The user can activate gem signature verification on installation:
+
+  Add the certificate to gem trusted certificates:
+
+  ```bash
+  curl https://raw.githubusercontent.com/IBM/aspera-cli/main/certs/aspera-cli-public-cert.pem -so aspera-cli-certificate.pem
+  gem cert --add aspera-cli-certificate.pem
+  rm aspera-cli-certificate.pem
+  ```
+
+  - The user installs the gem with `HighSecurity` or `MediumSecurity`: this will succeed only of the gem is trusted.
+
+  ```bash
+  gem install -P HighSecurity aspera-cli
+  ```
+
+  - The maintainer can renew the certificate when it is expired using the same private key:
+
+  ```bash
+  SIGNING_KEY=/path/to/vault/gem-private_key.pem make update-cert
+  ```
+
+  Alternatively, to generate a new certificate with the same key:
+
+  ```bash
+  SIGNING_KEY=/path/to/vault/gem-private_key.pem make new-cert
+  ```
+
+  - Show the current certificate contents
+
+  ```bash
+  make show-cert
+  ```
+
+  > Note: to provide a passphrase add argument: `-passin pass:_value_` to `openssl`
+
+  - Check that the signing key is the same as used to sign the certificate:
+
+  ```bash
+  SIGNING_KEY=/path/to/vault/gem-private_key.pem make check-cert-key
+  ```
 
 ## Docker image build
 
-The default docker image build installs the official gem version directly from <rubygems.org>.
+The Dockerfile template allows customizing the optional copy of gem file , versus install from rubygems,org as well as customizing the retrieval of the SDK.
+
+### Default image build
 
-By default it will build the image for the version in the current repository:
+Build the image:
 
 ```bash
 make docker
 ```
 
+This does the following:
+
+- Install the official gem version directly from <rubygems.org>.
+- Build the image for the version number in the current repository
+- creates tags for both the version and `latest`
+
 > **Note:** This target creates the `Dockerfile` from an `ERB` (embedded Ruby) template (Makefile target `dockerfile`).
 A template is used as it allows some level of customization to tell where to take the gem from, as as for the SDK file.
 
-Then, to push to the image registry:
+Then, to push to the image registry (both tags: version and `latest`):
 
 ```bash
 make dpush
 ```
 
+### Specific version image build
+
 It is possible to build a specific version by setting envvar `GEMVERS` and `make` with option `-e`:
 
 ```bash
@@ -125,14 +199,31 @@ GEMVERS=4.11.0 make -e docker
 GEMVERS=4.11.0 make -e dpush
 ```
 
+### Development version image build
+
 To build/push a beta/development container:
+it does not create the `latest` tag, it uses the gem file generated locally.
 
 ```bash
 make dockerbeta
 make dpushversion
 ```
 
-The Dockerfile template allows customizing the optional copy of gem file , versus install from rubygems,org as well as customizing the retrieval of the SDK.
+## Single executable build
+
+It is possible to build `ascli` as a single native executable using `rubyc` (gem `ruby-packer`).
+
+```bash
+make single
+```
+
+This is based on tool `rubyc` (gem `ruby-packer`): either place the executable in folder `tmp`, or the architecture-specific version will be automatically downloaded.
+
+> **Note:** Perl Findbin is needed, install on Linux with:
+
+```bash
+sudo dnf install -y perl perl-FindBin perl-IPC-Cmd
+```
 
 ## Long Term Implementation and delivery improvements