aspera-cli 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b048647bb937cbea1f3bd8ef7e010c18b97456aa00b45ad8be45656472ae9f
-  data.tar.gz: c0f02324d8916a1ca5247a313da624e8365a57c438aefc58cc1301fd5ca5e0ff
+  metadata.gz: 86109a9ac1ef2f30ea4fd192b5535367d72ca679bcf588f86452289cf451dc72
+  data.tar.gz: 94d5d460d4ed2ab49637119711f03e81f2ab1793e75f8f6c5da098c8d93c26dc
 SHA512:
-  metadata.gz: fca3097df5295eaf1f3fa67efe04c7d1226c5c050d01f3e3c7319210967addfa01d98fd7a7b67024cae0a085f56b0357cf4b9b7ee4eb7aedd027b7996dc59356
-  data.tar.gz: c45dc8053b73c26b7f0eaac877d35118aad007974ae61cb6b3e19aac373e8713f682513161e1af5250263bf461a03aa71846e4149fed411e81c771a2943c8e57
+  metadata.gz: '05729a6bcf5db7f2831883e2da68c2fc3e3cc542ea3fb7969a5095b87d094b0cc98845ac73f300865f358ff70751cdbde4cab16dc10349076168e5266c62a98a'
+  data.tar.gz: 7ebdeaaf9a8408137f7057665f0b8e12f6314f2328cd235be78cfd531df9ffa422f0574331d3fed2436fd3e97f3aff452c9ce778dc06112fc012f6e48b5adaf8

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changes (Release notes)
 
+* 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

data/CONTRIBUTING.md

@@ -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,15 +199,16 @@ 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.
-
 ## Long Term Implementation and delivery improvements
 
 - replace rest and oauth classes with ruby standard gems: