CLI capacity configuration
To use the CLI, you need a valid license. This license is tied to a ReversingLabs cloud account and determines not only how much analysis capacity you get, but also which entitlement categories are available for your account. Since CLI and Portal share a ReversingLabs cloud account, the total analysis capacity is divided between the two and can be configured from either the Manage Portal Capacity page or the Manage CLI Capacity page.
If you're already a CLI user and want to manage monthly capacity usage across your organization, you can do so by obtaining a new site key to register your CLI within the Portal. This can be done for multiple CLI licenses, which will then be visible on the Manage CLI Capacity page.
The Manage CLI Capacity page lets you:
- check the entitlements for your account
- check current analysis capacity status
- see your capacity consumption statistics by month
- check current shared pool capacity and consumption for your organization
- check capacity allocations and usage for specific site keys
- manage site keys and their allocation
If you're both a Portal and a CLI user, this page will also show your monthly capacity consumption for both products. For CLI-only users, the monthly capacity consumption for Portal will always be 0, and vice versa.
The information on configured usage allocations for each site key is displayed in the Manage Site Keys table containing the following fields:
- Site Key - a key tied to every site-wide deployment license for
rl-securein your organization. The copy button next to it allows you to instantly copy it to clipboard - Description - a special label you can pin on a specific site key
- Allocation - a part of the total monthly capacity allocated to the site key
- Used (GB) - the amount of allocated capacity the CLI tied to the site key used in the current month. Allocations are optional, but it's strongly recommended to configure them for all your site keys to avoid using up the whole capacity
- Actions - a menu from which you can edit or delete site keys from the Portal instance
The data in the Manage Site Keys table can be ordered by the following column header values:
- the site key description (Description)
- the amount of monthly capacity allocated to a site key (Allocation)
- the amount of allocated monthly capacity used by a site key (Used (GB))
Obtain a site key
Obtaining a site key is the first step towards managing your CLI monthly usage from the Portal interface. This is done by making a request to ReversingLabs Support. You can do this for multiple CLI licenses.
Even if you're an existing CLI user with a valid site key, you still need to request a new site key in order for your license to be registered in the Portal. Without the registration, you're using the Shared Pool capacity and you cannot allocate any monthly capacity to a specific site key.
Once you get the site key, it appears on the Manage CLI Capacity page on the Portal. By default, all newly registered site keys are assigned a quota of 0 bytes, which can be changed only by Organization Administrators in the Portal interface.
Site key allocations
Site key allocations reserve part of the total monthly capacity for individual site keys registered in the Portal. They are set by Organization Administrators to prevent any single CLI user or key from consuming the entire quota, while also guaranteeing a defined amount of analysis capacity.
This type of capacity management is available only for site keys. CLI licenses tied to machine IDs do not support individual allocations and can use the remaining monthly capacity, excluding any portion reserved for site keys.
As opposed to group limits for Portal users, which depend on the usage trends of other groups within your Organization and the remaining monthly analysis capacity, site key allocations ensure that the capacity assigned to your site key is only yours to use. This means that if you have 5 GB allocated to your site key for the current month, you can spend less than 5 GB, but you'll still have a total of 5 GB of capacity available only to you until the beginning of next month.
Even though site key allocations are managed through the Portal interface, the remaining capacity for your rl-secure license is still checked by using the rl-secure license status command.
Shared pool
Shared Pool differs from the total monthly organization capacity reserved for CLI. When you allocate a part of the total monthly CLI capacity to one or more site keys, the amount that remains is then called the Shared Pool. This remaining monthly capacity is then available for increasing the existing site key allocations, adding allocations to new site keys, or for use by site keys without any allocated capacity.
For example, if your total monthly organization capacity for CLI is 50 GB and there's one registered site key with the allocated capacity of 5 GB, the amount that goes into the Shared Pool for your organization is 45 GB. Adding another 5 GB to your registered site key will bring its allocation to a total of 10 GB and the Shared Pool amount to 40 GB. Regardless of these changes, the total monthly organization capacity remained 50 GB.
Analyzing files with site keys not listed in the table and with CLI licenses tied to machine IDs in your organization also consumes Shared Pool capacity.
Manage site keys
As an Organization Administrator, you can manage the site keys that belong to your organization from the Actions menu of the Manage Site Keys table.
Edit site key
For each site key in the table, you can add a short description for the key and set the monthly allocation amount tied to that key. When editing an allocation amount, keep in mind that a site key allocation cannot be:
- set below zero
- set below the current usage
- increased by more than the remaining Shared Pool capacity.
Delete site key
Deleting a site key removes it only from the Portal.
The site key remains functional and can still be used to analyze files with rl-secure, but will no longer have an individual monthly allocation set.
Any of its remaining unused allocation is moved to the Shared Pool. From that point on, all files analyzed with the deleted site key consume the Shared Pool capacity.
At the beginning of each month, all deleted keys are removed from the table.
If deleting a site key is not enough, you can revoke it to permanently deactivate it. This action can only be done by contacting ReversingLabs Support.
Manage capacity
Split capacity between CLI and Portal
You can distribute the total analysis capacity between the CLI and the Portal by clicking on the Reallocate Analysis Capacity button.
The total analysis capacity cannot be exceeded during limit configuration.
In addition to that, if any CLI site key allocations exist, you cannot set the limit for CLI processing below the reserved amount.
This allows you to tailor the limits according to your consumption habits. For example, your total capacity is 10 GB and you usually spend 6 GB for Portal and 4 GB for CLI processing. If this month you need 8 GB for the Portal, you can reallocate your analysis capacity accordingly. This will then leave only 2 GB for CLI processing.
Setting the Portal or CLI limit lower than the amount already spent raises a warning in the Reallocate Analysis Capacity dialog.
Increase organization capacity
The analysis capacity resets on the first day of every month. When needed, you can get an extension to your analysis capacity by means of the so-called Flex.
The Flex option is a promotional add-on to your license provided by ReversingLabs. It increases the analysis capacity allocated to your account for a limited time period. During this time, you get more capacity for processing your packages.
When Flex is enabled for your account, your default analysis capacity is used first. The Flex capacity is used only when you exceed your purchased analysis capacity.
Having Flex does not allow you to divide more capacity between products, Portal groups, or CLI site keys. When your organization runs out of its monthly analysis capacity, you can increase it by contacting your sales representative.
Interpret usage graphs and information
The Monthly Analysis Capacity chart indicates how much of the overall available analysis capacity was used per month by your organization.
On the Portal, this information is displayed as follows:
The line chart shows the capacity usage for those months during which your analysis capacity has been active. Data is displayed for a period of maximum 12 months prior to the current date.
On the chart, the black line represents the total analysis capacity for your organization, while the green line displays the amount of Flex quota. The dark purple area shows how much of the analysis capacity is used only by the Portal. If you're also using the CLI, the light purple area shows the overall usage for both products per month. This gives you a better insight into your organization's analysis capacity consumption habits.
The Analysis Capacity progress bar next to the chart shows the amount of used capacity and visually represents how much of the analysis capacity your organization has left until the limit is reached. If you're using both CLI and Portal, the first part of the bar shows the used capacity for the CLI (in GB) and the second part for the Portal (in GB). In case you're working with one product and not the other, the bar always shows 0 GB for the product you do not use.
The Portal Download Capacity progress bar below indicates how much of the capacity designated for downloads your organization has left until the limit is reached. The download capacity is separate from Analysis Capacity and cannot be divided between products or groups.
The Portal Package Limit progress bar at the bottom indicates how many packages out of the allowed 10,000 are created across all projects on your Portal instance. This limit is separate from the analysis and download capacities, and it cannot be upgraded or divided between products or groups.
SAFE Assessment Entitlements
The SAFE Assessment Entitlements section allows you to check which SAFE Assessment categories are enabled for your ReversingLabs cloud account and are evaluated during software analysis. If you're using both Portal and CLI, same entitlement restrictions apply to both products.
You can distinguish between enabled and disabled categories by color - the disabled categories are greyed out. The data from the disabled categories is not included in the report and does not affect the overall CI status.
Entitlements can be disabled and enabled on demand. This means that you can contact sales when you need to switch specific categories on or off, without acquiring a new license.
Files that were uploaded to Portal File Stream or Portal Projects and analyzed before making changes to any category will not be automatically reprocessed afterwards. This means that their reports will contain even the data from these newly disabled categories.