Safeguard Docs
Credentials Vault

Credentials Vault

Choose where each scan credential lives, in the Safeguard vault with access controls, approvals, leases and rotation, or in your own PAM where the value is read inside your network at scan time.

Credentials Vault

The credentials vault holds the logins, tokens and keys your scans need: a git token for a private repository, a registry password, a DAST login, an API bearer token, the account a host scan signs in with. You choose where each credential lives, one credential at a time, and the same vault, the same picker and the same audit trail serve both choices.

Choose where each credential lives

ChoiceWhat it means
The Safeguard vaultSafeguard keeps the value, encrypted, and adds the controls of a PAM on top: who may use it, which targets it may be used on, check-out with a lease, approval, rotation, versions and a full audit log. Set it up in The Safeguard vault.
Your PAMSafeguard keeps only a reference, such as pam://arcon/<TargetType>/<ServerIp>/<UserName>. A runner or the CLI in your network reads the value from your PAM when the scan starts. Set it up in Provider setup.

You can use both in one organization, and mix them across the targets of one scan. Existing entries, scans and CLI flags keep working exactly as they do now. A stored entry gets the new controls only when someone turns its vault policy on.

Compare the two

Safeguard vaultYour PAM
Where the value is storedIn Safeguard, encryptedIn your PAM. Safeguard stores a reference and never the value
Who reads it, and whenThe scan that is granted it, at check-out: Safeguard's cloud scanner, a runner or the CLI, for the length of a leaseThe runner or CLI in your network, when the scan starts, straight from your PAM
EncryptionAES-256-GCM under a data key that belongs to your organization alone, wrapped by the platform keyYour PAM's own
Access controlRoles vault-admin, vault-approver, vault-auditor and per-credential grants VIEW, USE, MANAGE, APPROVE, REVEALWhat the identity Safeguard uses may retrieve in your PAM, and allowed_refs on the runner
Target bindingOptional list of targets, scan types and runners. A scan outside it is refusedallowed_refs on the runner limits which references it reads. A vault entry that points at your PAM can carry bindings too
Check-out and leasesYes. A lease with a time limit, renewed while the scan runs and checked in when it ends. Optional one-user-at-a-timeWhatever your PAM does. BeyondTrust requests are checked in and HashiCorp Vault leases revoked at scan end
ApprovalsYes, in Safeguard, with a recent sign-in. Nobody approves their own requestIn your PAM, if you use them there
RotationYes, for SSH passwords, SSH keys and HTTP API tokens, run by a runner in your network. A manual new version for anything elseYour PAM rotates. The runner reads the current value at every scan start
VersionsYes. Each change is a version, metadata only is listedYour PAM's history
AuditOne tenant-wide log with filters and CSV or JSONL exportPlatform row for each read, the runner's local audit file, and your PAM's own audit
Network needsNone in your network for scans in Safeguard's cloud. A runner for rotation and for on-prem scansA runner or CLI in your network that can reach your PAM's API
Best forCredentials you would otherwise paste into scan targets: tokens, service logins, test accountsCredentials your PAM already rotates and approves, and that must not leave your network

The same reference style for every source

A scan field takes a reference wherever it takes a credential. The reference says where the value lives.

ReferenceSourcePage
sgvault://<handle> (also written pam://safeguard/<handle>)A credential in the Safeguard vault. Add #username or #password to pick a fieldThe Safeguard vault
pam://<provider>/...A credential in your PAM: ARCON, CyberArk, BeyondTrust, Delinea Secret Server, Azure Key Vault, AWS Secrets Manager, the REST connectorSupported PAM providers
vault://<mount>/<path>#<key>HashiCorp VaultHashiCorp Vault
env://NAMEAn environment variable on the runner or CLI machineEnvironment and file
file:///absolute/pathA file on the runner or CLI machineEnvironment and file

