DevOps Secrets Safe Licensing

DevOps Secrets Safe can 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 must generate licensing information using a serial number from BeyondTrust.

License Data Contents

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

{
  "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 used to license this instance of DSS.
  • 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. Otherwise false.
  • ActiveLicenseCount: Number of currently active instances of DSS using this serial number.
  • AllowedLicenseCount: Number of instances of DSS allowed for this serial number.

Apply and Update License - With Internet Access

Apply License During Unseal

Enter the serial number using the -s parameter with the unseal command, to update your current serial number, or to apply a serial number for the first time.

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

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

Update License

Enter the serial number using the s parameter with the license update command to update your current serial number.

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

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

Apply and Update License - Offline

If internet access is not available or restricted from your DevOps Secrets Safe instance, you can generate a license key to use offline.

To generate an offline license key:

  1. Access a machine that has Internet access.
  2. Browse to the offline licensing form.
  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.

Apply License During Unseal

Enter the serial number using the -s parameter, and the license key using the l parameter, with the unseal command, to update your current serial number or to apply a serial number for the first time.

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

Update License

Enter the serial number using the s parameter, and the license key using the l parameter, with the license update command, to update your current serial number.

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

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 can also use the force flag -f to make the system 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 removes all licensing data from this instance of DevOps Secrets Safe and decrements the active instance count for the associated serial number.