Skip to content

docs(get-started): add audit reports page - #357

Merged
jplgarcia merged 5 commits into
mainfrom
docs/internal-audits
Oct 30, 2026
Merged

jplgarcia merged 5 commits into
mainfrom
docs/internal-audits

Conversation

@jplgarcia

@jplgarcia jplgarcia commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

What

Adds an Audit Reports page under Get Started > References, next to Cartesi CLI, Honeypot Application and Rollup Lab.

  • get-started/audit-reports.md: a table of security reviews (date, report, reviewed by, components, PDF download) and the vulnerability reporting policy. It has one entry for now, reviewed by the internal QA team. External audits can be added with their firm name in the "Reviewed by" column.
  • static/audit-reports/rollups-node-v2.0.0-alpha.12-internal-security-review.pdf: the Rollups Node v2.0.0-alpha.12 internal security review (August 4, 2026), covering rollups-node, rollups-contracts and the CLI. It lists the seven findings that were reported to the maintainers during the cycle, with description, impact and severity, plus developer experience notes and the severity scale.
  • sidebarsGetStarted.js: new sidebar entry.
  • Removes the Immunefi "Bug Bounty" link (immunefi.com/bounty/cartesi/ returns 404) from docusaurus.config.js and the unused bugBounty route in FooterNav.js.

Why

Cartesi needs a public place for security reports and advisories: a documented policy plus an advisory archive. This page is both, so it works as the single point for that information. The SECURITY.md in the repositories links here (default org policy in cartesi/.github#1).

Notes for reviewers

  • The report lists findings as reported, with no status. Maintainers should confirm they are comfortable with every finding being public before merge.
  • The PDF links to the reviewed source at the tested tags and, for the CLI gas limit, to rollups-node#786. The links were checked against GitHub.
  • The PDF link uses the pathname:// protocol because trailingSlash: true otherwise adds a trailing slash to the .pdf URL and GitHub Pages returns 404.
  • The policy has no response-time or disclosure-date commitments, on purpose. Reports are not encrypted for now.
  • Do not merge before the rollups@cartesi.foundation mailbox exists. The page gives it as the reporting contact.
  • Checked locally with yarn start. I did not run yarn build.

🤖 Generated with Claude Code

Add an Internal Audits page under Get Started > References, next to the
Cartesi CLI, Honeypot and Rollup Lab entries. It lists the internal
security reviews with a PDF download. First entry is the Rollups Node
v2.0.0-alpha.12 internal security review.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

📖 Docs preview removed

The preview for this PR was taken down because the PR is now closed.

github-actions Bot added a commit that referenced this pull request Oct 28, 2026
The Immunefi page for Cartesi (immunefi.com/bounty/cartesi/) returns 404.
Remove it from the footer config and the unused bugBounty route, and from
the new Internal Audits page and its PDF.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
github-actions Bot added a commit that referenced this pull request Oct 28, 2026
trailingSlash is enabled, so the PDF link was rendered with a trailing
slash and returned 404 on GitHub Pages. Use the pathname:// protocol so
the link keeps the file path as is and still gets the baseUrl.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
github-actions Bot added a commit that referenced this pull request Oct 28, 2026
Replace the alpha.12 internal security review PDF with a version that
lists the seven findings reported to the maintainers, with a severity
scale and developer experience notes, and update the page description
and the reporting contact to match.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
github-actions Bot added a commit that referenced this pull request Oct 28, 2026
…eporting policy

Rename the page from Internal audits to Audit reports so it also fits external
audits, add a "Reviewed by" column, move the PDF to static/audit-reports, and
keep the vulnerability reporting policy on the page without response-time
commitments.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@jplgarcia jplgarcia changed the title docs(get-started): add internal audits page docs(get-started): add audit reports page Oct 30, 2026
github-actions Bot added a commit that referenced this pull request Oct 30, 2026
@jplgarcia
jplgarcia merged commit 2f0c59e into main Oct 30, 2026
1 check passed
@jplgarcia
jplgarcia deleted the docs/internal-audits branch October 30, 2026 16:05
github-actions Bot added a commit that referenced this pull request Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants