Skip to content
FendixDocumentationDocs

.fendix.yaml · SEC-001 · SARIF

Current release v3.7.0
ReferenceStablev3.7.0

.fendix.yaml

Exact strict schema, defaults, validation, precedence, and CLI mappings for .fendix.yaml.

On this page

The current strict .fendix.yaml schema version is 1. Unknown fields and unsupported future versions are rejected.

Minimal valid configuration

.fendix.yaml
version: 1

Common release policy

.fendix.yaml
version: 1
fail_on: HIGH
ignore_path: .fendix-ignore
scan:
  enforce_confidence: true
  deescalate_tests: true

Precedence

Fendix applies defaults, then values present in .fendix.yaml, then only CLI flags explicitly supplied by the caller. An unchanged CLI default does not overwrite the file.

defaults→.fendix.yaml→explicit CLI flags

Top-level fields

Scroll horizontally to inspect every field.

FieldTypeDefaultRequirementAllowed valuesCLIDescription
versioninteger1Required1—Required configuration schema version.
fail_onstring—OptionalCRITICAL · HIGH · MEDIUM · LOW · empty--fail-onSeverity threshold considered by the finding policy.
ignore_pathstring—Optional—--ignoreRepository ignore-file path.

scan fields

Scroll horizontally to inspect every field.

FieldTypeDefaultRequirementAllowed valuesCLIDescription
scan.deescalate_testsbooleantrueOptional—--deescalate-testsTreat unsupported test-code findings as informational while preserving evidence.
scan.delay_msinteger100Optional—--delayDelay between HTTP requests in milliseconds.
scan.enable_activebooleanfalseOptional—--enable-activeExplicitly permit active injection probes.
scan.enforce_confidencebooleantrueOptional—--enforce-confidenceRequire confidence and evidence support before BLOCK.
scan.formatstringjsonOptionaljson · html · sarif · pdf--formatDefault report format.
scan.timeoutinteger10Optional—--timeoutHTTP timeout in seconds.
scan.workersinteger10Optional—--workersConcurrent HTTP worker count.

crawler fields

Scroll horizontally to inspect every field.

FieldTypeDefaultRequirementAllowed valuesCLIDescription
crawler.crawl_depthinteger1Optional—--crawl-depthRecursive HTML link depth.
crawler.max_endpointsinteger500Optional—--max-endpointsMaximum discovered endpoints.
crawler.respect_robotsbooleanfalseOptional—--respect-robotsEnforce robots.txt Disallow directives.
crawler.wordlist_pathstring—Optional—--wordlistCustom discovery wordlist path.

budgets fields

Scroll horizontally to inspect every field.

FieldTypeDefaultRequirementAllowed valuesCLIDescription
budgets.max_durationduration0sOptional—--max-durationSoft cap for total scan duration.
budgets.max_requestsinteger0Optional—--max-requestsSoft cap for total HTTP requests.

auth fields

Scroll horizontally to inspect every field.

FieldTypeDefaultRequirementAllowed valuesCLIDescription
auth.profilestring—Optional—--profileName of a local authentication profile; no secret is stored in repository policy.

Validation behavior

  • version is required, must be positive, and cannot exceed 1.
  • Unknown fields fail parsing; spelling mistakes are never ignored silently.
  • A future schema version fails loudly so an older binary cannot misread policy.

Stable CLI-only capabilities

These stable controls cannot currently be committed to .fendix.yaml. Pass them explicitly in the invocation or CI configuration.

CapabilityCLI options
Coverage gates--fail-on-coverage-gap, --require-analyzers
Applicability policy--block-on-inapplicable
Offline scanning--offline, --offline-db
Diff and staged scope--diff, --staged, --fast
Analyzer selection--checks, --python-engine, --no-native-deps
Imports and plugins--import, --no-plugins, --allow-repo-local-plugins

Configure release policy · scan policy options