sigild 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +25 -0
- package/README.md +18 -2
- package/package.json +1 -1
package/CONTRIBUTING.md
CHANGED
|
@@ -37,3 +37,28 @@ Never commit:
|
|
|
37
37
|
The repo `.gitignore` covers these patterns. Double-check `git status` before committing.
|
|
38
38
|
|
|
39
39
|
For security issues in sigil itself, open a private GitHub Security Advisory rather than a public issue.
|
|
40
|
+
|
|
41
|
+
## Releasing (maintainer only)
|
|
42
|
+
|
|
43
|
+
`sigild` publishes to npm via OIDC trusted-publisher auth — there is no long-lived `NPM_TOKEN`. The release workflow at [`.github/workflows/release.yml`](./.github/workflows/release.yml) is the only thing allowed to publish; it triggers on tags matching `v*`.
|
|
44
|
+
|
|
45
|
+
To cut a new release:
|
|
46
|
+
|
|
47
|
+
1. Land a PR that bumps `package.json` `version` and `server.json` `version` + the inner `packages[0].version` (both must match). Get it into `main`.
|
|
48
|
+
2. Pull `main` locally so your working tree matches the merged commit.
|
|
49
|
+
3. Tag and push:
|
|
50
|
+
```sh
|
|
51
|
+
git tag v0.0.4 && git push --tags
|
|
52
|
+
```
|
|
53
|
+
4. The workflow runs: installs, tests, verifies the tag matches `package.json`, then `npm publish --access public --provenance`. If anything fails, no publish happens.
|
|
54
|
+
5. Optionally: also publish to the MCP registry. `mcp-publisher login github` (if your local token expired) then `mcp-publisher publish`. There's no automated path for the MCP registry yet.
|
|
55
|
+
|
|
56
|
+
One-time setup on `npmjs.com` (already done — listed here for documentation):
|
|
57
|
+
|
|
58
|
+
- Package settings → Trusted publishers → Add → GitHub Actions
|
|
59
|
+
- Organization or user: `cdrn`
|
|
60
|
+
- Repository: `sigil`
|
|
61
|
+
- Workflow filename: `release.yml`
|
|
62
|
+
- Environment name: `release`
|
|
63
|
+
|
|
64
|
+
If that config is ever lost or rotated, every step above will fail with an OIDC auth error until it's recreated. No fallback token by design.
|
package/README.md
CHANGED
|
@@ -153,11 +153,27 @@ Key-management libraries die from supply chain compromise, not from clever attac
|
|
|
153
153
|
All by paulmillr, audited, zero transitive deps.
|
|
154
154
|
- **No MCP SDK.** The official `@modelcontextprotocol/sdk` pulls 92 transitive deps (ajv, hono, cors, cross-spawn, etc) — unacceptable surface. We implement the MCP wire protocol directly in ~200 lines.
|
|
155
155
|
- **No Bun.** Plain Node only. Bun is currently being weaponized by Mini Shai-Hulud as an evasion layer; we will not give that pattern any cover.
|
|
156
|
-
- **
|
|
157
|
-
|
|
156
|
+
- **Provenance attestations on every npm publish.** Starting v0.0.4, releases are built by [a GitHub Actions workflow](./.github/workflows/release.yml) under OIDC trusted-publisher auth, signed with a Sigstore attestation. No long-lived npm token; tampered or out-of-band publishes fail signature verification.
|
|
157
|
+
- **Still planned for v0.1.0:**
|
|
158
158
|
- SBOM (CycloneDX) attached to every release
|
|
159
159
|
- Signed standalone binaries from GitHub Releases for users who'd rather not touch npm
|
|
160
160
|
- Action SHA pinning rotation via Dependabot
|
|
161
|
+
- CI guard that fails the build if any dep in the resolved tree declares `postinstall` / `preinstall` / `prepare`
|
|
162
|
+
|
|
163
|
+
## Verifying a release
|
|
164
|
+
|
|
165
|
+
You can confirm a `sigild` tarball was built by the public workflow at the commit it claims to come from:
|
|
166
|
+
|
|
167
|
+
```sh
|
|
168
|
+
# Validates every package in your install tree:
|
|
169
|
+
npm audit signatures
|
|
170
|
+
|
|
171
|
+
# Inspect the attestation for a specific sigild version:
|
|
172
|
+
npm view sigild@<version> dist.attestations
|
|
173
|
+
# → shows the workflow filename, the commit SHA, and the Sigstore signing cert
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
What the attestation tells you: this tarball was built by `cdrn/sigil`'s `.github/workflows/release.yml`, at a specific commit on `main`, at a specific time. It does *not* tell you that commit is non-malicious — for that, read the diff between the version you trust and the version you're upgrading to. But it does mean an attacker who steals an npm token can't publish a malicious `sigild` under our name; they'd need to compromise the GitHub repo + push a tag, which leaves an audit trail.
|
|
161
177
|
|
|
162
178
|
## Threat model
|
|
163
179
|
|
package/package.json
CHANGED