Security
What runs where, and what leaves
BonaFident runs the mutation engine on your CI runner. This page lists what is uploaded, what the GitHub App can do, and what is not done yet.
What runs where
The mutation engine runs on your CI runner, or on your machine for a local audit. BonaFident Cloud receives the report, not your repository.
- Your source code stays on the runner by default.
- Only one file is uploaded:
bonafident-report.json, gzipped, over TLS. - A local audit (
audit --local) uploads nothing. - Other report files the engine writes (Markdown, JUnit, Sonar, GitLab code quality) stay in your CI workspace. They do contain code: publishing them as build artifacts publishes that code.
What is uploaded
In its default form, bonafident-report.json holds no source text. It holds:
For each change BonaFident made
- File path, line and column
- Operator (the kind of change) and the syntax node kind
- Status (Killed, Survived, No coverage and the rest) with a fixed reason code
- The test files that ran the change or caught it
- A keyed HMAC-SHA256 digest of the original expression. The key is derived on the runner and never written to the report.
With the run
- Commit SHA and branch
- Repository identity as https://host/owner/repo, never the remote URL or a token in it
- The engine version and the SHA-256 of the engine binary that ran
- The CI pipeline URL, when the CI provides one
- On GitHub Actions, the short-lived OIDC token, whose claims name the repository and the workflow run
Also in the report
- The resolved bonafident.yml, including your globs and the test command
- The import graph between your files
- Detected framework names and versions
- Run metadata: CPU cores, worker count, heap size, wall time
File paths and line numbers are themselves metadata. They show how your repository is laid out and where the untested code is. If that is too much, the engine flag --strict-sovereignty (for example npx bonafident run -- --strict-sovereignty) replaces every path and policy string with an opaque identifier; the map stays on the runner.
Source in the report
report.source in bonafident.yml decides whether the report may quote code.
| Mode | Setting | What the report contains |
|---|---|---|
| Redacted | report.source: none (the default) | File paths, line and column numbers, mutation types and keyed digests. No source text: changed expressions, test names, assertion messages, error output and function names are removed before the report is written. |
| Full | report.source: full (opt-in, in bonafident.yml) | Also the changed expressions before and after the change, and the text of each enclosing function or class that holds code no test checks. The engine clips each excerpt to 150 lines and 12,000 bytes. BonaFident Cloud keeps at most 2,000 excerpts per report, each at most 12,000 characters. |
Organization policy
Full also needs an organization owner or admin to allow it (Settings > Data). Every organization starts at none: excerpts a report carries anyway are removed when it arrives, and the raw upload is deleted. Each change to the setting is recorded in the audit log.
Retention
- Free plan: BonaFident Cloud extracts the score and the counts, then discards the uploaded report. Up to 10 survivor locations (file, line and mutation type, no code) are kept for the pull request comment, then removed with the retention window.
- Paid plans: the line-level detail of each report (the stored report, survivors, crashing files and any excerpts) is kept for 90 days by default, then removed. Owners and admins can shorten the window. Scores, counts, verdicts and the Evidence Ledger are kept.
- Owners and admins can delete a project’s report detail at any time and download everything the workspace holds as one file (Settings > Data). Deleting a project removes its report detail too.
GitHub App permissions
The BonaFident GitHub App asks for these, and nothing else, by default:
| Permission | Access | Why |
|---|---|---|
metadata | read | Mandatory for every GitHub App. |
contents | read | Read CODEOWNERS and the policy file from the base branch. |
pull_requests | write | Post and update the one BonaFident comment on each pull request. |
checks | write | Publish the BonaFident check that branch protection can require. |
No workflows access, no issues access, and no write access to your code. In the standard install the App never pushes: you commit the workflow and bonafident.yml yourself. It does not ask for administration, so branch protection stays your decision.
Optional permissions
Each unlocks one capability. Without it, that capability shows a clear message and everything else works.
| Permission | Access | Why |
|---|---|---|
members | read | Verify team-owned CODEOWNERS entries when a team member accepts a risk. |
actions | write | Re-run the blocked job right after a risk acceptance so its status clears. |
The optional setup pull request
BonaFident can open a pull request that adds the workflow for you. It is opt-in and not part of the standard install, because it needs more access:
| Permission | Access | Why |
|---|---|---|
contents | write | Create the setup branch and commit the workflow. |
workflows | write | GitHub rejects any App write under .github/workflows/ without it. |
CI credentials
- GitHub Actions: the job authenticates with a short-lived OIDC token that GitHub mints for that run (
id-token: write). Nothing is stored on GitHub, and BonaFident resolves the project from the verified repository. - GitLab CI and Bitbucket Pipelines: a project API key in a masked CI variable (
BONAFIDENT_API_KEY). Revoke it at any time in the console under API keys.
Engine integrity
- The GitHub Action installs exactly the engine version pinned in its
versions.envand runs it only if the archive’s SHA-256 matches the checksum committed in the Action. A mismatch discards the archive unexecuted. - The CLI does the same against a SHA-256 compiled into the CLI, keyed by platform, and re-checks the binary before it runs it.
- Engine signature verification with Sigstore is being added. The pinned Action release checks the SHA-256 only.
Evidence Ledger
The Evidence Ledger on the Team plan is tamper-evident: each entry is hash-chained to the one before it, so a changed or removed entry breaks the chain. Each week, and on request, BonaFident signs the head of the chain with a dedicated Ed25519 key used for nothing else.
Anyone can check a signed checkpoint without an account: the public keys are at /api/v1/compliance-ledger/keys, and POST /api/v1/compliance-ledger/checkpoints/verify answers whether a signature is valid and its head is still in the ledger. Period exports carry the latest checkpoint and each entry says whether its run was attested by GitHub or GitLab OIDC.
Access control
- Single sign-on with SAML 2.0, for the email domains you verify with a DNS record. Owners can require it; they keep password access themselves so an identity-provider outage never locks the workspace.
- SCIM 2.0 provisioning: your identity provider adds and removes members, and maps its groups to roles. Removing someone revokes their sessions and the API keys they created.
- Roles: Owner, Admin, Developer and Auditor. An Auditor reads runs, the Evidence Ledger and the audit log, and cannot change anything or accept risk.
- An audit log of access, key, policy, billing and single sign-on changes, exportable as CSV with a SHA-256 of the file.
Compliance
SOC 2: not started.
A BonaFident report is evidence that changes were tested, and how well. It can support the testing records behind SOC 2 CC8.1, PCI DSS 6.2.3 and DORA Article 25. It is not an audit opinion.
Sub-processors
BonaFident Cloud relies on providers in these categories:
- Infrastructure hosting for the API, its database and its job queue
- Object storage for uploaded reports on paid plans
- A content delivery network that serves the engine download
- A payment processor for subscriptions
The sub-processor list will be published with the legal documents.
Reporting a vulnerability
A security contact will be published with the legal documents.