cleartoship 0.10.3 → 0.10.4

package/README.md

@@ -218,7 +218,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v7
-      - uses: murtazaozdemir/cleartoship@v0.10.3
+      - uses: murtazaozdemir/cleartoship@v0.10.4
         with:
           fail-on: critical
           comment: true
@@ -240,7 +240,7 @@ above `fail-on`) for use in later steps. The comment is *sticky* — re-runs edi
 the same comment instead of piling up.
 
 By default the action runs the scanner version its own ref declares, so
-`@v0.10.3` runs `cleartoship@0.10.3` and pinning the ref pins the behaviour. If
+`@v0.10.4` runs `cleartoship@0.10.4` and pinning the ref pins the behaviour. If
 that version is not on the registry, it builds from its own checkout instead, so
 `uses: …@ref` works against an unpublished commit.
 
@@ -303,6 +303,12 @@ uploaded, and no database is connected to.
   call chained to it, and stand down when the values are bound. They still fire
   when any interpolation reads from the request, so a query that binds one value
   and concatenates another is reported.
+- **The scan stays inside the directory you pointed at.** A symlink that
+  resolves outside the scan root is not followed. It sounds academic until you
+  run this in CI on a pull request: `vendor-config -> /home/runner/.ssh` would
+  otherwise be read, and quoted, into a public comment. Symlink loops are walked
+  once rather than a dozen times, and the report says how many links were
+  refused.
 - **A match in a comment is prose about code, not code.** The scanner lexes each
   file once for strings and comments — properly, tracking quotes, so a URL
   inside a string is not mistaken for the start of one — and a community rule

package/SECURITY.md

@@ -22,7 +22,7 @@ supported one; older versions are not backported.
 | **Never writes to the scanned project** | The only writes in the codebase are the report file you ask for with `--output <path>` and the registry cache. Verify: `grep -rn "writeFileSync\|mkdirSync\|rmSync\|unlink" src/ --exclude-dir=vendor` — five lines, of which two are imports and three are those call sites. Neither path is derived from the scan root. |
 | **Never executes your code** | The scanner has no `child_process`, `exec`, `spawn`, `eval`, `new Function`, or dynamic `import()` of scanned files. Your code is read as text, parsed by Babel into an AST, and matched against regexes. Verify: `grep -rn "child_process\|execSync\|spawn\|eval(\|new Function" src/ --exclude-dir=vendor` — one hit, and it is a *pattern string* in the rule that detects those calls in **your** install hooks. (Drop `--exclude-dir=vendor` and the extra hits are rule text in the vendored ruleset, matched against your code, never run.) |
 | **Never connects to your database** | The Row Level Security scanner replays your `.sql` migration files to model the resulting schema. There is no database driver in the dependency tree and no connection string is ever read. |
-| **Reads only what it scans** | Files are gathered by walking the scan root, skipping `node_modules`, build output, virtualenvs and anything your own `.gitignore` excludes. Ignore rules are read from the scan root downwards only — never from a parent directory — so nothing outside the root is read except the cache directory. |
+| **Reads only what it scans** | Files are gathered by walking the scan root, skipping `node_modules`, build output, virtualenvs and anything your own `.gitignore` excludes. Ignore rules are read from the scan root downwards only — never from a parent directory. **A symlink that resolves outside the root is not followed**, so a repository cannot make the scanner read `~/.ssh` and quote it back into a report; the count of refused links appears in the output. Nothing outside the root is read except the cache directory. |
 
 ## What leaves your machine
 
@@ -65,6 +65,9 @@ are visible in the diff and cannot change under you between releases:
   categories no static scanner can reach.
 - **Not a sandbox.** It reads whatever you point it at. Pointing it at a
   repository you do not trust is as safe as opening that repository in an
-  editor — no more, and no less.
+  editor — no more, and no less. What it will not do is read *beyond* what you
+  pointed it at: symlinks out of the tree are refused, and a malformed pattern
+  in the repository's own `.gitignore` is skipped rather than allowed to end
+  the scan.
 - **Not a secret scanner of record.** Secrets already committed to git history
   are out of scope; ClearToShip reads the working tree, not past commits.

package/action.yml

@@ -29,7 +29,7 @@ inputs:
   version:
     description: >-
       Version of the cleartoship npm package to run. Defaults to the version this
-      action's own ref declares, so `uses: …@v0.10.3` runs cleartoship@0.10.3. Set
+      action's own ref declares, so `uses: …@v0.10.4` runs cleartoship@0.10.4. Set
       `latest` to always track the newest release, or `local` to build from the checkout.
     required: false
     default: ''
@@ -76,7 +76,7 @@ runs:
       run: |
         # With no version pinned, run the exact version this action's checkout
         # declares. That keeps the action ref and the scanner in lockstep:
-        # `uses: <owner>/cleartoship@v0.10.3` runs cleartoship@0.10.3 instead of
+        # `uses: <owner>/cleartoship@v0.10.4` runs cleartoship@0.10.4 instead of
         # whatever npm happens to tag `latest` at the time.
         ver="$INPUT_VERSION"
         if [ -z "$ver" ]; then

package/dist/report.js