A vault entry can also be a pointer to your PAM (sgvault://dast-login holding pam://arcon/Web/10.0.5.17/svc_dast). Safeguard then applies the entry's policy (access, bindings, approval, audit) and your runner reads the value from your PAM. This is the recommended form for PAM credentials, because the audit trail names the entry.

Why a reference

A credential that lives in your PAM is rotated, approved and audited there. Copying it into another system creates a second copy that nobody rotates. With a PAM entry, Safeguard stores where the credential lives, never the credential. When a scan starts, the runner on your side asks your PAM for the current value, uses it for that scan, and discards it when the scan ends.

The value does not travel to Safeguard's cloud. Only the outcome of each read (time, entry or reference, provider, scan, runner, success or error code) is reported, and the runner keeps its own local audit file as well.

 Safeguard platform                          Your network
 ------------------                          --------------------------------------------
 Scan target or vault entry                  Safeguard runner (the safeguard CLI)
 holds a reference only   --- job ------->        |
 sgvault://dast-login                             | 1. reads secret-providers.yaml (local)
                                                  | 2. signs in to the PAM API over TLS
                                                  v
                                             Your PAM (ARCON, CyberArk, HashiCorp Vault ...)
                                                  | 3. returns the password for that account
                                                  v
                                             4. scan runs, value in memory only
 Findings, SBOM, audit outcome  <-----------  5. value discarded, read written to the audit
 (never the value)

How it works walks through each step.

Supported vaults

ARCON PAM, CyberArk Central Credential Provider, CyberArk Conjur, HashiCorp Vault, BeyondTrust Password Safe, Delinea Secret Server, Azure Key Vault, AWS Secrets Manager, a configurable REST connector for any other PAM with an HTTP API (with a recipe for ManageEngine PAM360), and environment variables or local files. See Supported PAM providers. Safeguard works with these products through their public APIs.

Which scans can use it

ScanWhere the credential is readPage
Source code and container scans (CLI and runner)The CLI or runner that runs the scanSource and registry scans
Source-code integrations (GitHub, GitLab, Bitbucket token)Safeguard, at the single point where the token is used. Safeguard vault references onlySource-code integrations
DAST (web applications)Safeguard's cloud scanner, or an on-prem runner you choose for the targetDAST
API securitySafeguard's cloud scanner, or an on-prem runner you choose for the targetAPI security
Infrastructure hosts over SSH (Linux and Unix)An on-prem runnerHost scans
Infrastructure hosts over WinRM (Windows)An on-prem runnerHost scans

Entries in the Safeguard vault work for scans that run in Safeguard's cloud and for scans on a runner. Entries that point at your PAM need a runner in your network, because the cloud has no route to your PAM.

Set it up

For a credential in the Safeguard vault:

  1. Open the Credentials Vault page and add the credential. See Create a credential.
  2. Turn its policy on and set who may use it, where, and whether it needs approval. See The policy.
  3. Use it in a scan target with the From the vault button, or give the CLI sgvault://<handle>.

For a credential in your PAM:

  1. Install a runner on a machine in your network that can reach your PAM's API and the systems you scan. See Local Runner.
  2. Prepare an identity in your PAM for Safeguard, limited to the accounts scans need. See Provider setup.
  3. Write the provider file on the runner, ~/.safeguard/secret-providers.yaml, with the PAM's address, the identity and its certificates. The Providers tab generates it for you. See Runner configuration.
  4. Add a vault entry of the kind From your PAM vault and give it a handle, then Test access from the runner. See Add an entry.
  5. Use the entry in a scan target with the From the vault button, and choose On-prem runner for DAST and API targets. See Using vault credentials in scans.

Add an entry

  1. Open Settings, then Credentials Vault, and choose the Credentials tab. If your organization does not show Credentials Vault yet, the same list is under Sandboxes, then Cloud credentials; choose the Shared tab there. Shared entries are the ones scans can use.
  2. Choose Add a credential. The field Where the value lives has two choices:
    • Stored in Safeguard is the form you already know: name, type, username, secret, address, tags, handle and notes. Tick Protect with a vault policy to turn the vault controls on from the start. The value is then write-only: once saved it can be replaced with a new version, not shown again.
    • From your PAM vault has no secret field. Pick your PAM product, fill in the fields it asks for (for ARCON PAM: target type, server IP or host name, user name, and optionally the hours to open the password for), and Safeguard shows the reference it will keep. Optionally pick a registered provider.
  3. Give the entry a handle, for example dast-staging, and save. Scans refer to the entry as sgvault://dast-staging.

If Protect with a vault policy or the Providers tab is not shown, the vault controls are not turned on for your organization yet. Contact Safeguard support. If From your PAM vault is not offered, PAM entries are not turned on yet; contact Safeguard support for that too.

From a terminal, safeguard vault add does the same. See the CLI reference.

Register a provider (optional)

The Providers tab lists the Safeguard vault and your registered PAM instances. Register one with a name, the product, its address, the sign-in method and the runner that reads from it. The form is generated for each product, and the tab shows the secret-providers.yaml snippet to put on the runner. This is descriptive information only. Certificates, keys and tokens are never entered in Safeguard; they stay in a file on the runner. The page shows Configured on runner X once that runner reports a provider with the same name, so the name you register must equal the name in the runner's secret-providers.yaml. See Provider setup.

Test access

Before a scan depends on an entry that points at your PAM, check that the runner can read it.

  • In the app, choose Test access on the entry, pick the runner, and choose Run test. The row shows Waiting for the runner to read it, then Read OK on the runner. The value was not sent to Safeguard., or the error code and message, for example FORBIDDEN: the API user is not allowed to retrieve this account. The value is never shown. If no runner picks the test up within about two minutes, the test expires.
  • On the runner machine, run safeguard secrets test <reference>. It reads the reference and prints OK, the provider and a length class, or the reason it failed. It never prints the value.

Where to go next

On this page