Licensing

DevOps Secrets Safe has the ability to run unlicensed for an evaluation period of 30 days upon being unsealed for the first time. To continue using DSS after this evaluation period, you will need to generate licensing information using a serial number provided to you.

License Data Contents

Each of the licensing commands described below will return a common data structure detailing the current state of the license of your instance of DevOps Secrets Safe

{
  "SerialNumber": "AAAAA-11111-BBBBB-22222-CCCCC-33333",
  "LicenseKey": "ZZZZZZZZ-YYYYYYYY-11111111-99999999-XXXXXXXX-88888888",
  "ExpiryDate": "2020-10-14T16:39:17Z",
  "IsEvaluation": false,
  "ActiveLicenseCount": 2,
  "AllowedLicenseCount": 2147483647
}

Each attribute describes the following:

  • SerialNumber - The serial number that was used to license this instance of Secrets Safe.
  • LicenseKey - License key generated using this serial number.
  • ExpiryDate - The expiry date of this serial number.
  • IsEvaluation - True if this serial number is an evaluation serial number. False otherwise.
  • ActiveLicenseCount - Number of currently active instances of Secrets Safe using this serial number.
  • AllowedLicenseCount - Number of instances of Secrets Safe allowed for this serial number.

Apply License During Unseal

A serial number can be provided to the unseal command to update your current serial number or to apply a serial number for the first time using the -s parameter:

$ ssrun unseal -f masterkey -s AFZTG-FDRJC-6WQFU-2KIHC-G44BS-EAF65

If internet access is not available or it is restricted from your DevOps Secrets Safe instance, you have the option of generating a license key offline to use with this command.

For more information about generating an offline license key, please see Offline Licensing.

If an existing serial number is in place, it will be decremented for this instance of DevOps Secrets Safe before the new serial number is applied.

Update License

A serial number can be provided to the license update command to update your current serial number using the -s parameter:

$ ssrun license update -s AAAAA-BBBBB-11111-22222-CCCCC-33333

If internet access is not available or it is restricted from your DevOps Secrets Safe instance, you have the option of generating a license key offline to use with this command.

For more information about generating an offline license key, please see Offline Licensing.

If an existing serial number is in place, it will be decremented for this instance of DevOps Secrets Safe before the new serial number is applied.

View License Data

The current state of the license of your instance of Secrets Safe can be retrieved by using the license get command:

$ ssrun license get

You may also use the force flag -f to indicate that the system should request an update of the licensing information from the licensing server.

Terminate License

To terminate your existing license use the license delete command:

$ ssrun license delete

This will remove all licensing data from this instance of DevOps Secrets Safe and decrement the active instance count for the associated serial number.

Offline Licensing

If internet access is not available or it is restricted from your DevOps Secrets Safe instance, you have the option of generating a license key offline.

To generate an offline license key:

  1. Access a machine that has internet access
  2. Browse to the offline licensing form licensing.beyondtrust.com
  3. Enter the serial number that was provided to you and submit
  4. Copy the license key that was generated for your instance of DevOps Secrets Safe

Finally, use the -l parameter to supply the offline license key you generated with the unseal or license update commands:

Unseal

$ ssrun unseal -f masterkey -s AAAAA-BBBBB-11111-22222-CCCCC-33333 -l ZZZZZZZZ-YYYYYYYY-11111111-99999999-XXXXXXXX-88888888

License Update

$ ssrun license update -s AAAAA-BBBBB-11111-22222-CCCCC-33333 -l ZZZZZZZZ-YYYYYYYY-11111111-99999999-XXXXXXXX-88888888