Safeguard Docs
Credentials Vault

Provider setup

What your PAM administrator prepares, what goes in the runner's provider file, and how to check each provider before a scan depends on it.

Provider setup

This page is for credentials that stay in your own PAM. For credentials kept in Safeguard, see The Safeguard vault.

Each provider needs three things: an identity for Safeguard in your PAM, a connection entry in the runner's provider file, and a test.

1. An identity for Safeguard in your PAM

Create one identity for Safeguard, used by nothing else, and give it the least it needs:

  • Read (retrieve) permission on the accounts your scans use, and nothing else. For ARCON PAM an API user with retrieve rights on the scan accounts; for CyberArk an Application ID with access to the scan Safes; for HashiCorp Vault a read-only policy on the scan paths; for BeyondTrust an API registration and run-as user that may request those managed accounts.
  • Where your PAM supports it, bind the identity to the runner machine: CyberArk's Allowed Machines or OS user, HashiCorp Vault's CIDR-bound AppRole or token, BeyondTrust's API registration authentication rules, or any source-address restriction your PAM offers for API users.
  • No interactive approval step on those accounts for this identity, or scans wait on an approval nobody sees. If your policy requires dual control, agree a window with your PAM team.
  • Rotation: let your PAM rotate the scan accounts as usual. The runner reads the current value at every scan start.

2. A connection entry on the runner

On the runner machine, add the provider to ~/.safeguard/secret-providers.yaml (mode 600). Every setting is listed in Runner configuration. Per product:

Then run safeguard vault providers. It lists each provider and says configured, or what is missing (a file that does not exist, an environment variable that is not set, a required setting), without reading any secret.

3. Test

  • On the runner: safeguard secrets test <reference>, for example safeguard secrets test pam://arcon/Windows/10.0.5.17/svc_scan. It prints OK, the provider and a length class, or the code and reason. It never prints the value, and it exits 0 on success.
  • In the app: Test access on the vault entry, choose the runner, Run test.

A test is recorded in the audit trail like a scan read, with the action TEST.

The Providers tab

The Providers tab of the Credentials Vault page is where you register a provider and get its runner configuration. It shows Safeguard vault, which needs no setup, and Your PAM, the list of providers you registered.

  1. Choose Register a provider.
  2. Pick the Product. The form that follows is generated for that product from the product's own description, so each one asks for exactly the settings it has: the address, the sign-in method, timeouts, allowed references and the product's own fields. Give it a Name. The name must be the same as the name in the runner's file, and is made of letters, digits, dots, dashes or underscores, starting with a letter or digit. Pick the Runner that reads from it.
  3. For each secret the product needs (an API key, a client secret, an AppRole secret id), choose Environment variable and give its name, or File and give its path. Safeguard never receives the secret. It uses what you chose to write the placeholder.
  4. Copy the snippet under Runner configuration into secret-providers.yaml on the runner, then set the environment variables or create the files it names.

The snippet has this shape. Secrets are env:// and file:// placeholders, never values:

providers:
  - name: ss-prod
    type: delinea
    url: https://secretserver.example.internal/SecretServer
    auth: password
    api_user: svc-safeguard
    api_key: env://DELINEA_API_KEY
    ca_cert: /etc/safeguard/internal-root-ca.pem

The same descriptions are available on the command line with safeguard vault provider-types --json, and you can register a provider from a runner's own file with safeguard vault providers register --from-config <name>. See the CLI reference.

The app then shows Configured on runner X or Not configured on runner X, and offers the provider when someone adds a PAM entry. Only descriptive information is registered; certificates and keys stay on the runner. To check that a provider works, open a credential that uses it and choose Test access.

On this page