* fix(security,ci): redact all DSN password forms in telemetry; require pg/mysql conformance Post-merge remediation for #4601 (choose-your-own-backend), reviewed landed range 812ad6d..3f0474a. Addresses the two gating findings from the post-merge review. Security (telemetry DSN leak): scrubArgsForTelemetry only redacted user:PASS@host userinfo, so `bd init --pg-url` URL `?password=`/`?sslpassword=` query params and libpq `password=`/`sslpassword=` keyword/value forms leaked into the bd.args telemetry span before init reached the parser-backed redaction path. Route --pg-url/--mysql-url values (both `--flag=value` and `--flag value`) through the parser-backed pgdialect scrubber via a new exported pgdialect.ScrubDSNString; every other arg keeps the narrow userinfo scrub, so ordinary text is never over-redacted. CI (conformance anti-skip): scripts/conformance.sh ran the pg/mysql Tier-1 suites with no skip/PASS detector, so a missing BEADS_*_TEST_URL self-skipped to green and silently narrowed backend coverage. Add require_backend + run_sql_conformance mirroring the embedded-Dolt reference guard, and set BEADS_CONFORMANCE_REQUIRE=postgres,mysql in conformance.yml (which also arms the existing Tier-2 e2e hard-fail). Tests: pgdialect TestScrubDSNString; cmd/bd TestScrubArgsForTelemetry (all DSN password forms x both spellings) and TestScrubArgsForTelemetryLeavesOrdinaryArgs (no over-redaction + userinfo defense-in-depth). Bash guards unit- and integration-tested against real `go test` self-skip/required paths. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(security): redact federation add-peer --password/-p from telemetry args The bd.args telemetry root span scrubbed --pg-url/--mysql-url DSN passwords but not federation add-peer's --password/-p, so `bd federation add-peer <name> <url> --user u --password <secret>` leaked the plaintext SQL password verbatim into the exported bd.args attribute and trace logs — the same sink and harm class the DSN scrub already closed. Redact by flag identity: secretFlagTokens resolves the secret flag's actual --long/-short tokens from the running command, so -p is redacted only on the command that binds it to --password (federation add-peer) and never on the many commands that bind -p to --priority/--prefix/--parallel. The value is redacted wholesale across every pflag spelling: --password <v>, --password=<v>, -p <v>, -p=<v>, and the concatenated -p<v> shorthand. Tests cover all five spellings, the command-aware token resolution, and the no-over-redaction guarantee for the overloaded -p on non-secret commands. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(security): redact raw encoded URL-userinfo passwords in DSN scrubber Post-merge remediation follow-up review (attempt-4) for #4601: the shared pgdialect DSN redactor missed percent-encoded URL-userinfo passwords when called directly — ScrubDSNError in driver.go, and any telemetry/log sink that scrubs a raw DSN through ScrubDSNString. dsnPasswordValues added only url.User.Password(), which url.Parse returns percent-DECODED, so ScrubDSNString("postgres://u:SUPER%2ASECRET@h/db", same) left the raw "SUPER%2ASECRET" in error text and logs. The query-param branch already adds both the raw and decoded forms; the userinfo branch now does too, extracting the raw as-written password structurally (rawURLUserinfoPassword) so it matches regardless of encoding form (mixed case, over-encoding). Tests: add encoded-userinfo cases to TestScrubDSNError and TestScrubDSNString (the latter now checks every leak form, matching TestScrubDSNError). Both new cases fail on the pre-fix redactor and pass after. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(security): close five telemetry DSN-redaction bypasses found in review Test-first fixes, each reproduced against pgx.ParseConfig before fixing: - percent-encoded query KEYS (pass%77ord=, %70assword=) are live password params after url.Query() decoding; compare unescaped keys too - pflag boolean-shorthand clusters (-qpSECRET parses as -q -p SECRET) leaked the raw token; walk the leading letter run to the first secret shorthand - backslash-escaped whitespace in unquoted libpq values (password=SUPER\ SECRET) leaked the tail; value pattern now consumes escaped sequences - pgx treats \v as DSN whitespace but Go regexp \s does not; spell the whitespace class out explicitly - overlapping secrets (one a prefix of another) leaked the longer tail; replace longest-first in ScrubDSNString Found by paired cross-vendor review (claude fable-5 + codex gpt-5.6-sol) on PR 4712. Agent-Signature: claude-fable-5-high on behalf of maphew --------- Co-authored-by: Eddie the Engineer <test@test.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: matt wilkie <maphew@gmail.com> |
||
|---|---|---|
| .. | ||
| bench-ready-indexes | ||
| ci | ||
| hooks | ||
| migration-test | ||
| repro-dolt-hang | ||
| repro-dolt-prod-timeouts | ||
| bump-version.sh | ||
| check-build-tags.sh | ||
| check-cli-docs-drift.sh | ||
| check-doc-flags.sh | ||
| check-doc-freshness.sh | ||
| check-docs-version.sh | ||
| check-go-install-guidance.sh | ||
| check-migration-hygiene.sh | ||
| check-testing-short.sh | ||
| check-versions.sh | ||
| check-website-docs-drift.sh | ||
| clean-test-tmp.sh | ||
| conformance.sh | ||
| cross-version-smoke-test.sh | ||
| docs-autofix-push.sh | ||
| docs.md | ||
| gen-winres.sh | ||
| generate-cli-docs.sh | ||
| generate-llms-full.sh | ||
| generate-newsletter.py | ||
| generate-newsletter_README.md | ||
| gh-body-lint | ||
| install-hooks.sh | ||
| install.sh | ||
| migrate-jsonl-to-dolt.sh | ||
| migrate-sqlite-to-current.sh | ||
| pr-preflight.sh | ||
| README.md | ||
| release.sh | ||
| release_script_test.go | ||
| run-oracle-p.sh | ||
| sign-windows.sh | ||
| snapshot-release-docs.sh | ||
| sync-website-docs.sh | ||
| test-cgo.sh | ||
| test-git-remote.sh | ||
| test-icu-path.sh | ||
| test.sh | ||
| update-nix-vendorhash.sh | ||
| update-versions.sh | ||
| update-winget.sh | ||
| upgrade-smoke-test.sh | ||
| verify-cgo.sh | ||
Beads Scripts
Utility scripts for maintaining the beads project.
ci/
Repository-owned CI command wrappers. These scripts are the source of truth for the target CI tiers; Make targets are aliases for local discoverability.
make ci-pr-core
make ci-pr-policy
make ci-pr-lint
make ci-package-mcp
make ci-package-npm
make ci-website
Each wrapper auto-detects the repository root, sources .buildflags when it
invokes Go in the default build mode, and records per-command timing through
scripts/ci/lib/timing.sh.
Broad Go test wrappers also source scripts/ci/lib/test-env.sh, which creates a
temporary HOME/XDG/Dolt root, isolates Git global/system config, clears runtime
Beads/Dolt environment variables, and sets BEADS_TEST_SKIP=dolt before tests
run. This keeps local make test and make ci-pr-core results comparable to
the fast PR-core contract even on shared agent hosts. Set
BEADS_TEST_ENV_RUN_DOLT=1 only when intentionally running the Dolt-dependent
tests through these broad wrappers, or BEADS_TEST_ENV_DISABLE=1 when debugging
against your real local configuration.
The broad Go wrappers also cap package and test parallelism to 4 by default
(GO_TEST_PKG_PARALLEL and GO_TEST_PARALLEL). This avoids turning high-core
shared hosts into a different test topology than GitHub Actions.
make ci-pr-policy includes scripts/check-testing-short.sh, which enforces
that testing.Short() is only used for runtime, stress, or large-fixture skips.
Use build tags, environment checks, or named wrappers for integration/e2e/API
boundaries.
Package gate wrappers validate publishable/package-adjacent surfaces:
make ci-package-mcpbuilds or consumes abdbinary, puts it onPATHasbd, then runs locked MCP packageuv sync, Ruff, mypy, pytest, and build checks.make ci-package-npmbuilds or consumes the native binary expected bynpm-package/bin/bd, runs the npm package test suite, and checksnpm pack --dry-run.make ci-websiteruns website dependency install, typecheck,llms-full.txtgeneration, and Docusaurus build.
Set BEADS_TEST_BD_BINARY=/path/to/bd for MCP and npm package gates to reuse a
prebuilt candidate binary instead of rebuilding it inside the wrapper.
pr-preflight.sh
Read-only PR safety check for agents and maintainers.
# Before implementing or opening a related PR
./scripts/pr-preflight.sh --search "topic keywords" --repo gastownhall/beads
# Before changing, closing, or merging an existing PR
./scripts/pr-preflight.sh 123 --repo gastownhall/beads
It reports contributor/fork status, draft/review/merge/check state, risky diff
signals such as .beads/ changes or missing tests, and the required
contributor-protection next steps. It does not replace code review or local
validation.
gh-body-lint
Lint Markdown files before posting them with gh ... --body-file.
./scripts/gh-body-lint body.md
./scripts/gh-body-lint --fix body.md
The lint catches literal \n sequences, which render poorly on GitHub, and
GH#123 references, which do not auto-link like #123 or owner/repo#123.
release.sh (⭐ The Easy Button)
One-command release from version bump to local installation.
Usage
# Full release (does everything)
./scripts/release.sh 0.9.3
# Preview what would happen
./scripts/release.sh 0.9.3 --dry-run
What It Does
This master script automates the entire release process:
- ✅ Stops running Dolt servers (avoids version conflicts)
- ✅ Runs tests and linting
- ✅ Bumps version in all files
- ✅ Commits and pushes version bump
- ✅ Creates and pushes git tag
- ✅ Verifies or opens the Homebrew core formula PR
- ✅ Upgrades local Homebrew installation
- ✅ Verifies everything works
After this script completes, your system is running the new version!
Examples
# Release version 0.9.3
./scripts/release.sh 0.9.3
# Preview a release (no changes made)
./scripts/release.sh 1.0.0 --dry-run
Prerequisites
- Clean git working directory
- All changes committed
- golangci-lint installed
- Homebrew installed (for local upgrade)
- Push access to gastownhall/beads
Output
The script provides colorful, step-by-step progress output:
- 🟨 Yellow: Current step
- 🟩 Green: Step completed
- 🟥 Red: Errors
- 🟦 Blue: Section headers
What Happens Next
After the script finishes:
- GitHub Actions builds binaries for all platforms (~5 minutes)
- PyPI package is published automatically
- Homebrew core formula is verified or tracked through its canonical PR
- Users can
brew upgrade beadsto get the new version after Homebrew merges - GitHub Release is created with binaries and changelog
bump-version.sh
Bumps the version number across all beads components in a single command.
Usage
# Show usage
./scripts/bump-version.sh
# Update versions (shows diff, no commit)
./scripts/bump-version.sh 0.9.3
# Update versions and auto-commit
./scripts/bump-version.sh 0.9.3 --commit
What It Does
Updates version in all these files:
cmd/bd/version.go- bd CLI version constantplugins/beads/.claude-plugin/plugin.json- Claude plugin versionplugins/beads/.codex-plugin/plugin.json- Codex plugin version.claude-plugin/marketplace.json- Claude marketplace plugin versionintegrations/beads-mcp/pyproject.toml- MCP server versionREADME.md- Alpha status versionPLUGIN.md- Version requirements
Features
- Validates semantic versioning format (MAJOR.MINOR.PATCH)
- Verifies all versions match after update
- Shows git diff of changes
- Auto-commits with standardized message (optional)
- Cross-platform compatible (macOS and Linux)
Examples
# Bump to 0.9.3 and review changes
./scripts/bump-version.sh 0.9.3
# Review the diff, then manually commit
# Bump to 1.0.0 and auto-commit
./scripts/bump-version.sh 1.0.0 --commit
git push origin main
Why This Script Exists
Previously, version bumps only updated cmd/bd/version.go, leaving other components out of sync. This script ensures all version numbers stay consistent across the project.
Safety
- Checks for uncommitted changes before proceeding
- Refuses to auto-commit if there are existing uncommitted changes
- Validates version format before making any changes
- Verifies all versions match after update
- Shows diff for review before commit
sign-windows.sh
Signs Windows executables with an Authenticode certificate using osslsigncode.
Usage
# Sign a Windows executable
./scripts/sign-windows.sh path/to/bd.exe
# Environment variables required for signing:
export WINDOWS_SIGNING_CERT_PFX_BASE64="<base64-encoded-pfx>"
export WINDOWS_SIGNING_CERT_PASSWORD="<certificate-password>"
What It Does
This script is called automatically by GoReleaser during the release process:
- Decodes the PFX certificate from base64
- Signs the Windows executable using osslsigncode
- Timestamps the signature using DigiCert's RFC3161 server
- Replaces the original binary with the signed version
- Verifies the signature was applied correctly
Prerequisites
osslsigncodeinstalled (apt install osslsigncodeorbrew install osslsigncode)- EV code signing certificate exported as PFX file
- GitHub secrets configured:
WINDOWS_SIGNING_CERT_PFX_BASE64- base64-encoded PFX fileWINDOWS_SIGNING_CERT_PASSWORD- certificate password
Graceful Degradation
If the signing secrets are not configured:
- The script prints a warning and exits successfully
- GoReleaser continues without signing
- The release proceeds with unsigned Windows binaries
This allows releases to work before a certificate is acquired.
Why This Script Exists
Windows code signing helps reduce antivirus false positives that affect Go binaries.
Kaspersky and other AV software commonly flag unsigned Go executables as potentially
malicious due to heuristic detection. See docs/ANTIVIRUS.md for details.
Future Scripts
Additional maintenance scripts may be added here as needed.