pqcheck 0.13.0 → 0.13.2
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/README.md +6 -11
- package/bin/pqcheck.js +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ Wire Cipherwake into your CI so every PR gets a Trust Diff comment when your dom
|
|
|
22
22
|
npx pqcheck onboard cipherwake.io
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
That runs in sequence: scan your domain → write the GitHub Action workflow → capture a vendor lockfile → generate a release checklist →
|
|
25
|
+
That runs in sequence: scan your domain → write the GitHub Action workflow → capture a vendor lockfile → generate a release checklist → commit + push. **No API key, no repo secret.** The scaffolded workflow uses GitHub Actions OIDC (`id-token: write`) to authenticate to Cipherwake — Free includes 100 Trust Diff calls/month per repo, no setup required.
|
|
26
26
|
|
|
27
27
|
**Or step-by-step if you prefer:**
|
|
28
28
|
|
|
@@ -30,20 +30,15 @@ That runs in sequence: scan your domain → write the GitHub Action workflow →
|
|
|
30
30
|
# 1. Scaffold a GitHub Actions workflow (interactive prompts)
|
|
31
31
|
npx pqcheck init
|
|
32
32
|
|
|
33
|
-
# 2.
|
|
34
|
-
# (Free tier: 30 Trust Diff calls/month)
|
|
35
|
-
|
|
36
|
-
# 3. Add the key as a repo secret:
|
|
37
|
-
# GitHub → Settings → Secrets → Actions → New secret
|
|
38
|
-
# Name: CIPHERWAKE_API_KEY Value: qpk_...
|
|
39
|
-
|
|
40
|
-
# 4. Commit + push
|
|
33
|
+
# 2. Commit + push
|
|
41
34
|
git add .github/workflows/cipherwake.yml
|
|
42
35
|
git commit -m "ci: add Cipherwake Trust Diff gate"
|
|
43
36
|
git push
|
|
44
37
|
```
|
|
45
38
|
|
|
46
|
-
That's it. Open a PR and Cipherwake comments inline when cert / SPKI / HSTS / CSP / DMARC / vendor scripts drift since your baseline.
|
|
39
|
+
That's it. The scaffolded workflow includes `permissions: id-token: write`, so the runner mints a signed OIDC token on each run and Cipherwake meters per repo — no secret to manage. Open a PR and Cipherwake comments inline when cert / SPKI / HSTS / CSP / DMARC / vendor scripts drift since your baseline.
|
|
40
|
+
|
|
41
|
+
**Need higher limits?** Paid tiers (Starter $29/mo · Growth $79/mo · Scale $199/mo) lift the per-repo quota to 1,000 / 10,000 / 50,000 calls/month. Generate an API key at [/account#api-keys](https://cipherwake.io/account#api-keys), then add it as the repo secret `CIPHERWAKE_API_KEY`. The Action uses the secret when present and falls back to OIDC when not — no code change needed to upgrade.
|
|
47
42
|
|
|
48
43
|
**Want more?**
|
|
49
44
|
- Pre-commit hook: `npx pqcheck deploy-check <domain>` before every deploy
|
|
@@ -54,7 +49,7 @@ That's it. Open a PR and Cipherwake comments inline when cert / SPKI / HSTS / CS
|
|
|
54
49
|
|
|
55
50
|
## What's new in 0.12.0
|
|
56
51
|
|
|
57
|
-
**Developer habit-loop bundle (locked 2026-05-16).** Five new subcommands that put Cipherwake where developers already work: PRs, CI, release notes, vendor allowlists. Free tier covers all of them within the
|
|
52
|
+
**Developer habit-loop bundle (locked 2026-05-16).** Five new subcommands that put Cipherwake where developers already work: PRs, CI, release notes, vendor allowlists. Free tier covers all of them within the 100 Trust Diff calls/month per repo quota.
|
|
58
53
|
|
|
59
54
|
- `pqcheck init` — interactive scaffold for `.github/workflows/cipherwake.yml`. Prompts for domain, fail-on severity, baseline. No copy-paste from docs required.
|
|
60
55
|
- `pqcheck deploy-check <domain>` — pre-deploy Trust Diff gate with deploy-friendly framing. Uses last-scan as default baseline. Same exit semantics as `trust-diff`.
|
package/bin/pqcheck.js
CHANGED
|
@@ -2665,7 +2665,7 @@ async function runInitCommand(args) {
|
|
|
2665
2665
|
console.log(` ${color("bold", "Next steps:")}`);
|
|
2666
2666
|
console.log("");
|
|
2667
2667
|
console.log(` ${color("dim", "1.")} Generate a Cipherwake API key at ${color("violet", "https://cipherwake.io/account#api-keys")}`);
|
|
2668
|
-
console.log(` ${color("dim", "Free tier:
|
|
2668
|
+
console.log(` ${color("dim", "Free tier: 100 Trust Diff calls/month per repo")}`);
|
|
2669
2669
|
console.log("");
|
|
2670
2670
|
console.log(` ${color("dim", "2.")} Add it as a repo secret:`);
|
|
2671
2671
|
console.log(` ${color("dim", "Settings → Secrets and variables → Actions → New repository secret")}`);
|
|
@@ -2701,7 +2701,7 @@ function renderTrustDiffWorkflow({ domain, failOn, baseline }) {
|
|
|
2701
2701
|
# posture regresses vs the baseline (cert / SPKI / vendor scripts / HSTS / CSP /
|
|
2702
2702
|
# DMARC / HNDL).
|
|
2703
2703
|
#
|
|
2704
|
-
# Free tier:
|
|
2704
|
+
# Free tier: 100 Trust Diff calls/month per repo (OIDC-metered).
|
|
2705
2705
|
# Methodology: https://cipherwake.io/methodology/
|
|
2706
2706
|
# Action source: https://github.com/cipherwakelabs/pqcheck
|
|
2707
2707
|
|
|
@@ -2715,7 +2715,7 @@ on:
|
|
|
2715
2715
|
|
|
2716
2716
|
permissions:
|
|
2717
2717
|
contents: read
|
|
2718
|
-
id-token: write # required for OIDC-based metering (Free=
|
|
2718
|
+
id-token: write # required for OIDC-based metering (Free=100 calls/repo/mo, no API key needed)
|
|
2719
2719
|
security-events: write # required for SARIF upload to Code Scanning
|
|
2720
2720
|
pull-requests: write # required for sticky PR comment (Action v3.1+)
|
|
2721
2721
|
|
|
@@ -2762,7 +2762,7 @@ async function prompt(question) {
|
|
|
2762
2762
|
// pre-build, Netlify build commands, custom CD scripts)
|
|
2763
2763
|
//
|
|
2764
2764
|
// Exit codes match trust-diff: 0 pass · 1 warn · 2 fail · 3 error.
|
|
2765
|
-
// Consumes the same Free
|
|
2765
|
+
// Consumes the same Free 100 Trust Diff calls/month per repo quota.
|
|
2766
2766
|
// =============================================================================
|
|
2767
2767
|
|
|
2768
2768
|
async function runDeployCheckCommand(args) {
|
|
@@ -3310,7 +3310,7 @@ async function runOnboardCommand(args) {
|
|
|
3310
3310
|
// to paste the key as a GitHub repo secret. With Action v3.2 + OIDC repo
|
|
3311
3311
|
// metering, the scaffolded workflow has `permissions: { id-token: write }`
|
|
3312
3312
|
// and the action fetches a GitHub-signed token automatically — no key, no
|
|
3313
|
-
// secret, no browser hop. Free tier is
|
|
3313
|
+
// secret, no browser hop. Free tier is 100 calls/repo/mo, enforced server-
|
|
3314
3314
|
// side via the `meter_gh_action_call` RPC against `gh_action_repo_quota`.
|
|
3315
3315
|
// For higher limits, the user links this repo to a paid account at /account
|
|
3316
3316
|
// (one-time OAuth) — still no API key in CI.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pqcheck",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.2",
|
|
4
4
|
"description": "HTTPS posture scanner with Trust Diff for CI, vendor lockfile + drift alerts, cross-tenant key map, and HNDL/quantum-decryption risk scoring. Free, no signup.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"post-quantum",
|