config

Description

Modifies the rl-secure settings.

Every rl-secure installation comes with a config.info file. That is the main configuration file where you can control some of the features available in rl-secure.

The config.info file uses the Boost INFO file format where configuration options are represented as a property tree. The configuration file can have multiple sections with key-value pairs. The key represents the configuration option name. To modify a configuration option, you would change the value assigned to it. The file supports adding custom comments, which must be prepended by a semicolon (;).

The following example illustrates the config.info file structure.

configuration {
  feature {
    key1  value1
    key2  value2
    key3  value3 ; Example comment
  }
}

Although it's possible to edit the config.info file manually, the config command lets you change the configuration directly from the command-line, and even automate it if necessary.

When you use the config command, it overwrites any existing settings in the config.info file. If the setting you're modifying has a comment on the same line in the file, the comment will remain unchanged.

In some cases, you may need to reprocess packages with rl-secure sync after modifying the configuration. This is done only when the change requires reprocessing to apply the new settings.

Preview stream for Partners

ReversingLabs partners have the opportunity to check out new rl-secure features a few days before their official release. This feature is available only for the CLI and the rl-scanner Docker image.

Users need to have a special OEM partner license and use either the rl-secure config command or the Docker image --stream parameter to tell rl-secure which stream to run. Step-by-step instructions can be found in the Partner section of the docs.

Usage

rl-secure config <key> <value>

rl-secure config -k=<key> -v=<value>

Options

Option	Description
-k, --key	Name of the configuration key you want to modify. Must specify the exact location of the key (the section(s) containing the key separated by a dot - e.g. proxy.port).
-v, --value	New value for the key you want to modify. Must be used together with -k. You can only assign one value to a key in a command.
--clear, --clear-value	Must be used together with -k. If the provided key exists in the configuration file and has a value assigned to it, this option resets the value to an empty string. If the provided key doesn't exist in the configuration file, the option adds it as a new key with an empty value. When you're using this option to add a new key, the key name must include only allowed characters (a-z, 0-9 and the dot).
--delete, --delete-key	Must be used together with -k. Deletes the provided key, its assigned value (if any), and all its sub-sections (if any) from the configuration file. If used with a section name, deletes the whole section and all its sub-sections, keys, and values.

Examples

Modify the rl-secure proxy configuration

In this example, we're modifying the proxy configuration with the config command.

If your organization is using a proxy server to protect its network, you may need to change the proxy settings in rl-secure so that the devices in your network can install and run it.

Configure the proxy during installation

With the rl-deploy tool, you can change the proxy configuration while installing rl-secure. Your proxy settings will be automatically saved to the config.info file.

The config.info file supports the following proxy settings:

• enable or disable the proxy functionality
• username and password (for proxy servers that require authentication)
• proxy server address (typically in the form of an IP address)
• proxy port number

To change any of the supported proxy settings, specify the configuration key name followed by the value you want to set.

You can omit the --key and --value options from the command as long as the key and its new value are provided exactly in that order, one after the other (as illustrated in the Simplified input example).

The proxy.enabled setting must be set to true for the proxy configuration to take effect. It's recommended to set this as the last step in the configuration to prevent issues with rl-secure in case something fails.

Simplified input

rl-secure config proxy.username armando
rl-secure config proxy.password ************
rl-secure config proxy.server my-proxy-server
rl-secure config proxy.port 3128
rl-secure config proxy.enabled true

Extended input

rl-secure config --key proxy.username --value armando
rl-secure config --key proxy.password --value ************
rl-secure config --key proxy.server --value my-proxy-server
rl-secure config --key proxy.port --value 3128
rl-secure config --key proxy.enabled --value true

The config command exits without any output when the configuration change is successful.

To confirm your changes have been saved, open the config.info file in the directory that contains your rl-secure executable. Compare the file contents to the keys and values you've previously modified.