Skip to main content

Install rl-secure

You can install rl-secure in any of the following ways:

  • Manually, from a single-file installation package you'll request from ReversingLabs
  • With the rl-deploy tool that automatically downloads the installation package

To use the rl-deploy tool, switch to the rl-deploy installation instructions.

To install the package manually, continue reading this guide.

rl-safe installation

In rl-secure 2.5.0 and newer, the rl-safe companion tool is automatically installed with rl-secure. You can use this tool to create RL-SAFE archives for easier sharing and storage of SAFE reports.

Prerequisites​

  • Check if your system fulfills the minimum requirements for running rl-secure.

  • Confirm that your network controls (such as proxy server or firewall) will permit HTTPS traffic to data.reversinglabs.com and api.reversinglabs.com. To use the live secret validation feature, access to sites such as GitHub and AWS will also be required. For details on sites that may require allowlisting, consult the list of services that get queried for liveness.

  • Contact ReversingLabs and request the appropriate version of the single-file installation package for your system.

  • Download the installation package from the link you received from ReversingLabs and save it on the system where you want to install rl-secure.

1. Set up rl-secure​

Windows​

Your user account must have permissions to install software on the system.

  1. Access the directory where you downloaded the rl-secure installation package and extract it.

  2. To allow running rl-secure from anywhere on the system, make sure the full path to its executable is in the PATH system environment variable. You can do this by searching for the Edit environment variables option in the Start menu, and modifying the PATH environment variable to contain the location of rl-secure on your system.

  3. Confirm all changes and restart the command prompt after modifying environment variables.

Silent mode installation​

Optionally, you can install rl-secure in silent mode on your Windows machine. Silent mode installation refers to installing an application without any user interaction during the process. However, this type of installation does require users to include all necessary input directly into the command.

  1. Access the directory where you downloaded the rl-secure installation package and extract it by writing the following parameters with no spaces between them and their values in the command line:

    • filename with its file extension
    • -d<path> - Set the destination folder for unpacked files.
    • -p<password> - Specify a password for the encrypted archive.
    • -s1 - Silent mode. Hide the main dialog and the extraction progress.
rlSecure151-Release-x64.exe -drl-secure -pINSTALLPASSWORD -s1

  1. To allow running rl-secure from anywhere on the system, make sure the full path to its executable is in the PATH system environment variable. You can do this by searching for the Edit environment variables option in the Start menu, and modifying the PATH environment variable to contain the location of rl-secure on your system.

  2. Confirm all changes and restart the command prompt after modifying environment variables.

Linux​

Warning

Never run rl-secure as root. It should not be installed in a location that requires root-only access.

You must be able to extract the downloaded package on the system. If your Linux distribution doesn't have a built-in tool for this, make sure to install one before you proceed. We recommend an AES-capable file archiver (such as 7-Zip) to avoid any encryption-related errors.

  1. Access the directory where you downloaded rl-secure and extract it.

  2. To allow running rl-secure from anywhere on the system, make sure the full path to its executable is in the PATH environment variable. A common way to do this is in the user's ~/.bashrc file. Note that this approach only configures it for the current user.

  3. Run source ~/.bashrc in the terminal to apply changes.

2. Activate your license​

The rl-secure tool requires activating a license key as the last step of the installation process.

You can use a license tied to a single machine, or use a license with a site-wide key that can be deployed on multiple machines.

  • After extracting and setting up rl-secure, run the following command:

    rl-secure license status

    The output of this command includes your machine key. Copy the machine key and store it in a safe place.

  • Send an email with your machine key to ReversingLabs Support. You can use the following template for the email contents:

    Subject: rl-secure license request

    Body:

    Hello,

    I am [your name] from [your company, organization or other affiliation] 
    and I would like to request a rl-secure license key.

    My machine key: [copy and paste your machine key here]

    Thanks,
    [your signature]

  • ReversingLabs Support will send you the license key as a single file named license.key.

  • Save the license file on your system. It's practical (but not required) to save it into the same directory where you extracted the rl-secure archive.

  • To activate your license, run the following command in the directory where you placed the license key file:

    rl-secure license install license.key

    The command displays the license activation process and informs you when it's successfully completed.

Success

Your installation of rl-secure should now be ready to use.

To confirm it's successfully installed and configured, open your terminal and run rl-secure --version.