rl-deploy 2.0.1.0

Deployment tool for ReversingLabs rl-secure project.

rl-deploy by ReversingLabs

rl-deploy is a tool for fast and flexible installation of rl-secure (Spectra Assure CLI) in ephemeral and cloud infrastructure, CI/CD environments, and containers.

Spectra Assure is a software supply chain security platform created by ReversingLabs to help organizations develop and release software with confidence. To support automated security scanning of software releases, ReversingLabs developed the Spectra Assure CLI tool called rl-secure.

This guide explains how to use rl-deploy to install rl-secure. For more details, visit the official Spectra Assure documentation.

Installation

rl-deploy requires Python 3.x.

It can be installed on the following systems and architectures:

• Windows 10 and later, 64-bit
• Linux x86 (all major distributions), 64-bit

To install the latest version of rl-deploy from PyPI, run:

pip install rl-deploy

To confirm rl-deploy is successfully installed, run:

rl-deploy --version

How to use rl-deploy

After installing rl-deploy to your system, use it to install the latest version of the rl-secure CLI tool.

1. Prepare your license and site key

Send an email to [e-mail] with the subject "rl-secure license request". In the email, ask for a site key that you will use to deploy rl-secure.

ReversingLabs Support will send you the license file and the site key. The site key is a string you can use to associate any rl-secure installation with your license. This allows you to install rl-secure on multiple ephemeral systems without having to request a separate license for each machine.

2. Install rl-secure

Important note: rl-secure implements an auto-update mechanism to keep the product up to date on every use. The user executing rl-secure commands must have write access to the installation location to facilitate the auto-update mechanism.

To install rl-secure on your system, provide the installation location, license, and the site key to the rl-deploy tool. You can either provide the path to the license file, or convert the license file contents into a Base64-encoded string.

Install with encoded license key

rl-deploy install --location /path/to/destination/ --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key

Install with license file path

rl-deploy install --location /path/to/destination/ --license-file /path/to/license.key --site-key=your-site-key

3. Confirm rl-secure installation

Access the location where you installed rl-secure and run the following command to confirm it's successfully installed.

rl-secure --version

Configuration

The rl-deploy tool supports proxy configuration in case it's required to download and install rl-secure.

You can specify the proxy configuration parameters directly when installing rl-secure:

rl-deploy install --location /path/to/destination/ --license-file /path/to/license.key --site-key=your-site-key --proxy-server 127.0.0.1 --proxy-port 8080

Proxy settings used during installation are automatically saved to the rl-secure configuration file, so rl-secure can continue using them when it needs to connect to ReversingLabs servers.

Note the rl-deploy proxy configuration does not support system-provided certificates, so it will not work if you have a custom certificate.

Support

To share your feedback or report any issues with rl-deploy, send an email to [e-mail]