Credentials Vault
Supported PAM providers
The PAM and secret-store products Safeguard reads scan credentials from, the reference format for each, and how each one signs in.
Supported PAM providers
A "From your PAM vault" entry names a provider and a reference inside it. The runner or CLI that runs the scan asks that provider for the value, using the connection settings in its local provider file.
| Provider | type | Reference | Runner signs in with | Setup |
|---|---|---|---|---|
| ARCON PAM | arcon | pam://arcon/<TargetType>/<ServerIp>/<UserName> | API user and key (token request), optional client certificate | ARCON PAM |
| CyberArk Central Credential Provider (CCP) | cyberark-ccp | pam://cyberark-ccp/<AppID>/<Safe>/<Object> | Client certificate for the Application ID | CyberArk |
| CyberArk Conjur | cyberark-conjur | pam://cyberark-conjur/<variable-id> | Host API key, or a JWT authenticator | CyberArk |
| HashiCorp Vault | hashicorp-vault | vault://<mount>/<path>#<key> | Token, AppRole or Kubernetes | HashiCorp Vault |
| Delinea Secret Server | delinea | pam://delinea/<secretId>/<fieldSlug> | OAuth2: application account and password, or client credentials | Delinea Secret Server |
| BeyondTrust Password Safe | beyondtrust | pam://beyondtrust/<SystemName>/<AccountName> | API registration key and run-as user | BeyondTrust |
| Azure Key Vault | azure-key-vault | pam://azure-key-vault/<vault>/<secret>[/<version>] | App registration or managed identity | Azure and AWS |
| AWS Secrets Manager | aws-secrets-manager | pam://aws-secrets-manager/<secret-id>[#json-key] | The machine's default AWS credential chain | Azure and AWS |
| Any PAM with an HTTP API (REST connector) | rest | pam://<name>/<key>=<value>/... | Whatever the API needs: token step, API key header, Basic | REST connector |
| Environment variable or file | none | env://NAME, file:///absolute/path | Nothing: read on the machine | Environment and file |
The REST connector page has a worked configuration for ManageEngine PAM360, written from its public API documentation. Test it with safeguard secrets test against your instance before relying on it. For Delinea Secret Server, use the delinea type: it needs fewer settings than a REST connector recipe.
Reference rules
sgvault://<handle>(also writtenpam://safeguard/<handle>) points at an entry in the credentials vault, whichever kind it is. This is what the app's From the vault button inserts, and it is the recommended form: the platform audit trail then names the entry.- A reference can name a configured provider instead of its type, for example
pam://ccp-prod/<AppID>/<Safe>/<Object>whenccp-prodis a provider of typecyberark-ccpin the provider file. Use this when you have two instances of one product. #password(the default) or#usernamepicks which field to read, for ARCON PAM, CyberArk CCP, Delinea, the REST connector andsgvault://. HashiCorp Vault and AWS use#<key>to pick a key of the secret.- Characters that are not letters, digits,
-,.or_in a path part are percent-encoded, for example a CCP folderRoot\Appsis?folder=Root%5CApps. - A value is treated as a reference only when the whole value is one. Any other value is used exactly as typed.
- If a reference cannot be read, the scan does not start. Safeguard never falls back to sending the reference text as the credential.
What every provider does the same way
- TLS certificate verification is on, with your own CA through
ca_cert. A plainhttp://address is refused unless it points at the runner machine itself (a local Vault agent, for example) or the provider setsallow_http: true. - Secrets the runner needs to sign in (API keys, AppRole secret ids, client secrets, tokens) are written in the provider file as
env://NAMEorfile:///path, never inline. - A dropped connection, a timeout, a 429 or a 5xx answer is retried (
retries, default 2). Authentication, permission and not-found answers are not. allowed_refslimits which references the runner reads from that provider.- Every read is recorded on the platform and in the runner's local audit file. See Audit.