@@ -118,6 +118,7 @@ export function renderJson(scan) {
         framework: scan.framework,
         fileCount: scan.fileCount,
         gitIgnoredCount: scan.gitIgnoredCount,
+        escapingSymlinkCount: scan.escapingSymlinkCount,
         durationMs: scan.durationMs,
         verdict: scan.counts.critical > 0 ? 'hold' : scan.counts.high > 0 ? 'conditional' : 'clear',
         counts: scan.counts,

package/dist/scan.d.ts

@@ -19,6 +19,8 @@ export interface FullScan {
     fileCount: number;
     /** Paths left unscanned because the repository's own ignore rules exclude them. */
     gitIgnoredCount: number;
+    /** Symlinks that pointed outside the scan root and were not followed. */
+    escapingSymlinkCount: number;
     findings: Finding[];
     checks: CheckSummary[];
     warnings: string[];

package/dist/scan.js

@@ -13,6 +13,7 @@ export async function scan(options) {
     const walked = roots.map((r) => walk(r, { respectGitignore: !options.noGitignore }));
     const files = [...new Set(walked.flatMap((w) => w.files))];
     const gitIgnoredCount = walked.reduce((n, w) => n + w.gitIgnored, 0);
+    const escapingSymlinkCount = walked.reduce((n, w) => n + w.escapingSymlinks, 0);
     const framework = detectFramework(root, files);
     const ctx = {
         root,
@@ -76,6 +77,14 @@ export async function scan(options) {
                 'checkout. Use --no-gitignore to scan them anyway.',
         });
     }
+    if (escapingSymlinkCount > 0) {
+        checks.push({
+            label: `Symlinks leaving the scan root not followed (${escapingSymlinkCount})`,
+            passed: true,
+            note: 'they point outside the directory you asked about, so their contents are not ' +
+                'this project and are never read or quoted in this report',
+        });
+    }
     const counts = { critical: 0, high: 0, medium: 0, low: 0, info: 0 };
     for (const f of filtered)
         counts[f.severity]++;
@@ -84,6 +93,7 @@ export async function scan(options) {
         framework: framework.describe(),
         fileCount: files.length,
         gitIgnoredCount,
+        escapingSymlinkCount,
         findings: filtered,
         checks,
         warnings,

package/dist/utils/files.d.ts

@@ -2,6 +2,8 @@ export interface WalkResult {
     files: string[];
     /** How many paths were left out because the repository ignores them. */
     gitIgnored: number;
+    /** How many symlinks pointed outside the scan root and were not followed. */
+    escapingSymlinks: number;
 }
 export declare function walk(root: string, options?: {
     respectGitignore?: boolean;

package/dist/utils/files.js

@@ -1,4 +1,4 @@
-import { readdirSync, statSync, readFileSync, existsSync } from 'node:fs';
+import { readdirSync, statSync, readFileSync, existsSync, realpathSync } from 'node:fs';
 import { join, relative, sep } from 'node:path';
 import { Gitignore, extendedAt, repositoryExcludes } from './gitignore.js';
 const SKIP_DIRS = new Set([
@@ -63,6 +63,25 @@ export function walk(root, options = {}) {
         ? extendedAt(repositoryExcludes(root, read), root, read)
         : Gitignore.empty();
     const stack = [{ dir: root, rules: rootRules }];
+    // A symlinked directory that points back into the tree — `self -> .`, or the
+    // A→B→A pair a workspace layout can produce — otherwise gets walked again on
+    // every pass, reporting the same file at a dozen different paths. Resolving
+    // each directory once and remembering it costs one syscall per directory.
+    const visited = new Set();
+    let escapingSymlinks = 0;
+    // A symlink that leaves the tree is not part of the project, and following one
+    // would be worse than useless: `vendor-config -> /home/runner/.ssh` makes the
+    // scanner read that directory and quote what it finds — into a pull-request
+    // comment, in the Action. So the scan stays inside what it was pointed at.
+    let rootReal;
+    try {
+        rootReal = realpathSync(root);
+    }
+    catch {
+        rootReal = root;
+    }
+    visited.add(rootReal);
+    const insideRoot = (real) => real === rootReal || real.startsWith(rootReal.endsWith('/') ? rootReal : rootReal + '/');
     while (stack.length) {
         const { dir, rules } = stack.pop();
         let entries;
@@ -81,9 +100,23 @@ export function walk(root, options = {}) {
             catch {
                 continue;
             }
+            let real;
+            try {
+                real = realpathSync(full);
+            }
+            catch {
+                continue;
+            }
+            if (!insideRoot(real)) {
+                escapingSymlinks++;
+                continue;
+            }
             if (st.isDirectory()) {
                 if (SKIP_DIRS.has(entry))
                     continue;
+                if (visited.has(real))
+                    continue;
+                visited.add(real);
                 // git never descends into an ignored directory, and neither do we —
                 // which is also where most of the saving comes from.
                 if (respect && rules.ignores(full, true)) {
@@ -113,7 +146,7 @@ export function walk(root, options = {}) {
             }
         }
     }
-    return { files: found.sort(), gitIgnored };
+    return { files: found.sort(), gitIgnored, escapingSymlinks };
 }
 export function read(file) {
     try {

package/examples/security.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v7
-      - uses: murtazaozdemir/cleartoship@v0.10.3
+      - uses: murtazaozdemir/cleartoship@v0.10.4
         with:
           fail-on: critical   # block the PR only on criticals
           comment: true        # post a summary comment on the PR

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cleartoship",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "The 30-second pre-launch security clearance for AI-built & vibe-coded apps. Catches missing Server Action auth, Supabase RLS holes, hallucinated npm packages and leaked keys.",
   "keywords": [
     "security",