Repository navigation
Releases
canship 0.8.2
Added
injection/path: reports file reads, writes and deletes whose path is built from request input (fs,fs/promises,fs-extra, Expressres.sendFile/res.downloadwithoutroot). A whole path taken directly from the request iscertain; joined or checked paths arelikely. Values reduced withpath.basenameare not reported.- Credential formats: GitLab, Shopify, Linear, Notion, DigitalOcean, Sentry, PlanetScale, Doppler, Fly.io, Postman, Heroku, and webhook signing secrets (
whsec_). These values are also masked in reports.
Fixed
- Router mounts: nested cross-file mounts carry outer middleware and URL prefixes. Mounts registered only in test or example files no longer affect production routes.
- Server requests:
ssrf/request-urlaccepts an exit before the request when the parsed URL'sorigin,hostorhostnamemust match a literal value or literal list. - Shared prefixes:
sk_live_(Stripe, Clerk) andsk-(OpenAI, DeepSeek and other compatible services) are attributed from the variable name or nearby code; otherwise findings name the shared format. - Placeholders: values in form
placeholderattributes are no longer reported as credentials.
Changed
- Titles and rotation steps for
sk_live_andsk-findings may differ from 0.8.1. Rule IDs and fingerprints are unchanged; existing baselines still match. - The Action defaults to
0.8.2.
Usage
npx canship@0.8.2 .npm package · Documentation · 简体中文 · Changes since 0.8.1
Source commit: 237a98773dd4765cc63fabf77a2716553215d189.
canship 0.8.1
Fixed
- Deployment probes no longer fail with
PROBE_DNS_FAILEDwhen the configured DNS servers are unreachable, as is common with VPN or proxy network adapters. If both A and AAAA queries cannot reach a server, Canship uses the system resolver within the same 3-second limit. Negative answers do not fall back, and every resolved address must still be an ordinary public address.
Changed
- Deployment probes have been verified against a live GitHub Pages target: HEAD, OPTIONS, canary match and mismatch, expected-denial review, and an unfollowed redirect.
- The Action defaults to
0.8.1.
Usage
npx canship@0.8.1 .npm package · Documentation · 简体中文 · Changes since 0.8.0
Source commit: 25d115c41e1a9a9455d19f448fc2265d87843b74.
canship 0.8.0
Added
Route coverage
- Hono
OpenAPIHono.openapi()handlers,openapiRoutes()batches, and route configurations imported from other modules. Unresolved batch entries mark coverage incomplete instead of being skipped silently. - Project router factories (
const app = makeApp()) for Express, Hono and Fastify, including single-targettsconfig/jsconfigpathsand explicitly linked workspace packages.
Baselines and comparison
- Baseline v4 with optional acceptance reasons and UTC expiry.
--baseline-review,--baseline-pruneand--baseline-acceptprint reviewed candidates without changing the source file;--baseline-migrateupgrades v2/v3 baselines. - Stable v3 finding identity: title, wording and line moves no longer change a finding's identity.
--compare=before.json --with=after.jsonlists added, persisting and no-longer-observed findings in the terminal, JSON or an offline HTML view. Absence is not reported as a fix.
Scanning workflow
--workspace=PATHscans explicit subprojects independently, each with its own configuration and baseline.--exclude=PATHexcludes literal paths and discloses them in every report.--explain-config,--doctorand a bundled JSON schema forcanship.config.jsonwith line/column diagnostics.--init=config|ci|ci-workspaces|pre-commitpreviews templates without writing files.--share-summaryprints counts and scope flags without paths or project text.- Interactive progress and Ctrl+C cancellation; the
scan()API acceptssignalandonProgress. --build-infoidentifies development, prerelease and release builds.
Reports
- Scoped before/after remediation examples in the terminal, HTML and fix prompts.
- HTML confidence filter, stable finding links and accessibility improvements.
Opt-in deployment probes
--probe=https://…previews an HTTPS HEAD/OPTIONS plan; requests are sent only with the matching--confirm-probedigest. Static scans remain offline.
VS Code extension (development preview)
- Bundled scanner, Problems integration, fix-prompt copy and reviewed line suppressions. Not published to the Marketplace; see the extension README to build a local VSIX.
Fixed
- Conditional middleware no longer protects routes registered outside its branch.
- Authentication middleware re-exported through a barrel module (
export * from,export { name } from) is now followed to its definition, and Hono routes that helper functions register on a sub-app mounted from another file now inherit that mount's middleware. Previously such routes were reported as unauthenticated writes atlikelyconfidence. - Consistent verdicts and follow-up commands across terminal, HTML and JSON; PowerShell-safe quoting on Windows.
- Stable
errors[].codevalues and a final output status when report writing fails.
Compatibility
- New baselines are v4. v2/v3 remain readable; older scanners reject v4 instead of ignoring expiry.
- GitHub code scanning alert identity was verified across repeated uploads, moved lines, changed wording/version and a partial fix. GitHub's own line hash also covers nearby code, so editing adjacent lines can still open a new alert.
- The Action now defaults to
0.8.0, and the README pins the Action commit that uses it.
Usage
npx canship@0.8.0 .Requires Node.js 18 or later; no runtime dependencies. Static scanning does not execute project code or make network requests. Findings describe static evidence and do not prove exploitability.
npm package · Documentation · 简体中文 · Changes since 0.7.1
Source commit: 0700a3d119573b1d13c5f5b60f4e93ab87244b35.
canship 0.8.0-rc.1
Release candidate. Published to npm under the next tag; latest remains 0.7.1. Pin the exact version when testing.
Added
Route coverage
- Hono
OpenAPIHono.openapi()handlers,openapiRoutes()batches, and route configurations imported from other modules. Unresolved batch entries mark coverage incomplete instead of being skipped silently. - Project router factories (
const app = makeApp()) for Express, Hono and Fastify, including single-targettsconfig/jsconfigpathsand explicitly linked workspace packages.
Baselines and comparison
- Baseline v4 with optional acceptance reasons and UTC expiry.
--baseline-review,--baseline-pruneand--baseline-acceptprint reviewed candidates without changing the source file;--baseline-migrateupgrades v2/v3 baselines. - Stable v3 finding identity: title, wording and line moves no longer change a finding's identity.
--compare=before.json --with=after.jsonlists added, persisting and no-longer-observed findings in the terminal, JSON or an offline HTML view. Absence is not reported as a fix.
Scanning workflow
--workspace=PATHscans explicit subprojects independently, each with its own configuration and baseline.--exclude=PATHexcludes literal paths and discloses them in every report.--explain-config,--doctorand a bundled JSON schema forcanship.config.jsonwith line/column diagnostics.--init=config|ci|ci-workspaces|pre-commitpreviews templates without writing files.--share-summaryprints counts and scope flags without paths or project text.- Interactive progress and Ctrl+C cancellation; the
scan()API acceptssignalandonProgress. --build-infoidentifies development, prerelease and release builds.
Reports
- Scoped before/after remediation examples in the terminal, HTML and fix prompts.
- HTML confidence filter, stable finding links and accessibility improvements.
Opt-in deployment probes
--probe=https://…previews an HTTPS HEAD/OPTIONS plan; requests are sent only with the matching--confirm-probedigest. Static scans remain offline.
VS Code extension (development preview)
- Bundled scanner, Problems integration, fix-prompt copy and reviewed line suppressions. Not published to the Marketplace; see the extension README to build a local VSIX.
Fixed
- Conditional middleware no longer protects routes registered outside its branch.
- Consistent verdicts and follow-up commands across terminal, HTML and JSON; PowerShell-safe quoting on Windows.
- Stable
errors[].codevalues and a final output status when report writing fails.
Compatibility
- New baselines are v4. v2/v3 remain readable; older scanners reject v4 instead of ignoring expiry.
- GitHub code scanning alert identity was verified across repeated uploads, moved lines, changed wording/version and a partial fix. GitHub's own line hash also covers nearby code, so editing adjacent lines can still open a new alert.
- The README Action pin defaults to
0.7.0; setversion: '0.8.0-rc.1'explicitly to test this candidate.
Usage
npx canship@0.8.0-rc.1 .Requires Node.js 18 or later; no runtime dependencies. Static scanning does not execute project code or make network requests. Findings describe static evidence and do not prove exploitability.
npm package · Documentation · 简体中文 · Changes since 0.7.1
Source commit: c290998ae023d55a646c757ab181302ab73cee77.
canship 0.7.1
Fixed
- Require authentication and webhook verification to execute before protected operations; preserve findings for unawaited checks and swallowed failures.
- Keep Express, Hono, and Fastify middleware evidence within its resolved route and instance scope. Uncertain middleware paths no longer suppress findings.
- Preserve request-input tracking through resolvable cross-file passthrough helpers.
Performance
- Reuse scoped Fastify plugin registrations during route analysis.
Usage
npx canship@0.7.1 .Requires Node.js 18 or later; no runtime dependencies. Scanning does not execute project code or make network requests. Static findings do not prove runtime exploitability.
For the GitHub Action, explicitly set version: '0.7.1' with the pinned wrapper in the README.
npm package · Documentation · 简体中文 · Changes since 0.7.0
Source commit: c5026d23d0e091351e0302740d2f5ff629f45535. Subsequent Action-default updates are not part of the published package.
canship 0.7.0
Added
- Express, Hono and Fastify: analyse routes, mounted routers, hooks and middleware. Writes inside called service and model functions are followed two levels.
- Authentication evidence: project session checks, composed wrappers such as
withWorkspace, and Polar, Clerk, Svix and awaited webhook signature verification are recognised as guards.
Fixed
- Keep findings when authentication, webhook verification or route coverage cannot be proven.
- Resolve likely auth helpers first; resolution limits are noted on the affected finding instead of marking the scan incomplete.
- Recognise curried auth wrappers such as
withAdmin = (handler) => async (req) => {}. - Reduce false positives found in a 20-project sweep; long expressions no longer mark scans incomplete.
Usage
npx canship@0.7.0 .npm package · Documentation · 简体中文 · Changes since 0.6.0
Source commit: 0fdb353962b09181956c4d28d0b9f89dea295075. Published to npm on 2026-10-05; this release entry was added later.
canship 0.6.0
Added
- Request-input analysis for SQL and command construction, SSRF review, and open redirects.
- Checks for server-side trust in Supabase
getSession()and unverified Stripe webhook events.
Changed
- Terminal findings are grouped by file. Use
--verbosefor excerpts, evidence, and remediation details. - Redesigned the self-contained HTML report with filtering, grouping, and copyable fix prompts.
--openopens the report in the default browser.
Fixed
- Preserve code boundaries around JSX and improve Supabase identity recognition.
- Require verification failure paths to exit; prevent uncalled closures from affecting outer input-flow analysis.
- Validate report-opener paths and symbolic links against project boundaries.
- Limit request-input analysis to handlers containing relevant calls.
Usage
npx canship@0.6.0 .Requires Node.js 18 or later; no runtime dependencies. Scanning remains local and does not execute project code. Findings are static evidence, not proof of runtime exploitability or credential validity.
For the GitHub Action, explicitly set version: '0.6.0' with the pinned wrapper in the README.
npm package · Documentation · 简体中文 · Full changelog
Source commit: e01bfaeef9d9f0c29b97d85e956ab48a927fee9e. Subsequent Action-default updates are not part of the published package.
canship 0.5.0
Added
- Bounded authentication analysis across local helpers, aliases, re-exports, and delegated calls.
- Identity provenance and argument checks for supported assignments, destructuring, getters, and Supabase
data.user. - Authentication checks across supported
if/elseandtry/catch/finallypaths, with explicit coverage gaps when limits are exceeded. - GitHub Action
honor-ignore-markersinput and expanded CLI, package, and application-snapshot tests.
Fixed
- Redact complete PEM private-key blocks in reports.
- Reject tracked files beneath linked directories and handle directory-link cycles consistently.
- Preserve JavaScript code boundaries around regex literals.
- Apply read budgets to unknown-file probes and bound directory discovery.
- Correct Firebase and PostgreSQL remediation guidance for individual operations.
- Avoid repeated full-file operation filtering in large Server Action modules.
Usage
npx canship@0.5.0 .Requires Node.js 18 or later; no runtime dependencies. Scanning remains local and does not execute project code. Authentication evidence is static and does not prove runtime or business authorization.
For the GitHub Action, explicitly set version: '0.5.0' with the pinned wrapper commit in the README.
Published through GitHub Actions trusted publishing with manual npm approval and SLSA provenance.
npm package · Documentation · 简体中文 · Full changelog
Source commit: 22c44e759002369a7dfa6f805db25d411f295f6e. Subsequent Action-default updates are not part of the published package.
canship 0.4.0
Added
- Typed ESM API:
scan(),summarize(), andlistRules(). --changed-since=REFreview view, preserving full-project scans and exit status.- Static cross-file evidence in terminal, HTML, JSON, SARIF, and fix prompts.
- Authentication checks for Next.js Server Functions and SvelteKit form actions, including supported local helper imports, aliases, re-exports, and wrappers.
- Supabase always-true RLS policy and public bucket listing checks.
- Firebase Realtime Database rule checks and additional credential formats.
Fixed
- Preserve SQL literal semantics, calibrate policy confidence, and report the current migration evidence.
- Correct Git-history, middleware, public-environment, and inline CORS handling.
- Report incomplete coverage when policy or bucket parsing limits are exceeded.
Usage
npx canship@0.4.0Requires Node.js 18 or later; no runtime dependencies. Scans remain local and do not execute project code. Static findings do not verify credential validity or deployed state.
For the GitHub Action, explicitly set version: '0.4.0' with the pinned Action commit in the README.
canship 0.3.2
Highlights
- API authentication checks now cover server routes beyond Next.js: SvelteKit (
+serverendpoints), Nuxt (server/apiandserver/routes), Remix and React Router (modules inapp/routesexportingloaderoraction), and Astro (endpoints insrc/pages). Admin clients are followed through$lib,~/, and Nuxtserver/utilsauto-imports. - An authentication check in SvelteKit
hooks.serveror Nuxtserver/middlewarelowers confidence instead of hiding the finding, because the routes it covers are decided in code.
Fixes
- Common guards are now recognised: optional-chained session checks (
if (!session?.user)), ClerkuserIdredirects, SvelteKiterror(401), NuxtcreateError({ statusCode: 401 }),requireUserId, andrequireUserSession. Previously the first two were reported as P0 admin access without authentication on Next.js routes. - A scanned file could make a scan take minutes: long whitespace after
createClient, or after a CORSorigin: functioncallback. Both are now linear.
Release
Published from GitHub Actions through npm trusted publishing with staged approval. The package carries SLSA provenance linking it to this tag; verify with npm audit signatures.
Usage
npx canship@0.3.2 .For the GitHub Action, set version: '0.3.2' explicitly.
Requires Node.js 18 or later. No runtime dependencies. Scanning does not execute project code or use the network; package installation may access npm.
Package on npm · Documentation · 简体中文
Source commit: 2ac2a7b1b5870d97cddc0951b5b70ce85c9f9102. This release identifies the source corresponding to the published npm package; subsequent Action-default changes are not included.