The secrets store provides secure storage for credentials used in JavaScript-based scripts. Scripts run throughout AppGate ZTNA and perform complex logic, string manipulation, and calculations. An important part of this capability is support for limited HTTPS calls to external systems. The secrets store ensures that credentials required to authenticate to those external systems are not exposed in scripts or related logs.
There are three types of secrets:
Generic. Supports the following script types: User claim scripts, assignment criteria scripts, entitlement scripts, and access criteria scripts.
Credentials. Supports Brokered RDP entitlements.
SSH Key. Supports Brokered SSH entitlements.
Configuring secrets
Generic
To configure a secret:
Go to Secrets (System > Secrets).
Select +Add and complete the following fields:
Name. Enter the name used to reference to the secret in scripts. Use the format
%SECRET:<name>%. The name must not contain lowercase letters or spaces. Changing the name may break existing scripts.Notes. Optional. Enter any notes about the secret.
Tags. Select +Add to add tags to the secret.
Secret. Enter the secret value to substitute into the script at run time. You can copy the reference to a secret from the Secrets page using the action button (
).
Save the secret.
Credentials
Brokered RDP sessions use a Credentials secret. To configure a Credentials secret, complete the following steps:
Go to Secrets (System > Secrets).
Select Add > Credentials.
On the Edit Secret - Credentials page, complete the following fields:
Name. Enter the name that scripts use to reference the secret. Use the format
%SECRET:<name>%. The name cannot contain lowercase letters or spaces. Changing the name can break existing scripts.Notes. Optional. Enter any notes about the secret.
Tags. Select +Add to add tags to the secret.
Username. Enter the username to authenticate with the target resource.
Password. Enter the password for authentication at run time.
Select Save.
SSH Key
Brokered SSH sessions use an SSH Key secret. To configure an SSH Key secret, complete the following steps:
Go to Secrets (System > Secrets).
Select Add > SSH Key.
On the Edit Secret - SSH Key page, complete the following fields:
Name. Enter the name that scripts use to reference to the secret. Use the format
%SECRET:<name>%. The name cannot contain lowercase letters or spaces. Changing the name can break existing scripts.Notes. Optional. Enter any notes about the secret.
Tags. Select +Add to add tags to the secret.
Username. Enter the username to authenticate with the target resource.
SSH Key. Enter the private SSH key for authentication at run time.
Select Save.
Managing secrets
Use the action button—the three dots icon (
) to the right of each line item—to access the following option:
Copy reference to clipboard. Copies the secret reference for use in a script.