@coo-quack/sensitive-canary 0.7.0 → 0.8.1

package/src/__tests__/user-prompt-submit-hook.test.ts

@@ -1,297 +0,0 @@
-import { spawnSync } from "node:child_process";
-import { describe, expect, it } from "vitest";
-
-const HOOK = new URL("../user-prompt-submit-hook.ts", import.meta.url).pathname;
-const NODE_FLAGS = ["--experimental-strip-types"];
-
-function runHook(prompt: string, opts?: { env?: Record<string, string> }) {
-  const result = spawnSync("node", [...NODE_FLAGS, HOOK], {
-    input: JSON.stringify({ prompt }),
-    encoding: "utf8",
-    env: { ...process.env, ...opts?.env },
-  });
-  return {
-    exitCode: result.status ?? -1,
-    stdout: result.stdout,
-    stderr: result.stderr,
-  };
-}
-
-describe("user-prompt-submit-hook — allow (exit 0)", () => {
-  it("passes a clean prompt", () => {
-    const { exitCode } = runHook("hello, can you help me?");
-    expect(exitCode).toBe(0);
-  });
-
-  it("passes an empty prompt", () => {
-    const { exitCode } = runHook("");
-    expect(exitCode).toBe(0);
-  });
-
-  it("passes with [allow-all] tag even if secret is present", () => {
-    const { exitCode } = runHook("[allow-all] my key is AKIAIOSFODNN7EXAMPLE");
-    expect(exitCode).toBe(0);
-  });
-
-  it("passes with [allow-secret] tag when only secrets are present", () => {
-    const { exitCode } = runHook(
-      "[allow-secret] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(0);
-  });
-
-  it("passes with [allow-pii] tag when only PII is present", () => {
-    const { exitCode } = runHook("[allow-pii] please email user@example.com");
-    expect(exitCode).toBe(0);
-  });
-});
-
-describe("user-prompt-submit-hook — block (exit 2)", () => {
-  it("blocks a prompt with an AWS access key", () => {
-    const { exitCode, stderr } = runHook("my key is AKIAIOSFODNN7EXAMPLE");
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("aws-access-key");
-    expect(stderr).toContain("blocked");
-  });
-
-  it("blocks a prompt with a JWT", () => {
-    const jwt =
-      "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
-    const { exitCode, stderr } = runHook(`token: ${jwt}`);
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("jwt");
-  });
-
-  it("blocks a prompt with an email address", () => {
-    const { exitCode, stderr } = runHook("please email user@example.com");
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("pii-email");
-  });
-
-  it("blocks a prompt with a credit card number", () => {
-    const { exitCode, stderr } = runHook("card: 4111111111111111");
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("pii-credit-card");
-  });
-
-  it("shows [allow-secret] and [allow-all] hints for a secret", () => {
-    const { stderr } = runHook("key=AKIAIOSFODNN7EXAMPLE");
-    expect(stderr).toContain("[allow-secret]");
-    expect(stderr).toContain("[allow-all]");
-  });
-
-  it("shows [allow-pii] and [allow-all] hints for PII", () => {
-    const { stderr } = runHook("email: user@example.com");
-    expect(stderr).toContain("[allow-pii]");
-    expect(stderr).toContain("[allow-all]");
-  });
-
-  it("shows both [allow-secret] and [allow-pii] hints when both are detected", () => {
-    const { stderr } = runHook(
-      "key=AKIAIOSFODNN7EXAMPLE and email user@example.com",
-    );
-    expect(stderr).toContain("[allow-secret]");
-    expect(stderr).toContain("[allow-pii]");
-    expect(stderr).toContain("[allow-all]");
-  });
-
-  it("deduplicates the same secret appearing multiple times", () => {
-    const { stderr } = runHook("A=AKIAIOSFODNN7EXAMPLE B=AKIAIOSFODNN7EXAMPLE");
-    // aws-access-key finding should appear only once in the output
-    const count = (stderr ?? "").split("aws-access-key").length - 1;
-    expect(count).toBe(1);
-  });
-
-  it("[allow-pii] does not bypass a secret block", () => {
-    const { exitCode } = runHook("[allow-pii] my key is AKIAIOSFODNN7EXAMPLE");
-    expect(exitCode).toBe(2);
-  });
-
-  it("[allow-secret] does not bypass a PII block", () => {
-    const { exitCode } = runHook(
-      "[allow-secret] please email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-  });
-
-  it("[allow-secret] with mixed content still blocks PII", () => {
-    const { exitCode } = runHook(
-      "[allow-secret] key=AKIAIOSFODNN7EXAMPLE and email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-  });
-});
-
-describe("user-prompt-submit-hook — [mask-xxx] tags", () => {
-  it("[mask-secret] with secret shows the actual tag in message", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-secret] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-    expect(stderr).toContain("[mask-secret]");
-    expect(stderr).toContain("[allow-secret]");
-  });
-
-  it("[mask-pii] with PII shows the actual tag in message", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-pii] please email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-    expect(stderr).toContain("[mask-pii]");
-    expect(stderr).toContain("[allow-pii]");
-  });
-
-  it("[mask-all] with any sensitive data shows masking not supported", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-all] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-    expect(stderr).toContain("[mask-all]");
-  });
-
-  it("[mask-secret] with only PII falls through to normal block", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-secret] please email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).not.toContain("prompt masking is not supported");
-    expect(stderr).toContain("sensitive data detected");
-  });
-
-  it("[mask-pii] with only secrets falls through to normal block", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-pii] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).not.toContain("prompt masking is not supported");
-    expect(stderr).toContain("sensitive data detected");
-  });
-
-  it("[mask-secret] with clean prompt passes through", () => {
-    const { exitCode } = runHook("[mask-secret] hello, can you help me?");
-    expect(exitCode).toBe(0);
-  });
-
-  it("[mask-unknown] with sensitive data falls through to normal block", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-unknown] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).not.toContain("prompt masking is not supported");
-    expect(stderr).toContain("sensitive data detected");
-  });
-});
-
-describe("user-prompt-submit-hook — first-occurrence tag priority", () => {
-  it("[allow-secret] before [mask-secret] → passes through (exit 0)", () => {
-    const { exitCode } = runHook(
-      "[allow-secret] [mask-secret] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(0);
-  });
-
-  it("[mask-secret] before [allow-secret] → shows masking not supported (exit 2)", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-secret] [allow-secret] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-  });
-
-  it("[allow-all] before [mask-secret] → passes through (exit 0)", () => {
-    const { exitCode } = runHook(
-      "[allow-all] [mask-secret] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(0);
-  });
-
-  it("[mask-all] before [allow-secret] → shows masking not supported (exit 2)", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-all] [allow-secret] my key is AKIAIOSFODNN7EXAMPLE",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-  });
-
-  it("[allow-secret] [mask-pii] → secret allowed, pii masked → masking not supported (exit 2)", () => {
-    const { exitCode, stderr } = runHook(
-      "[allow-secret] [mask-pii] key AKIAIOSFODNN7EXAMPLE email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-    expect(stderr).toContain("[mask-pii]");
-    expect(stderr).not.toContain("[mask-secret]");
-  });
-
-  it("[mask-pii] [allow-secret] → secret: allow, pii: mask → masking not supported for email (exit 2)", () => {
-    const { exitCode, stderr } = runHook(
-      "[mask-pii] [allow-secret] key AKIAIOSFODNN7EXAMPLE email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("prompt masking is not supported");
-    expect(stderr).toContain("[mask-pii]");
-  });
-
-  it("[allow-pii] before [mask-pii] → pii allowed, secret still blocked (exit 2)", () => {
-    const { exitCode, stderr } = runHook(
-      "[allow-pii] [mask-pii] key AKIAIOSFODNN7EXAMPLE email user@example.com",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("sensitive data detected");
-    expect(stderr).not.toContain("prompt masking is not supported");
-  });
-});
-
-describe("user-prompt-submit-hook — malformed input", () => {
-  it("exits 0 on invalid JSON", () => {
-    const result = spawnSync("node", [...NODE_FLAGS, HOOK], {
-      input: "not json",
-      encoding: "utf8",
-    });
-    expect(result.status).toBe(0);
-  });
-});
-
-describe("user-prompt-submit-hook — SENSITIVE_CANARY_CATEGORIES", () => {
-  it("pii-only: passes a prompt containing only secrets", () => {
-    const { exitCode } = runHook("my key is AKIAIOSFODNN7EXAMPLE", {
-      env: { SENSITIVE_CANARY_CATEGORIES: "pii" },
-    });
-    expect(exitCode).toBe(0);
-  });
-
-  it("pii-only: still blocks a prompt containing PII", () => {
-    const { exitCode, stderr } = runHook("my card is 4111111111111111", {
-      env: { SENSITIVE_CANARY_CATEGORIES: "pii" },
-    });
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("sensitive data detected");
-  });
-
-  it("secret-only: passes a prompt containing only PII", () => {
-    const { exitCode } = runHook("my card is 4111111111111111", {
-      env: { SENSITIVE_CANARY_CATEGORIES: "secret" },
-    });
-    expect(exitCode).toBe(0);
-  });
-
-  it("secret-only: still blocks a prompt containing secrets", () => {
-    const { exitCode, stderr } = runHook("my key is AKIAIOSFODNN7EXAMPLE", {
-      env: { SENSITIVE_CANARY_CATEGORIES: "secret" },
-    });
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("sensitive data detected");
-  });
-
-  it("unset: blocks both secrets and PII (default behavior)", () => {
-    const { exitCode, stderr } = runHook(
-      "key AKIAIOSFODNN7EXAMPLE card 4111111111111111",
-    );
-    expect(exitCode).toBe(2);
-    expect(stderr).toContain("aws-access-key");
-    expect(stderr).toContain("pii-credit-card");
-  });
-});

package/src/lib/__tests__/inspector.test.ts

@@ -1,289 +0,0 @@
-import { describe, expect, it } from "vitest";
-import type { Finding } from "../inspector.ts";
-import {
-  applyAllowTags,
-  dedupeFindings,
-  findingsToLines,
-  parseAllowTags,
-  resolveTagPriority,
-} from "../inspector.ts";
-
-// ── parseAllowTags ────────────────────────────────────────────────────────────
-
-describe("parseAllowTags", () => {
-  it("returns empty set when no tags are present", () => {
-    const tags = parseAllowTags([{ role: "user", content: "hello" }]);
-    expect(tags.size).toBe(0);
-  });
-
-  it("parses [allow-all]", () => {
-    const tags = parseAllowTags([
-      { role: "user", content: "[allow-all] send anyway" },
-    ]);
-    expect(tags.has("all")).toBe(true);
-  });
-
-  it("parses [allow-pii]", () => {
-    const tags = parseAllowTags([{ role: "user", content: "[allow-pii] ok" }]);
-    expect(tags.has("pii")).toBe(true);
-  });
-
-  it("parses [allow-secret]", () => {
-    const tags = parseAllowTags([
-      { role: "user", content: "[allow-secret] here is my key" },
-    ]);
-    expect(tags.has("secret")).toBe(true);
-  });
-
-  it("is case-insensitive", () => {
-    const tags = parseAllowTags([{ role: "user", content: "[Allow-Secret]" }]);
-    expect(tags.has("secret")).toBe(true);
-  });
-
-  it("ignores tags in assistant messages", () => {
-    const tags = parseAllowTags([
-      { role: "assistant", content: "[allow-all] this is the assistant" },
-    ]);
-    expect(tags.size).toBe(0);
-  });
-
-  it("parses tags from ContentBlock[] content", () => {
-    const tags = parseAllowTags([
-      {
-        role: "user",
-        content: [{ type: "text", text: "[allow-secret] check this" }],
-      },
-    ]);
-    expect(tags.has("secret")).toBe(true);
-  });
-});
-
-// ── resolveTagPriority ────────────────────────────────────────────────────────
-
-describe("resolveTagPriority", () => {
-  it("returns empty sets when no tags are present", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority("hello world");
-    expect(effectiveAllow.size).toBe(0);
-    expect(effectiveMask.size).toBe(0);
-  });
-
-  it("[allow-secret] → effectiveAllow has 'secret'", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[allow-secret] key=abc",
-    );
-    expect(effectiveAllow.has("secret")).toBe(true);
-    expect(effectiveMask.has("secret")).toBe(false);
-  });
-
-  it("[mask-secret] → effectiveMask has 'secret'", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[mask-secret] key=abc",
-    );
-    expect(effectiveMask.has("secret")).toBe(true);
-    expect(effectiveAllow.has("secret")).toBe(false);
-  });
-
-  it("[allow-secret] before [mask-secret] → allow wins for secret", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[allow-secret] [mask-secret] key=abc",
-    );
-    expect(effectiveAllow.has("secret")).toBe(true);
-    expect(effectiveMask.has("secret")).toBe(false);
-  });
-
-  it("[mask-secret] before [allow-secret] → mask wins for secret", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[mask-secret] [allow-secret] key=abc",
-    );
-    expect(effectiveMask.has("secret")).toBe(true);
-    expect(effectiveAllow.has("secret")).toBe(false);
-  });
-
-  it("[allow-all] before [mask-secret] → allow wins for both dimensions", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[allow-all] [mask-secret] key=abc",
-    );
-    expect(effectiveAllow.has("secret")).toBe(true);
-    expect(effectiveAllow.has("pii")).toBe(true);
-    expect(effectiveMask.size).toBe(0);
-  });
-
-  it("[mask-all] before [allow-secret] → mask wins for both dimensions", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[mask-all] [allow-secret] key=abc",
-    );
-    expect(effectiveMask.has("secret")).toBe(true);
-    expect(effectiveMask.has("pii")).toBe(true);
-    expect(effectiveMask.has("all")).toBe(true);
-    expect(effectiveAllow.size).toBe(0);
-  });
-
-  it("[allow-secret] [mask-pii] → allow for secret, mask for pii", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[allow-secret] [mask-pii] ...",
-    );
-    expect(effectiveAllow.has("secret")).toBe(true);
-    expect(effectiveMask.has("pii")).toBe(true);
-    expect(effectiveAllow.has("pii")).toBe(false);
-    expect(effectiveMask.has("secret")).toBe(false);
-  });
-
-  it("[allow-all] → effectiveAllow has 'all'", () => {
-    const { effectiveAllow } = resolveTagPriority("[allow-all] key=abc");
-    expect(effectiveAllow.has("all")).toBe(true);
-  });
-
-  it("[mask-all] → effectiveMask has 'all'", () => {
-    const { effectiveMask } = resolveTagPriority("[mask-all] key=abc");
-    expect(effectiveMask.has("all")).toBe(true);
-  });
-
-  it("is case-insensitive", () => {
-    const { effectiveAllow } = resolveTagPriority("[Allow-Secret] key=abc");
-    expect(effectiveAllow.has("secret")).toBe(true);
-  });
-
-  it("unknown tag suffix is ignored", () => {
-    const { effectiveAllow, effectiveMask } = resolveTagPriority(
-      "[allow-unknown] key=abc",
-    );
-    expect(effectiveAllow.size).toBe(0);
-    expect(effectiveMask.size).toBe(0);
-  });
-});
-
-// ── applyAllowTags ────────────────────────────────────────────────────────────
-
-describe("applyAllowTags", () => {
-  const findings: Finding[] = [
-    {
-      ruleId: "aws-access-key",
-      description: "AWS",
-      category: "secret",
-      matchRedacted: "AKIA****",
-      secretValue: "AKIATEST",
-      score: 1,
-    },
-    {
-      ruleId: "pii-email",
-      description: "Email",
-      category: "pii",
-      matchRedacted: "user****",
-      secretValue: "user@example.com",
-      score: 1,
-    },
-  ];
-
-  it("returns all findings when allow set is empty", () => {
-    expect(applyAllowTags(findings, new Set())).toHaveLength(2);
-  });
-
-  it("returns empty array when findings is empty", () => {
-    expect(applyAllowTags([], new Set(["all"]))).toHaveLength(0);
-  });
-
-  it("[allow-all] removes all findings", () => {
-    expect(applyAllowTags(findings, new Set(["all"]))).toHaveLength(0);
-  });
-
-  it("[allow-secret] removes only secret findings", () => {
-    const result = applyAllowTags(findings, new Set(["secret"]));
-    expect(result).toHaveLength(1);
-    expect(result[0]?.ruleId).toBe("pii-email");
-  });
-
-  it("[allow-pii] removes only PII findings", () => {
-    const result = applyAllowTags(findings, new Set(["pii"]));
-    expect(result).toHaveLength(1);
-    expect(result[0]?.ruleId).toBe("aws-access-key");
-  });
-
-  it("an unknown tag has no effect", () => {
-    const result = applyAllowTags(findings, new Set(["aws-access-key"]));
-    expect(result).toHaveLength(2);
-  });
-});
-
-// ── dedupeFindings ────────────────────────────────────────────────────────────
-
-describe("dedupeFindings", () => {
-  it("removes duplicate findings with the same secretValue", () => {
-    const findings: Finding[] = [
-      {
-        ruleId: "aws-access-key",
-        description: "AWS",
-        category: "secret",
-        matchRedacted: "AKIA****",
-        secretValue: "AKIATEST",
-        score: 1,
-      },
-      {
-        ruleId: "aws-access-key",
-        description: "AWS",
-        category: "secret",
-        matchRedacted: "AKIA****",
-        secretValue: "AKIATEST",
-        score: 1,
-      },
-    ];
-    expect(dedupeFindings(findings)).toHaveLength(1);
-  });
-
-  it("keeps findings with different secretValues", () => {
-    const findings: Finding[] = [
-      {
-        ruleId: "aws-access-key",
-        description: "AWS",
-        category: "secret",
-        matchRedacted: "AKIA****",
-        secretValue: "AKIATEST1",
-        score: 1,
-      },
-      {
-        ruleId: "aws-access-key",
-        description: "AWS",
-        category: "secret",
-        matchRedacted: "AKIA****",
-        secretValue: "AKIATEST2",
-        score: 1,
-      },
-    ];
-    expect(dedupeFindings(findings)).toHaveLength(2);
-  });
-});
-
-// ── findingsToLines ───────────────────────────────────────────────────────────
-
-describe("findingsToLines", () => {
-  it("formats a secret finding", () => {
-    const findings: Finding[] = [
-      {
-        ruleId: "aws-access-key",
-        description: "AWS Access Key ID",
-        category: "secret",
-        matchRedacted: "AKIA****MPLE",
-        secretValue: "AKIAIOSFODNN7EXAMPLE",
-        score: 1,
-      },
-    ];
-    const lines = findingsToLines(findings);
-    expect(lines[0]).toBe(
-      "  [Secret] AWS Access Key ID (aws-access-key): AKIA****MPLE",
-    );
-  });
-
-  it("formats a PII finding", () => {
-    const findings: Finding[] = [
-      {
-        ruleId: "pii-email",
-        description: "Email Address",
-        category: "pii",
-        matchRedacted: "user****",
-        secretValue: "user@example.com",
-        score: 1,
-      },
-    ];
-    const lines = findingsToLines(findings);
-    expect(lines[0]).toBe("  [PII] Email Address (pii-email): user****");
-  });
-});