Type object
File match **/zizmor.yml **/zizmor.yaml **/.github/zizmor.yml **/.github/zizmor.yaml
Schema URL https://catalog.lintel.tools/schemas/github/zizmor/latest.json
Source https://raw.githubusercontent.com/woodruffw/zizmor/main/support/zizmor.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration file for zizmor, a static analysis tool for GitHub Actions.

See: https://docs.zizmor.sh/configuration/

Properties

rules object
34 nested properties
anonymous-definition object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
archived-uses object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
artipacked object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
bot-conditions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
cache-poisoning object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
concurrency-limits object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
dangerous-triggers object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
dependabot-cooldown object

Configuration for the dependabot-cooldown audit.

3 nested properties
config object

Configuration for the dependabot-cooldown audit.

1 nested properties
days integer

The minimum acceptable default-days value for Dependabot's cooldown setting.

Settings beneath this value will produce findings.

Default: 7
format=uintmin=1
disable boolean
Default: false
dependabot-execution object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
excessive-permissions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
forbidden-uses object

Configuration for the forbidden-uses audit.

3 nested properties
config ForbiddenUsesConfig | null
disable boolean
Default: false
github-env object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
hardcoded-container-credentials object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
impostor-commit object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
insecure-commands object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
known-vulnerable-actions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
misfeature object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
obfuscation object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
overprovisioned-secrets object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
ref-confusion object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
ref-version-mismatch object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
secrets-inherit object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
secrets-outside-env object

Configuration for the secrets-outside-env audit.

3 nested properties
config SecretsOutsideEnvConfig | null
disable boolean
Default: false
self-hosted-runner object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
stale-action-refs object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
superfluous-actions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
template-injection object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
undocumented-permissions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unpinned-images object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unpinned-uses object

Configuration for the unpinned-uses audit.

3 nested properties
config object

This configuration is reified into an UnpinnedUsesPolicies.

1 nested properties
policies Record<string, string | string | string>

A mapping of uses: patterns to policies.

disable boolean
Default: false
unredacted-secrets object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unsound-condition object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unsound-contains object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
use-trusted-publishing object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false

Definitions

BaseRuleConfig object

Base configuration for all audit rules.

disable boolean
Default: false
DependabotCooldownConfig object

Configuration for the dependabot-cooldown audit.

days integer

The minimum acceptable default-days value for Dependabot's cooldown setting.

Settings beneath this value will produce findings.

Default: 7
format=uintmin=1
DependabotCooldownRuleConfig object

Configuration for the dependabot-cooldown audit.

config object

Configuration for the dependabot-cooldown audit.

1 nested properties
days integer

The minimum acceptable default-days value for Dependabot's cooldown setting.

Settings beneath this value will produce findings.

Default: 7
format=uintmin=1
disable boolean
Default: false
ForbiddenUsesConfig object | object

An allow or deny list of uses: patterns for the forbidden-uses audit.

ForbiddenUsesRuleConfig object

Configuration for the forbidden-uses audit.

config ForbiddenUsesConfig | null
disable boolean
Default: false
RepositoryUsesPattern string

These patterns are ordered by specificity; more specific patterns should be listed first.

RulesConfig object
anonymous-definition object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
archived-uses object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
artipacked object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
bot-conditions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
cache-poisoning object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
concurrency-limits object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
dangerous-triggers object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
dependabot-cooldown object

Configuration for the dependabot-cooldown audit.

3 nested properties
config object

Configuration for the dependabot-cooldown audit.

1 nested properties
days integer

The minimum acceptable default-days value for Dependabot's cooldown setting.

Settings beneath this value will produce findings.

Default: 7
format=uintmin=1
disable boolean
Default: false
dependabot-execution object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
excessive-permissions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
forbidden-uses object

Configuration for the forbidden-uses audit.

3 nested properties
config ForbiddenUsesConfig | null
disable boolean
Default: false
github-env object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
hardcoded-container-credentials object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
impostor-commit object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
insecure-commands object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
known-vulnerable-actions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
misfeature object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
obfuscation object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
overprovisioned-secrets object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
ref-confusion object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
ref-version-mismatch object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
secrets-inherit object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
secrets-outside-env object

Configuration for the secrets-outside-env audit.

3 nested properties
config SecretsOutsideEnvConfig | null
disable boolean
Default: false
self-hosted-runner object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
stale-action-refs object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
superfluous-actions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
template-injection object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
undocumented-permissions object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unpinned-images object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unpinned-uses object

Configuration for the unpinned-uses audit.

3 nested properties
config object

This configuration is reified into an UnpinnedUsesPolicies.

1 nested properties
policies Record<string, string | string | string>

A mapping of uses: patterns to policies.

disable boolean
Default: false
unredacted-secrets object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unsound-condition object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
unsound-contains object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
use-trusted-publishing object

Base configuration for all audit rules.

2 nested properties
disable boolean
Default: false
SecretsOutsideEnvConfig object

Configuration for the secrets-outside-env audit.

allow string[]

List of secret names excluded from the audit

Default:
[]
SecretsOutsideEnvRuleConfig object

Configuration for the secrets-outside-env audit.

config SecretsOutsideEnvConfig | null
disable boolean
Default: false
UnpinnedUsesConfig object

This configuration is reified into an UnpinnedUsesPolicies.

policies Record<string, string | string | string>

A mapping of uses: patterns to policies.

UnpinnedUsesRuleConfig object

Configuration for the unpinned-uses audit.

config object

This configuration is reified into an UnpinnedUsesPolicies.

1 nested properties
policies Record<string, string | string | string>

A mapping of uses: patterns to policies.

disable boolean
Default: false
UsesPolicy string | string | string

A singular policy for a uses: reference.

WorkflowRule string

Ignore rules are specified as filename.yml:line:col, where line and col are optional 1-based indices. If line is omitted, col must also be omitted.