#[non_exhaustive]pub struct CredentialFile {
pub path: Option<String>,
pub mode: Option<CredentialMode>,
pub extract: Option<String>,
pub on_extract_no_match: Option<ExtractNoMatch>,
pub decode: Option<TokenDecode>,
pub mask_claims: Option<Vec<String>>,
pub mask_duplicates: Option<bool>,
pub inject_hosts: Option<Vec<String>>,
pub extra: Extra,
}Expand description
An entry of sandbox.credentials.files.
Protect credential files or directories from sandboxed commands. With "mode": "deny",
Claude Code blocks reads of the path inside the sandbox, the same read block as
sandbox.filesystem.denyRead.
Docs: sandbox.credentials.files.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.path: Option<String>§mode: Option<CredentialMode>§extract: Option<String>Mask only the text captured by group 1 of each match, so the rest of the file stays
parseable. With decode also set, Claude Code checks each capture as a possible JWT
instead of replacing it outright. Requires v2.1.221 or later.
- Values: string, a regular expression with at least one capturing group
- Default: unset
Docs: extract.
on_extract_no_match: Option<ExtractNoMatch>What happens when extract or decode finds nothing to mask. warn leaves the file
readable as-is inside the sandbox, deny makes it unreadable, and error stops sandbox
setup until you fix the configuration. Claude Code treats deny as error when the
read block wouldn’t be enforced, because you disable filesystem
isolation or a
sandbox.filesystem.allowRead
entry re-opens the path.
- Values:
"warn","deny", or"error"; default"warn" - Default: unset
Docs: onExtractNoMatch.
decode: Option<TokenDecode>Find JSON Web Tokens (JWTs) in the file, with a built-in pattern or with extract when
set, verify each candidate, and replace it with a structurally valid fake token, so code
inside the sandbox that decodes the token keeps working. When no candidate verifies,
onExtractNoMatch governs the outcome. Requires v2.1.224 or later.
- Values: the string
"jwt" - Default: unset
Docs: decode.
mask_claims: Option<Vec<String>>Mask only the named top-level payload claims inside each verified JWT and rebuild the
token around the modified payload, so the other claims stay readable. When no named
claim matches, onExtractNoMatch governs the outcome. Requires v2.1.224 or later.
- Values: array of strings, at least one claim name; requires
decode - Default: unset
Docs: maskClaims.
mask_duplicates: Option<bool>Also replace verbatim copies of each masked value elsewhere in the file, such as a
secret pasted into a comment. Claude Code matches raw substrings, so reserve it for
long, high-entropy secrets. Consulted only when extract or decode is set.
- Values: Boolean, default
false - Default: unset
Docs: maskDuplicates.
inject_hosts: Option<Vec<String>>Narrow the hosts where the sandbox proxy substitutes the real value. When unset, the
proxy substitutes it on requests to every host in sandbox.network.allowedDomains.
Requires v2.1.221 or later.
- Values: array of strings, each a host that
sandbox.network.allowedDomainsalso admits - Default: unset
Docs: injectHosts.
extra: ExtraKeys Claude Code accepts here that this crate doesn’t model (newer or undocumented ones), kept as written so the document round-trips.